AGW Logo

agw_title AuiFloatingFrame

AuiFloatingFrame is the frame class that holds floating panes.

hierarchy Inheritance Diagram

Inheritance diagram for: AuiFloatingFrame

Inheritance diagram of AuiFloatingFrame


method_summary Methods Summary

__init__Default class constructor.
CopyAttributesCopies all the attributes of the input pane into another AuiPaneInfo.
FadeOutActually starts the fading out of the floating pane.
FlyOutStarts the flying in and out of a floating pane.
GetOwnerManagerReturns the AuiManager that manages the pane.
OnActivateHandles the wx.EVT_ACTIVATE event for AuiFloatingFrame.
OnCheckFlyTimerHandles the wx.EVT_TIMER event for AuiFloatingFrame.
OnCloseHandles the wx.EVT_CLOSE event for AuiFloatingFrame.
OnFindManagerHandles the EVT_AUI_FIND_MANAGER event for AuiFloatingFrame.
OnFlyTimerHandles the wx.EVT_TIMER event for AuiFloatingFrame.
OnIdleHandles the wx.EVT_IDLE event for AuiFloatingFrame.
OnMoveHandles the wx.EVT_MOVE event for AuiFloatingFrame.
OnMoveEventHandles the wx.EVT_MOVE and wx.EVT_MOVING events for AuiFloatingFrame.
OnMoveFinishedThe user has just finished moving the floating pane.
OnMoveStartThe user has just started moving the floating pane.
OnMovingThe user is moving the floating pane.
OnSizeHandles the wx.EVT_SIZE event for AuiFloatingFrame.
SetPaneWindowSets all the properties of a pane.

API Class API

class AuiFloatingFrame(wx.MiniFrame)[source]

AuiFloatingFrame is the frame class that holds floating panes.



__init__(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)[source]

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

Parameters:
  • parent – the AuiFloatingFrame parent;
  • owner_mgr – the AuiManager that manages the floating pane;
  • pane – the AuiPaneInfo pane that is about to float;
  • id – the window identifier. It may take a value of -1 to indicate a default value.
  • title – the caption to be displayed on the frame’s title bar.
  • style – the window style.


CopyAttributes(pane)[source]

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

Parameters:pane – the source AuiPaneInfo from where to copy attributes.


FadeOut()[source]

Actually starts the fading out of the floating pane.



FlyOut()[source]

Starts the flying in and out of a floating pane.



GetOwnerManager()[source]

Returns the AuiManager that manages the pane.



OnActivate(event)[source]

Handles the wx.EVT_ACTIVATE event for AuiFloatingFrame.

Parameters:event – a wx.ActivateEvent to be processed.


OnCheckFlyTimer(event)[source]

Handles the wx.EVT_TIMER event for AuiFloatingFrame.

Parameters:event – a wx.TimerEvent to be processed.

Note

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



OnClose(event)[source]

Handles the wx.EVT_CLOSE event for AuiFloatingFrame.

Parameters:event – a wx.CloseEvent to be processed.


OnFindManager(event)[source]

Handles the EVT_AUI_FIND_MANAGER event for AuiFloatingFrame.

Parameters:event – a AuiManagerEvent event to be processed.


OnFlyTimer(event)[source]

Handles the wx.EVT_TIMER event for AuiFloatingFrame.

Parameters:event – a wx.TimerEvent to be processed.



OnIdle(event)[source]

Handles the wx.EVT_IDLE event for AuiFloatingFrame.

Parameters:event – a wx.IdleEvent event to be processed.

Note

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



OnMove(event)[source]

Handles the wx.EVT_MOVE event for AuiFloatingFrame.

Parameters:event – a wx.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(event)[source]

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

Parameters:event – a wx.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()[source]

The user has just finished moving the floating pane.

Note

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



OnMoveStart(event)[source]

The user has just started moving the floating pane.

Parameters:event – an instance of wx.MouseEvent.

Note

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



OnMoving(event)[source]

The user is moving the floating pane.

Parameters:event – an instance of wx.MouseEvent.

Note

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



OnSize(event)[source]

Handles the wx.EVT_SIZE event for AuiFloatingFrame.

Parameters:event – a wx.SizeEvent to be processed.


SetPaneWindow(pane)[source]

Sets all the properties of a pane.

Parameters:pane – the AuiPaneInfo to analyze.
Tree

Table Of Contents

Previous topic

AuiDockingHintWindow

Next topic

AuiManager