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_DISABLE_VENETIAN_BLINDS_FADE
= _aui
.AUI_MGR_DISABLE_VENETIAN_BLINDS_FADE
172 AUI_MGR_DEFAULT
= _aui
.AUI_MGR_DEFAULT
173 AUI_ART_SASH_SIZE
= _aui
.AUI_ART_SASH_SIZE
174 AUI_ART_CAPTION_SIZE
= _aui
.AUI_ART_CAPTION_SIZE
175 AUI_ART_GRIPPER_SIZE
= _aui
.AUI_ART_GRIPPER_SIZE
176 AUI_ART_PANE_BORDER_SIZE
= _aui
.AUI_ART_PANE_BORDER_SIZE
177 AUI_ART_PANE_BUTTON_SIZE
= _aui
.AUI_ART_PANE_BUTTON_SIZE
178 AUI_ART_BACKGROUND_COLOUR
= _aui
.AUI_ART_BACKGROUND_COLOUR
179 AUI_ART_SASH_COLOUR
= _aui
.AUI_ART_SASH_COLOUR
180 AUI_ART_ACTIVE_CAPTION_COLOUR
= _aui
.AUI_ART_ACTIVE_CAPTION_COLOUR
181 AUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR
= _aui
.AUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR
182 AUI_ART_INACTIVE_CAPTION_COLOUR
= _aui
.AUI_ART_INACTIVE_CAPTION_COLOUR
183 AUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR
= _aui
.AUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR
184 AUI_ART_ACTIVE_CAPTION_TEXT_COLOUR
= _aui
.AUI_ART_ACTIVE_CAPTION_TEXT_COLOUR
185 AUI_ART_INACTIVE_CAPTION_TEXT_COLOUR
= _aui
.AUI_ART_INACTIVE_CAPTION_TEXT_COLOUR
186 AUI_ART_BORDER_COLOUR
= _aui
.AUI_ART_BORDER_COLOUR
187 AUI_ART_GRIPPER_COLOUR
= _aui
.AUI_ART_GRIPPER_COLOUR
188 AUI_ART_CAPTION_FONT
= _aui
.AUI_ART_CAPTION_FONT
189 AUI_ART_GRADIENT_TYPE
= _aui
.AUI_ART_GRADIENT_TYPE
190 AUI_GRADIENT_NONE
= _aui
.AUI_GRADIENT_NONE
191 AUI_GRADIENT_VERTICAL
= _aui
.AUI_GRADIENT_VERTICAL
192 AUI_GRADIENT_HORIZONTAL
= _aui
.AUI_GRADIENT_HORIZONTAL
193 AUI_BUTTON_STATE_NORMAL
= _aui
.AUI_BUTTON_STATE_NORMAL
194 AUI_BUTTON_STATE_HOVER
= _aui
.AUI_BUTTON_STATE_HOVER
195 AUI_BUTTON_STATE_PRESSED
= _aui
.AUI_BUTTON_STATE_PRESSED
196 AUI_INSERT_PANE
= _aui
.AUI_INSERT_PANE
197 AUI_INSERT_ROW
= _aui
.AUI_INSERT_ROW
198 AUI_INSERT_DOCK
= _aui
.AUI_INSERT_DOCK
199 class PaneInfo(object):
201 PaneInfo specifies all the parameters for a pane for the
202 `FrameManager`. These parameters specify where the pane is on the
203 screen, whether it is docked or floating, or hidden. In addition,
204 these parameters specify the pane's docked position, floating
205 position, preferred size, minimum size, caption text among many other
209 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
210 __repr__
= _swig_repr
211 def __init__(self
, *args
, **kwargs
):
213 __init__(self) -> PaneInfo
215 PaneInfo specifies all the parameters for a pane for the
216 `FrameManager`. These parameters specify where the pane is on the
217 screen, whether it is docked or floating, or hidden. In addition,
218 these parameters specify the pane's docked position, floating
219 position, preferred size, minimum size, caption text among many other
223 _aui
.PaneInfo_swiginit(self
,_aui
.new_PaneInfo(*args
, **kwargs
))
224 __swig_destroy__
= _aui
.delete_PaneInfo
225 __del__
= lambda self
: None;
226 def SafeSet(*args
, **kwargs
):
227 """SafeSet(self, PaneInfo source)"""
228 return _aui
.PaneInfo_SafeSet(*args
, **kwargs
)
230 def IsOk(*args
, **kwargs
):
234 IsOk returns ``True`` if the PaneInfo structure is valid.
237 return _aui
.PaneInfo_IsOk(*args
, **kwargs
)
239 def IsFixed(*args
, **kwargs
):
241 IsFixed(self) -> bool
243 IsFixed returns ``True`` if the pane cannot be resized.
246 return _aui
.PaneInfo_IsFixed(*args
, **kwargs
)
248 def IsResizable(*args
, **kwargs
):
250 IsResizable(self) -> bool
252 IsResizeable returns ``True`` if the pane can be resized.
255 return _aui
.PaneInfo_IsResizable(*args
, **kwargs
)
257 def IsShown(*args
, **kwargs
):
259 IsShown(self) -> bool
261 IsShown returns ``True`` if the pane should be drawn on the screen.
264 return _aui
.PaneInfo_IsShown(*args
, **kwargs
)
266 def IsFloating(*args
, **kwargs
):
268 IsFloating(self) -> bool
270 IsFloating returns ``True`` if the pane is floating.
273 return _aui
.PaneInfo_IsFloating(*args
, **kwargs
)
275 def IsDocked(*args
, **kwargs
):
277 IsDocked(self) -> bool
279 IsDocked returns ``True`` if the pane is docked.
282 return _aui
.PaneInfo_IsDocked(*args
, **kwargs
)
284 def IsToolbar(*args
, **kwargs
):
286 IsToolbar(self) -> bool
288 IsToolbar returns ``True`` if the pane contains a toolbar.
291 return _aui
.PaneInfo_IsToolbar(*args
, **kwargs
)
293 def IsTopDockable(*args
, **kwargs
):
295 IsTopDockable(self) -> bool
297 IsTopDockable returns ``True`` if the pane can be docked at the top of
301 return _aui
.PaneInfo_IsTopDockable(*args
, **kwargs
)
303 def IsBottomDockable(*args
, **kwargs
):
305 IsBottomDockable(self) -> bool
307 IsBottomDockable returns ``True`` if the pane can be docked at the
308 bottom of the managed frame.
311 return _aui
.PaneInfo_IsBottomDockable(*args
, **kwargs
)
313 def IsLeftDockable(*args
, **kwargs
):
315 IsLeftDockable(self) -> bool
317 IsLeftDockable returns ``True`` if the pane can be docked on the left
318 of the managed frame.
321 return _aui
.PaneInfo_IsLeftDockable(*args
, **kwargs
)
323 def IsRightDockable(*args
, **kwargs
):
325 IsRightDockable(self) -> bool
327 IsRightDockable returns ``True`` if the pane can be docked on the
328 right of the managed frame.
331 return _aui
.PaneInfo_IsRightDockable(*args
, **kwargs
)
333 def IsFloatable(*args
, **kwargs
):
335 IsFloatable(self) -> bool
337 IsFloatable returns ``True`` if the pane can be undocked and displayed
338 as a floating window.
341 return _aui
.PaneInfo_IsFloatable(*args
, **kwargs
)
343 def IsMovable(*args
, **kwargs
):
345 IsMovable(self) -> bool
347 IsMoveable returns ``True`` if the docked frame can be undocked or moved
348 to another dock position.
351 return _aui
.PaneInfo_IsMovable(*args
, **kwargs
)
353 def IsDestroyOnClose(*args
, **kwargs
):
354 """IsDestroyOnClose(self) -> bool"""
355 return _aui
.PaneInfo_IsDestroyOnClose(*args
, **kwargs
)
357 def HasCaption(*args
, **kwargs
):
359 HasCaption(self) -> bool
361 HasCaption returns ``True`` if the pane displays a caption.
364 return _aui
.PaneInfo_HasCaption(*args
, **kwargs
)
366 def HasGripper(*args
, **kwargs
):
368 HasGripper(self) -> bool
370 HasGripper returns ``True`` if the pane displays a gripper.
373 return _aui
.PaneInfo_HasGripper(*args
, **kwargs
)
375 def HasBorder(*args
, **kwargs
):
377 HasBorder(self) -> bool
379 HasBorder returns ``True`` if the pane displays a border.
382 return _aui
.PaneInfo_HasBorder(*args
, **kwargs
)
384 def HasCloseButton(*args
, **kwargs
):
386 HasCloseButton(self) -> bool
388 HasCloseButton returns ``True`` if the pane displays a button to close
392 return _aui
.PaneInfo_HasCloseButton(*args
, **kwargs
)
394 def HasMaximizeButton(*args
, **kwargs
):
396 HasMaximizeButton(self) -> bool
398 HasMaximizeButton returns ``True`` if the pane displays a button to
402 return _aui
.PaneInfo_HasMaximizeButton(*args
, **kwargs
)
404 def HasMinimizeButton(*args
, **kwargs
):
406 HasMinimizeButton(self) -> bool
408 HasMinimizeButton returns ``True`` if the pane displays a button to
412 return _aui
.PaneInfo_HasMinimizeButton(*args
, **kwargs
)
414 def HasPinButton(*args
, **kwargs
):
416 HasPinButton(self) -> bool
418 HasPinButton returns ``True`` if the pane displays a button to float
422 return _aui
.PaneInfo_HasPinButton(*args
, **kwargs
)
424 def HasGripperTop(*args
, **kwargs
):
425 """HasGripperTop(self) -> bool"""
426 return _aui
.PaneInfo_HasGripperTop(*args
, **kwargs
)
428 def Window(*args
, **kwargs
):
429 """Window(self, Window w) -> PaneInfo"""
430 return _aui
.PaneInfo_Window(*args
, **kwargs
)
432 def Name(*args
, **kwargs
):
434 Name(self, String n) -> PaneInfo
436 Name sets the name of the pane so it can be referenced in lookup
440 return _aui
.PaneInfo_Name(*args
, **kwargs
)
442 def Caption(*args
, **kwargs
):
444 Caption(self, String c) -> PaneInfo
446 Caption sets the caption of the pane.
449 return _aui
.PaneInfo_Caption(*args
, **kwargs
)
451 def Left(*args
, **kwargs
):
453 Left(self) -> PaneInfo
455 Left sets the pane dock position to the left side of the frame.
458 return _aui
.PaneInfo_Left(*args
, **kwargs
)
460 def Right(*args
, **kwargs
):
462 Right(self) -> PaneInfo
464 Right sets the pane dock position to the right side of the frame.
467 return _aui
.PaneInfo_Right(*args
, **kwargs
)
469 def Top(*args
, **kwargs
):
471 Top(self) -> PaneInfo
473 Top sets the pane dock position to the top of the frame.
476 return _aui
.PaneInfo_Top(*args
, **kwargs
)
478 def Bottom(*args
, **kwargs
):
480 Bottom(self) -> PaneInfo
482 Bottom sets the pane dock position to the bottom of the frame.
485 return _aui
.PaneInfo_Bottom(*args
, **kwargs
)
487 def Center(*args
, **kwargs
):
489 Center(self) -> PaneInfo
491 Center sets the pane to the center position of the frame.
494 return _aui
.PaneInfo_Center(*args
, **kwargs
)
496 def Centre(*args
, **kwargs
):
498 Centre(self) -> PaneInfo
500 Centre sets the pane to the center position of the frame.
503 return _aui
.PaneInfo_Centre(*args
, **kwargs
)
505 def Direction(*args
, **kwargs
):
507 Direction(self, int direction) -> PaneInfo
509 Direction determines the direction of the docked pane.
512 return _aui
.PaneInfo_Direction(*args
, **kwargs
)
514 def Layer(*args
, **kwargs
):
516 Layer(self, int layer) -> PaneInfo
518 Layer determines the layer of the docked pane.
521 return _aui
.PaneInfo_Layer(*args
, **kwargs
)
523 def Row(*args
, **kwargs
):
525 Row(self, int row) -> PaneInfo
527 Row determines the row of the docked pane.
530 return _aui
.PaneInfo_Row(*args
, **kwargs
)
532 def Position(*args
, **kwargs
):
534 Position(self, int pos) -> PaneInfo
536 Position determines the position of the docked pane.
539 return _aui
.PaneInfo_Position(*args
, **kwargs
)
541 def BestSize(*args
, **kwargs
):
543 BestSize(self, Size size) -> PaneInfo
545 BestSize sets the ideal size for the pane.
548 return _aui
.PaneInfo_BestSize(*args
, **kwargs
)
550 def MinSize(*args
, **kwargs
):
552 MinSize(self, Size size) -> PaneInfo
554 MinSize sets the minimum size of the pane.
557 return _aui
.PaneInfo_MinSize(*args
, **kwargs
)
559 def MaxSize(*args
, **kwargs
):
561 MaxSize(self, Size size) -> PaneInfo
563 MaxSize sets the maximum size of the pane.
566 return _aui
.PaneInfo_MaxSize(*args
, **kwargs
)
568 def FloatingPosition(*args
, **kwargs
):
570 FloatingPosition(self, Point pos) -> PaneInfo
572 FloatingPosition sets the position of the floating pane.
575 return _aui
.PaneInfo_FloatingPosition(*args
, **kwargs
)
577 def FloatingSize(*args
, **kwargs
):
579 FloatingSize(self, Size size) -> PaneInfo
581 FloatingSize sets the size of the floating pane.
584 return _aui
.PaneInfo_FloatingSize(*args
, **kwargs
)
586 def Fixed(*args
, **kwargs
):
588 Fixed(self) -> PaneInfo
590 Fixed forces a pane to be fixed size so that it cannot be resized.
593 return _aui
.PaneInfo_Fixed(*args
, **kwargs
)
595 def Resizable(*args
, **kwargs
):
597 Resizable(self, bool resizable=True) -> PaneInfo
599 Resized allows a pane to be resized if resizable is true, and forces
600 it to be a fixed size if resizeable is false.
603 return _aui
.PaneInfo_Resizable(*args
, **kwargs
)
605 def Dock(*args
, **kwargs
):
607 Dock(self) -> PaneInfo
609 Dock indicates that a pane should be docked.
612 return _aui
.PaneInfo_Dock(*args
, **kwargs
)
614 def Float(*args
, **kwargs
):
616 Float(self) -> PaneInfo
618 Float indicates that a pane should be floated.
621 return _aui
.PaneInfo_Float(*args
, **kwargs
)
623 def Hide(*args
, **kwargs
):
625 Hide(self) -> PaneInfo
627 Hide indicates that a pane should be hidden.
630 return _aui
.PaneInfo_Hide(*args
, **kwargs
)
632 def Show(*args
, **kwargs
):
634 Show(self, bool show=True) -> PaneInfo
636 Show indicates that a pane should be shown.
639 return _aui
.PaneInfo_Show(*args
, **kwargs
)
641 def CaptionVisible(*args
, **kwargs
):
643 CaptionVisible(self, bool visible=True) -> PaneInfo
645 CaptionVisible indicates that a pane caption should be visible.
648 return _aui
.PaneInfo_CaptionVisible(*args
, **kwargs
)
650 def PaneBorder(*args
, **kwargs
):
652 PaneBorder(self, bool visible=True) -> PaneInfo
654 PaneBorder indicates that a border should be drawn for the pane.
657 return _aui
.PaneInfo_PaneBorder(*args
, **kwargs
)
659 def Gripper(*args
, **kwargs
):
661 Gripper(self, bool visible=True) -> PaneInfo
663 Gripper indicates that a gripper should be drawn for the pane..
666 return _aui
.PaneInfo_Gripper(*args
, **kwargs
)
668 def GripperTop(*args
, **kwargs
):
669 """GripperTop(self, bool attop=True) -> PaneInfo"""
670 return _aui
.PaneInfo_GripperTop(*args
, **kwargs
)
672 def CloseButton(*args
, **kwargs
):
674 CloseButton(self, bool visible=True) -> PaneInfo
676 CloseButton indicates that a close button should be drawn for the
680 return _aui
.PaneInfo_CloseButton(*args
, **kwargs
)
682 def MaximizeButton(*args
, **kwargs
):
684 MaximizeButton(self, bool visible=True) -> PaneInfo
686 MaximizeButton indicates that a maximize button should be drawn for
690 return _aui
.PaneInfo_MaximizeButton(*args
, **kwargs
)
692 def MinimizeButton(*args
, **kwargs
):
694 MinimizeButton(self, bool visible=True) -> PaneInfo
696 MinimizeButton indicates that a minimize button should be drawn for
700 return _aui
.PaneInfo_MinimizeButton(*args
, **kwargs
)
702 def PinButton(*args
, **kwargs
):
704 PinButton(self, bool visible=True) -> PaneInfo
706 PinButton indicates that a pin button should be drawn for the pane.
709 return _aui
.PaneInfo_PinButton(*args
, **kwargs
)
711 def DestroyOnClose(*args
, **kwargs
):
713 DestroyOnClose(self, bool b=True) -> PaneInfo
715 DestroyOnClose indicates whether a pane should be detroyed when it is
719 return _aui
.PaneInfo_DestroyOnClose(*args
, **kwargs
)
721 def TopDockable(*args
, **kwargs
):
723 TopDockable(self, bool b=True) -> PaneInfo
725 TopDockable indicates whether a pane can be docked at the top of the
729 return _aui
.PaneInfo_TopDockable(*args
, **kwargs
)
731 def BottomDockable(*args
, **kwargs
):
733 BottomDockable(self, bool b=True) -> PaneInfo
735 BottomDockable indicates whether a pane can be docked at the bottom of
739 return _aui
.PaneInfo_BottomDockable(*args
, **kwargs
)
741 def LeftDockable(*args
, **kwargs
):
743 LeftDockable(self, bool b=True) -> PaneInfo
745 LeftDockable indicates whether a pane can be docked on the left of the
749 return _aui
.PaneInfo_LeftDockable(*args
, **kwargs
)
751 def RightDockable(*args
, **kwargs
):
753 RightDockable(self, bool b=True) -> PaneInfo
755 RightDockable indicates whether a pane can be docked on the right of
759 return _aui
.PaneInfo_RightDockable(*args
, **kwargs
)
761 def Floatable(*args
, **kwargs
):
763 Floatable(self, bool b=True) -> PaneInfo
765 Floatable indicates whether a frame can be floated.
768 return _aui
.PaneInfo_Floatable(*args
, **kwargs
)
770 def Movable(*args
, **kwargs
):
772 Movable(self, bool b=True) -> PaneInfo
774 Movable indicates whether a frame can be moved.
777 return _aui
.PaneInfo_Movable(*args
, **kwargs
)
779 def Dockable(*args
, **kwargs
):
781 Dockable(self, bool b=True) -> PaneInfo
783 Dockable indicates whether a pane can be docked at any position of the
787 return _aui
.PaneInfo_Dockable(*args
, **kwargs
)
789 def DefaultPane(*args
, **kwargs
):
791 DefaultPane(self) -> PaneInfo
793 DefaultPane specifies that the pane should adopt the default pane
797 return _aui
.PaneInfo_DefaultPane(*args
, **kwargs
)
799 def CentrePane(*args
, **kwargs
):
801 CentrePane(self) -> PaneInfo
803 CentrePane specifies that the pane should adopt the default center
807 return _aui
.PaneInfo_CentrePane(*args
, **kwargs
)
809 def CenterPane(*args
, **kwargs
):
811 CenterPane(self) -> PaneInfo
813 CenterPane specifies that the pane should adopt the default center
817 return _aui
.PaneInfo_CenterPane(*args
, **kwargs
)
819 def ToolbarPane(*args
, **kwargs
):
821 ToolbarPane(self) -> PaneInfo
823 ToolbarPane specifies that the pane should adopt the default toolbar
827 return _aui
.PaneInfo_ToolbarPane(*args
, **kwargs
)
829 def SetFlag(*args
, **kwargs
):
831 SetFlag(self, int flag, bool option_state) -> PaneInfo
833 SetFlag turns the property given by flag on or off with the
834 option_state parameter.
837 return _aui
.PaneInfo_SetFlag(*args
, **kwargs
)
839 def HasFlag(*args
, **kwargs
):
841 HasFlag(self, int flag) -> bool
843 HasFlag returns ``True`` if the the property specified by flag is
847 return _aui
.PaneInfo_HasFlag(*args
, **kwargs
)
849 optionFloating
= _aui
.PaneInfo_optionFloating
850 optionHidden
= _aui
.PaneInfo_optionHidden
851 optionLeftDockable
= _aui
.PaneInfo_optionLeftDockable
852 optionRightDockable
= _aui
.PaneInfo_optionRightDockable
853 optionTopDockable
= _aui
.PaneInfo_optionTopDockable
854 optionBottomDockable
= _aui
.PaneInfo_optionBottomDockable
855 optionFloatable
= _aui
.PaneInfo_optionFloatable
856 optionMovable
= _aui
.PaneInfo_optionMovable
857 optionResizable
= _aui
.PaneInfo_optionResizable
858 optionPaneBorder
= _aui
.PaneInfo_optionPaneBorder
859 optionCaption
= _aui
.PaneInfo_optionCaption
860 optionGripper
= _aui
.PaneInfo_optionGripper
861 optionDestroyOnClose
= _aui
.PaneInfo_optionDestroyOnClose
862 optionToolbar
= _aui
.PaneInfo_optionToolbar
863 optionActive
= _aui
.PaneInfo_optionActive
864 optionGripperTop
= _aui
.PaneInfo_optionGripperTop
865 buttonClose
= _aui
.PaneInfo_buttonClose
866 buttonMaximize
= _aui
.PaneInfo_buttonMaximize
867 buttonMinimize
= _aui
.PaneInfo_buttonMinimize
868 buttonPin
= _aui
.PaneInfo_buttonPin
869 buttonCustom1
= _aui
.PaneInfo_buttonCustom1
870 buttonCustom2
= _aui
.PaneInfo_buttonCustom2
871 buttonCustom3
= _aui
.PaneInfo_buttonCustom3
872 actionPane
= _aui
.PaneInfo_actionPane
873 name
= property(_aui
.PaneInfo_name_get
, _aui
.PaneInfo_name_set
)
874 caption
= property(_aui
.PaneInfo_caption_get
, _aui
.PaneInfo_caption_set
)
875 window
= property(_aui
.PaneInfo_window_get
, _aui
.PaneInfo_window_set
)
876 frame
= property(_aui
.PaneInfo_frame_get
, _aui
.PaneInfo_frame_set
)
877 state
= property(_aui
.PaneInfo_state_get
, _aui
.PaneInfo_state_set
)
878 dock_direction
= property(_aui
.PaneInfo_dock_direction_get
, _aui
.PaneInfo_dock_direction_set
)
879 dock_layer
= property(_aui
.PaneInfo_dock_layer_get
, _aui
.PaneInfo_dock_layer_set
)
880 dock_row
= property(_aui
.PaneInfo_dock_row_get
, _aui
.PaneInfo_dock_row_set
)
881 dock_pos
= property(_aui
.PaneInfo_dock_pos_get
, _aui
.PaneInfo_dock_pos_set
)
882 best_size
= property(_aui
.PaneInfo_best_size_get
, _aui
.PaneInfo_best_size_set
)
883 min_size
= property(_aui
.PaneInfo_min_size_get
, _aui
.PaneInfo_min_size_set
)
884 max_size
= property(_aui
.PaneInfo_max_size_get
, _aui
.PaneInfo_max_size_set
)
885 floating_pos
= property(_aui
.PaneInfo_floating_pos_get
, _aui
.PaneInfo_floating_pos_set
)
886 floating_size
= property(_aui
.PaneInfo_floating_size_get
, _aui
.PaneInfo_floating_size_set
)
887 dock_proportion
= property(_aui
.PaneInfo_dock_proportion_get
, _aui
.PaneInfo_dock_proportion_set
)
888 buttons
= property(_aui
.PaneInfo_buttons_get
, _aui
.PaneInfo_buttons_set
)
889 rect
= property(_aui
.PaneInfo_rect_get
, _aui
.PaneInfo_rect_set
)
890 _aui
.PaneInfo_swigregister(PaneInfo
)
893 class FrameManager(_core
.EvtHandler
):
895 FrameManager manages the panes associated with it for a particular
896 `wx.Frame`, using a pane's `PaneInfo` information to determine each
897 pane's docking and floating behavior. FrameManager uses wxWidgets'
898 sizer mechanism to plan the layout of each frame. It uses a
899 replaceable `DockArt` class to do all drawing, so all drawing is
900 localized in one area, and may be customized depending on an
901 application's specific needs.
904 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
905 __repr__
= _swig_repr
906 def __init__(self
, *args
, **kwargs
):
908 __init__(self, Window managed_wnd=None, int flags=AUI_MGR_DEFAULT) -> FrameManager
912 :param managed_wnd: Specifies the `wx.Window` which should be
913 managed. If not set in the call to this constructor then
914 `SetManagedWindow` should be called later.
916 :param flags: Specifies options which allow the frame management
917 behavior to be modified.
920 _aui
.FrameManager_swiginit(self
,_aui
.new_FrameManager(*args
, **kwargs
))
921 __swig_destroy__
= _aui
.delete_FrameManager
922 __del__
= lambda self
: None;
923 def UnInit(*args
, **kwargs
):
927 UnInit uninitializes the framework and should be called before a
928 managed frame is destroyed. UnInit is usually called in the managed
932 return _aui
.FrameManager_UnInit(*args
, **kwargs
)
934 def SetFlags(*args
, **kwargs
):
936 SetFlags(self, int flags)
938 SetFlags is used to specify the FrameManager's behavioral
939 settings. The flags parameter is described in the docs for `__init__`
942 return _aui
.FrameManager_SetFlags(*args
, **kwargs
)
944 def GetFlags(*args
, **kwargs
):
946 GetFlags(self) -> int
948 GetFlags returns the current FrameManager's flags.
951 return _aui
.FrameManager_GetFlags(*args
, **kwargs
)
953 def SetManagedWindow(*args
, **kwargs
):
955 SetManagedWindow(self, Window managed_wnd)
957 SetManagedWindow is called to specify the window which is to be
958 managed by the FrameManager. It is normally a `wx.Frame` but it is
959 possible to also allow docking within any container window. This only
960 needs to be called if the window was not given to the manager in the
964 return _aui
.FrameManager_SetManagedWindow(*args
, **kwargs
)
966 def GetManagedWindow(*args
, **kwargs
):
968 GetManagedWindow(self) -> Window
970 GetManagedWindow returns the window currently being managed by the
974 return _aui
.FrameManager_GetManagedWindow(*args
, **kwargs
)
976 def SetArtProvider(*args
, **kwargs
):
978 SetArtProvider(self, DockArt art_provider)
980 SetArtProvider instructs FrameManager to use the art provider
981 specified for all drawing calls. This allows plugable look-and-feel
982 features. The previous art provider object, if any, will be destroyed
985 :note: If you wish to use a custom `DockArt` class to override drawing
986 or metrics then you shoudl derive your class from the `PyDockArt`
987 class, which has been instrumented for reflecting virtual calls to
991 return _aui
.FrameManager_SetArtProvider(*args
, **kwargs
)
993 def GetArtProvider(*args
, **kwargs
):
995 GetArtProvider(self) -> DockArt
997 GetArtProvider returns the current art provider being used.
1000 return _aui
.FrameManager_GetArtProvider(*args
, **kwargs
)
1002 def _GetPaneByWidget(*args
, **kwargs
):
1003 """_GetPaneByWidget(self, Window window) -> PaneInfo"""
1004 return _aui
.FrameManager__GetPaneByWidget(*args
, **kwargs
)
1006 def _GetPaneByName(*args
, **kwargs
):
1007 """_GetPaneByName(self, String name) -> PaneInfo"""
1008 return _aui
.FrameManager__GetPaneByName(*args
, **kwargs
)
1010 def GetAllPanes(*args
, **kwargs
):
1012 GetAllPanes(self) -> list
1014 GetAllPanes returns a list of `PaneInfo` objects for all panes managed
1015 by the frame manager.
1018 return _aui
.FrameManager_GetAllPanes(*args
, **kwargs
)
1020 def _AddPane1(*args
, **kwargs
):
1021 """_AddPane1(self, Window window, PaneInfo pane_info) -> bool"""
1022 return _aui
.FrameManager__AddPane1(*args
, **kwargs
)
1024 def AddPaneAtPos(*args
, **kwargs
):
1025 """AddPaneAtPos(self, Window window, PaneInfo pane_info, Point drop_pos) -> bool"""
1026 return _aui
.FrameManager_AddPaneAtPos(*args
, **kwargs
)
1028 def _AddPane2(*args
, **kwargs
):
1029 """_AddPane2(self, Window window, int direction=LEFT, String caption=wxEmptyString) -> bool"""
1030 return _aui
.FrameManager__AddPane2(*args
, **kwargs
)
1032 def InsertPane(*args
, **kwargs
):
1034 InsertPane(self, Window window, PaneInfo insert_location, int insert_level=AUI_INSERT_PANE) -> bool
1036 InsertPane is used to insert either a previously unmanaged pane window
1037 into the frame manager, or to insert a currently managed pane
1038 somewhere else. InsertPane will push all panes, rows, or docks aside
1039 and insert the window into the position specified by
1040 ``insert_location``. Because ``insert_location`` can specify either a pane,
1041 dock row, or dock layer, the ``insert_level`` parameter is used to
1042 disambiguate this. The parameter ``insert_level`` can take a value of
1043 ``AUI_INSERT_PANE``, ``AUI_INSERT_ROW`` or ``AUI_INSERT_DOCK``.
1046 return _aui
.FrameManager_InsertPane(*args
, **kwargs
)
1048 def DetachPane(*args
, **kwargs
):
1050 DetachPane(self, Window window) -> bool
1052 DetachPane tells the FrameManager to stop managing the pane specified
1053 by window. The window, if in a floated frame, is reparented to the
1054 frame managed by FrameManager.
1057 return _aui
.FrameManager_DetachPane(*args
, **kwargs
)
1059 def ClosePane(*args
, **kwargs
):
1060 """ClosePane(self, PaneInfo pane_info)"""
1061 return _aui
.FrameManager_ClosePane(*args
, **kwargs
)
1063 def SavePaneInfo(*args
, **kwargs
):
1064 """SavePaneInfo(self, PaneInfo pane) -> String"""
1065 return _aui
.FrameManager_SavePaneInfo(*args
, **kwargs
)
1067 def LoadPaneInfo(*args
, **kwargs
):
1068 """LoadPaneInfo(self, String pane_part, PaneInfo pane)"""
1069 return _aui
.FrameManager_LoadPaneInfo(*args
, **kwargs
)
1071 def SavePerspective(*args
, **kwargs
):
1073 SavePerspective(self) -> String
1075 SavePerspective saves the entire user interface layout into an encoded
1076 string, which can then be stored someplace by the application. When a
1077 perspective is restored using `LoadPerspective`, the entire user
1078 interface will return to the state it was when the perspective was
1082 return _aui
.FrameManager_SavePerspective(*args
, **kwargs
)
1084 def LoadPerspective(*args
, **kwargs
):
1086 LoadPerspective(self, String perspective, bool update=True) -> bool
1088 LoadPerspective loads a saved perspective. If ``update`` is ``True``,
1089 `Update` is automatically invoked, thus realizing the saved
1090 perspective on screen.
1093 return _aui
.FrameManager_LoadPerspective(*args
, **kwargs
)
1095 def Update(*args
, **kwargs
):
1099 Update shoudl be called called after any number of changes are made to
1100 any of the managed panes. Update must be invoked after `AddPane` or
1101 `InsertPane` are called in order to "realize" or "commit" the
1102 changes. In addition, any number of changes may be made to `PaneInfo`
1103 structures (retrieved with `GetPane` or `GetAllPanes`), but to realize
1104 the changes, Update must be called. This construction allows pane
1105 flicker to be avoided by updating the whole layout at one time.
1108 return _aui
.FrameManager_Update(*args
, **kwargs
)
1110 def CreateFloatingFrame(*args
, **kwargs
):
1111 """CreateFloatingFrame(self, Window parent, PaneInfo p) -> FloatingPane"""
1112 return _aui
.FrameManager_CreateFloatingFrame(*args
, **kwargs
)
1114 def DrawHintRect(*args
, **kwargs
):
1115 """DrawHintRect(self, Window pane_window, Point pt, Point offset)"""
1116 return _aui
.FrameManager_DrawHintRect(*args
, **kwargs
)
1118 def ShowHint(*args
, **kwargs
):
1119 """ShowHint(self, Rect rect)"""
1120 return _aui
.FrameManager_ShowHint(*args
, **kwargs
)
1122 def HideHint(*args
, **kwargs
):
1123 """HideHint(self)"""
1124 return _aui
.FrameManager_HideHint(*args
, **kwargs
)
1126 def OnRender(*args
, **kwargs
):
1127 """OnRender(self, FrameManagerEvent evt)"""
1128 return _aui
.FrameManager_OnRender(*args
, **kwargs
)
1130 def OnPaneButton(*args
, **kwargs
):
1131 """OnPaneButton(self, FrameManagerEvent evt)"""
1132 return _aui
.FrameManager_OnPaneButton(*args
, **kwargs
)
1134 def GetPane(self
, item
):
1136 GetPane(self, window_or_info item) -> PaneInfo
1138 GetPane is used to search for a `PaneInfo` object either by
1139 widget reference or by pane name, which acts as a unique id
1140 for a window pane. The returned `PaneInfo` object may then be
1141 modified to change a pane's look, state or position. After one
1142 or more modifications to the `PaneInfo`, `FrameManager.Update`
1143 should be called to realize the changes to the user interface.
1145 If the lookup failed (meaning the pane could not be found in
1146 the manager) GetPane returns an empty `PaneInfo`, a condition
1147 which can be checked by calling `PaneInfo.IsOk`.
1149 if isinstance(item
, wx
.Window
):
1150 return self
._GetPaneByWidget
(item
)
1152 return self
._GetPaneByName
(item
)
1154 def AddPane(self
, window
, info
=None, caption
=None):
1156 AddPane(self, window, info=None, caption=None) -> bool
1158 AddPane tells the frame manager to start managing a child
1159 window. There are two versions of this function. The first
1160 verison accepts a `PaneInfo` object for the ``info`` parameter
1161 and allows the full spectrum of pane parameter
1162 possibilities. (Say that 3 times fast!)
1164 The second version is used for simpler user interfaces which
1165 do not require as much configuration. In this case the
1166 ``info`` parameter specifies the direction property of the
1167 pane info, and defaults to ``wx.LEFT``. The pane caption may
1168 also be specified as an extra parameter in this form.
1170 if type(info
) == PaneInfo
:
1171 return self
._AddPane
1(window
, info
)
1178 return self
._AddPane
2(window
, info
, caption
)
1180 SetFrame
= wx
._deprecated
(SetManagedWindow
,
1181 "SetFrame is deprecated, use `SetManagedWindow` instead.")
1182 GetFrame
= wx
._deprecated
(GetManagedWindow
,
1183 "GetFrame is deprecated, use `GetManagedWindow` instead.")
1185 AllPanes
= property(GetAllPanes
,doc
="See `GetAllPanes`")
1186 ArtProvider
= property(GetArtProvider
,SetArtProvider
,doc
="See `GetArtProvider` and `SetArtProvider`")
1187 Flags
= property(GetFlags
,SetFlags
,doc
="See `GetFlags` and `SetFlags`")
1188 ManagedWindow
= property(GetManagedWindow
,SetManagedWindow
,doc
="See `GetManagedWindow` and `SetManagedWindow`")
1189 _aui
.FrameManager_swigregister(FrameManager
)
1191 class FrameManagerEvent(_core
.Event
):
1192 """Proxy of C++ FrameManagerEvent class"""
1193 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1194 __repr__
= _swig_repr
1195 def __init__(self
, *args
, **kwargs
):
1196 """__init__(self, EventType type=wxEVT_NULL) -> FrameManagerEvent"""
1197 _aui
.FrameManagerEvent_swiginit(self
,_aui
.new_FrameManagerEvent(*args
, **kwargs
))
1198 def Clone(*args
, **kwargs
):
1199 """Clone(self) -> Event"""
1200 return _aui
.FrameManagerEvent_Clone(*args
, **kwargs
)
1202 def SetPane(*args
, **kwargs
):
1203 """SetPane(self, PaneInfo p)"""
1204 return _aui
.FrameManagerEvent_SetPane(*args
, **kwargs
)
1206 def SetButton(*args
, **kwargs
):
1207 """SetButton(self, int b)"""
1208 return _aui
.FrameManagerEvent_SetButton(*args
, **kwargs
)
1210 def SetDC(*args
, **kwargs
):
1211 """SetDC(self, DC pdc)"""
1212 return _aui
.FrameManagerEvent_SetDC(*args
, **kwargs
)
1214 def GetPane(*args
, **kwargs
):
1215 """GetPane(self) -> PaneInfo"""
1216 return _aui
.FrameManagerEvent_GetPane(*args
, **kwargs
)
1218 def GetButton(*args
, **kwargs
):
1219 """GetButton(self) -> int"""
1220 return _aui
.FrameManagerEvent_GetButton(*args
, **kwargs
)
1222 def GetDC(*args
, **kwargs
):
1223 """GetDC(self) -> DC"""
1224 return _aui
.FrameManagerEvent_GetDC(*args
, **kwargs
)
1226 def Veto(*args
, **kwargs
):
1227 """Veto(self, bool veto=True)"""
1228 return _aui
.FrameManagerEvent_Veto(*args
, **kwargs
)
1230 def GetVeto(*args
, **kwargs
):
1231 """GetVeto(self) -> bool"""
1232 return _aui
.FrameManagerEvent_GetVeto(*args
, **kwargs
)
1234 def SetCanVeto(*args
, **kwargs
):
1235 """SetCanVeto(self, bool can_veto)"""
1236 return _aui
.FrameManagerEvent_SetCanVeto(*args
, **kwargs
)
1238 def CanVeto(*args
, **kwargs
):
1239 """CanVeto(self) -> bool"""
1240 return _aui
.FrameManagerEvent_CanVeto(*args
, **kwargs
)
1242 pane
= property(_aui
.FrameManagerEvent_pane_get
, _aui
.FrameManagerEvent_pane_set
)
1243 button
= property(_aui
.FrameManagerEvent_button_get
, _aui
.FrameManagerEvent_button_set
)
1244 veto_flag
= property(_aui
.FrameManagerEvent_veto_flag_get
, _aui
.FrameManagerEvent_veto_flag_set
)
1245 canveto_flag
= property(_aui
.FrameManagerEvent_canveto_flag_get
, _aui
.FrameManagerEvent_canveto_flag_set
)
1246 dc
= property(_aui
.FrameManagerEvent_dc_get
, _aui
.FrameManagerEvent_dc_set
)
1247 Button
= property(GetButton
,SetButton
,doc
="See `GetButton` and `SetButton`")
1248 DC
= property(GetDC
,SetDC
,doc
="See `GetDC` and `SetDC`")
1249 Pane
= property(GetPane
,SetPane
,doc
="See `GetPane` and `SetPane`")
1250 _aui
.FrameManagerEvent_swigregister(FrameManagerEvent
)
1252 class DockInfo(object):
1253 """Proxy of C++ DockInfo class"""
1254 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1255 __repr__
= _swig_repr
1256 def __init__(self
, *args
, **kwargs
):
1257 """__init__(self) -> DockInfo"""
1258 _aui
.DockInfo_swiginit(self
,_aui
.new_DockInfo(*args
, **kwargs
))
1259 def IsOk(*args
, **kwargs
):
1260 """IsOk(self) -> bool"""
1261 return _aui
.DockInfo_IsOk(*args
, **kwargs
)
1263 def IsHorizontal(*args
, **kwargs
):
1264 """IsHorizontal(self) -> bool"""
1265 return _aui
.DockInfo_IsHorizontal(*args
, **kwargs
)
1267 def IsVertical(*args
, **kwargs
):
1268 """IsVertical(self) -> bool"""
1269 return _aui
.DockInfo_IsVertical(*args
, **kwargs
)
1271 panes
= property(_aui
.DockInfo_panes_get
, _aui
.DockInfo_panes_set
)
1272 rect
= property(_aui
.DockInfo_rect_get
, _aui
.DockInfo_rect_set
)
1273 dock_direction
= property(_aui
.DockInfo_dock_direction_get
, _aui
.DockInfo_dock_direction_set
)
1274 dock_layer
= property(_aui
.DockInfo_dock_layer_get
, _aui
.DockInfo_dock_layer_set
)
1275 dock_row
= property(_aui
.DockInfo_dock_row_get
, _aui
.DockInfo_dock_row_set
)
1276 size
= property(_aui
.DockInfo_size_get
, _aui
.DockInfo_size_set
)
1277 min_size
= property(_aui
.DockInfo_min_size_get
, _aui
.DockInfo_min_size_set
)
1278 resizable
= property(_aui
.DockInfo_resizable_get
, _aui
.DockInfo_resizable_set
)
1279 toolbar
= property(_aui
.DockInfo_toolbar_get
, _aui
.DockInfo_toolbar_set
)
1280 fixed
= property(_aui
.DockInfo_fixed_get
, _aui
.DockInfo_fixed_set
)
1281 __swig_destroy__
= _aui
.delete_DockInfo
1282 __del__
= lambda self
: None;
1283 _aui
.DockInfo_swigregister(DockInfo
)
1285 class DockUIPart(object):
1286 """Proxy of C++ DockUIPart class"""
1287 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1288 def __init__(self
): raise AttributeError, "No constructor defined"
1289 __repr__
= _swig_repr
1290 typeCaption
= _aui
.DockUIPart_typeCaption
1291 typeGripper
= _aui
.DockUIPart_typeGripper
1292 typeDock
= _aui
.DockUIPart_typeDock
1293 typeDockSizer
= _aui
.DockUIPart_typeDockSizer
1294 typePane
= _aui
.DockUIPart_typePane
1295 typePaneSizer
= _aui
.DockUIPart_typePaneSizer
1296 typeBackground
= _aui
.DockUIPart_typeBackground
1297 typePaneBorder
= _aui
.DockUIPart_typePaneBorder
1298 typePaneButton
= _aui
.DockUIPart_typePaneButton
1299 type = property(_aui
.DockUIPart_type_get
, _aui
.DockUIPart_type_set
)
1300 orientation
= property(_aui
.DockUIPart_orientation_get
, _aui
.DockUIPart_orientation_set
)
1301 dock
= property(_aui
.DockUIPart_dock_get
, _aui
.DockUIPart_dock_set
)
1302 pane
= property(_aui
.DockUIPart_pane_get
, _aui
.DockUIPart_pane_set
)
1303 button
= property(_aui
.DockUIPart_button_get
, _aui
.DockUIPart_button_set
)
1304 cont_sizer
= property(_aui
.DockUIPart_cont_sizer_get
, _aui
.DockUIPart_cont_sizer_set
)
1305 sizer_item
= property(_aui
.DockUIPart_sizer_item_get
, _aui
.DockUIPart_sizer_item_set
)
1306 rect
= property(_aui
.DockUIPart_rect_get
, _aui
.DockUIPart_rect_set
)
1307 __swig_destroy__
= _aui
.delete_DockUIPart
1308 __del__
= lambda self
: None;
1309 _aui
.DockUIPart_swigregister(DockUIPart
)
1311 class PaneButton(object):
1312 """Proxy of C++ PaneButton class"""
1313 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1314 def __init__(self
): raise AttributeError, "No constructor defined"
1315 __repr__
= _swig_repr
1316 button_id
= property(_aui
.PaneButton_button_id_get
, _aui
.PaneButton_button_id_set
)
1317 __swig_destroy__
= _aui
.delete_PaneButton
1318 __del__
= lambda self
: None;
1319 _aui
.PaneButton_swigregister(PaneButton
)
1321 wxEVT_AUI_PANEBUTTON
= _aui
.wxEVT_AUI_PANEBUTTON
1322 wxEVT_AUI_PANECLOSE
= _aui
.wxEVT_AUI_PANECLOSE
1323 wxEVT_AUI_RENDER
= _aui
.wxEVT_AUI_RENDER
1324 EVT_AUI_PANEBUTTON
= wx
.PyEventBinder( wxEVT_AUI_PANEBUTTON
)
1325 EVT_AUI_PANECLOSE
= wx
.PyEventBinder( wxEVT_AUI_PANECLOSE
)
1326 EVT_AUI_RENDER
= wx
.PyEventBinder( wxEVT_AUI_RENDER
)
1328 class DockArt(object):
1330 DockArt is an art provider class which does all of the drawing for
1331 `FrameManager`. This allows the library caller to customize or replace the
1332 dock art and drawing routines by deriving a new class from `PyDockArt`. The
1333 active dock art class can be set via `FrameManager.SetArtProvider`.
1336 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1337 def __init__(self
): raise AttributeError, "No constructor defined"
1338 __repr__
= _swig_repr
1339 __swig_destroy__
= _aui
.delete_DockArt
1340 __del__
= lambda self
: None;
1341 def GetMetric(*args
, **kwargs
):
1342 """GetMetric(self, int id) -> int"""
1343 return _aui
.DockArt_GetMetric(*args
, **kwargs
)
1345 def SetMetric(*args
, **kwargs
):
1346 """SetMetric(self, int id, int new_val)"""
1347 return _aui
.DockArt_SetMetric(*args
, **kwargs
)
1349 def SetFont(*args
, **kwargs
):
1350 """SetFont(self, int id, Font font)"""
1351 return _aui
.DockArt_SetFont(*args
, **kwargs
)
1353 def GetFont(*args
, **kwargs
):
1354 """GetFont(self, int id) -> Font"""
1355 return _aui
.DockArt_GetFont(*args
, **kwargs
)
1357 def GetColour(*args
, **kwargs
):
1358 """GetColour(self, int id) -> Colour"""
1359 return _aui
.DockArt_GetColour(*args
, **kwargs
)
1361 def SetColour(*args
, **kwargs
):
1362 """SetColour(self, int id, wxColor colour)"""
1363 return _aui
.DockArt_SetColour(*args
, **kwargs
)
1365 def GetColor(*args
, **kwargs
):
1366 """GetColor(self, int id) -> Colour"""
1367 return _aui
.DockArt_GetColor(*args
, **kwargs
)
1369 def SetColor(*args
, **kwargs
):
1370 """SetColor(self, int id, Colour color)"""
1371 return _aui
.DockArt_SetColor(*args
, **kwargs
)
1373 def DrawSash(*args
, **kwargs
):
1374 """DrawSash(self, DC dc, Window window, int orientation, Rect rect)"""
1375 return _aui
.DockArt_DrawSash(*args
, **kwargs
)
1377 def DrawBackground(*args
, **kwargs
):
1378 """DrawBackground(self, DC dc, Window window, int orientation, Rect rect)"""
1379 return _aui
.DockArt_DrawBackground(*args
, **kwargs
)
1381 def DrawCaption(*args
, **kwargs
):
1382 """DrawCaption(self, DC dc, Window window, String text, Rect rect, PaneInfo pane)"""
1383 return _aui
.DockArt_DrawCaption(*args
, **kwargs
)
1385 def DrawGripper(*args
, **kwargs
):
1386 """DrawGripper(self, DC dc, Window window, Rect rect, PaneInfo pane)"""
1387 return _aui
.DockArt_DrawGripper(*args
, **kwargs
)
1389 def DrawBorder(*args
, **kwargs
):
1390 """DrawBorder(self, DC dc, Window window, Rect rect, PaneInfo pane)"""
1391 return _aui
.DockArt_DrawBorder(*args
, **kwargs
)
1393 def DrawPaneButton(*args
, **kwargs
):
1395 DrawPaneButton(self, DC dc, Window window, int button, int button_state,
1396 Rect rect, PaneInfo pane)
1398 return _aui
.DockArt_DrawPaneButton(*args
, **kwargs
)
1400 _aui
.DockArt_swigregister(DockArt
)
1402 class DefaultDockArt(DockArt
):
1404 DefaultDockArt is the type of art class constructed by default for the
1407 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1408 __repr__
= _swig_repr
1409 def __init__(self
, *args
, **kwargs
):
1411 __init__(self) -> DefaultDockArt
1413 DefaultDockArt is the type of art class constructed by default for the
1416 _aui
.DefaultDockArt_swiginit(self
,_aui
.new_DefaultDockArt(*args
, **kwargs
))
1417 _aui
.DefaultDockArt_swigregister(DefaultDockArt
)
1419 class FloatingPane(_windows
.MiniFrame
):
1420 """Proxy of C++ FloatingPane class"""
1421 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1422 __repr__
= _swig_repr
1423 def __init__(self
, *args
, **kwargs
):
1425 __init__(self, Window parent, FrameManager owner_mgr, PaneInfo pane,
1426 int id=ID_ANY, long style=wxRESIZE_BORDER|wxSYSTEM_MENU|wxCAPTION|wxFRAME_NO_TASKBAR|wxFRAME_FLOAT_ON_PARENT|wxCLIP_CHILDREN) -> FloatingPane
1428 _aui
.FloatingPane_swiginit(self
,_aui
.new_FloatingPane(*args
, **kwargs
))
1429 __swig_destroy__
= _aui
.delete_FloatingPane
1430 __del__
= lambda self
: None;
1431 def SetPaneWindow(*args
, **kwargs
):
1432 """SetPaneWindow(self, PaneInfo pane)"""
1433 return _aui
.FloatingPane_SetPaneWindow(*args
, **kwargs
)
1435 _aui
.FloatingPane_swigregister(FloatingPane
)
1437 class AuiNotebookEvent(_core
.NotifyEvent
):
1438 """Proxy of C++ AuiNotebookEvent class"""
1439 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1440 __repr__
= _swig_repr
1441 def __init__(self
, *args
, **kwargs
):
1442 """__init__(self, EventType command_type=wxEVT_NULL, int win_id=0) -> AuiNotebookEvent"""
1443 _aui
.AuiNotebookEvent_swiginit(self
,_aui
.new_AuiNotebookEvent(*args
, **kwargs
))
1444 def SetSelection(*args
, **kwargs
):
1445 """SetSelection(self, int s)"""
1446 return _aui
.AuiNotebookEvent_SetSelection(*args
, **kwargs
)
1448 def SetOldSelection(*args
, **kwargs
):
1449 """SetOldSelection(self, int s)"""
1450 return _aui
.AuiNotebookEvent_SetOldSelection(*args
, **kwargs
)
1452 def GetSelection(*args
, **kwargs
):
1454 GetSelection(self) -> int
1456 Returns item index for a listbox or choice selection event (not valid
1459 return _aui
.AuiNotebookEvent_GetSelection(*args
, **kwargs
)
1461 def GetOldSelection(*args
, **kwargs
):
1462 """GetOldSelection(self) -> int"""
1463 return _aui
.AuiNotebookEvent_GetOldSelection(*args
, **kwargs
)
1465 old_selection
= property(_aui
.AuiNotebookEvent_old_selection_get
, _aui
.AuiNotebookEvent_old_selection_set
)
1466 selection
= property(_aui
.AuiNotebookEvent_selection_get
, _aui
.AuiNotebookEvent_selection_set
)
1467 OldSelection
= property(GetOldSelection
,SetOldSelection
,doc
="See `GetOldSelection` and `SetOldSelection`")
1468 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
1469 _aui
.AuiNotebookEvent_swigregister(AuiNotebookEvent
)
1471 class AuiNotebookPage(object):
1472 """Proxy of C++ AuiNotebookPage class"""
1473 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1474 def __init__(self
): raise AttributeError, "No constructor defined"
1475 __repr__
= _swig_repr
1476 window
= property(_aui
.AuiNotebookPage_window_get
, _aui
.AuiNotebookPage_window_set
)
1477 caption
= property(_aui
.AuiNotebookPage_caption_get
, _aui
.AuiNotebookPage_caption_set
)
1478 bitmap
= property(_aui
.AuiNotebookPage_bitmap_get
, _aui
.AuiNotebookPage_bitmap_set
)
1479 rect
= property(_aui
.AuiNotebookPage_rect_get
, _aui
.AuiNotebookPage_rect_set
)
1480 active
= property(_aui
.AuiNotebookPage_active_get
, _aui
.AuiNotebookPage_active_set
)
1481 _aui
.AuiNotebookPage_swigregister(AuiNotebookPage
)
1483 class AuiTabContainerButton(object):
1484 """Proxy of C++ AuiTabContainerButton class"""
1485 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1486 def __init__(self
): raise AttributeError, "No constructor defined"
1487 __repr__
= _swig_repr
1488 id = property(_aui
.AuiTabContainerButton_id_get
, _aui
.AuiTabContainerButton_id_set
)
1489 cur_state
= property(_aui
.AuiTabContainerButton_cur_state_get
, _aui
.AuiTabContainerButton_cur_state_set
)
1490 bitmap
= property(_aui
.AuiTabContainerButton_bitmap_get
, _aui
.AuiTabContainerButton_bitmap_set
)
1491 rect
= property(_aui
.AuiTabContainerButton_rect_get
, _aui
.AuiTabContainerButton_rect_set
)
1492 _aui
.AuiTabContainerButton_swigregister(AuiTabContainerButton
)
1494 class AuiTabContainer(object):
1495 """Proxy of C++ AuiTabContainer class"""
1496 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1497 __repr__
= _swig_repr
1498 def __init__(self
, *args
, **kwargs
):
1499 """__init__(self) -> AuiTabContainer"""
1500 _aui
.AuiTabContainer_swiginit(self
,_aui
.new_AuiTabContainer(*args
, **kwargs
))
1501 __swig_destroy__
= _aui
.delete_AuiTabContainer
1502 __del__
= lambda self
: None;
1503 def AddPage(*args
, **kwargs
):
1504 """AddPage(self, Window page, AuiNotebookPage info) -> bool"""
1505 return _aui
.AuiTabContainer_AddPage(*args
, **kwargs
)
1507 def InsertPage(*args
, **kwargs
):
1508 """InsertPage(self, Window page, AuiNotebookPage info, size_t idx) -> bool"""
1509 return _aui
.AuiTabContainer_InsertPage(*args
, **kwargs
)
1511 def RemovePage(*args
, **kwargs
):
1512 """RemovePage(self, Window page) -> bool"""
1513 return _aui
.AuiTabContainer_RemovePage(*args
, **kwargs
)
1515 def SetActivePage(*args
):
1517 SetActivePage(self, Window page) -> bool
1518 SetActivePage(self, size_t page) -> bool
1520 return _aui
.AuiTabContainer_SetActivePage(*args
)
1522 def SetNoneActive(*args
, **kwargs
):
1523 """SetNoneActive(self)"""
1524 return _aui
.AuiTabContainer_SetNoneActive(*args
, **kwargs
)
1526 def GetActivePage(*args
, **kwargs
):
1527 """GetActivePage(self) -> int"""
1528 return _aui
.AuiTabContainer_GetActivePage(*args
, **kwargs
)
1530 def TabHitTest(*args
, **kwargs
):
1531 """TabHitTest(self, int x, int y, Window hit) -> bool"""
1532 return _aui
.AuiTabContainer_TabHitTest(*args
, **kwargs
)
1534 def ButtonHitTest(*args
, **kwargs
):
1535 """ButtonHitTest(self, int x, int y, AuiTabContainerButton hit) -> bool"""
1536 return _aui
.AuiTabContainer_ButtonHitTest(*args
, **kwargs
)
1538 def GetWindowFromIdx(*args
, **kwargs
):
1539 """GetWindowFromIdx(self, size_t idx) -> Window"""
1540 return _aui
.AuiTabContainer_GetWindowFromIdx(*args
, **kwargs
)
1542 def GetIdxFromWindow(*args
, **kwargs
):
1543 """GetIdxFromWindow(self, Window page) -> int"""
1544 return _aui
.AuiTabContainer_GetIdxFromWindow(*args
, **kwargs
)
1546 def GetPageCount(*args
, **kwargs
):
1547 """GetPageCount(self) -> size_t"""
1548 return _aui
.AuiTabContainer_GetPageCount(*args
, **kwargs
)
1550 def GetPage(*args
, **kwargs
):
1551 """GetPage(self, size_t idx) -> AuiNotebookPage"""
1552 return _aui
.AuiTabContainer_GetPage(*args
, **kwargs
)
1554 def GetPages(*args
, **kwargs
):
1555 """GetPages(self) -> wxAuiNotebookPageArray"""
1556 return _aui
.AuiTabContainer_GetPages(*args
, **kwargs
)
1558 def SetNormalFont(*args
, **kwargs
):
1559 """SetNormalFont(self, Font normal_font)"""
1560 return _aui
.AuiTabContainer_SetNormalFont(*args
, **kwargs
)
1562 def SetSelectedFont(*args
, **kwargs
):
1563 """SetSelectedFont(self, Font selected_font)"""
1564 return _aui
.AuiTabContainer_SetSelectedFont(*args
, **kwargs
)
1566 def SetMeasuringFont(*args
, **kwargs
):
1567 """SetMeasuringFont(self, Font measuring_font)"""
1568 return _aui
.AuiTabContainer_SetMeasuringFont(*args
, **kwargs
)
1570 def DoShowHide(*args
, **kwargs
):
1571 """DoShowHide(self)"""
1572 return _aui
.AuiTabContainer_DoShowHide(*args
, **kwargs
)
1574 def SetRect(*args
, **kwargs
):
1575 """SetRect(self, Rect rect)"""
1576 return _aui
.AuiTabContainer_SetRect(*args
, **kwargs
)
1578 def AddButton(*args
, **kwargs
):
1579 """AddButton(self, int id, Bitmap bmp)"""
1580 return _aui
.AuiTabContainer_AddButton(*args
, **kwargs
)
1582 ActivePage
= property(GetActivePage
,SetActivePage
,doc
="See `GetActivePage` and `SetActivePage`")
1583 PageCount
= property(GetPageCount
,doc
="See `GetPageCount`")
1584 Pages
= property(GetPages
,doc
="See `GetPages`")
1585 _aui
.AuiTabContainer_swigregister(AuiTabContainer
)
1587 class AuiTabCtrl(_core
.Control
,AuiTabContainer
):
1588 """Proxy of C++ AuiTabCtrl class"""
1589 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1590 __repr__
= _swig_repr
1591 def __init__(self
, *args
, **kwargs
):
1593 __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
1594 Size size=DefaultSize, long style=0) -> AuiTabCtrl
1596 _aui
.AuiTabCtrl_swiginit(self
,_aui
.new_AuiTabCtrl(*args
, **kwargs
))
1597 self
._setOORInfo
(self
)
1599 _aui
.AuiTabCtrl_swigregister(AuiTabCtrl
)
1601 class AuiMultiNotebook(_core
.Control
):
1602 """Proxy of C++ AuiMultiNotebook class"""
1603 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1604 __repr__
= _swig_repr
1605 def __init__(self
, *args
, **kwargs
):
1607 __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
1608 Size size=DefaultSize, long style=0) -> AuiMultiNotebook
1610 _aui
.AuiMultiNotebook_swiginit(self
,_aui
.new_AuiMultiNotebook(*args
, **kwargs
))
1611 self
._setOORInfo
(self
)
1613 def Create(*args
, **kwargs
):
1615 Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
1616 Size size=DefaultSize, long style=0) -> bool
1618 Do the 2nd phase and create the GUI control.
1620 return _aui
.AuiMultiNotebook_Create(*args
, **kwargs
)
1622 def AddPage(*args
, **kwargs
):
1623 """AddPage(self, Window page, String caption, bool select=False, Bitmap bitmap=wxNullBitmap) -> bool"""
1624 return _aui
.AuiMultiNotebook_AddPage(*args
, **kwargs
)
1626 def InsertPage(*args
, **kwargs
):
1628 InsertPage(self, size_t page_idx, Window page, String caption, bool select=False,
1629 Bitmap bitmap=wxNullBitmap) -> bool
1631 return _aui
.AuiMultiNotebook_InsertPage(*args
, **kwargs
)
1633 def DeletePage(*args
, **kwargs
):
1634 """DeletePage(self, size_t page) -> bool"""
1635 return _aui
.AuiMultiNotebook_DeletePage(*args
, **kwargs
)
1637 def RemovePage(*args
, **kwargs
):
1638 """RemovePage(self, size_t page) -> bool"""
1639 return _aui
.AuiMultiNotebook_RemovePage(*args
, **kwargs
)
1641 def SetPageText(*args
, **kwargs
):
1642 """SetPageText(self, size_t page, String text) -> bool"""
1643 return _aui
.AuiMultiNotebook_SetPageText(*args
, **kwargs
)
1645 def SetSelection(*args
, **kwargs
):
1646 """SetSelection(self, size_t new_page) -> size_t"""
1647 return _aui
.AuiMultiNotebook_SetSelection(*args
, **kwargs
)
1649 def GetSelection(*args
, **kwargs
):
1650 """GetSelection(self) -> int"""
1651 return _aui
.AuiMultiNotebook_GetSelection(*args
, **kwargs
)
1653 def GetPageCount(*args
, **kwargs
):
1654 """GetPageCount(self) -> size_t"""
1655 return _aui
.AuiMultiNotebook_GetPageCount(*args
, **kwargs
)
1657 def GetPage(*args
, **kwargs
):
1658 """GetPage(self, size_t page_idx) -> Window"""
1659 return _aui
.AuiMultiNotebook_GetPage(*args
, **kwargs
)
1661 PageCount
= property(GetPageCount
,doc
="See `GetPageCount`")
1662 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
1663 _aui
.AuiMultiNotebook_swigregister(AuiMultiNotebook
)
1665 def PreAuiMultiNotebook(*args
, **kwargs
):
1666 """PreAuiMultiNotebook() -> AuiMultiNotebook"""
1667 val
= _aui
.new_PreAuiMultiNotebook(*args
, **kwargs
)
1668 self
._setOORInfo
(self
)
1671 wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
1672 wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
1673 wxEVT_COMMAND_AUINOTEBOOK_BUTTON
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_BUTTON
1674 wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
1675 wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
1676 wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
1677 EVT_AUINOTEBOOK_PAGE_CHANGED
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
, 1 )
1678 EVT_AUINOTEBOOK_PAGE_CHANGING
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
, 1 )
1679 EVT_AUINOTEBOOK_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BUTTON
, 1 )
1680 EVT_AUINOTEBOOK_BEGIN_DRAG
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
, 1 )
1681 EVT_AUINOTEBOOK_END_DRAG
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
, 1 )
1682 EVT_AUINOTEBOOK_DRAG_MOTION
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
, 1 )
1684 class PyDockArt(DefaultDockArt
):
1686 This version of the `DockArt` class has been instrumented to be
1687 subclassable in Python and to reflect all calls to the C++ base class
1688 methods to the Python methods implemented in the derived class.
1690 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1691 def __init__(self
): raise AttributeError, "No constructor defined"
1692 __repr__
= _swig_repr
1693 _aui
.PyDockArt_swigregister(PyDockArt
)