framemanager.AuiDockingGuideWindow

Inheritance diagram for AuiDockingGuideWindow:


digraph inheritancebccb66fb02 {
rankdir=LR;
size="8.0, 12.0";
  "framemanager.AuiDockingGuideWindow" [style="setlinewidth(0.5)",URL="#framemanager.AuiDockingGuideWindow",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "wx._core.Window" -> "framemanager.AuiDockingGuideWindow" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.Window" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.EvtHandler" -> "wx._core.Window" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.EvtHandler" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.Object" -> "wx._core.EvtHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.Object" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
}


Description

Target class for L{AuiSingleDockingGuide} and L{AuiCenterDockingGuide}.

Class API

Methods

class AuiDockingGuideWindow(parent, rect, direction=0, center=False)

Bases: wx._core.Window

Target class for L{AuiSingleDockingGuide} and L{AuiCenterDockingGuide}.

__init__()

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

Parameters:
  • parent – the AuiDockingGuideWindow parent;
  • rect – the window rect;
  • direction – one of wx.TOP, wx.BOTTOM, wx.LEFT, wx.RIGHT, wx.CENTER;
  • center – whether the calling class is a L{AuiCenterDockingGuide}.
Draw(dc)

Draws the whole docking guide window (not used if the docking guide images are ok).

Parameter:dc – a L{wx.DC} device context object.
DrawArrow(dc)

Draws the docking guide arrow icon (not used if the docking guide images are ok).

Parameter:dc – a L{wx.DC} device context object.
DrawBackground(dc)

Draws the docking guide background.

Parameter:dc – a L{wx.DC} device context object.
DrawDottedLine(dc, point, length, vertical)

Draws a dotted line (not used if the docking guide images are ok).

Parameters:
  • dc – a L{wx.DC} device context object;
  • point – a L{wx.Point} where to start drawing the dotted line;
  • length – the length of the dotted line;
  • vertical – whether it is a vertical docking guide window or not.
DrawIcon(dc)

Draws the docking guide icon (not used if the docking guide images are ok).

Parameter:dc – a L{wx.DC} device context object.
IsValid()
Returns whether the docking direction is valid.
OnEraseBackground(event)

Handles the wx.EVT_ERASE_BACKGROUND event for L{AuiDockingGuideWindow}. This is intentiobnally empty to reduce flickering while drawing.

Parameter:event – L{wx.EraseEvent} to be processed.
OnPaint(event)

Handles the wx.EVT_PAINT event for L{AuiDockingGuideWindow}.

Parameter:event – a L{wx.PaintEvent} to be processed.
SetValid(valid)

Sets the docking direction as valid or invalid.

Parameter:valid – whether the docking direction is allowed or not.
UpdateDockGuide(pos)

Updates the docking guide images depending on the mouse position, using focused images if the mouse is inside the docking guide or unfocused images if it is outside.

Parameter:pos – a L{wx.Point} mouse position.

Table Of Contents

This Page