Phoenix Logo

phoenix_title wx.lib.agw.aui.framemanager.AuiDockingGuide

Base class for AuiSingleDockingGuide and AuiCenterDockingGuide.


class_hierarchy Class Hierarchy

Inheritance diagram for class AuiDockingGuide:


super_classes Known Superclasses

wx.Frame


method_summary Methods Summary

__init__ Default class constructor. Used internally, do not call it in your code!
HitTest To be overridden by parent classes.
ValidateNotebookDocking To be overridden by parent classes.

api Class API



class AuiDockingGuide(wx.Frame)

Base class for AuiSingleDockingGuide and AuiCenterDockingGuide.


Methods



__init__(self, 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")

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

Parameters:
  • parent – the AuiManager parent;
  • 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.
  • pos (wx.Point) – the window position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform.
  • size (wx.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 (integer) – the window style.
  • name (string) – 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(self, x, y)

To be overridden by parent classes.

Parameters:
  • x (integer) – the x mouse position;
  • y (integer) – the y mouse position.


ValidateNotebookDocking(self, valid)

To be overridden by parent classes.

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