AGW Logo

agw_title AuiDockingGuide

Base class for AuiCenterDockingGuide and AuiSingleDockingGuide.

hierarchy Inheritance Diagram

Inheritance diagram for: AuiDockingGuide

Inheritance diagram of AuiDockingGuide


method_summary Methods Summary

__init__Default class constructor.
HitTestTo be overridden by parent classes.
ValidateNotebookDockingTo be overridden by parent classes.

API Class API

class AuiDockingGuide(wx.Frame)[source]

Base class for AuiCenterDockingGuide and AuiSingleDockingGuide.



__init__(parent, id=wx.ID_ANY, title="", pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.FRAME_TOOL_WINDOW | wx.STAY_ON_TOP | wx.FRAME_NO_TASKBAR | wx.NO_BORDER, name="AuiDockingGuide")[source]

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

Parameters:
  • parent – the AuiDockingGuide parent;
  • 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.
  • pos – the window position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform.
  • size – the window size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform.
  • style – the window style.
  • name – the name of the window. This parameter is used to associate a name with the item, allowing the application user to set Motif resource values for individual windows.


HitTest(x, y)[source]

To be overridden by parent classes.

Parameters:
  • x – the x mouse position;
  • y – the y mouse position.


ValidateNotebookDocking(valid)[source]

To be overridden by parent classes.

Parameters:valid – whether a pane can be docked on top to another to form an automatic AuiNotebook.
Tree

Table Of Contents

Previous topic

AuiDockUIPart

Next topic

AuiDockingGuideInfo