]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/mac/aui.py
5a6a228870c05801eabd03463562d830a5b25283
[wxWidgets.git] / wxPython / src / mac / aui.py
1 # This file was created automatically by SWIG 1.3.29.
2 # Don't modify this file, modify the SWIG interface instead.
3
4 """
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.
9
10 **Vision and Design Principles**
11
12 wx.aui attempts to encapsulate the following aspects of the user
13 interface:
14
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.
19
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.
25
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.
31
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
36 animation.
37
38 **PyAUI adheres to the following principles**
39
40 - Use native floating frames to obtain a native look and feel for
41 all platforms;
42
43 - Use existing wxPython code where possible, such as sizer
44 implementation for frame management;
45
46 - Use standard wxPython coding conventions.
47
48
49 **Usage**
50
51 The following example shows a simple implementation that utilizes
52 `wx.aui.FrameManager` to manage three text controls in a frame window::
53
54 import wx
55 import wx.aui
56
57 class MyFrame(wx.Frame):
58
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)
62
63 self._mgr = wx.aui.FrameManager(self)
64
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)
69
70 text2 = wx.TextCtrl(self, -1, 'Pane 2 - sample text',
71 wx.DefaultPosition, wx.Size(200,150),
72 wx.NO_BORDER | wx.TE_MULTILINE)
73
74 text3 = wx.TextCtrl(self, -1, 'Main content window',
75 wx.DefaultPosition, wx.Size(200,150),
76 wx.NO_BORDER | wx.TE_MULTILINE)
77
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)
82
83 # tell the manager to 'commit' all the changes just made
84 self._mgr.Update()
85
86 self.Bind(wx.EVT_CLOSE, self.OnClose)
87
88
89 def OnClose(self, event):
90 # deinitialize the frame manager
91 self._mgr.UnInit()
92 # delete the frame
93 self.Destroy()
94
95
96 app = wx.App()
97 frame = MyFrame(None)
98 frame.Show()
99 app.MainLoop()
100
101 """
102
103 import _aui
104 import new
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)
108 if (name == "this"):
109 if type(value).__name__ == 'PySwigObject':
110 self.__dict__[name] = value
111 return
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
116 else:
117 raise AttributeError("You cannot add attributes to %s" % self)
118
119 def _swig_setattr(self,class_type,name,value):
120 return _swig_setattr_nondynamic(self,class_type,name,value,0)
121
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
127
128 def _swig_repr(self):
129 try: strthis = "proxy of " + self.this.__repr__()
130 except: strthis = ""
131 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
132
133 import types
134 try:
135 _object = types.ObjectType
136 _newclass = 1
137 except AttributeError:
138 class _object : pass
139 _newclass = 0
140 del types
141
142
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"):
147 set(self,name,value)
148 else:
149 raise AttributeError("You cannot add attributes to %s" % self)
150 return set_attr
151
152
153 import _core
154 import _windows
155 wx = _core
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_DEFAULT = _aui.AUI_MGR_DEFAULT
171 AUI_ART_SASH_SIZE = _aui.AUI_ART_SASH_SIZE
172 AUI_ART_CAPTION_SIZE = _aui.AUI_ART_CAPTION_SIZE
173 AUI_ART_GRIPPER_SIZE = _aui.AUI_ART_GRIPPER_SIZE
174 AUI_ART_PANE_BORDER_SIZE = _aui.AUI_ART_PANE_BORDER_SIZE
175 AUI_ART_PANE_BUTTON_SIZE = _aui.AUI_ART_PANE_BUTTON_SIZE
176 AUI_ART_BACKGROUND_COLOUR = _aui.AUI_ART_BACKGROUND_COLOUR
177 AUI_ART_SASH_COLOUR = _aui.AUI_ART_SASH_COLOUR
178 AUI_ART_ACTIVE_CAPTION_COLOUR = _aui.AUI_ART_ACTIVE_CAPTION_COLOUR
179 AUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR = _aui.AUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR
180 AUI_ART_INACTIVE_CAPTION_COLOUR = _aui.AUI_ART_INACTIVE_CAPTION_COLOUR
181 AUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR = _aui.AUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR
182 AUI_ART_ACTIVE_CAPTION_TEXT_COLOUR = _aui.AUI_ART_ACTIVE_CAPTION_TEXT_COLOUR
183 AUI_ART_INACTIVE_CAPTION_TEXT_COLOUR = _aui.AUI_ART_INACTIVE_CAPTION_TEXT_COLOUR
184 AUI_ART_BORDER_COLOUR = _aui.AUI_ART_BORDER_COLOUR
185 AUI_ART_GRIPPER_COLOUR = _aui.AUI_ART_GRIPPER_COLOUR
186 AUI_ART_CAPTION_FONT = _aui.AUI_ART_CAPTION_FONT
187 AUI_ART_GRADIENT_TYPE = _aui.AUI_ART_GRADIENT_TYPE
188 AUI_GRADIENT_NONE = _aui.AUI_GRADIENT_NONE
189 AUI_GRADIENT_VERTICAL = _aui.AUI_GRADIENT_VERTICAL
190 AUI_GRADIENT_HORIZONTAL = _aui.AUI_GRADIENT_HORIZONTAL
191 AUI_BUTTON_STATE_NORMAL = _aui.AUI_BUTTON_STATE_NORMAL
192 AUI_BUTTON_STATE_HOVER = _aui.AUI_BUTTON_STATE_HOVER
193 AUI_BUTTON_STATE_PRESSED = _aui.AUI_BUTTON_STATE_PRESSED
194 AUI_INSERT_PANE = _aui.AUI_INSERT_PANE
195 AUI_INSERT_ROW = _aui.AUI_INSERT_ROW
196 AUI_INSERT_DOCK = _aui.AUI_INSERT_DOCK
197 class PaneInfo(object):
198 """
199 PaneInfo specifies all the parameters for a pane for the
200 `FrameManager`. These parameters specify where the pane is on the
201 screen, whether it is docked or floating, or hidden. In addition,
202 these parameters specify the pane's docked position, floating
203 position, preferred size, minimum size, caption text among many other
204 parameters.
205
206 """
207 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
208 __repr__ = _swig_repr
209 def __init__(self, *args, **kwargs):
210 """
211 __init__(self) -> PaneInfo
212
213 PaneInfo specifies all the parameters for a pane for the
214 `FrameManager`. These parameters specify where the pane is on the
215 screen, whether it is docked or floating, or hidden. In addition,
216 these parameters specify the pane's docked position, floating
217 position, preferred size, minimum size, caption text among many other
218 parameters.
219
220 """
221 _aui.PaneInfo_swiginit(self,_aui.new_PaneInfo(*args, **kwargs))
222 __swig_destroy__ = _aui.delete_PaneInfo
223 __del__ = lambda self : None;
224 def IsOk(*args, **kwargs):
225 """
226 IsOk(self) -> bool
227
228 IsOk returns ``True`` if the PaneInfo structure is valid.
229
230 """
231 return _aui.PaneInfo_IsOk(*args, **kwargs)
232
233 def IsFixed(*args, **kwargs):
234 """
235 IsFixed(self) -> bool
236
237 IsFixed returns ``True`` if the pane cannot be resized.
238
239 """
240 return _aui.PaneInfo_IsFixed(*args, **kwargs)
241
242 def IsResizable(*args, **kwargs):
243 """
244 IsResizable(self) -> bool
245
246 IsResizeable returns ``True`` if the pane can be resized.
247
248 """
249 return _aui.PaneInfo_IsResizable(*args, **kwargs)
250
251 def IsShown(*args, **kwargs):
252 """
253 IsShown(self) -> bool
254
255 IsShown returns ``True`` if the pane should be drawn on the screen.
256
257 """
258 return _aui.PaneInfo_IsShown(*args, **kwargs)
259
260 def IsFloating(*args, **kwargs):
261 """
262 IsFloating(self) -> bool
263
264 IsFloating returns ``True`` if the pane is floating.
265
266 """
267 return _aui.PaneInfo_IsFloating(*args, **kwargs)
268
269 def IsDocked(*args, **kwargs):
270 """
271 IsDocked(self) -> bool
272
273 IsDocked returns ``True`` if the pane is docked.
274
275 """
276 return _aui.PaneInfo_IsDocked(*args, **kwargs)
277
278 def IsToolbar(*args, **kwargs):
279 """
280 IsToolbar(self) -> bool
281
282 IsToolbar returns ``True`` if the pane contains a toolbar.
283
284 """
285 return _aui.PaneInfo_IsToolbar(*args, **kwargs)
286
287 def IsTopDockable(*args, **kwargs):
288 """
289 IsTopDockable(self) -> bool
290
291 IsTopDockable returns ``True`` if the pane can be docked at the top of
292 the managed frame.
293
294 """
295 return _aui.PaneInfo_IsTopDockable(*args, **kwargs)
296
297 def IsBottomDockable(*args, **kwargs):
298 """
299 IsBottomDockable(self) -> bool
300
301 IsBottomDockable returns ``True`` if the pane can be docked at the
302 bottom of the managed frame.
303
304 """
305 return _aui.PaneInfo_IsBottomDockable(*args, **kwargs)
306
307 def IsLeftDockable(*args, **kwargs):
308 """
309 IsLeftDockable(self) -> bool
310
311 IsLeftDockable returns ``True`` if the pane can be docked on the left
312 of the managed frame.
313
314 """
315 return _aui.PaneInfo_IsLeftDockable(*args, **kwargs)
316
317 def IsRightDockable(*args, **kwargs):
318 """
319 IsRightDockable(self) -> bool
320
321 IsRightDockable returns ``True`` if the pane can be docked on the
322 right of the managed frame.
323
324 """
325 return _aui.PaneInfo_IsRightDockable(*args, **kwargs)
326
327 def IsFloatable(*args, **kwargs):
328 """
329 IsFloatable(self) -> bool
330
331 IsFloatable returns ``True`` if the pane can be undocked and displayed
332 as a floating window.
333
334 """
335 return _aui.PaneInfo_IsFloatable(*args, **kwargs)
336
337 def IsMovable(*args, **kwargs):
338 """
339 IsMovable(self) -> bool
340
341 IsMoveable returns ``True`` if the docked frame can be undocked or moved
342 to another dock position.
343
344 """
345 return _aui.PaneInfo_IsMovable(*args, **kwargs)
346
347 def HasCaption(*args, **kwargs):
348 """
349 HasCaption(self) -> bool
350
351 HasCaption returns ``True`` if the pane displays a caption.
352
353 """
354 return _aui.PaneInfo_HasCaption(*args, **kwargs)
355
356 def HasGripper(*args, **kwargs):
357 """
358 HasGripper(self) -> bool
359
360 HasGripper returns ``True`` if the pane displays a gripper.
361
362 """
363 return _aui.PaneInfo_HasGripper(*args, **kwargs)
364
365 def HasBorder(*args, **kwargs):
366 """
367 HasBorder(self) -> bool
368
369 HasBorder returns ``True`` if the pane displays a border.
370
371 """
372 return _aui.PaneInfo_HasBorder(*args, **kwargs)
373
374 def HasCloseButton(*args, **kwargs):
375 """
376 HasCloseButton(self) -> bool
377
378 HasCloseButton returns ``True`` if the pane displays a button to close
379 the pane.
380
381 """
382 return _aui.PaneInfo_HasCloseButton(*args, **kwargs)
383
384 def HasMaximizeButton(*args, **kwargs):
385 """
386 HasMaximizeButton(self) -> bool
387
388 HasMaximizeButton returns ``True`` if the pane displays a button to
389 maximize the pane.
390
391 """
392 return _aui.PaneInfo_HasMaximizeButton(*args, **kwargs)
393
394 def HasMinimizeButton(*args, **kwargs):
395 """
396 HasMinimizeButton(self) -> bool
397
398 HasMinimizeButton returns ``True`` if the pane displays a button to
399 minimize the pane.
400
401 """
402 return _aui.PaneInfo_HasMinimizeButton(*args, **kwargs)
403
404 def HasPinButton(*args, **kwargs):
405 """
406 HasPinButton(self) -> bool
407
408 HasPinButton returns ``True`` if the pane displays a button to float
409 the pane.
410
411 """
412 return _aui.PaneInfo_HasPinButton(*args, **kwargs)
413
414 def HasGripperTop(*args, **kwargs):
415 """HasGripperTop(self) -> bool"""
416 return _aui.PaneInfo_HasGripperTop(*args, **kwargs)
417
418 def Window(*args, **kwargs):
419 """Window(self, Window w) -> PaneInfo"""
420 return _aui.PaneInfo_Window(*args, **kwargs)
421
422 def Name(*args, **kwargs):
423 """
424 Name(self, String n) -> PaneInfo
425
426 Name sets the name of the pane so it can be referenced in lookup
427 functions.
428
429 """
430 return _aui.PaneInfo_Name(*args, **kwargs)
431
432 def Caption(*args, **kwargs):
433 """
434 Caption(self, String c) -> PaneInfo
435
436 Caption sets the caption of the pane.
437
438 """
439 return _aui.PaneInfo_Caption(*args, **kwargs)
440
441 def Left(*args, **kwargs):
442 """
443 Left(self) -> PaneInfo
444
445 Left sets the pane dock position to the left side of the frame.
446
447 """
448 return _aui.PaneInfo_Left(*args, **kwargs)
449
450 def Right(*args, **kwargs):
451 """
452 Right(self) -> PaneInfo
453
454 Right sets the pane dock position to the right side of the frame.
455
456 """
457 return _aui.PaneInfo_Right(*args, **kwargs)
458
459 def Top(*args, **kwargs):
460 """
461 Top(self) -> PaneInfo
462
463 Top sets the pane dock position to the top of the frame.
464
465 """
466 return _aui.PaneInfo_Top(*args, **kwargs)
467
468 def Bottom(*args, **kwargs):
469 """
470 Bottom(self) -> PaneInfo
471
472 Bottom sets the pane dock position to the bottom of the frame.
473
474 """
475 return _aui.PaneInfo_Bottom(*args, **kwargs)
476
477 def Center(*args, **kwargs):
478 """
479 Center(self) -> PaneInfo
480
481 Center sets the pane to the center position of the frame.
482
483 """
484 return _aui.PaneInfo_Center(*args, **kwargs)
485
486 def Centre(*args, **kwargs):
487 """
488 Centre(self) -> PaneInfo
489
490 Centre sets the pane to the center position of the frame.
491
492 """
493 return _aui.PaneInfo_Centre(*args, **kwargs)
494
495 def Direction(*args, **kwargs):
496 """
497 Direction(self, int direction) -> PaneInfo
498
499 Direction determines the direction of the docked pane.
500
501 """
502 return _aui.PaneInfo_Direction(*args, **kwargs)
503
504 def Layer(*args, **kwargs):
505 """
506 Layer(self, int layer) -> PaneInfo
507
508 Layer determines the layer of the docked pane.
509
510 """
511 return _aui.PaneInfo_Layer(*args, **kwargs)
512
513 def Row(*args, **kwargs):
514 """
515 Row(self, int row) -> PaneInfo
516
517 Row determines the row of the docked pane.
518
519 """
520 return _aui.PaneInfo_Row(*args, **kwargs)
521
522 def Position(*args, **kwargs):
523 """
524 Position(self, int pos) -> PaneInfo
525
526 Position determines the position of the docked pane.
527
528 """
529 return _aui.PaneInfo_Position(*args, **kwargs)
530
531 def BestSize(*args, **kwargs):
532 """
533 BestSize(self, Size size) -> PaneInfo
534
535 BestSize sets the ideal size for the pane.
536
537 """
538 return _aui.PaneInfo_BestSize(*args, **kwargs)
539
540 def MinSize(*args, **kwargs):
541 """
542 MinSize(self, Size size) -> PaneInfo
543
544 MinSize sets the minimum size of the pane.
545
546 """
547 return _aui.PaneInfo_MinSize(*args, **kwargs)
548
549 def MaxSize(*args, **kwargs):
550 """
551 MaxSize(self, Size size) -> PaneInfo
552
553 MaxSize sets the maximum size of the pane.
554
555 """
556 return _aui.PaneInfo_MaxSize(*args, **kwargs)
557
558 def FloatingPosition(*args, **kwargs):
559 """
560 FloatingPosition(self, Point pos) -> PaneInfo
561
562 FloatingPosition sets the position of the floating pane.
563
564 """
565 return _aui.PaneInfo_FloatingPosition(*args, **kwargs)
566
567 def FloatingSize(*args, **kwargs):
568 """
569 FloatingSize(self, Size size) -> PaneInfo
570
571 FloatingSize sets the size of the floating pane.
572
573 """
574 return _aui.PaneInfo_FloatingSize(*args, **kwargs)
575
576 def Fixed(*args, **kwargs):
577 """
578 Fixed(self) -> PaneInfo
579
580 Fixed forces a pane to be fixed size so that it cannot be resized.
581
582 """
583 return _aui.PaneInfo_Fixed(*args, **kwargs)
584
585 def Resizable(*args, **kwargs):
586 """
587 Resizable(self, bool resizable=True) -> PaneInfo
588
589 Resized allows a pane to be resized if resizable is true, and forces
590 it to be a fixed size if resizeable is false.
591
592 """
593 return _aui.PaneInfo_Resizable(*args, **kwargs)
594
595 def Dock(*args, **kwargs):
596 """
597 Dock(self) -> PaneInfo
598
599 Dock indicates that a pane should be docked.
600
601 """
602 return _aui.PaneInfo_Dock(*args, **kwargs)
603
604 def Float(*args, **kwargs):
605 """
606 Float(self) -> PaneInfo
607
608 Float indicates that a pane should be floated.
609
610 """
611 return _aui.PaneInfo_Float(*args, **kwargs)
612
613 def Hide(*args, **kwargs):
614 """
615 Hide(self) -> PaneInfo
616
617 Hide indicates that a pane should be hidden.
618
619 """
620 return _aui.PaneInfo_Hide(*args, **kwargs)
621
622 def Show(*args, **kwargs):
623 """
624 Show(self, bool show=True) -> PaneInfo
625
626 Show indicates that a pane should be shown.
627
628 """
629 return _aui.PaneInfo_Show(*args, **kwargs)
630
631 def CaptionVisible(*args, **kwargs):
632 """
633 CaptionVisible(self, bool visible=True) -> PaneInfo
634
635 CaptionVisible indicates that a pane caption should be visible.
636
637 """
638 return _aui.PaneInfo_CaptionVisible(*args, **kwargs)
639
640 def PaneBorder(*args, **kwargs):
641 """
642 PaneBorder(self, bool visible=True) -> PaneInfo
643
644 PaneBorder indicates that a border should be drawn for the pane.
645
646 """
647 return _aui.PaneInfo_PaneBorder(*args, **kwargs)
648
649 def Gripper(*args, **kwargs):
650 """
651 Gripper(self, bool visible=True) -> PaneInfo
652
653 Gripper indicates that a gripper should be drawn for the pane..
654
655 """
656 return _aui.PaneInfo_Gripper(*args, **kwargs)
657
658 def GripperTop(*args, **kwargs):
659 """GripperTop(self, bool attop=True) -> PaneInfo"""
660 return _aui.PaneInfo_GripperTop(*args, **kwargs)
661
662 def CloseButton(*args, **kwargs):
663 """
664 CloseButton(self, bool visible=True) -> PaneInfo
665
666 CloseButton indicates that a close button should be drawn for the
667 pane.
668
669 """
670 return _aui.PaneInfo_CloseButton(*args, **kwargs)
671
672 def MaximizeButton(*args, **kwargs):
673 """
674 MaximizeButton(self, bool visible=True) -> PaneInfo
675
676 MaximizeButton indicates that a maximize button should be drawn for
677 the pane.
678
679 """
680 return _aui.PaneInfo_MaximizeButton(*args, **kwargs)
681
682 def MinimizeButton(*args, **kwargs):
683 """
684 MinimizeButton(self, bool visible=True) -> PaneInfo
685
686 MinimizeButton indicates that a minimize button should be drawn for
687 the pane.
688
689 """
690 return _aui.PaneInfo_MinimizeButton(*args, **kwargs)
691
692 def PinButton(*args, **kwargs):
693 """
694 PinButton(self, bool visible=True) -> PaneInfo
695
696 PinButton indicates that a pin button should be drawn for the pane.
697
698 """
699 return _aui.PaneInfo_PinButton(*args, **kwargs)
700
701 def DestroyOnClose(*args, **kwargs):
702 """
703 DestroyOnClose(self, bool b=True) -> PaneInfo
704
705 DestroyOnClose indicates whether a pane should be detroyed when it is
706 closed.
707
708 """
709 return _aui.PaneInfo_DestroyOnClose(*args, **kwargs)
710
711 def TopDockable(*args, **kwargs):
712 """
713 TopDockable(self, bool b=True) -> PaneInfo
714
715 TopDockable indicates whether a pane can be docked at the top of the
716 frame.
717
718 """
719 return _aui.PaneInfo_TopDockable(*args, **kwargs)
720
721 def BottomDockable(*args, **kwargs):
722 """
723 BottomDockable(self, bool b=True) -> PaneInfo
724
725 BottomDockable indicates whether a pane can be docked at the bottom of
726 the frame.
727
728 """
729 return _aui.PaneInfo_BottomDockable(*args, **kwargs)
730
731 def LeftDockable(*args, **kwargs):
732 """
733 LeftDockable(self, bool b=True) -> PaneInfo
734
735 LeftDockable indicates whether a pane can be docked on the left of the
736 frame.
737
738 """
739 return _aui.PaneInfo_LeftDockable(*args, **kwargs)
740
741 def RightDockable(*args, **kwargs):
742 """
743 RightDockable(self, bool b=True) -> PaneInfo
744
745 RightDockable indicates whether a pane can be docked on the right of
746 the frame.
747
748 """
749 return _aui.PaneInfo_RightDockable(*args, **kwargs)
750
751 def Floatable(*args, **kwargs):
752 """
753 Floatable(self, bool b=True) -> PaneInfo
754
755 Floatable indicates whether a frame can be floated.
756
757 """
758 return _aui.PaneInfo_Floatable(*args, **kwargs)
759
760 def Movable(*args, **kwargs):
761 """
762 Movable(self, bool b=True) -> PaneInfo
763
764 Movable indicates whether a frame can be moved.
765
766 """
767 return _aui.PaneInfo_Movable(*args, **kwargs)
768
769 def Dockable(*args, **kwargs):
770 """
771 Dockable(self, bool b=True) -> PaneInfo
772
773 Dockable indicates whether a pane can be docked at any position of the
774 frame.
775
776 """
777 return _aui.PaneInfo_Dockable(*args, **kwargs)
778
779 def DefaultPane(*args, **kwargs):
780 """
781 DefaultPane(self) -> PaneInfo
782
783 DefaultPane specifies that the pane should adopt the default pane
784 settings.
785
786 """
787 return _aui.PaneInfo_DefaultPane(*args, **kwargs)
788
789 def CentrePane(*args, **kwargs):
790 """
791 CentrePane(self) -> PaneInfo
792
793 CentrePane specifies that the pane should adopt the default center
794 pane settings.
795
796 """
797 return _aui.PaneInfo_CentrePane(*args, **kwargs)
798
799 def CenterPane(*args, **kwargs):
800 """
801 CenterPane(self) -> PaneInfo
802
803 CenterPane specifies that the pane should adopt the default center
804 pane settings.
805
806 """
807 return _aui.PaneInfo_CenterPane(*args, **kwargs)
808
809 def ToolbarPane(*args, **kwargs):
810 """
811 ToolbarPane(self) -> PaneInfo
812
813 ToolbarPane specifies that the pane should adopt the default toolbar
814 pane settings.
815
816 """
817 return _aui.PaneInfo_ToolbarPane(*args, **kwargs)
818
819 def SetFlag(*args, **kwargs):
820 """
821 SetFlag(self, int flag, bool option_state) -> PaneInfo
822
823 SetFlag turns the property given by flag on or off with the
824 option_state parameter.
825
826 """
827 return _aui.PaneInfo_SetFlag(*args, **kwargs)
828
829 def HasFlag(*args, **kwargs):
830 """
831 HasFlag(self, int flag) -> bool
832
833 HasFlag returns ``True`` if the the property specified by flag is
834 active for the pane.
835
836 """
837 return _aui.PaneInfo_HasFlag(*args, **kwargs)
838
839 optionFloating = _aui.PaneInfo_optionFloating
840 optionHidden = _aui.PaneInfo_optionHidden
841 optionLeftDockable = _aui.PaneInfo_optionLeftDockable
842 optionRightDockable = _aui.PaneInfo_optionRightDockable
843 optionTopDockable = _aui.PaneInfo_optionTopDockable
844 optionBottomDockable = _aui.PaneInfo_optionBottomDockable
845 optionFloatable = _aui.PaneInfo_optionFloatable
846 optionMovable = _aui.PaneInfo_optionMovable
847 optionResizable = _aui.PaneInfo_optionResizable
848 optionPaneBorder = _aui.PaneInfo_optionPaneBorder
849 optionCaption = _aui.PaneInfo_optionCaption
850 optionGripper = _aui.PaneInfo_optionGripper
851 optionDestroyOnClose = _aui.PaneInfo_optionDestroyOnClose
852 optionToolbar = _aui.PaneInfo_optionToolbar
853 optionActive = _aui.PaneInfo_optionActive
854 optionGripperTop = _aui.PaneInfo_optionGripperTop
855 buttonClose = _aui.PaneInfo_buttonClose
856 buttonMaximize = _aui.PaneInfo_buttonMaximize
857 buttonMinimize = _aui.PaneInfo_buttonMinimize
858 buttonPin = _aui.PaneInfo_buttonPin
859 buttonCustom1 = _aui.PaneInfo_buttonCustom1
860 buttonCustom2 = _aui.PaneInfo_buttonCustom2
861 buttonCustom3 = _aui.PaneInfo_buttonCustom3
862 actionPane = _aui.PaneInfo_actionPane
863 name = property(_aui.PaneInfo_name_get, _aui.PaneInfo_name_set)
864 caption = property(_aui.PaneInfo_caption_get, _aui.PaneInfo_caption_set)
865 window = property(_aui.PaneInfo_window_get, _aui.PaneInfo_window_set)
866 frame = property(_aui.PaneInfo_frame_get, _aui.PaneInfo_frame_set)
867 state = property(_aui.PaneInfo_state_get, _aui.PaneInfo_state_set)
868 dock_direction = property(_aui.PaneInfo_dock_direction_get, _aui.PaneInfo_dock_direction_set)
869 dock_layer = property(_aui.PaneInfo_dock_layer_get, _aui.PaneInfo_dock_layer_set)
870 dock_row = property(_aui.PaneInfo_dock_row_get, _aui.PaneInfo_dock_row_set)
871 dock_pos = property(_aui.PaneInfo_dock_pos_get, _aui.PaneInfo_dock_pos_set)
872 best_size = property(_aui.PaneInfo_best_size_get, _aui.PaneInfo_best_size_set)
873 min_size = property(_aui.PaneInfo_min_size_get, _aui.PaneInfo_min_size_set)
874 max_size = property(_aui.PaneInfo_max_size_get, _aui.PaneInfo_max_size_set)
875 floating_pos = property(_aui.PaneInfo_floating_pos_get, _aui.PaneInfo_floating_pos_set)
876 floating_size = property(_aui.PaneInfo_floating_size_get, _aui.PaneInfo_floating_size_set)
877 dock_proportion = property(_aui.PaneInfo_dock_proportion_get, _aui.PaneInfo_dock_proportion_set)
878 buttons = property(_aui.PaneInfo_buttons_get, _aui.PaneInfo_buttons_set)
879 rect = property(_aui.PaneInfo_rect_get, _aui.PaneInfo_rect_set)
880 _aui.PaneInfo_swigregister(PaneInfo)
881 cvar = _aui.cvar
882
883 class FrameManager(_core.EvtHandler):
884 """
885 FrameManager manages the panes associated with it for a particular
886 `wx.Frame`, using a pane's `PaneInfo` information to determine each
887 pane's docking and floating behavior. FrameManager uses wxWidgets'
888 sizer mechanism to plan the layout of each frame. It uses a
889 replaceable `DockArt` class to do all drawing, so all drawing is
890 localized in one area, and may be customized depending on an
891 application's specific needs.
892
893 """
894 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
895 __repr__ = _swig_repr
896 def __init__(self, *args, **kwargs):
897 """
898 __init__(self, Window managed_wnd=None, int flags=AUI_MGR_DEFAULT) -> FrameManager
899
900 Constructor.
901
902 :param managed_wnd: Specifies the `wx.Window` which should be
903 managed. If not set in the call to this constructor then
904 `SetManagedWindow` should be called later.
905
906 :param flags: Specifies options which allow the frame management
907 behavior to be modified.
908
909 """
910 _aui.FrameManager_swiginit(self,_aui.new_FrameManager(*args, **kwargs))
911 __swig_destroy__ = _aui.delete_FrameManager
912 __del__ = lambda self : None;
913 def UnInit(*args, **kwargs):
914 """
915 UnInit(self)
916
917 UnInit uninitializes the framework and should be called before a
918 managed frame is destroyed. UnInit is usually called in the managed
919 window's destructor.
920
921 """
922 return _aui.FrameManager_UnInit(*args, **kwargs)
923
924 def SetFlags(*args, **kwargs):
925 """
926 SetFlags(self, int flags)
927
928 SetFlags is used to specify the FrameManager's behavioral
929 settings. The flags parameter is described in the docs for `__init__`
930
931 """
932 return _aui.FrameManager_SetFlags(*args, **kwargs)
933
934 def GetFlags(*args, **kwargs):
935 """
936 GetFlags(self) -> int
937
938 GetFlags returns the current FrameManager's flags.
939
940 """
941 return _aui.FrameManager_GetFlags(*args, **kwargs)
942
943 def SetManagedWindow(*args, **kwargs):
944 """
945 SetManagedWindow(self, Window managed_wnd)
946
947 SetManagedWindow is called to specify the window which is to be
948 managed by the FrameManager. It is normally a `wx.Frame` but it is
949 possible to also allow docking within any container window. This only
950 needs to be called if the window was not given to the manager in the
951 constructor.
952
953 """
954 return _aui.FrameManager_SetManagedWindow(*args, **kwargs)
955
956 def GetManagedWindow(*args, **kwargs):
957 """
958 GetManagedWindow(self) -> Window
959
960 GetManagedWindow returns the window currently being managed by the
961 FrameManager.
962
963 """
964 return _aui.FrameManager_GetManagedWindow(*args, **kwargs)
965
966 def SetArtProvider(*args, **kwargs):
967 """
968 SetArtProvider(self, DockArt art_provider)
969
970 SetArtProvider instructs FrameManager to use the art provider
971 specified for all drawing calls. This allows plugable look-and-feel
972 features. The previous art provider object, if any, will be destroyed
973 by FrameManager.
974
975 :note: If you wish to use a custom `DockArt` class to override drawing
976 or metrics then you shoudl derive your class from the `PyDockArt`
977 class, which has been instrumented for reflecting virtual calls to
978 Python methods.
979
980 """
981 return _aui.FrameManager_SetArtProvider(*args, **kwargs)
982
983 def GetArtProvider(*args, **kwargs):
984 """
985 GetArtProvider(self) -> DockArt
986
987 GetArtProvider returns the current art provider being used.
988
989 """
990 return _aui.FrameManager_GetArtProvider(*args, **kwargs)
991
992 def _GetPaneByWidget(*args, **kwargs):
993 """_GetPaneByWidget(self, Window window) -> PaneInfo"""
994 return _aui.FrameManager__GetPaneByWidget(*args, **kwargs)
995
996 def _GetPaneByName(*args, **kwargs):
997 """_GetPaneByName(self, String name) -> PaneInfo"""
998 return _aui.FrameManager__GetPaneByName(*args, **kwargs)
999
1000 def GetAllPanes(*args, **kwargs):
1001 """
1002 GetAllPanes(self) -> list
1003
1004 GetAllPanes returns a list of `PaneInfo` objects for all panes managed
1005 by the frame manager.
1006
1007 """
1008 return _aui.FrameManager_GetAllPanes(*args, **kwargs)
1009
1010 def _AddPane1(*args, **kwargs):
1011 """_AddPane1(self, Window window, PaneInfo pane_info) -> bool"""
1012 return _aui.FrameManager__AddPane1(*args, **kwargs)
1013
1014 def AddPaneAtPos(*args, **kwargs):
1015 """AddPaneAtPos(self, Window window, PaneInfo pane_info, Point drop_pos) -> bool"""
1016 return _aui.FrameManager_AddPaneAtPos(*args, **kwargs)
1017
1018 def _AddPane2(*args, **kwargs):
1019 """_AddPane2(self, Window window, int direction=LEFT, String caption=wxEmptyString) -> bool"""
1020 return _aui.FrameManager__AddPane2(*args, **kwargs)
1021
1022 def InsertPane(*args, **kwargs):
1023 """
1024 InsertPane(self, Window window, PaneInfo insert_location, int insert_level=AUI_INSERT_PANE) -> bool
1025
1026 InsertPane is used to insert either a previously unmanaged pane window
1027 into the frame manager, or to insert a currently managed pane
1028 somewhere else. InsertPane will push all panes, rows, or docks aside
1029 and insert the window into the position specified by
1030 ``insert_location``. Because ``insert_location`` can specify either a pane,
1031 dock row, or dock layer, the ``insert_level`` parameter is used to
1032 disambiguate this. The parameter ``insert_level`` can take a value of
1033 ``AUI_INSERT_PANE``, ``AUI_INSERT_ROW`` or ``AUI_INSERT_DOCK``.
1034
1035 """
1036 return _aui.FrameManager_InsertPane(*args, **kwargs)
1037
1038 def DetachPane(*args, **kwargs):
1039 """
1040 DetachPane(self, Window window) -> bool
1041
1042 DetachPane tells the FrameManager to stop managing the pane specified
1043 by window. The window, if in a floated frame, is reparented to the
1044 frame managed by FrameManager.
1045
1046 """
1047 return _aui.FrameManager_DetachPane(*args, **kwargs)
1048
1049 def SavePerspective(*args, **kwargs):
1050 """
1051 SavePerspective(self) -> String
1052
1053 SavePerspective saves the entire user interface layout into an encoded
1054 string, which can then be stored someplace by the application. When a
1055 perspective is restored using `LoadPerspective`, the entire user
1056 interface will return to the state it was when the perspective was
1057 saved.
1058
1059 """
1060 return _aui.FrameManager_SavePerspective(*args, **kwargs)
1061
1062 def LoadPerspective(*args, **kwargs):
1063 """
1064 LoadPerspective(self, String perspective, bool update=True) -> bool
1065
1066 LoadPerspective loads a saved perspective. If ``update`` is ``True``,
1067 `Update` is automatically invoked, thus realizing the saved
1068 perspective on screen.
1069
1070 """
1071 return _aui.FrameManager_LoadPerspective(*args, **kwargs)
1072
1073 def Update(*args, **kwargs):
1074 """
1075 Update(self)
1076
1077 Update shoudl be called called after any number of changes are made to
1078 any of the managed panes. Update must be invoked after `AddPane` or
1079 `InsertPane` are called in order to "realize" or "commit" the
1080 changes. In addition, any number of changes may be made to `PaneInfo`
1081 structures (retrieved with `GetPane` or `GetAllPanes`), but to realize
1082 the changes, Update must be called. This construction allows pane
1083 flicker to be avoided by updating the whole layout at one time.
1084
1085 """
1086 return _aui.FrameManager_Update(*args, **kwargs)
1087
1088 def DrawHintRect(*args, **kwargs):
1089 """DrawHintRect(self, Window pane_window, Point pt, Point offset)"""
1090 return _aui.FrameManager_DrawHintRect(*args, **kwargs)
1091
1092 def ShowHint(*args, **kwargs):
1093 """ShowHint(self, Rect rect)"""
1094 return _aui.FrameManager_ShowHint(*args, **kwargs)
1095
1096 def HideHint(*args, **kwargs):
1097 """HideHint(self)"""
1098 return _aui.FrameManager_HideHint(*args, **kwargs)
1099
1100 def OnRender(*args, **kwargs):
1101 """OnRender(self, FrameManagerEvent evt)"""
1102 return _aui.FrameManager_OnRender(*args, **kwargs)
1103
1104 def OnPaneButton(*args, **kwargs):
1105 """OnPaneButton(self, FrameManagerEvent evt)"""
1106 return _aui.FrameManager_OnPaneButton(*args, **kwargs)
1107
1108 def GetPane(self, item):
1109 """
1110 GetPane(self, window_or_info item) -> PaneInfo
1111
1112 GetPane is used to search for a `PaneInfo` object either by
1113 widget reference or by pane name, which acts as a unique id
1114 for a window pane. The returned `PaneInfo` object may then be
1115 modified to change a pane's look, state or position. After one
1116 or more modifications to the `PaneInfo`, `FrameManager.Update`
1117 should be called to realize the changes to the user interface.
1118
1119 If the lookup failed (meaning the pane could not be found in
1120 the manager) GetPane returns an empty `PaneInfo`, a condition
1121 which can be checked by calling `PaneInfo.IsOk`.
1122 """
1123 if isinstance(item, wx.Window):
1124 return self._GetPaneByWidget(item)
1125 else:
1126 return self._GetPaneByName(item)
1127
1128 def AddPane(self, window, info=None, caption=None):
1129 """
1130 AddPane(self, window, info=None, caption=None) -> bool
1131
1132 AddPane tells the frame manager to start managing a child
1133 window. There are two versions of this function. The first
1134 verison accepts a `PaneInfo` object for the ``info`` parameter
1135 and allows the full spectrum of pane parameter
1136 possibilities. (Say that 3 times fast!)
1137
1138 The second version is used for simpler user interfaces which
1139 do not require as much configuration. In this case the
1140 ``info`` parameter specifies the direction property of the
1141 pane info, and defaults to ``wx.LEFT``. The pane caption may
1142 also be specified as an extra parameter in this form.
1143 """
1144 if type(info) == PaneInfo:
1145 return self._AddPane1(window, info)
1146 else:
1147
1148 if info is None:
1149 info = wx.LEFT
1150 if caption is None:
1151 caption = ""
1152 return self._AddPane2(window, info, caption)
1153
1154 SetFrame = wx._deprecated(SetManagedWindow,
1155 "SetFrame is deprecated, use `SetManagedWindow` instead.")
1156 GetFrame = wx._deprecated(GetManagedWindow,
1157 "GetFrame is deprecated, use `GetManagedWindow` instead.")
1158
1159 _aui.FrameManager_swigregister(FrameManager)
1160
1161 class FrameManagerEvent(_core.Event):
1162 """Proxy of C++ FrameManagerEvent class"""
1163 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1164 __repr__ = _swig_repr
1165 def __init__(self, *args, **kwargs):
1166 """__init__(self, EventType type=wxEVT_NULL) -> FrameManagerEvent"""
1167 _aui.FrameManagerEvent_swiginit(self,_aui.new_FrameManagerEvent(*args, **kwargs))
1168 def Clone(*args, **kwargs):
1169 """Clone(self) -> Event"""
1170 return _aui.FrameManagerEvent_Clone(*args, **kwargs)
1171
1172 def SetPane(*args, **kwargs):
1173 """SetPane(self, PaneInfo p)"""
1174 return _aui.FrameManagerEvent_SetPane(*args, **kwargs)
1175
1176 def SetButton(*args, **kwargs):
1177 """SetButton(self, int b)"""
1178 return _aui.FrameManagerEvent_SetButton(*args, **kwargs)
1179
1180 def SetDC(*args, **kwargs):
1181 """SetDC(self, DC pdc)"""
1182 return _aui.FrameManagerEvent_SetDC(*args, **kwargs)
1183
1184 def GetPane(*args, **kwargs):
1185 """GetPane(self) -> PaneInfo"""
1186 return _aui.FrameManagerEvent_GetPane(*args, **kwargs)
1187
1188 def GetButton(*args, **kwargs):
1189 """GetButton(self) -> int"""
1190 return _aui.FrameManagerEvent_GetButton(*args, **kwargs)
1191
1192 def GetDC(*args, **kwargs):
1193 """GetDC(self) -> DC"""
1194 return _aui.FrameManagerEvent_GetDC(*args, **kwargs)
1195
1196 def Veto(*args, **kwargs):
1197 """Veto(self, bool veto=True)"""
1198 return _aui.FrameManagerEvent_Veto(*args, **kwargs)
1199
1200 def GetVeto(*args, **kwargs):
1201 """GetVeto(self) -> bool"""
1202 return _aui.FrameManagerEvent_GetVeto(*args, **kwargs)
1203
1204 def SetCanVeto(*args, **kwargs):
1205 """SetCanVeto(self, bool can_veto)"""
1206 return _aui.FrameManagerEvent_SetCanVeto(*args, **kwargs)
1207
1208 def CanVeto(*args, **kwargs):
1209 """CanVeto(self) -> bool"""
1210 return _aui.FrameManagerEvent_CanVeto(*args, **kwargs)
1211
1212 pane = property(_aui.FrameManagerEvent_pane_get, _aui.FrameManagerEvent_pane_set)
1213 button = property(_aui.FrameManagerEvent_button_get, _aui.FrameManagerEvent_button_set)
1214 veto_flag = property(_aui.FrameManagerEvent_veto_flag_get, _aui.FrameManagerEvent_veto_flag_set)
1215 canveto_flag = property(_aui.FrameManagerEvent_canveto_flag_get, _aui.FrameManagerEvent_canveto_flag_set)
1216 dc = property(_aui.FrameManagerEvent_dc_get, _aui.FrameManagerEvent_dc_set)
1217 _aui.FrameManagerEvent_swigregister(FrameManagerEvent)
1218
1219 class DockInfo(object):
1220 """Proxy of C++ DockInfo class"""
1221 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1222 __repr__ = _swig_repr
1223 def __init__(self, *args, **kwargs):
1224 """__init__(self) -> DockInfo"""
1225 _aui.DockInfo_swiginit(self,_aui.new_DockInfo(*args, **kwargs))
1226 def IsOk(*args, **kwargs):
1227 """IsOk(self) -> bool"""
1228 return _aui.DockInfo_IsOk(*args, **kwargs)
1229
1230 def IsHorizontal(*args, **kwargs):
1231 """IsHorizontal(self) -> bool"""
1232 return _aui.DockInfo_IsHorizontal(*args, **kwargs)
1233
1234 def IsVertical(*args, **kwargs):
1235 """IsVertical(self) -> bool"""
1236 return _aui.DockInfo_IsVertical(*args, **kwargs)
1237
1238 panes = property(_aui.DockInfo_panes_get, _aui.DockInfo_panes_set)
1239 rect = property(_aui.DockInfo_rect_get, _aui.DockInfo_rect_set)
1240 dock_direction = property(_aui.DockInfo_dock_direction_get, _aui.DockInfo_dock_direction_set)
1241 dock_layer = property(_aui.DockInfo_dock_layer_get, _aui.DockInfo_dock_layer_set)
1242 dock_row = property(_aui.DockInfo_dock_row_get, _aui.DockInfo_dock_row_set)
1243 size = property(_aui.DockInfo_size_get, _aui.DockInfo_size_set)
1244 min_size = property(_aui.DockInfo_min_size_get, _aui.DockInfo_min_size_set)
1245 resizable = property(_aui.DockInfo_resizable_get, _aui.DockInfo_resizable_set)
1246 toolbar = property(_aui.DockInfo_toolbar_get, _aui.DockInfo_toolbar_set)
1247 fixed = property(_aui.DockInfo_fixed_get, _aui.DockInfo_fixed_set)
1248 _aui.DockInfo_swigregister(DockInfo)
1249
1250 class DockUIPart(object):
1251 """Proxy of C++ DockUIPart class"""
1252 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1253 def __init__(self): raise AttributeError, "No constructor defined"
1254 __repr__ = _swig_repr
1255 typeCaption = _aui.DockUIPart_typeCaption
1256 typeGripper = _aui.DockUIPart_typeGripper
1257 typeDock = _aui.DockUIPart_typeDock
1258 typeDockSizer = _aui.DockUIPart_typeDockSizer
1259 typePane = _aui.DockUIPart_typePane
1260 typePaneSizer = _aui.DockUIPart_typePaneSizer
1261 typeBackground = _aui.DockUIPart_typeBackground
1262 typePaneBorder = _aui.DockUIPart_typePaneBorder
1263 typePaneButton = _aui.DockUIPart_typePaneButton
1264 type = property(_aui.DockUIPart_type_get, _aui.DockUIPart_type_set)
1265 orientation = property(_aui.DockUIPart_orientation_get, _aui.DockUIPart_orientation_set)
1266 dock = property(_aui.DockUIPart_dock_get, _aui.DockUIPart_dock_set)
1267 pane = property(_aui.DockUIPart_pane_get, _aui.DockUIPart_pane_set)
1268 button = property(_aui.DockUIPart_button_get, _aui.DockUIPart_button_set)
1269 cont_sizer = property(_aui.DockUIPart_cont_sizer_get, _aui.DockUIPart_cont_sizer_set)
1270 sizer_item = property(_aui.DockUIPart_sizer_item_get, _aui.DockUIPart_sizer_item_set)
1271 rect = property(_aui.DockUIPart_rect_get, _aui.DockUIPart_rect_set)
1272 _aui.DockUIPart_swigregister(DockUIPart)
1273
1274 class PaneButton(object):
1275 """Proxy of C++ PaneButton class"""
1276 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1277 def __init__(self): raise AttributeError, "No constructor defined"
1278 __repr__ = _swig_repr
1279 button_id = property(_aui.PaneButton_button_id_get, _aui.PaneButton_button_id_set)
1280 _aui.PaneButton_swigregister(PaneButton)
1281
1282 wxEVT_AUI_PANEBUTTON = _aui.wxEVT_AUI_PANEBUTTON
1283 wxEVT_AUI_PANECLOSE = _aui.wxEVT_AUI_PANECLOSE
1284 wxEVT_AUI_RENDER = _aui.wxEVT_AUI_RENDER
1285 EVT_AUI_PANEBUTTON = wx.PyEventBinder( wxEVT_AUI_PANEBUTTON )
1286 EVT_AUI_PANECLOSE = wx.PyEventBinder( wxEVT_AUI_PANECLOSE )
1287 EVT_AUI_RENDER = wx.PyEventBinder( wxEVT_AUI_RENDER )
1288
1289 class DockArt(object):
1290 """
1291 DockArt is an art provider class which does all of the drawing for
1292 `FrameManager`. This allows the library caller to customize or replace the
1293 dock art and drawing routines by deriving a new class from `PyDockArt`. The
1294 active dock art class can be set via `FrameManager.SetArtProvider`.
1295
1296 """
1297 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1298 def __init__(self): raise AttributeError, "No constructor defined"
1299 __repr__ = _swig_repr
1300 __swig_destroy__ = _aui.delete_DockArt
1301 __del__ = lambda self : None;
1302 def GetMetric(*args, **kwargs):
1303 """GetMetric(self, int id) -> int"""
1304 return _aui.DockArt_GetMetric(*args, **kwargs)
1305
1306 def SetMetric(*args, **kwargs):
1307 """SetMetric(self, int id, int new_val)"""
1308 return _aui.DockArt_SetMetric(*args, **kwargs)
1309
1310 def SetFont(*args, **kwargs):
1311 """SetFont(self, int id, Font font)"""
1312 return _aui.DockArt_SetFont(*args, **kwargs)
1313
1314 def GetFont(*args, **kwargs):
1315 """GetFont(self, int id) -> Font"""
1316 return _aui.DockArt_GetFont(*args, **kwargs)
1317
1318 def GetColour(*args, **kwargs):
1319 """GetColour(self, int id) -> Colour"""
1320 return _aui.DockArt_GetColour(*args, **kwargs)
1321
1322 def SetColour(*args, **kwargs):
1323 """SetColour(self, int id, wxColor colour)"""
1324 return _aui.DockArt_SetColour(*args, **kwargs)
1325
1326 def GetColor(*args, **kwargs):
1327 """GetColor(self, int id) -> Colour"""
1328 return _aui.DockArt_GetColor(*args, **kwargs)
1329
1330 def SetColor(*args, **kwargs):
1331 """SetColor(self, int id, Colour color)"""
1332 return _aui.DockArt_SetColor(*args, **kwargs)
1333
1334 def DrawSash(*args, **kwargs):
1335 """DrawSash(self, DC dc, int orientation, Rect rect)"""
1336 return _aui.DockArt_DrawSash(*args, **kwargs)
1337
1338 def DrawBackground(*args, **kwargs):
1339 """DrawBackground(self, DC dc, int orientation, Rect rect)"""
1340 return _aui.DockArt_DrawBackground(*args, **kwargs)
1341
1342 def DrawCaption(*args, **kwargs):
1343 """DrawCaption(self, DC dc, String text, Rect rect, PaneInfo pane)"""
1344 return _aui.DockArt_DrawCaption(*args, **kwargs)
1345
1346 def DrawGripper(*args, **kwargs):
1347 """DrawGripper(self, DC dc, Rect rect, PaneInfo pane)"""
1348 return _aui.DockArt_DrawGripper(*args, **kwargs)
1349
1350 def DrawBorder(*args, **kwargs):
1351 """DrawBorder(self, DC dc, Rect rect, PaneInfo pane)"""
1352 return _aui.DockArt_DrawBorder(*args, **kwargs)
1353
1354 def DrawPaneButton(*args, **kwargs):
1355 """DrawPaneButton(self, DC dc, int button, int button_state, Rect rect, PaneInfo pane)"""
1356 return _aui.DockArt_DrawPaneButton(*args, **kwargs)
1357
1358 _aui.DockArt_swigregister(DockArt)
1359
1360 class DefaultDockArt(DockArt):
1361 """
1362 DefaultDockArt is the type of art class constructed by default for the
1363 `FrameManager`.
1364 """
1365 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1366 __repr__ = _swig_repr
1367 def __init__(self, *args, **kwargs):
1368 """
1369 __init__(self) -> DefaultDockArt
1370
1371 DefaultDockArt is the type of art class constructed by default for the
1372 `FrameManager`.
1373 """
1374 _aui.DefaultDockArt_swiginit(self,_aui.new_DefaultDockArt(*args, **kwargs))
1375 _aui.DefaultDockArt_swigregister(DefaultDockArt)
1376
1377 class FloatingPane(_windows.MiniFrame):
1378 """Proxy of C++ FloatingPane class"""
1379 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1380 __repr__ = _swig_repr
1381 def __init__(self, *args, **kwargs):
1382 """
1383 __init__(self, Window parent, FrameManager owner_mgr, PaneInfo pane,
1384 int id=ID_ANY) -> FloatingPane
1385 """
1386 _aui.FloatingPane_swiginit(self,_aui.new_FloatingPane(*args, **kwargs))
1387 __swig_destroy__ = _aui.delete_FloatingPane
1388 __del__ = lambda self : None;
1389 def SetPaneWindow(*args, **kwargs):
1390 """SetPaneWindow(self, PaneInfo pane)"""
1391 return _aui.FloatingPane_SetPaneWindow(*args, **kwargs)
1392
1393 _aui.FloatingPane_swigregister(FloatingPane)
1394
1395 class PyDockArt(DefaultDockArt):
1396 """
1397 This version of the `DockArt` class has been instrumented to be
1398 subclassable in Python and to reflect all calls to the C++ base class
1399 methods to the Python methods implemented in the derived class.
1400 """
1401 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1402 def __init__(self): raise AttributeError, "No constructor defined"
1403 __repr__ = _swig_repr
1404 _aui.PyDockArt_swigregister(PyDockArt)
1405
1406
1407