wx.lib.agw.aui.framemanager.AuiFloatingFrame

AuiFloatingFrame is the frame class that holds floating panes.

Class Hierarchy

Inheritance diagram for class AuiFloatingFrame:

Known Superclasses

wx.MiniFrame

Methods Summary

__init__	Default class constructor. Used internally, do not call it in your code!
CopyAttributes	Copies all the attributes of the input pane into another AuiPaneInfo.
FadeOut	Actually starts the fading out of the floating pane.
FlyOut	Starts the flying in and out of a floating pane.
GetOwnerManager	Returns the AuiManager that manages the pane.
OnActivate	Handles the wx.EVT_ACTIVATE event for AuiFloatingFrame.
OnCheckFlyTimer	Handles the wx.EVT_TIMER event for AuiFloatingFrame.
OnClose	Handles the wx.EVT_CLOSE event for AuiFloatingFrame.
OnFindManager	Handles the EVT_AUI_FIND_MANAGER event for AuiFloatingFrame.
OnFlyTimer	Handles the wx.EVT_TIMER event for AuiFloatingFrame.
OnIdle	Handles the wx.EVT_IDLE event for AuiFloatingFrame.
OnMove	Handles the wx.EVT_MOVE event for AuiFloatingFrame.
OnMoveEvent	Handles the wx.EVT_MOVE and wx.EVT_MOVING events for AuiFloatingFrame.
OnMoveFinished	The user has just finished moving the floating pane.
OnMoveStart	The user has just started moving the floating pane.
OnMoving	The user is moving the floating pane.
OnSize	Handles the wx.EVT_SIZE event for AuiFloatingFrame.
SetPaneWindow	Sets all the properties of a pane.

Class API

class AuiFloatingFrame(wx.MiniFrame)

AuiFloatingFrame is the frame class that holds floating panes.

Methods

__init__(self, parent, owner_mgr, pane=None, id=wx.ID_ANY, title="", style=wx.FRAME_TOOL_WINDOW | wx.FRAME_FLOAT_ON_PARENT | wx.FRAME_NO_TASKBAR | wx.CLIP_CHILDREN)

Default class constructor. Used internally, do not call it in your code!

Parameters:

• parent – the AuiManager parent;

• owner_mgr – the AuiManager that manages the floating pane;

• pane – the AuiPaneInfo pane that is about to float;

• id (integer) – the window identifier. It may take a value of -1 to indicate a default value.

• title (string) – the caption to be displayed on the frame’s title bar.

• style (integer) – the window style.

---

CopyAttributes(self, pane)

Copies all the attributes of the input pane into another AuiPaneInfo.

Parameters:

pane – the source AuiPaneInfo from where to copy attributes.

---

FadeOut(self)

Actually starts the fading out of the floating pane.

---

FlyOut(self)

Starts the flying in and out of a floating pane.

---

GetOwnerManager(self)

Returns the AuiManager that manages the pane.

---

OnActivate(self, event)

Handles the wx.EVT_ACTIVATE event for AuiFloatingFrame.

Parameters:

event – a ActivateEvent to be processed.

---

OnCheckFlyTimer(self, event)

Handles the wx.EVT_TIMER event for AuiFloatingFrame.

Parameters:

event – a TimerEvent to be processed.

Note

This is used solely for “fly-out” panes.

---

OnClose(self, event)

Handles the wx.EVT_CLOSE event for AuiFloatingFrame.

Parameters:

event – a CloseEvent to be processed.

---

OnFindManager(self, event)

Handles the EVT_AUI_FIND_MANAGER event for AuiFloatingFrame.

Parameters:

event – a AuiManagerEvent event to be processed.

---

OnFlyTimer(self, event)

Handles the wx.EVT_TIMER event for AuiFloatingFrame.

Parameters:

event – a TimerEvent to be processed.

---

OnIdle(self, event)

Handles the wx.EVT_IDLE event for AuiFloatingFrame.

Parameters:

event – a IdleEvent event to be processed.

Note

This event is only processed on wxMAC if AuiManager is using the AUI_MGR_USE_NATIVE_MINIFRAMES style.

---

OnMove(self, event)

Handles the wx.EVT_MOVE event for AuiFloatingFrame.

Parameters:

event – a MoveEvent to be processed.

Note

This event is not processed on wxMAC or if AuiManager is not using the AUI_MGR_USE_NATIVE_MINIFRAMES style.

---

OnMoveEvent(self, event)

Handles the wx.EVT_MOVE and wx.EVT_MOVING events for AuiFloatingFrame.

Parameters:

event – a MoveEvent to be processed.

Note

This event is only processed on wxMAC or if AuiManager is using the AUI_MGR_USE_NATIVE_MINIFRAMES style.

---

OnMoveFinished(self)

The user has just finished moving the floating pane.

Note

This method is used only on wxMAC if AuiManager is using the AUI_MGR_USE_NATIVE_MINIFRAMES style.

---

OnMoveStart(self, event)

The user has just started moving the floating pane.

Parameters:

event – an instance of MouseEvent.

Note

This event is only processed on wxMAC if AuiManager is using the AUI_MGR_USE_NATIVE_MINIFRAMES style.

---

OnMoving(self, rect, direction)

The user is moving the floating pane.

Parameters:

• rect (wx.Rect) – the pane client rectangle;

• direction (integer) – the direction in which the pane is moving, can be one of wx.NORTH, wx.SOUTH, wx.EAST or wx.WEST.

Note

This event is only processed on wxMAC if AuiManager is using the AUI_MGR_USE_NATIVE_MINIFRAMES style.

---

OnSize(self, event)

Handles the wx.EVT_SIZE event for AuiFloatingFrame.

Parameters:

event – a wx.SizeEvent to be processed.

---

SetPaneWindow(self, pane)

Sets all the properties of a pane.

Parameters:

pane – the AuiPaneInfo to analyze.