]>
Commit | Line | Data |
---|---|---|
27e45892 RD |
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 | |
70d7cb34 RD |
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 | |
27e45892 RD |
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 | |
8f514ab4 RD |
197 | AUI_BUTTON_STATE_DISABLED = _aui.AUI_BUTTON_STATE_DISABLED |
198 | AUI_BUTTON_STATE_HIDDEN = _aui.AUI_BUTTON_STATE_HIDDEN | |
199 | AUI_BUTTON_CLOSE = _aui.AUI_BUTTON_CLOSE | |
200 | AUI_BUTTON_MAXIMIZE = _aui.AUI_BUTTON_MAXIMIZE | |
201 | AUI_BUTTON_MINIMIZE = _aui.AUI_BUTTON_MINIMIZE | |
202 | AUI_BUTTON_PIN = _aui.AUI_BUTTON_PIN | |
203 | AUI_BUTTON_OPTIONS = _aui.AUI_BUTTON_OPTIONS | |
204 | AUI_BUTTON_LEFT = _aui.AUI_BUTTON_LEFT | |
205 | AUI_BUTTON_RIGHT = _aui.AUI_BUTTON_RIGHT | |
206 | AUI_BUTTON_UP = _aui.AUI_BUTTON_UP | |
207 | AUI_BUTTON_DOWN = _aui.AUI_BUTTON_DOWN | |
208 | AUI_BUTTON_CUSTOM1 = _aui.AUI_BUTTON_CUSTOM1 | |
209 | AUI_BUTTON_CUSTOM2 = _aui.AUI_BUTTON_CUSTOM2 | |
210 | AUI_BUTTON_CUSTOM3 = _aui.AUI_BUTTON_CUSTOM3 | |
27e45892 RD |
211 | AUI_INSERT_PANE = _aui.AUI_INSERT_PANE |
212 | AUI_INSERT_ROW = _aui.AUI_INSERT_ROW | |
213 | AUI_INSERT_DOCK = _aui.AUI_INSERT_DOCK | |
214 | class PaneInfo(object): | |
215 | """ | |
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 | |
221 | parameters. | |
222 | ||
223 | """ | |
224 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
225 | __repr__ = _swig_repr | |
226 | def __init__(self, *args, **kwargs): | |
227 | """ | |
228 | __init__(self) -> PaneInfo | |
229 | ||
230 | PaneInfo specifies all the parameters for a pane for the | |
231 | `FrameManager`. These parameters specify where the pane is on the | |
232 | screen, whether it is docked or floating, or hidden. In addition, | |
233 | these parameters specify the pane's docked position, floating | |
234 | position, preferred size, minimum size, caption text among many other | |
235 | parameters. | |
236 | ||
237 | """ | |
238 | _aui.PaneInfo_swiginit(self,_aui.new_PaneInfo(*args, **kwargs)) | |
239 | __swig_destroy__ = _aui.delete_PaneInfo | |
240 | __del__ = lambda self : None; | |
0f83f5da RD |
241 | def SafeSet(*args, **kwargs): |
242 | """SafeSet(self, PaneInfo source)""" | |
243 | return _aui.PaneInfo_SafeSet(*args, **kwargs) | |
244 | ||
27e45892 RD |
245 | def IsOk(*args, **kwargs): |
246 | """ | |
247 | IsOk(self) -> bool | |
248 | ||
249 | IsOk returns ``True`` if the PaneInfo structure is valid. | |
250 | ||
251 | """ | |
252 | return _aui.PaneInfo_IsOk(*args, **kwargs) | |
253 | ||
254 | def IsFixed(*args, **kwargs): | |
255 | """ | |
256 | IsFixed(self) -> bool | |
257 | ||
258 | IsFixed returns ``True`` if the pane cannot be resized. | |
259 | ||
260 | """ | |
261 | return _aui.PaneInfo_IsFixed(*args, **kwargs) | |
262 | ||
263 | def IsResizable(*args, **kwargs): | |
264 | """ | |
265 | IsResizable(self) -> bool | |
266 | ||
267 | IsResizeable returns ``True`` if the pane can be resized. | |
268 | ||
269 | """ | |
270 | return _aui.PaneInfo_IsResizable(*args, **kwargs) | |
271 | ||
272 | def IsShown(*args, **kwargs): | |
273 | """ | |
274 | IsShown(self) -> bool | |
275 | ||
276 | IsShown returns ``True`` if the pane should be drawn on the screen. | |
277 | ||
278 | """ | |
279 | return _aui.PaneInfo_IsShown(*args, **kwargs) | |
280 | ||
281 | def IsFloating(*args, **kwargs): | |
282 | """ | |
283 | IsFloating(self) -> bool | |
284 | ||
285 | IsFloating returns ``True`` if the pane is floating. | |
286 | ||
287 | """ | |
288 | return _aui.PaneInfo_IsFloating(*args, **kwargs) | |
289 | ||
290 | def IsDocked(*args, **kwargs): | |
291 | """ | |
292 | IsDocked(self) -> bool | |
293 | ||
294 | IsDocked returns ``True`` if the pane is docked. | |
295 | ||
296 | """ | |
297 | return _aui.PaneInfo_IsDocked(*args, **kwargs) | |
298 | ||
299 | def IsToolbar(*args, **kwargs): | |
300 | """ | |
301 | IsToolbar(self) -> bool | |
302 | ||
303 | IsToolbar returns ``True`` if the pane contains a toolbar. | |
304 | ||
305 | """ | |
306 | return _aui.PaneInfo_IsToolbar(*args, **kwargs) | |
307 | ||
308 | def IsTopDockable(*args, **kwargs): | |
309 | """ | |
310 | IsTopDockable(self) -> bool | |
311 | ||
312 | IsTopDockable returns ``True`` if the pane can be docked at the top of | |
313 | the managed frame. | |
314 | ||
315 | """ | |
316 | return _aui.PaneInfo_IsTopDockable(*args, **kwargs) | |
317 | ||
318 | def IsBottomDockable(*args, **kwargs): | |
319 | """ | |
320 | IsBottomDockable(self) -> bool | |
321 | ||
322 | IsBottomDockable returns ``True`` if the pane can be docked at the | |
323 | bottom of the managed frame. | |
324 | ||
325 | """ | |
326 | return _aui.PaneInfo_IsBottomDockable(*args, **kwargs) | |
327 | ||
328 | def IsLeftDockable(*args, **kwargs): | |
329 | """ | |
330 | IsLeftDockable(self) -> bool | |
331 | ||
332 | IsLeftDockable returns ``True`` if the pane can be docked on the left | |
333 | of the managed frame. | |
334 | ||
335 | """ | |
336 | return _aui.PaneInfo_IsLeftDockable(*args, **kwargs) | |
337 | ||
338 | def IsRightDockable(*args, **kwargs): | |
339 | """ | |
340 | IsRightDockable(self) -> bool | |
341 | ||
342 | IsRightDockable returns ``True`` if the pane can be docked on the | |
343 | right of the managed frame. | |
344 | ||
345 | """ | |
346 | return _aui.PaneInfo_IsRightDockable(*args, **kwargs) | |
347 | ||
348 | def IsFloatable(*args, **kwargs): | |
349 | """ | |
350 | IsFloatable(self) -> bool | |
351 | ||
352 | IsFloatable returns ``True`` if the pane can be undocked and displayed | |
353 | as a floating window. | |
354 | ||
355 | """ | |
356 | return _aui.PaneInfo_IsFloatable(*args, **kwargs) | |
357 | ||
358 | def IsMovable(*args, **kwargs): | |
359 | """ | |
360 | IsMovable(self) -> bool | |
361 | ||
362 | IsMoveable returns ``True`` if the docked frame can be undocked or moved | |
363 | to another dock position. | |
364 | ||
365 | """ | |
366 | return _aui.PaneInfo_IsMovable(*args, **kwargs) | |
367 | ||
9b940138 RD |
368 | def IsDestroyOnClose(*args, **kwargs): |
369 | """IsDestroyOnClose(self) -> bool""" | |
370 | return _aui.PaneInfo_IsDestroyOnClose(*args, **kwargs) | |
371 | ||
27e45892 RD |
372 | def HasCaption(*args, **kwargs): |
373 | """ | |
374 | HasCaption(self) -> bool | |
375 | ||
376 | HasCaption returns ``True`` if the pane displays a caption. | |
377 | ||
378 | """ | |
379 | return _aui.PaneInfo_HasCaption(*args, **kwargs) | |
380 | ||
381 | def HasGripper(*args, **kwargs): | |
382 | """ | |
383 | HasGripper(self) -> bool | |
384 | ||
385 | HasGripper returns ``True`` if the pane displays a gripper. | |
386 | ||
387 | """ | |
388 | return _aui.PaneInfo_HasGripper(*args, **kwargs) | |
389 | ||
390 | def HasBorder(*args, **kwargs): | |
391 | """ | |
392 | HasBorder(self) -> bool | |
393 | ||
394 | HasBorder returns ``True`` if the pane displays a border. | |
395 | ||
396 | """ | |
397 | return _aui.PaneInfo_HasBorder(*args, **kwargs) | |
398 | ||
399 | def HasCloseButton(*args, **kwargs): | |
400 | """ | |
401 | HasCloseButton(self) -> bool | |
402 | ||
403 | HasCloseButton returns ``True`` if the pane displays a button to close | |
404 | the pane. | |
405 | ||
406 | """ | |
407 | return _aui.PaneInfo_HasCloseButton(*args, **kwargs) | |
408 | ||
409 | def HasMaximizeButton(*args, **kwargs): | |
410 | """ | |
411 | HasMaximizeButton(self) -> bool | |
412 | ||
413 | HasMaximizeButton returns ``True`` if the pane displays a button to | |
414 | maximize the pane. | |
415 | ||
416 | """ | |
417 | return _aui.PaneInfo_HasMaximizeButton(*args, **kwargs) | |
418 | ||
419 | def HasMinimizeButton(*args, **kwargs): | |
420 | """ | |
421 | HasMinimizeButton(self) -> bool | |
422 | ||
423 | HasMinimizeButton returns ``True`` if the pane displays a button to | |
424 | minimize the pane. | |
425 | ||
426 | """ | |
427 | return _aui.PaneInfo_HasMinimizeButton(*args, **kwargs) | |
428 | ||
429 | def HasPinButton(*args, **kwargs): | |
430 | """ | |
431 | HasPinButton(self) -> bool | |
432 | ||
433 | HasPinButton returns ``True`` if the pane displays a button to float | |
434 | the pane. | |
435 | ||
436 | """ | |
437 | return _aui.PaneInfo_HasPinButton(*args, **kwargs) | |
438 | ||
439 | def HasGripperTop(*args, **kwargs): | |
440 | """HasGripperTop(self) -> bool""" | |
441 | return _aui.PaneInfo_HasGripperTop(*args, **kwargs) | |
442 | ||
443 | def Window(*args, **kwargs): | |
444 | """Window(self, Window w) -> PaneInfo""" | |
445 | return _aui.PaneInfo_Window(*args, **kwargs) | |
446 | ||
447 | def Name(*args, **kwargs): | |
448 | """ | |
449 | Name(self, String n) -> PaneInfo | |
450 | ||
451 | Name sets the name of the pane so it can be referenced in lookup | |
452 | functions. | |
453 | ||
454 | """ | |
455 | return _aui.PaneInfo_Name(*args, **kwargs) | |
456 | ||
457 | def Caption(*args, **kwargs): | |
458 | """ | |
459 | Caption(self, String c) -> PaneInfo | |
460 | ||
461 | Caption sets the caption of the pane. | |
462 | ||
463 | """ | |
464 | return _aui.PaneInfo_Caption(*args, **kwargs) | |
465 | ||
466 | def Left(*args, **kwargs): | |
467 | """ | |
468 | Left(self) -> PaneInfo | |
469 | ||
470 | Left sets the pane dock position to the left side of the frame. | |
471 | ||
472 | """ | |
473 | return _aui.PaneInfo_Left(*args, **kwargs) | |
474 | ||
475 | def Right(*args, **kwargs): | |
476 | """ | |
477 | Right(self) -> PaneInfo | |
478 | ||
479 | Right sets the pane dock position to the right side of the frame. | |
480 | ||
481 | """ | |
482 | return _aui.PaneInfo_Right(*args, **kwargs) | |
483 | ||
484 | def Top(*args, **kwargs): | |
485 | """ | |
486 | Top(self) -> PaneInfo | |
487 | ||
488 | Top sets the pane dock position to the top of the frame. | |
489 | ||
490 | """ | |
491 | return _aui.PaneInfo_Top(*args, **kwargs) | |
492 | ||
493 | def Bottom(*args, **kwargs): | |
494 | """ | |
495 | Bottom(self) -> PaneInfo | |
496 | ||
497 | Bottom sets the pane dock position to the bottom of the frame. | |
498 | ||
499 | """ | |
500 | return _aui.PaneInfo_Bottom(*args, **kwargs) | |
501 | ||
502 | def Center(*args, **kwargs): | |
503 | """ | |
504 | Center(self) -> PaneInfo | |
505 | ||
506 | Center sets the pane to the center position of the frame. | |
507 | ||
508 | """ | |
509 | return _aui.PaneInfo_Center(*args, **kwargs) | |
510 | ||
511 | def Centre(*args, **kwargs): | |
512 | """ | |
513 | Centre(self) -> PaneInfo | |
514 | ||
515 | Centre sets the pane to the center position of the frame. | |
516 | ||
517 | """ | |
518 | return _aui.PaneInfo_Centre(*args, **kwargs) | |
519 | ||
520 | def Direction(*args, **kwargs): | |
521 | """ | |
522 | Direction(self, int direction) -> PaneInfo | |
523 | ||
524 | Direction determines the direction of the docked pane. | |
525 | ||
526 | """ | |
527 | return _aui.PaneInfo_Direction(*args, **kwargs) | |
528 | ||
529 | def Layer(*args, **kwargs): | |
530 | """ | |
531 | Layer(self, int layer) -> PaneInfo | |
532 | ||
533 | Layer determines the layer of the docked pane. | |
534 | ||
535 | """ | |
536 | return _aui.PaneInfo_Layer(*args, **kwargs) | |
537 | ||
538 | def Row(*args, **kwargs): | |
539 | """ | |
540 | Row(self, int row) -> PaneInfo | |
541 | ||
542 | Row determines the row of the docked pane. | |
543 | ||
544 | """ | |
545 | return _aui.PaneInfo_Row(*args, **kwargs) | |
546 | ||
547 | def Position(*args, **kwargs): | |
548 | """ | |
549 | Position(self, int pos) -> PaneInfo | |
550 | ||
551 | Position determines the position of the docked pane. | |
552 | ||
553 | """ | |
554 | return _aui.PaneInfo_Position(*args, **kwargs) | |
555 | ||
556 | def BestSize(*args, **kwargs): | |
557 | """ | |
558 | BestSize(self, Size size) -> PaneInfo | |
559 | ||
560 | BestSize sets the ideal size for the pane. | |
561 | ||
562 | """ | |
563 | return _aui.PaneInfo_BestSize(*args, **kwargs) | |
564 | ||
565 | def MinSize(*args, **kwargs): | |
566 | """ | |
567 | MinSize(self, Size size) -> PaneInfo | |
568 | ||
569 | MinSize sets the minimum size of the pane. | |
570 | ||
571 | """ | |
572 | return _aui.PaneInfo_MinSize(*args, **kwargs) | |
573 | ||
574 | def MaxSize(*args, **kwargs): | |
575 | """ | |
576 | MaxSize(self, Size size) -> PaneInfo | |
577 | ||
578 | MaxSize sets the maximum size of the pane. | |
579 | ||
580 | """ | |
581 | return _aui.PaneInfo_MaxSize(*args, **kwargs) | |
582 | ||
583 | def FloatingPosition(*args, **kwargs): | |
584 | """ | |
585 | FloatingPosition(self, Point pos) -> PaneInfo | |
586 | ||
587 | FloatingPosition sets the position of the floating pane. | |
588 | ||
589 | """ | |
590 | return _aui.PaneInfo_FloatingPosition(*args, **kwargs) | |
591 | ||
592 | def FloatingSize(*args, **kwargs): | |
593 | """ | |
594 | FloatingSize(self, Size size) -> PaneInfo | |
595 | ||
596 | FloatingSize sets the size of the floating pane. | |
597 | ||
598 | """ | |
599 | return _aui.PaneInfo_FloatingSize(*args, **kwargs) | |
600 | ||
601 | def Fixed(*args, **kwargs): | |
602 | """ | |
603 | Fixed(self) -> PaneInfo | |
604 | ||
605 | Fixed forces a pane to be fixed size so that it cannot be resized. | |
606 | ||
607 | """ | |
608 | return _aui.PaneInfo_Fixed(*args, **kwargs) | |
609 | ||
610 | def Resizable(*args, **kwargs): | |
611 | """ | |
612 | Resizable(self, bool resizable=True) -> PaneInfo | |
613 | ||
614 | Resized allows a pane to be resized if resizable is true, and forces | |
615 | it to be a fixed size if resizeable is false. | |
616 | ||
617 | """ | |
618 | return _aui.PaneInfo_Resizable(*args, **kwargs) | |
619 | ||
620 | def Dock(*args, **kwargs): | |
621 | """ | |
622 | Dock(self) -> PaneInfo | |
623 | ||
624 | Dock indicates that a pane should be docked. | |
625 | ||
626 | """ | |
627 | return _aui.PaneInfo_Dock(*args, **kwargs) | |
628 | ||
629 | def Float(*args, **kwargs): | |
630 | """ | |
631 | Float(self) -> PaneInfo | |
632 | ||
633 | Float indicates that a pane should be floated. | |
634 | ||
635 | """ | |
636 | return _aui.PaneInfo_Float(*args, **kwargs) | |
637 | ||
638 | def Hide(*args, **kwargs): | |
639 | """ | |
640 | Hide(self) -> PaneInfo | |
641 | ||
642 | Hide indicates that a pane should be hidden. | |
643 | ||
644 | """ | |
645 | return _aui.PaneInfo_Hide(*args, **kwargs) | |
646 | ||
647 | def Show(*args, **kwargs): | |
648 | """ | |
649 | Show(self, bool show=True) -> PaneInfo | |
650 | ||
651 | Show indicates that a pane should be shown. | |
652 | ||
653 | """ | |
654 | return _aui.PaneInfo_Show(*args, **kwargs) | |
655 | ||
656 | def CaptionVisible(*args, **kwargs): | |
657 | """ | |
658 | CaptionVisible(self, bool visible=True) -> PaneInfo | |
659 | ||
660 | CaptionVisible indicates that a pane caption should be visible. | |
661 | ||
662 | """ | |
663 | return _aui.PaneInfo_CaptionVisible(*args, **kwargs) | |
664 | ||
665 | def PaneBorder(*args, **kwargs): | |
666 | """ | |
667 | PaneBorder(self, bool visible=True) -> PaneInfo | |
668 | ||
669 | PaneBorder indicates that a border should be drawn for the pane. | |
670 | ||
671 | """ | |
672 | return _aui.PaneInfo_PaneBorder(*args, **kwargs) | |
673 | ||
674 | def Gripper(*args, **kwargs): | |
675 | """ | |
676 | Gripper(self, bool visible=True) -> PaneInfo | |
677 | ||
678 | Gripper indicates that a gripper should be drawn for the pane.. | |
679 | ||
680 | """ | |
681 | return _aui.PaneInfo_Gripper(*args, **kwargs) | |
682 | ||
683 | def GripperTop(*args, **kwargs): | |
684 | """GripperTop(self, bool attop=True) -> PaneInfo""" | |
685 | return _aui.PaneInfo_GripperTop(*args, **kwargs) | |
686 | ||
687 | def CloseButton(*args, **kwargs): | |
688 | """ | |
689 | CloseButton(self, bool visible=True) -> PaneInfo | |
690 | ||
691 | CloseButton indicates that a close button should be drawn for the | |
692 | pane. | |
693 | ||
694 | """ | |
695 | return _aui.PaneInfo_CloseButton(*args, **kwargs) | |
696 | ||
697 | def MaximizeButton(*args, **kwargs): | |
698 | """ | |
699 | MaximizeButton(self, bool visible=True) -> PaneInfo | |
700 | ||
701 | MaximizeButton indicates that a maximize button should be drawn for | |
702 | the pane. | |
703 | ||
704 | """ | |
705 | return _aui.PaneInfo_MaximizeButton(*args, **kwargs) | |
706 | ||
707 | def MinimizeButton(*args, **kwargs): | |
708 | """ | |
709 | MinimizeButton(self, bool visible=True) -> PaneInfo | |
710 | ||
711 | MinimizeButton indicates that a minimize button should be drawn for | |
712 | the pane. | |
713 | ||
714 | """ | |
715 | return _aui.PaneInfo_MinimizeButton(*args, **kwargs) | |
716 | ||
717 | def PinButton(*args, **kwargs): | |
718 | """ | |
719 | PinButton(self, bool visible=True) -> PaneInfo | |
720 | ||
721 | PinButton indicates that a pin button should be drawn for the pane. | |
722 | ||
723 | """ | |
724 | return _aui.PaneInfo_PinButton(*args, **kwargs) | |
725 | ||
726 | def DestroyOnClose(*args, **kwargs): | |
727 | """ | |
728 | DestroyOnClose(self, bool b=True) -> PaneInfo | |
729 | ||
730 | DestroyOnClose indicates whether a pane should be detroyed when it is | |
731 | closed. | |
732 | ||
733 | """ | |
734 | return _aui.PaneInfo_DestroyOnClose(*args, **kwargs) | |
735 | ||
736 | def TopDockable(*args, **kwargs): | |
737 | """ | |
738 | TopDockable(self, bool b=True) -> PaneInfo | |
739 | ||
740 | TopDockable indicates whether a pane can be docked at the top of the | |
741 | frame. | |
742 | ||
743 | """ | |
744 | return _aui.PaneInfo_TopDockable(*args, **kwargs) | |
745 | ||
746 | def BottomDockable(*args, **kwargs): | |
747 | """ | |
748 | BottomDockable(self, bool b=True) -> PaneInfo | |
749 | ||
750 | BottomDockable indicates whether a pane can be docked at the bottom of | |
751 | the frame. | |
752 | ||
753 | """ | |
754 | return _aui.PaneInfo_BottomDockable(*args, **kwargs) | |
755 | ||
756 | def LeftDockable(*args, **kwargs): | |
757 | """ | |
758 | LeftDockable(self, bool b=True) -> PaneInfo | |
759 | ||
760 | LeftDockable indicates whether a pane can be docked on the left of the | |
761 | frame. | |
762 | ||
763 | """ | |
764 | return _aui.PaneInfo_LeftDockable(*args, **kwargs) | |
765 | ||
766 | def RightDockable(*args, **kwargs): | |
767 | """ | |
768 | RightDockable(self, bool b=True) -> PaneInfo | |
769 | ||
770 | RightDockable indicates whether a pane can be docked on the right of | |
771 | the frame. | |
772 | ||
773 | """ | |
774 | return _aui.PaneInfo_RightDockable(*args, **kwargs) | |
775 | ||
776 | def Floatable(*args, **kwargs): | |
777 | """ | |
778 | Floatable(self, bool b=True) -> PaneInfo | |
779 | ||
780 | Floatable indicates whether a frame can be floated. | |
781 | ||
782 | """ | |
783 | return _aui.PaneInfo_Floatable(*args, **kwargs) | |
784 | ||
785 | def Movable(*args, **kwargs): | |
786 | """ | |
787 | Movable(self, bool b=True) -> PaneInfo | |
788 | ||
789 | Movable indicates whether a frame can be moved. | |
790 | ||
791 | """ | |
792 | return _aui.PaneInfo_Movable(*args, **kwargs) | |
793 | ||
794 | def Dockable(*args, **kwargs): | |
795 | """ | |
796 | Dockable(self, bool b=True) -> PaneInfo | |
797 | ||
798 | Dockable indicates whether a pane can be docked at any position of the | |
799 | frame. | |
800 | ||
801 | """ | |
802 | return _aui.PaneInfo_Dockable(*args, **kwargs) | |
803 | ||
804 | def DefaultPane(*args, **kwargs): | |
805 | """ | |
806 | DefaultPane(self) -> PaneInfo | |
807 | ||
808 | DefaultPane specifies that the pane should adopt the default pane | |
809 | settings. | |
810 | ||
811 | """ | |
812 | return _aui.PaneInfo_DefaultPane(*args, **kwargs) | |
813 | ||
814 | def CentrePane(*args, **kwargs): | |
815 | """ | |
816 | CentrePane(self) -> PaneInfo | |
817 | ||
818 | CentrePane specifies that the pane should adopt the default center | |
819 | pane settings. | |
820 | ||
821 | """ | |
822 | return _aui.PaneInfo_CentrePane(*args, **kwargs) | |
823 | ||
824 | def CenterPane(*args, **kwargs): | |
825 | """ | |
826 | CenterPane(self) -> PaneInfo | |
827 | ||
828 | CenterPane specifies that the pane should adopt the default center | |
829 | pane settings. | |
830 | ||
831 | """ | |
832 | return _aui.PaneInfo_CenterPane(*args, **kwargs) | |
833 | ||
834 | def ToolbarPane(*args, **kwargs): | |
835 | """ | |
836 | ToolbarPane(self) -> PaneInfo | |
837 | ||
838 | ToolbarPane specifies that the pane should adopt the default toolbar | |
839 | pane settings. | |
840 | ||
841 | """ | |
842 | return _aui.PaneInfo_ToolbarPane(*args, **kwargs) | |
843 | ||
844 | def SetFlag(*args, **kwargs): | |
845 | """ | |
846 | SetFlag(self, int flag, bool option_state) -> PaneInfo | |
847 | ||
848 | SetFlag turns the property given by flag on or off with the | |
849 | option_state parameter. | |
850 | ||
851 | """ | |
852 | return _aui.PaneInfo_SetFlag(*args, **kwargs) | |
853 | ||
854 | def HasFlag(*args, **kwargs): | |
855 | """ | |
856 | HasFlag(self, int flag) -> bool | |
857 | ||
858 | HasFlag returns ``True`` if the the property specified by flag is | |
859 | active for the pane. | |
860 | ||
861 | """ | |
862 | return _aui.PaneInfo_HasFlag(*args, **kwargs) | |
863 | ||
864 | optionFloating = _aui.PaneInfo_optionFloating | |
865 | optionHidden = _aui.PaneInfo_optionHidden | |
866 | optionLeftDockable = _aui.PaneInfo_optionLeftDockable | |
867 | optionRightDockable = _aui.PaneInfo_optionRightDockable | |
868 | optionTopDockable = _aui.PaneInfo_optionTopDockable | |
869 | optionBottomDockable = _aui.PaneInfo_optionBottomDockable | |
870 | optionFloatable = _aui.PaneInfo_optionFloatable | |
871 | optionMovable = _aui.PaneInfo_optionMovable | |
872 | optionResizable = _aui.PaneInfo_optionResizable | |
873 | optionPaneBorder = _aui.PaneInfo_optionPaneBorder | |
874 | optionCaption = _aui.PaneInfo_optionCaption | |
875 | optionGripper = _aui.PaneInfo_optionGripper | |
876 | optionDestroyOnClose = _aui.PaneInfo_optionDestroyOnClose | |
877 | optionToolbar = _aui.PaneInfo_optionToolbar | |
878 | optionActive = _aui.PaneInfo_optionActive | |
879 | optionGripperTop = _aui.PaneInfo_optionGripperTop | |
880 | buttonClose = _aui.PaneInfo_buttonClose | |
881 | buttonMaximize = _aui.PaneInfo_buttonMaximize | |
882 | buttonMinimize = _aui.PaneInfo_buttonMinimize | |
883 | buttonPin = _aui.PaneInfo_buttonPin | |
884 | buttonCustom1 = _aui.PaneInfo_buttonCustom1 | |
885 | buttonCustom2 = _aui.PaneInfo_buttonCustom2 | |
886 | buttonCustom3 = _aui.PaneInfo_buttonCustom3 | |
887 | actionPane = _aui.PaneInfo_actionPane | |
888 | name = property(_aui.PaneInfo_name_get, _aui.PaneInfo_name_set) | |
889 | caption = property(_aui.PaneInfo_caption_get, _aui.PaneInfo_caption_set) | |
890 | window = property(_aui.PaneInfo_window_get, _aui.PaneInfo_window_set) | |
891 | frame = property(_aui.PaneInfo_frame_get, _aui.PaneInfo_frame_set) | |
892 | state = property(_aui.PaneInfo_state_get, _aui.PaneInfo_state_set) | |
893 | dock_direction = property(_aui.PaneInfo_dock_direction_get, _aui.PaneInfo_dock_direction_set) | |
894 | dock_layer = property(_aui.PaneInfo_dock_layer_get, _aui.PaneInfo_dock_layer_set) | |
895 | dock_row = property(_aui.PaneInfo_dock_row_get, _aui.PaneInfo_dock_row_set) | |
896 | dock_pos = property(_aui.PaneInfo_dock_pos_get, _aui.PaneInfo_dock_pos_set) | |
897 | best_size = property(_aui.PaneInfo_best_size_get, _aui.PaneInfo_best_size_set) | |
898 | min_size = property(_aui.PaneInfo_min_size_get, _aui.PaneInfo_min_size_set) | |
899 | max_size = property(_aui.PaneInfo_max_size_get, _aui.PaneInfo_max_size_set) | |
900 | floating_pos = property(_aui.PaneInfo_floating_pos_get, _aui.PaneInfo_floating_pos_set) | |
901 | floating_size = property(_aui.PaneInfo_floating_size_get, _aui.PaneInfo_floating_size_set) | |
902 | dock_proportion = property(_aui.PaneInfo_dock_proportion_get, _aui.PaneInfo_dock_proportion_set) | |
903 | buttons = property(_aui.PaneInfo_buttons_get, _aui.PaneInfo_buttons_set) | |
904 | rect = property(_aui.PaneInfo_rect_get, _aui.PaneInfo_rect_set) | |
905 | _aui.PaneInfo_swigregister(PaneInfo) | |
906 | cvar = _aui.cvar | |
907 | ||
908 | class FrameManager(_core.EvtHandler): | |
909 | """ | |
910 | FrameManager manages the panes associated with it for a particular | |
911 | `wx.Frame`, using a pane's `PaneInfo` information to determine each | |
912 | pane's docking and floating behavior. FrameManager uses wxWidgets' | |
913 | sizer mechanism to plan the layout of each frame. It uses a | |
914 | replaceable `DockArt` class to do all drawing, so all drawing is | |
915 | localized in one area, and may be customized depending on an | |
916 | application's specific needs. | |
917 | ||
918 | """ | |
919 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
920 | __repr__ = _swig_repr | |
921 | def __init__(self, *args, **kwargs): | |
922 | """ | |
10044bf1 | 923 | __init__(self, Window managed_wnd=None, int flags=AUI_MGR_DEFAULT) -> FrameManager |
27e45892 RD |
924 | |
925 | Constructor. | |
926 | ||
10044bf1 RD |
927 | :param managed_wnd: Specifies the `wx.Window` which should be |
928 | managed. If not set in the call to this constructor then | |
929 | `SetManagedWindow` should be called later. | |
27e45892 RD |
930 | |
931 | :param flags: Specifies options which allow the frame management | |
932 | behavior to be modified. | |
933 | ||
934 | """ | |
935 | _aui.FrameManager_swiginit(self,_aui.new_FrameManager(*args, **kwargs)) | |
936 | __swig_destroy__ = _aui.delete_FrameManager | |
937 | __del__ = lambda self : None; | |
938 | def UnInit(*args, **kwargs): | |
939 | """ | |
940 | UnInit(self) | |
941 | ||
942 | UnInit uninitializes the framework and should be called before a | |
943 | managed frame is destroyed. UnInit is usually called in the managed | |
10044bf1 | 944 | window's destructor. |
27e45892 RD |
945 | |
946 | """ | |
947 | return _aui.FrameManager_UnInit(*args, **kwargs) | |
948 | ||
949 | def SetFlags(*args, **kwargs): | |
950 | """ | |
951 | SetFlags(self, int flags) | |
952 | ||
953 | SetFlags is used to specify the FrameManager's behavioral | |
954 | settings. The flags parameter is described in the docs for `__init__` | |
955 | ||
956 | """ | |
957 | return _aui.FrameManager_SetFlags(*args, **kwargs) | |
958 | ||
959 | def GetFlags(*args, **kwargs): | |
960 | """ | |
961 | GetFlags(self) -> int | |
962 | ||
963 | GetFlags returns the current FrameManager's flags. | |
964 | ||
965 | """ | |
966 | return _aui.FrameManager_GetFlags(*args, **kwargs) | |
967 | ||
10044bf1 | 968 | def SetManagedWindow(*args, **kwargs): |
27e45892 | 969 | """ |
10044bf1 | 970 | SetManagedWindow(self, Window managed_wnd) |
27e45892 | 971 | |
10044bf1 RD |
972 | SetManagedWindow is called to specify the window which is to be |
973 | managed by the FrameManager. It is normally a `wx.Frame` but it is | |
974 | possible to also allow docking within any container window. This only | |
975 | needs to be called if the window was not given to the manager in the | |
976 | constructor. | |
27e45892 RD |
977 | |
978 | """ | |
10044bf1 | 979 | return _aui.FrameManager_SetManagedWindow(*args, **kwargs) |
27e45892 | 980 | |
10044bf1 | 981 | def GetManagedWindow(*args, **kwargs): |
27e45892 | 982 | """ |
10044bf1 | 983 | GetManagedWindow(self) -> Window |
27e45892 | 984 | |
10044bf1 | 985 | GetManagedWindow returns the window currently being managed by the |
27e45892 RD |
986 | FrameManager. |
987 | ||
988 | """ | |
10044bf1 | 989 | return _aui.FrameManager_GetManagedWindow(*args, **kwargs) |
27e45892 RD |
990 | |
991 | def SetArtProvider(*args, **kwargs): | |
992 | """ | |
993 | SetArtProvider(self, DockArt art_provider) | |
994 | ||
995 | SetArtProvider instructs FrameManager to use the art provider | |
996 | specified for all drawing calls. This allows plugable look-and-feel | |
997 | features. The previous art provider object, if any, will be destroyed | |
998 | by FrameManager. | |
999 | ||
1000 | :note: If you wish to use a custom `DockArt` class to override drawing | |
1001 | or metrics then you shoudl derive your class from the `PyDockArt` | |
1002 | class, which has been instrumented for reflecting virtual calls to | |
1003 | Python methods. | |
1004 | ||
1005 | """ | |
1006 | return _aui.FrameManager_SetArtProvider(*args, **kwargs) | |
1007 | ||
1008 | def GetArtProvider(*args, **kwargs): | |
1009 | """ | |
1010 | GetArtProvider(self) -> DockArt | |
1011 | ||
1012 | GetArtProvider returns the current art provider being used. | |
1013 | ||
1014 | """ | |
1015 | return _aui.FrameManager_GetArtProvider(*args, **kwargs) | |
1016 | ||
1017 | def _GetPaneByWidget(*args, **kwargs): | |
1018 | """_GetPaneByWidget(self, Window window) -> PaneInfo""" | |
1019 | return _aui.FrameManager__GetPaneByWidget(*args, **kwargs) | |
1020 | ||
1021 | def _GetPaneByName(*args, **kwargs): | |
1022 | """_GetPaneByName(self, String name) -> PaneInfo""" | |
1023 | return _aui.FrameManager__GetPaneByName(*args, **kwargs) | |
1024 | ||
1025 | def GetAllPanes(*args, **kwargs): | |
1026 | """ | |
1027 | GetAllPanes(self) -> list | |
1028 | ||
1029 | GetAllPanes returns a list of `PaneInfo` objects for all panes managed | |
1030 | by the frame manager. | |
1031 | ||
1032 | """ | |
1033 | return _aui.FrameManager_GetAllPanes(*args, **kwargs) | |
1034 | ||
1035 | def _AddPane1(*args, **kwargs): | |
1036 | """_AddPane1(self, Window window, PaneInfo pane_info) -> bool""" | |
1037 | return _aui.FrameManager__AddPane1(*args, **kwargs) | |
1038 | ||
10044bf1 RD |
1039 | def AddPaneAtPos(*args, **kwargs): |
1040 | """AddPaneAtPos(self, Window window, PaneInfo pane_info, Point drop_pos) -> bool""" | |
1041 | return _aui.FrameManager_AddPaneAtPos(*args, **kwargs) | |
1042 | ||
27e45892 RD |
1043 | def _AddPane2(*args, **kwargs): |
1044 | """_AddPane2(self, Window window, int direction=LEFT, String caption=wxEmptyString) -> bool""" | |
1045 | return _aui.FrameManager__AddPane2(*args, **kwargs) | |
1046 | ||
1047 | def InsertPane(*args, **kwargs): | |
1048 | """ | |
1049 | InsertPane(self, Window window, PaneInfo insert_location, int insert_level=AUI_INSERT_PANE) -> bool | |
1050 | ||
1051 | InsertPane is used to insert either a previously unmanaged pane window | |
1052 | into the frame manager, or to insert a currently managed pane | |
1053 | somewhere else. InsertPane will push all panes, rows, or docks aside | |
1054 | and insert the window into the position specified by | |
1055 | ``insert_location``. Because ``insert_location`` can specify either a pane, | |
1056 | dock row, or dock layer, the ``insert_level`` parameter is used to | |
1057 | disambiguate this. The parameter ``insert_level`` can take a value of | |
1058 | ``AUI_INSERT_PANE``, ``AUI_INSERT_ROW`` or ``AUI_INSERT_DOCK``. | |
1059 | ||
1060 | """ | |
1061 | return _aui.FrameManager_InsertPane(*args, **kwargs) | |
1062 | ||
1063 | def DetachPane(*args, **kwargs): | |
1064 | """ | |
1065 | DetachPane(self, Window window) -> bool | |
1066 | ||
1067 | DetachPane tells the FrameManager to stop managing the pane specified | |
1068 | by window. The window, if in a floated frame, is reparented to the | |
1069 | frame managed by FrameManager. | |
1070 | ||
1071 | """ | |
1072 | return _aui.FrameManager_DetachPane(*args, **kwargs) | |
1073 | ||
9b940138 RD |
1074 | def ClosePane(*args, **kwargs): |
1075 | """ClosePane(self, PaneInfo pane_info)""" | |
1076 | return _aui.FrameManager_ClosePane(*args, **kwargs) | |
1077 | ||
0f83f5da RD |
1078 | def SavePaneInfo(*args, **kwargs): |
1079 | """SavePaneInfo(self, PaneInfo pane) -> String""" | |
1080 | return _aui.FrameManager_SavePaneInfo(*args, **kwargs) | |
1081 | ||
1082 | def LoadPaneInfo(*args, **kwargs): | |
1083 | """LoadPaneInfo(self, String pane_part, PaneInfo pane)""" | |
1084 | return _aui.FrameManager_LoadPaneInfo(*args, **kwargs) | |
1085 | ||
27e45892 RD |
1086 | def SavePerspective(*args, **kwargs): |
1087 | """ | |
1088 | SavePerspective(self) -> String | |
1089 | ||
1090 | SavePerspective saves the entire user interface layout into an encoded | |
1091 | string, which can then be stored someplace by the application. When a | |
1092 | perspective is restored using `LoadPerspective`, the entire user | |
1093 | interface will return to the state it was when the perspective was | |
1094 | saved. | |
1095 | ||
1096 | """ | |
1097 | return _aui.FrameManager_SavePerspective(*args, **kwargs) | |
1098 | ||
1099 | def LoadPerspective(*args, **kwargs): | |
1100 | """ | |
1101 | LoadPerspective(self, String perspective, bool update=True) -> bool | |
1102 | ||
1103 | LoadPerspective loads a saved perspective. If ``update`` is ``True``, | |
1104 | `Update` is automatically invoked, thus realizing the saved | |
1105 | perspective on screen. | |
1106 | ||
1107 | """ | |
1108 | return _aui.FrameManager_LoadPerspective(*args, **kwargs) | |
1109 | ||
1110 | def Update(*args, **kwargs): | |
1111 | """ | |
1112 | Update(self) | |
1113 | ||
1114 | Update shoudl be called called after any number of changes are made to | |
1115 | any of the managed panes. Update must be invoked after `AddPane` or | |
1116 | `InsertPane` are called in order to "realize" or "commit" the | |
1117 | changes. In addition, any number of changes may be made to `PaneInfo` | |
1118 | structures (retrieved with `GetPane` or `GetAllPanes`), but to realize | |
1119 | the changes, Update must be called. This construction allows pane | |
1120 | flicker to be avoided by updating the whole layout at one time. | |
1121 | ||
1122 | """ | |
1123 | return _aui.FrameManager_Update(*args, **kwargs) | |
1124 | ||
9b940138 RD |
1125 | def CreateFloatingFrame(*args, **kwargs): |
1126 | """CreateFloatingFrame(self, Window parent, PaneInfo p) -> FloatingPane""" | |
1127 | return _aui.FrameManager_CreateFloatingFrame(*args, **kwargs) | |
1128 | ||
10044bf1 RD |
1129 | def DrawHintRect(*args, **kwargs): |
1130 | """DrawHintRect(self, Window pane_window, Point pt, Point offset)""" | |
1131 | return _aui.FrameManager_DrawHintRect(*args, **kwargs) | |
1132 | ||
1133 | def ShowHint(*args, **kwargs): | |
1134 | """ShowHint(self, Rect rect)""" | |
1135 | return _aui.FrameManager_ShowHint(*args, **kwargs) | |
1136 | ||
1137 | def HideHint(*args, **kwargs): | |
1138 | """HideHint(self)""" | |
1139 | return _aui.FrameManager_HideHint(*args, **kwargs) | |
1140 | ||
81f5836b RD |
1141 | def OnRender(*args, **kwargs): |
1142 | """OnRender(self, FrameManagerEvent evt)""" | |
1143 | return _aui.FrameManager_OnRender(*args, **kwargs) | |
1144 | ||
1145 | def OnPaneButton(*args, **kwargs): | |
1146 | """OnPaneButton(self, FrameManagerEvent evt)""" | |
1147 | return _aui.FrameManager_OnPaneButton(*args, **kwargs) | |
1148 | ||
27e45892 RD |
1149 | def GetPane(self, item): |
1150 | """ | |
1151 | GetPane(self, window_or_info item) -> PaneInfo | |
1152 | ||
1153 | GetPane is used to search for a `PaneInfo` object either by | |
1154 | widget reference or by pane name, which acts as a unique id | |
1155 | for a window pane. The returned `PaneInfo` object may then be | |
1156 | modified to change a pane's look, state or position. After one | |
1157 | or more modifications to the `PaneInfo`, `FrameManager.Update` | |
1158 | should be called to realize the changes to the user interface. | |
1159 | ||
1160 | If the lookup failed (meaning the pane could not be found in | |
1161 | the manager) GetPane returns an empty `PaneInfo`, a condition | |
1162 | which can be checked by calling `PaneInfo.IsOk`. | |
1163 | """ | |
1164 | if isinstance(item, wx.Window): | |
1165 | return self._GetPaneByWidget(item) | |
1166 | else: | |
1167 | return self._GetPaneByName(item) | |
1168 | ||
1169 | def AddPane(self, window, info=None, caption=None): | |
1170 | """ | |
1171 | AddPane(self, window, info=None, caption=None) -> bool | |
1172 | ||
1173 | AddPane tells the frame manager to start managing a child | |
1174 | window. There are two versions of this function. The first | |
1175 | verison accepts a `PaneInfo` object for the ``info`` parameter | |
1176 | and allows the full spectrum of pane parameter | |
1177 | possibilities. (Say that 3 times fast!) | |
1178 | ||
1179 | The second version is used for simpler user interfaces which | |
1180 | do not require as much configuration. In this case the | |
1181 | ``info`` parameter specifies the direction property of the | |
1182 | pane info, and defaults to ``wx.LEFT``. The pane caption may | |
1183 | also be specified as an extra parameter in this form. | |
1184 | """ | |
1185 | if type(info) == PaneInfo: | |
1186 | return self._AddPane1(window, info) | |
1187 | else: | |
1188 | ||
1189 | if info is None: | |
1190 | info = wx.LEFT | |
1191 | if caption is None: | |
1192 | caption = "" | |
1193 | return self._AddPane2(window, info, caption) | |
1194 | ||
10044bf1 RD |
1195 | SetFrame = wx._deprecated(SetManagedWindow, |
1196 | "SetFrame is deprecated, use `SetManagedWindow` instead.") | |
1197 | GetFrame = wx._deprecated(GetManagedWindow, | |
1198 | "GetFrame is deprecated, use `GetManagedWindow` instead.") | |
1199 | ||
777e547f RD |
1200 | AllPanes = property(GetAllPanes,doc="See `GetAllPanes`") |
1201 | ArtProvider = property(GetArtProvider,SetArtProvider,doc="See `GetArtProvider` and `SetArtProvider`") | |
1202 | Flags = property(GetFlags,SetFlags,doc="See `GetFlags` and `SetFlags`") | |
1203 | ManagedWindow = property(GetManagedWindow,SetManagedWindow,doc="See `GetManagedWindow` and `SetManagedWindow`") | |
27e45892 RD |
1204 | _aui.FrameManager_swigregister(FrameManager) |
1205 | ||
1206 | class FrameManagerEvent(_core.Event): | |
1207 | """Proxy of C++ FrameManagerEvent class""" | |
1208 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1209 | __repr__ = _swig_repr | |
1210 | def __init__(self, *args, **kwargs): | |
1211 | """__init__(self, EventType type=wxEVT_NULL) -> FrameManagerEvent""" | |
1212 | _aui.FrameManagerEvent_swiginit(self,_aui.new_FrameManagerEvent(*args, **kwargs)) | |
1213 | def Clone(*args, **kwargs): | |
1214 | """Clone(self) -> Event""" | |
1215 | return _aui.FrameManagerEvent_Clone(*args, **kwargs) | |
1216 | ||
1217 | def SetPane(*args, **kwargs): | |
1218 | """SetPane(self, PaneInfo p)""" | |
1219 | return _aui.FrameManagerEvent_SetPane(*args, **kwargs) | |
1220 | ||
1221 | def SetButton(*args, **kwargs): | |
1222 | """SetButton(self, int b)""" | |
1223 | return _aui.FrameManagerEvent_SetButton(*args, **kwargs) | |
1224 | ||
81f5836b RD |
1225 | def SetDC(*args, **kwargs): |
1226 | """SetDC(self, DC pdc)""" | |
1227 | return _aui.FrameManagerEvent_SetDC(*args, **kwargs) | |
1228 | ||
27e45892 RD |
1229 | def GetPane(*args, **kwargs): |
1230 | """GetPane(self) -> PaneInfo""" | |
1231 | return _aui.FrameManagerEvent_GetPane(*args, **kwargs) | |
1232 | ||
1233 | def GetButton(*args, **kwargs): | |
1234 | """GetButton(self) -> int""" | |
1235 | return _aui.FrameManagerEvent_GetButton(*args, **kwargs) | |
1236 | ||
81f5836b RD |
1237 | def GetDC(*args, **kwargs): |
1238 | """GetDC(self) -> DC""" | |
1239 | return _aui.FrameManagerEvent_GetDC(*args, **kwargs) | |
1240 | ||
27e45892 RD |
1241 | def Veto(*args, **kwargs): |
1242 | """Veto(self, bool veto=True)""" | |
1243 | return _aui.FrameManagerEvent_Veto(*args, **kwargs) | |
1244 | ||
1245 | def GetVeto(*args, **kwargs): | |
1246 | """GetVeto(self) -> bool""" | |
1247 | return _aui.FrameManagerEvent_GetVeto(*args, **kwargs) | |
1248 | ||
1249 | def SetCanVeto(*args, **kwargs): | |
1250 | """SetCanVeto(self, bool can_veto)""" | |
1251 | return _aui.FrameManagerEvent_SetCanVeto(*args, **kwargs) | |
1252 | ||
1253 | def CanVeto(*args, **kwargs): | |
1254 | """CanVeto(self) -> bool""" | |
1255 | return _aui.FrameManagerEvent_CanVeto(*args, **kwargs) | |
1256 | ||
1257 | pane = property(_aui.FrameManagerEvent_pane_get, _aui.FrameManagerEvent_pane_set) | |
1258 | button = property(_aui.FrameManagerEvent_button_get, _aui.FrameManagerEvent_button_set) | |
1259 | veto_flag = property(_aui.FrameManagerEvent_veto_flag_get, _aui.FrameManagerEvent_veto_flag_set) | |
1260 | canveto_flag = property(_aui.FrameManagerEvent_canveto_flag_get, _aui.FrameManagerEvent_canveto_flag_set) | |
81f5836b | 1261 | dc = property(_aui.FrameManagerEvent_dc_get, _aui.FrameManagerEvent_dc_set) |
777e547f RD |
1262 | Button = property(GetButton,SetButton,doc="See `GetButton` and `SetButton`") |
1263 | DC = property(GetDC,SetDC,doc="See `GetDC` and `SetDC`") | |
1264 | Pane = property(GetPane,SetPane,doc="See `GetPane` and `SetPane`") | |
27e45892 RD |
1265 | _aui.FrameManagerEvent_swigregister(FrameManagerEvent) |
1266 | ||
1267 | class DockInfo(object): | |
1268 | """Proxy of C++ DockInfo class""" | |
1269 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1270 | __repr__ = _swig_repr | |
1271 | def __init__(self, *args, **kwargs): | |
1272 | """__init__(self) -> DockInfo""" | |
1273 | _aui.DockInfo_swiginit(self,_aui.new_DockInfo(*args, **kwargs)) | |
1274 | def IsOk(*args, **kwargs): | |
1275 | """IsOk(self) -> bool""" | |
1276 | return _aui.DockInfo_IsOk(*args, **kwargs) | |
1277 | ||
1278 | def IsHorizontal(*args, **kwargs): | |
1279 | """IsHorizontal(self) -> bool""" | |
1280 | return _aui.DockInfo_IsHorizontal(*args, **kwargs) | |
1281 | ||
1282 | def IsVertical(*args, **kwargs): | |
1283 | """IsVertical(self) -> bool""" | |
1284 | return _aui.DockInfo_IsVertical(*args, **kwargs) | |
1285 | ||
1286 | panes = property(_aui.DockInfo_panes_get, _aui.DockInfo_panes_set) | |
1287 | rect = property(_aui.DockInfo_rect_get, _aui.DockInfo_rect_set) | |
1288 | dock_direction = property(_aui.DockInfo_dock_direction_get, _aui.DockInfo_dock_direction_set) | |
1289 | dock_layer = property(_aui.DockInfo_dock_layer_get, _aui.DockInfo_dock_layer_set) | |
1290 | dock_row = property(_aui.DockInfo_dock_row_get, _aui.DockInfo_dock_row_set) | |
1291 | size = property(_aui.DockInfo_size_get, _aui.DockInfo_size_set) | |
1292 | min_size = property(_aui.DockInfo_min_size_get, _aui.DockInfo_min_size_set) | |
1293 | resizable = property(_aui.DockInfo_resizable_get, _aui.DockInfo_resizable_set) | |
1294 | toolbar = property(_aui.DockInfo_toolbar_get, _aui.DockInfo_toolbar_set) | |
1295 | fixed = property(_aui.DockInfo_fixed_get, _aui.DockInfo_fixed_set) | |
72ef6efb RD |
1296 | __swig_destroy__ = _aui.delete_DockInfo |
1297 | __del__ = lambda self : None; | |
27e45892 RD |
1298 | _aui.DockInfo_swigregister(DockInfo) |
1299 | ||
1300 | class DockUIPart(object): | |
1301 | """Proxy of C++ DockUIPart class""" | |
1302 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1303 | def __init__(self): raise AttributeError, "No constructor defined" | |
1304 | __repr__ = _swig_repr | |
1305 | typeCaption = _aui.DockUIPart_typeCaption | |
1306 | typeGripper = _aui.DockUIPart_typeGripper | |
1307 | typeDock = _aui.DockUIPart_typeDock | |
1308 | typeDockSizer = _aui.DockUIPart_typeDockSizer | |
1309 | typePane = _aui.DockUIPart_typePane | |
1310 | typePaneSizer = _aui.DockUIPart_typePaneSizer | |
1311 | typeBackground = _aui.DockUIPart_typeBackground | |
1312 | typePaneBorder = _aui.DockUIPart_typePaneBorder | |
1313 | typePaneButton = _aui.DockUIPart_typePaneButton | |
1314 | type = property(_aui.DockUIPart_type_get, _aui.DockUIPart_type_set) | |
1315 | orientation = property(_aui.DockUIPart_orientation_get, _aui.DockUIPart_orientation_set) | |
1316 | dock = property(_aui.DockUIPart_dock_get, _aui.DockUIPart_dock_set) | |
1317 | pane = property(_aui.DockUIPart_pane_get, _aui.DockUIPart_pane_set) | |
1318 | button = property(_aui.DockUIPart_button_get, _aui.DockUIPart_button_set) | |
1319 | cont_sizer = property(_aui.DockUIPart_cont_sizer_get, _aui.DockUIPart_cont_sizer_set) | |
1320 | sizer_item = property(_aui.DockUIPart_sizer_item_get, _aui.DockUIPart_sizer_item_set) | |
1321 | rect = property(_aui.DockUIPart_rect_get, _aui.DockUIPart_rect_set) | |
72ef6efb RD |
1322 | __swig_destroy__ = _aui.delete_DockUIPart |
1323 | __del__ = lambda self : None; | |
27e45892 RD |
1324 | _aui.DockUIPart_swigregister(DockUIPart) |
1325 | ||
1326 | class PaneButton(object): | |
1327 | """Proxy of C++ PaneButton class""" | |
1328 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1329 | def __init__(self): raise AttributeError, "No constructor defined" | |
1330 | __repr__ = _swig_repr | |
1331 | button_id = property(_aui.PaneButton_button_id_get, _aui.PaneButton_button_id_set) | |
72ef6efb RD |
1332 | __swig_destroy__ = _aui.delete_PaneButton |
1333 | __del__ = lambda self : None; | |
27e45892 RD |
1334 | _aui.PaneButton_swigregister(PaneButton) |
1335 | ||
1336 | wxEVT_AUI_PANEBUTTON = _aui.wxEVT_AUI_PANEBUTTON | |
1337 | wxEVT_AUI_PANECLOSE = _aui.wxEVT_AUI_PANECLOSE | |
81f5836b | 1338 | wxEVT_AUI_RENDER = _aui.wxEVT_AUI_RENDER |
27e45892 RD |
1339 | EVT_AUI_PANEBUTTON = wx.PyEventBinder( wxEVT_AUI_PANEBUTTON ) |
1340 | EVT_AUI_PANECLOSE = wx.PyEventBinder( wxEVT_AUI_PANECLOSE ) | |
81f5836b | 1341 | EVT_AUI_RENDER = wx.PyEventBinder( wxEVT_AUI_RENDER ) |
27e45892 RD |
1342 | |
1343 | class DockArt(object): | |
1344 | """ | |
1345 | DockArt is an art provider class which does all of the drawing for | |
1346 | `FrameManager`. This allows the library caller to customize or replace the | |
1347 | dock art and drawing routines by deriving a new class from `PyDockArt`. The | |
1348 | active dock art class can be set via `FrameManager.SetArtProvider`. | |
1349 | ||
1350 | """ | |
1351 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1352 | def __init__(self): raise AttributeError, "No constructor defined" | |
1353 | __repr__ = _swig_repr | |
1354 | __swig_destroy__ = _aui.delete_DockArt | |
1355 | __del__ = lambda self : None; | |
1356 | def GetMetric(*args, **kwargs): | |
1357 | """GetMetric(self, int id) -> int""" | |
1358 | return _aui.DockArt_GetMetric(*args, **kwargs) | |
1359 | ||
1360 | def SetMetric(*args, **kwargs): | |
1361 | """SetMetric(self, int id, int new_val)""" | |
1362 | return _aui.DockArt_SetMetric(*args, **kwargs) | |
1363 | ||
1364 | def SetFont(*args, **kwargs): | |
1365 | """SetFont(self, int id, Font font)""" | |
1366 | return _aui.DockArt_SetFont(*args, **kwargs) | |
1367 | ||
1368 | def GetFont(*args, **kwargs): | |
1369 | """GetFont(self, int id) -> Font""" | |
1370 | return _aui.DockArt_GetFont(*args, **kwargs) | |
1371 | ||
1372 | def GetColour(*args, **kwargs): | |
1373 | """GetColour(self, int id) -> Colour""" | |
1374 | return _aui.DockArt_GetColour(*args, **kwargs) | |
1375 | ||
1376 | def SetColour(*args, **kwargs): | |
1377 | """SetColour(self, int id, wxColor colour)""" | |
1378 | return _aui.DockArt_SetColour(*args, **kwargs) | |
1379 | ||
1380 | def GetColor(*args, **kwargs): | |
1381 | """GetColor(self, int id) -> Colour""" | |
1382 | return _aui.DockArt_GetColor(*args, **kwargs) | |
1383 | ||
1384 | def SetColor(*args, **kwargs): | |
1385 | """SetColor(self, int id, Colour color)""" | |
1386 | return _aui.DockArt_SetColor(*args, **kwargs) | |
1387 | ||
1388 | def DrawSash(*args, **kwargs): | |
97ab0f6a | 1389 | """DrawSash(self, DC dc, Window window, int orientation, Rect rect)""" |
27e45892 RD |
1390 | return _aui.DockArt_DrawSash(*args, **kwargs) |
1391 | ||
1392 | def DrawBackground(*args, **kwargs): | |
97ab0f6a | 1393 | """DrawBackground(self, DC dc, Window window, int orientation, Rect rect)""" |
27e45892 RD |
1394 | return _aui.DockArt_DrawBackground(*args, **kwargs) |
1395 | ||
1396 | def DrawCaption(*args, **kwargs): | |
97ab0f6a | 1397 | """DrawCaption(self, DC dc, Window window, String text, Rect rect, PaneInfo pane)""" |
27e45892 RD |
1398 | return _aui.DockArt_DrawCaption(*args, **kwargs) |
1399 | ||
1400 | def DrawGripper(*args, **kwargs): | |
97ab0f6a | 1401 | """DrawGripper(self, DC dc, Window window, Rect rect, PaneInfo pane)""" |
27e45892 RD |
1402 | return _aui.DockArt_DrawGripper(*args, **kwargs) |
1403 | ||
1404 | def DrawBorder(*args, **kwargs): | |
97ab0f6a | 1405 | """DrawBorder(self, DC dc, Window window, Rect rect, PaneInfo pane)""" |
27e45892 RD |
1406 | return _aui.DockArt_DrawBorder(*args, **kwargs) |
1407 | ||
1408 | def DrawPaneButton(*args, **kwargs): | |
97ab0f6a RD |
1409 | """ |
1410 | DrawPaneButton(self, DC dc, Window window, int button, int button_state, | |
1411 | Rect rect, PaneInfo pane) | |
1412 | """ | |
27e45892 RD |
1413 | return _aui.DockArt_DrawPaneButton(*args, **kwargs) |
1414 | ||
1415 | _aui.DockArt_swigregister(DockArt) | |
1416 | ||
1417 | class DefaultDockArt(DockArt): | |
1418 | """ | |
1419 | DefaultDockArt is the type of art class constructed by default for the | |
1420 | `FrameManager`. | |
1421 | """ | |
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): | |
1425 | """ | |
1426 | __init__(self) -> DefaultDockArt | |
1427 | ||
1428 | DefaultDockArt is the type of art class constructed by default for the | |
1429 | `FrameManager`. | |
1430 | """ | |
1431 | _aui.DefaultDockArt_swiginit(self,_aui.new_DefaultDockArt(*args, **kwargs)) | |
1432 | _aui.DefaultDockArt_swigregister(DefaultDockArt) | |
1433 | ||
1434 | class FloatingPane(_windows.MiniFrame): | |
1435 | """Proxy of C++ FloatingPane class""" | |
1436 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1437 | __repr__ = _swig_repr | |
1438 | def __init__(self, *args, **kwargs): | |
1439 | """ | |
1440 | __init__(self, Window parent, FrameManager owner_mgr, PaneInfo pane, | |
9b940138 | 1441 | int id=ID_ANY, long style=wxRESIZE_BORDER|wxSYSTEM_MENU|wxCAPTION|wxFRAME_NO_TASKBAR|wxFRAME_FLOAT_ON_PARENT|wxCLIP_CHILDREN) -> FloatingPane |
27e45892 RD |
1442 | """ |
1443 | _aui.FloatingPane_swiginit(self,_aui.new_FloatingPane(*args, **kwargs)) | |
1444 | __swig_destroy__ = _aui.delete_FloatingPane | |
1445 | __del__ = lambda self : None; | |
1446 | def SetPaneWindow(*args, **kwargs): | |
1447 | """SetPaneWindow(self, PaneInfo pane)""" | |
1448 | return _aui.FloatingPane_SetPaneWindow(*args, **kwargs) | |
1449 | ||
1450 | _aui.FloatingPane_swigregister(FloatingPane) | |
1451 | ||
5c8c7dd3 RD |
1452 | class TabArt(object): |
1453 | """Proxy of C++ TabArt class""" | |
1454 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1455 | def __init__(self): raise AttributeError, "No constructor defined" | |
1456 | __repr__ = _swig_repr | |
1457 | __swig_destroy__ = _aui.delete_TabArt | |
1458 | __del__ = lambda self : None; | |
8f514ab4 RD |
1459 | def SetNormalFont(*args, **kwargs): |
1460 | """SetNormalFont(self, Font font)""" | |
1461 | return _aui.TabArt_SetNormalFont(*args, **kwargs) | |
1462 | ||
1463 | def SetSelectedFont(*args, **kwargs): | |
1464 | """SetSelectedFont(self, Font font)""" | |
1465 | return _aui.TabArt_SetSelectedFont(*args, **kwargs) | |
1466 | ||
1467 | def SetMeasuringFont(*args, **kwargs): | |
1468 | """SetMeasuringFont(self, Font font)""" | |
1469 | return _aui.TabArt_SetMeasuringFont(*args, **kwargs) | |
1470 | ||
5c8c7dd3 RD |
1471 | def DrawBackground(*args, **kwargs): |
1472 | """DrawBackground(self, DC dc, Rect rect)""" | |
1473 | return _aui.TabArt_DrawBackground(*args, **kwargs) | |
1474 | ||
1475 | def DrawTab(*args, **kwargs): | |
1476 | """ | |
1477 | DrawTab(self, DC dc, Rect in_rect, String caption, bool active, Rect out_rect, | |
1478 | int x_extent) | |
1479 | """ | |
1480 | return _aui.TabArt_DrawTab(*args, **kwargs) | |
1481 | ||
8f514ab4 RD |
1482 | def DrawButton(*args, **kwargs): |
1483 | """ | |
1484 | DrawButton(self, DC dc, Rect in_rect, int bitmap_id, int button_state, | |
1485 | int orientation, Bitmap bitmap_override, Rect out_rect) | |
1486 | """ | |
1487 | return _aui.TabArt_DrawButton(*args, **kwargs) | |
5c8c7dd3 | 1488 | |
8f514ab4 RD |
1489 | def GetTabSize(*args, **kwargs): |
1490 | """GetTabSize(self, DC dc, String caption, bool active, int x_extent) -> Size""" | |
1491 | return _aui.TabArt_GetTabSize(*args, **kwargs) | |
5c8c7dd3 | 1492 | |
8f514ab4 RD |
1493 | def GetBestTabCtrlSize(*args, **kwargs): |
1494 | """GetBestTabCtrlSize(self, Window wnd) -> int""" | |
1495 | return _aui.TabArt_GetBestTabCtrlSize(*args, **kwargs) | |
5c8c7dd3 RD |
1496 | |
1497 | _aui.TabArt_swigregister(TabArt) | |
1498 | ||
1499 | class DefaultTabArt(TabArt): | |
1500 | """Proxy of C++ DefaultTabArt class""" | |
1501 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1502 | __repr__ = _swig_repr | |
1503 | def __init__(self, *args, **kwargs): | |
1504 | """__init__(self) -> DefaultTabArt""" | |
1505 | _aui.DefaultTabArt_swiginit(self,_aui.new_DefaultTabArt(*args, **kwargs)) | |
1506 | __swig_destroy__ = _aui.delete_DefaultTabArt | |
1507 | __del__ = lambda self : None; | |
1508 | _aui.DefaultTabArt_swigregister(DefaultTabArt) | |
1509 | ||
10044bf1 RD |
1510 | class AuiNotebookEvent(_core.NotifyEvent): |
1511 | """Proxy of C++ AuiNotebookEvent class""" | |
1512 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1513 | __repr__ = _swig_repr | |
1514 | def __init__(self, *args, **kwargs): | |
1515 | """__init__(self, EventType command_type=wxEVT_NULL, int win_id=0) -> AuiNotebookEvent""" | |
1516 | _aui.AuiNotebookEvent_swiginit(self,_aui.new_AuiNotebookEvent(*args, **kwargs)) | |
1517 | def SetSelection(*args, **kwargs): | |
1518 | """SetSelection(self, int s)""" | |
1519 | return _aui.AuiNotebookEvent_SetSelection(*args, **kwargs) | |
1520 | ||
1521 | def SetOldSelection(*args, **kwargs): | |
1522 | """SetOldSelection(self, int s)""" | |
1523 | return _aui.AuiNotebookEvent_SetOldSelection(*args, **kwargs) | |
1524 | ||
1525 | def GetSelection(*args, **kwargs): | |
1526 | """ | |
1527 | GetSelection(self) -> int | |
1528 | ||
1529 | Returns item index for a listbox or choice selection event (not valid | |
1530 | for a deselection). | |
1531 | """ | |
1532 | return _aui.AuiNotebookEvent_GetSelection(*args, **kwargs) | |
1533 | ||
1534 | def GetOldSelection(*args, **kwargs): | |
1535 | """GetOldSelection(self) -> int""" | |
1536 | return _aui.AuiNotebookEvent_GetOldSelection(*args, **kwargs) | |
1537 | ||
1538 | old_selection = property(_aui.AuiNotebookEvent_old_selection_get, _aui.AuiNotebookEvent_old_selection_set) | |
1539 | selection = property(_aui.AuiNotebookEvent_selection_get, _aui.AuiNotebookEvent_selection_set) | |
777e547f RD |
1540 | OldSelection = property(GetOldSelection,SetOldSelection,doc="See `GetOldSelection` and `SetOldSelection`") |
1541 | Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`") | |
10044bf1 RD |
1542 | _aui.AuiNotebookEvent_swigregister(AuiNotebookEvent) |
1543 | ||
1544 | class AuiNotebookPage(object): | |
1545 | """Proxy of C++ AuiNotebookPage class""" | |
1546 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1547 | def __init__(self): raise AttributeError, "No constructor defined" | |
1548 | __repr__ = _swig_repr | |
1549 | window = property(_aui.AuiNotebookPage_window_get, _aui.AuiNotebookPage_window_set) | |
1550 | caption = property(_aui.AuiNotebookPage_caption_get, _aui.AuiNotebookPage_caption_set) | |
1551 | bitmap = property(_aui.AuiNotebookPage_bitmap_get, _aui.AuiNotebookPage_bitmap_set) | |
1552 | rect = property(_aui.AuiNotebookPage_rect_get, _aui.AuiNotebookPage_rect_set) | |
1553 | active = property(_aui.AuiNotebookPage_active_get, _aui.AuiNotebookPage_active_set) | |
1554 | _aui.AuiNotebookPage_swigregister(AuiNotebookPage) | |
1555 | ||
1556 | class AuiTabContainerButton(object): | |
1557 | """Proxy of C++ AuiTabContainerButton class""" | |
1558 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1559 | def __init__(self): raise AttributeError, "No constructor defined" | |
1560 | __repr__ = _swig_repr | |
1561 | id = property(_aui.AuiTabContainerButton_id_get, _aui.AuiTabContainerButton_id_set) | |
1562 | cur_state = property(_aui.AuiTabContainerButton_cur_state_get, _aui.AuiTabContainerButton_cur_state_set) | |
5c8c7dd3 | 1563 | location = property(_aui.AuiTabContainerButton_location_get, _aui.AuiTabContainerButton_location_set) |
10044bf1 | 1564 | bitmap = property(_aui.AuiTabContainerButton_bitmap_get, _aui.AuiTabContainerButton_bitmap_set) |
8f514ab4 | 1565 | dis_bitmap = property(_aui.AuiTabContainerButton_dis_bitmap_get, _aui.AuiTabContainerButton_dis_bitmap_set) |
10044bf1 RD |
1566 | rect = property(_aui.AuiTabContainerButton_rect_get, _aui.AuiTabContainerButton_rect_set) |
1567 | _aui.AuiTabContainerButton_swigregister(AuiTabContainerButton) | |
1568 | ||
1569 | class AuiTabContainer(object): | |
1570 | """Proxy of C++ AuiTabContainer class""" | |
1571 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1572 | __repr__ = _swig_repr | |
1573 | def __init__(self, *args, **kwargs): | |
1574 | """__init__(self) -> AuiTabContainer""" | |
1575 | _aui.AuiTabContainer_swiginit(self,_aui.new_AuiTabContainer(*args, **kwargs)) | |
1576 | __swig_destroy__ = _aui.delete_AuiTabContainer | |
1577 | __del__ = lambda self : None; | |
5c8c7dd3 RD |
1578 | def SetArtProvider(*args, **kwargs): |
1579 | """SetArtProvider(self, TabArt art)""" | |
1580 | return _aui.AuiTabContainer_SetArtProvider(*args, **kwargs) | |
1581 | ||
1582 | def GetArtProvider(*args, **kwargs): | |
1583 | """GetArtProvider(self) -> TabArt""" | |
1584 | return _aui.AuiTabContainer_GetArtProvider(*args, **kwargs) | |
1585 | ||
10044bf1 RD |
1586 | def AddPage(*args, **kwargs): |
1587 | """AddPage(self, Window page, AuiNotebookPage info) -> bool""" | |
1588 | return _aui.AuiTabContainer_AddPage(*args, **kwargs) | |
1589 | ||
1590 | def InsertPage(*args, **kwargs): | |
1591 | """InsertPage(self, Window page, AuiNotebookPage info, size_t idx) -> bool""" | |
1592 | return _aui.AuiTabContainer_InsertPage(*args, **kwargs) | |
1593 | ||
1594 | def RemovePage(*args, **kwargs): | |
1595 | """RemovePage(self, Window page) -> bool""" | |
1596 | return _aui.AuiTabContainer_RemovePage(*args, **kwargs) | |
1597 | ||
1598 | def SetActivePage(*args): | |
1599 | """ | |
1600 | SetActivePage(self, Window page) -> bool | |
1601 | SetActivePage(self, size_t page) -> bool | |
1602 | """ | |
1603 | return _aui.AuiTabContainer_SetActivePage(*args) | |
1604 | ||
1605 | def SetNoneActive(*args, **kwargs): | |
1606 | """SetNoneActive(self)""" | |
1607 | return _aui.AuiTabContainer_SetNoneActive(*args, **kwargs) | |
1608 | ||
1609 | def GetActivePage(*args, **kwargs): | |
1610 | """GetActivePage(self) -> int""" | |
1611 | return _aui.AuiTabContainer_GetActivePage(*args, **kwargs) | |
1612 | ||
1613 | def TabHitTest(*args, **kwargs): | |
1614 | """TabHitTest(self, int x, int y, Window hit) -> bool""" | |
1615 | return _aui.AuiTabContainer_TabHitTest(*args, **kwargs) | |
1616 | ||
1617 | def ButtonHitTest(*args, **kwargs): | |
1618 | """ButtonHitTest(self, int x, int y, AuiTabContainerButton hit) -> bool""" | |
1619 | return _aui.AuiTabContainer_ButtonHitTest(*args, **kwargs) | |
1620 | ||
1621 | def GetWindowFromIdx(*args, **kwargs): | |
1622 | """GetWindowFromIdx(self, size_t idx) -> Window""" | |
1623 | return _aui.AuiTabContainer_GetWindowFromIdx(*args, **kwargs) | |
1624 | ||
1625 | def GetIdxFromWindow(*args, **kwargs): | |
1626 | """GetIdxFromWindow(self, Window page) -> int""" | |
1627 | return _aui.AuiTabContainer_GetIdxFromWindow(*args, **kwargs) | |
1628 | ||
1629 | def GetPageCount(*args, **kwargs): | |
1630 | """GetPageCount(self) -> size_t""" | |
1631 | return _aui.AuiTabContainer_GetPageCount(*args, **kwargs) | |
1632 | ||
1633 | def GetPage(*args, **kwargs): | |
1634 | """GetPage(self, size_t idx) -> AuiNotebookPage""" | |
1635 | return _aui.AuiTabContainer_GetPage(*args, **kwargs) | |
1636 | ||
1637 | def GetPages(*args, **kwargs): | |
1638 | """GetPages(self) -> wxAuiNotebookPageArray""" | |
1639 | return _aui.AuiTabContainer_GetPages(*args, **kwargs) | |
1640 | ||
1641 | def SetNormalFont(*args, **kwargs): | |
1642 | """SetNormalFont(self, Font normal_font)""" | |
1643 | return _aui.AuiTabContainer_SetNormalFont(*args, **kwargs) | |
1644 | ||
1645 | def SetSelectedFont(*args, **kwargs): | |
1646 | """SetSelectedFont(self, Font selected_font)""" | |
1647 | return _aui.AuiTabContainer_SetSelectedFont(*args, **kwargs) | |
1648 | ||
1649 | def SetMeasuringFont(*args, **kwargs): | |
1650 | """SetMeasuringFont(self, Font measuring_font)""" | |
1651 | return _aui.AuiTabContainer_SetMeasuringFont(*args, **kwargs) | |
1652 | ||
1653 | def DoShowHide(*args, **kwargs): | |
1654 | """DoShowHide(self)""" | |
1655 | return _aui.AuiTabContainer_DoShowHide(*args, **kwargs) | |
1656 | ||
1657 | def SetRect(*args, **kwargs): | |
1658 | """SetRect(self, Rect rect)""" | |
1659 | return _aui.AuiTabContainer_SetRect(*args, **kwargs) | |
1660 | ||
1661 | def AddButton(*args, **kwargs): | |
8f514ab4 RD |
1662 | """ |
1663 | AddButton(self, int id, int location, Bitmap normal_bitmap=wxNullBitmap, | |
1664 | Bitmap disabled_bitmap=wxNullBitmap) | |
1665 | """ | |
10044bf1 RD |
1666 | return _aui.AuiTabContainer_AddButton(*args, **kwargs) |
1667 | ||
8f514ab4 RD |
1668 | def GetTabOffset(*args, **kwargs): |
1669 | """GetTabOffset(self) -> size_t""" | |
1670 | return _aui.AuiTabContainer_GetTabOffset(*args, **kwargs) | |
1671 | ||
1672 | def SetTabOffset(*args, **kwargs): | |
1673 | """SetTabOffset(self, size_t offset)""" | |
1674 | return _aui.AuiTabContainer_SetTabOffset(*args, **kwargs) | |
1675 | ||
777e547f RD |
1676 | ActivePage = property(GetActivePage,SetActivePage,doc="See `GetActivePage` and `SetActivePage`") |
1677 | PageCount = property(GetPageCount,doc="See `GetPageCount`") | |
1678 | Pages = property(GetPages,doc="See `GetPages`") | |
10044bf1 RD |
1679 | _aui.AuiTabContainer_swigregister(AuiTabContainer) |
1680 | ||
1681 | class AuiTabCtrl(_core.Control,AuiTabContainer): | |
1682 | """Proxy of C++ AuiTabCtrl class""" | |
1683 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1684 | __repr__ = _swig_repr | |
1685 | def __init__(self, *args, **kwargs): | |
1686 | """ | |
1687 | __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, | |
1688 | Size size=DefaultSize, long style=0) -> AuiTabCtrl | |
1689 | """ | |
1690 | _aui.AuiTabCtrl_swiginit(self,_aui.new_AuiTabCtrl(*args, **kwargs)) | |
1691 | self._setOORInfo(self) | |
1692 | ||
1693 | _aui.AuiTabCtrl_swigregister(AuiTabCtrl) | |
1694 | ||
1695 | class AuiMultiNotebook(_core.Control): | |
1696 | """Proxy of C++ AuiMultiNotebook class""" | |
1697 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1698 | __repr__ = _swig_repr | |
1699 | def __init__(self, *args, **kwargs): | |
1700 | """ | |
1701 | __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, | |
1702 | Size size=DefaultSize, long style=0) -> AuiMultiNotebook | |
1703 | """ | |
1704 | _aui.AuiMultiNotebook_swiginit(self,_aui.new_AuiMultiNotebook(*args, **kwargs)) | |
1705 | self._setOORInfo(self) | |
1706 | ||
1707 | def Create(*args, **kwargs): | |
1708 | """ | |
1709 | Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, | |
1710 | Size size=DefaultSize, long style=0) -> bool | |
1711 | ||
1712 | Do the 2nd phase and create the GUI control. | |
1713 | """ | |
1714 | return _aui.AuiMultiNotebook_Create(*args, **kwargs) | |
1715 | ||
1716 | def AddPage(*args, **kwargs): | |
1717 | """AddPage(self, Window page, String caption, bool select=False, Bitmap bitmap=wxNullBitmap) -> bool""" | |
1718 | return _aui.AuiMultiNotebook_AddPage(*args, **kwargs) | |
1719 | ||
1720 | def InsertPage(*args, **kwargs): | |
1721 | """ | |
1722 | InsertPage(self, size_t page_idx, Window page, String caption, bool select=False, | |
1723 | Bitmap bitmap=wxNullBitmap) -> bool | |
1724 | """ | |
1725 | return _aui.AuiMultiNotebook_InsertPage(*args, **kwargs) | |
1726 | ||
1727 | def DeletePage(*args, **kwargs): | |
1728 | """DeletePage(self, size_t page) -> bool""" | |
1729 | return _aui.AuiMultiNotebook_DeletePage(*args, **kwargs) | |
1730 | ||
1731 | def RemovePage(*args, **kwargs): | |
1732 | """RemovePage(self, size_t page) -> bool""" | |
1733 | return _aui.AuiMultiNotebook_RemovePage(*args, **kwargs) | |
1734 | ||
1735 | def SetPageText(*args, **kwargs): | |
1736 | """SetPageText(self, size_t page, String text) -> bool""" | |
1737 | return _aui.AuiMultiNotebook_SetPageText(*args, **kwargs) | |
1738 | ||
1739 | def SetSelection(*args, **kwargs): | |
1740 | """SetSelection(self, size_t new_page) -> size_t""" | |
1741 | return _aui.AuiMultiNotebook_SetSelection(*args, **kwargs) | |
1742 | ||
1743 | def GetSelection(*args, **kwargs): | |
1744 | """GetSelection(self) -> int""" | |
1745 | return _aui.AuiMultiNotebook_GetSelection(*args, **kwargs) | |
1746 | ||
1747 | def GetPageCount(*args, **kwargs): | |
1748 | """GetPageCount(self) -> size_t""" | |
1749 | return _aui.AuiMultiNotebook_GetPageCount(*args, **kwargs) | |
1750 | ||
1751 | def GetPage(*args, **kwargs): | |
1752 | """GetPage(self, size_t page_idx) -> Window""" | |
1753 | return _aui.AuiMultiNotebook_GetPage(*args, **kwargs) | |
1754 | ||
5c8c7dd3 RD |
1755 | def SetArtProvider(*args, **kwargs): |
1756 | """SetArtProvider(self, TabArt art)""" | |
1757 | return _aui.AuiMultiNotebook_SetArtProvider(*args, **kwargs) | |
1758 | ||
1759 | def GetArtProvider(*args, **kwargs): | |
1760 | """GetArtProvider(self) -> TabArt""" | |
1761 | return _aui.AuiMultiNotebook_GetArtProvider(*args, **kwargs) | |
1762 | ||
777e547f RD |
1763 | PageCount = property(GetPageCount,doc="See `GetPageCount`") |
1764 | Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`") | |
10044bf1 RD |
1765 | _aui.AuiMultiNotebook_swigregister(AuiMultiNotebook) |
1766 | ||
1767 | def PreAuiMultiNotebook(*args, **kwargs): | |
1768 | """PreAuiMultiNotebook() -> AuiMultiNotebook""" | |
1769 | val = _aui.new_PreAuiMultiNotebook(*args, **kwargs) | |
1770 | self._setOORInfo(self) | |
1771 | return val | |
1772 | ||
1773 | wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED = _aui.wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED | |
1774 | wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING = _aui.wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING | |
1775 | wxEVT_COMMAND_AUINOTEBOOK_BUTTON = _aui.wxEVT_COMMAND_AUINOTEBOOK_BUTTON | |
1776 | wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG = _aui.wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG | |
1777 | wxEVT_COMMAND_AUINOTEBOOK_END_DRAG = _aui.wxEVT_COMMAND_AUINOTEBOOK_END_DRAG | |
1778 | wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION = _aui.wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION | |
1779 | EVT_AUINOTEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED, 1 ) | |
1780 | EVT_AUINOTEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING, 1 ) | |
1781 | EVT_AUINOTEBOOK_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BUTTON, 1 ) | |
1782 | EVT_AUINOTEBOOK_BEGIN_DRAG = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG, 1 ) | |
1783 | EVT_AUINOTEBOOK_END_DRAG = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_END_DRAG, 1 ) | |
0f83f5da | 1784 | EVT_AUINOTEBOOK_DRAG_MOTION = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, 1 ) |
10044bf1 | 1785 | |
27e45892 RD |
1786 | class PyDockArt(DefaultDockArt): |
1787 | """ | |
1788 | This version of the `DockArt` class has been instrumented to be | |
1789 | subclassable in Python and to reflect all calls to the C++ base class | |
1790 | methods to the Python methods implemented in the derived class. | |
1791 | """ | |
1792 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1793 | def __init__(self): raise AttributeError, "No constructor defined" | |
1794 | __repr__ = _swig_repr | |
1795 | _aui.PyDockArt_swigregister(PyDockArt) | |
1796 | ||
5c8c7dd3 RD |
1797 | class PyTabArt(DefaultTabArt): |
1798 | """ | |
1799 | This version of the `TabArt` class has been instrumented to be | |
1800 | subclassable in Python and to reflect all calls to the C++ base class | |
1801 | methods to the Python methods implemented in the derived class. | |
1802 | """ | |
1803 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1804 | def __init__(self): raise AttributeError, "No constructor defined" | |
1805 | __repr__ = _swig_repr | |
1806 | _aui.PyTabArt_swigregister(PyTabArt) | |
1807 | ||
27e45892 RD |
1808 | |
1809 |