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_VENETIAN_BLINDS_HINT
= _aui
.AUI_MGR_VENETIAN_BLINDS_HINT
170 AUI_MGR_RECTANGLE_HINT
= _aui
.AUI_MGR_RECTANGLE_HINT
171 AUI_MGR_HINT_FADE
= _aui
.AUI_MGR_HINT_FADE
172 AUI_MGR_NO_VENETIAN_BLINDS_FADE
= _aui
.AUI_MGR_NO_VENETIAN_BLINDS_FADE
173 AUI_MGR_DEFAULT
= _aui
.AUI_MGR_DEFAULT
174 AUI_ART_SASH_SIZE
= _aui
.AUI_ART_SASH_SIZE
175 AUI_ART_CAPTION_SIZE
= _aui
.AUI_ART_CAPTION_SIZE
176 AUI_ART_GRIPPER_SIZE
= _aui
.AUI_ART_GRIPPER_SIZE
177 AUI_ART_PANE_BORDER_SIZE
= _aui
.AUI_ART_PANE_BORDER_SIZE
178 AUI_ART_PANE_BUTTON_SIZE
= _aui
.AUI_ART_PANE_BUTTON_SIZE
179 AUI_ART_BACKGROUND_COLOUR
= _aui
.AUI_ART_BACKGROUND_COLOUR
180 AUI_ART_SASH_COLOUR
= _aui
.AUI_ART_SASH_COLOUR
181 AUI_ART_ACTIVE_CAPTION_COLOUR
= _aui
.AUI_ART_ACTIVE_CAPTION_COLOUR
182 AUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR
= _aui
.AUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR
183 AUI_ART_INACTIVE_CAPTION_COLOUR
= _aui
.AUI_ART_INACTIVE_CAPTION_COLOUR
184 AUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR
= _aui
.AUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR
185 AUI_ART_ACTIVE_CAPTION_TEXT_COLOUR
= _aui
.AUI_ART_ACTIVE_CAPTION_TEXT_COLOUR
186 AUI_ART_INACTIVE_CAPTION_TEXT_COLOUR
= _aui
.AUI_ART_INACTIVE_CAPTION_TEXT_COLOUR
187 AUI_ART_BORDER_COLOUR
= _aui
.AUI_ART_BORDER_COLOUR
188 AUI_ART_GRIPPER_COLOUR
= _aui
.AUI_ART_GRIPPER_COLOUR
189 AUI_ART_CAPTION_FONT
= _aui
.AUI_ART_CAPTION_FONT
190 AUI_ART_GRADIENT_TYPE
= _aui
.AUI_ART_GRADIENT_TYPE
191 AUI_GRADIENT_NONE
= _aui
.AUI_GRADIENT_NONE
192 AUI_GRADIENT_VERTICAL
= _aui
.AUI_GRADIENT_VERTICAL
193 AUI_GRADIENT_HORIZONTAL
= _aui
.AUI_GRADIENT_HORIZONTAL
194 AUI_BUTTON_STATE_NORMAL
= _aui
.AUI_BUTTON_STATE_NORMAL
195 AUI_BUTTON_STATE_HOVER
= _aui
.AUI_BUTTON_STATE_HOVER
196 AUI_BUTTON_STATE_PRESSED
= _aui
.AUI_BUTTON_STATE_PRESSED
197 AUI_INSERT_PANE
= _aui
.AUI_INSERT_PANE
198 AUI_INSERT_ROW
= _aui
.AUI_INSERT_ROW
199 AUI_INSERT_DOCK
= _aui
.AUI_INSERT_DOCK
200 class PaneInfo(object):
202 PaneInfo specifies all the parameters for a pane for the
203 `FrameManager`. These parameters specify where the pane is on the
204 screen, whether it is docked or floating, or hidden. In addition,
205 these parameters specify the pane's docked position, floating
206 position, preferred size, minimum size, caption text among many other
210 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
211 __repr__
= _swig_repr
212 def __init__(self
, *args
, **kwargs
):
214 __init__(self) -> PaneInfo
216 PaneInfo specifies all the parameters for a pane for the
217 `FrameManager`. These parameters specify where the pane is on the
218 screen, whether it is docked or floating, or hidden. In addition,
219 these parameters specify the pane's docked position, floating
220 position, preferred size, minimum size, caption text among many other
224 _aui
.PaneInfo_swiginit(self
,_aui
.new_PaneInfo(*args
, **kwargs
))
225 __swig_destroy__
= _aui
.delete_PaneInfo
226 __del__
= lambda self
: None;
227 def SafeSet(*args
, **kwargs
):
228 """SafeSet(self, PaneInfo source)"""
229 return _aui
.PaneInfo_SafeSet(*args
, **kwargs
)
231 def IsOk(*args
, **kwargs
):
235 IsOk returns ``True`` if the PaneInfo structure is valid.
238 return _aui
.PaneInfo_IsOk(*args
, **kwargs
)
240 def IsFixed(*args
, **kwargs
):
242 IsFixed(self) -> bool
244 IsFixed returns ``True`` if the pane cannot be resized.
247 return _aui
.PaneInfo_IsFixed(*args
, **kwargs
)
249 def IsResizable(*args
, **kwargs
):
251 IsResizable(self) -> bool
253 IsResizeable returns ``True`` if the pane can be resized.
256 return _aui
.PaneInfo_IsResizable(*args
, **kwargs
)
258 def IsShown(*args
, **kwargs
):
260 IsShown(self) -> bool
262 IsShown returns ``True`` if the pane should be drawn on the screen.
265 return _aui
.PaneInfo_IsShown(*args
, **kwargs
)
267 def IsFloating(*args
, **kwargs
):
269 IsFloating(self) -> bool
271 IsFloating returns ``True`` if the pane is floating.
274 return _aui
.PaneInfo_IsFloating(*args
, **kwargs
)
276 def IsDocked(*args
, **kwargs
):
278 IsDocked(self) -> bool
280 IsDocked returns ``True`` if the pane is docked.
283 return _aui
.PaneInfo_IsDocked(*args
, **kwargs
)
285 def IsToolbar(*args
, **kwargs
):
287 IsToolbar(self) -> bool
289 IsToolbar returns ``True`` if the pane contains a toolbar.
292 return _aui
.PaneInfo_IsToolbar(*args
, **kwargs
)
294 def IsTopDockable(*args
, **kwargs
):
296 IsTopDockable(self) -> bool
298 IsTopDockable returns ``True`` if the pane can be docked at the top of
302 return _aui
.PaneInfo_IsTopDockable(*args
, **kwargs
)
304 def IsBottomDockable(*args
, **kwargs
):
306 IsBottomDockable(self) -> bool
308 IsBottomDockable returns ``True`` if the pane can be docked at the
309 bottom of the managed frame.
312 return _aui
.PaneInfo_IsBottomDockable(*args
, **kwargs
)
314 def IsLeftDockable(*args
, **kwargs
):
316 IsLeftDockable(self) -> bool
318 IsLeftDockable returns ``True`` if the pane can be docked on the left
319 of the managed frame.
322 return _aui
.PaneInfo_IsLeftDockable(*args
, **kwargs
)
324 def IsRightDockable(*args
, **kwargs
):
326 IsRightDockable(self) -> bool
328 IsRightDockable returns ``True`` if the pane can be docked on the
329 right of the managed frame.
332 return _aui
.PaneInfo_IsRightDockable(*args
, **kwargs
)
334 def IsFloatable(*args
, **kwargs
):
336 IsFloatable(self) -> bool
338 IsFloatable returns ``True`` if the pane can be undocked and displayed
339 as a floating window.
342 return _aui
.PaneInfo_IsFloatable(*args
, **kwargs
)
344 def IsMovable(*args
, **kwargs
):
346 IsMovable(self) -> bool
348 IsMoveable returns ``True`` if the docked frame can be undocked or moved
349 to another dock position.
352 return _aui
.PaneInfo_IsMovable(*args
, **kwargs
)
354 def IsDestroyOnClose(*args
, **kwargs
):
355 """IsDestroyOnClose(self) -> bool"""
356 return _aui
.PaneInfo_IsDestroyOnClose(*args
, **kwargs
)
358 def HasCaption(*args
, **kwargs
):
360 HasCaption(self) -> bool
362 HasCaption returns ``True`` if the pane displays a caption.
365 return _aui
.PaneInfo_HasCaption(*args
, **kwargs
)
367 def HasGripper(*args
, **kwargs
):
369 HasGripper(self) -> bool
371 HasGripper returns ``True`` if the pane displays a gripper.
374 return _aui
.PaneInfo_HasGripper(*args
, **kwargs
)
376 def HasBorder(*args
, **kwargs
):
378 HasBorder(self) -> bool
380 HasBorder returns ``True`` if the pane displays a border.
383 return _aui
.PaneInfo_HasBorder(*args
, **kwargs
)
385 def HasCloseButton(*args
, **kwargs
):
387 HasCloseButton(self) -> bool
389 HasCloseButton returns ``True`` if the pane displays a button to close
393 return _aui
.PaneInfo_HasCloseButton(*args
, **kwargs
)
395 def HasMaximizeButton(*args
, **kwargs
):
397 HasMaximizeButton(self) -> bool
399 HasMaximizeButton returns ``True`` if the pane displays a button to
403 return _aui
.PaneInfo_HasMaximizeButton(*args
, **kwargs
)
405 def HasMinimizeButton(*args
, **kwargs
):
407 HasMinimizeButton(self) -> bool
409 HasMinimizeButton returns ``True`` if the pane displays a button to
413 return _aui
.PaneInfo_HasMinimizeButton(*args
, **kwargs
)
415 def HasPinButton(*args
, **kwargs
):
417 HasPinButton(self) -> bool
419 HasPinButton returns ``True`` if the pane displays a button to float
423 return _aui
.PaneInfo_HasPinButton(*args
, **kwargs
)
425 def HasGripperTop(*args
, **kwargs
):
426 """HasGripperTop(self) -> bool"""
427 return _aui
.PaneInfo_HasGripperTop(*args
, **kwargs
)
429 def Window(*args
, **kwargs
):
430 """Window(self, Window w) -> PaneInfo"""
431 return _aui
.PaneInfo_Window(*args
, **kwargs
)
433 def Name(*args
, **kwargs
):
435 Name(self, String n) -> PaneInfo
437 Name sets the name of the pane so it can be referenced in lookup
441 return _aui
.PaneInfo_Name(*args
, **kwargs
)
443 def Caption(*args
, **kwargs
):
445 Caption(self, String c) -> PaneInfo
447 Caption sets the caption of the pane.
450 return _aui
.PaneInfo_Caption(*args
, **kwargs
)
452 def Left(*args
, **kwargs
):
454 Left(self) -> PaneInfo
456 Left sets the pane dock position to the left side of the frame.
459 return _aui
.PaneInfo_Left(*args
, **kwargs
)
461 def Right(*args
, **kwargs
):
463 Right(self) -> PaneInfo
465 Right sets the pane dock position to the right side of the frame.
468 return _aui
.PaneInfo_Right(*args
, **kwargs
)
470 def Top(*args
, **kwargs
):
472 Top(self) -> PaneInfo
474 Top sets the pane dock position to the top of the frame.
477 return _aui
.PaneInfo_Top(*args
, **kwargs
)
479 def Bottom(*args
, **kwargs
):
481 Bottom(self) -> PaneInfo
483 Bottom sets the pane dock position to the bottom of the frame.
486 return _aui
.PaneInfo_Bottom(*args
, **kwargs
)
488 def Center(*args
, **kwargs
):
490 Center(self) -> PaneInfo
492 Center sets the pane to the center position of the frame.
495 return _aui
.PaneInfo_Center(*args
, **kwargs
)
497 def Centre(*args
, **kwargs
):
499 Centre(self) -> PaneInfo
501 Centre sets the pane to the center position of the frame.
504 return _aui
.PaneInfo_Centre(*args
, **kwargs
)
506 def Direction(*args
, **kwargs
):
508 Direction(self, int direction) -> PaneInfo
510 Direction determines the direction of the docked pane.
513 return _aui
.PaneInfo_Direction(*args
, **kwargs
)
515 def Layer(*args
, **kwargs
):
517 Layer(self, int layer) -> PaneInfo
519 Layer determines the layer of the docked pane.
522 return _aui
.PaneInfo_Layer(*args
, **kwargs
)
524 def Row(*args
, **kwargs
):
526 Row(self, int row) -> PaneInfo
528 Row determines the row of the docked pane.
531 return _aui
.PaneInfo_Row(*args
, **kwargs
)
533 def Position(*args
, **kwargs
):
535 Position(self, int pos) -> PaneInfo
537 Position determines the position of the docked pane.
540 return _aui
.PaneInfo_Position(*args
, **kwargs
)
542 def BestSize(*args
, **kwargs
):
544 BestSize(self, Size size) -> PaneInfo
546 BestSize sets the ideal size for the pane.
549 return _aui
.PaneInfo_BestSize(*args
, **kwargs
)
551 def MinSize(*args
, **kwargs
):
553 MinSize(self, Size size) -> PaneInfo
555 MinSize sets the minimum size of the pane.
558 return _aui
.PaneInfo_MinSize(*args
, **kwargs
)
560 def MaxSize(*args
, **kwargs
):
562 MaxSize(self, Size size) -> PaneInfo
564 MaxSize sets the maximum size of the pane.
567 return _aui
.PaneInfo_MaxSize(*args
, **kwargs
)
569 def FloatingPosition(*args
, **kwargs
):
571 FloatingPosition(self, Point pos) -> PaneInfo
573 FloatingPosition sets the position of the floating pane.
576 return _aui
.PaneInfo_FloatingPosition(*args
, **kwargs
)
578 def FloatingSize(*args
, **kwargs
):
580 FloatingSize(self, Size size) -> PaneInfo
582 FloatingSize sets the size of the floating pane.
585 return _aui
.PaneInfo_FloatingSize(*args
, **kwargs
)
587 def Fixed(*args
, **kwargs
):
589 Fixed(self) -> PaneInfo
591 Fixed forces a pane to be fixed size so that it cannot be resized.
594 return _aui
.PaneInfo_Fixed(*args
, **kwargs
)
596 def Resizable(*args
, **kwargs
):
598 Resizable(self, bool resizable=True) -> PaneInfo
600 Resized allows a pane to be resized if resizable is true, and forces
601 it to be a fixed size if resizeable is false.
604 return _aui
.PaneInfo_Resizable(*args
, **kwargs
)
606 def Dock(*args
, **kwargs
):
608 Dock(self) -> PaneInfo
610 Dock indicates that a pane should be docked.
613 return _aui
.PaneInfo_Dock(*args
, **kwargs
)
615 def Float(*args
, **kwargs
):
617 Float(self) -> PaneInfo
619 Float indicates that a pane should be floated.
622 return _aui
.PaneInfo_Float(*args
, **kwargs
)
624 def Hide(*args
, **kwargs
):
626 Hide(self) -> PaneInfo
628 Hide indicates that a pane should be hidden.
631 return _aui
.PaneInfo_Hide(*args
, **kwargs
)
633 def Show(*args
, **kwargs
):
635 Show(self, bool show=True) -> PaneInfo
637 Show indicates that a pane should be shown.
640 return _aui
.PaneInfo_Show(*args
, **kwargs
)
642 def CaptionVisible(*args
, **kwargs
):
644 CaptionVisible(self, bool visible=True) -> PaneInfo
646 CaptionVisible indicates that a pane caption should be visible.
649 return _aui
.PaneInfo_CaptionVisible(*args
, **kwargs
)
651 def PaneBorder(*args
, **kwargs
):
653 PaneBorder(self, bool visible=True) -> PaneInfo
655 PaneBorder indicates that a border should be drawn for the pane.
658 return _aui
.PaneInfo_PaneBorder(*args
, **kwargs
)
660 def Gripper(*args
, **kwargs
):
662 Gripper(self, bool visible=True) -> PaneInfo
664 Gripper indicates that a gripper should be drawn for the pane..
667 return _aui
.PaneInfo_Gripper(*args
, **kwargs
)
669 def GripperTop(*args
, **kwargs
):
670 """GripperTop(self, bool attop=True) -> PaneInfo"""
671 return _aui
.PaneInfo_GripperTop(*args
, **kwargs
)
673 def CloseButton(*args
, **kwargs
):
675 CloseButton(self, bool visible=True) -> PaneInfo
677 CloseButton indicates that a close button should be drawn for the
681 return _aui
.PaneInfo_CloseButton(*args
, **kwargs
)
683 def MaximizeButton(*args
, **kwargs
):
685 MaximizeButton(self, bool visible=True) -> PaneInfo
687 MaximizeButton indicates that a maximize button should be drawn for
691 return _aui
.PaneInfo_MaximizeButton(*args
, **kwargs
)
693 def MinimizeButton(*args
, **kwargs
):
695 MinimizeButton(self, bool visible=True) -> PaneInfo
697 MinimizeButton indicates that a minimize button should be drawn for
701 return _aui
.PaneInfo_MinimizeButton(*args
, **kwargs
)
703 def PinButton(*args
, **kwargs
):
705 PinButton(self, bool visible=True) -> PaneInfo
707 PinButton indicates that a pin button should be drawn for the pane.
710 return _aui
.PaneInfo_PinButton(*args
, **kwargs
)
712 def DestroyOnClose(*args
, **kwargs
):
714 DestroyOnClose(self, bool b=True) -> PaneInfo
716 DestroyOnClose indicates whether a pane should be detroyed when it is
720 return _aui
.PaneInfo_DestroyOnClose(*args
, **kwargs
)
722 def TopDockable(*args
, **kwargs
):
724 TopDockable(self, bool b=True) -> PaneInfo
726 TopDockable indicates whether a pane can be docked at the top of the
730 return _aui
.PaneInfo_TopDockable(*args
, **kwargs
)
732 def BottomDockable(*args
, **kwargs
):
734 BottomDockable(self, bool b=True) -> PaneInfo
736 BottomDockable indicates whether a pane can be docked at the bottom of
740 return _aui
.PaneInfo_BottomDockable(*args
, **kwargs
)
742 def LeftDockable(*args
, **kwargs
):
744 LeftDockable(self, bool b=True) -> PaneInfo
746 LeftDockable indicates whether a pane can be docked on the left of the
750 return _aui
.PaneInfo_LeftDockable(*args
, **kwargs
)
752 def RightDockable(*args
, **kwargs
):
754 RightDockable(self, bool b=True) -> PaneInfo
756 RightDockable indicates whether a pane can be docked on the right of
760 return _aui
.PaneInfo_RightDockable(*args
, **kwargs
)
762 def Floatable(*args
, **kwargs
):
764 Floatable(self, bool b=True) -> PaneInfo
766 Floatable indicates whether a frame can be floated.
769 return _aui
.PaneInfo_Floatable(*args
, **kwargs
)
771 def Movable(*args
, **kwargs
):
773 Movable(self, bool b=True) -> PaneInfo
775 Movable indicates whether a frame can be moved.
778 return _aui
.PaneInfo_Movable(*args
, **kwargs
)
780 def Dockable(*args
, **kwargs
):
782 Dockable(self, bool b=True) -> PaneInfo
784 Dockable indicates whether a pane can be docked at any position of the
788 return _aui
.PaneInfo_Dockable(*args
, **kwargs
)
790 def DefaultPane(*args
, **kwargs
):
792 DefaultPane(self) -> PaneInfo
794 DefaultPane specifies that the pane should adopt the default pane
798 return _aui
.PaneInfo_DefaultPane(*args
, **kwargs
)
800 def CentrePane(*args
, **kwargs
):
802 CentrePane(self) -> PaneInfo
804 CentrePane specifies that the pane should adopt the default center
808 return _aui
.PaneInfo_CentrePane(*args
, **kwargs
)
810 def CenterPane(*args
, **kwargs
):
812 CenterPane(self) -> PaneInfo
814 CenterPane specifies that the pane should adopt the default center
818 return _aui
.PaneInfo_CenterPane(*args
, **kwargs
)
820 def ToolbarPane(*args
, **kwargs
):
822 ToolbarPane(self) -> PaneInfo
824 ToolbarPane specifies that the pane should adopt the default toolbar
828 return _aui
.PaneInfo_ToolbarPane(*args
, **kwargs
)
830 def SetFlag(*args
, **kwargs
):
832 SetFlag(self, int flag, bool option_state) -> PaneInfo
834 SetFlag turns the property given by flag on or off with the
835 option_state parameter.
838 return _aui
.PaneInfo_SetFlag(*args
, **kwargs
)
840 def HasFlag(*args
, **kwargs
):
842 HasFlag(self, int flag) -> bool
844 HasFlag returns ``True`` if the the property specified by flag is
848 return _aui
.PaneInfo_HasFlag(*args
, **kwargs
)
850 optionFloating
= _aui
.PaneInfo_optionFloating
851 optionHidden
= _aui
.PaneInfo_optionHidden
852 optionLeftDockable
= _aui
.PaneInfo_optionLeftDockable
853 optionRightDockable
= _aui
.PaneInfo_optionRightDockable
854 optionTopDockable
= _aui
.PaneInfo_optionTopDockable
855 optionBottomDockable
= _aui
.PaneInfo_optionBottomDockable
856 optionFloatable
= _aui
.PaneInfo_optionFloatable
857 optionMovable
= _aui
.PaneInfo_optionMovable
858 optionResizable
= _aui
.PaneInfo_optionResizable
859 optionPaneBorder
= _aui
.PaneInfo_optionPaneBorder
860 optionCaption
= _aui
.PaneInfo_optionCaption
861 optionGripper
= _aui
.PaneInfo_optionGripper
862 optionDestroyOnClose
= _aui
.PaneInfo_optionDestroyOnClose
863 optionToolbar
= _aui
.PaneInfo_optionToolbar
864 optionActive
= _aui
.PaneInfo_optionActive
865 optionGripperTop
= _aui
.PaneInfo_optionGripperTop
866 buttonClose
= _aui
.PaneInfo_buttonClose
867 buttonMaximize
= _aui
.PaneInfo_buttonMaximize
868 buttonMinimize
= _aui
.PaneInfo_buttonMinimize
869 buttonPin
= _aui
.PaneInfo_buttonPin
870 buttonCustom1
= _aui
.PaneInfo_buttonCustom1
871 buttonCustom2
= _aui
.PaneInfo_buttonCustom2
872 buttonCustom3
= _aui
.PaneInfo_buttonCustom3
873 actionPane
= _aui
.PaneInfo_actionPane
874 name
= property(_aui
.PaneInfo_name_get
, _aui
.PaneInfo_name_set
)
875 caption
= property(_aui
.PaneInfo_caption_get
, _aui
.PaneInfo_caption_set
)
876 window
= property(_aui
.PaneInfo_window_get
, _aui
.PaneInfo_window_set
)
877 frame
= property(_aui
.PaneInfo_frame_get
, _aui
.PaneInfo_frame_set
)
878 state
= property(_aui
.PaneInfo_state_get
, _aui
.PaneInfo_state_set
)
879 dock_direction
= property(_aui
.PaneInfo_dock_direction_get
, _aui
.PaneInfo_dock_direction_set
)
880 dock_layer
= property(_aui
.PaneInfo_dock_layer_get
, _aui
.PaneInfo_dock_layer_set
)
881 dock_row
= property(_aui
.PaneInfo_dock_row_get
, _aui
.PaneInfo_dock_row_set
)
882 dock_pos
= property(_aui
.PaneInfo_dock_pos_get
, _aui
.PaneInfo_dock_pos_set
)
883 best_size
= property(_aui
.PaneInfo_best_size_get
, _aui
.PaneInfo_best_size_set
)
884 min_size
= property(_aui
.PaneInfo_min_size_get
, _aui
.PaneInfo_min_size_set
)
885 max_size
= property(_aui
.PaneInfo_max_size_get
, _aui
.PaneInfo_max_size_set
)
886 floating_pos
= property(_aui
.PaneInfo_floating_pos_get
, _aui
.PaneInfo_floating_pos_set
)
887 floating_size
= property(_aui
.PaneInfo_floating_size_get
, _aui
.PaneInfo_floating_size_set
)
888 dock_proportion
= property(_aui
.PaneInfo_dock_proportion_get
, _aui
.PaneInfo_dock_proportion_set
)
889 buttons
= property(_aui
.PaneInfo_buttons_get
, _aui
.PaneInfo_buttons_set
)
890 rect
= property(_aui
.PaneInfo_rect_get
, _aui
.PaneInfo_rect_set
)
891 _aui
.PaneInfo_swigregister(PaneInfo
)
894 class FrameManager(_core
.EvtHandler
):
896 FrameManager manages the panes associated with it for a particular
897 `wx.Frame`, using a pane's `PaneInfo` information to determine each
898 pane's docking and floating behavior. FrameManager uses wxWidgets'
899 sizer mechanism to plan the layout of each frame. It uses a
900 replaceable `DockArt` class to do all drawing, so all drawing is
901 localized in one area, and may be customized depending on an
902 application's specific needs.
905 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
906 __repr__
= _swig_repr
907 def __init__(self
, *args
, **kwargs
):
909 __init__(self, Window managed_wnd=None, int flags=AUI_MGR_DEFAULT) -> FrameManager
913 :param managed_wnd: Specifies the `wx.Window` which should be
914 managed. If not set in the call to this constructor then
915 `SetManagedWindow` should be called later.
917 :param flags: Specifies options which allow the frame management
918 behavior to be modified.
921 _aui
.FrameManager_swiginit(self
,_aui
.new_FrameManager(*args
, **kwargs
))
922 __swig_destroy__
= _aui
.delete_FrameManager
923 __del__
= lambda self
: None;
924 def UnInit(*args
, **kwargs
):
928 UnInit uninitializes the framework and should be called before a
929 managed frame is destroyed. UnInit is usually called in the managed
933 return _aui
.FrameManager_UnInit(*args
, **kwargs
)
935 def SetFlags(*args
, **kwargs
):
937 SetFlags(self, int flags)
939 SetFlags is used to specify the FrameManager's behavioral
940 settings. The flags parameter is described in the docs for `__init__`
943 return _aui
.FrameManager_SetFlags(*args
, **kwargs
)
945 def GetFlags(*args
, **kwargs
):
947 GetFlags(self) -> int
949 GetFlags returns the current FrameManager's flags.
952 return _aui
.FrameManager_GetFlags(*args
, **kwargs
)
954 def SetManagedWindow(*args
, **kwargs
):
956 SetManagedWindow(self, Window managed_wnd)
958 SetManagedWindow is called to specify the window which is to be
959 managed by the FrameManager. It is normally a `wx.Frame` but it is
960 possible to also allow docking within any container window. This only
961 needs to be called if the window was not given to the manager in the
965 return _aui
.FrameManager_SetManagedWindow(*args
, **kwargs
)
967 def GetManagedWindow(*args
, **kwargs
):
969 GetManagedWindow(self) -> Window
971 GetManagedWindow returns the window currently being managed by the
975 return _aui
.FrameManager_GetManagedWindow(*args
, **kwargs
)
977 def SetArtProvider(*args
, **kwargs
):
979 SetArtProvider(self, DockArt art_provider)
981 SetArtProvider instructs FrameManager to use the art provider
982 specified for all drawing calls. This allows plugable look-and-feel
983 features. The previous art provider object, if any, will be destroyed
986 :note: If you wish to use a custom `DockArt` class to override drawing
987 or metrics then you shoudl derive your class from the `PyDockArt`
988 class, which has been instrumented for reflecting virtual calls to
992 return _aui
.FrameManager_SetArtProvider(*args
, **kwargs
)
994 def GetArtProvider(*args
, **kwargs
):
996 GetArtProvider(self) -> DockArt
998 GetArtProvider returns the current art provider being used.
1001 return _aui
.FrameManager_GetArtProvider(*args
, **kwargs
)
1003 def _GetPaneByWidget(*args
, **kwargs
):
1004 """_GetPaneByWidget(self, Window window) -> PaneInfo"""
1005 return _aui
.FrameManager__GetPaneByWidget(*args
, **kwargs
)
1007 def _GetPaneByName(*args
, **kwargs
):
1008 """_GetPaneByName(self, String name) -> PaneInfo"""
1009 return _aui
.FrameManager__GetPaneByName(*args
, **kwargs
)
1011 def GetAllPanes(*args
, **kwargs
):
1013 GetAllPanes(self) -> list
1015 GetAllPanes returns a list of `PaneInfo` objects for all panes managed
1016 by the frame manager.
1019 return _aui
.FrameManager_GetAllPanes(*args
, **kwargs
)
1021 def _AddPane1(*args
, **kwargs
):
1022 """_AddPane1(self, Window window, PaneInfo pane_info) -> bool"""
1023 return _aui
.FrameManager__AddPane1(*args
, **kwargs
)
1025 def AddPaneAtPos(*args
, **kwargs
):
1026 """AddPaneAtPos(self, Window window, PaneInfo pane_info, Point drop_pos) -> bool"""
1027 return _aui
.FrameManager_AddPaneAtPos(*args
, **kwargs
)
1029 def _AddPane2(*args
, **kwargs
):
1030 """_AddPane2(self, Window window, int direction=LEFT, String caption=wxEmptyString) -> bool"""
1031 return _aui
.FrameManager__AddPane2(*args
, **kwargs
)
1033 def InsertPane(*args
, **kwargs
):
1035 InsertPane(self, Window window, PaneInfo insert_location, int insert_level=AUI_INSERT_PANE) -> bool
1037 InsertPane is used to insert either a previously unmanaged pane window
1038 into the frame manager, or to insert a currently managed pane
1039 somewhere else. InsertPane will push all panes, rows, or docks aside
1040 and insert the window into the position specified by
1041 ``insert_location``. Because ``insert_location`` can specify either a pane,
1042 dock row, or dock layer, the ``insert_level`` parameter is used to
1043 disambiguate this. The parameter ``insert_level`` can take a value of
1044 ``AUI_INSERT_PANE``, ``AUI_INSERT_ROW`` or ``AUI_INSERT_DOCK``.
1047 return _aui
.FrameManager_InsertPane(*args
, **kwargs
)
1049 def DetachPane(*args
, **kwargs
):
1051 DetachPane(self, Window window) -> bool
1053 DetachPane tells the FrameManager to stop managing the pane specified
1054 by window. The window, if in a floated frame, is reparented to the
1055 frame managed by FrameManager.
1058 return _aui
.FrameManager_DetachPane(*args
, **kwargs
)
1060 def ClosePane(*args
, **kwargs
):
1061 """ClosePane(self, PaneInfo pane_info)"""
1062 return _aui
.FrameManager_ClosePane(*args
, **kwargs
)
1064 def SavePaneInfo(*args
, **kwargs
):
1065 """SavePaneInfo(self, PaneInfo pane) -> String"""
1066 return _aui
.FrameManager_SavePaneInfo(*args
, **kwargs
)
1068 def LoadPaneInfo(*args
, **kwargs
):
1069 """LoadPaneInfo(self, String pane_part, PaneInfo pane)"""
1070 return _aui
.FrameManager_LoadPaneInfo(*args
, **kwargs
)
1072 def SavePerspective(*args
, **kwargs
):
1074 SavePerspective(self) -> String
1076 SavePerspective saves the entire user interface layout into an encoded
1077 string, which can then be stored someplace by the application. When a
1078 perspective is restored using `LoadPerspective`, the entire user
1079 interface will return to the state it was when the perspective was
1083 return _aui
.FrameManager_SavePerspective(*args
, **kwargs
)
1085 def LoadPerspective(*args
, **kwargs
):
1087 LoadPerspective(self, String perspective, bool update=True) -> bool
1089 LoadPerspective loads a saved perspective. If ``update`` is ``True``,
1090 `Update` is automatically invoked, thus realizing the saved
1091 perspective on screen.
1094 return _aui
.FrameManager_LoadPerspective(*args
, **kwargs
)
1096 def Update(*args
, **kwargs
):
1100 Update shoudl be called called after any number of changes are made to
1101 any of the managed panes. Update must be invoked after `AddPane` or
1102 `InsertPane` are called in order to "realize" or "commit" the
1103 changes. In addition, any number of changes may be made to `PaneInfo`
1104 structures (retrieved with `GetPane` or `GetAllPanes`), but to realize
1105 the changes, Update must be called. This construction allows pane
1106 flicker to be avoided by updating the whole layout at one time.
1109 return _aui
.FrameManager_Update(*args
, **kwargs
)
1111 def CreateFloatingFrame(*args
, **kwargs
):
1112 """CreateFloatingFrame(self, Window parent, PaneInfo p) -> FloatingPane"""
1113 return _aui
.FrameManager_CreateFloatingFrame(*args
, **kwargs
)
1115 def DrawHintRect(*args
, **kwargs
):
1116 """DrawHintRect(self, Window pane_window, Point pt, Point offset)"""
1117 return _aui
.FrameManager_DrawHintRect(*args
, **kwargs
)
1119 def ShowHint(*args
, **kwargs
):
1120 """ShowHint(self, Rect rect)"""
1121 return _aui
.FrameManager_ShowHint(*args
, **kwargs
)
1123 def HideHint(*args
, **kwargs
):
1124 """HideHint(self)"""
1125 return _aui
.FrameManager_HideHint(*args
, **kwargs
)
1127 def OnRender(*args
, **kwargs
):
1128 """OnRender(self, FrameManagerEvent evt)"""
1129 return _aui
.FrameManager_OnRender(*args
, **kwargs
)
1131 def OnPaneButton(*args
, **kwargs
):
1132 """OnPaneButton(self, FrameManagerEvent evt)"""
1133 return _aui
.FrameManager_OnPaneButton(*args
, **kwargs
)
1135 def GetPane(self
, item
):
1137 GetPane(self, window_or_info item) -> PaneInfo
1139 GetPane is used to search for a `PaneInfo` object either by
1140 widget reference or by pane name, which acts as a unique id
1141 for a window pane. The returned `PaneInfo` object may then be
1142 modified to change a pane's look, state or position. After one
1143 or more modifications to the `PaneInfo`, `FrameManager.Update`
1144 should be called to realize the changes to the user interface.
1146 If the lookup failed (meaning the pane could not be found in
1147 the manager) GetPane returns an empty `PaneInfo`, a condition
1148 which can be checked by calling `PaneInfo.IsOk`.
1150 if isinstance(item
, wx
.Window
):
1151 return self
._GetPaneByWidget
(item
)
1153 return self
._GetPaneByName
(item
)
1155 def AddPane(self
, window
, info
=None, caption
=None):
1157 AddPane(self, window, info=None, caption=None) -> bool
1159 AddPane tells the frame manager to start managing a child
1160 window. There are two versions of this function. The first
1161 verison accepts a `PaneInfo` object for the ``info`` parameter
1162 and allows the full spectrum of pane parameter
1163 possibilities. (Say that 3 times fast!)
1165 The second version is used for simpler user interfaces which
1166 do not require as much configuration. In this case the
1167 ``info`` parameter specifies the direction property of the
1168 pane info, and defaults to ``wx.LEFT``. The pane caption may
1169 also be specified as an extra parameter in this form.
1171 if type(info
) == PaneInfo
:
1172 return self
._AddPane
1(window
, info
)
1179 return self
._AddPane
2(window
, info
, caption
)
1181 SetFrame
= wx
._deprecated
(SetManagedWindow
,
1182 "SetFrame is deprecated, use `SetManagedWindow` instead.")
1183 GetFrame
= wx
._deprecated
(GetManagedWindow
,
1184 "GetFrame is deprecated, use `GetManagedWindow` instead.")
1186 AllPanes
= property(GetAllPanes
,doc
="See `GetAllPanes`")
1187 ArtProvider
= property(GetArtProvider
,SetArtProvider
,doc
="See `GetArtProvider` and `SetArtProvider`")
1188 Flags
= property(GetFlags
,SetFlags
,doc
="See `GetFlags` and `SetFlags`")
1189 ManagedWindow
= property(GetManagedWindow
,SetManagedWindow
,doc
="See `GetManagedWindow` and `SetManagedWindow`")
1190 _aui
.FrameManager_swigregister(FrameManager
)
1192 class FrameManagerEvent(_core
.Event
):
1193 """Proxy of C++ FrameManagerEvent class"""
1194 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1195 __repr__
= _swig_repr
1196 def __init__(self
, *args
, **kwargs
):
1197 """__init__(self, EventType type=wxEVT_NULL) -> FrameManagerEvent"""
1198 _aui
.FrameManagerEvent_swiginit(self
,_aui
.new_FrameManagerEvent(*args
, **kwargs
))
1199 def Clone(*args
, **kwargs
):
1200 """Clone(self) -> Event"""
1201 return _aui
.FrameManagerEvent_Clone(*args
, **kwargs
)
1203 def SetPane(*args
, **kwargs
):
1204 """SetPane(self, PaneInfo p)"""
1205 return _aui
.FrameManagerEvent_SetPane(*args
, **kwargs
)
1207 def SetButton(*args
, **kwargs
):
1208 """SetButton(self, int b)"""
1209 return _aui
.FrameManagerEvent_SetButton(*args
, **kwargs
)
1211 def SetDC(*args
, **kwargs
):
1212 """SetDC(self, DC pdc)"""
1213 return _aui
.FrameManagerEvent_SetDC(*args
, **kwargs
)
1215 def GetPane(*args
, **kwargs
):
1216 """GetPane(self) -> PaneInfo"""
1217 return _aui
.FrameManagerEvent_GetPane(*args
, **kwargs
)
1219 def GetButton(*args
, **kwargs
):
1220 """GetButton(self) -> int"""
1221 return _aui
.FrameManagerEvent_GetButton(*args
, **kwargs
)
1223 def GetDC(*args
, **kwargs
):
1224 """GetDC(self) -> DC"""
1225 return _aui
.FrameManagerEvent_GetDC(*args
, **kwargs
)
1227 def Veto(*args
, **kwargs
):
1228 """Veto(self, bool veto=True)"""
1229 return _aui
.FrameManagerEvent_Veto(*args
, **kwargs
)
1231 def GetVeto(*args
, **kwargs
):
1232 """GetVeto(self) -> bool"""
1233 return _aui
.FrameManagerEvent_GetVeto(*args
, **kwargs
)
1235 def SetCanVeto(*args
, **kwargs
):
1236 """SetCanVeto(self, bool can_veto)"""
1237 return _aui
.FrameManagerEvent_SetCanVeto(*args
, **kwargs
)
1239 def CanVeto(*args
, **kwargs
):
1240 """CanVeto(self) -> bool"""
1241 return _aui
.FrameManagerEvent_CanVeto(*args
, **kwargs
)
1243 pane
= property(_aui
.FrameManagerEvent_pane_get
, _aui
.FrameManagerEvent_pane_set
)
1244 button
= property(_aui
.FrameManagerEvent_button_get
, _aui
.FrameManagerEvent_button_set
)
1245 veto_flag
= property(_aui
.FrameManagerEvent_veto_flag_get
, _aui
.FrameManagerEvent_veto_flag_set
)
1246 canveto_flag
= property(_aui
.FrameManagerEvent_canveto_flag_get
, _aui
.FrameManagerEvent_canveto_flag_set
)
1247 dc
= property(_aui
.FrameManagerEvent_dc_get
, _aui
.FrameManagerEvent_dc_set
)
1248 Button
= property(GetButton
,SetButton
,doc
="See `GetButton` and `SetButton`")
1249 DC
= property(GetDC
,SetDC
,doc
="See `GetDC` and `SetDC`")
1250 Pane
= property(GetPane
,SetPane
,doc
="See `GetPane` and `SetPane`")
1251 _aui
.FrameManagerEvent_swigregister(FrameManagerEvent
)
1253 class DockInfo(object):
1254 """Proxy of C++ DockInfo class"""
1255 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1256 __repr__
= _swig_repr
1257 def __init__(self
, *args
, **kwargs
):
1258 """__init__(self) -> DockInfo"""
1259 _aui
.DockInfo_swiginit(self
,_aui
.new_DockInfo(*args
, **kwargs
))
1260 def IsOk(*args
, **kwargs
):
1261 """IsOk(self) -> bool"""
1262 return _aui
.DockInfo_IsOk(*args
, **kwargs
)
1264 def IsHorizontal(*args
, **kwargs
):
1265 """IsHorizontal(self) -> bool"""
1266 return _aui
.DockInfo_IsHorizontal(*args
, **kwargs
)
1268 def IsVertical(*args
, **kwargs
):
1269 """IsVertical(self) -> bool"""
1270 return _aui
.DockInfo_IsVertical(*args
, **kwargs
)
1272 panes
= property(_aui
.DockInfo_panes_get
, _aui
.DockInfo_panes_set
)
1273 rect
= property(_aui
.DockInfo_rect_get
, _aui
.DockInfo_rect_set
)
1274 dock_direction
= property(_aui
.DockInfo_dock_direction_get
, _aui
.DockInfo_dock_direction_set
)
1275 dock_layer
= property(_aui
.DockInfo_dock_layer_get
, _aui
.DockInfo_dock_layer_set
)
1276 dock_row
= property(_aui
.DockInfo_dock_row_get
, _aui
.DockInfo_dock_row_set
)
1277 size
= property(_aui
.DockInfo_size_get
, _aui
.DockInfo_size_set
)
1278 min_size
= property(_aui
.DockInfo_min_size_get
, _aui
.DockInfo_min_size_set
)
1279 resizable
= property(_aui
.DockInfo_resizable_get
, _aui
.DockInfo_resizable_set
)
1280 toolbar
= property(_aui
.DockInfo_toolbar_get
, _aui
.DockInfo_toolbar_set
)
1281 fixed
= property(_aui
.DockInfo_fixed_get
, _aui
.DockInfo_fixed_set
)
1282 __swig_destroy__
= _aui
.delete_DockInfo
1283 __del__
= lambda self
: None;
1284 _aui
.DockInfo_swigregister(DockInfo
)
1286 class DockUIPart(object):
1287 """Proxy of C++ DockUIPart class"""
1288 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1289 def __init__(self
): raise AttributeError, "No constructor defined"
1290 __repr__
= _swig_repr
1291 typeCaption
= _aui
.DockUIPart_typeCaption
1292 typeGripper
= _aui
.DockUIPart_typeGripper
1293 typeDock
= _aui
.DockUIPart_typeDock
1294 typeDockSizer
= _aui
.DockUIPart_typeDockSizer
1295 typePane
= _aui
.DockUIPart_typePane
1296 typePaneSizer
= _aui
.DockUIPart_typePaneSizer
1297 typeBackground
= _aui
.DockUIPart_typeBackground
1298 typePaneBorder
= _aui
.DockUIPart_typePaneBorder
1299 typePaneButton
= _aui
.DockUIPart_typePaneButton
1300 type = property(_aui
.DockUIPart_type_get
, _aui
.DockUIPart_type_set
)
1301 orientation
= property(_aui
.DockUIPart_orientation_get
, _aui
.DockUIPart_orientation_set
)
1302 dock
= property(_aui
.DockUIPart_dock_get
, _aui
.DockUIPart_dock_set
)
1303 pane
= property(_aui
.DockUIPart_pane_get
, _aui
.DockUIPart_pane_set
)
1304 button
= property(_aui
.DockUIPart_button_get
, _aui
.DockUIPart_button_set
)
1305 cont_sizer
= property(_aui
.DockUIPart_cont_sizer_get
, _aui
.DockUIPart_cont_sizer_set
)
1306 sizer_item
= property(_aui
.DockUIPart_sizer_item_get
, _aui
.DockUIPart_sizer_item_set
)
1307 rect
= property(_aui
.DockUIPart_rect_get
, _aui
.DockUIPart_rect_set
)
1308 __swig_destroy__
= _aui
.delete_DockUIPart
1309 __del__
= lambda self
: None;
1310 _aui
.DockUIPart_swigregister(DockUIPart
)
1312 class PaneButton(object):
1313 """Proxy of C++ PaneButton class"""
1314 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1315 def __init__(self
): raise AttributeError, "No constructor defined"
1316 __repr__
= _swig_repr
1317 button_id
= property(_aui
.PaneButton_button_id_get
, _aui
.PaneButton_button_id_set
)
1318 __swig_destroy__
= _aui
.delete_PaneButton
1319 __del__
= lambda self
: None;
1320 _aui
.PaneButton_swigregister(PaneButton
)
1322 wxEVT_AUI_PANEBUTTON
= _aui
.wxEVT_AUI_PANEBUTTON
1323 wxEVT_AUI_PANECLOSE
= _aui
.wxEVT_AUI_PANECLOSE
1324 wxEVT_AUI_RENDER
= _aui
.wxEVT_AUI_RENDER
1325 EVT_AUI_PANEBUTTON
= wx
.PyEventBinder( wxEVT_AUI_PANEBUTTON
)
1326 EVT_AUI_PANECLOSE
= wx
.PyEventBinder( wxEVT_AUI_PANECLOSE
)
1327 EVT_AUI_RENDER
= wx
.PyEventBinder( wxEVT_AUI_RENDER
)
1329 class DockArt(object):
1331 DockArt is an art provider class which does all of the drawing for
1332 `FrameManager`. This allows the library caller to customize or replace the
1333 dock art and drawing routines by deriving a new class from `PyDockArt`. The
1334 active dock art class can be set via `FrameManager.SetArtProvider`.
1337 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1338 def __init__(self
): raise AttributeError, "No constructor defined"
1339 __repr__
= _swig_repr
1340 __swig_destroy__
= _aui
.delete_DockArt
1341 __del__
= lambda self
: None;
1342 def GetMetric(*args
, **kwargs
):
1343 """GetMetric(self, int id) -> int"""
1344 return _aui
.DockArt_GetMetric(*args
, **kwargs
)
1346 def SetMetric(*args
, **kwargs
):
1347 """SetMetric(self, int id, int new_val)"""
1348 return _aui
.DockArt_SetMetric(*args
, **kwargs
)
1350 def SetFont(*args
, **kwargs
):
1351 """SetFont(self, int id, Font font)"""
1352 return _aui
.DockArt_SetFont(*args
, **kwargs
)
1354 def GetFont(*args
, **kwargs
):
1355 """GetFont(self, int id) -> Font"""
1356 return _aui
.DockArt_GetFont(*args
, **kwargs
)
1358 def GetColour(*args
, **kwargs
):
1359 """GetColour(self, int id) -> Colour"""
1360 return _aui
.DockArt_GetColour(*args
, **kwargs
)
1362 def SetColour(*args
, **kwargs
):
1363 """SetColour(self, int id, wxColor colour)"""
1364 return _aui
.DockArt_SetColour(*args
, **kwargs
)
1366 def GetColor(*args
, **kwargs
):
1367 """GetColor(self, int id) -> Colour"""
1368 return _aui
.DockArt_GetColor(*args
, **kwargs
)
1370 def SetColor(*args
, **kwargs
):
1371 """SetColor(self, int id, Colour color)"""
1372 return _aui
.DockArt_SetColor(*args
, **kwargs
)
1374 def DrawSash(*args
, **kwargs
):
1375 """DrawSash(self, DC dc, Window window, int orientation, Rect rect)"""
1376 return _aui
.DockArt_DrawSash(*args
, **kwargs
)
1378 def DrawBackground(*args
, **kwargs
):
1379 """DrawBackground(self, DC dc, Window window, int orientation, Rect rect)"""
1380 return _aui
.DockArt_DrawBackground(*args
, **kwargs
)
1382 def DrawCaption(*args
, **kwargs
):
1383 """DrawCaption(self, DC dc, Window window, String text, Rect rect, PaneInfo pane)"""
1384 return _aui
.DockArt_DrawCaption(*args
, **kwargs
)
1386 def DrawGripper(*args
, **kwargs
):
1387 """DrawGripper(self, DC dc, Window window, Rect rect, PaneInfo pane)"""
1388 return _aui
.DockArt_DrawGripper(*args
, **kwargs
)
1390 def DrawBorder(*args
, **kwargs
):
1391 """DrawBorder(self, DC dc, Window window, Rect rect, PaneInfo pane)"""
1392 return _aui
.DockArt_DrawBorder(*args
, **kwargs
)
1394 def DrawPaneButton(*args
, **kwargs
):
1396 DrawPaneButton(self, DC dc, Window window, int button, int button_state,
1397 Rect rect, PaneInfo pane)
1399 return _aui
.DockArt_DrawPaneButton(*args
, **kwargs
)
1401 _aui
.DockArt_swigregister(DockArt
)
1403 class DefaultDockArt(DockArt
):
1405 DefaultDockArt is the type of art class constructed by default for the
1408 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1409 __repr__
= _swig_repr
1410 def __init__(self
, *args
, **kwargs
):
1412 __init__(self) -> DefaultDockArt
1414 DefaultDockArt is the type of art class constructed by default for the
1417 _aui
.DefaultDockArt_swiginit(self
,_aui
.new_DefaultDockArt(*args
, **kwargs
))
1418 _aui
.DefaultDockArt_swigregister(DefaultDockArt
)
1420 class FloatingPane(_windows
.MiniFrame
):
1421 """Proxy of C++ FloatingPane class"""
1422 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1423 __repr__
= _swig_repr
1424 def __init__(self
, *args
, **kwargs
):
1426 __init__(self, Window parent, FrameManager owner_mgr, PaneInfo pane,
1427 int id=ID_ANY, long style=wxRESIZE_BORDER|wxSYSTEM_MENU|wxCAPTION|wxFRAME_NO_TASKBAR|wxFRAME_FLOAT_ON_PARENT|wxCLIP_CHILDREN) -> FloatingPane
1429 _aui
.FloatingPane_swiginit(self
,_aui
.new_FloatingPane(*args
, **kwargs
))
1430 __swig_destroy__
= _aui
.delete_FloatingPane
1431 __del__
= lambda self
: None;
1432 def SetPaneWindow(*args
, **kwargs
):
1433 """SetPaneWindow(self, PaneInfo pane)"""
1434 return _aui
.FloatingPane_SetPaneWindow(*args
, **kwargs
)
1436 _aui
.FloatingPane_swigregister(FloatingPane
)
1438 class AuiNotebookEvent(_core
.NotifyEvent
):
1439 """Proxy of C++ AuiNotebookEvent class"""
1440 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1441 __repr__
= _swig_repr
1442 def __init__(self
, *args
, **kwargs
):
1443 """__init__(self, EventType command_type=wxEVT_NULL, int win_id=0) -> AuiNotebookEvent"""
1444 _aui
.AuiNotebookEvent_swiginit(self
,_aui
.new_AuiNotebookEvent(*args
, **kwargs
))
1445 def SetSelection(*args
, **kwargs
):
1446 """SetSelection(self, int s)"""
1447 return _aui
.AuiNotebookEvent_SetSelection(*args
, **kwargs
)
1449 def SetOldSelection(*args
, **kwargs
):
1450 """SetOldSelection(self, int s)"""
1451 return _aui
.AuiNotebookEvent_SetOldSelection(*args
, **kwargs
)
1453 def GetSelection(*args
, **kwargs
):
1455 GetSelection(self) -> int
1457 Returns item index for a listbox or choice selection event (not valid
1460 return _aui
.AuiNotebookEvent_GetSelection(*args
, **kwargs
)
1462 def GetOldSelection(*args
, **kwargs
):
1463 """GetOldSelection(self) -> int"""
1464 return _aui
.AuiNotebookEvent_GetOldSelection(*args
, **kwargs
)
1466 old_selection
= property(_aui
.AuiNotebookEvent_old_selection_get
, _aui
.AuiNotebookEvent_old_selection_set
)
1467 selection
= property(_aui
.AuiNotebookEvent_selection_get
, _aui
.AuiNotebookEvent_selection_set
)
1468 OldSelection
= property(GetOldSelection
,SetOldSelection
,doc
="See `GetOldSelection` and `SetOldSelection`")
1469 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
1470 _aui
.AuiNotebookEvent_swigregister(AuiNotebookEvent
)
1472 class AuiNotebookPage(object):
1473 """Proxy of C++ AuiNotebookPage class"""
1474 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1475 def __init__(self
): raise AttributeError, "No constructor defined"
1476 __repr__
= _swig_repr
1477 window
= property(_aui
.AuiNotebookPage_window_get
, _aui
.AuiNotebookPage_window_set
)
1478 caption
= property(_aui
.AuiNotebookPage_caption_get
, _aui
.AuiNotebookPage_caption_set
)
1479 bitmap
= property(_aui
.AuiNotebookPage_bitmap_get
, _aui
.AuiNotebookPage_bitmap_set
)
1480 rect
= property(_aui
.AuiNotebookPage_rect_get
, _aui
.AuiNotebookPage_rect_set
)
1481 active
= property(_aui
.AuiNotebookPage_active_get
, _aui
.AuiNotebookPage_active_set
)
1482 _aui
.AuiNotebookPage_swigregister(AuiNotebookPage
)
1484 class AuiTabContainerButton(object):
1485 """Proxy of C++ AuiTabContainerButton class"""
1486 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1487 def __init__(self
): raise AttributeError, "No constructor defined"
1488 __repr__
= _swig_repr
1489 id = property(_aui
.AuiTabContainerButton_id_get
, _aui
.AuiTabContainerButton_id_set
)
1490 cur_state
= property(_aui
.AuiTabContainerButton_cur_state_get
, _aui
.AuiTabContainerButton_cur_state_set
)
1491 bitmap
= property(_aui
.AuiTabContainerButton_bitmap_get
, _aui
.AuiTabContainerButton_bitmap_set
)
1492 rect
= property(_aui
.AuiTabContainerButton_rect_get
, _aui
.AuiTabContainerButton_rect_set
)
1493 _aui
.AuiTabContainerButton_swigregister(AuiTabContainerButton
)
1495 class AuiTabContainer(object):
1496 """Proxy of C++ AuiTabContainer class"""
1497 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1498 __repr__
= _swig_repr
1499 def __init__(self
, *args
, **kwargs
):
1500 """__init__(self) -> AuiTabContainer"""
1501 _aui
.AuiTabContainer_swiginit(self
,_aui
.new_AuiTabContainer(*args
, **kwargs
))
1502 __swig_destroy__
= _aui
.delete_AuiTabContainer
1503 __del__
= lambda self
: None;
1504 def AddPage(*args
, **kwargs
):
1505 """AddPage(self, Window page, AuiNotebookPage info) -> bool"""
1506 return _aui
.AuiTabContainer_AddPage(*args
, **kwargs
)
1508 def InsertPage(*args
, **kwargs
):
1509 """InsertPage(self, Window page, AuiNotebookPage info, size_t idx) -> bool"""
1510 return _aui
.AuiTabContainer_InsertPage(*args
, **kwargs
)
1512 def RemovePage(*args
, **kwargs
):
1513 """RemovePage(self, Window page) -> bool"""
1514 return _aui
.AuiTabContainer_RemovePage(*args
, **kwargs
)
1516 def SetActivePage(*args
):
1518 SetActivePage(self, Window page) -> bool
1519 SetActivePage(self, size_t page) -> bool
1521 return _aui
.AuiTabContainer_SetActivePage(*args
)
1523 def SetNoneActive(*args
, **kwargs
):
1524 """SetNoneActive(self)"""
1525 return _aui
.AuiTabContainer_SetNoneActive(*args
, **kwargs
)
1527 def GetActivePage(*args
, **kwargs
):
1528 """GetActivePage(self) -> int"""
1529 return _aui
.AuiTabContainer_GetActivePage(*args
, **kwargs
)
1531 def TabHitTest(*args
, **kwargs
):
1532 """TabHitTest(self, int x, int y, Window hit) -> bool"""
1533 return _aui
.AuiTabContainer_TabHitTest(*args
, **kwargs
)
1535 def ButtonHitTest(*args
, **kwargs
):
1536 """ButtonHitTest(self, int x, int y, AuiTabContainerButton hit) -> bool"""
1537 return _aui
.AuiTabContainer_ButtonHitTest(*args
, **kwargs
)
1539 def GetWindowFromIdx(*args
, **kwargs
):
1540 """GetWindowFromIdx(self, size_t idx) -> Window"""
1541 return _aui
.AuiTabContainer_GetWindowFromIdx(*args
, **kwargs
)
1543 def GetIdxFromWindow(*args
, **kwargs
):
1544 """GetIdxFromWindow(self, Window page) -> int"""
1545 return _aui
.AuiTabContainer_GetIdxFromWindow(*args
, **kwargs
)
1547 def GetPageCount(*args
, **kwargs
):
1548 """GetPageCount(self) -> size_t"""
1549 return _aui
.AuiTabContainer_GetPageCount(*args
, **kwargs
)
1551 def GetPage(*args
, **kwargs
):
1552 """GetPage(self, size_t idx) -> AuiNotebookPage"""
1553 return _aui
.AuiTabContainer_GetPage(*args
, **kwargs
)
1555 def GetPages(*args
, **kwargs
):
1556 """GetPages(self) -> wxAuiNotebookPageArray"""
1557 return _aui
.AuiTabContainer_GetPages(*args
, **kwargs
)
1559 def SetNormalFont(*args
, **kwargs
):
1560 """SetNormalFont(self, Font normal_font)"""
1561 return _aui
.AuiTabContainer_SetNormalFont(*args
, **kwargs
)
1563 def SetSelectedFont(*args
, **kwargs
):
1564 """SetSelectedFont(self, Font selected_font)"""
1565 return _aui
.AuiTabContainer_SetSelectedFont(*args
, **kwargs
)
1567 def SetMeasuringFont(*args
, **kwargs
):
1568 """SetMeasuringFont(self, Font measuring_font)"""
1569 return _aui
.AuiTabContainer_SetMeasuringFont(*args
, **kwargs
)
1571 def DoShowHide(*args
, **kwargs
):
1572 """DoShowHide(self)"""
1573 return _aui
.AuiTabContainer_DoShowHide(*args
, **kwargs
)
1575 def SetRect(*args
, **kwargs
):
1576 """SetRect(self, Rect rect)"""
1577 return _aui
.AuiTabContainer_SetRect(*args
, **kwargs
)
1579 def AddButton(*args
, **kwargs
):
1580 """AddButton(self, int id, Bitmap bmp)"""
1581 return _aui
.AuiTabContainer_AddButton(*args
, **kwargs
)
1583 ActivePage
= property(GetActivePage
,SetActivePage
,doc
="See `GetActivePage` and `SetActivePage`")
1584 PageCount
= property(GetPageCount
,doc
="See `GetPageCount`")
1585 Pages
= property(GetPages
,doc
="See `GetPages`")
1586 _aui
.AuiTabContainer_swigregister(AuiTabContainer
)
1588 class AuiTabCtrl(_core
.Control
,AuiTabContainer
):
1589 """Proxy of C++ AuiTabCtrl class"""
1590 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1591 __repr__
= _swig_repr
1592 def __init__(self
, *args
, **kwargs
):
1594 __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
1595 Size size=DefaultSize, long style=0) -> AuiTabCtrl
1597 _aui
.AuiTabCtrl_swiginit(self
,_aui
.new_AuiTabCtrl(*args
, **kwargs
))
1598 self
._setOORInfo
(self
)
1600 _aui
.AuiTabCtrl_swigregister(AuiTabCtrl
)
1602 class AuiMultiNotebook(_core
.Control
):
1603 """Proxy of C++ AuiMultiNotebook class"""
1604 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1605 __repr__
= _swig_repr
1606 def __init__(self
, *args
, **kwargs
):
1608 __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
1609 Size size=DefaultSize, long style=0) -> AuiMultiNotebook
1611 _aui
.AuiMultiNotebook_swiginit(self
,_aui
.new_AuiMultiNotebook(*args
, **kwargs
))
1612 self
._setOORInfo
(self
)
1614 def Create(*args
, **kwargs
):
1616 Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
1617 Size size=DefaultSize, long style=0) -> bool
1619 Do the 2nd phase and create the GUI control.
1621 return _aui
.AuiMultiNotebook_Create(*args
, **kwargs
)
1623 def AddPage(*args
, **kwargs
):
1624 """AddPage(self, Window page, String caption, bool select=False, Bitmap bitmap=wxNullBitmap) -> bool"""
1625 return _aui
.AuiMultiNotebook_AddPage(*args
, **kwargs
)
1627 def InsertPage(*args
, **kwargs
):
1629 InsertPage(self, size_t page_idx, Window page, String caption, bool select=False,
1630 Bitmap bitmap=wxNullBitmap) -> bool
1632 return _aui
.AuiMultiNotebook_InsertPage(*args
, **kwargs
)
1634 def DeletePage(*args
, **kwargs
):
1635 """DeletePage(self, size_t page) -> bool"""
1636 return _aui
.AuiMultiNotebook_DeletePage(*args
, **kwargs
)
1638 def RemovePage(*args
, **kwargs
):
1639 """RemovePage(self, size_t page) -> bool"""
1640 return _aui
.AuiMultiNotebook_RemovePage(*args
, **kwargs
)
1642 def SetPageText(*args
, **kwargs
):
1643 """SetPageText(self, size_t page, String text) -> bool"""
1644 return _aui
.AuiMultiNotebook_SetPageText(*args
, **kwargs
)
1646 def SetSelection(*args
, **kwargs
):
1647 """SetSelection(self, size_t new_page) -> size_t"""
1648 return _aui
.AuiMultiNotebook_SetSelection(*args
, **kwargs
)
1650 def GetSelection(*args
, **kwargs
):
1651 """GetSelection(self) -> int"""
1652 return _aui
.AuiMultiNotebook_GetSelection(*args
, **kwargs
)
1654 def GetPageCount(*args
, **kwargs
):
1655 """GetPageCount(self) -> size_t"""
1656 return _aui
.AuiMultiNotebook_GetPageCount(*args
, **kwargs
)
1658 def GetPage(*args
, **kwargs
):
1659 """GetPage(self, size_t page_idx) -> Window"""
1660 return _aui
.AuiMultiNotebook_GetPage(*args
, **kwargs
)
1662 PageCount
= property(GetPageCount
,doc
="See `GetPageCount`")
1663 Selection
= property(GetSelection
,SetSelection
,doc
="See `GetSelection` and `SetSelection`")
1664 _aui
.AuiMultiNotebook_swigregister(AuiMultiNotebook
)
1666 def PreAuiMultiNotebook(*args
, **kwargs
):
1667 """PreAuiMultiNotebook() -> AuiMultiNotebook"""
1668 val
= _aui
.new_PreAuiMultiNotebook(*args
, **kwargs
)
1669 self
._setOORInfo
(self
)
1672 wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
1673 wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
1674 wxEVT_COMMAND_AUINOTEBOOK_BUTTON
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_BUTTON
1675 wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
1676 wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
1677 wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
= _aui
.wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
1678 EVT_AUINOTEBOOK_PAGE_CHANGED
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
, 1 )
1679 EVT_AUINOTEBOOK_PAGE_CHANGING
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
, 1 )
1680 EVT_AUINOTEBOOK_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BUTTON
, 1 )
1681 EVT_AUINOTEBOOK_BEGIN_DRAG
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
, 1 )
1682 EVT_AUINOTEBOOK_END_DRAG
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
, 1 )
1683 EVT_AUINOTEBOOK_DRAG_MOTION
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
, 1 )
1685 class PyDockArt(DefaultDockArt
):
1687 This version of the `DockArt` class has been instrumented to be
1688 subclassable in Python and to reflect all calls to the C++ base class
1689 methods to the Python methods implemented in the derived class.
1691 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1692 def __init__(self
): raise AttributeError, "No constructor defined"
1693 __repr__
= _swig_repr
1694 _aui
.PyDockArt_swigregister(PyDockArt
)