1 # This file was created automatically by SWIG 1.3.29.
2 # Don't modify this file, modify the SWIG interface instead.
5 The wx.aui moduleis an Advanced User Interface library that aims to
6 implement "cutting-edge" interface usability and design features so
7 developers can quickly and easily create beautiful and usable
8 application interfaces.
10 **Vision and Design Principles**
12 wx.aui attempts to encapsulate the following aspects of the user
15 * Frame Management: Frame management provides the means to open,
16 move and hide common controls that are needed to interact with the
17 document, and allow these configurations to be saved into
18 different perspectives and loaded at a later time.
20 * Toolbars: Toolbars are a specialized subset of the frame
21 management system and should behave similarly to other docked
22 components. However, they also require additional functionality,
23 such as "spring-loaded" rebar support, "chevron" buttons and
24 end-user customizability.
26 * Modeless Controls: Modeless controls expose a tool palette or set
27 of options that float above the application content while allowing
28 it to be accessed. Usually accessed by the toolbar, these controls
29 disappear when an option is selected, but may also be "torn off"
30 the toolbar into a floating frame of their own.
32 * Look and Feel: Look and feel encompasses the way controls are
33 drawn, both when shown statically as well as when they are being
34 moved. This aspect of user interface design incorporates "special
35 effects" such as transparent window dragging as well as frame
38 **PyAUI adheres to the following principles**
40 - Use native floating frames to obtain a native look and feel for
43 - Use existing wxPython code where possible, such as sizer
44 implementation for frame management;
46 - Use standard wxPython coding conventions.
51 The following example shows a simple implementation that utilizes
52 `wx.aui.FrameManager` to manage three text controls in a frame window::
57 class MyFrame(wx.Frame):
59 def __init__(self, parent, id=-1, title='wx.aui Test',
60 size=(800, 600), style=wx.DEFAULT_FRAME_STYLE):
61 wx.Frame.__init__(self, parent, id, title, pos, size, style)
63 self._mgr = wx.aui.FrameManager(self)
65 # create several text controls
66 text1 = wx.TextCtrl(self, -1, 'Pane 1 - sample text',
67 wx.DefaultPosition, wx.Size(200,150),
68 wx.NO_BORDER | wx.TE_MULTILINE)
70 text2 = wx.TextCtrl(self, -1, 'Pane 2 - sample text',
71 wx.DefaultPosition, wx.Size(200,150),
72 wx.NO_BORDER | wx.TE_MULTILINE)
74 text3 = wx.TextCtrl(self, -1, 'Main content window',
75 wx.DefaultPosition, wx.Size(200,150),
76 wx.NO_BORDER | wx.TE_MULTILINE)
78 # add the panes to the manager
79 self._mgr.AddPane(text1, wx.LEFT, 'Pane Number One')
80 self._mgr.AddPane(text2, wx.BOTTOM, 'Pane Number Two')
81 self._mgr.AddPane(text3, wx.CENTER)
83 # tell the manager to 'commit' all the changes just made
86 self.Bind(wx.EVT_CLOSE, self.OnClose)
89 def OnClose(self, event):
90 # deinitialize the frame manager
105 new_instancemethod
= new
.instancemethod
106 def _swig_setattr_nondynamic(self
,class_type
,name
,value
,static
=1):
107 if (name
== "thisown"): return self
.this
.own(value
)
109 if type(value
).__name
__ == 'PySwigObject':
110 self
.__dict
__[name
] = value
112 method
= class_type
.__swig
_setmethods
__.get(name
,None)
113 if method
: return method(self
,value
)
114 if (not static
) or hasattr(self
,name
):
115 self
.__dict
__[name
] = value
117 raise AttributeError("You cannot add attributes to %s" % self
)
119 def _swig_setattr(self
,class_type
,name
,value
):
120 return _swig_setattr_nondynamic(self
,class_type
,name
,value
,0)
122 def _swig_getattr(self
,class_type
,name
):
123 if (name
== "thisown"): return self
.this
.own()
124 method
= class_type
.__swig
_getmethods
__.get(name
,None)
125 if method
: return method(self
)
126 raise AttributeError,name
128 def _swig_repr(self
):
129 try: strthis
= "proxy of " + self
.this
.__repr
__()
131 return "<%s.%s; %s >" % (self
.__class
__.__module
__, self
.__class
__.__name
__, strthis
,)
135 _object
= types
.ObjectType
137 except AttributeError:
143 def _swig_setattr_nondynamic_method(set):
144 def set_attr(self
,name
,value
):
145 if (name
== "thisown"): return self
.this
.own(value
)
146 if hasattr(self
,name
) or (name
== "this"):
149 raise AttributeError("You cannot add attributes to %s" % self
)
156 __docfilter__
= wx
.__DocFilter
(globals())
157 USE_AUI
= _aui
.USE_AUI
158 AUI_DOCK_NONE
= _aui
.AUI_DOCK_NONE
159 AUI_DOCK_TOP
= _aui
.AUI_DOCK_TOP
160 AUI_DOCK_RIGHT
= _aui
.AUI_DOCK_RIGHT
161 AUI_DOCK_BOTTOM
= _aui
.AUI_DOCK_BOTTOM
162 AUI_DOCK_LEFT
= _aui
.AUI_DOCK_LEFT
163 AUI_DOCK_CENTER
= _aui
.AUI_DOCK_CENTER
164 AUI_DOCK_CENTRE
= _aui
.AUI_DOCK_CENTRE
165 AUI_MGR_ALLOW_FLOATING
= _aui
.AUI_MGR_ALLOW_FLOATING
166 AUI_MGR_ALLOW_ACTIVE_PANE
= _aui
.AUI_MGR_ALLOW_ACTIVE_PANE
167 AUI_MGR_TRANSPARENT_DRAG
= _aui
.AUI_MGR_TRANSPARENT_DRAG
168 AUI_MGR_TRANSPARENT_HINT
= _aui
.AUI_MGR_TRANSPARENT_HINT
169 AUI_MGR_TRANSPARENT_HINT_FADE
= _aui
.AUI_MGR_TRANSPARENT_HINT_FADE
170 AUI_MGR_DISABLE_VENETIAN_BLINDS
= _aui
.AUI_MGR_DISABLE_VENETIAN_BLINDS
171 AUI_MGR_DEFAULT
= _aui
.AUI_MGR_DEFAULT
172 AUI_ART_SASH_SIZE
= _aui
.AUI_ART_SASH_SIZE
173 AUI_ART_CAPTION_SIZE
= _aui
.AUI_ART_CAPTION_SIZE
174 AUI_ART_GRIPPER_SIZE
= _aui
.AUI_ART_GRIPPER_SIZE
175 AUI_ART_PANE_BORDER_SIZE
= _aui
.AUI_ART_PANE_BORDER_SIZE
176 AUI_ART_PANE_BUTTON_SIZE
= _aui
.AUI_ART_PANE_BUTTON_SIZE
177 AUI_ART_BACKGROUND_COLOUR
= _aui
.AUI_ART_BACKGROUND_COLOUR
178 AUI_ART_SASH_COLOUR
= _aui
.AUI_ART_SASH_COLOUR
179 AUI_ART_ACTIVE_CAPTION_COLOUR
= _aui
.AUI_ART_ACTIVE_CAPTION_COLOUR
180 AUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR
= _aui
.AUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR
181 AUI_ART_INACTIVE_CAPTION_COLOUR
= _aui
.AUI_ART_INACTIVE_CAPTION_COLOUR
182 AUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR
= _aui
.AUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR
183 AUI_ART_ACTIVE_CAPTION_TEXT_COLOUR
= _aui
.AUI_ART_ACTIVE_CAPTION_TEXT_COLOUR
184 AUI_ART_INACTIVE_CAPTION_TEXT_COLOUR
= _aui
.AUI_ART_INACTIVE_CAPTION_TEXT_COLOUR
185 AUI_ART_BORDER_COLOUR
= _aui
.AUI_ART_BORDER_COLOUR
186 AUI_ART_GRIPPER_COLOUR
= _aui
.AUI_ART_GRIPPER_COLOUR
187 AUI_ART_CAPTION_FONT
= _aui
.AUI_ART_CAPTION_FONT
188 AUI_ART_GRADIENT_TYPE
= _aui
.AUI_ART_GRADIENT_TYPE
189 AUI_GRADIENT_NONE
= _aui
.AUI_GRADIENT_NONE
190 AUI_GRADIENT_VERTICAL
= _aui
.AUI_GRADIENT_VERTICAL
191 AUI_GRADIENT_HORIZONTAL
= _aui
.AUI_GRADIENT_HORIZONTAL
192 AUI_BUTTON_STATE_NORMAL
= _aui
.AUI_BUTTON_STATE_NORMAL
193 AUI_BUTTON_STATE_HOVER
= _aui
.AUI_BUTTON_STATE_HOVER
194 AUI_BUTTON_STATE_PRESSED
= _aui
.AUI_BUTTON_STATE_PRESSED
195 AUI_INSERT_PANE
= _aui
.AUI_INSERT_PANE
196 AUI_INSERT_ROW
= _aui
.AUI_INSERT_ROW
197 AUI_INSERT_DOCK
= _aui
.AUI_INSERT_DOCK
198 class PaneInfo(object):
200 PaneInfo specifies all the parameters for a pane for the
201 `FrameManager`. These parameters specify where the pane is on the
202 screen, whether it is docked or floating, or hidden. In addition,
203 these parameters specify the pane's docked position, floating
204 position, preferred size, minimum size, caption text among many other
208 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
209 __repr__
= _swig_repr
210 def __init__(self
, *args
, **kwargs
):
212 __init__(self) -> PaneInfo
214 PaneInfo specifies all the parameters for a pane for the
215 `FrameManager`. These parameters specify where the pane is on the
216 screen, whether it is docked or floating, or hidden. In addition,
217 these parameters specify the pane's docked position, floating
218 position, preferred size, minimum size, caption text among many other
222 _aui
.PaneInfo_swiginit(self
,_aui
.new_PaneInfo(*args
, **kwargs
))
223 __swig_destroy__
= _aui
.delete_PaneInfo
224 __del__
= lambda self
: None;
225 def IsOk(*args
, **kwargs
):
229 IsOk returns ``True`` if the PaneInfo structure is valid.
232 return _aui
.PaneInfo_IsOk(*args
, **kwargs
)
234 def IsFixed(*args
, **kwargs
):
236 IsFixed(self) -> bool
238 IsFixed returns ``True`` if the pane cannot be resized.
241 return _aui
.PaneInfo_IsFixed(*args
, **kwargs
)
243 def IsResizable(*args
, **kwargs
):
245 IsResizable(self) -> bool
247 IsResizeable returns ``True`` if the pane can be resized.
250 return _aui
.PaneInfo_IsResizable(*args
, **kwargs
)
252 def IsShown(*args
, **kwargs
):
254 IsShown(self) -> bool
256 IsShown returns ``True`` if the pane should be drawn on the screen.
259 return _aui
.PaneInfo_IsShown(*args
, **kwargs
)
261 def IsFloating(*args
, **kwargs
):
263 IsFloating(self) -> bool
265 IsFloating returns ``True`` if the pane is floating.
268 return _aui
.PaneInfo_IsFloating(*args
, **kwargs
)
270 def IsDocked(*args
, **kwargs
):
272 IsDocked(self) -> bool
274 IsDocked returns ``True`` if the pane is docked.
277 return _aui
.PaneInfo_IsDocked(*args
, **kwargs
)
279 def IsToolbar(*args
, **kwargs
):
281 IsToolbar(self) -> bool
283 IsToolbar returns ``True`` if the pane contains a toolbar.
286 return _aui
.PaneInfo_IsToolbar(*args
, **kwargs
)
288 def IsTopDockable(*args
, **kwargs
):
290 IsTopDockable(self) -> bool
292 IsTopDockable returns ``True`` if the pane can be docked at the top of
296 return _aui
.PaneInfo_IsTopDockable(*args
, **kwargs
)
298 def IsBottomDockable(*args
, **kwargs
):
300 IsBottomDockable(self) -> bool
302 IsBottomDockable returns ``True`` if the pane can be docked at the
303 bottom of the managed frame.
306 return _aui
.PaneInfo_IsBottomDockable(*args
, **kwargs
)
308 def IsLeftDockable(*args
, **kwargs
):
310 IsLeftDockable(self) -> bool
312 IsLeftDockable returns ``True`` if the pane can be docked on the left
313 of the managed frame.
316 return _aui
.PaneInfo_IsLeftDockable(*args
, **kwargs
)
318 def IsRightDockable(*args
, **kwargs
):
320 IsRightDockable(self) -> bool
322 IsRightDockable returns ``True`` if the pane can be docked on the
323 right of the managed frame.
326 return _aui
.PaneInfo_IsRightDockable(*args
, **kwargs
)
328 def IsFloatable(*args
, **kwargs
):
330 IsFloatable(self) -> bool
332 IsFloatable returns ``True`` if the pane can be undocked and displayed
333 as a floating window.
336 return _aui
.PaneInfo_IsFloatable(*args
, **kwargs
)
338 def IsMovable(*args
, **kwargs
):
340 IsMovable(self) -> bool
342 IsMoveable returns ``True`` if the docked frame can be undocked or moved
343 to another dock position.
346 return _aui
.PaneInfo_IsMovable(*args
, **kwargs
)
348 def HasCaption(*args
, **kwargs
):
350 HasCaption(self) -> bool
352 HasCaption returns ``True`` if the pane displays a caption.
355 return _aui
.PaneInfo_HasCaption(*args
, **kwargs
)
357 def HasGripper(*args
, **kwargs
):
359 HasGripper(self) -> bool
361 HasGripper returns ``True`` if the pane displays a gripper.
364 return _aui
.PaneInfo_HasGripper(*args
, **kwargs
)
366 def HasBorder(*args
, **kwargs
):
368 HasBorder(self) -> bool
370 HasBorder returns ``True`` if the pane displays a border.
373 return _aui
.PaneInfo_HasBorder(*args
, **kwargs
)
375 def HasCloseButton(*args
, **kwargs
):
377 HasCloseButton(self) -> bool
379 HasCloseButton returns ``True`` if the pane displays a button to close
383 return _aui
.PaneInfo_HasCloseButton(*args
, **kwargs
)
385 def HasMaximizeButton(*args
, **kwargs
):
387 HasMaximizeButton(self) -> bool
389 HasMaximizeButton returns ``True`` if the pane displays a button to
393 return _aui
.PaneInfo_HasMaximizeButton(*args
, **kwargs
)
395 def HasMinimizeButton(*args
, **kwargs
):
397 HasMinimizeButton(self) -> bool
399 HasMinimizeButton returns ``True`` if the pane displays a button to
403 return _aui
.PaneInfo_HasMinimizeButton(*args
, **kwargs
)
405 def HasPinButton(*args
, **kwargs
):
407 HasPinButton(self) -> bool
409 HasPinButton returns ``True`` if the pane displays a button to float
413 return _aui
.PaneInfo_HasPinButton(*args
, **kwargs
)
415 def HasGripperTop(*args
, **kwargs
):
416 """HasGripperTop(self) -> bool"""
417 return _aui
.PaneInfo_HasGripperTop(*args
, **kwargs
)
419 def Window(*args
, **kwargs
):
420 """Window(self, Window w) -> PaneInfo"""
421 return _aui
.PaneInfo_Window(*args
, **kwargs
)
423 def Name(*args
, **kwargs
):
425 Name(self, String n) -> PaneInfo
427 Name sets the name of the pane so it can be referenced in lookup
431 return _aui
.PaneInfo_Name(*args
, **kwargs
)
433 def Caption(*args
, **kwargs
):
435 Caption(self, String c) -> PaneInfo
437 Caption sets the caption of the pane.
440 return _aui
.PaneInfo_Caption(*args
, **kwargs
)
442 def Left(*args
, **kwargs
):
444 Left(self) -> PaneInfo
446 Left sets the pane dock position to the left side of the frame.
449 return _aui
.PaneInfo_Left(*args
, **kwargs
)
451 def Right(*args
, **kwargs
):
453 Right(self) -> PaneInfo
455 Right sets the pane dock position to the right side of the frame.
458 return _aui
.PaneInfo_Right(*args
, **kwargs
)
460 def Top(*args
, **kwargs
):
462 Top(self) -> PaneInfo
464 Top sets the pane dock position to the top of the frame.
467 return _aui
.PaneInfo_Top(*args
, **kwargs
)
469 def Bottom(*args
, **kwargs
):
471 Bottom(self) -> PaneInfo
473 Bottom sets the pane dock position to the bottom of the frame.
476 return _aui
.PaneInfo_Bottom(*args
, **kwargs
)
478 def Center(*args
, **kwargs
):
480 Center(self) -> PaneInfo
482 Center sets the pane to the center position of the frame.
485 return _aui
.PaneInfo_Center(*args
, **kwargs
)
487 def Centre(*args
, **kwargs
):
489 Centre(self) -> PaneInfo
491 Centre sets the pane to the center position of the frame.
494 return _aui
.PaneInfo_Centre(*args
, **kwargs
)
496 def Direction(*args
, **kwargs
):
498 Direction(self, int direction) -> PaneInfo
500 Direction determines the direction of the docked pane.
503 return _aui
.PaneInfo_Direction(*args
, **kwargs
)
505 def Layer(*args
, **kwargs
):
507 Layer(self, int layer) -> PaneInfo
509 Layer determines the layer of the docked pane.
512 return _aui
.PaneInfo_Layer(*args
, **kwargs
)
514 def Row(*args
, **kwargs
):
516 Row(self, int row) -> PaneInfo
518 Row determines the row of the docked pane.
521 return _aui
.PaneInfo_Row(*args
, **kwargs
)
523 def Position(*args
, **kwargs
):
525 Position(self, int pos) -> PaneInfo
527 Position determines the position of the docked pane.
530 return _aui
.PaneInfo_Position(*args
, **kwargs
)
532 def BestSize(*args
, **kwargs
):
534 BestSize(self, Size size) -> PaneInfo
536 BestSize sets the ideal size for the pane.
539 return _aui
.PaneInfo_BestSize(*args
, **kwargs
)
541 def MinSize(*args
, **kwargs
):
543 MinSize(self, Size size) -> PaneInfo
545 MinSize sets the minimum size of the pane.
548 return _aui
.PaneInfo_MinSize(*args
, **kwargs
)
550 def MaxSize(*args
, **kwargs
):
552 MaxSize(self, Size size) -> PaneInfo
554 MaxSize sets the maximum size of the pane.
557 return _aui
.PaneInfo_MaxSize(*args
, **kwargs
)
559 def FloatingPosition(*args
, **kwargs
):
561 FloatingPosition(self, Point pos) -> PaneInfo
563 FloatingPosition sets the position of the floating pane.
566 return _aui
.PaneInfo_FloatingPosition(*args
, **kwargs
)
568 def FloatingSize(*args
, **kwargs
):
570 FloatingSize(self, Size size) -> PaneInfo
572 FloatingSize sets the size of the floating pane.
575 return _aui
.PaneInfo_FloatingSize(*args
, **kwargs
)
577 def Fixed(*args
, **kwargs
):
579 Fixed(self) -> PaneInfo
581 Fixed forces a pane to be fixed size so that it cannot be resized.
584 return _aui
.PaneInfo_Fixed(*args
, **kwargs
)
586 def Resizable(*args
, **kwargs
):
588 Resizable(self, bool resizable=True) -> PaneInfo
590 Resized allows a pane to be resized if resizable is true, and forces
591 it to be a fixed size if resizeable is false.
594 return _aui
.PaneInfo_Resizable(*args
, **kwargs
)
596 def Dock(*args
, **kwargs
):
598 Dock(self) -> PaneInfo
600 Dock indicates that a pane should be docked.
603 return _aui
.PaneInfo_Dock(*args
, **kwargs
)
605 def Float(*args
, **kwargs
):
607 Float(self) -> PaneInfo
609 Float indicates that a pane should be floated.
612 return _aui
.PaneInfo_Float(*args
, **kwargs
)
614 def Hide(*args
, **kwargs
):
616 Hide(self) -> PaneInfo
618 Hide indicates that a pane should be hidden.
621 return _aui
.PaneInfo_Hide(*args
, **kwargs
)
623 def Show(*args
, **kwargs
):
625 Show(self, bool show=True) -> PaneInfo
627 Show indicates that a pane should be shown.
630 return _aui
.PaneInfo_Show(*args
, **kwargs
)
632 def CaptionVisible(*args
, **kwargs
):
634 CaptionVisible(self, bool visible=True) -> PaneInfo
636 CaptionVisible indicates that a pane caption should be visible.
639 return _aui
.PaneInfo_CaptionVisible(*args
, **kwargs
)
641 def PaneBorder(*args
, **kwargs
):
643 PaneBorder(self, bool visible=True) -> PaneInfo
645 PaneBorder indicates that a border should be drawn for the pane.
648 return _aui
.PaneInfo_PaneBorder(*args
, **kwargs
)
650 def Gripper(*args
, **kwargs
):
652 Gripper(self, bool visible=True) -> PaneInfo
654 Gripper indicates that a gripper should be drawn for the pane..
657 return _aui
.PaneInfo_Gripper(*args
, **kwargs
)
659 def GripperTop(*args
, **kwargs
):
660 """GripperTop(self, bool attop=True) -> PaneInfo"""
661 return _aui
.PaneInfo_GripperTop(*args
, **kwargs
)
663 def CloseButton(*args
, **kwargs
):
665 CloseButton(self, bool visible=True) -> PaneInfo
667 CloseButton indicates that a close button should be drawn for the
671 return _aui
.PaneInfo_CloseButton(*args
, **kwargs
)
673 def MaximizeButton(*args
, **kwargs
):
675 MaximizeButton(self, bool visible=True) -> PaneInfo
677 MaximizeButton indicates that a maximize button should be drawn for
681 return _aui
.PaneInfo_MaximizeButton(*args
, **kwargs
)
683 def MinimizeButton(*args
, **kwargs
):
685 MinimizeButton(self, bool visible=True) -> PaneInfo
687 MinimizeButton indicates that a minimize button should be drawn for
691 return _aui
.PaneInfo_MinimizeButton(*args
, **kwargs
)
693 def PinButton(*args
, **kwargs
):
695 PinButton(self, bool visible=True) -> PaneInfo
697 PinButton indicates that a pin button should be drawn for the pane.
700 return _aui
.PaneInfo_PinButton(*args
, **kwargs
)
702 def DestroyOnClose(*args
, **kwargs
):
704 DestroyOnClose(self, bool b=True) -> PaneInfo
706 DestroyOnClose indicates whether a pane should be detroyed when it is
710 return _aui
.PaneInfo_DestroyOnClose(*args
, **kwargs
)
712 def TopDockable(*args
, **kwargs
):
714 TopDockable(self, bool b=True) -> PaneInfo
716 TopDockable indicates whether a pane can be docked at the top of the
720 return _aui
.PaneInfo_TopDockable(*args
, **kwargs
)
722 def BottomDockable(*args
, **kwargs
):
724 BottomDockable(self, bool b=True) -> PaneInfo
726 BottomDockable indicates whether a pane can be docked at the bottom of
730 return _aui
.PaneInfo_BottomDockable(*args
, **kwargs
)
732 def LeftDockable(*args
, **kwargs
):
734 LeftDockable(self, bool b=True) -> PaneInfo
736 LeftDockable indicates whether a pane can be docked on the left of the
740 return _aui
.PaneInfo_LeftDockable(*args
, **kwargs
)
742 def RightDockable(*args
, **kwargs
):
744 RightDockable(self, bool b=True) -> PaneInfo
746 RightDockable indicates whether a pane can be docked on the right of
750 return _aui
.PaneInfo_RightDockable(*args
, **kwargs
)
752 def Floatable(*args
, **kwargs
):
754 Floatable(self, bool b=True) -> PaneInfo
756 Floatable indicates whether a frame can be floated.
759 return _aui
.PaneInfo_Floatable(*args
, **kwargs
)
761 def Movable(*args
, **kwargs
):
763 Movable(self, bool b=True) -> PaneInfo
765 Movable indicates whether a frame can be moved.
768 return _aui
.PaneInfo_Movable(*args
, **kwargs
)
770 def Dockable(*args
, **kwargs
):
772 Dockable(self, bool b=True) -> PaneInfo
774 Dockable indicates whether a pane can be docked at any position of the
778 return _aui
.PaneInfo_Dockable(*args
, **kwargs
)
780 def DefaultPane(*args
, **kwargs
):
782 DefaultPane(self) -> PaneInfo
784 DefaultPane specifies that the pane should adopt the default pane
788 return _aui
.PaneInfo_DefaultPane(*args
, **kwargs
)
790 def CentrePane(*args
, **kwargs
):
792 CentrePane(self) -> PaneInfo
794 CentrePane specifies that the pane should adopt the default center
798 return _aui
.PaneInfo_CentrePane(*args
, **kwargs
)
800 def CenterPane(*args
, **kwargs
):
802 CenterPane(self) -> PaneInfo
804 CenterPane specifies that the pane should adopt the default center
808 return _aui
.PaneInfo_CenterPane(*args
, **kwargs
)
810 def ToolbarPane(*args
, **kwargs
):
812 ToolbarPane(self) -> PaneInfo
814 ToolbarPane specifies that the pane should adopt the default toolbar
818 return _aui
.PaneInfo_ToolbarPane(*args
, **kwargs
)
820 def SetFlag(*args
, **kwargs
):
822 SetFlag(self, int flag, bool option_state) -> PaneInfo
824 SetFlag turns the property given by flag on or off with the
825 option_state parameter.
828 return _aui
.PaneInfo_SetFlag(*args
, **kwargs
)
830 def HasFlag(*args
, **kwargs
):
832 HasFlag(self, int flag) -> bool
834 HasFlag returns ``True`` if the the property specified by flag is
838 return _aui
.PaneInfo_HasFlag(*args
, **kwargs
)
840 optionFloating
= _aui
.PaneInfo_optionFloating
841 optionHidden
= _aui
.PaneInfo_optionHidden
842 optionLeftDockable
= _aui
.PaneInfo_optionLeftDockable
843 optionRightDockable
= _aui
.PaneInfo_optionRightDockable
844 optionTopDockable
= _aui
.PaneInfo_optionTopDockable
845 optionBottomDockable
= _aui
.PaneInfo_optionBottomDockable
846 optionFloatable
= _aui
.PaneInfo_optionFloatable
847 optionMovable
= _aui
.PaneInfo_optionMovable
848 optionResizable
= _aui
.PaneInfo_optionResizable
849 optionPaneBorder
= _aui
.PaneInfo_optionPaneBorder
850 optionCaption
= _aui
.PaneInfo_optionCaption
851 optionGripper
= _aui
.PaneInfo_optionGripper
852 optionDestroyOnClose
= _aui
.PaneInfo_optionDestroyOnClose
853 optionToolbar
= _aui
.PaneInfo_optionToolbar
854 optionActive
= _aui
.PaneInfo_optionActive
855 optionGripperTop
= _aui
.PaneInfo_optionGripperTop
856 buttonClose
= _aui
.PaneInfo_buttonClose
857 buttonMaximize
= _aui
.PaneInfo_buttonMaximize
858 buttonMinimize
= _aui
.PaneInfo_buttonMinimize
859 buttonPin
= _aui
.PaneInfo_buttonPin
860 buttonCustom1
= _aui
.PaneInfo_buttonCustom1
861 buttonCustom2
= _aui
.PaneInfo_buttonCustom2
862 buttonCustom3
= _aui
.PaneInfo_buttonCustom3
863 actionPane
= _aui
.PaneInfo_actionPane
864 name
= property(_aui
.PaneInfo_name_get
, _aui
.PaneInfo_name_set
)
865 caption
= property(_aui
.PaneInfo_caption_get
, _aui
.PaneInfo_caption_set
)
866 window
= property(_aui
.PaneInfo_window_get
, _aui
.PaneInfo_window_set
)
867 frame
= property(_aui
.PaneInfo_frame_get
, _aui
.PaneInfo_frame_set
)
868 state
= property(_aui
.PaneInfo_state_get
, _aui
.PaneInfo_state_set
)
869 dock_direction
= property(_aui
.PaneInfo_dock_direction_get
, _aui
.PaneInfo_dock_direction_set
)
870 dock_layer
= property(_aui
.PaneInfo_dock_layer_get
, _aui
.PaneInfo_dock_layer_set
)
871 dock_row
= property(_aui
.PaneInfo_dock_row_get
, _aui
.PaneInfo_dock_row_set
)
872 dock_pos
= property(_aui
.PaneInfo_dock_pos_get
, _aui
.PaneInfo_dock_pos_set
)
873 best_size
= property(_aui
.PaneInfo_best_size_get
, _aui
.PaneInfo_best_size_set
)
874 min_size
= property(_aui
.PaneInfo_min_size_get
, _aui
.PaneInfo_min_size_set
)
875 max_size
= property(_aui
.PaneInfo_max_size_get
, _aui
.PaneInfo_max_size_set
)
876 floating_pos
= property(_aui
.PaneInfo_floating_pos_get
, _aui
.PaneInfo_floating_pos_set
)
877 floating_size
= property(_aui
.PaneInfo_floating_size_get
, _aui
.PaneInfo_floating_size_set
)
878 dock_proportion
= property(_aui
.PaneInfo_dock_proportion_get
, _aui
.PaneInfo_dock_proportion_set
)
879 buttons
= property(_aui
.PaneInfo_buttons_get
, _aui
.PaneInfo_buttons_set
)
880 rect
= property(_aui
.PaneInfo_rect_get
, _aui
.PaneInfo_rect_set
)
881 _aui
.PaneInfo_swigregister(PaneInfo
)
884 class FrameManager(_core
.EvtHandler
):
886 FrameManager manages the panes associated with it for a particular
887 `wx.Frame`, using a pane's `PaneInfo` information to determine each
888 pane's docking and floating behavior. FrameManager uses wxWidgets'
889 sizer mechanism to plan the layout of each frame. It uses a
890 replaceable `DockArt` class to do all drawing, so all drawing is
891 localized in one area, and may be customized depending on an
892 application's specific needs.
895 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
896 __repr__
= _swig_repr
897 def __init__(self
, *args
, **kwargs
):
899 __init__(self, Window managed_wnd=None, int flags=AUI_MGR_DEFAULT) -> FrameManager
903 :param managed_wnd: Specifies the `wx.Window` which should be
904 managed. If not set in the call to this constructor then
905 `SetManagedWindow` should be called later.
907 :param flags: Specifies options which allow the frame management
908 behavior to be modified.
911 _aui
.FrameManager_swiginit(self
,_aui
.new_FrameManager(*args
, **kwargs
))
912 __swig_destroy__
= _aui
.delete_FrameManager
913 __del__
= lambda self
: None;
914 def UnInit(*args
, **kwargs
):
918 UnInit uninitializes the framework and should be called before a
919 managed frame is destroyed. UnInit is usually called in the managed
923 return _aui
.FrameManager_UnInit(*args
, **kwargs
)
925 def SetFlags(*args
, **kwargs
):
927 SetFlags(self, int flags)
929 SetFlags is used to specify the FrameManager's behavioral
930 settings. The flags parameter is described in the docs for `__init__`
933 return _aui
.FrameManager_SetFlags(*args
, **kwargs
)
935 def GetFlags(*args
, **kwargs
):
937 GetFlags(self) -> int
939 GetFlags returns the current FrameManager's flags.
942 return _aui
.FrameManager_GetFlags(*args
, **kwargs
)
944 def SetManagedWindow(*args
, **kwargs
):
946 SetManagedWindow(self, Window managed_wnd)
948 SetManagedWindow is called to specify the window which is to be
949 managed by the FrameManager. It is normally a `wx.Frame` but it is
950 possible to also allow docking within any container window. This only
951 needs to be called if the window was not given to the manager in the
955 return _aui
.FrameManager_SetManagedWindow(*args
, **kwargs
)
957 def GetManagedWindow(*args
, **kwargs
):
959 GetManagedWindow(self) -> Window
961 GetManagedWindow returns the window currently being managed by the
965 return _aui
.FrameManager_GetManagedWindow(*args
, **kwargs
)
967 def SetArtProvider(*args
, **kwargs
):
969 SetArtProvider(self, DockArt art_provider)
971 SetArtProvider instructs FrameManager to use the art provider
972 specified for all drawing calls. This allows plugable look-and-feel
973 features. The previous art provider object, if any, will be destroyed
976 :note: If you wish to use a custom `DockArt` class to override drawing
977 or metrics then you shoudl derive your class from the `PyDockArt`
978 class, which has been instrumented for reflecting virtual calls to
982 return _aui
.FrameManager_SetArtProvider(*args
, **kwargs
)
984 def GetArtProvider(*args
, **kwargs
):
986 GetArtProvider(self) -> DockArt
988 GetArtProvider returns the current art provider being used.
991 return _aui
.FrameManager_GetArtProvider(*args
, **kwargs
)
993 def _GetPaneByWidget(*args
, **kwargs
):
994 """_GetPaneByWidget(self, Window window) -> PaneInfo"""
995 return _aui
.FrameManager__GetPaneByWidget(*args
, **kwargs
)
997 def _GetPaneByName(*args
, **kwargs
):
998 """_GetPaneByName(self, String name) -> PaneInfo"""
999 return _aui
.FrameManager__GetPaneByName(*args
, **kwargs
)
1001 def GetAllPanes(*args
, **kwargs
):
1003 GetAllPanes(self) -> list
1005 GetAllPanes returns a list of `PaneInfo` objects for all panes managed
1006 by the frame manager.
1009 return _aui
.FrameManager_GetAllPanes(*args
, **kwargs
)
1011 def _AddPane1(*args
, **kwargs
):
1012 """_AddPane1(self, Window window, PaneInfo pane_info) -> bool"""
1013 return _aui
.FrameManager__AddPane1(*args
, **kwargs
)
1015 def AddPaneAtPos(*args
, **kwargs
):
1016 """AddPaneAtPos(self, Window window, PaneInfo pane_info, Point drop_pos) -> bool"""
1017 return _aui
.FrameManager_AddPaneAtPos(*args
, **kwargs
)
1019 def _AddPane2(*args
, **kwargs
):
1020 """_AddPane2(self, Window window, int direction=LEFT, String caption=wxEmptyString) -> bool"""
1021 return _aui
.FrameManager__AddPane2(*args
, **kwargs
)
1023 def InsertPane(*args
, **kwargs
):
1025 InsertPane(self, Window window, PaneInfo insert_location, int insert_level=AUI_INSERT_PANE) -> bool
1027 InsertPane is used to insert either a previously unmanaged pane window
1028 into the frame manager, or to insert a currently managed pane
1029 somewhere else. InsertPane will push all panes, rows, or docks aside
1030 and insert the window into the position specified by
1031 ``insert_location``. Because ``insert_location`` can specify either a pane,
1032 dock row, or dock layer, the ``insert_level`` parameter is used to
1033 disambiguate this. The parameter ``insert_level`` can take a value of
1034 ``AUI_INSERT_PANE``, ``AUI_INSERT_ROW`` or ``AUI_INSERT_DOCK``.
1037 return _aui
.FrameManager_InsertPane(*args
, **kwargs
)
1039 def DetachPane(*args
, **kwargs
):
1041 DetachPane(self, Window window) -> bool
1043 DetachPane tells the FrameManager to stop managing the pane specified
1044 by window. The window, if in a floated frame, is reparented to the
1045 frame managed by FrameManager.
1048 return _aui
.FrameManager_DetachPane(*args
, **kwargs
)
1050 def SavePerspective(*args
, **kwargs
):
1052 SavePerspective(self) -> String
1054 SavePerspective saves the entire user interface layout into an encoded
1055 string, which can then be stored someplace by the application. When a
1056 perspective is restored using `LoadPerspective`, the entire user
1057 interface will return to the state it was when the perspective was
1061 return _aui
.FrameManager_SavePerspective(*args
, **kwargs
)
1063 def LoadPerspective(*args
, **kwargs
):
1065 LoadPerspective(self, String perspective, bool update=True) -> bool
1067 LoadPerspective loads a saved perspective. If ``update`` is ``True``,
1068 `Update` is automatically invoked, thus realizing the saved
1069 perspective on screen.
1072 return _aui
.FrameManager_LoadPerspective(*args
, **kwargs
)
1074 def Update(*args
, **kwargs
):
1078 Update shoudl be called called after any number of changes are made to
1079 any of the managed panes. Update must be invoked after `AddPane` or
1080 `InsertPane` are called in order to "realize" or "commit" the
1081 changes. In addition, any number of changes may be made to `PaneInfo`
1082 structures (retrieved with `GetPane` or `GetAllPanes`), but to realize
1083 the changes, Update must be called. This construction allows pane
1084 flicker to be avoided by updating the whole layout at one time.
1087 return _aui
.FrameManager_Update(*args
, **kwargs
)
1089 def DrawHintRect(*args
, **kwargs
):
1090 """DrawHintRect(self, Window pane_window, Point pt, Point offset)"""
1091 return _aui
.FrameManager_DrawHintRect(*args
, **kwargs
)
1093 def ShowHint(*args
, **kwargs
):
1094 """ShowHint(self, Rect rect)"""
1095 return _aui
.FrameManager_ShowHint(*args
, **kwargs
)
1097 def HideHint(*args
, **kwargs
):
1098 """HideHint(self)"""
1099 return _aui
.FrameManager_HideHint(*args
, **kwargs
)
1101 def OnRender(*args
, **kwargs
):
1102 """OnRender(self, FrameManagerEvent evt)"""
1103 return _aui
.FrameManager_OnRender(*args
, **kwargs
)
1105 def OnPaneButton(*args
, **kwargs
):
1106 """OnPaneButton(self, FrameManagerEvent evt)"""
1107 return _aui
.FrameManager_OnPaneButton(*args
, **kwargs
)
1109 def GetPane(self
, item
):
1111 GetPane(self, window_or_info item) -> PaneInfo
1113 GetPane is used to search for a `PaneInfo` object either by
1114 widget reference or by pane name, which acts as a unique id
1115 for a window pane. The returned `PaneInfo` object may then be
1116 modified to change a pane's look, state or position. After one
1117 or more modifications to the `PaneInfo`, `FrameManager.Update`
1118 should be called to realize the changes to the user interface.
1120 If the lookup failed (meaning the pane could not be found in
1121 the manager) GetPane returns an empty `PaneInfo`, a condition
1122 which can be checked by calling `PaneInfo.IsOk`.
1124 if isinstance(item
, wx
.Window
):
1125 return self
._GetPaneByWidget
(item
)
1127 return self
._GetPaneByName
(item
)
1129 def AddPane(self
, window
, info
=None, caption
=None):
1131 AddPane(self, window, info=None, caption=None) -> bool
1133 AddPane tells the frame manager to start managing a child
1134 window. There are two versions of this function. The first
1135 verison accepts a `PaneInfo` object for the ``info`` parameter
1136 and allows the full spectrum of pane parameter
1137 possibilities. (Say that 3 times fast!)
1139 The second version is used for simpler user interfaces which
1140 do not require as much configuration. In this case the
1141 ``info`` parameter specifies the direction property of the
1142 pane info, and defaults to ``wx.LEFT``. The pane caption may
1143 also be specified as an extra parameter in this form.
1145 if type(info
) == PaneInfo
:
1146 return self
._AddPane
1(window
, info
)
1153 return self
._AddPane
2(window
, info
, caption
)
1155 SetFrame
= wx
._deprecated
(SetManagedWindow
,
1156 "SetFrame is deprecated, use `SetManagedWindow` instead.")
1157 GetFrame
= wx
._deprecated
(GetManagedWindow
,
1158 "GetFrame is deprecated, use `GetManagedWindow` instead.")
1160 _aui
.FrameManager_swigregister(FrameManager
)
1162 class FrameManagerEvent(_core
.Event
):
1163 """Proxy of C++ FrameManagerEvent class"""
1164 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1165 __repr__
= _swig_repr
1166 def __init__(self
, *args
, **kwargs
):
1167 """__init__(self, EventType type=wxEVT_NULL) -> FrameManagerEvent"""
1168 _aui
.FrameManagerEvent_swiginit(self
,_aui
.new_FrameManagerEvent(*args
, **kwargs
))
1169 def Clone(*args
, **kwargs
):
1170 """Clone(self) -> Event"""
1171 return _aui
.FrameManagerEvent_Clone(*args
, **kwargs
)
1173 def SetPane(*args
, **kwargs
):
1174 """SetPane(self, PaneInfo p)"""
1175 return _aui
.FrameManagerEvent_SetPane(*args
, **kwargs
)
1177 def SetButton(*args
, **kwargs
):
1178 """SetButton(self, int b)"""
1179 return _aui
.FrameManagerEvent_SetButton(*args
, **kwargs
)
1181 def SetDC(*args
, **kwargs
):
1182 """SetDC(self, DC pdc)"""
1183 return _aui
.FrameManagerEvent_SetDC(*args
, **kwargs
)
1185 def GetPane(*args
, **kwargs
):
1186 """GetPane(self) -> PaneInfo"""
1187 return _aui
.FrameManagerEvent_GetPane(*args
, **kwargs
)
1189 def GetButton(*args
, **kwargs
):
1190 """GetButton(self) -> int"""
1191 return _aui
.FrameManagerEvent_GetButton(*args
, **kwargs
)
1193 def GetDC(*args
, **kwargs
):
1194 """GetDC(self) -> DC"""
1195 return _aui
.FrameManagerEvent_GetDC(*args
, **kwargs
)
1197 def Veto(*args
, **kwargs
):
1198 """Veto(self, bool veto=True)"""
1199 return _aui
.FrameManagerEvent_Veto(*args
, **kwargs
)
1201 def GetVeto(*args
, **kwargs
):
1202 """GetVeto(self) -> bool"""
1203 return _aui
.FrameManagerEvent_GetVeto(*args
, **kwargs
)
1205 def SetCanVeto(*args
, **kwargs
):
1206 """SetCanVeto(self, bool can_veto)"""
1207 return _aui
.FrameManagerEvent_SetCanVeto(*args
, **kwargs
)
1209 def CanVeto(*args
, **kwargs
):
1210 """CanVeto(self) -> bool"""
1211 return _aui
.FrameManagerEvent_CanVeto(*args
, **kwargs
)
1213 pane
= property(_aui
.FrameManagerEvent_pane_get
, _aui
.FrameManagerEvent_pane_set
)
1214 button
= property(_aui
.FrameManagerEvent_button_get
, _aui
.FrameManagerEvent_button_set
)
1215 veto_flag
= property(_aui
.FrameManagerEvent_veto_flag_get
, _aui
.FrameManagerEvent_veto_flag_set
)
1216 canveto_flag
= property(_aui
.FrameManagerEvent_canveto_flag_get
, _aui
.FrameManagerEvent_canveto_flag_set
)
1217 dc
= property(_aui
.FrameManagerEvent_dc_get
, _aui
.FrameManagerEvent_dc_set
)
1218 _aui
.FrameManagerEvent_swigregister(FrameManagerEvent
)
1220 class DockInfo(object):
1221 """Proxy of C++ DockInfo class"""
1222 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1223 __repr__
= _swig_repr
1224 def __init__(self
, *args
, **kwargs
):
1225 """__init__(self) -> DockInfo"""
1226 _aui
.DockInfo_swiginit(self
,_aui
.new_DockInfo(*args
, **kwargs
))
1227 def IsOk(*args
, **kwargs
):
1228 """IsOk(self) -> bool"""
1229 return _aui
.DockInfo_IsOk(*args
, **kwargs
)
1231 def IsHorizontal(*args
, **kwargs
):
1232 """IsHorizontal(self) -> bool"""
1233 return _aui
.DockInfo_IsHorizontal(*args
, **kwargs
)
1235 def IsVertical(*args
, **kwargs
):
1236 """IsVertical(self) -> bool"""
1237 return _aui
.DockInfo_IsVertical(*args
, **kwargs
)
1239 panes
= property(_aui
.DockInfo_panes_get
, _aui
.DockInfo_panes_set
)
1240 rect
= property(_aui
.DockInfo_rect_get
, _aui
.DockInfo_rect_set
)
1241 dock_direction
= property(_aui
.DockInfo_dock_direction_get
, _aui
.DockInfo_dock_direction_set
)
1242 dock_layer
= property(_aui
.DockInfo_dock_layer_get
, _aui
.DockInfo_dock_layer_set
)
1243 dock_row
= property(_aui
.DockInfo_dock_row_get
, _aui
.DockInfo_dock_row_set
)
1244 size
= property(_aui
.DockInfo_size_get
, _aui
.DockInfo_size_set
)
1245 min_size
= property(_aui
.DockInfo_min_size_get
, _aui
.DockInfo_min_size_set
)
1246 resizable
= property(_aui
.DockInfo_resizable_get
, _aui
.DockInfo_resizable_set
)
1247 toolbar
= property(_aui
.DockInfo_toolbar_get
, _aui
.DockInfo_toolbar_set
)
1248 fixed
= property(_aui
.DockInfo_fixed_get
, _aui
.DockInfo_fixed_set
)
1249 _aui
.DockInfo_swigregister(DockInfo
)
1251 class DockUIPart(object):
1252 """Proxy of C++ DockUIPart class"""
1253 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1254 def __init__(self
): raise AttributeError, "No constructor defined"
1255 __repr__
= _swig_repr
1256 typeCaption
= _aui
.DockUIPart_typeCaption
1257 typeGripper
= _aui
.DockUIPart_typeGripper
1258 typeDock
= _aui
.DockUIPart_typeDock
1259 typeDockSizer
= _aui
.DockUIPart_typeDockSizer
1260 typePane
= _aui
.DockUIPart_typePane
1261 typePaneSizer
= _aui
.DockUIPart_typePaneSizer
1262 typeBackground
= _aui
.DockUIPart_typeBackground
1263 typePaneBorder
= _aui
.DockUIPart_typePaneBorder
1264 typePaneButton
= _aui
.DockUIPart_typePaneButton
1265 type = property(_aui
.DockUIPart_type_get
, _aui
.DockUIPart_type_set
)
1266 orientation
= property(_aui
.DockUIPart_orientation_get
, _aui
.DockUIPart_orientation_set
)
1267 dock
= property(_aui
.DockUIPart_dock_get
, _aui
.DockUIPart_dock_set
)
1268 pane
= property(_aui
.DockUIPart_pane_get
, _aui
.DockUIPart_pane_set
)
1269 button
= property(_aui
.DockUIPart_button_get
, _aui
.DockUIPart_button_set
)
1270 cont_sizer
= property(_aui
.DockUIPart_cont_sizer_get
, _aui
.DockUIPart_cont_sizer_set
)
1271 sizer_item
= property(_aui
.DockUIPart_sizer_item_get
, _aui
.DockUIPart_sizer_item_set
)
1272 rect
= property(_aui
.DockUIPart_rect_get
, _aui
.DockUIPart_rect_set
)
1273 _aui
.DockUIPart_swigregister(DockUIPart
)
1275 class PaneButton(object):
1276 """Proxy of C++ PaneButton class"""
1277 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1278 def __init__(self
): raise AttributeError, "No constructor defined"
1279 __repr__
= _swig_repr
1280 button_id
= property(_aui
.PaneButton_button_id_get
, _aui
.PaneButton_button_id_set
)
1281 _aui
.PaneButton_swigregister(PaneButton
)
1283 wxEVT_AUI_PANEBUTTON
= _aui
.wxEVT_AUI_PANEBUTTON
1284 wxEVT_AUI_PANECLOSE
= _aui
.wxEVT_AUI_PANECLOSE
1285 wxEVT_AUI_RENDER
= _aui
.wxEVT_AUI_RENDER
1286 EVT_AUI_PANEBUTTON
= wx
.PyEventBinder( wxEVT_AUI_PANEBUTTON
)
1287 EVT_AUI_PANECLOSE
= wx
.PyEventBinder( wxEVT_AUI_PANECLOSE
)
1288 EVT_AUI_RENDER
= wx
.PyEventBinder( wxEVT_AUI_RENDER
)
1290 class DockArt(object):
1292 DockArt is an art provider class which does all of the drawing for
1293 `FrameManager`. This allows the library caller to customize or replace the
1294 dock art and drawing routines by deriving a new class from `PyDockArt`. The
1295 active dock art class can be set via `FrameManager.SetArtProvider`.
1298 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1299 def __init__(self
): raise AttributeError, "No constructor defined"
1300 __repr__
= _swig_repr
1301 __swig_destroy__
= _aui
.delete_DockArt
1302 __del__
= lambda self
: None;
1303 def GetMetric(*args
, **kwargs
):
1304 """GetMetric(self, int id) -> int"""
1305 return _aui
.DockArt_GetMetric(*args
, **kwargs
)
1307 def SetMetric(*args
, **kwargs
):
1308 """SetMetric(self, int id, int new_val)"""
1309 return _aui
.DockArt_SetMetric(*args
, **kwargs
)
1311 def SetFont(*args
, **kwargs
):
1312 """SetFont(self, int id, Font font)"""
1313 return _aui
.DockArt_SetFont(*args
, **kwargs
)
1315 def GetFont(*args
, **kwargs
):
1316 """GetFont(self, int id) -> Font"""
1317 return _aui
.DockArt_GetFont(*args
, **kwargs
)
1319 def GetColour(*args
, **kwargs
):
1320 """GetColour(self, int id) -> Colour"""
1321 return _aui
.DockArt_GetColour(*args
, **kwargs
)
1323 def SetColour(*args
, **kwargs
):
1324 """SetColour(self, int id, wxColor colour)"""
1325 return _aui
.DockArt_SetColour(*args
, **kwargs
)
1327 def GetColor(*args
, **kwargs
):
1328 """GetColor(self, int id) -> Colour"""
1329 return _aui
.DockArt_GetColor(*args
, **kwargs
)
1331 def SetColor(*args
, **kwargs
):
1332 """SetColor(self, int id, Colour color)"""
1333 return _aui
.DockArt_SetColor(*args
, **kwargs
)
1335 def DrawSash(*args
, **kwargs
):
1336 """DrawSash(self, DC dc, int orientation, Rect rect)"""
1337 return _aui
.DockArt_DrawSash(*args
, **kwargs
)
1339 def DrawBackground(*args
, **kwargs
):
1340 """DrawBackground(self, DC dc, int orientation, Rect rect)"""
1341 return _aui
.DockArt_DrawBackground(*args
, **kwargs
)
1343 def DrawCaption(*args
, **kwargs
):
1344 """DrawCaption(self, DC dc, String text, Rect rect, PaneInfo pane)"""
1345 return _aui
.DockArt_DrawCaption(*args
, **kwargs
)
1347 def DrawGripper(*args
, **kwargs
):
1348 """DrawGripper(self, DC dc, Rect rect, PaneInfo pane)"""
1349 return _aui
.DockArt_DrawGripper(*args
, **kwargs
)
1351 def DrawBorder(*args
, **kwargs
):
1352 """DrawBorder(self, DC dc, Rect rect, PaneInfo pane)"""
1353 return _aui
.DockArt_DrawBorder(*args
, **kwargs
)
1355 def DrawPaneButton(*args
, **kwargs
):
1356 """DrawPaneButton(self, DC dc, int button, int button_state, Rect rect, PaneInfo pane)"""
1357 return _aui
.DockArt_DrawPaneButton(*args
, **kwargs
)
1359 _aui
.DockArt_swigregister(DockArt
)
1361 class DefaultDockArt(DockArt
):
1363 DefaultDockArt is the type of art class constructed by default for the
1366 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1367 __repr__
= _swig_repr
1368 def __init__(self
, *args
, **kwargs
):
1370 __init__(self) -> DefaultDockArt
1372 DefaultDockArt is the type of art class constructed by default for the
1375 _aui
.DefaultDockArt_swiginit(self
,_aui
.new_DefaultDockArt(*args
, **kwargs
))
1376 _aui
.DefaultDockArt_swigregister(DefaultDockArt
)
1378 class FloatingPane(_windows
.MiniFrame
):
1379 """Proxy of C++ FloatingPane class"""
1380 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1381 __repr__
= _swig_repr
1382 def __init__(self
, *args
, **kwargs
):
1384 __init__(self, Window parent, FrameManager owner_mgr, PaneInfo pane,
1385 int id=ID_ANY) -> FloatingPane
1387 _aui
.FloatingPane_swiginit(self
,_aui
.new_FloatingPane(*args
, **kwargs
))
1388 __swig_destroy__
= _aui
.delete_FloatingPane
1389 __del__
= lambda self
: None;
1390 def SetPaneWindow(*args
, **kwargs
):
1391 """SetPaneWindow(self, PaneInfo pane)"""
1392 return _aui
.FloatingPane_SetPaneWindow(*args
, **kwargs
)
1394 _aui
.FloatingPane_swigregister(FloatingPane
)
1396 class AuiNotebookEvent(_core
.NotifyEvent
):
1397 """Proxy of C++ AuiNotebookEvent class"""
1398 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1399 __repr__
= _swig_repr
1400 def __init__(self
, *args
, **kwargs
):
1401 """__init__(self, EventType command_type=wxEVT_NULL, int win_id=0) -> AuiNotebookEvent"""
1402 _aui
.AuiNotebookEvent_swiginit(self
,_aui
.new_AuiNotebookEvent(*args
, **kwargs
))
1403 def SetSelection(*args
, **kwargs
):
1404 """SetSelection(self, int s)"""
1405 return _aui
.AuiNotebookEvent_SetSelection(*args
, **kwargs
)
1407 def SetOldSelection(*args
, **kwargs
):
1408 """SetOldSelection(self, int s)"""
1409 return _aui
.AuiNotebookEvent_SetOldSelection(*args
, **kwargs
)
1411 def GetSelection(*args
, **kwargs
):
1413 GetSelection(self) -> int
1415 Returns item index for a listbox or choice selection event (not valid
1418 return _aui
.AuiNotebookEvent_GetSelection(*args
, **kwargs
)
1420 def GetOldSelection(*args
, **kwargs
):
1421 """GetOldSelection(self) -> int"""
1422 return _aui
.AuiNotebookEvent_GetOldSelection(*args
, **kwargs
)
1424 old_selection
= property(_aui
.AuiNotebookEvent_old_selection_get
, _aui
.AuiNotebookEvent_old_selection_set
)
1425 selection
= property(_aui
.AuiNotebookEvent_selection_get
, _aui
.AuiNotebookEvent_selection_set
)
1426 _aui
.AuiNotebookEvent_swigregister(AuiNotebookEvent
)
1428 class AuiNotebookPage(object):
1429 """Proxy of C++ AuiNotebookPage class"""
1430 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1431 def __init__(self
): raise AttributeError, "No constructor defined"
1432 __repr__
= _swig_repr
1433 window
= property(_aui
.AuiNotebookPage_window_get
, _aui
.AuiNotebookPage_window_set
)
1434 caption
= property(_aui
.AuiNotebookPage_caption_get
, _aui
.AuiNotebookPage_caption_set
)
1435 bitmap
= property(_aui
.AuiNotebookPage_bitmap_get
, _aui
.AuiNotebookPage_bitmap_set
)
1436 rect
= property(_aui
.AuiNotebookPage_rect_get
, _aui
.AuiNotebookPage_rect_set
)
1437 active
= property(_aui
.AuiNotebookPage_active_get
, _aui
.AuiNotebookPage_active_set
)
1438 _aui
.AuiNotebookPage_swigregister(AuiNotebookPage
)
1440 class AuiTabContainerButton(object):
1441 """Proxy of C++ AuiTabContainerButton class"""
1442 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1443 def __init__(self
): raise AttributeError, "No constructor defined"
1444 __repr__
= _swig_repr
1445 id = property(_aui
.AuiTabContainerButton_id_get
, _aui
.AuiTabContainerButton_id_set
)
1446 cur_state
= property(_aui
.AuiTabContainerButton_cur_state_get
, _aui
.AuiTabContainerButton_cur_state_set
)
1447 bitmap
= property(_aui
.AuiTabContainerButton_bitmap_get
, _aui
.AuiTabContainerButton_bitmap_set
)
1448 rect
= property(_aui
.AuiTabContainerButton_rect_get
, _aui
.AuiTabContainerButton_rect_set
)
1449 _aui
.AuiTabContainerButton_swigregister(AuiTabContainerButton
)
1451 class AuiTabContainer(object):
1452 """Proxy of C++ AuiTabContainer class"""
1453 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1454 __repr__
= _swig_repr
1455 def __init__(self
, *args
, **kwargs
):
1456 """__init__(self) -> AuiTabContainer"""
1457 _aui
.AuiTabContainer_swiginit(self
,_aui
.new_AuiTabContainer(*args
, **kwargs
))
1458 __swig_destroy__
= _aui
.delete_AuiTabContainer
1459 __del__
= lambda self
: None;
1460 def AddPage(*args
, **kwargs
):
1461 """AddPage(self, Window page, AuiNotebookPage info) -> bool"""
1462 return _aui
.AuiTabContainer_AddPage(*args
, **kwargs
)
1464 def InsertPage(*args
, **kwargs
):
1465 """InsertPage(self, Window page, AuiNotebookPage info, size_t idx) -> bool"""
1466 return _aui
.AuiTabContainer_InsertPage(*args
, **kwargs
)
1468 def RemovePage(*args
, **kwargs
):
1469 """RemovePage(self, Window page) -> bool"""
1470 return _aui
.AuiTabContainer_RemovePage(*args
, **kwargs
)
1472 def SetActivePage(*args
):
1474 SetActivePage(self, Window page) -> bool
1475 SetActivePage(self, size_t page) -> bool
1477 return _aui
.AuiTabContainer_SetActivePage(*args
)
1479 def SetNoneActive(*args
, **kwargs
):
1480 """SetNoneActive(self)"""
1481 return _aui
.AuiTabContainer_SetNoneActive(*args
, **kwargs
)
1483 def GetActivePage(*args
, **kwargs
):
1484 """GetActivePage(self) -> int"""
1485 return _aui
.AuiTabContainer_GetActivePage(*args
, **kwargs
)
1487 def TabHitTest(*args
, **kwargs
):
1488 """TabHitTest(self, int x, int y, Window hit) -> bool"""
1489 return _aui
.AuiTabContainer_TabHitTest(*args
, **kwargs
)
1491 def ButtonHitTest(*args
, **kwargs
):
1492 """ButtonHitTest(self, int x, int y, AuiTabContainerButton hit) -> bool"""
1493 return _aui
.AuiTabContainer_ButtonHitTest(*args
, **kwargs
)
1495 def GetWindowFromIdx(*args
, **kwargs
):
1496 """GetWindowFromIdx(self, size_t idx) -> Window"""
1497 return _aui
.AuiTabContainer_GetWindowFromIdx(*args
, **kwargs
)
1499 def GetIdxFromWindow(*args
, **kwargs
):
1500 """GetIdxFromWindow(self, Window page) -> int"""
1501 return _aui
.AuiTabContainer_GetIdxFromWindow(*args
, **kwargs
)
1503 def GetPageCount(*args
, **kwargs
):
1504 """GetPageCount(self) -> size_t"""
1505 return _aui
.AuiTabContainer_GetPageCount(*args
, **kwargs
)
1507 def GetPage(*args
, **kwargs
):
1508 """GetPage(self, size_t idx) -> AuiNotebookPage"""
1509 return _aui
.AuiTabContainer_GetPage(*args
, **kwargs
)
1511 def GetPages(*args
, **kwargs
):
1512 """GetPages(self) -> wxAuiNotebookPageArray"""
1513 return _aui
.AuiTabContainer_GetPages(*args
, **kwargs
)
1515 def SetNormalFont(*args
, **kwargs
):
1516 """SetNormalFont(self, Font normal_font)"""
1517 return _aui
.AuiTabContainer_SetNormalFont(*args
, **kwargs
)
1519 def SetSelectedFont(*args
, **kwargs
):
1520 """SetSelectedFont(self, Font selected_font)"""
1521 return _aui
.AuiTabContainer_SetSelectedFont(*args
, **kwargs
)
1523 def SetMeasuringFont(*args
, **kwargs
):
1524 """SetMeasuringFont(self, Font measuring_font)"""
1525 return _aui
.AuiTabContainer_SetMeasuringFont(*args
, **kwargs
)
1527 def DoShowHide(*args
, **kwargs
):
1528 """DoShowHide(self)"""
1529 return _aui
.AuiTabContainer_DoShowHide(*args
, **kwargs
)
1531 def SetRect(*args
, **kwargs
):
1532 """SetRect(self, Rect rect)"""
1533 return _aui
.AuiTabContainer_SetRect(*args
, **kwargs
)
1535 def AddButton(*args
, **kwargs
):
1536 """AddButton(self, int id, Bitmap bmp)"""
1537 return _aui
.AuiTabContainer_AddButton(*args
, **kwargs
)
1539 _aui
.AuiTabContainer_swigregister(AuiTabContainer
)
1541 class AuiTabCtrl(_core
.Control
,AuiTabContainer
):
1542 """Proxy of C++ AuiTabCtrl class"""
1543 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1544 __repr__
= _swig_repr
1545 def __init__(self
, *args
, **kwargs
):
1547 __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
1548 Size size=DefaultSize, long style=0) -> AuiTabCtrl
1550 _aui
.AuiTabCtrl_swiginit(self
,_aui
.new_AuiTabCtrl(*args
, **kwargs
))
1551 self
._setOORInfo
(self
)
1553 _aui
.AuiTabCtrl_swigregister(AuiTabCtrl
)
1555 class AuiMultiNotebook(_core
.Control
):
1556 """Proxy of C++ AuiMultiNotebook class"""
1557 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1558 __repr__
= _swig_repr
1559 def __init__(self
, *args
, **kwargs
):
1561 __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
1562 Size size=DefaultSize, long style=0) -> AuiMultiNotebook
1564 _aui
.AuiMultiNotebook_swiginit(self
,_aui
.new_AuiMultiNotebook(*args
, **kwargs
))
1565 self
._setOORInfo
(self
)
1567 def Create(*args
, **kwargs
):
1569 Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
1570 Size size=DefaultSize, long style=0) -> bool
1572 Do the 2nd phase and create the GUI control.
1574 return _aui
.AuiMultiNotebook_Create(*args
, **kwargs
)
1576 def AddPage(*args
, **kwargs
):
1577 """AddPage(self, Window page, String caption, bool select=False, Bitmap bitmap=wxNullBitmap) -> bool"""
1578 return _aui
.AuiMultiNotebook_AddPage(*args
, **kwargs
)
1580 def InsertPage(*args
, **kwargs
):
1582 InsertPage(self, size_t page_idx, Window page, String caption, bool select=False,
1583 Bitmap bitmap=wxNullBitmap) -> bool
1585 return _aui
.AuiMultiNotebook_InsertPage(*args
, **kwargs
)
1587 def DeletePage(*args
, **kwargs
):
1588 """DeletePage(self, size_t page) -> bool"""
1589 return _aui
.AuiMultiNotebook_DeletePage(*args
, **kwargs
)
1591 def RemovePage(*args
, **kwargs
):
1592 """RemovePage(self, size_t page) -> bool"""
1593 return _aui
.AuiMultiNotebook_RemovePage(*args
, **kwargs
)
1595 def SetPageText(*args
, **kwargs
):
1596 """SetPageText(self, size_t page, String text) -> bool"""
1597 return _aui
.AuiMultiNotebook_SetPageText(*args
, **kwargs
)
1599 def SetSelection(*args
, **kwargs
):
1600 """SetSelection(self, size_t new_page) -> size_t"""
1601 return _aui
.AuiMultiNotebook_SetSelection(*args
, **kwargs
)
1603 def GetSelection(*args
, **kwargs
):
1604 """GetSelection(self) -> int"""
1605 return _aui
.AuiMultiNotebook_GetSelection(*args
, **kwargs
)
1607 def GetPageCount(*args
, **kwargs
):
1608 """GetPageCount(self) -> size_t"""
1609 return _aui
.AuiMultiNotebook_GetPageCount(*args
, **kwargs
)
1611 def GetPage(*args
, **kwargs
):
1612 """GetPage(self, size_t page_idx) -> Window"""
1613 return _aui
.AuiMultiNotebook_GetPage(*args
, **kwargs
)
1615 _aui
.AuiMultiNotebook_swigregister(AuiMultiNotebook
)
1617 def PreAuiMultiNotebook(*args
, **kwargs
):
1618 """PreAuiMultiNotebook() -> AuiMultiNotebook"""
1619 val
= _aui
.new_PreAuiMultiNotebook(*args
, **kwargs
)
1620 self
._setOORInfo
(self
)
1623 wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
1624 wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
1625 wxEVT_COMMAND_AUINOTEBOOK_BUTTON
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_BUTTON
1626 wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
1627 wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
1628 wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
1629 EVT_AUINOTEBOOK_PAGE_CHANGED
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
, 1 )
1630 EVT_AUINOTEBOOK_PAGE_CHANGING
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
, 1 )
1631 EVT_AUINOTEBOOK_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BUTTON
, 1 )
1632 EVT_AUINOTEBOOK_BEGIN_DRAG
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
, 1 )
1633 EVT_AUINOTEBOOK_END_DRAG
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
, 1 )
1634 EVT_AUINOTEBOOK_DRAG_MOTION
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
, 1 )
1636 class PyDockArt(DefaultDockArt
):
1638 This version of the `DockArt` class has been instrumented to be
1639 subclassable in Python and to reflect all calls to the C++ base class
1640 methods to the Python methods implemented in the derived class.
1642 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1643 def __init__(self
): raise AttributeError, "No constructor defined"
1644 __repr__
= _swig_repr
1645 _aui
.PyDockArt_swigregister(PyDockArt
)