wx.lib.agw.aui.framemanager.AuiDockingHintWindow

The original wxAUI docking window hint.

Class Hierarchy

Inheritance diagram for class AuiDockingHintWindow:

Known Superclasses

wx.Frame

Methods Summary

__init__	Default class constructor. Used internally, do not call it in your code!
MakeVenetianBlinds	Creates the “venetian blind” effect if AuiManager has the AUI_MGR_VENETIAN_BLINDS_HINT
OnPaint	Handles the wx.EVT_PAINT event for AuiDockingHintWindow.
OnSize	Handles the wx.EVT_SIZE event for AuiDockingHintWindow.
SetBlindMode	Sets whether venetian blinds or transparent hints will be shown as docking hint.
SetShape	If the platform supports it, sets the shape of the window to that depicted by region.
Show	Show the hint window.

Class API

class AuiDockingHintWindow(wx.Frame)

The original wxAUI docking window hint.

Methods

__init__(self, parent, id=wx.ID_ANY, title='', pos=wx.DefaultPosition, size=wx.Size(1, 1), style=wx.FRAME_TOOL_WINDOW | wx.FRAME_FLOAT_ON_PARENT | wx.FRAME_NO_TASKBAR | wx.NO_BORDER | wx.FRAME_SHAPED, name='auiHintWindow')

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.

---

MakeVenetianBlinds(self)

Creates the “venetian blind” effect if AuiManager has the AUI_MGR_VENETIAN_BLINDS_HINT flag set.

---

OnPaint(self, event)

Handles the wx.EVT_PAINT event for AuiDockingHintWindow.

Parameters:

event – an instance of PaintEvent to be processed.

---

OnSize(self, event)

Handles the wx.EVT_SIZE event for AuiDockingHintWindow.

Parameters:

event – a wx.SizeEvent to be processed.

---

SetBlindMode(self, agwFlags)

Sets whether venetian blinds or transparent hints will be shown as docking hint. This depends on the AuiManager flags.

Parameters:

agwFlags (integer) – the AuiManager flags.

---

SetShape(self, region)

If the platform supports it, sets the shape of the window to that depicted by region. The system will not display or respond to any mouse event for the pixels that lie outside of the region. To reset the window to the normal rectangular shape simply call SetShape again with an empty region.

Parameters:

region (Region) – the shape of the frame.

Note

Overridden for wxMAC.

---

Show(self, show=True)

Show the hint window.

Parameters:

show (bool) – whether to show or hide the hint docking window.