]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/msw/_controls.py
Forward declare new wxPy classes
[wxWidgets.git] / wxPython / src / msw / _controls.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 import _controls_
5 import new
6 new_instancemethod = new.instancemethod
7 def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
8 if (name == "thisown"): return self.this.own(value)
9 if (name == "this"):
10 if type(value).__name__ == 'PySwigObject':
11 self.__dict__[name] = value
12 return
13 method = class_type.__swig_setmethods__.get(name,None)
14 if method: return method(self,value)
15 if (not static) or hasattr(self,name):
16 self.__dict__[name] = value
17 else:
18 raise AttributeError("You cannot add attributes to %s" % self)
19
20 def _swig_setattr(self,class_type,name,value):
21 return _swig_setattr_nondynamic(self,class_type,name,value,0)
22
23 def _swig_getattr(self,class_type,name):
24 if (name == "thisown"): return self.this.own()
25 method = class_type.__swig_getmethods__.get(name,None)
26 if method: return method(self)
27 raise AttributeError,name
28
29 def _swig_repr(self):
30 try: strthis = "proxy of " + self.this.__repr__()
31 except: strthis = ""
32 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
33
34 import types
35 try:
36 _object = types.ObjectType
37 _newclass = 1
38 except AttributeError:
39 class _object : pass
40 _newclass = 0
41 del types
42
43
44 def _swig_setattr_nondynamic_method(set):
45 def set_attr(self,name,value):
46 if (name == "thisown"): return self.this.own(value)
47 if hasattr(self,name) or (name == "this"):
48 set(self,name,value)
49 else:
50 raise AttributeError("You cannot add attributes to %s" % self)
51 return set_attr
52
53
54 import _core
55 wx = _core
56 #---------------------------------------------------------------------------
57
58 BU_LEFT = _controls_.BU_LEFT
59 BU_TOP = _controls_.BU_TOP
60 BU_RIGHT = _controls_.BU_RIGHT
61 BU_BOTTOM = _controls_.BU_BOTTOM
62 BU_ALIGN_MASK = _controls_.BU_ALIGN_MASK
63 BU_EXACTFIT = _controls_.BU_EXACTFIT
64 BU_AUTODRAW = _controls_.BU_AUTODRAW
65 class Button(_core.Control):
66 """
67 A button is a control that contains a text string, and is one of the most
68 common elements of a GUI. It may be placed on a dialog box or panel, or
69 indeed almost any other window.
70 """
71 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
72 __repr__ = _swig_repr
73 def __init__(self, *args, **kwargs):
74 """
75 __init__(self, Window parent, int id=-1, String label=EmptyString,
76 Point pos=DefaultPosition, Size size=DefaultSize,
77 long style=0, Validator validator=DefaultValidator,
78 String name=ButtonNameStr) -> Button
79
80 Create and show a button. The preferred way to create standard
81 buttons is to use a standard ID and an empty label. In this case
82 wxWigets will automatically use a stock label that coresponds to the
83 ID given. In additon, the button will be decorated with stock icons
84 under GTK+ 2.
85 """
86 _controls_.Button_swiginit(self,_controls_.new_Button(*args, **kwargs))
87 self._setOORInfo(self)
88
89 def Create(*args, **kwargs):
90 """
91 Create(self, Window parent, int id=-1, String label=EmptyString,
92 Point pos=DefaultPosition, Size size=DefaultSize,
93 long style=0, Validator validator=DefaultValidator,
94 String name=ButtonNameStr) -> bool
95
96 Acutally create the GUI Button for 2-phase creation.
97 """
98 return _controls_.Button_Create(*args, **kwargs)
99
100 def SetDefault(*args, **kwargs):
101 """
102 SetDefault(self) -> Window
103
104 This sets the button to be the default item for the panel or dialog box.
105 """
106 return _controls_.Button_SetDefault(*args, **kwargs)
107
108 def GetDefaultSize(*args, **kwargs):
109 """
110 GetDefaultSize() -> Size
111
112 Returns the default button size for this platform.
113 """
114 return _controls_.Button_GetDefaultSize(*args, **kwargs)
115
116 GetDefaultSize = staticmethod(GetDefaultSize)
117 def GetClassDefaultAttributes(*args, **kwargs):
118 """
119 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
120
121 Get the default attributes for this class. This is useful if you want
122 to use the same font or colour in your own control as in a standard
123 control -- which is a much better idea than hard coding specific
124 colours or fonts which might look completely out of place on the
125 user's system, especially if it uses themes.
126
127 The variant parameter is only relevant under Mac currently and is
128 ignore under other platforms. Under Mac, it will change the size of
129 the returned font. See `wx.Window.SetWindowVariant` for more about
130 this.
131 """
132 return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs)
133
134 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
135 _controls_.Button_swigregister(Button)
136 cvar = _controls_.cvar
137 ButtonNameStr = cvar.ButtonNameStr
138
139 def PreButton(*args, **kwargs):
140 """
141 PreButton() -> Button
142
143 Precreate a Button for 2-phase creation.
144 """
145 val = _controls_.new_PreButton(*args, **kwargs)
146 return val
147
148 def Button_GetDefaultSize(*args):
149 """
150 Button_GetDefaultSize() -> Size
151
152 Returns the default button size for this platform.
153 """
154 return _controls_.Button_GetDefaultSize(*args)
155
156 def Button_GetClassDefaultAttributes(*args, **kwargs):
157 """
158 Button_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
159
160 Get the default attributes for this class. This is useful if you want
161 to use the same font or colour in your own control as in a standard
162 control -- which is a much better idea than hard coding specific
163 colours or fonts which might look completely out of place on the
164 user's system, especially if it uses themes.
165
166 The variant parameter is only relevant under Mac currently and is
167 ignore under other platforms. Under Mac, it will change the size of
168 the returned font. See `wx.Window.SetWindowVariant` for more about
169 this.
170 """
171 return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs)
172
173 class BitmapButton(Button):
174 """
175 A Button that contains a bitmap. A bitmap button can be supplied with a
176 single bitmap, and wxWidgets will draw all button states using this bitmap. If
177 the application needs more control, additional bitmaps for the selected state,
178 unpressed focused state, and greyed-out state may be supplied.
179 """
180 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
181 __repr__ = _swig_repr
182 def __init__(self, *args, **kwargs):
183 """
184 __init__(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap,
185 Point pos=DefaultPosition, Size size=DefaultSize,
186 long style=BU_AUTODRAW, Validator validator=DefaultValidator,
187 String name=ButtonNameStr) -> BitmapButton
188
189 Create and show a button with a bitmap for the label.
190 """
191 _controls_.BitmapButton_swiginit(self,_controls_.new_BitmapButton(*args, **kwargs))
192 self._setOORInfo(self)
193
194 def Create(*args, **kwargs):
195 """
196 Create(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap,
197 Point pos=DefaultPosition, Size size=DefaultSize,
198 long style=BU_AUTODRAW, Validator validator=DefaultValidator,
199 String name=ButtonNameStr) -> bool
200
201 Acutally create the GUI BitmapButton for 2-phase creation.
202 """
203 return _controls_.BitmapButton_Create(*args, **kwargs)
204
205 def GetBitmapLabel(*args, **kwargs):
206 """
207 GetBitmapLabel(self) -> Bitmap
208
209 Returns the label bitmap (the one passed to the constructor).
210 """
211 return _controls_.BitmapButton_GetBitmapLabel(*args, **kwargs)
212
213 def GetBitmapDisabled(*args, **kwargs):
214 """
215 GetBitmapDisabled(self) -> Bitmap
216
217 Returns the bitmap for the disabled state.
218 """
219 return _controls_.BitmapButton_GetBitmapDisabled(*args, **kwargs)
220
221 def GetBitmapFocus(*args, **kwargs):
222 """
223 GetBitmapFocus(self) -> Bitmap
224
225 Returns the bitmap for the focused state.
226 """
227 return _controls_.BitmapButton_GetBitmapFocus(*args, **kwargs)
228
229 def GetBitmapSelected(*args, **kwargs):
230 """
231 GetBitmapSelected(self) -> Bitmap
232
233 Returns the bitmap for the selected state.
234 """
235 return _controls_.BitmapButton_GetBitmapSelected(*args, **kwargs)
236
237 def GetBitmapHover(*args, **kwargs):
238 """
239 GetBitmapHover(self) -> Bitmap
240
241 Returns the bitmap used when the mouse is over the button, may be invalid.
242 """
243 return _controls_.BitmapButton_GetBitmapHover(*args, **kwargs)
244
245 def SetBitmapDisabled(*args, **kwargs):
246 """
247 SetBitmapDisabled(self, Bitmap bitmap)
248
249 Sets the bitmap for the disabled button appearance.
250 """
251 return _controls_.BitmapButton_SetBitmapDisabled(*args, **kwargs)
252
253 def SetBitmapFocus(*args, **kwargs):
254 """
255 SetBitmapFocus(self, Bitmap bitmap)
256
257 Sets the bitmap for the button appearance when it has the keyboard focus.
258 """
259 return _controls_.BitmapButton_SetBitmapFocus(*args, **kwargs)
260
261 def SetBitmapSelected(*args, **kwargs):
262 """
263 SetBitmapSelected(self, Bitmap bitmap)
264
265 Sets the bitmap for the selected (depressed) button appearance.
266 """
267 return _controls_.BitmapButton_SetBitmapSelected(*args, **kwargs)
268
269 def SetBitmapLabel(*args, **kwargs):
270 """
271 SetBitmapLabel(self, Bitmap bitmap)
272
273 Sets the bitmap label for the button. This is the bitmap used for the
274 unselected state, and for all other states if no other bitmaps are provided.
275 """
276 return _controls_.BitmapButton_SetBitmapLabel(*args, **kwargs)
277
278 def SetBitmapHover(*args, **kwargs):
279 """
280 SetBitmapHover(self, Bitmap hover)
281
282 Sets the bitmap to be shown when the mouse is over the button. This function
283 is new since wxWidgets version 2.7.0 and the hover bitmap is currently only
284 supported in wxMSW.
285 """
286 return _controls_.BitmapButton_SetBitmapHover(*args, **kwargs)
287
288 def SetMargins(*args, **kwargs):
289 """SetMargins(self, int x, int y)"""
290 return _controls_.BitmapButton_SetMargins(*args, **kwargs)
291
292 def GetMarginX(*args, **kwargs):
293 """GetMarginX(self) -> int"""
294 return _controls_.BitmapButton_GetMarginX(*args, **kwargs)
295
296 def GetMarginY(*args, **kwargs):
297 """GetMarginY(self) -> int"""
298 return _controls_.BitmapButton_GetMarginY(*args, **kwargs)
299
300 BitmapDisabled = property(GetBitmapDisabled,SetBitmapDisabled,doc="See `GetBitmapDisabled` and `SetBitmapDisabled`")
301 BitmapFocus = property(GetBitmapFocus,SetBitmapFocus,doc="See `GetBitmapFocus` and `SetBitmapFocus`")
302 BitmapHover = property(GetBitmapHover,SetBitmapHover,doc="See `GetBitmapHover` and `SetBitmapHover`")
303 BitmapLabel = property(GetBitmapLabel,SetBitmapLabel,doc="See `GetBitmapLabel` and `SetBitmapLabel`")
304 BitmapSelected = property(GetBitmapSelected,SetBitmapSelected,doc="See `GetBitmapSelected` and `SetBitmapSelected`")
305 MarginX = property(GetMarginX,doc="See `GetMarginX`")
306 MarginY = property(GetMarginY,doc="See `GetMarginY`")
307 _controls_.BitmapButton_swigregister(BitmapButton)
308
309 def PreBitmapButton(*args, **kwargs):
310 """
311 PreBitmapButton() -> BitmapButton
312
313 Precreate a BitmapButton for 2-phase creation.
314 """
315 val = _controls_.new_PreBitmapButton(*args, **kwargs)
316 return val
317
318 #---------------------------------------------------------------------------
319
320 CHK_2STATE = _controls_.CHK_2STATE
321 CHK_3STATE = _controls_.CHK_3STATE
322 CHK_ALLOW_3RD_STATE_FOR_USER = _controls_.CHK_ALLOW_3RD_STATE_FOR_USER
323 CHK_UNCHECKED = _controls_.CHK_UNCHECKED
324 CHK_CHECKED = _controls_.CHK_CHECKED
325 CHK_UNDETERMINED = _controls_.CHK_UNDETERMINED
326 class CheckBox(_core.Control):
327 """
328 A checkbox is a labelled box which by default is either on (the
329 checkmark is visible) or off (no checkmark). Optionally (When the
330 wx.CHK_3STATE style flag is set) it can have a third state, called the
331 mixed or undetermined state. Often this is used as a "Does Not
332 Apply" state.
333 """
334 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
335 __repr__ = _swig_repr
336 def __init__(self, *args, **kwargs):
337 """
338 __init__(self, Window parent, int id=-1, String label=EmptyString,
339 Point pos=DefaultPosition, Size size=DefaultSize,
340 long style=0, Validator validator=DefaultValidator,
341 String name=CheckBoxNameStr) -> CheckBox
342
343 Creates and shows a CheckBox control
344 """
345 _controls_.CheckBox_swiginit(self,_controls_.new_CheckBox(*args, **kwargs))
346 self._setOORInfo(self)
347
348 def Create(*args, **kwargs):
349 """
350 Create(self, Window parent, int id=-1, String label=EmptyString,
351 Point pos=DefaultPosition, Size size=DefaultSize,
352 long style=0, Validator validator=DefaultValidator,
353 String name=CheckBoxNameStr) -> bool
354
355 Actually create the GUI CheckBox for 2-phase creation.
356 """
357 return _controls_.CheckBox_Create(*args, **kwargs)
358
359 def GetValue(*args, **kwargs):
360 """
361 GetValue(self) -> bool
362
363 Gets the state of a 2-state CheckBox. Returns True if it is checked,
364 False otherwise.
365 """
366 return _controls_.CheckBox_GetValue(*args, **kwargs)
367
368 def IsChecked(*args, **kwargs):
369 """
370 IsChecked(self) -> bool
371
372 Similar to GetValue, but raises an exception if it is not a 2-state
373 CheckBox.
374 """
375 return _controls_.CheckBox_IsChecked(*args, **kwargs)
376
377 def SetValue(*args, **kwargs):
378 """
379 SetValue(self, bool state)
380
381 Set the state of a 2-state CheckBox. Pass True for checked, False for
382 unchecked.
383 """
384 return _controls_.CheckBox_SetValue(*args, **kwargs)
385
386 def Get3StateValue(*args, **kwargs):
387 """
388 Get3StateValue(self) -> int
389
390 Returns wx.CHK_UNCHECKED when the CheckBox is unchecked,
391 wx.CHK_CHECKED when it is checked and wx.CHK_UNDETERMINED when it's in
392 the undetermined state. Raises an exceptiion when the function is
393 used with a 2-state CheckBox.
394 """
395 return _controls_.CheckBox_Get3StateValue(*args, **kwargs)
396
397 def Set3StateValue(*args, **kwargs):
398 """
399 Set3StateValue(self, int state)
400
401 Sets the CheckBox to the given state. The state parameter can be one
402 of the following: wx.CHK_UNCHECKED (Check is off), wx.CHK_CHECKED (the
403 Check is on) or wx.CHK_UNDETERMINED (Check is mixed). Raises an
404 exception when the CheckBox is a 2-state checkbox and setting the
405 state to wx.CHK_UNDETERMINED.
406 """
407 return _controls_.CheckBox_Set3StateValue(*args, **kwargs)
408
409 def Is3State(*args, **kwargs):
410 """
411 Is3State(self) -> bool
412
413 Returns whether or not the CheckBox is a 3-state CheckBox.
414 """
415 return _controls_.CheckBox_Is3State(*args, **kwargs)
416
417 def Is3rdStateAllowedForUser(*args, **kwargs):
418 """
419 Is3rdStateAllowedForUser(self) -> bool
420
421 Returns whether or not the user can set the CheckBox to the third
422 state.
423 """
424 return _controls_.CheckBox_Is3rdStateAllowedForUser(*args, **kwargs)
425
426 def GetClassDefaultAttributes(*args, **kwargs):
427 """
428 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
429
430 Get the default attributes for this class. This is useful if you want
431 to use the same font or colour in your own control as in a standard
432 control -- which is a much better idea than hard coding specific
433 colours or fonts which might look completely out of place on the
434 user's system, especially if it uses themes.
435
436 The variant parameter is only relevant under Mac currently and is
437 ignore under other platforms. Under Mac, it will change the size of
438 the returned font. See `wx.Window.SetWindowVariant` for more about
439 this.
440 """
441 return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs)
442
443 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
444 ThreeStateValue = property(Get3StateValue,Set3StateValue,doc="See `Get3StateValue` and `Set3StateValue`")
445 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
446 _controls_.CheckBox_swigregister(CheckBox)
447 CheckBoxNameStr = cvar.CheckBoxNameStr
448
449 def PreCheckBox(*args, **kwargs):
450 """
451 PreCheckBox() -> CheckBox
452
453 Precreate a CheckBox for 2-phase creation.
454 """
455 val = _controls_.new_PreCheckBox(*args, **kwargs)
456 return val
457
458 def CheckBox_GetClassDefaultAttributes(*args, **kwargs):
459 """
460 CheckBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
461
462 Get the default attributes for this class. This is useful if you want
463 to use the same font or colour in your own control as in a standard
464 control -- which is a much better idea than hard coding specific
465 colours or fonts which might look completely out of place on the
466 user's system, especially if it uses themes.
467
468 The variant parameter is only relevant under Mac currently and is
469 ignore under other platforms. Under Mac, it will change the size of
470 the returned font. See `wx.Window.SetWindowVariant` for more about
471 this.
472 """
473 return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs)
474
475 #---------------------------------------------------------------------------
476
477 class Choice(_core.ControlWithItems):
478 """
479 A Choice control is used to select one of a list of strings.
480 Unlike a `wx.ListBox`, only the selection is visible until the
481 user pulls down the menu of choices.
482 """
483 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
484 __repr__ = _swig_repr
485 def __init__(self, *args, **kwargs):
486 """
487 __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
488 List choices=EmptyList, long style=0, Validator validator=DefaultValidator,
489 String name=ChoiceNameStr) -> Choice
490
491 Create and show a Choice control
492 """
493 _controls_.Choice_swiginit(self,_controls_.new_Choice(*args, **kwargs))
494 self._setOORInfo(self)
495
496 def Create(*args, **kwargs):
497 """
498 Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
499 List choices=EmptyList, long style=0, Validator validator=DefaultValidator,
500 String name=ChoiceNameStr) -> bool
501
502 Actually create the GUI Choice control for 2-phase creation
503 """
504 return _controls_.Choice_Create(*args, **kwargs)
505
506 def GetCurrentSelection(*args, **kwargs):
507 """
508 GetCurrentSelection(self) -> int
509
510 Unlike `GetSelection` which only returns the accepted selection value,
511 i.e. the selection in the control once the user closes the dropdown
512 list, this function returns the current selection. That is, while the
513 dropdown list is shown, it returns the currently selected item in
514 it. When it is not shown, its result is the same as for the other
515 function.
516 """
517 return _controls_.Choice_GetCurrentSelection(*args, **kwargs)
518
519 def GetClassDefaultAttributes(*args, **kwargs):
520 """
521 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
522
523 Get the default attributes for this class. This is useful if you want
524 to use the same font or colour in your own control as in a standard
525 control -- which is a much better idea than hard coding specific
526 colours or fonts which might look completely out of place on the
527 user's system, especially if it uses themes.
528
529 The variant parameter is only relevant under Mac currently and is
530 ignore under other platforms. Under Mac, it will change the size of
531 the returned font. See `wx.Window.SetWindowVariant` for more about
532 this.
533 """
534 return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs)
535
536 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
537 CurrentSelection = property(GetCurrentSelection,doc="See `GetCurrentSelection`")
538 _controls_.Choice_swigregister(Choice)
539 ChoiceNameStr = cvar.ChoiceNameStr
540
541 def PreChoice(*args, **kwargs):
542 """
543 PreChoice() -> Choice
544
545 Precreate a Choice control for 2-phase creation.
546 """
547 val = _controls_.new_PreChoice(*args, **kwargs)
548 return val
549
550 def Choice_GetClassDefaultAttributes(*args, **kwargs):
551 """
552 Choice_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
553
554 Get the default attributes for this class. This is useful if you want
555 to use the same font or colour in your own control as in a standard
556 control -- which is a much better idea than hard coding specific
557 colours or fonts which might look completely out of place on the
558 user's system, especially if it uses themes.
559
560 The variant parameter is only relevant under Mac currently and is
561 ignore under other platforms. Under Mac, it will change the size of
562 the returned font. See `wx.Window.SetWindowVariant` for more about
563 this.
564 """
565 return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs)
566
567 #---------------------------------------------------------------------------
568
569 class ComboBox(Choice):
570 """
571 A combobox is like a combination of an edit control and a
572 listbox. It can be displayed as static list with editable or
573 read-only text field; or a drop-down list with text field.
574
575 A combobox permits a single selection only. Combobox items are
576 numbered from zero.
577 """
578 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
579 __repr__ = _swig_repr
580 def __init__(self, *args, **kwargs):
581 """
582 __init__(Window parent, int id=-1, String value=EmptyString,
583 Point pos=DefaultPosition, Size size=DefaultSize,
584 List choices=EmptyList, long style=0, Validator validator=DefaultValidator,
585 String name=ComboBoxNameStr) -> ComboBox
586
587 Constructor, creates and shows a ComboBox control.
588 """
589 _controls_.ComboBox_swiginit(self,_controls_.new_ComboBox(*args, **kwargs))
590 self._setOORInfo(self)
591
592 def Create(*args, **kwargs):
593 """
594 Create(Window parent, int id=-1, String value=EmptyString,
595 Point pos=DefaultPosition, Size size=DefaultSize,
596 List choices=EmptyList, long style=0, Validator validator=DefaultValidator,
597 String name=ChoiceNameStr) -> bool
598
599 Actually create the GUI wxComboBox control for 2-phase creation
600 """
601 return _controls_.ComboBox_Create(*args, **kwargs)
602
603 def GetValue(*args, **kwargs):
604 """
605 GetValue(self) -> String
606
607 Returns the current value in the combobox text field.
608 """
609 return _controls_.ComboBox_GetValue(*args, **kwargs)
610
611 def SetValue(*args, **kwargs):
612 """SetValue(self, String value)"""
613 return _controls_.ComboBox_SetValue(*args, **kwargs)
614
615 def Copy(*args, **kwargs):
616 """
617 Copy(self)
618
619 Copies the selected text to the clipboard.
620 """
621 return _controls_.ComboBox_Copy(*args, **kwargs)
622
623 def Cut(*args, **kwargs):
624 """
625 Cut(self)
626
627 Copies the selected text to the clipboard and removes the selection.
628 """
629 return _controls_.ComboBox_Cut(*args, **kwargs)
630
631 def Paste(*args, **kwargs):
632 """
633 Paste(self)
634
635 Pastes text from the clipboard to the text field.
636 """
637 return _controls_.ComboBox_Paste(*args, **kwargs)
638
639 def SetInsertionPoint(*args, **kwargs):
640 """
641 SetInsertionPoint(self, long pos)
642
643 Sets the insertion point in the combobox text field.
644 """
645 return _controls_.ComboBox_SetInsertionPoint(*args, **kwargs)
646
647 def GetInsertionPoint(*args, **kwargs):
648 """
649 GetInsertionPoint(self) -> long
650
651 Returns the insertion point for the combobox's text field.
652 """
653 return _controls_.ComboBox_GetInsertionPoint(*args, **kwargs)
654
655 def GetLastPosition(*args, **kwargs):
656 """
657 GetLastPosition(self) -> long
658
659 Returns the last position in the combobox text field.
660 """
661 return _controls_.ComboBox_GetLastPosition(*args, **kwargs)
662
663 def Replace(*args, **kwargs):
664 """
665 Replace(self, long from, long to, String value)
666
667 Replaces the text between two positions with the given text, in the
668 combobox text field.
669 """
670 return _controls_.ComboBox_Replace(*args, **kwargs)
671
672 def SetMark(*args, **kwargs):
673 """
674 SetMark(self, long from, long to)
675
676 Selects the text between the two positions in the combobox text field.
677 """
678 return _controls_.ComboBox_SetMark(*args, **kwargs)
679
680 def GetMark(*args, **kwargs):
681 """
682 GetMark(self) -> (from, to)
683
684 Gets the positions of the begining and ending of the selection mark in
685 the combobox text field.
686 """
687 return _controls_.ComboBox_GetMark(*args, **kwargs)
688
689 def GetCurrentSelection(*args, **kwargs):
690 """
691 GetCurrentSelection(self) -> int
692
693 Unlike `GetSelection` which only returns the accepted selection value,
694 i.e. the selection in the control once the user closes the dropdown
695 list, this function returns the current selection. That is, while the
696 dropdown list is shown, it returns the currently selected item in
697 it. When it is not shown, its result is the same as for the other
698 function.
699 """
700 return _controls_.ComboBox_GetCurrentSelection(*args, **kwargs)
701
702 def SetStringSelection(*args, **kwargs):
703 """
704 SetStringSelection(self, String string) -> bool
705
706 Select the item with the specifed string
707 """
708 return _controls_.ComboBox_SetStringSelection(*args, **kwargs)
709
710 def SetEditable(*args, **kwargs):
711 """SetEditable(self, bool editable)"""
712 return _controls_.ComboBox_SetEditable(*args, **kwargs)
713
714 def SetInsertionPointEnd(*args, **kwargs):
715 """
716 SetInsertionPointEnd(self)
717
718 Sets the insertion point at the end of the combobox text field.
719 """
720 return _controls_.ComboBox_SetInsertionPointEnd(*args, **kwargs)
721
722 def Remove(*args, **kwargs):
723 """
724 Remove(self, long from, long to)
725
726 Removes the text between the two positions in the combobox text field.
727 """
728 return _controls_.ComboBox_Remove(*args, **kwargs)
729
730 def IsEditable(*args, **kwargs):
731 """
732 IsEditable(self) -> bool
733
734 Returns True if the combo is ediatable (not read-only.)
735 """
736 return _controls_.ComboBox_IsEditable(*args, **kwargs)
737
738 def Undo(*args, **kwargs):
739 """
740 Undo(self)
741
742 Redoes the last undo in the text field. Windows only.
743 """
744 return _controls_.ComboBox_Undo(*args, **kwargs)
745
746 def Redo(*args, **kwargs):
747 """
748 Redo(self)
749
750 Undoes the last edit in the text field. Windows only.
751 """
752 return _controls_.ComboBox_Redo(*args, **kwargs)
753
754 def SelectAll(*args, **kwargs):
755 """
756 SelectAll(self)
757
758 Select all the text in the combo's text field.
759 """
760 return _controls_.ComboBox_SelectAll(*args, **kwargs)
761
762 def CanCopy(*args, **kwargs):
763 """
764 CanCopy(self) -> bool
765
766 Returns True if the combobox is editable and there is a text selection
767 to copy to the clipboard. Only available on Windows.
768 """
769 return _controls_.ComboBox_CanCopy(*args, **kwargs)
770
771 def CanCut(*args, **kwargs):
772 """
773 CanCut(self) -> bool
774
775 Returns True if the combobox is editable and there is a text selection
776 to copy to the clipboard. Only available on Windows.
777 """
778 return _controls_.ComboBox_CanCut(*args, **kwargs)
779
780 def CanPaste(*args, **kwargs):
781 """
782 CanPaste(self) -> bool
783
784 Returns True if the combobox is editable and there is text on the
785 clipboard that can be pasted into the text field. Only available on
786 Windows.
787 """
788 return _controls_.ComboBox_CanPaste(*args, **kwargs)
789
790 def CanUndo(*args, **kwargs):
791 """
792 CanUndo(self) -> bool
793
794 Returns True if the combobox is editable and the last edit can be
795 undone. Only available on Windows.
796 """
797 return _controls_.ComboBox_CanUndo(*args, **kwargs)
798
799 def CanRedo(*args, **kwargs):
800 """
801 CanRedo(self) -> bool
802
803 Returns True if the combobox is editable and the last undo can be
804 redone. Only available on Windows.
805 """
806 return _controls_.ComboBox_CanRedo(*args, **kwargs)
807
808 def GetClassDefaultAttributes(*args, **kwargs):
809 """
810 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
811
812 Get the default attributes for this class. This is useful if you want
813 to use the same font or colour in your own control as in a standard
814 control -- which is a much better idea than hard coding specific
815 colours or fonts which might look completely out of place on the
816 user's system, especially if it uses themes.
817
818 The variant parameter is only relevant under Mac currently and is
819 ignore under other platforms. Under Mac, it will change the size of
820 the returned font. See `wx.Window.SetWindowVariant` for more about
821 this.
822 """
823 return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs)
824
825 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
826 CurrentSelection = property(GetCurrentSelection,doc="See `GetCurrentSelection`")
827 InsertionPoint = property(GetInsertionPoint,SetInsertionPoint,doc="See `GetInsertionPoint` and `SetInsertionPoint`")
828 LastPosition = property(GetLastPosition,doc="See `GetLastPosition`")
829 Mark = property(GetMark,SetMark,doc="See `GetMark` and `SetMark`")
830 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
831 _controls_.ComboBox_swigregister(ComboBox)
832 ComboBoxNameStr = cvar.ComboBoxNameStr
833
834 def PreComboBox(*args, **kwargs):
835 """
836 PreComboBox() -> ComboBox
837
838 Precreate a ComboBox control for 2-phase creation.
839 """
840 val = _controls_.new_PreComboBox(*args, **kwargs)
841 return val
842
843 def ComboBox_GetClassDefaultAttributes(*args, **kwargs):
844 """
845 ComboBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
846
847 Get the default attributes for this class. This is useful if you want
848 to use the same font or colour in your own control as in a standard
849 control -- which is a much better idea than hard coding specific
850 colours or fonts which might look completely out of place on the
851 user's system, especially if it uses themes.
852
853 The variant parameter is only relevant under Mac currently and is
854 ignore under other platforms. Under Mac, it will change the size of
855 the returned font. See `wx.Window.SetWindowVariant` for more about
856 this.
857 """
858 return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs)
859
860 #---------------------------------------------------------------------------
861
862 GA_HORIZONTAL = _controls_.GA_HORIZONTAL
863 GA_VERTICAL = _controls_.GA_VERTICAL
864 GA_SMOOTH = _controls_.GA_SMOOTH
865 GA_PROGRESSBAR = 0 # obsolete
866 class Gauge(_core.Control):
867 """Proxy of C++ Gauge class"""
868 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
869 __repr__ = _swig_repr
870 def __init__(self, *args, **kwargs):
871 """
872 __init__(self, Window parent, int id=-1, int range=100, Point pos=DefaultPosition,
873 Size size=DefaultSize, long style=GA_HORIZONTAL,
874 Validator validator=DefaultValidator,
875 String name=GaugeNameStr) -> Gauge
876 """
877 _controls_.Gauge_swiginit(self,_controls_.new_Gauge(*args, **kwargs))
878 self._setOORInfo(self)
879
880 def Create(*args, **kwargs):
881 """
882 Create(self, Window parent, int id=-1, int range=100, Point pos=DefaultPosition,
883 Size size=DefaultSize, long style=GA_HORIZONTAL,
884 Validator validator=DefaultValidator,
885 String name=GaugeNameStr) -> bool
886 """
887 return _controls_.Gauge_Create(*args, **kwargs)
888
889 def SetRange(*args, **kwargs):
890 """SetRange(self, int range)"""
891 return _controls_.Gauge_SetRange(*args, **kwargs)
892
893 def GetRange(*args, **kwargs):
894 """GetRange(self) -> int"""
895 return _controls_.Gauge_GetRange(*args, **kwargs)
896
897 def SetValue(*args, **kwargs):
898 """SetValue(self, int pos)"""
899 return _controls_.Gauge_SetValue(*args, **kwargs)
900
901 def GetValue(*args, **kwargs):
902 """GetValue(self) -> int"""
903 return _controls_.Gauge_GetValue(*args, **kwargs)
904
905 def Pulse(*args, **kwargs):
906 """Pulse(self)"""
907 return _controls_.Gauge_Pulse(*args, **kwargs)
908
909 def IsVertical(*args, **kwargs):
910 """IsVertical(self) -> bool"""
911 return _controls_.Gauge_IsVertical(*args, **kwargs)
912
913 def SetShadowWidth(*args, **kwargs):
914 """SetShadowWidth(self, int w)"""
915 return _controls_.Gauge_SetShadowWidth(*args, **kwargs)
916
917 def GetShadowWidth(*args, **kwargs):
918 """GetShadowWidth(self) -> int"""
919 return _controls_.Gauge_GetShadowWidth(*args, **kwargs)
920
921 def SetBezelFace(*args, **kwargs):
922 """SetBezelFace(self, int w)"""
923 return _controls_.Gauge_SetBezelFace(*args, **kwargs)
924
925 def GetBezelFace(*args, **kwargs):
926 """GetBezelFace(self) -> int"""
927 return _controls_.Gauge_GetBezelFace(*args, **kwargs)
928
929 def GetClassDefaultAttributes(*args, **kwargs):
930 """
931 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
932
933 Get the default attributes for this class. This is useful if you want
934 to use the same font or colour in your own control as in a standard
935 control -- which is a much better idea than hard coding specific
936 colours or fonts which might look completely out of place on the
937 user's system, especially if it uses themes.
938
939 The variant parameter is only relevant under Mac currently and is
940 ignore under other platforms. Under Mac, it will change the size of
941 the returned font. See `wx.Window.SetWindowVariant` for more about
942 this.
943 """
944 return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs)
945
946 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
947 BezelFace = property(GetBezelFace,SetBezelFace,doc="See `GetBezelFace` and `SetBezelFace`")
948 Range = property(GetRange,SetRange,doc="See `GetRange` and `SetRange`")
949 ShadowWidth = property(GetShadowWidth,SetShadowWidth,doc="See `GetShadowWidth` and `SetShadowWidth`")
950 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
951 _controls_.Gauge_swigregister(Gauge)
952 GaugeNameStr = cvar.GaugeNameStr
953
954 def PreGauge(*args, **kwargs):
955 """PreGauge() -> Gauge"""
956 val = _controls_.new_PreGauge(*args, **kwargs)
957 return val
958
959 def Gauge_GetClassDefaultAttributes(*args, **kwargs):
960 """
961 Gauge_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
962
963 Get the default attributes for this class. This is useful if you want
964 to use the same font or colour in your own control as in a standard
965 control -- which is a much better idea than hard coding specific
966 colours or fonts which might look completely out of place on the
967 user's system, especially if it uses themes.
968
969 The variant parameter is only relevant under Mac currently and is
970 ignore under other platforms. Under Mac, it will change the size of
971 the returned font. See `wx.Window.SetWindowVariant` for more about
972 this.
973 """
974 return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs)
975
976 #---------------------------------------------------------------------------
977
978 class StaticBox(_core.Control):
979 """Proxy of C++ StaticBox class"""
980 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
981 __repr__ = _swig_repr
982 def __init__(self, *args, **kwargs):
983 """
984 __init__(self, Window parent, int id=-1, String label=EmptyString,
985 Point pos=DefaultPosition, Size size=DefaultSize,
986 long style=0, String name=StaticBoxNameStr) -> StaticBox
987 """
988 _controls_.StaticBox_swiginit(self,_controls_.new_StaticBox(*args, **kwargs))
989 self._setOORInfo(self)
990
991 def Create(*args, **kwargs):
992 """
993 Create(self, Window parent, int id=-1, String label=EmptyString,
994 Point pos=DefaultPosition, Size size=DefaultSize,
995 long style=0, String name=StaticBoxNameStr) -> bool
996 """
997 return _controls_.StaticBox_Create(*args, **kwargs)
998
999 def GetClassDefaultAttributes(*args, **kwargs):
1000 """
1001 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
1002
1003 Get the default attributes for this class. This is useful if you want
1004 to use the same font or colour in your own control as in a standard
1005 control -- which is a much better idea than hard coding specific
1006 colours or fonts which might look completely out of place on the
1007 user's system, especially if it uses themes.
1008
1009 The variant parameter is only relevant under Mac currently and is
1010 ignore under other platforms. Under Mac, it will change the size of
1011 the returned font. See `wx.Window.SetWindowVariant` for more about
1012 this.
1013 """
1014 return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs)
1015
1016 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
1017 _controls_.StaticBox_swigregister(StaticBox)
1018 StaticBitmapNameStr = cvar.StaticBitmapNameStr
1019 StaticBoxNameStr = cvar.StaticBoxNameStr
1020 StaticTextNameStr = cvar.StaticTextNameStr
1021 StaticLineNameStr = cvar.StaticLineNameStr
1022
1023 def PreStaticBox(*args, **kwargs):
1024 """PreStaticBox() -> StaticBox"""
1025 val = _controls_.new_PreStaticBox(*args, **kwargs)
1026 return val
1027
1028 def StaticBox_GetClassDefaultAttributes(*args, **kwargs):
1029 """
1030 StaticBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
1031
1032 Get the default attributes for this class. This is useful if you want
1033 to use the same font or colour in your own control as in a standard
1034 control -- which is a much better idea than hard coding specific
1035 colours or fonts which might look completely out of place on the
1036 user's system, especially if it uses themes.
1037
1038 The variant parameter is only relevant under Mac currently and is
1039 ignore under other platforms. Under Mac, it will change the size of
1040 the returned font. See `wx.Window.SetWindowVariant` for more about
1041 this.
1042 """
1043 return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs)
1044
1045 #---------------------------------------------------------------------------
1046
1047 class StaticLine(_core.Control):
1048 """Proxy of C++ StaticLine class"""
1049 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1050 __repr__ = _swig_repr
1051 def __init__(self, *args, **kwargs):
1052 """
1053 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
1054 Size size=DefaultSize, long style=LI_HORIZONTAL,
1055 String name=StaticLineNameStr) -> StaticLine
1056 """
1057 _controls_.StaticLine_swiginit(self,_controls_.new_StaticLine(*args, **kwargs))
1058 self._setOORInfo(self)
1059
1060 def Create(*args, **kwargs):
1061 """
1062 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
1063 Size size=DefaultSize, long style=LI_HORIZONTAL,
1064 String name=StaticLineNameStr) -> bool
1065 """
1066 return _controls_.StaticLine_Create(*args, **kwargs)
1067
1068 def IsVertical(*args, **kwargs):
1069 """IsVertical(self) -> bool"""
1070 return _controls_.StaticLine_IsVertical(*args, **kwargs)
1071
1072 def GetDefaultSize(*args, **kwargs):
1073 """GetDefaultSize() -> int"""
1074 return _controls_.StaticLine_GetDefaultSize(*args, **kwargs)
1075
1076 GetDefaultSize = staticmethod(GetDefaultSize)
1077 def GetClassDefaultAttributes(*args, **kwargs):
1078 """
1079 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
1080
1081 Get the default attributes for this class. This is useful if you want
1082 to use the same font or colour in your own control as in a standard
1083 control -- which is a much better idea than hard coding specific
1084 colours or fonts which might look completely out of place on the
1085 user's system, especially if it uses themes.
1086
1087 The variant parameter is only relevant under Mac currently and is
1088 ignore under other platforms. Under Mac, it will change the size of
1089 the returned font. See `wx.Window.SetWindowVariant` for more about
1090 this.
1091 """
1092 return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs)
1093
1094 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
1095 _controls_.StaticLine_swigregister(StaticLine)
1096
1097 def PreStaticLine(*args, **kwargs):
1098 """PreStaticLine() -> StaticLine"""
1099 val = _controls_.new_PreStaticLine(*args, **kwargs)
1100 return val
1101
1102 def StaticLine_GetDefaultSize(*args):
1103 """StaticLine_GetDefaultSize() -> int"""
1104 return _controls_.StaticLine_GetDefaultSize(*args)
1105
1106 def StaticLine_GetClassDefaultAttributes(*args, **kwargs):
1107 """
1108 StaticLine_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
1109
1110 Get the default attributes for this class. This is useful if you want
1111 to use the same font or colour in your own control as in a standard
1112 control -- which is a much better idea than hard coding specific
1113 colours or fonts which might look completely out of place on the
1114 user's system, especially if it uses themes.
1115
1116 The variant parameter is only relevant under Mac currently and is
1117 ignore under other platforms. Under Mac, it will change the size of
1118 the returned font. See `wx.Window.SetWindowVariant` for more about
1119 this.
1120 """
1121 return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs)
1122
1123 #---------------------------------------------------------------------------
1124
1125 ST_NO_AUTORESIZE = _controls_.ST_NO_AUTORESIZE
1126 ST_MARKUP = _controls_.ST_MARKUP
1127 ST_ELLIPSIZE_START = _controls_.ST_ELLIPSIZE_START
1128 ST_ELLIPSIZE_MIDDLE = _controls_.ST_ELLIPSIZE_MIDDLE
1129 ST_ELLIPSIZE_END = _controls_.ST_ELLIPSIZE_END
1130 class StaticText(_core.Control):
1131 """Proxy of C++ StaticText class"""
1132 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1133 __repr__ = _swig_repr
1134 def __init__(self, *args, **kwargs):
1135 """
1136 __init__(self, Window parent, int id=-1, String label=EmptyString,
1137 Point pos=DefaultPosition, Size size=DefaultSize,
1138 long style=0, String name=StaticTextNameStr) -> StaticText
1139 """
1140 _controls_.StaticText_swiginit(self,_controls_.new_StaticText(*args, **kwargs))
1141 self._setOORInfo(self)
1142
1143 def Create(*args, **kwargs):
1144 """
1145 Create(self, Window parent, int id=-1, String label=EmptyString,
1146 Point pos=DefaultPosition, Size size=DefaultSize,
1147 long style=0, String name=StaticTextNameStr) -> bool
1148 """
1149 return _controls_.StaticText_Create(*args, **kwargs)
1150
1151 def Wrap(*args, **kwargs):
1152 """
1153 Wrap(self, int width)
1154
1155 This functions wraps the control's label so that each of its lines
1156 becomes at most ``width`` pixels wide if possible (the lines are
1157 broken at words boundaries so it might not be the case if words are
1158 too long). If ``width`` is negative, no wrapping is done.
1159 """
1160 return _controls_.StaticText_Wrap(*args, **kwargs)
1161
1162 def IsEllipsized(*args, **kwargs):
1163 """IsEllipsized(self) -> bool"""
1164 return _controls_.StaticText_IsEllipsized(*args, **kwargs)
1165
1166 def RemoveMarkup(*args, **kwargs):
1167 """
1168 RemoveMarkup(String str) -> String
1169
1170 Removes the markup accepted by wx.StaticText when wx.ST_MARKUP is
1171 used, and then returns the cleaned string.
1172
1173 """
1174 return _controls_.StaticText_RemoveMarkup(*args, **kwargs)
1175
1176 RemoveMarkup = staticmethod(RemoveMarkup)
1177 def EscapeMarkup(*args, **kwargs):
1178 """
1179 EscapeMarkup(String str) -> String
1180
1181 Escapes the alls special symbols (<>"'&) present inside the given
1182 string using the corresponding entities (&lt; &gt; &quot; &apos;
1183 &amp;)
1184 """
1185 return _controls_.StaticText_EscapeMarkup(*args, **kwargs)
1186
1187 EscapeMarkup = staticmethod(EscapeMarkup)
1188 def GetClassDefaultAttributes(*args, **kwargs):
1189 """
1190 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
1191
1192 Get the default attributes for this class. This is useful if you want
1193 to use the same font or colour in your own control as in a standard
1194 control -- which is a much better idea than hard coding specific
1195 colours or fonts which might look completely out of place on the
1196 user's system, especially if it uses themes.
1197
1198 The variant parameter is only relevant under Mac currently and is
1199 ignore under other platforms. Under Mac, it will change the size of
1200 the returned font. See `wx.Window.SetWindowVariant` for more about
1201 this.
1202 """
1203 return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs)
1204
1205 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
1206 _controls_.StaticText_swigregister(StaticText)
1207
1208 def PreStaticText(*args, **kwargs):
1209 """PreStaticText() -> StaticText"""
1210 val = _controls_.new_PreStaticText(*args, **kwargs)
1211 return val
1212
1213 def StaticText_RemoveMarkup(*args, **kwargs):
1214 """
1215 StaticText_RemoveMarkup(String str) -> String
1216
1217 Removes the markup accepted by wx.StaticText when wx.ST_MARKUP is
1218 used, and then returns the cleaned string.
1219
1220 """
1221 return _controls_.StaticText_RemoveMarkup(*args, **kwargs)
1222
1223 def StaticText_EscapeMarkup(*args, **kwargs):
1224 """
1225 StaticText_EscapeMarkup(String str) -> String
1226
1227 Escapes the alls special symbols (<>"'&) present inside the given
1228 string using the corresponding entities (&lt; &gt; &quot; &apos;
1229 &amp;)
1230 """
1231 return _controls_.StaticText_EscapeMarkup(*args, **kwargs)
1232
1233 def StaticText_GetClassDefaultAttributes(*args, **kwargs):
1234 """
1235 StaticText_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
1236
1237 Get the default attributes for this class. This is useful if you want
1238 to use the same font or colour in your own control as in a standard
1239 control -- which is a much better idea than hard coding specific
1240 colours or fonts which might look completely out of place on the
1241 user's system, especially if it uses themes.
1242
1243 The variant parameter is only relevant under Mac currently and is
1244 ignore under other platforms. Under Mac, it will change the size of
1245 the returned font. See `wx.Window.SetWindowVariant` for more about
1246 this.
1247 """
1248 return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs)
1249
1250 #---------------------------------------------------------------------------
1251
1252 class StaticBitmap(_core.Control):
1253 """Proxy of C++ StaticBitmap class"""
1254 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1255 __repr__ = _swig_repr
1256 def __init__(self, *args, **kwargs):
1257 """
1258 __init__(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap,
1259 Point pos=DefaultPosition, Size size=DefaultSize,
1260 long style=0, String name=StaticBitmapNameStr) -> StaticBitmap
1261 """
1262 _controls_.StaticBitmap_swiginit(self,_controls_.new_StaticBitmap(*args, **kwargs))
1263 self._setOORInfo(self)
1264
1265 def Create(*args, **kwargs):
1266 """
1267 Create(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap,
1268 Point pos=DefaultPosition, Size size=DefaultSize,
1269 long style=0, String name=StaticBitmapNameStr) -> bool
1270 """
1271 return _controls_.StaticBitmap_Create(*args, **kwargs)
1272
1273 def GetBitmap(*args, **kwargs):
1274 """GetBitmap(self) -> Bitmap"""
1275 return _controls_.StaticBitmap_GetBitmap(*args, **kwargs)
1276
1277 def SetBitmap(*args, **kwargs):
1278 """SetBitmap(self, Bitmap bitmap)"""
1279 return _controls_.StaticBitmap_SetBitmap(*args, **kwargs)
1280
1281 def SetIcon(*args, **kwargs):
1282 """SetIcon(self, Icon icon)"""
1283 return _controls_.StaticBitmap_SetIcon(*args, **kwargs)
1284
1285 def GetClassDefaultAttributes(*args, **kwargs):
1286 """
1287 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
1288
1289 Get the default attributes for this class. This is useful if you want
1290 to use the same font or colour in your own control as in a standard
1291 control -- which is a much better idea than hard coding specific
1292 colours or fonts which might look completely out of place on the
1293 user's system, especially if it uses themes.
1294
1295 The variant parameter is only relevant under Mac currently and is
1296 ignore under other platforms. Under Mac, it will change the size of
1297 the returned font. See `wx.Window.SetWindowVariant` for more about
1298 this.
1299 """
1300 return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs)
1301
1302 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
1303 _controls_.StaticBitmap_swigregister(StaticBitmap)
1304
1305 def PreStaticBitmap(*args, **kwargs):
1306 """PreStaticBitmap() -> StaticBitmap"""
1307 val = _controls_.new_PreStaticBitmap(*args, **kwargs)
1308 return val
1309
1310 def StaticBitmap_GetClassDefaultAttributes(*args, **kwargs):
1311 """
1312 StaticBitmap_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
1313
1314 Get the default attributes for this class. This is useful if you want
1315 to use the same font or colour in your own control as in a standard
1316 control -- which is a much better idea than hard coding specific
1317 colours or fonts which might look completely out of place on the
1318 user's system, especially if it uses themes.
1319
1320 The variant parameter is only relevant under Mac currently and is
1321 ignore under other platforms. Under Mac, it will change the size of
1322 the returned font. See `wx.Window.SetWindowVariant` for more about
1323 this.
1324 """
1325 return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs)
1326
1327 #---------------------------------------------------------------------------
1328
1329 class ListBox(_core.ControlWithItems):
1330 """Proxy of C++ ListBox class"""
1331 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1332 __repr__ = _swig_repr
1333 def __init__(self, *args, **kwargs):
1334 """
1335 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
1336 Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
1337 long style=0, Validator validator=DefaultValidator,
1338 String name=ListBoxNameStr) -> ListBox
1339 """
1340 _controls_.ListBox_swiginit(self,_controls_.new_ListBox(*args, **kwargs))
1341 self._setOORInfo(self)
1342
1343 def Create(*args, **kwargs):
1344 """
1345 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
1346 Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
1347 long style=0, Validator validator=DefaultValidator,
1348 String name=ListBoxNameStr) -> bool
1349 """
1350 return _controls_.ListBox_Create(*args, **kwargs)
1351
1352 def Insert(*args, **kwargs):
1353 """
1354 Insert(self, String item, int pos, PyObject clientData=None)
1355
1356 Insert an item into the control before the item at the ``pos`` index,
1357 optionally associating some data object with the item.
1358 """
1359 return _controls_.ListBox_Insert(*args, **kwargs)
1360
1361 def InsertItems(*args, **kwargs):
1362 """InsertItems(self, wxArrayString items, unsigned int pos)"""
1363 return _controls_.ListBox_InsertItems(*args, **kwargs)
1364
1365 def Set(*args, **kwargs):
1366 """Set(self, wxArrayString items)"""
1367 return _controls_.ListBox_Set(*args, **kwargs)
1368
1369 def IsSelected(*args, **kwargs):
1370 """IsSelected(self, int n) -> bool"""
1371 return _controls_.ListBox_IsSelected(*args, **kwargs)
1372
1373 def SetSelection(*args, **kwargs):
1374 """SetSelection(self, int n, bool select=True)"""
1375 return _controls_.ListBox_SetSelection(*args, **kwargs)
1376
1377 def Select(*args, **kwargs):
1378 """
1379 Select(self, int n)
1380
1381 This is the same as `SetSelection` and exists only because it is
1382 slightly more natural for controls which support multiple selection.
1383 """
1384 return _controls_.ListBox_Select(*args, **kwargs)
1385
1386 def Deselect(*args, **kwargs):
1387 """Deselect(self, int n)"""
1388 return _controls_.ListBox_Deselect(*args, **kwargs)
1389
1390 def DeselectAll(*args, **kwargs):
1391 """DeselectAll(self, int itemToLeaveSelected=-1)"""
1392 return _controls_.ListBox_DeselectAll(*args, **kwargs)
1393
1394 def SetStringSelection(*args, **kwargs):
1395 """SetStringSelection(self, String s, bool select=True) -> bool"""
1396 return _controls_.ListBox_SetStringSelection(*args, **kwargs)
1397
1398 def GetSelections(*args, **kwargs):
1399 """GetSelections(self) -> PyObject"""
1400 return _controls_.ListBox_GetSelections(*args, **kwargs)
1401
1402 def SetFirstItem(*args, **kwargs):
1403 """SetFirstItem(self, int n)"""
1404 return _controls_.ListBox_SetFirstItem(*args, **kwargs)
1405
1406 def SetFirstItemStr(*args, **kwargs):
1407 """SetFirstItemStr(self, String s)"""
1408 return _controls_.ListBox_SetFirstItemStr(*args, **kwargs)
1409
1410 def EnsureVisible(*args, **kwargs):
1411 """EnsureVisible(self, int n)"""
1412 return _controls_.ListBox_EnsureVisible(*args, **kwargs)
1413
1414 def AppendAndEnsureVisible(*args, **kwargs):
1415 """AppendAndEnsureVisible(self, String s)"""
1416 return _controls_.ListBox_AppendAndEnsureVisible(*args, **kwargs)
1417
1418 def IsSorted(*args, **kwargs):
1419 """IsSorted(self) -> bool"""
1420 return _controls_.ListBox_IsSorted(*args, **kwargs)
1421
1422 def HitTest(*args, **kwargs):
1423 """
1424 HitTest(self, Point pt) -> int
1425
1426 Test where the given (in client coords) point lies
1427 """
1428 return _controls_.ListBox_HitTest(*args, **kwargs)
1429
1430 def SetItemForegroundColour(*args, **kwargs):
1431 """SetItemForegroundColour(self, int item, Colour c)"""
1432 return _controls_.ListBox_SetItemForegroundColour(*args, **kwargs)
1433
1434 def SetItemBackgroundColour(*args, **kwargs):
1435 """SetItemBackgroundColour(self, int item, Colour c)"""
1436 return _controls_.ListBox_SetItemBackgroundColour(*args, **kwargs)
1437
1438 def SetItemFont(*args, **kwargs):
1439 """SetItemFont(self, int item, Font f)"""
1440 return _controls_.ListBox_SetItemFont(*args, **kwargs)
1441
1442 def GetClassDefaultAttributes(*args, **kwargs):
1443 """
1444 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
1445
1446 Get the default attributes for this class. This is useful if you want
1447 to use the same font or colour in your own control as in a standard
1448 control -- which is a much better idea than hard coding specific
1449 colours or fonts which might look completely out of place on the
1450 user's system, especially if it uses themes.
1451
1452 The variant parameter is only relevant under Mac currently and is
1453 ignore under other platforms. Under Mac, it will change the size of
1454 the returned font. See `wx.Window.SetWindowVariant` for more about
1455 this.
1456 """
1457 return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs)
1458
1459 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
1460 Selections = property(GetSelections,doc="See `GetSelections`")
1461 _controls_.ListBox_swigregister(ListBox)
1462 ListBoxNameStr = cvar.ListBoxNameStr
1463
1464 def PreListBox(*args, **kwargs):
1465 """PreListBox() -> ListBox"""
1466 val = _controls_.new_PreListBox(*args, **kwargs)
1467 return val
1468
1469 def ListBox_GetClassDefaultAttributes(*args, **kwargs):
1470 """
1471 ListBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
1472
1473 Get the default attributes for this class. This is useful if you want
1474 to use the same font or colour in your own control as in a standard
1475 control -- which is a much better idea than hard coding specific
1476 colours or fonts which might look completely out of place on the
1477 user's system, especially if it uses themes.
1478
1479 The variant parameter is only relevant under Mac currently and is
1480 ignore under other platforms. Under Mac, it will change the size of
1481 the returned font. See `wx.Window.SetWindowVariant` for more about
1482 this.
1483 """
1484 return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs)
1485
1486 #---------------------------------------------------------------------------
1487
1488 class CheckListBox(ListBox):
1489 """Proxy of C++ CheckListBox class"""
1490 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1491 __repr__ = _swig_repr
1492 def __init__(self, *args, **kwargs):
1493 """
1494 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
1495 Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
1496 long style=0, Validator validator=DefaultValidator,
1497 String name=ListBoxNameStr) -> CheckListBox
1498 """
1499 _controls_.CheckListBox_swiginit(self,_controls_.new_CheckListBox(*args, **kwargs))
1500 self._setOORInfo(self)
1501
1502 def Create(*args, **kwargs):
1503 """
1504 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
1505 Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
1506 long style=0, Validator validator=DefaultValidator,
1507 String name=ListBoxNameStr) -> bool
1508 """
1509 return _controls_.CheckListBox_Create(*args, **kwargs)
1510
1511 def IsChecked(*args, **kwargs):
1512 """IsChecked(self, unsigned int index) -> bool"""
1513 return _controls_.CheckListBox_IsChecked(*args, **kwargs)
1514
1515 def Check(*args, **kwargs):
1516 """Check(self, unsigned int index, int check=True)"""
1517 return _controls_.CheckListBox_Check(*args, **kwargs)
1518
1519 def GetItemHeight(*args, **kwargs):
1520 """GetItemHeight(self) -> int"""
1521 return _controls_.CheckListBox_GetItemHeight(*args, **kwargs)
1522
1523 ItemHeight = property(GetItemHeight,doc="See `GetItemHeight`")
1524 _controls_.CheckListBox_swigregister(CheckListBox)
1525
1526 def PreCheckListBox(*args, **kwargs):
1527 """PreCheckListBox() -> CheckListBox"""
1528 val = _controls_.new_PreCheckListBox(*args, **kwargs)
1529 return val
1530
1531 #---------------------------------------------------------------------------
1532
1533 TE_NO_VSCROLL = _controls_.TE_NO_VSCROLL
1534 TE_AUTO_SCROLL = _controls_.TE_AUTO_SCROLL
1535 TE_READONLY = _controls_.TE_READONLY
1536 TE_MULTILINE = _controls_.TE_MULTILINE
1537 TE_PROCESS_TAB = _controls_.TE_PROCESS_TAB
1538 TE_LEFT = _controls_.TE_LEFT
1539 TE_CENTER = _controls_.TE_CENTER
1540 TE_RIGHT = _controls_.TE_RIGHT
1541 TE_CENTRE = _controls_.TE_CENTRE
1542 TE_RICH = _controls_.TE_RICH
1543 TE_PROCESS_ENTER = _controls_.TE_PROCESS_ENTER
1544 TE_PASSWORD = _controls_.TE_PASSWORD
1545 TE_AUTO_URL = _controls_.TE_AUTO_URL
1546 TE_NOHIDESEL = _controls_.TE_NOHIDESEL
1547 TE_DONTWRAP = _controls_.TE_DONTWRAP
1548 TE_CHARWRAP = _controls_.TE_CHARWRAP
1549 TE_WORDWRAP = _controls_.TE_WORDWRAP
1550 TE_BESTWRAP = _controls_.TE_BESTWRAP
1551 TE_RICH2 = _controls_.TE_RICH2
1552 TE_CAPITALIZE = _controls_.TE_CAPITALIZE
1553 TE_LINEWRAP = TE_CHARWRAP
1554 PROCESS_ENTER = TE_PROCESS_ENTER
1555 PASSWORD = TE_PASSWORD
1556
1557 TEXT_ALIGNMENT_DEFAULT = _controls_.TEXT_ALIGNMENT_DEFAULT
1558 TEXT_ALIGNMENT_LEFT = _controls_.TEXT_ALIGNMENT_LEFT
1559 TEXT_ALIGNMENT_CENTRE = _controls_.TEXT_ALIGNMENT_CENTRE
1560 TEXT_ALIGNMENT_CENTER = _controls_.TEXT_ALIGNMENT_CENTER
1561 TEXT_ALIGNMENT_RIGHT = _controls_.TEXT_ALIGNMENT_RIGHT
1562 TEXT_ALIGNMENT_JUSTIFIED = _controls_.TEXT_ALIGNMENT_JUSTIFIED
1563 TEXT_ATTR_TEXT_COLOUR = _controls_.TEXT_ATTR_TEXT_COLOUR
1564 TEXT_ATTR_BACKGROUND_COLOUR = _controls_.TEXT_ATTR_BACKGROUND_COLOUR
1565 TEXT_ATTR_FONT_FACE = _controls_.TEXT_ATTR_FONT_FACE
1566 TEXT_ATTR_FONT_SIZE = _controls_.TEXT_ATTR_FONT_SIZE
1567 TEXT_ATTR_FONT_WEIGHT = _controls_.TEXT_ATTR_FONT_WEIGHT
1568 TEXT_ATTR_FONT_ITALIC = _controls_.TEXT_ATTR_FONT_ITALIC
1569 TEXT_ATTR_FONT_UNDERLINE = _controls_.TEXT_ATTR_FONT_UNDERLINE
1570 TEXT_ATTR_FONT = _controls_.TEXT_ATTR_FONT
1571 TEXT_ATTR_ALIGNMENT = _controls_.TEXT_ATTR_ALIGNMENT
1572 TEXT_ATTR_LEFT_INDENT = _controls_.TEXT_ATTR_LEFT_INDENT
1573 TEXT_ATTR_RIGHT_INDENT = _controls_.TEXT_ATTR_RIGHT_INDENT
1574 TEXT_ATTR_TABS = _controls_.TEXT_ATTR_TABS
1575 TE_HT_UNKNOWN = _controls_.TE_HT_UNKNOWN
1576 TE_HT_BEFORE = _controls_.TE_HT_BEFORE
1577 TE_HT_ON_TEXT = _controls_.TE_HT_ON_TEXT
1578 TE_HT_BELOW = _controls_.TE_HT_BELOW
1579 TE_HT_BEYOND = _controls_.TE_HT_BEYOND
1580 OutOfRangeTextCoord = _controls_.OutOfRangeTextCoord
1581 InvalidTextCoord = _controls_.InvalidTextCoord
1582 TEXT_TYPE_ANY = _controls_.TEXT_TYPE_ANY
1583 class TextAttr(object):
1584 """Proxy of C++ TextAttr class"""
1585 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1586 __repr__ = _swig_repr
1587 def __init__(self, *args, **kwargs):
1588 """
1589 __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour,
1590 Font font=wxNullFont, int alignment=TEXT_ALIGNMENT_DEFAULT) -> TextAttr
1591 """
1592 _controls_.TextAttr_swiginit(self,_controls_.new_TextAttr(*args, **kwargs))
1593 __swig_destroy__ = _controls_.delete_TextAttr
1594 __del__ = lambda self : None;
1595 def Init(*args, **kwargs):
1596 """Init(self)"""
1597 return _controls_.TextAttr_Init(*args, **kwargs)
1598
1599 def Merge(*args, **kwargs):
1600 """Merge(TextAttr base, TextAttr overlay) -> TextAttr"""
1601 return _controls_.TextAttr_Merge(*args, **kwargs)
1602
1603 Merge = staticmethod(Merge)
1604 def SetTextColour(*args, **kwargs):
1605 """SetTextColour(self, Colour colText)"""
1606 return _controls_.TextAttr_SetTextColour(*args, **kwargs)
1607
1608 def SetBackgroundColour(*args, **kwargs):
1609 """SetBackgroundColour(self, Colour colBack)"""
1610 return _controls_.TextAttr_SetBackgroundColour(*args, **kwargs)
1611
1612 def SetFont(*args, **kwargs):
1613 """SetFont(self, Font font, long flags=TEXT_ATTR_FONT)"""
1614 return _controls_.TextAttr_SetFont(*args, **kwargs)
1615
1616 def SetAlignment(*args, **kwargs):
1617 """SetAlignment(self, int alignment)"""
1618 return _controls_.TextAttr_SetAlignment(*args, **kwargs)
1619
1620 def SetTabs(*args, **kwargs):
1621 """SetTabs(self, wxArrayInt tabs)"""
1622 return _controls_.TextAttr_SetTabs(*args, **kwargs)
1623
1624 def SetLeftIndent(*args, **kwargs):
1625 """SetLeftIndent(self, int indent, int subIndent=0)"""
1626 return _controls_.TextAttr_SetLeftIndent(*args, **kwargs)
1627
1628 def SetRightIndent(*args, **kwargs):
1629 """SetRightIndent(self, int indent)"""
1630 return _controls_.TextAttr_SetRightIndent(*args, **kwargs)
1631
1632 def SetFlags(*args, **kwargs):
1633 """SetFlags(self, long flags)"""
1634 return _controls_.TextAttr_SetFlags(*args, **kwargs)
1635
1636 def HasTextColour(*args, **kwargs):
1637 """HasTextColour(self) -> bool"""
1638 return _controls_.TextAttr_HasTextColour(*args, **kwargs)
1639
1640 def HasBackgroundColour(*args, **kwargs):
1641 """HasBackgroundColour(self) -> bool"""
1642 return _controls_.TextAttr_HasBackgroundColour(*args, **kwargs)
1643
1644 def HasFont(*args, **kwargs):
1645 """HasFont(self) -> bool"""
1646 return _controls_.TextAttr_HasFont(*args, **kwargs)
1647
1648 def HasAlignment(*args, **kwargs):
1649 """HasAlignment(self) -> bool"""
1650 return _controls_.TextAttr_HasAlignment(*args, **kwargs)
1651
1652 def HasTabs(*args, **kwargs):
1653 """HasTabs(self) -> bool"""
1654 return _controls_.TextAttr_HasTabs(*args, **kwargs)
1655
1656 def HasLeftIndent(*args, **kwargs):
1657 """HasLeftIndent(self) -> bool"""
1658 return _controls_.TextAttr_HasLeftIndent(*args, **kwargs)
1659
1660 def HasRightIndent(*args, **kwargs):
1661 """HasRightIndent(self) -> bool"""
1662 return _controls_.TextAttr_HasRightIndent(*args, **kwargs)
1663
1664 def HasFlag(*args, **kwargs):
1665 """HasFlag(self, long flag) -> bool"""
1666 return _controls_.TextAttr_HasFlag(*args, **kwargs)
1667
1668 def GetTextColour(*args, **kwargs):
1669 """GetTextColour(self) -> Colour"""
1670 return _controls_.TextAttr_GetTextColour(*args, **kwargs)
1671
1672 def GetBackgroundColour(*args, **kwargs):
1673 """GetBackgroundColour(self) -> Colour"""
1674 return _controls_.TextAttr_GetBackgroundColour(*args, **kwargs)
1675
1676 def GetFont(*args, **kwargs):
1677 """GetFont(self) -> Font"""
1678 return _controls_.TextAttr_GetFont(*args, **kwargs)
1679
1680 def GetAlignment(*args, **kwargs):
1681 """GetAlignment(self) -> int"""
1682 return _controls_.TextAttr_GetAlignment(*args, **kwargs)
1683
1684 def GetTabs(*args, **kwargs):
1685 """GetTabs(self) -> wxArrayInt"""
1686 return _controls_.TextAttr_GetTabs(*args, **kwargs)
1687
1688 def GetLeftIndent(*args, **kwargs):
1689 """GetLeftIndent(self) -> long"""
1690 return _controls_.TextAttr_GetLeftIndent(*args, **kwargs)
1691
1692 def GetLeftSubIndent(*args, **kwargs):
1693 """GetLeftSubIndent(self) -> long"""
1694 return _controls_.TextAttr_GetLeftSubIndent(*args, **kwargs)
1695
1696 def GetRightIndent(*args, **kwargs):
1697 """GetRightIndent(self) -> long"""
1698 return _controls_.TextAttr_GetRightIndent(*args, **kwargs)
1699
1700 def GetFlags(*args, **kwargs):
1701 """GetFlags(self) -> long"""
1702 return _controls_.TextAttr_GetFlags(*args, **kwargs)
1703
1704 def IsDefault(*args, **kwargs):
1705 """IsDefault(self) -> bool"""
1706 return _controls_.TextAttr_IsDefault(*args, **kwargs)
1707
1708 def Combine(*args, **kwargs):
1709 """Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr"""
1710 return _controls_.TextAttr_Combine(*args, **kwargs)
1711
1712 Combine = staticmethod(Combine)
1713 Alignment = property(GetAlignment,SetAlignment,doc="See `GetAlignment` and `SetAlignment`")
1714 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
1715 Flags = property(GetFlags,SetFlags,doc="See `GetFlags` and `SetFlags`")
1716 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
1717 LeftIndent = property(GetLeftIndent,SetLeftIndent,doc="See `GetLeftIndent` and `SetLeftIndent`")
1718 LeftSubIndent = property(GetLeftSubIndent,doc="See `GetLeftSubIndent`")
1719 RightIndent = property(GetRightIndent,SetRightIndent,doc="See `GetRightIndent` and `SetRightIndent`")
1720 Tabs = property(GetTabs,SetTabs,doc="See `GetTabs` and `SetTabs`")
1721 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
1722 _controls_.TextAttr_swigregister(TextAttr)
1723 TextCtrlNameStr = cvar.TextCtrlNameStr
1724
1725 def TextAttr_Merge(*args, **kwargs):
1726 """TextAttr_Merge(TextAttr base, TextAttr overlay) -> TextAttr"""
1727 return _controls_.TextAttr_Merge(*args, **kwargs)
1728
1729 def TextAttr_Combine(*args, **kwargs):
1730 """TextAttr_Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr"""
1731 return _controls_.TextAttr_Combine(*args, **kwargs)
1732
1733 class TextCtrl(_core.Control):
1734 """Proxy of C++ TextCtrl class"""
1735 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1736 __repr__ = _swig_repr
1737 def __init__(self, *args, **kwargs):
1738 """
1739 __init__(self, Window parent, int id=-1, String value=EmptyString,
1740 Point pos=DefaultPosition, Size size=DefaultSize,
1741 long style=0, Validator validator=DefaultValidator,
1742 String name=TextCtrlNameStr) -> TextCtrl
1743 """
1744 _controls_.TextCtrl_swiginit(self,_controls_.new_TextCtrl(*args, **kwargs))
1745 self._setOORInfo(self)
1746
1747 def Create(*args, **kwargs):
1748 """
1749 Create(self, Window parent, int id=-1, String value=EmptyString,
1750 Point pos=DefaultPosition, Size size=DefaultSize,
1751 long style=0, Validator validator=DefaultValidator,
1752 String name=TextCtrlNameStr) -> bool
1753 """
1754 return _controls_.TextCtrl_Create(*args, **kwargs)
1755
1756 def GetValue(*args, **kwargs):
1757 """GetValue(self) -> String"""
1758 return _controls_.TextCtrl_GetValue(*args, **kwargs)
1759
1760 def SetValue(*args, **kwargs):
1761 """SetValue(self, String value)"""
1762 return _controls_.TextCtrl_SetValue(*args, **kwargs)
1763
1764 def IsEmpty(*args, **kwargs):
1765 """IsEmpty(self) -> bool"""
1766 return _controls_.TextCtrl_IsEmpty(*args, **kwargs)
1767
1768 def ChangeValue(*args, **kwargs):
1769 """ChangeValue(self, String value)"""
1770 return _controls_.TextCtrl_ChangeValue(*args, **kwargs)
1771
1772 def GetRange(*args, **kwargs):
1773 """GetRange(self, long from, long to) -> String"""
1774 return _controls_.TextCtrl_GetRange(*args, **kwargs)
1775
1776 def GetLineLength(*args, **kwargs):
1777 """GetLineLength(self, long lineNo) -> int"""
1778 return _controls_.TextCtrl_GetLineLength(*args, **kwargs)
1779
1780 def GetLineText(*args, **kwargs):
1781 """GetLineText(self, long lineNo) -> String"""
1782 return _controls_.TextCtrl_GetLineText(*args, **kwargs)
1783
1784 def GetNumberOfLines(*args, **kwargs):
1785 """GetNumberOfLines(self) -> int"""
1786 return _controls_.TextCtrl_GetNumberOfLines(*args, **kwargs)
1787
1788 def IsModified(*args, **kwargs):
1789 """IsModified(self) -> bool"""
1790 return _controls_.TextCtrl_IsModified(*args, **kwargs)
1791
1792 def IsEditable(*args, **kwargs):
1793 """IsEditable(self) -> bool"""
1794 return _controls_.TextCtrl_IsEditable(*args, **kwargs)
1795
1796 def IsSingleLine(*args, **kwargs):
1797 """IsSingleLine(self) -> bool"""
1798 return _controls_.TextCtrl_IsSingleLine(*args, **kwargs)
1799
1800 def IsMultiLine(*args, **kwargs):
1801 """IsMultiLine(self) -> bool"""
1802 return _controls_.TextCtrl_IsMultiLine(*args, **kwargs)
1803
1804 def GetSelection(*args, **kwargs):
1805 """
1806 GetSelection() -> (from, to)
1807
1808 If the return values from and to are the same, there is no selection.
1809 """
1810 return _controls_.TextCtrl_GetSelection(*args, **kwargs)
1811
1812 def GetStringSelection(*args, **kwargs):
1813 """GetStringSelection(self) -> String"""
1814 return _controls_.TextCtrl_GetStringSelection(*args, **kwargs)
1815
1816 def Clear(*args, **kwargs):
1817 """Clear(self)"""
1818 return _controls_.TextCtrl_Clear(*args, **kwargs)
1819
1820 def Replace(*args, **kwargs):
1821 """Replace(self, long from, long to, String value)"""
1822 return _controls_.TextCtrl_Replace(*args, **kwargs)
1823
1824 def Remove(*args, **kwargs):
1825 """Remove(self, long from, long to)"""
1826 return _controls_.TextCtrl_Remove(*args, **kwargs)
1827
1828 def LoadFile(*args, **kwargs):
1829 """LoadFile(self, String file, int fileType=TEXT_TYPE_ANY) -> bool"""
1830 return _controls_.TextCtrl_LoadFile(*args, **kwargs)
1831
1832 def SaveFile(*args, **kwargs):
1833 """SaveFile(self, String file=EmptyString, int fileType=TEXT_TYPE_ANY) -> bool"""
1834 return _controls_.TextCtrl_SaveFile(*args, **kwargs)
1835
1836 def MarkDirty(*args, **kwargs):
1837 """MarkDirty(self)"""
1838 return _controls_.TextCtrl_MarkDirty(*args, **kwargs)
1839
1840 def DiscardEdits(*args, **kwargs):
1841 """DiscardEdits(self)"""
1842 return _controls_.TextCtrl_DiscardEdits(*args, **kwargs)
1843
1844 def SetModified(*args, **kwargs):
1845 """SetModified(self, bool modified)"""
1846 return _controls_.TextCtrl_SetModified(*args, **kwargs)
1847
1848 def SetMaxLength(*args, **kwargs):
1849 """SetMaxLength(self, unsigned long len)"""
1850 return _controls_.TextCtrl_SetMaxLength(*args, **kwargs)
1851
1852 def WriteText(*args, **kwargs):
1853 """WriteText(self, String text)"""
1854 return _controls_.TextCtrl_WriteText(*args, **kwargs)
1855
1856 def AppendText(*args, **kwargs):
1857 """AppendText(self, String text)"""
1858 return _controls_.TextCtrl_AppendText(*args, **kwargs)
1859
1860 def EmulateKeyPress(*args, **kwargs):
1861 """EmulateKeyPress(self, KeyEvent event) -> bool"""
1862 return _controls_.TextCtrl_EmulateKeyPress(*args, **kwargs)
1863
1864 def SetStyle(*args, **kwargs):
1865 """SetStyle(self, long start, long end, TextAttr style) -> bool"""
1866 return _controls_.TextCtrl_SetStyle(*args, **kwargs)
1867
1868 def GetStyle(*args, **kwargs):
1869 """GetStyle(self, long position, TextAttr style) -> bool"""
1870 return _controls_.TextCtrl_GetStyle(*args, **kwargs)
1871
1872 def SetDefaultStyle(*args, **kwargs):
1873 """SetDefaultStyle(self, TextAttr style) -> bool"""
1874 return _controls_.TextCtrl_SetDefaultStyle(*args, **kwargs)
1875
1876 def GetDefaultStyle(*args, **kwargs):
1877 """GetDefaultStyle(self) -> TextAttr"""
1878 return _controls_.TextCtrl_GetDefaultStyle(*args, **kwargs)
1879
1880 def XYToPosition(*args, **kwargs):
1881 """XYToPosition(self, long x, long y) -> long"""
1882 return _controls_.TextCtrl_XYToPosition(*args, **kwargs)
1883
1884 def PositionToXY(*args, **kwargs):
1885 """PositionToXY(long pos) -> (x, y)"""
1886 return _controls_.TextCtrl_PositionToXY(*args, **kwargs)
1887
1888 def ShowPosition(*args, **kwargs):
1889 """ShowPosition(self, long pos)"""
1890 return _controls_.TextCtrl_ShowPosition(*args, **kwargs)
1891
1892 def HitTest(*args, **kwargs):
1893 """
1894 HitTest(Point pt) -> (result, col, row)
1895
1896 Find the row, col coresponding to the character at the point given in
1897 pixels. NB: pt is in device coords but is not adjusted for the client
1898 area origin nor scrolling.
1899 """
1900 return _controls_.TextCtrl_HitTest(*args, **kwargs)
1901
1902 def HitTestPos(*args, **kwargs):
1903 """
1904 HitTestPos(Point pt) -> (result, position)
1905
1906 Find the character position in the text coresponding to the point
1907 given in pixels. NB: pt is in device coords but is not adjusted for
1908 the client area origin nor scrolling.
1909 """
1910 return _controls_.TextCtrl_HitTestPos(*args, **kwargs)
1911
1912 def Copy(*args, **kwargs):
1913 """Copy(self)"""
1914 return _controls_.TextCtrl_Copy(*args, **kwargs)
1915
1916 def Cut(*args, **kwargs):
1917 """Cut(self)"""
1918 return _controls_.TextCtrl_Cut(*args, **kwargs)
1919
1920 def Paste(*args, **kwargs):
1921 """Paste(self)"""
1922 return _controls_.TextCtrl_Paste(*args, **kwargs)
1923
1924 def CanCopy(*args, **kwargs):
1925 """CanCopy(self) -> bool"""
1926 return _controls_.TextCtrl_CanCopy(*args, **kwargs)
1927
1928 def CanCut(*args, **kwargs):
1929 """CanCut(self) -> bool"""
1930 return _controls_.TextCtrl_CanCut(*args, **kwargs)
1931
1932 def CanPaste(*args, **kwargs):
1933 """CanPaste(self) -> bool"""
1934 return _controls_.TextCtrl_CanPaste(*args, **kwargs)
1935
1936 def Undo(*args, **kwargs):
1937 """Undo(self)"""
1938 return _controls_.TextCtrl_Undo(*args, **kwargs)
1939
1940 def Redo(*args, **kwargs):
1941 """Redo(self)"""
1942 return _controls_.TextCtrl_Redo(*args, **kwargs)
1943
1944 def CanUndo(*args, **kwargs):
1945 """CanUndo(self) -> bool"""
1946 return _controls_.TextCtrl_CanUndo(*args, **kwargs)
1947
1948 def CanRedo(*args, **kwargs):
1949 """CanRedo(self) -> bool"""
1950 return _controls_.TextCtrl_CanRedo(*args, **kwargs)
1951
1952 def SetInsertionPoint(*args, **kwargs):
1953 """SetInsertionPoint(self, long pos)"""
1954 return _controls_.TextCtrl_SetInsertionPoint(*args, **kwargs)
1955
1956 def SetInsertionPointEnd(*args, **kwargs):
1957 """SetInsertionPointEnd(self)"""
1958 return _controls_.TextCtrl_SetInsertionPointEnd(*args, **kwargs)
1959
1960 def GetInsertionPoint(*args, **kwargs):
1961 """GetInsertionPoint(self) -> long"""
1962 return _controls_.TextCtrl_GetInsertionPoint(*args, **kwargs)
1963
1964 def GetLastPosition(*args, **kwargs):
1965 """GetLastPosition(self) -> long"""
1966 return _controls_.TextCtrl_GetLastPosition(*args, **kwargs)
1967
1968 def SetSelection(*args, **kwargs):
1969 """SetSelection(self, long from, long to)"""
1970 return _controls_.TextCtrl_SetSelection(*args, **kwargs)
1971
1972 def SelectAll(*args, **kwargs):
1973 """SelectAll(self)"""
1974 return _controls_.TextCtrl_SelectAll(*args, **kwargs)
1975
1976 def SetEditable(*args, **kwargs):
1977 """SetEditable(self, bool editable)"""
1978 return _controls_.TextCtrl_SetEditable(*args, **kwargs)
1979
1980 def MacCheckSpelling(*args, **kwargs):
1981 """MacCheckSpelling(self, bool check)"""
1982 return _controls_.TextCtrl_MacCheckSpelling(*args, **kwargs)
1983
1984 def SendTextUpdatedEvent(*args, **kwargs):
1985 """SendTextUpdatedEvent(self)"""
1986 return _controls_.TextCtrl_SendTextUpdatedEvent(*args, **kwargs)
1987
1988 def ShowNativeCaret(*args, **kwargs):
1989 """ShowNativeCaret(self, bool show=True) -> bool"""
1990 return _controls_.TextCtrl_ShowNativeCaret(*args, **kwargs)
1991
1992 def HideNativeCaret(*args, **kwargs):
1993 """HideNativeCaret(self) -> bool"""
1994 return _controls_.TextCtrl_HideNativeCaret(*args, **kwargs)
1995
1996 def write(*args, **kwargs):
1997 """write(self, String text)"""
1998 return _controls_.TextCtrl_write(*args, **kwargs)
1999
2000 def GetString(*args, **kwargs):
2001 """GetString(self, long from, long to) -> String"""
2002 return _controls_.TextCtrl_GetString(*args, **kwargs)
2003
2004 def GetClassDefaultAttributes(*args, **kwargs):
2005 """
2006 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2007
2008 Get the default attributes for this class. This is useful if you want
2009 to use the same font or colour in your own control as in a standard
2010 control -- which is a much better idea than hard coding specific
2011 colours or fonts which might look completely out of place on the
2012 user's system, especially if it uses themes.
2013
2014 The variant parameter is only relevant under Mac currently and is
2015 ignore under other platforms. Under Mac, it will change the size of
2016 the returned font. See `wx.Window.SetWindowVariant` for more about
2017 this.
2018 """
2019 return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs)
2020
2021 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2022 DefaultStyle = property(GetDefaultStyle,SetDefaultStyle,doc="See `GetDefaultStyle` and `SetDefaultStyle`")
2023 InsertionPoint = property(GetInsertionPoint,SetInsertionPoint,doc="See `GetInsertionPoint` and `SetInsertionPoint`")
2024 LastPosition = property(GetLastPosition,doc="See `GetLastPosition`")
2025 NumberOfLines = property(GetNumberOfLines,doc="See `GetNumberOfLines`")
2026 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
2027 StringSelection = property(GetStringSelection,doc="See `GetStringSelection`")
2028 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2029 _controls_.TextCtrl_swigregister(TextCtrl)
2030
2031 def PreTextCtrl(*args, **kwargs):
2032 """PreTextCtrl() -> TextCtrl"""
2033 val = _controls_.new_PreTextCtrl(*args, **kwargs)
2034 return val
2035
2036 def TextCtrl_GetClassDefaultAttributes(*args, **kwargs):
2037 """
2038 TextCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2039
2040 Get the default attributes for this class. This is useful if you want
2041 to use the same font or colour in your own control as in a standard
2042 control -- which is a much better idea than hard coding specific
2043 colours or fonts which might look completely out of place on the
2044 user's system, especially if it uses themes.
2045
2046 The variant parameter is only relevant under Mac currently and is
2047 ignore under other platforms. Under Mac, it will change the size of
2048 the returned font. See `wx.Window.SetWindowVariant` for more about
2049 this.
2050 """
2051 return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs)
2052
2053 wxEVT_COMMAND_TEXT_UPDATED = _controls_.wxEVT_COMMAND_TEXT_UPDATED
2054 wxEVT_COMMAND_TEXT_ENTER = _controls_.wxEVT_COMMAND_TEXT_ENTER
2055 wxEVT_COMMAND_TEXT_URL = _controls_.wxEVT_COMMAND_TEXT_URL
2056 wxEVT_COMMAND_TEXT_MAXLEN = _controls_.wxEVT_COMMAND_TEXT_MAXLEN
2057 class TextUrlEvent(_core.CommandEvent):
2058 """Proxy of C++ TextUrlEvent class"""
2059 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2060 __repr__ = _swig_repr
2061 def __init__(self, *args, **kwargs):
2062 """__init__(self, int winid, MouseEvent evtMouse, long start, long end) -> TextUrlEvent"""
2063 _controls_.TextUrlEvent_swiginit(self,_controls_.new_TextUrlEvent(*args, **kwargs))
2064 def GetMouseEvent(*args, **kwargs):
2065 """GetMouseEvent(self) -> MouseEvent"""
2066 return _controls_.TextUrlEvent_GetMouseEvent(*args, **kwargs)
2067
2068 def GetURLStart(*args, **kwargs):
2069 """GetURLStart(self) -> long"""
2070 return _controls_.TextUrlEvent_GetURLStart(*args, **kwargs)
2071
2072 def GetURLEnd(*args, **kwargs):
2073 """GetURLEnd(self) -> long"""
2074 return _controls_.TextUrlEvent_GetURLEnd(*args, **kwargs)
2075
2076 MouseEvent = property(GetMouseEvent,doc="See `GetMouseEvent`")
2077 URLEnd = property(GetURLEnd,doc="See `GetURLEnd`")
2078 URLStart = property(GetURLStart,doc="See `GetURLStart`")
2079 _controls_.TextUrlEvent_swigregister(TextUrlEvent)
2080
2081 EVT_TEXT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_UPDATED, 1)
2082 EVT_TEXT_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TEXT_ENTER, 1)
2083 EVT_TEXT_URL = wx.PyEventBinder( wxEVT_COMMAND_TEXT_URL, 1)
2084 EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1)
2085
2086 #---------------------------------------------------------------------------
2087
2088 class ScrollBar(_core.Control):
2089 """Proxy of C++ ScrollBar class"""
2090 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2091 __repr__ = _swig_repr
2092 def __init__(self, *args, **kwargs):
2093 """
2094 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
2095 Size size=DefaultSize, long style=SB_HORIZONTAL,
2096 Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> ScrollBar
2097 """
2098 _controls_.ScrollBar_swiginit(self,_controls_.new_ScrollBar(*args, **kwargs))
2099 self._setOORInfo(self)
2100
2101 def Create(*args, **kwargs):
2102 """
2103 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
2104 Size size=DefaultSize, long style=SB_HORIZONTAL,
2105 Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> bool
2106
2107 Do the 2nd phase and create the GUI control.
2108 """
2109 return _controls_.ScrollBar_Create(*args, **kwargs)
2110
2111 def GetThumbPosition(*args, **kwargs):
2112 """GetThumbPosition(self) -> int"""
2113 return _controls_.ScrollBar_GetThumbPosition(*args, **kwargs)
2114
2115 def GetThumbSize(*args, **kwargs):
2116 """GetThumbSize(self) -> int"""
2117 return _controls_.ScrollBar_GetThumbSize(*args, **kwargs)
2118
2119 GetThumbLength = GetThumbSize
2120 def GetPageSize(*args, **kwargs):
2121 """GetPageSize(self) -> int"""
2122 return _controls_.ScrollBar_GetPageSize(*args, **kwargs)
2123
2124 def GetRange(*args, **kwargs):
2125 """GetRange(self) -> int"""
2126 return _controls_.ScrollBar_GetRange(*args, **kwargs)
2127
2128 def IsVertical(*args, **kwargs):
2129 """IsVertical(self) -> bool"""
2130 return _controls_.ScrollBar_IsVertical(*args, **kwargs)
2131
2132 def SetThumbPosition(*args, **kwargs):
2133 """SetThumbPosition(self, int viewStart)"""
2134 return _controls_.ScrollBar_SetThumbPosition(*args, **kwargs)
2135
2136 def GetClassDefaultAttributes(*args, **kwargs):
2137 """
2138 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2139
2140 Get the default attributes for this class. This is useful if you want
2141 to use the same font or colour in your own control as in a standard
2142 control -- which is a much better idea than hard coding specific
2143 colours or fonts which might look completely out of place on the
2144 user's system, especially if it uses themes.
2145
2146 The variant parameter is only relevant under Mac currently and is
2147 ignore under other platforms. Under Mac, it will change the size of
2148 the returned font. See `wx.Window.SetWindowVariant` for more about
2149 this.
2150 """
2151 return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs)
2152
2153 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2154 PageSize = property(GetPageSize,doc="See `GetPageSize`")
2155 Range = property(GetRange,doc="See `GetRange`")
2156 ThumbPosition = property(GetThumbPosition,SetThumbPosition,doc="See `GetThumbPosition` and `SetThumbPosition`")
2157 ThumbSize = property(GetThumbSize,doc="See `GetThumbSize`")
2158 _controls_.ScrollBar_swigregister(ScrollBar)
2159 ScrollBarNameStr = cvar.ScrollBarNameStr
2160
2161 def PreScrollBar(*args, **kwargs):
2162 """PreScrollBar() -> ScrollBar"""
2163 val = _controls_.new_PreScrollBar(*args, **kwargs)
2164 return val
2165
2166 def ScrollBar_GetClassDefaultAttributes(*args, **kwargs):
2167 """
2168 ScrollBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2169
2170 Get the default attributes for this class. This is useful if you want
2171 to use the same font or colour in your own control as in a standard
2172 control -- which is a much better idea than hard coding specific
2173 colours or fonts which might look completely out of place on the
2174 user's system, especially if it uses themes.
2175
2176 The variant parameter is only relevant under Mac currently and is
2177 ignore under other platforms. Under Mac, it will change the size of
2178 the returned font. See `wx.Window.SetWindowVariant` for more about
2179 this.
2180 """
2181 return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs)
2182
2183 #---------------------------------------------------------------------------
2184
2185 SP_HORIZONTAL = _controls_.SP_HORIZONTAL
2186 SP_VERTICAL = _controls_.SP_VERTICAL
2187 SP_ARROW_KEYS = _controls_.SP_ARROW_KEYS
2188 SP_WRAP = _controls_.SP_WRAP
2189 class SpinButton(_core.Control):
2190 """Proxy of C++ SpinButton class"""
2191 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2192 __repr__ = _swig_repr
2193 def __init__(self, *args, **kwargs):
2194 """
2195 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
2196 Size size=DefaultSize, long style=SP_HORIZONTAL,
2197 String name=SPIN_BUTTON_NAME) -> SpinButton
2198 """
2199 _controls_.SpinButton_swiginit(self,_controls_.new_SpinButton(*args, **kwargs))
2200 self._setOORInfo(self)
2201
2202 def Create(*args, **kwargs):
2203 """
2204 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
2205 Size size=DefaultSize, long style=SP_HORIZONTAL,
2206 String name=SPIN_BUTTON_NAME) -> bool
2207 """
2208 return _controls_.SpinButton_Create(*args, **kwargs)
2209
2210 def GetValue(*args, **kwargs):
2211 """GetValue(self) -> int"""
2212 return _controls_.SpinButton_GetValue(*args, **kwargs)
2213
2214 def GetMin(*args, **kwargs):
2215 """GetMin(self) -> int"""
2216 return _controls_.SpinButton_GetMin(*args, **kwargs)
2217
2218 def GetMax(*args, **kwargs):
2219 """GetMax(self) -> int"""
2220 return _controls_.SpinButton_GetMax(*args, **kwargs)
2221
2222 def SetValue(*args, **kwargs):
2223 """SetValue(self, int val)"""
2224 return _controls_.SpinButton_SetValue(*args, **kwargs)
2225
2226 def SetMin(*args, **kwargs):
2227 """SetMin(self, int minVal)"""
2228 return _controls_.SpinButton_SetMin(*args, **kwargs)
2229
2230 def SetMax(*args, **kwargs):
2231 """SetMax(self, int maxVal)"""
2232 return _controls_.SpinButton_SetMax(*args, **kwargs)
2233
2234 def SetRange(*args, **kwargs):
2235 """SetRange(self, int minVal, int maxVal)"""
2236 return _controls_.SpinButton_SetRange(*args, **kwargs)
2237
2238 def IsVertical(*args, **kwargs):
2239 """IsVertical(self) -> bool"""
2240 return _controls_.SpinButton_IsVertical(*args, **kwargs)
2241
2242 def GetClassDefaultAttributes(*args, **kwargs):
2243 """
2244 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2245
2246 Get the default attributes for this class. This is useful if you want
2247 to use the same font or colour in your own control as in a standard
2248 control -- which is a much better idea than hard coding specific
2249 colours or fonts which might look completely out of place on the
2250 user's system, especially if it uses themes.
2251
2252 The variant parameter is only relevant under Mac currently and is
2253 ignore under other platforms. Under Mac, it will change the size of
2254 the returned font. See `wx.Window.SetWindowVariant` for more about
2255 this.
2256 """
2257 return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs)
2258
2259 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2260 Max = property(GetMax,SetMax,doc="See `GetMax` and `SetMax`")
2261 Min = property(GetMin,SetMin,doc="See `GetMin` and `SetMin`")
2262 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2263 _controls_.SpinButton_swigregister(SpinButton)
2264 SPIN_BUTTON_NAME = cvar.SPIN_BUTTON_NAME
2265 SpinCtrlNameStr = cvar.SpinCtrlNameStr
2266
2267 def PreSpinButton(*args, **kwargs):
2268 """PreSpinButton() -> SpinButton"""
2269 val = _controls_.new_PreSpinButton(*args, **kwargs)
2270 return val
2271
2272 def SpinButton_GetClassDefaultAttributes(*args, **kwargs):
2273 """
2274 SpinButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2275
2276 Get the default attributes for this class. This is useful if you want
2277 to use the same font or colour in your own control as in a standard
2278 control -- which is a much better idea than hard coding specific
2279 colours or fonts which might look completely out of place on the
2280 user's system, especially if it uses themes.
2281
2282 The variant parameter is only relevant under Mac currently and is
2283 ignore under other platforms. Under Mac, it will change the size of
2284 the returned font. See `wx.Window.SetWindowVariant` for more about
2285 this.
2286 """
2287 return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs)
2288
2289 class SpinCtrl(_core.Control):
2290 """Proxy of C++ SpinCtrl class"""
2291 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2292 __repr__ = _swig_repr
2293 def __init__(self, *args, **kwargs):
2294 """
2295 __init__(self, Window parent, int id=-1, String value=EmptyString,
2296 Point pos=DefaultPosition, Size size=DefaultSize,
2297 long style=SP_ARROW_KEYS, int min=0, int max=100,
2298 int initial=0, String name=SpinCtrlNameStr) -> SpinCtrl
2299 """
2300 _controls_.SpinCtrl_swiginit(self,_controls_.new_SpinCtrl(*args, **kwargs))
2301 self._setOORInfo(self)
2302
2303 def Create(*args, **kwargs):
2304 """
2305 Create(self, Window parent, int id=-1, String value=EmptyString,
2306 Point pos=DefaultPosition, Size size=DefaultSize,
2307 long style=SP_ARROW_KEYS, int min=0, int max=100,
2308 int initial=0, String name=SpinCtrlNameStr) -> bool
2309 """
2310 return _controls_.SpinCtrl_Create(*args, **kwargs)
2311
2312 def GetValue(*args, **kwargs):
2313 """GetValue(self) -> int"""
2314 return _controls_.SpinCtrl_GetValue(*args, **kwargs)
2315
2316 def SetValue(*args, **kwargs):
2317 """SetValue(self, int value)"""
2318 return _controls_.SpinCtrl_SetValue(*args, **kwargs)
2319
2320 def SetValueString(*args, **kwargs):
2321 """SetValueString(self, String text)"""
2322 return _controls_.SpinCtrl_SetValueString(*args, **kwargs)
2323
2324 def SetRange(*args, **kwargs):
2325 """SetRange(self, int minVal, int maxVal)"""
2326 return _controls_.SpinCtrl_SetRange(*args, **kwargs)
2327
2328 def GetMin(*args, **kwargs):
2329 """GetMin(self) -> int"""
2330 return _controls_.SpinCtrl_GetMin(*args, **kwargs)
2331
2332 def GetMax(*args, **kwargs):
2333 """GetMax(self) -> int"""
2334 return _controls_.SpinCtrl_GetMax(*args, **kwargs)
2335
2336 def SetSelection(*args, **kwargs):
2337 """SetSelection(self, long from, long to)"""
2338 return _controls_.SpinCtrl_SetSelection(*args, **kwargs)
2339
2340 def GetClassDefaultAttributes(*args, **kwargs):
2341 """
2342 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2343
2344 Get the default attributes for this class. This is useful if you want
2345 to use the same font or colour in your own control as in a standard
2346 control -- which is a much better idea than hard coding specific
2347 colours or fonts which might look completely out of place on the
2348 user's system, especially if it uses themes.
2349
2350 The variant parameter is only relevant under Mac currently and is
2351 ignore under other platforms. Under Mac, it will change the size of
2352 the returned font. See `wx.Window.SetWindowVariant` for more about
2353 this.
2354 """
2355 return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs)
2356
2357 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2358 Max = property(GetMax,doc="See `GetMax`")
2359 Min = property(GetMin,doc="See `GetMin`")
2360 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2361 _controls_.SpinCtrl_swigregister(SpinCtrl)
2362
2363 def PreSpinCtrl(*args, **kwargs):
2364 """PreSpinCtrl() -> SpinCtrl"""
2365 val = _controls_.new_PreSpinCtrl(*args, **kwargs)
2366 return val
2367
2368 def SpinCtrl_GetClassDefaultAttributes(*args, **kwargs):
2369 """
2370 SpinCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2371
2372 Get the default attributes for this class. This is useful if you want
2373 to use the same font or colour in your own control as in a standard
2374 control -- which is a much better idea than hard coding specific
2375 colours or fonts which might look completely out of place on the
2376 user's system, especially if it uses themes.
2377
2378 The variant parameter is only relevant under Mac currently and is
2379 ignore under other platforms. Under Mac, it will change the size of
2380 the returned font. See `wx.Window.SetWindowVariant` for more about
2381 this.
2382 """
2383 return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs)
2384
2385 class SpinEvent(_core.NotifyEvent):
2386 """Proxy of C++ SpinEvent class"""
2387 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2388 __repr__ = _swig_repr
2389 def __init__(self, *args, **kwargs):
2390 """__init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> SpinEvent"""
2391 _controls_.SpinEvent_swiginit(self,_controls_.new_SpinEvent(*args, **kwargs))
2392 def GetPosition(*args, **kwargs):
2393 """GetPosition(self) -> int"""
2394 return _controls_.SpinEvent_GetPosition(*args, **kwargs)
2395
2396 def SetPosition(*args, **kwargs):
2397 """SetPosition(self, int pos)"""
2398 return _controls_.SpinEvent_SetPosition(*args, **kwargs)
2399
2400 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2401 _controls_.SpinEvent_swigregister(SpinEvent)
2402
2403 wxEVT_COMMAND_SPINCTRL_UPDATED = _controls_.wxEVT_COMMAND_SPINCTRL_UPDATED
2404 EVT_SPIN_UP = wx.PyEventBinder( wx.wxEVT_SCROLL_LINEUP, 1)
2405 EVT_SPIN_DOWN = wx.PyEventBinder( wx.wxEVT_SCROLL_LINEDOWN, 1)
2406 EVT_SPIN = wx.PyEventBinder( wx.wxEVT_SCROLL_THUMBTRACK, 1)
2407 EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1)
2408
2409 #---------------------------------------------------------------------------
2410
2411 class RadioBox(_core.Control):
2412 """Proxy of C++ RadioBox class"""
2413 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2414 __repr__ = _swig_repr
2415 def __init__(self, *args, **kwargs):
2416 """
2417 __init__(self, Window parent, int id=-1, String label=EmptyString,
2418 Point pos=DefaultPosition, Size size=DefaultSize,
2419 wxArrayString choices=wxPyEmptyStringArray,
2420 int majorDimension=0, long style=RA_HORIZONTAL,
2421 Validator validator=DefaultValidator,
2422 String name=RadioBoxNameStr) -> RadioBox
2423 """
2424 if kwargs.has_key('point'): kwargs['pos'] = kwargs['point'];del kwargs['point']
2425 _controls_.RadioBox_swiginit(self,_controls_.new_RadioBox(*args, **kwargs))
2426 self._setOORInfo(self)
2427
2428 def Create(*args, **kwargs):
2429 """
2430 Create(self, Window parent, int id=-1, String label=EmptyString,
2431 Point pos=DefaultPosition, Size size=DefaultSize,
2432 wxArrayString choices=wxPyEmptyStringArray,
2433 int majorDimension=0, long style=RA_HORIZONTAL,
2434 Validator validator=DefaultValidator,
2435 String name=RadioBoxNameStr) -> bool
2436 """
2437 return _controls_.RadioBox_Create(*args, **kwargs)
2438
2439 def SetSelection(*args, **kwargs):
2440 """SetSelection(self, int n)"""
2441 return _controls_.RadioBox_SetSelection(*args, **kwargs)
2442
2443 def GetSelection(*args, **kwargs):
2444 """GetSelection(self) -> int"""
2445 return _controls_.RadioBox_GetSelection(*args, **kwargs)
2446
2447 def GetStringSelection(*args, **kwargs):
2448 """GetStringSelection(self) -> String"""
2449 return _controls_.RadioBox_GetStringSelection(*args, **kwargs)
2450
2451 def SetStringSelection(*args, **kwargs):
2452 """SetStringSelection(self, String s) -> bool"""
2453 return _controls_.RadioBox_SetStringSelection(*args, **kwargs)
2454
2455 def GetCount(*args, **kwargs):
2456 """GetCount(self) -> size_t"""
2457 return _controls_.RadioBox_GetCount(*args, **kwargs)
2458
2459 def FindString(*args, **kwargs):
2460 """FindString(self, String s) -> int"""
2461 return _controls_.RadioBox_FindString(*args, **kwargs)
2462
2463 def GetString(*args, **kwargs):
2464 """GetString(self, int n) -> String"""
2465 return _controls_.RadioBox_GetString(*args, **kwargs)
2466
2467 def SetString(*args, **kwargs):
2468 """SetString(self, int n, String label)"""
2469 return _controls_.RadioBox_SetString(*args, **kwargs)
2470
2471 GetItemLabel = GetString
2472 SetItemLabel = SetString
2473 def EnableItem(*args, **kwargs):
2474 """EnableItem(self, unsigned int n, bool enable=True)"""
2475 return _controls_.RadioBox_EnableItem(*args, **kwargs)
2476
2477 def ShowItem(*args, **kwargs):
2478 """ShowItem(self, unsigned int n, bool show=True)"""
2479 return _controls_.RadioBox_ShowItem(*args, **kwargs)
2480
2481 def IsItemEnabled(*args, **kwargs):
2482 """IsItemEnabled(self, unsigned int n) -> bool"""
2483 return _controls_.RadioBox_IsItemEnabled(*args, **kwargs)
2484
2485 def IsItemShown(*args, **kwargs):
2486 """IsItemShown(self, unsigned int n) -> bool"""
2487 return _controls_.RadioBox_IsItemShown(*args, **kwargs)
2488
2489 def GetColumnCount(*args, **kwargs):
2490 """GetColumnCount(self) -> unsigned int"""
2491 return _controls_.RadioBox_GetColumnCount(*args, **kwargs)
2492
2493 def GetRowCount(*args, **kwargs):
2494 """GetRowCount(self) -> unsigned int"""
2495 return _controls_.RadioBox_GetRowCount(*args, **kwargs)
2496
2497 def GetNextItem(*args, **kwargs):
2498 """GetNextItem(self, int item, int dir, long style) -> int"""
2499 return _controls_.RadioBox_GetNextItem(*args, **kwargs)
2500
2501 def SetItemToolTip(*args, **kwargs):
2502 """SetItemToolTip(self, unsigned int item, String text)"""
2503 return _controls_.RadioBox_SetItemToolTip(*args, **kwargs)
2504
2505 def GetItemToolTip(*args, **kwargs):
2506 """GetItemToolTip(self, unsigned int item) -> ToolTip"""
2507 return _controls_.RadioBox_GetItemToolTip(*args, **kwargs)
2508
2509 def SetItemHelpText(*args, **kwargs):
2510 """SetItemHelpText(self, unsigned int n, String helpText)"""
2511 return _controls_.RadioBox_SetItemHelpText(*args, **kwargs)
2512
2513 def GetItemHelpText(*args, **kwargs):
2514 """GetItemHelpText(self, unsigned int n) -> String"""
2515 return _controls_.RadioBox_GetItemHelpText(*args, **kwargs)
2516
2517 def GetClassDefaultAttributes(*args, **kwargs):
2518 """
2519 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2520
2521 Get the default attributes for this class. This is useful if you want
2522 to use the same font or colour in your own control as in a standard
2523 control -- which is a much better idea than hard coding specific
2524 colours or fonts which might look completely out of place on the
2525 user's system, especially if it uses themes.
2526
2527 The variant parameter is only relevant under Mac currently and is
2528 ignore under other platforms. Under Mac, it will change the size of
2529 the returned font. See `wx.Window.SetWindowVariant` for more about
2530 this.
2531 """
2532 return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs)
2533
2534 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2535 ColumnCount = property(GetColumnCount,doc="See `GetColumnCount`")
2536 Count = property(GetCount,doc="See `GetCount`")
2537 RowCount = property(GetRowCount,doc="See `GetRowCount`")
2538 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
2539 StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`")
2540 _controls_.RadioBox_swigregister(RadioBox)
2541 RadioBoxNameStr = cvar.RadioBoxNameStr
2542 RadioButtonNameStr = cvar.RadioButtonNameStr
2543
2544 def PreRadioBox(*args, **kwargs):
2545 """PreRadioBox() -> RadioBox"""
2546 val = _controls_.new_PreRadioBox(*args, **kwargs)
2547 return val
2548
2549 def RadioBox_GetClassDefaultAttributes(*args, **kwargs):
2550 """
2551 RadioBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2552
2553 Get the default attributes for this class. This is useful if you want
2554 to use the same font or colour in your own control as in a standard
2555 control -- which is a much better idea than hard coding specific
2556 colours or fonts which might look completely out of place on the
2557 user's system, especially if it uses themes.
2558
2559 The variant parameter is only relevant under Mac currently and is
2560 ignore under other platforms. Under Mac, it will change the size of
2561 the returned font. See `wx.Window.SetWindowVariant` for more about
2562 this.
2563 """
2564 return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs)
2565
2566 #---------------------------------------------------------------------------
2567
2568 class RadioButton(_core.Control):
2569 """Proxy of C++ RadioButton class"""
2570 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2571 __repr__ = _swig_repr
2572 def __init__(self, *args, **kwargs):
2573 """
2574 __init__(self, Window parent, int id=-1, String label=EmptyString,
2575 Point pos=DefaultPosition, Size size=DefaultSize,
2576 long style=0, Validator validator=DefaultValidator,
2577 String name=RadioButtonNameStr) -> RadioButton
2578 """
2579 _controls_.RadioButton_swiginit(self,_controls_.new_RadioButton(*args, **kwargs))
2580 self._setOORInfo(self)
2581
2582 def Create(*args, **kwargs):
2583 """
2584 Create(self, Window parent, int id=-1, String label=EmptyString,
2585 Point pos=DefaultPosition, Size size=DefaultSize,
2586 long style=0, Validator validator=DefaultValidator,
2587 String name=RadioButtonNameStr) -> bool
2588 """
2589 return _controls_.RadioButton_Create(*args, **kwargs)
2590
2591 def GetValue(*args, **kwargs):
2592 """GetValue(self) -> bool"""
2593 return _controls_.RadioButton_GetValue(*args, **kwargs)
2594
2595 def SetValue(*args, **kwargs):
2596 """SetValue(self, bool value)"""
2597 return _controls_.RadioButton_SetValue(*args, **kwargs)
2598
2599 def GetClassDefaultAttributes(*args, **kwargs):
2600 """
2601 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2602
2603 Get the default attributes for this class. This is useful if you want
2604 to use the same font or colour in your own control as in a standard
2605 control -- which is a much better idea than hard coding specific
2606 colours or fonts which might look completely out of place on the
2607 user's system, especially if it uses themes.
2608
2609 The variant parameter is only relevant under Mac currently and is
2610 ignore under other platforms. Under Mac, it will change the size of
2611 the returned font. See `wx.Window.SetWindowVariant` for more about
2612 this.
2613 """
2614 return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs)
2615
2616 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2617 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2618 _controls_.RadioButton_swigregister(RadioButton)
2619
2620 def PreRadioButton(*args, **kwargs):
2621 """PreRadioButton() -> RadioButton"""
2622 val = _controls_.new_PreRadioButton(*args, **kwargs)
2623 return val
2624
2625 def RadioButton_GetClassDefaultAttributes(*args, **kwargs):
2626 """
2627 RadioButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2628
2629 Get the default attributes for this class. This is useful if you want
2630 to use the same font or colour in your own control as in a standard
2631 control -- which is a much better idea than hard coding specific
2632 colours or fonts which might look completely out of place on the
2633 user's system, especially if it uses themes.
2634
2635 The variant parameter is only relevant under Mac currently and is
2636 ignore under other platforms. Under Mac, it will change the size of
2637 the returned font. See `wx.Window.SetWindowVariant` for more about
2638 this.
2639 """
2640 return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs)
2641
2642 #---------------------------------------------------------------------------
2643
2644 SL_HORIZONTAL = _controls_.SL_HORIZONTAL
2645 SL_VERTICAL = _controls_.SL_VERTICAL
2646 SL_TICKS = _controls_.SL_TICKS
2647 SL_AUTOTICKS = _controls_.SL_AUTOTICKS
2648 SL_LABELS = _controls_.SL_LABELS
2649 SL_LEFT = _controls_.SL_LEFT
2650 SL_TOP = _controls_.SL_TOP
2651 SL_RIGHT = _controls_.SL_RIGHT
2652 SL_BOTTOM = _controls_.SL_BOTTOM
2653 SL_BOTH = _controls_.SL_BOTH
2654 SL_SELRANGE = _controls_.SL_SELRANGE
2655 SL_INVERSE = _controls_.SL_INVERSE
2656 class Slider(_core.Control):
2657 """Proxy of C++ Slider class"""
2658 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2659 __repr__ = _swig_repr
2660 def __init__(self, *args, **kwargs):
2661 """
2662 __init__(self, Window parent, int id=-1, int value=0, int minValue=0,
2663 int maxValue=100, Point pos=DefaultPosition,
2664 Size size=DefaultSize, long style=SL_HORIZONTAL,
2665 Validator validator=DefaultValidator,
2666 String name=SliderNameStr) -> Slider
2667 """
2668 if kwargs.has_key('point'): kwargs['pos'] = kwargs['point'];del kwargs['point']
2669 _controls_.Slider_swiginit(self,_controls_.new_Slider(*args, **kwargs))
2670 self._setOORInfo(self)
2671
2672 def Create(*args, **kwargs):
2673 """
2674 Create(self, Window parent, int id=-1, int value=0, int minValue=0,
2675 int maxValue=100, Point pos=DefaultPosition,
2676 Size size=DefaultSize, long style=SL_HORIZONTAL,
2677 Validator validator=DefaultValidator,
2678 String name=SliderNameStr) -> bool
2679 """
2680 return _controls_.Slider_Create(*args, **kwargs)
2681
2682 def GetValue(*args, **kwargs):
2683 """GetValue(self) -> int"""
2684 return _controls_.Slider_GetValue(*args, **kwargs)
2685
2686 def SetValue(*args, **kwargs):
2687 """SetValue(self, int value)"""
2688 return _controls_.Slider_SetValue(*args, **kwargs)
2689
2690 def SetRange(*args, **kwargs):
2691 """SetRange(self, int minValue, int maxValue)"""
2692 return _controls_.Slider_SetRange(*args, **kwargs)
2693
2694 def GetMin(*args, **kwargs):
2695 """GetMin(self) -> int"""
2696 return _controls_.Slider_GetMin(*args, **kwargs)
2697
2698 def GetMax(*args, **kwargs):
2699 """GetMax(self) -> int"""
2700 return _controls_.Slider_GetMax(*args, **kwargs)
2701
2702 def SetMin(*args, **kwargs):
2703 """SetMin(self, int minValue)"""
2704 return _controls_.Slider_SetMin(*args, **kwargs)
2705
2706 def SetMax(*args, **kwargs):
2707 """SetMax(self, int maxValue)"""
2708 return _controls_.Slider_SetMax(*args, **kwargs)
2709
2710 def SetLineSize(*args, **kwargs):
2711 """SetLineSize(self, int lineSize)"""
2712 return _controls_.Slider_SetLineSize(*args, **kwargs)
2713
2714 def SetPageSize(*args, **kwargs):
2715 """SetPageSize(self, int pageSize)"""
2716 return _controls_.Slider_SetPageSize(*args, **kwargs)
2717
2718 def GetLineSize(*args, **kwargs):
2719 """GetLineSize(self) -> int"""
2720 return _controls_.Slider_GetLineSize(*args, **kwargs)
2721
2722 def GetPageSize(*args, **kwargs):
2723 """GetPageSize(self) -> int"""
2724 return _controls_.Slider_GetPageSize(*args, **kwargs)
2725
2726 def SetThumbLength(*args, **kwargs):
2727 """SetThumbLength(self, int lenPixels)"""
2728 return _controls_.Slider_SetThumbLength(*args, **kwargs)
2729
2730 def GetThumbLength(*args, **kwargs):
2731 """GetThumbLength(self) -> int"""
2732 return _controls_.Slider_GetThumbLength(*args, **kwargs)
2733
2734 def SetTickFreq(*args, **kwargs):
2735 """SetTickFreq(self, int n, int pos=1)"""
2736 return _controls_.Slider_SetTickFreq(*args, **kwargs)
2737
2738 def GetTickFreq(*args, **kwargs):
2739 """GetTickFreq(self) -> int"""
2740 return _controls_.Slider_GetTickFreq(*args, **kwargs)
2741
2742 def ClearTicks(*args, **kwargs):
2743 """ClearTicks(self)"""
2744 return _controls_.Slider_ClearTicks(*args, **kwargs)
2745
2746 def SetTick(*args, **kwargs):
2747 """SetTick(self, int tickPos)"""
2748 return _controls_.Slider_SetTick(*args, **kwargs)
2749
2750 def ClearSel(*args, **kwargs):
2751 """ClearSel(self)"""
2752 return _controls_.Slider_ClearSel(*args, **kwargs)
2753
2754 def GetSelEnd(*args, **kwargs):
2755 """GetSelEnd(self) -> int"""
2756 return _controls_.Slider_GetSelEnd(*args, **kwargs)
2757
2758 def GetSelStart(*args, **kwargs):
2759 """GetSelStart(self) -> int"""
2760 return _controls_.Slider_GetSelStart(*args, **kwargs)
2761
2762 def SetSelection(*args, **kwargs):
2763 """SetSelection(self, int min, int max)"""
2764 return _controls_.Slider_SetSelection(*args, **kwargs)
2765
2766 def GetClassDefaultAttributes(*args, **kwargs):
2767 """
2768 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2769
2770 Get the default attributes for this class. This is useful if you want
2771 to use the same font or colour in your own control as in a standard
2772 control -- which is a much better idea than hard coding specific
2773 colours or fonts which might look completely out of place on the
2774 user's system, especially if it uses themes.
2775
2776 The variant parameter is only relevant under Mac currently and is
2777 ignore under other platforms. Under Mac, it will change the size of
2778 the returned font. See `wx.Window.SetWindowVariant` for more about
2779 this.
2780 """
2781 return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs)
2782
2783 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2784 LineSize = property(GetLineSize,SetLineSize,doc="See `GetLineSize` and `SetLineSize`")
2785 Max = property(GetMax,SetMax,doc="See `GetMax` and `SetMax`")
2786 Min = property(GetMin,SetMin,doc="See `GetMin` and `SetMin`")
2787 PageSize = property(GetPageSize,SetPageSize,doc="See `GetPageSize` and `SetPageSize`")
2788 SelEnd = property(GetSelEnd,doc="See `GetSelEnd`")
2789 SelStart = property(GetSelStart,doc="See `GetSelStart`")
2790 ThumbLength = property(GetThumbLength,SetThumbLength,doc="See `GetThumbLength` and `SetThumbLength`")
2791 TickFreq = property(GetTickFreq,SetTickFreq,doc="See `GetTickFreq` and `SetTickFreq`")
2792 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2793 _controls_.Slider_swigregister(Slider)
2794 SliderNameStr = cvar.SliderNameStr
2795
2796 def PreSlider(*args, **kwargs):
2797 """PreSlider() -> Slider"""
2798 val = _controls_.new_PreSlider(*args, **kwargs)
2799 return val
2800
2801 def Slider_GetClassDefaultAttributes(*args, **kwargs):
2802 """
2803 Slider_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2804
2805 Get the default attributes for this class. This is useful if you want
2806 to use the same font or colour in your own control as in a standard
2807 control -- which is a much better idea than hard coding specific
2808 colours or fonts which might look completely out of place on the
2809 user's system, especially if it uses themes.
2810
2811 The variant parameter is only relevant under Mac currently and is
2812 ignore under other platforms. Under Mac, it will change the size of
2813 the returned font. See `wx.Window.SetWindowVariant` for more about
2814 this.
2815 """
2816 return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs)
2817
2818 #---------------------------------------------------------------------------
2819
2820 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED = _controls_.wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
2821 EVT_TOGGLEBUTTON = wx.PyEventBinder( wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, 1)
2822
2823 class ToggleButton(_core.Control):
2824 """Proxy of C++ ToggleButton class"""
2825 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2826 __repr__ = _swig_repr
2827 def __init__(self, *args, **kwargs):
2828 """
2829 __init__(self, Window parent, int id=-1, String label=EmptyString,
2830 Point pos=DefaultPosition, Size size=DefaultSize,
2831 long style=0, Validator validator=DefaultValidator,
2832 String name=ToggleButtonNameStr) -> ToggleButton
2833 """
2834 _controls_.ToggleButton_swiginit(self,_controls_.new_ToggleButton(*args, **kwargs))
2835 self._setOORInfo(self)
2836
2837 def Create(*args, **kwargs):
2838 """
2839 Create(self, Window parent, int id=-1, String label=EmptyString,
2840 Point pos=DefaultPosition, Size size=DefaultSize,
2841 long style=0, Validator validator=DefaultValidator,
2842 String name=ToggleButtonNameStr) -> bool
2843 """
2844 return _controls_.ToggleButton_Create(*args, **kwargs)
2845
2846 def SetValue(*args, **kwargs):
2847 """SetValue(self, bool value)"""
2848 return _controls_.ToggleButton_SetValue(*args, **kwargs)
2849
2850 def GetValue(*args, **kwargs):
2851 """GetValue(self) -> bool"""
2852 return _controls_.ToggleButton_GetValue(*args, **kwargs)
2853
2854 def GetClassDefaultAttributes(*args, **kwargs):
2855 """
2856 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2857
2858 Get the default attributes for this class. This is useful if you want
2859 to use the same font or colour in your own control as in a standard
2860 control -- which is a much better idea than hard coding specific
2861 colours or fonts which might look completely out of place on the
2862 user's system, especially if it uses themes.
2863
2864 The variant parameter is only relevant under Mac currently and is
2865 ignore under other platforms. Under Mac, it will change the size of
2866 the returned font. See `wx.Window.SetWindowVariant` for more about
2867 this.
2868 """
2869 return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs)
2870
2871 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
2872 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
2873 _controls_.ToggleButton_swigregister(ToggleButton)
2874 ToggleButtonNameStr = cvar.ToggleButtonNameStr
2875
2876 def PreToggleButton(*args, **kwargs):
2877 """PreToggleButton() -> ToggleButton"""
2878 val = _controls_.new_PreToggleButton(*args, **kwargs)
2879 return val
2880
2881 def ToggleButton_GetClassDefaultAttributes(*args, **kwargs):
2882 """
2883 ToggleButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
2884
2885 Get the default attributes for this class. This is useful if you want
2886 to use the same font or colour in your own control as in a standard
2887 control -- which is a much better idea than hard coding specific
2888 colours or fonts which might look completely out of place on the
2889 user's system, especially if it uses themes.
2890
2891 The variant parameter is only relevant under Mac currently and is
2892 ignore under other platforms. Under Mac, it will change the size of
2893 the returned font. See `wx.Window.SetWindowVariant` for more about
2894 this.
2895 """
2896 return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs)
2897
2898 #---------------------------------------------------------------------------
2899
2900 BK_DEFAULT = _controls_.BK_DEFAULT
2901 BK_TOP = _controls_.BK_TOP
2902 BK_BOTTOM = _controls_.BK_BOTTOM
2903 BK_LEFT = _controls_.BK_LEFT
2904 BK_RIGHT = _controls_.BK_RIGHT
2905 BK_ALIGN_MASK = _controls_.BK_ALIGN_MASK
2906 BK_BUTTONBAR = _controls_.BK_BUTTONBAR
2907 BK_HITTEST_NOWHERE = _controls_.BK_HITTEST_NOWHERE
2908 BK_HITTEST_ONICON = _controls_.BK_HITTEST_ONICON
2909 BK_HITTEST_ONLABEL = _controls_.BK_HITTEST_ONLABEL
2910 BK_HITTEST_ONITEM = _controls_.BK_HITTEST_ONITEM
2911 BK_HITTEST_ONPAGE = _controls_.BK_HITTEST_ONPAGE
2912 class BookCtrlBase(_core.Control):
2913 """Proxy of C++ BookCtrlBase class"""
2914 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2915 def __init__(self): raise AttributeError, "No constructor defined"
2916 __repr__ = _swig_repr
2917 def GetPageCount(*args, **kwargs):
2918 """GetPageCount(self) -> size_t"""
2919 return _controls_.BookCtrlBase_GetPageCount(*args, **kwargs)
2920
2921 def GetPage(*args, **kwargs):
2922 """GetPage(self, size_t n) -> Window"""
2923 return _controls_.BookCtrlBase_GetPage(*args, **kwargs)
2924
2925 def GetCurrentPage(*args, **kwargs):
2926 """GetCurrentPage(self) -> Window"""
2927 return _controls_.BookCtrlBase_GetCurrentPage(*args, **kwargs)
2928
2929 def GetSelection(*args, **kwargs):
2930 """GetSelection(self) -> int"""
2931 return _controls_.BookCtrlBase_GetSelection(*args, **kwargs)
2932
2933 def SetPageText(*args, **kwargs):
2934 """SetPageText(self, size_t n, String strText) -> bool"""
2935 return _controls_.BookCtrlBase_SetPageText(*args, **kwargs)
2936
2937 def GetPageText(*args, **kwargs):
2938 """GetPageText(self, size_t n) -> String"""
2939 return _controls_.BookCtrlBase_GetPageText(*args, **kwargs)
2940
2941 def SetImageList(*args, **kwargs):
2942 """SetImageList(self, ImageList imageList)"""
2943 return _controls_.BookCtrlBase_SetImageList(*args, **kwargs)
2944
2945 def AssignImageList(*args, **kwargs):
2946 """AssignImageList(self, ImageList imageList)"""
2947 return _controls_.BookCtrlBase_AssignImageList(*args, **kwargs)
2948
2949 def GetImageList(*args, **kwargs):
2950 """GetImageList(self) -> ImageList"""
2951 return _controls_.BookCtrlBase_GetImageList(*args, **kwargs)
2952
2953 def GetPageImage(*args, **kwargs):
2954 """GetPageImage(self, size_t n) -> int"""
2955 return _controls_.BookCtrlBase_GetPageImage(*args, **kwargs)
2956
2957 def SetPageImage(*args, **kwargs):
2958 """SetPageImage(self, size_t n, int imageId) -> bool"""
2959 return _controls_.BookCtrlBase_SetPageImage(*args, **kwargs)
2960
2961 def SetPageSize(*args, **kwargs):
2962 """SetPageSize(self, Size size)"""
2963 return _controls_.BookCtrlBase_SetPageSize(*args, **kwargs)
2964
2965 def CalcSizeFromPage(*args, **kwargs):
2966 """CalcSizeFromPage(self, Size sizePage) -> Size"""
2967 return _controls_.BookCtrlBase_CalcSizeFromPage(*args, **kwargs)
2968
2969 def GetInternalBorder(*args, **kwargs):
2970 """GetInternalBorder(self) -> unsigned int"""
2971 return _controls_.BookCtrlBase_GetInternalBorder(*args, **kwargs)
2972
2973 def SetInternalBorder(*args, **kwargs):
2974 """SetInternalBorder(self, unsigned int internalBorder)"""
2975 return _controls_.BookCtrlBase_SetInternalBorder(*args, **kwargs)
2976
2977 def IsVertical(*args, **kwargs):
2978 """IsVertical(self) -> bool"""
2979 return _controls_.BookCtrlBase_IsVertical(*args, **kwargs)
2980
2981 def SetControlMargin(*args, **kwargs):
2982 """SetControlMargin(self, int margin)"""
2983 return _controls_.BookCtrlBase_SetControlMargin(*args, **kwargs)
2984
2985 def GetControlMargin(*args, **kwargs):
2986 """GetControlMargin(self) -> int"""
2987 return _controls_.BookCtrlBase_GetControlMargin(*args, **kwargs)
2988
2989 def SetFitToCurrentPage(*args, **kwargs):
2990 """SetFitToCurrentPage(self, bool fit)"""
2991 return _controls_.BookCtrlBase_SetFitToCurrentPage(*args, **kwargs)
2992
2993 def GetFitToCurrentPage(*args, **kwargs):
2994 """GetFitToCurrentPage(self) -> bool"""
2995 return _controls_.BookCtrlBase_GetFitToCurrentPage(*args, **kwargs)
2996
2997 def GetControlSizer(*args, **kwargs):
2998 """GetControlSizer(self) -> Sizer"""
2999 return _controls_.BookCtrlBase_GetControlSizer(*args, **kwargs)
3000
3001 def DeletePage(*args, **kwargs):
3002 """DeletePage(self, size_t n) -> bool"""
3003 return _controls_.BookCtrlBase_DeletePage(*args, **kwargs)
3004
3005 def RemovePage(*args, **kwargs):
3006 """RemovePage(self, size_t n) -> bool"""
3007 return _controls_.BookCtrlBase_RemovePage(*args, **kwargs)
3008
3009 def DeleteAllPages(*args, **kwargs):
3010 """DeleteAllPages(self) -> bool"""
3011 return _controls_.BookCtrlBase_DeleteAllPages(*args, **kwargs)
3012
3013 def AddPage(*args, **kwargs):
3014 """AddPage(self, Window page, String text, bool select=False, int imageId=-1) -> bool"""
3015 return _controls_.BookCtrlBase_AddPage(*args, **kwargs)
3016
3017 def InsertPage(*args, **kwargs):
3018 """
3019 InsertPage(self, size_t n, Window page, String text, bool select=False,
3020 int imageId=-1) -> bool
3021 """
3022 return _controls_.BookCtrlBase_InsertPage(*args, **kwargs)
3023
3024 def SetSelection(*args, **kwargs):
3025 """SetSelection(self, size_t n) -> int"""
3026 return _controls_.BookCtrlBase_SetSelection(*args, **kwargs)
3027
3028 def ChangeSelection(*args, **kwargs):
3029 """ChangeSelection(self, size_t n) -> int"""
3030 return _controls_.BookCtrlBase_ChangeSelection(*args, **kwargs)
3031
3032 def AdvanceSelection(*args, **kwargs):
3033 """AdvanceSelection(self, bool forward=True)"""
3034 return _controls_.BookCtrlBase_AdvanceSelection(*args, **kwargs)
3035
3036 def HitTest(*args, **kwargs):
3037 """
3038 HitTest(Point pt) -> (tab, where)
3039
3040 Returns the page/tab which is hit, and flags indicating where using
3041 wx.NB_HITTEST flags.
3042 """
3043 return _controls_.BookCtrlBase_HitTest(*args, **kwargs)
3044
3045 def GetClassDefaultAttributes(*args, **kwargs):
3046 """
3047 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
3048
3049 Get the default attributes for this class. This is useful if you want
3050 to use the same font or colour in your own control as in a standard
3051 control -- which is a much better idea than hard coding specific
3052 colours or fonts which might look completely out of place on the
3053 user's system, especially if it uses themes.
3054
3055 The variant parameter is only relevant under Mac currently and is
3056 ignore under other platforms. Under Mac, it will change the size of
3057 the returned font. See `wx.Window.SetWindowVariant` for more about
3058 this.
3059 """
3060 return _controls_.BookCtrlBase_GetClassDefaultAttributes(*args, **kwargs)
3061
3062 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
3063 ControlMargin = property(GetControlMargin,SetControlMargin,doc="See `GetControlMargin` and `SetControlMargin`")
3064 ControlSizer = property(GetControlSizer,doc="See `GetControlSizer`")
3065 CurrentPage = property(GetCurrentPage,doc="See `GetCurrentPage`")
3066 FitToCurrentPage = property(GetFitToCurrentPage,SetFitToCurrentPage,doc="See `GetFitToCurrentPage` and `SetFitToCurrentPage`")
3067 ImageList = property(GetImageList,SetImageList,doc="See `GetImageList` and `SetImageList`")
3068 InternalBorder = property(GetInternalBorder,SetInternalBorder,doc="See `GetInternalBorder` and `SetInternalBorder`")
3069 Page = property(GetPage,doc="See `GetPage`")
3070 PageCount = property(GetPageCount,doc="See `GetPageCount`")
3071 PageImage = property(GetPageImage,SetPageImage,doc="See `GetPageImage` and `SetPageImage`")
3072 PageText = property(GetPageText,SetPageText,doc="See `GetPageText` and `SetPageText`")
3073 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
3074 _controls_.BookCtrlBase_swigregister(BookCtrlBase)
3075 NotebookNameStr = cvar.NotebookNameStr
3076
3077 def BookCtrlBase_GetClassDefaultAttributes(*args, **kwargs):
3078 """
3079 BookCtrlBase_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
3080
3081 Get the default attributes for this class. This is useful if you want
3082 to use the same font or colour in your own control as in a standard
3083 control -- which is a much better idea than hard coding specific
3084 colours or fonts which might look completely out of place on the
3085 user's system, especially if it uses themes.
3086
3087 The variant parameter is only relevant under Mac currently and is
3088 ignore under other platforms. Under Mac, it will change the size of
3089 the returned font. See `wx.Window.SetWindowVariant` for more about
3090 this.
3091 """
3092 return _controls_.BookCtrlBase_GetClassDefaultAttributes(*args, **kwargs)
3093
3094 class BookCtrlBaseEvent(_core.NotifyEvent):
3095 """Proxy of C++ BookCtrlBaseEvent class"""
3096 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3097 __repr__ = _swig_repr
3098 def __init__(self, *args, **kwargs):
3099 """
3100 __init__(self, EventType commandType=wxEVT_NULL, int id=0, int nSel=-1,
3101 int nOldSel=-1) -> BookCtrlBaseEvent
3102 """
3103 _controls_.BookCtrlBaseEvent_swiginit(self,_controls_.new_BookCtrlBaseEvent(*args, **kwargs))
3104 def GetSelection(*args, **kwargs):
3105 """
3106 GetSelection(self) -> int
3107
3108 Returns item index for a listbox or choice selection event (not valid
3109 for a deselection).
3110 """
3111 return _controls_.BookCtrlBaseEvent_GetSelection(*args, **kwargs)
3112
3113 def SetSelection(*args, **kwargs):
3114 """SetSelection(self, int nSel)"""
3115 return _controls_.BookCtrlBaseEvent_SetSelection(*args, **kwargs)
3116
3117 def GetOldSelection(*args, **kwargs):
3118 """GetOldSelection(self) -> int"""
3119 return _controls_.BookCtrlBaseEvent_GetOldSelection(*args, **kwargs)
3120
3121 def SetOldSelection(*args, **kwargs):
3122 """SetOldSelection(self, int nOldSel)"""
3123 return _controls_.BookCtrlBaseEvent_SetOldSelection(*args, **kwargs)
3124
3125 OldSelection = property(GetOldSelection,SetOldSelection,doc="See `GetOldSelection` and `SetOldSelection`")
3126 Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`")
3127 _controls_.BookCtrlBaseEvent_swigregister(BookCtrlBaseEvent)
3128
3129 #---------------------------------------------------------------------------
3130
3131 NB_FIXEDWIDTH = _controls_.NB_FIXEDWIDTH
3132 NB_TOP = _controls_.NB_TOP
3133 NB_LEFT = _controls_.NB_LEFT
3134 NB_RIGHT = _controls_.NB_RIGHT
3135 NB_BOTTOM = _controls_.NB_BOTTOM
3136 NB_MULTILINE = _controls_.NB_MULTILINE
3137 NB_NOPAGETHEME = _controls_.NB_NOPAGETHEME
3138 NB_HITTEST_NOWHERE = _controls_.NB_HITTEST_NOWHERE
3139 NB_HITTEST_ONICON = _controls_.NB_HITTEST_ONICON
3140 NB_HITTEST_ONLABEL = _controls_.NB_HITTEST_ONLABEL
3141 NB_HITTEST_ONITEM = _controls_.NB_HITTEST_ONITEM
3142 NB_HITTEST_ONPAGE = _controls_.NB_HITTEST_ONPAGE
3143 class Notebook(BookCtrlBase):
3144 """Proxy of C++ Notebook class"""
3145 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3146 __repr__ = _swig_repr
3147 def __init__(self, *args, **kwargs):
3148 """
3149 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
3150 Size size=DefaultSize, long style=0, String name=NotebookNameStr) -> Notebook
3151 """
3152 _controls_.Notebook_swiginit(self,_controls_.new_Notebook(*args, **kwargs))
3153 self._setOORInfo(self)
3154
3155 def Create(*args, **kwargs):
3156 """
3157 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
3158 Size size=DefaultSize, long style=0, String name=NotebookNameStr) -> bool
3159 """
3160 return _controls_.Notebook_Create(*args, **kwargs)
3161
3162 def GetRowCount(*args, **kwargs):
3163 """GetRowCount(self) -> int"""
3164 return _controls_.Notebook_GetRowCount(*args, **kwargs)
3165
3166 def SetPadding(*args, **kwargs):
3167 """SetPadding(self, Size padding)"""
3168 return _controls_.Notebook_SetPadding(*args, **kwargs)
3169
3170 def SetTabSize(*args, **kwargs):
3171 """SetTabSize(self, Size sz)"""
3172 return _controls_.Notebook_SetTabSize(*args, **kwargs)
3173
3174 def GetThemeBackgroundColour(*args, **kwargs):
3175 """GetThemeBackgroundColour(self) -> Colour"""
3176 return _controls_.Notebook_GetThemeBackgroundColour(*args, **kwargs)
3177
3178 def GetClassDefaultAttributes(*args, **kwargs):
3179 """
3180 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
3181
3182 Get the default attributes for this class. This is useful if you want
3183 to use the same font or colour in your own control as in a standard
3184 control -- which is a much better idea than hard coding specific
3185 colours or fonts which might look completely out of place on the
3186 user's system, especially if it uses themes.
3187
3188 The variant parameter is only relevant under Mac currently and is
3189 ignore under other platforms. Under Mac, it will change the size of
3190 the returned font. See `wx.Window.SetWindowVariant` for more about
3191 this.
3192 """
3193 return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs)
3194
3195 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
3196 def SendPageChangingEvent(*args, **kwargs):
3197 """SendPageChangingEvent(self, int nPage) -> bool"""
3198 return _controls_.Notebook_SendPageChangingEvent(*args, **kwargs)
3199
3200 def SendPageChangedEvent(*args, **kwargs):
3201 """SendPageChangedEvent(self, int nPageOld, int nPageNew=-1)"""
3202 return _controls_.Notebook_SendPageChangedEvent(*args, **kwargs)
3203
3204 RowCount = property(GetRowCount,doc="See `GetRowCount`")
3205 ThemeBackgroundColour = property(GetThemeBackgroundColour,doc="See `GetThemeBackgroundColour`")
3206 _controls_.Notebook_swigregister(Notebook)
3207
3208 def PreNotebook(*args, **kwargs):
3209 """PreNotebook() -> Notebook"""
3210 val = _controls_.new_PreNotebook(*args, **kwargs)
3211 return val
3212
3213 def Notebook_GetClassDefaultAttributes(*args, **kwargs):
3214 """
3215 Notebook_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
3216
3217 Get the default attributes for this class. This is useful if you want
3218 to use the same font or colour in your own control as in a standard
3219 control -- which is a much better idea than hard coding specific
3220 colours or fonts which might look completely out of place on the
3221 user's system, especially if it uses themes.
3222
3223 The variant parameter is only relevant under Mac currently and is
3224 ignore under other platforms. Under Mac, it will change the size of
3225 the returned font. See `wx.Window.SetWindowVariant` for more about
3226 this.
3227 """
3228 return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs)
3229
3230 class NotebookEvent(BookCtrlBaseEvent):
3231 """Proxy of C++ NotebookEvent class"""
3232 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3233 __repr__ = _swig_repr
3234 def __init__(self, *args, **kwargs):
3235 """
3236 __init__(self, EventType commandType=wxEVT_NULL, int id=0, int nSel=-1,
3237 int nOldSel=-1) -> NotebookEvent
3238 """
3239 _controls_.NotebookEvent_swiginit(self,_controls_.new_NotebookEvent(*args, **kwargs))
3240 _controls_.NotebookEvent_swigregister(NotebookEvent)
3241
3242 wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED = _controls_.wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
3243 wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING = _controls_.wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
3244 # wxNotebook events
3245 EVT_NOTEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 1 )
3246 EVT_NOTEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 1 )
3247
3248 #----------------------------------------------------------------------------
3249
3250 class NotebookPage(wx.Panel):
3251 """
3252 There is an old (and apparently unsolvable) bug when placing a
3253 window with a nonstandard background colour in a wx.Notebook on
3254 wxGTK1, as the notbooks's background colour would always be used
3255 when the window is refreshed. The solution is to place a panel in
3256 the notbook and the coloured window on the panel, sized to cover
3257 the panel. This simple class does that for you, just put an
3258 instance of this in the notebook and make your regular window a
3259 child of this one and it will handle the resize for you.
3260 """
3261 def __init__(self, parent, id=-1,
3262 pos=wx.DefaultPosition, size=wx.DefaultSize,
3263 style=wx.TAB_TRAVERSAL, name="panel"):
3264 wx.Panel.__init__(self, parent, id, pos, size, style, name)
3265 self.child = None
3266 self.Bind(wx.EVT_SIZE, self.OnSize)
3267
3268 def OnSize(self, evt):
3269 if self.child is None:
3270 children = self.GetChildren()
3271 if len(children):
3272 self.child = children[0]
3273 if self.child:
3274 self.child.SetPosition((0,0))
3275 self.child.SetSize(self.GetSize())
3276
3277
3278 #---------------------------------------------------------------------------
3279
3280 LB_DEFAULT = _controls_.LB_DEFAULT
3281 LB_TOP = _controls_.LB_TOP
3282 LB_BOTTOM = _controls_.LB_BOTTOM
3283 LB_LEFT = _controls_.LB_LEFT
3284 LB_RIGHT = _controls_.LB_RIGHT
3285 LB_ALIGN_MASK = _controls_.LB_ALIGN_MASK
3286 class Listbook(BookCtrlBase):
3287 """Proxy of C++ Listbook class"""
3288 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3289 __repr__ = _swig_repr
3290 def __init__(self, *args, **kwargs):
3291 """
3292 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
3293 Size size=DefaultSize, long style=0, String name=EmptyString) -> Listbook
3294 """
3295 _controls_.Listbook_swiginit(self,_controls_.new_Listbook(*args, **kwargs))
3296 self._setOORInfo(self)
3297
3298 def Create(*args, **kwargs):
3299 """
3300 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
3301 Size size=DefaultSize, long style=0, String name=EmptyString) -> bool
3302 """
3303 return _controls_.Listbook_Create(*args, **kwargs)
3304
3305 def GetListView(*args, **kwargs):
3306 """GetListView(self) -> ListView"""
3307 return _controls_.Listbook_GetListView(*args, **kwargs)
3308
3309 ListView = property(GetListView,doc="See `GetListView`")
3310 _controls_.Listbook_swigregister(Listbook)
3311
3312 def PreListbook(*args, **kwargs):
3313 """PreListbook() -> Listbook"""
3314 val = _controls_.new_PreListbook(*args, **kwargs)
3315 return val
3316
3317 class ListbookEvent(BookCtrlBaseEvent):
3318 """Proxy of C++ ListbookEvent class"""
3319 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3320 __repr__ = _swig_repr
3321 def __init__(self, *args, **kwargs):
3322 """
3323 __init__(self, EventType commandType=wxEVT_NULL, int id=0, int nSel=-1,
3324 int nOldSel=-1) -> ListbookEvent
3325 """
3326 _controls_.ListbookEvent_swiginit(self,_controls_.new_ListbookEvent(*args, **kwargs))
3327 _controls_.ListbookEvent_swigregister(ListbookEvent)
3328
3329 wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED = _controls_.wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED
3330 wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING = _controls_.wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING
3331 EVT_LISTBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, 1 )
3332 EVT_LISTBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, 1 )
3333
3334 CHB_DEFAULT = _controls_.CHB_DEFAULT
3335 CHB_TOP = _controls_.CHB_TOP
3336 CHB_BOTTOM = _controls_.CHB_BOTTOM
3337 CHB_LEFT = _controls_.CHB_LEFT
3338 CHB_RIGHT = _controls_.CHB_RIGHT
3339 CHB_ALIGN_MASK = _controls_.CHB_ALIGN_MASK
3340 class Choicebook(BookCtrlBase):
3341 """Proxy of C++ Choicebook class"""
3342 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3343 __repr__ = _swig_repr
3344 def __init__(self, *args, **kwargs):
3345 """
3346 __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
3347 long style=0, String name=EmptyString) -> Choicebook
3348 """
3349 _controls_.Choicebook_swiginit(self,_controls_.new_Choicebook(*args, **kwargs))
3350 self._setOORInfo(self)
3351
3352 def Create(*args, **kwargs):
3353 """
3354 Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
3355 long style=0, String name=EmptyString) -> bool
3356 """
3357 return _controls_.Choicebook_Create(*args, **kwargs)
3358
3359 def GetChoiceCtrl(*args, **kwargs):
3360 """GetChoiceCtrl(self) -> Choice"""
3361 return _controls_.Choicebook_GetChoiceCtrl(*args, **kwargs)
3362
3363 ChoiceCtrl = property(GetChoiceCtrl,doc="See `GetChoiceCtrl`")
3364 _controls_.Choicebook_swigregister(Choicebook)
3365
3366 def PreChoicebook(*args, **kwargs):
3367 """PreChoicebook() -> Choicebook"""
3368 val = _controls_.new_PreChoicebook(*args, **kwargs)
3369 return val
3370
3371 class ChoicebookEvent(BookCtrlBaseEvent):
3372 """Proxy of C++ ChoicebookEvent class"""
3373 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3374 __repr__ = _swig_repr
3375 def __init__(self, *args, **kwargs):
3376 """
3377 __init__(self, EventType commandType=wxEVT_NULL, int id=0, int nSel=-1,
3378 int nOldSel=-1) -> ChoicebookEvent
3379 """
3380 _controls_.ChoicebookEvent_swiginit(self,_controls_.new_ChoicebookEvent(*args, **kwargs))
3381 _controls_.ChoicebookEvent_swigregister(ChoicebookEvent)
3382
3383 wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED = _controls_.wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED
3384 wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING = _controls_.wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING
3385 EVT_CHOICEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED, 1 )
3386 EVT_CHOICEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING, 1 )
3387
3388 #---------------------------------------------------------------------------
3389
3390 class Treebook(BookCtrlBase):
3391 """Proxy of C++ Treebook class"""
3392 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3393 __repr__ = _swig_repr
3394 def __init__(self, *args, **kwargs):
3395 """
3396 __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
3397 long style=BK_DEFAULT,
3398 String name=EmptyString) -> Treebook
3399 """
3400 _controls_.Treebook_swiginit(self,_controls_.new_Treebook(*args, **kwargs))
3401 self._setOORInfo(self)
3402
3403 def Create(*args, **kwargs):
3404 """
3405 Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
3406 long style=BK_DEFAULT,
3407 String name=EmptyString) -> bool
3408 """
3409 return _controls_.Treebook_Create(*args, **kwargs)
3410
3411 def InsertSubPage(*args, **kwargs):
3412 """
3413 InsertSubPage(self, size_t pos, Window page, String text, bool select=False,
3414 int imageId=NOT_FOUND) -> bool
3415 """
3416 return _controls_.Treebook_InsertSubPage(*args, **kwargs)
3417
3418 def AddSubPage(*args, **kwargs):
3419 """AddSubPage(self, Window page, String text, bool select=False, int imageId=NOT_FOUND) -> bool"""
3420 return _controls_.Treebook_AddSubPage(*args, **kwargs)
3421
3422 def IsNodeExpanded(*args, **kwargs):
3423 """IsNodeExpanded(self, size_t pos) -> bool"""
3424 return _controls_.Treebook_IsNodeExpanded(*args, **kwargs)
3425
3426 def ExpandNode(*args, **kwargs):
3427 """ExpandNode(self, size_t pos, bool expand=True) -> bool"""
3428 return _controls_.Treebook_ExpandNode(*args, **kwargs)
3429
3430 def CollapseNode(*args, **kwargs):
3431 """CollapseNode(self, size_t pos) -> bool"""
3432 return _controls_.Treebook_CollapseNode(*args, **kwargs)
3433
3434 def GetPageParent(*args, **kwargs):
3435 """GetPageParent(self, size_t pos) -> int"""
3436 return _controls_.Treebook_GetPageParent(*args, **kwargs)
3437
3438 def GetTreeCtrl(*args, **kwargs):
3439 """GetTreeCtrl(self) -> TreeCtrl"""
3440 return _controls_.Treebook_GetTreeCtrl(*args, **kwargs)
3441
3442 TreeCtrl = property(GetTreeCtrl,doc="See `GetTreeCtrl`")
3443 _controls_.Treebook_swigregister(Treebook)
3444
3445 def PreTreebook(*args, **kwargs):
3446 """PreTreebook() -> Treebook"""
3447 val = _controls_.new_PreTreebook(*args, **kwargs)
3448 return val
3449
3450 class TreebookEvent(BookCtrlBaseEvent):
3451 """Proxy of C++ TreebookEvent class"""
3452 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3453 __repr__ = _swig_repr
3454 def __init__(self, *args, **kwargs):
3455 """
3456 __init__(self, EventType commandType=wxEVT_NULL, int id=0, int nSel=NOT_FOUND,
3457 int nOldSel=NOT_FOUND) -> TreebookEvent
3458 """
3459 _controls_.TreebookEvent_swiginit(self,_controls_.new_TreebookEvent(*args, **kwargs))
3460 _controls_.TreebookEvent_swigregister(TreebookEvent)
3461
3462 wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED = _controls_.wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED
3463 wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING = _controls_.wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING
3464 wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED = _controls_.wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED
3465 wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED = _controls_.wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED
3466 EVT_TREEBOOK_PAGE_CHANGED= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED, 1 )
3467 EVT_TREEBOOK_PAGE_CHANGING= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING, 1)
3468 EVT_TREEBOOK_NODE_COLLAPSED= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED, 1 )
3469 EVT_TREEBOOK_NODE_EXPANDED= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED, 1 )
3470
3471 #---------------------------------------------------------------------------
3472
3473 class Toolbook(BookCtrlBase):
3474 """Proxy of C++ Toolbook class"""
3475 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3476 __repr__ = _swig_repr
3477 def __init__(self, *args, **kwargs):
3478 """
3479 __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
3480 long style=BK_DEFAULT,
3481 String name=EmptyString) -> Toolbook
3482 """
3483 _controls_.Toolbook_swiginit(self,_controls_.new_Toolbook(*args, **kwargs))
3484 self._setOORInfo(self)
3485
3486 def Create(*args, **kwargs):
3487 """
3488 Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
3489 long style=0, String name=wxEmptyString) -> bool
3490 """
3491 return _controls_.Toolbook_Create(*args, **kwargs)
3492
3493 def GetToolBar(*args, **kwargs):
3494 """GetToolBar(self) -> ToolBarBase"""
3495 return _controls_.Toolbook_GetToolBar(*args, **kwargs)
3496
3497 def Realize(*args, **kwargs):
3498 """Realize(self)"""
3499 return _controls_.Toolbook_Realize(*args, **kwargs)
3500
3501 ToolBar = property(GetToolBar,doc="See `GetToolBar`")
3502 _controls_.Toolbook_swigregister(Toolbook)
3503
3504 def PreToolbook(*args, **kwargs):
3505 """PreToolbook() -> Toolbook"""
3506 val = _controls_.new_PreToolbook(*args, **kwargs)
3507 return val
3508
3509 class ToolbookEvent(BookCtrlBaseEvent):
3510 """Proxy of C++ ToolbookEvent class"""
3511 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3512 __repr__ = _swig_repr
3513 def __init__(self, *args, **kwargs):
3514 """
3515 __init__(self, EventType commandType=wxEVT_NULL, int id=0, int nSel=NOT_FOUND,
3516 int nOldSel=NOT_FOUND) -> ToolbookEvent
3517 """
3518 _controls_.ToolbookEvent_swiginit(self,_controls_.new_ToolbookEvent(*args, **kwargs))
3519 _controls_.ToolbookEvent_swigregister(ToolbookEvent)
3520
3521 wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED = _controls_.wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED
3522 wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING = _controls_.wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING
3523 EVT_TOOLBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED, 1)
3524 EVT_TOOLBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING, 1)
3525
3526 #---------------------------------------------------------------------------
3527
3528 TOOL_STYLE_BUTTON = _controls_.TOOL_STYLE_BUTTON
3529 TOOL_STYLE_SEPARATOR = _controls_.TOOL_STYLE_SEPARATOR
3530 TOOL_STYLE_CONTROL = _controls_.TOOL_STYLE_CONTROL
3531 TB_HORIZONTAL = _controls_.TB_HORIZONTAL
3532 TB_VERTICAL = _controls_.TB_VERTICAL
3533 TB_TOP = _controls_.TB_TOP
3534 TB_LEFT = _controls_.TB_LEFT
3535 TB_BOTTOM = _controls_.TB_BOTTOM
3536 TB_RIGHT = _controls_.TB_RIGHT
3537 TB_3DBUTTONS = _controls_.TB_3DBUTTONS
3538 TB_FLAT = _controls_.TB_FLAT
3539 TB_DOCKABLE = _controls_.TB_DOCKABLE
3540 TB_NOICONS = _controls_.TB_NOICONS
3541 TB_TEXT = _controls_.TB_TEXT
3542 TB_NODIVIDER = _controls_.TB_NODIVIDER
3543 TB_NOALIGN = _controls_.TB_NOALIGN
3544 TB_HORZ_LAYOUT = _controls_.TB_HORZ_LAYOUT
3545 TB_HORZ_TEXT = _controls_.TB_HORZ_TEXT
3546 TB_NO_TOOLTIPS = _controls_.TB_NO_TOOLTIPS
3547 class ToolBarToolBase(_core.Object):
3548 """Proxy of C++ ToolBarToolBase class"""
3549 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3550 def __init__(self): raise AttributeError, "No constructor defined"
3551 __repr__ = _swig_repr
3552 def GetId(*args, **kwargs):
3553 """GetId(self) -> int"""
3554 return _controls_.ToolBarToolBase_GetId(*args, **kwargs)
3555
3556 def GetControl(*args, **kwargs):
3557 """GetControl(self) -> Control"""
3558 return _controls_.ToolBarToolBase_GetControl(*args, **kwargs)
3559
3560 def GetToolBar(*args, **kwargs):
3561 """GetToolBar(self) -> ToolBarBase"""
3562 return _controls_.ToolBarToolBase_GetToolBar(*args, **kwargs)
3563
3564 def IsButton(*args, **kwargs):
3565 """IsButton(self) -> int"""
3566 return _controls_.ToolBarToolBase_IsButton(*args, **kwargs)
3567
3568 def IsControl(*args, **kwargs):
3569 """IsControl(self) -> int"""
3570 return _controls_.ToolBarToolBase_IsControl(*args, **kwargs)
3571
3572 def IsSeparator(*args, **kwargs):
3573 """IsSeparator(self) -> int"""
3574 return _controls_.ToolBarToolBase_IsSeparator(*args, **kwargs)
3575
3576 def GetStyle(*args, **kwargs):
3577 """GetStyle(self) -> int"""
3578 return _controls_.ToolBarToolBase_GetStyle(*args, **kwargs)
3579
3580 def GetKind(*args, **kwargs):
3581 """GetKind(self) -> int"""
3582 return _controls_.ToolBarToolBase_GetKind(*args, **kwargs)
3583
3584 def IsEnabled(*args, **kwargs):
3585 """IsEnabled(self) -> bool"""
3586 return _controls_.ToolBarToolBase_IsEnabled(*args, **kwargs)
3587
3588 def IsToggled(*args, **kwargs):
3589 """IsToggled(self) -> bool"""
3590 return _controls_.ToolBarToolBase_IsToggled(*args, **kwargs)
3591
3592 def CanBeToggled(*args, **kwargs):
3593 """CanBeToggled(self) -> bool"""
3594 return _controls_.ToolBarToolBase_CanBeToggled(*args, **kwargs)
3595
3596 def GetNormalBitmap(*args, **kwargs):
3597 """GetNormalBitmap(self) -> Bitmap"""
3598 return _controls_.ToolBarToolBase_GetNormalBitmap(*args, **kwargs)
3599
3600 def GetDisabledBitmap(*args, **kwargs):
3601 """GetDisabledBitmap(self) -> Bitmap"""
3602 return _controls_.ToolBarToolBase_GetDisabledBitmap(*args, **kwargs)
3603
3604 def GetBitmap(*args, **kwargs):
3605 """GetBitmap(self) -> Bitmap"""
3606 return _controls_.ToolBarToolBase_GetBitmap(*args, **kwargs)
3607
3608 def GetLabel(*args, **kwargs):
3609 """GetLabel(self) -> String"""
3610 return _controls_.ToolBarToolBase_GetLabel(*args, **kwargs)
3611
3612 def GetShortHelp(*args, **kwargs):
3613 """GetShortHelp(self) -> String"""
3614 return _controls_.ToolBarToolBase_GetShortHelp(*args, **kwargs)
3615
3616 def GetLongHelp(*args, **kwargs):
3617 """GetLongHelp(self) -> String"""
3618 return _controls_.ToolBarToolBase_GetLongHelp(*args, **kwargs)
3619
3620 def Enable(*args, **kwargs):
3621 """Enable(self, bool enable) -> bool"""
3622 return _controls_.ToolBarToolBase_Enable(*args, **kwargs)
3623
3624 def Toggle(*args, **kwargs):
3625 """Toggle(self)"""
3626 return _controls_.ToolBarToolBase_Toggle(*args, **kwargs)
3627
3628 def SetToggle(*args, **kwargs):
3629 """SetToggle(self, bool toggle) -> bool"""
3630 return _controls_.ToolBarToolBase_SetToggle(*args, **kwargs)
3631
3632 def SetShortHelp(*args, **kwargs):
3633 """SetShortHelp(self, String help) -> bool"""
3634 return _controls_.ToolBarToolBase_SetShortHelp(*args, **kwargs)
3635
3636 def SetLongHelp(*args, **kwargs):
3637 """SetLongHelp(self, String help) -> bool"""
3638 return _controls_.ToolBarToolBase_SetLongHelp(*args, **kwargs)
3639
3640 def SetNormalBitmap(*args, **kwargs):
3641 """SetNormalBitmap(self, Bitmap bmp)"""
3642 return _controls_.ToolBarToolBase_SetNormalBitmap(*args, **kwargs)
3643
3644 def SetDisabledBitmap(*args, **kwargs):
3645 """SetDisabledBitmap(self, Bitmap bmp)"""
3646 return _controls_.ToolBarToolBase_SetDisabledBitmap(*args, **kwargs)
3647
3648 def SetLabel(*args, **kwargs):
3649 """SetLabel(self, String label)"""
3650 return _controls_.ToolBarToolBase_SetLabel(*args, **kwargs)
3651
3652 def Detach(*args, **kwargs):
3653 """Detach(self)"""
3654 return _controls_.ToolBarToolBase_Detach(*args, **kwargs)
3655
3656 def Attach(*args, **kwargs):
3657 """Attach(self, ToolBarBase tbar)"""
3658 return _controls_.ToolBarToolBase_Attach(*args, **kwargs)
3659
3660 def GetClientData(*args, **kwargs):
3661 """GetClientData(self) -> PyObject"""
3662 return _controls_.ToolBarToolBase_GetClientData(*args, **kwargs)
3663
3664 def SetClientData(*args, **kwargs):
3665 """SetClientData(self, PyObject clientData)"""
3666 return _controls_.ToolBarToolBase_SetClientData(*args, **kwargs)
3667
3668 GetBitmap1 = GetNormalBitmap
3669 GetBitmap2 = GetDisabledBitmap
3670 SetBitmap1 = SetNormalBitmap
3671 SetBitmap2 = SetDisabledBitmap
3672
3673 Bitmap = property(GetBitmap,doc="See `GetBitmap`")
3674 ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`")
3675 Control = property(GetControl,doc="See `GetControl`")
3676 DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`")
3677 Id = property(GetId,doc="See `GetId`")
3678 Kind = property(GetKind,doc="See `GetKind`")
3679 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
3680 LongHelp = property(GetLongHelp,SetLongHelp,doc="See `GetLongHelp` and `SetLongHelp`")
3681 NormalBitmap = property(GetNormalBitmap,SetNormalBitmap,doc="See `GetNormalBitmap` and `SetNormalBitmap`")
3682 ShortHelp = property(GetShortHelp,SetShortHelp,doc="See `GetShortHelp` and `SetShortHelp`")
3683 Style = property(GetStyle,doc="See `GetStyle`")
3684 ToolBar = property(GetToolBar,doc="See `GetToolBar`")
3685 _controls_.ToolBarToolBase_swigregister(ToolBarToolBase)
3686
3687 class ToolBarBase(_core.Control):
3688 """Proxy of C++ ToolBarBase class"""
3689 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3690 def __init__(self): raise AttributeError, "No constructor defined"
3691 __repr__ = _swig_repr
3692 def DoAddTool(*args, **kwargs):
3693 """
3694 DoAddTool(self, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap,
3695 int kind=ITEM_NORMAL, String shortHelp=EmptyString,
3696 String longHelp=EmptyString,
3697 PyObject clientData=None) -> ToolBarToolBase
3698 """
3699 return _controls_.ToolBarBase_DoAddTool(*args, **kwargs)
3700
3701 def DoInsertTool(*args, **kwargs):
3702 """
3703 DoInsertTool(self, size_t pos, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap,
3704 int kind=ITEM_NORMAL,
3705 String shortHelp=EmptyString, String longHelp=EmptyString,
3706 PyObject clientData=None) -> ToolBarToolBase
3707 """
3708 return _controls_.ToolBarBase_DoInsertTool(*args, **kwargs)
3709
3710 # These match the original Add methods for this class, kept for
3711 # backwards compatibility with versions < 2.3.3.
3712
3713
3714 def AddTool(self, id, bitmap,
3715 pushedBitmap = wx.NullBitmap,
3716 isToggle = 0,
3717 clientData = None,
3718 shortHelpString = '',
3719 longHelpString = '') :
3720 '''Old style method to add a tool to the toolbar.'''
3721 kind = wx.ITEM_NORMAL
3722 if isToggle: kind = wx.ITEM_CHECK
3723 return self.DoAddTool(id, '', bitmap, pushedBitmap, kind,
3724 shortHelpString, longHelpString, clientData)
3725
3726 def AddSimpleTool(self, id, bitmap,
3727 shortHelpString = '',
3728 longHelpString = '',
3729 isToggle = 0):
3730 '''Old style method to add a tool to the toolbar.'''
3731 kind = wx.ITEM_NORMAL
3732 if isToggle: kind = wx.ITEM_CHECK
3733 return self.DoAddTool(id, '', bitmap, wx.NullBitmap, kind,
3734 shortHelpString, longHelpString, None)
3735
3736 def InsertTool(self, pos, id, bitmap,
3737 pushedBitmap = wx.NullBitmap,
3738 isToggle = 0,
3739 clientData = None,
3740 shortHelpString = '',
3741 longHelpString = ''):
3742 '''Old style method to insert a tool in the toolbar.'''
3743 kind = wx.ITEM_NORMAL
3744 if isToggle: kind = wx.ITEM_CHECK
3745 return self.DoInsertTool(pos, id, '', bitmap, pushedBitmap, kind,
3746 shortHelpString, longHelpString, clientData)
3747
3748 def InsertSimpleTool(self, pos, id, bitmap,
3749 shortHelpString = '',
3750 longHelpString = '',
3751 isToggle = 0):
3752 '''Old style method to insert a tool in the toolbar.'''
3753 kind = wx.ITEM_NORMAL
3754 if isToggle: kind = wx.ITEM_CHECK
3755 return self.DoInsertTool(pos, id, '', bitmap, wx.NullBitmap, kind,
3756 shortHelpString, longHelpString, None)
3757
3758
3759 # The following are the new toolbar Add methods starting with
3760 # 2.3.3. They are renamed to have 'Label' in the name so as to be
3761 # able to keep backwards compatibility with using the above
3762 # methods. Eventually these should migrate to be the methods used
3763 # primarily and lose the 'Label' in the name...
3764
3765 def AddLabelTool(self, id, label, bitmap,
3766 bmpDisabled = wx.NullBitmap,
3767 kind = wx.ITEM_NORMAL,
3768 shortHelp = '', longHelp = '',
3769 clientData = None):
3770 '''
3771 The full AddTool() function.
3772
3773 If bmpDisabled is wx.NullBitmap, a shadowed version of the normal bitmap
3774 is created and used as the disabled image.
3775 '''
3776 return self.DoAddTool(id, label, bitmap, bmpDisabled, kind,
3777 shortHelp, longHelp, clientData)
3778
3779
3780 def InsertLabelTool(self, pos, id, label, bitmap,
3781 bmpDisabled = wx.NullBitmap,
3782 kind = wx.ITEM_NORMAL,
3783 shortHelp = '', longHelp = '',
3784 clientData = None):
3785 '''
3786 Insert the new tool at the given position, if pos == GetToolsCount(), it
3787 is equivalent to AddTool()
3788 '''
3789 return self.DoInsertTool(pos, id, label, bitmap, bmpDisabled, kind,
3790 shortHelp, longHelp, clientData)
3791
3792 def AddCheckLabelTool(self, id, label, bitmap,
3793 bmpDisabled = wx.NullBitmap,
3794 shortHelp = '', longHelp = '',
3795 clientData = None):
3796 '''Add a check tool, i.e. a tool which can be toggled'''
3797 return self.DoAddTool(id, label, bitmap, bmpDisabled, wx.ITEM_CHECK,
3798 shortHelp, longHelp, clientData)
3799
3800 def AddRadioLabelTool(self, id, label, bitmap,
3801 bmpDisabled = wx.NullBitmap,
3802 shortHelp = '', longHelp = '',
3803 clientData = None):
3804 '''
3805 Add a radio tool, i.e. a tool which can be toggled and releases any
3806 other toggled radio tools in the same group when it happens
3807 '''
3808 return self.DoAddTool(id, label, bitmap, bmpDisabled, wx.ITEM_RADIO,
3809 shortHelp, longHelp, clientData)
3810
3811
3812 # For consistency with the backwards compatible methods above, here are
3813 # some non-'Label' versions of the Check and Radio methods
3814
3815 def AddCheckTool(self, id, bitmap,
3816 bmpDisabled = wx.NullBitmap,
3817 shortHelp = '', longHelp = '',
3818 clientData = None):
3819 '''Add a check tool, i.e. a tool which can be toggled'''
3820 return self.DoAddTool(id, '', bitmap, bmpDisabled, wx.ITEM_CHECK,
3821 shortHelp, longHelp, clientData)
3822
3823 def AddRadioTool(self, id, bitmap,
3824 bmpDisabled = wx.NullBitmap,
3825 shortHelp = '', longHelp = '',
3826 clientData = None):
3827 '''
3828 Add a radio tool, i.e. a tool which can be toggled and releases any
3829 other toggled radio tools in the same group when it happens
3830 '''
3831 return self.DoAddTool(id, '', bitmap, bmpDisabled, wx.ITEM_RADIO,
3832 shortHelp, longHelp, clientData)
3833
3834 def AddToolItem(*args, **kwargs):
3835 """AddToolItem(self, ToolBarToolBase tool) -> ToolBarToolBase"""
3836 return _controls_.ToolBarBase_AddToolItem(*args, **kwargs)
3837
3838 def InsertToolItem(*args, **kwargs):
3839 """InsertToolItem(self, size_t pos, ToolBarToolBase tool) -> ToolBarToolBase"""
3840 return _controls_.ToolBarBase_InsertToolItem(*args, **kwargs)
3841
3842 def AddControl(*args, **kwargs):
3843 """AddControl(self, Control control, String label=wxEmptyString) -> ToolBarToolBase"""
3844 return _controls_.ToolBarBase_AddControl(*args, **kwargs)
3845
3846 def InsertControl(*args, **kwargs):
3847 """InsertControl(self, size_t pos, Control control, String label=wxEmptyString) -> ToolBarToolBase"""
3848 return _controls_.ToolBarBase_InsertControl(*args, **kwargs)
3849
3850 def FindControl(*args, **kwargs):
3851 """FindControl(self, int id) -> Control"""
3852 return _controls_.ToolBarBase_FindControl(*args, **kwargs)
3853
3854 def AddSeparator(*args, **kwargs):
3855 """AddSeparator(self) -> ToolBarToolBase"""
3856 return _controls_.ToolBarBase_AddSeparator(*args, **kwargs)
3857
3858 def InsertSeparator(*args, **kwargs):
3859 """InsertSeparator(self, size_t pos) -> ToolBarToolBase"""
3860 return _controls_.ToolBarBase_InsertSeparator(*args, **kwargs)
3861
3862 def RemoveTool(*args, **kwargs):
3863 """RemoveTool(self, int id) -> ToolBarToolBase"""
3864 return _controls_.ToolBarBase_RemoveTool(*args, **kwargs)
3865
3866 def DeleteToolByPos(*args, **kwargs):
3867 """DeleteToolByPos(self, size_t pos) -> bool"""
3868 return _controls_.ToolBarBase_DeleteToolByPos(*args, **kwargs)
3869
3870 def DeleteTool(*args, **kwargs):
3871 """DeleteTool(self, int id) -> bool"""
3872 return _controls_.ToolBarBase_DeleteTool(*args, **kwargs)
3873
3874 def ClearTools(*args, **kwargs):
3875 """ClearTools(self)"""
3876 return _controls_.ToolBarBase_ClearTools(*args, **kwargs)
3877
3878 def Realize(*args, **kwargs):
3879 """Realize(self) -> bool"""
3880 return _controls_.ToolBarBase_Realize(*args, **kwargs)
3881
3882 def EnableTool(*args, **kwargs):
3883 """EnableTool(self, int id, bool enable)"""
3884 return _controls_.ToolBarBase_EnableTool(*args, **kwargs)
3885
3886 def ToggleTool(*args, **kwargs):
3887 """ToggleTool(self, int id, bool toggle)"""
3888 return _controls_.ToolBarBase_ToggleTool(*args, **kwargs)
3889
3890 def SetToggle(*args, **kwargs):
3891 """SetToggle(self, int id, bool toggle)"""
3892 return _controls_.ToolBarBase_SetToggle(*args, **kwargs)
3893
3894 def GetToolClientData(*args, **kwargs):
3895 """GetToolClientData(self, int id) -> PyObject"""
3896 return _controls_.ToolBarBase_GetToolClientData(*args, **kwargs)
3897
3898 def SetToolClientData(*args, **kwargs):
3899 """SetToolClientData(self, int id, PyObject clientData)"""
3900 return _controls_.ToolBarBase_SetToolClientData(*args, **kwargs)
3901
3902 def GetToolPos(*args, **kwargs):
3903 """GetToolPos(self, int id) -> int"""
3904 return _controls_.ToolBarBase_GetToolPos(*args, **kwargs)
3905
3906 def GetToolState(*args, **kwargs):
3907 """GetToolState(self, int id) -> bool"""
3908 return _controls_.ToolBarBase_GetToolState(*args, **kwargs)
3909
3910 def GetToolEnabled(*args, **kwargs):
3911 """GetToolEnabled(self, int id) -> bool"""
3912 return _controls_.ToolBarBase_GetToolEnabled(*args, **kwargs)
3913
3914 def SetToolShortHelp(*args, **kwargs):
3915 """SetToolShortHelp(self, int id, String helpString)"""
3916 return _controls_.ToolBarBase_SetToolShortHelp(*args, **kwargs)
3917
3918 def GetToolShortHelp(*args, **kwargs):
3919 """GetToolShortHelp(self, int id) -> String"""
3920 return _controls_.ToolBarBase_GetToolShortHelp(*args, **kwargs)
3921
3922 def SetToolLongHelp(*args, **kwargs):
3923 """SetToolLongHelp(self, int id, String helpString)"""
3924 return _controls_.ToolBarBase_SetToolLongHelp(*args, **kwargs)
3925
3926 def GetToolLongHelp(*args, **kwargs):
3927 """GetToolLongHelp(self, int id) -> String"""
3928 return _controls_.ToolBarBase_GetToolLongHelp(*args, **kwargs)
3929
3930 def SetMarginsXY(*args, **kwargs):
3931 """SetMarginsXY(self, int x, int y)"""
3932 return _controls_.ToolBarBase_SetMarginsXY(*args, **kwargs)
3933
3934 def SetMargins(*args, **kwargs):
3935 """SetMargins(self, Size size)"""
3936 return _controls_.ToolBarBase_SetMargins(*args, **kwargs)
3937
3938 def SetToolPacking(*args, **kwargs):
3939 """SetToolPacking(self, int packing)"""
3940 return _controls_.ToolBarBase_SetToolPacking(*args, **kwargs)
3941
3942 def SetToolSeparation(*args, **kwargs):
3943 """SetToolSeparation(self, int separation)"""
3944 return _controls_.ToolBarBase_SetToolSeparation(*args, **kwargs)
3945
3946 def GetToolMargins(*args, **kwargs):
3947 """GetToolMargins(self) -> Size"""
3948 return _controls_.ToolBarBase_GetToolMargins(*args, **kwargs)
3949
3950 def GetMargins(*args, **kwargs):
3951 """GetMargins(self) -> Size"""
3952 return _controls_.ToolBarBase_GetMargins(*args, **kwargs)
3953
3954 def GetToolPacking(*args, **kwargs):
3955 """GetToolPacking(self) -> int"""
3956 return _controls_.ToolBarBase_GetToolPacking(*args, **kwargs)
3957
3958 def GetToolSeparation(*args, **kwargs):
3959 """GetToolSeparation(self) -> int"""
3960 return _controls_.ToolBarBase_GetToolSeparation(*args, **kwargs)
3961
3962 def SetRows(*args, **kwargs):
3963 """SetRows(self, int nRows)"""
3964 return _controls_.ToolBarBase_SetRows(*args, **kwargs)
3965
3966 def SetMaxRowsCols(*args, **kwargs):
3967 """SetMaxRowsCols(self, int rows, int cols)"""
3968 return _controls_.ToolBarBase_SetMaxRowsCols(*args, **kwargs)
3969
3970 def GetMaxRows(*args, **kwargs):
3971 """GetMaxRows(self) -> int"""
3972 return _controls_.ToolBarBase_GetMaxRows(*args, **kwargs)
3973
3974 def GetMaxCols(*args, **kwargs):
3975 """GetMaxCols(self) -> int"""
3976 return _controls_.ToolBarBase_GetMaxCols(*args, **kwargs)
3977
3978 def SetToolBitmapSize(*args, **kwargs):
3979 """SetToolBitmapSize(self, Size size)"""
3980 return _controls_.ToolBarBase_SetToolBitmapSize(*args, **kwargs)
3981
3982 def GetToolBitmapSize(*args, **kwargs):
3983 """GetToolBitmapSize(self) -> Size"""
3984 return _controls_.ToolBarBase_GetToolBitmapSize(*args, **kwargs)
3985
3986 def GetToolSize(*args, **kwargs):
3987 """GetToolSize(self) -> Size"""
3988 return _controls_.ToolBarBase_GetToolSize(*args, **kwargs)
3989
3990 def FindToolForPosition(*args, **kwargs):
3991 """FindToolForPosition(self, int x, int y) -> ToolBarToolBase"""
3992 return _controls_.ToolBarBase_FindToolForPosition(*args, **kwargs)
3993
3994 def FindById(*args, **kwargs):
3995 """FindById(self, int toolid) -> ToolBarToolBase"""
3996 return _controls_.ToolBarBase_FindById(*args, **kwargs)
3997
3998 def IsVertical(*args, **kwargs):
3999 """IsVertical(self) -> bool"""
4000 return _controls_.ToolBarBase_IsVertical(*args, **kwargs)
4001
4002 def GetToolsCount(*args, **kwargs):
4003 """GetToolsCount(self) -> size_t"""
4004 return _controls_.ToolBarBase_GetToolsCount(*args, **kwargs)
4005
4006 Margins = property(GetMargins,SetMargins,doc="See `GetMargins` and `SetMargins`")
4007 MaxCols = property(GetMaxCols,doc="See `GetMaxCols`")
4008 MaxRows = property(GetMaxRows,doc="See `GetMaxRows`")
4009 ToolBitmapSize = property(GetToolBitmapSize,SetToolBitmapSize,doc="See `GetToolBitmapSize` and `SetToolBitmapSize`")
4010 ToolMargins = property(GetToolMargins,doc="See `GetToolMargins`")
4011 ToolPacking = property(GetToolPacking,SetToolPacking,doc="See `GetToolPacking` and `SetToolPacking`")
4012 ToolSeparation = property(GetToolSeparation,SetToolSeparation,doc="See `GetToolSeparation` and `SetToolSeparation`")
4013 ToolSize = property(GetToolSize,doc="See `GetToolSize`")
4014 ToolsCount = property(GetToolsCount,doc="See `GetToolsCount`")
4015 _controls_.ToolBarBase_swigregister(ToolBarBase)
4016
4017 class ToolBar(ToolBarBase):
4018 """Proxy of C++ ToolBar class"""
4019 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4020 __repr__ = _swig_repr
4021 def __init__(self, *args, **kwargs):
4022 """
4023 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
4024 Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL,
4025 String name=wxPyToolBarNameStr) -> ToolBar
4026 """
4027 _controls_.ToolBar_swiginit(self,_controls_.new_ToolBar(*args, **kwargs))
4028 self._setOORInfo(self)
4029
4030 def Create(*args, **kwargs):
4031 """
4032 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
4033 Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL,
4034 String name=wxPyToolBarNameStr) -> bool
4035 """
4036 return _controls_.ToolBar_Create(*args, **kwargs)
4037
4038 def SetToolNormalBitmap(*args, **kwargs):
4039 """SetToolNormalBitmap(self, int id, Bitmap bitmap)"""
4040 return _controls_.ToolBar_SetToolNormalBitmap(*args, **kwargs)
4041
4042 def SetToolDisabledBitmap(*args, **kwargs):
4043 """SetToolDisabledBitmap(self, int id, Bitmap bitmap)"""
4044 return _controls_.ToolBar_SetToolDisabledBitmap(*args, **kwargs)
4045
4046 def GetClassDefaultAttributes(*args, **kwargs):
4047 """
4048 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
4049
4050 Get the default attributes for this class. This is useful if you want
4051 to use the same font or colour in your own control as in a standard
4052 control -- which is a much better idea than hard coding specific
4053 colours or fonts which might look completely out of place on the
4054 user's system, especially if it uses themes.
4055
4056 The variant parameter is only relevant under Mac currently and is
4057 ignore under other platforms. Under Mac, it will change the size of
4058 the returned font. See `wx.Window.SetWindowVariant` for more about
4059 this.
4060 """
4061 return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs)
4062
4063 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
4064 _controls_.ToolBar_swigregister(ToolBar)
4065
4066 def PreToolBar(*args, **kwargs):
4067 """PreToolBar() -> ToolBar"""
4068 val = _controls_.new_PreToolBar(*args, **kwargs)
4069 return val
4070
4071 def ToolBar_GetClassDefaultAttributes(*args, **kwargs):
4072 """
4073 ToolBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
4074
4075 Get the default attributes for this class. This is useful if you want
4076 to use the same font or colour in your own control as in a standard
4077 control -- which is a much better idea than hard coding specific
4078 colours or fonts which might look completely out of place on the
4079 user's system, especially if it uses themes.
4080
4081 The variant parameter is only relevant under Mac currently and is
4082 ignore under other platforms. Under Mac, it will change the size of
4083 the returned font. See `wx.Window.SetWindowVariant` for more about
4084 this.
4085 """
4086 return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs)
4087
4088 #---------------------------------------------------------------------------
4089
4090 LC_VRULES = _controls_.LC_VRULES
4091 LC_HRULES = _controls_.LC_HRULES
4092 LC_ICON = _controls_.LC_ICON
4093 LC_SMALL_ICON = _controls_.LC_SMALL_ICON
4094 LC_LIST = _controls_.LC_LIST
4095 LC_REPORT = _controls_.LC_REPORT
4096 LC_ALIGN_TOP = _controls_.LC_ALIGN_TOP
4097 LC_ALIGN_LEFT = _controls_.LC_ALIGN_LEFT
4098 LC_AUTOARRANGE = _controls_.LC_AUTOARRANGE
4099 LC_VIRTUAL = _controls_.LC_VIRTUAL
4100 LC_EDIT_LABELS = _controls_.LC_EDIT_LABELS
4101 LC_NO_HEADER = _controls_.LC_NO_HEADER
4102 LC_NO_SORT_HEADER = _controls_.LC_NO_SORT_HEADER
4103 LC_SINGLE_SEL = _controls_.LC_SINGLE_SEL
4104 LC_SORT_ASCENDING = _controls_.LC_SORT_ASCENDING
4105 LC_SORT_DESCENDING = _controls_.LC_SORT_DESCENDING
4106 LC_MASK_TYPE = _controls_.LC_MASK_TYPE
4107 LC_MASK_ALIGN = _controls_.LC_MASK_ALIGN
4108 LC_MASK_SORT = _controls_.LC_MASK_SORT
4109 LIST_MASK_STATE = _controls_.LIST_MASK_STATE
4110 LIST_MASK_TEXT = _controls_.LIST_MASK_TEXT
4111 LIST_MASK_IMAGE = _controls_.LIST_MASK_IMAGE
4112 LIST_MASK_DATA = _controls_.LIST_MASK_DATA
4113 LIST_SET_ITEM = _controls_.LIST_SET_ITEM
4114 LIST_MASK_WIDTH = _controls_.LIST_MASK_WIDTH
4115 LIST_MASK_FORMAT = _controls_.LIST_MASK_FORMAT
4116 LIST_STATE_DONTCARE = _controls_.LIST_STATE_DONTCARE
4117 LIST_STATE_DROPHILITED = _controls_.LIST_STATE_DROPHILITED
4118 LIST_STATE_FOCUSED = _controls_.LIST_STATE_FOCUSED
4119 LIST_STATE_SELECTED = _controls_.LIST_STATE_SELECTED
4120 LIST_STATE_CUT = _controls_.LIST_STATE_CUT
4121 LIST_STATE_DISABLED = _controls_.LIST_STATE_DISABLED
4122 LIST_STATE_FILTERED = _controls_.LIST_STATE_FILTERED
4123 LIST_STATE_INUSE = _controls_.LIST_STATE_INUSE
4124 LIST_STATE_PICKED = _controls_.LIST_STATE_PICKED
4125 LIST_STATE_SOURCE = _controls_.LIST_STATE_SOURCE
4126 LIST_HITTEST_ABOVE = _controls_.LIST_HITTEST_ABOVE
4127 LIST_HITTEST_BELOW = _controls_.LIST_HITTEST_BELOW
4128 LIST_HITTEST_NOWHERE = _controls_.LIST_HITTEST_NOWHERE
4129 LIST_HITTEST_ONITEMICON = _controls_.LIST_HITTEST_ONITEMICON
4130 LIST_HITTEST_ONITEMLABEL = _controls_.LIST_HITTEST_ONITEMLABEL
4131 LIST_HITTEST_ONITEMRIGHT = _controls_.LIST_HITTEST_ONITEMRIGHT
4132 LIST_HITTEST_ONITEMSTATEICON = _controls_.LIST_HITTEST_ONITEMSTATEICON
4133 LIST_HITTEST_TOLEFT = _controls_.LIST_HITTEST_TOLEFT
4134 LIST_HITTEST_TORIGHT = _controls_.LIST_HITTEST_TORIGHT
4135 LIST_HITTEST_ONITEM = _controls_.LIST_HITTEST_ONITEM
4136 LIST_GETSUBITEMRECT_WHOLEITEM = _controls_.LIST_GETSUBITEMRECT_WHOLEITEM
4137 LIST_NEXT_ABOVE = _controls_.LIST_NEXT_ABOVE
4138 LIST_NEXT_ALL = _controls_.LIST_NEXT_ALL
4139 LIST_NEXT_BELOW = _controls_.LIST_NEXT_BELOW
4140 LIST_NEXT_LEFT = _controls_.LIST_NEXT_LEFT
4141 LIST_NEXT_RIGHT = _controls_.LIST_NEXT_RIGHT
4142 LIST_ALIGN_DEFAULT = _controls_.LIST_ALIGN_DEFAULT
4143 LIST_ALIGN_LEFT = _controls_.LIST_ALIGN_LEFT
4144 LIST_ALIGN_TOP = _controls_.LIST_ALIGN_TOP
4145 LIST_ALIGN_SNAP_TO_GRID = _controls_.LIST_ALIGN_SNAP_TO_GRID
4146 LIST_FORMAT_LEFT = _controls_.LIST_FORMAT_LEFT
4147 LIST_FORMAT_RIGHT = _controls_.LIST_FORMAT_RIGHT
4148 LIST_FORMAT_CENTRE = _controls_.LIST_FORMAT_CENTRE
4149 LIST_FORMAT_CENTER = _controls_.LIST_FORMAT_CENTER
4150 LIST_AUTOSIZE = _controls_.LIST_AUTOSIZE
4151 LIST_AUTOSIZE_USEHEADER = _controls_.LIST_AUTOSIZE_USEHEADER
4152 LIST_RECT_BOUNDS = _controls_.LIST_RECT_BOUNDS
4153 LIST_RECT_ICON = _controls_.LIST_RECT_ICON
4154 LIST_RECT_LABEL = _controls_.LIST_RECT_LABEL
4155 LIST_FIND_UP = _controls_.LIST_FIND_UP
4156 LIST_FIND_DOWN = _controls_.LIST_FIND_DOWN
4157 LIST_FIND_LEFT = _controls_.LIST_FIND_LEFT
4158 LIST_FIND_RIGHT = _controls_.LIST_FIND_RIGHT
4159 #---------------------------------------------------------------------------
4160
4161 class ListItemAttr(object):
4162 """Proxy of C++ ListItemAttr class"""
4163 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4164 __repr__ = _swig_repr
4165 def __init__(self, *args, **kwargs):
4166 """
4167 __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour,
4168 Font font=wxNullFont) -> ListItemAttr
4169 """
4170 _controls_.ListItemAttr_swiginit(self,_controls_.new_ListItemAttr(*args, **kwargs))
4171 __swig_destroy__ = _controls_.delete_ListItemAttr
4172 __del__ = lambda self : None;
4173 def SetTextColour(*args, **kwargs):
4174 """SetTextColour(self, Colour colText)"""
4175 return _controls_.ListItemAttr_SetTextColour(*args, **kwargs)
4176
4177 def SetBackgroundColour(*args, **kwargs):
4178 """SetBackgroundColour(self, Colour colBack)"""
4179 return _controls_.ListItemAttr_SetBackgroundColour(*args, **kwargs)
4180
4181 def SetFont(*args, **kwargs):
4182 """SetFont(self, Font font)"""
4183 return _controls_.ListItemAttr_SetFont(*args, **kwargs)
4184
4185 def HasTextColour(*args, **kwargs):
4186 """HasTextColour(self) -> bool"""
4187 return _controls_.ListItemAttr_HasTextColour(*args, **kwargs)
4188
4189 def HasBackgroundColour(*args, **kwargs):
4190 """HasBackgroundColour(self) -> bool"""
4191 return _controls_.ListItemAttr_HasBackgroundColour(*args, **kwargs)
4192
4193 def HasFont(*args, **kwargs):
4194 """HasFont(self) -> bool"""
4195 return _controls_.ListItemAttr_HasFont(*args, **kwargs)
4196
4197 def GetTextColour(*args, **kwargs):
4198 """GetTextColour(self) -> Colour"""
4199 return _controls_.ListItemAttr_GetTextColour(*args, **kwargs)
4200
4201 def GetBackgroundColour(*args, **kwargs):
4202 """GetBackgroundColour(self) -> Colour"""
4203 return _controls_.ListItemAttr_GetBackgroundColour(*args, **kwargs)
4204
4205 def GetFont(*args, **kwargs):
4206 """GetFont(self) -> Font"""
4207 return _controls_.ListItemAttr_GetFont(*args, **kwargs)
4208
4209 def AssignFrom(*args, **kwargs):
4210 """AssignFrom(self, ListItemAttr source)"""
4211 return _controls_.ListItemAttr_AssignFrom(*args, **kwargs)
4212
4213 def Destroy(*args, **kwargs):
4214 """Destroy(self)"""
4215 args[0].this.own(False)
4216 return _controls_.ListItemAttr_Destroy(*args, **kwargs)
4217
4218 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
4219 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
4220 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
4221 _controls_.ListItemAttr_swigregister(ListItemAttr)
4222 ListCtrlNameStr = cvar.ListCtrlNameStr
4223
4224 #---------------------------------------------------------------------------
4225
4226 class ListItem(_core.Object):
4227 """Proxy of C++ ListItem class"""
4228 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4229 __repr__ = _swig_repr
4230 def __init__(self, *args, **kwargs):
4231 """__init__(self) -> ListItem"""
4232 _controls_.ListItem_swiginit(self,_controls_.new_ListItem(*args, **kwargs))
4233 __swig_destroy__ = _controls_.delete_ListItem
4234 __del__ = lambda self : None;
4235 def Clear(*args, **kwargs):
4236 """Clear(self)"""
4237 return _controls_.ListItem_Clear(*args, **kwargs)
4238
4239 def ClearAttributes(*args, **kwargs):
4240 """ClearAttributes(self)"""
4241 return _controls_.ListItem_ClearAttributes(*args, **kwargs)
4242
4243 def SetMask(*args, **kwargs):
4244 """SetMask(self, long mask)"""
4245 return _controls_.ListItem_SetMask(*args, **kwargs)
4246
4247 def SetId(*args, **kwargs):
4248 """SetId(self, long id)"""
4249 return _controls_.ListItem_SetId(*args, **kwargs)
4250
4251 def SetColumn(*args, **kwargs):
4252 """SetColumn(self, int col)"""
4253 return _controls_.ListItem_SetColumn(*args, **kwargs)
4254
4255 def SetState(*args, **kwargs):
4256 """SetState(self, long state)"""
4257 return _controls_.ListItem_SetState(*args, **kwargs)
4258
4259 def SetStateMask(*args, **kwargs):
4260 """SetStateMask(self, long stateMask)"""
4261 return _controls_.ListItem_SetStateMask(*args, **kwargs)
4262
4263 def SetText(*args, **kwargs):
4264 """SetText(self, String text)"""
4265 return _controls_.ListItem_SetText(*args, **kwargs)
4266
4267 def SetImage(*args, **kwargs):
4268 """SetImage(self, int image)"""
4269 return _controls_.ListItem_SetImage(*args, **kwargs)
4270
4271 def SetData(*args, **kwargs):
4272 """SetData(self, long data)"""
4273 return _controls_.ListItem_SetData(*args, **kwargs)
4274
4275 def SetWidth(*args, **kwargs):
4276 """SetWidth(self, int width)"""
4277 return _controls_.ListItem_SetWidth(*args, **kwargs)
4278
4279 def SetAlign(*args, **kwargs):
4280 """SetAlign(self, int align)"""
4281 return _controls_.ListItem_SetAlign(*args, **kwargs)
4282
4283 def SetTextColour(*args, **kwargs):
4284 """SetTextColour(self, Colour colText)"""
4285 return _controls_.ListItem_SetTextColour(*args, **kwargs)
4286
4287 def SetBackgroundColour(*args, **kwargs):
4288 """SetBackgroundColour(self, Colour colBack)"""
4289 return _controls_.ListItem_SetBackgroundColour(*args, **kwargs)
4290
4291 def SetFont(*args, **kwargs):
4292 """SetFont(self, Font font)"""
4293 return _controls_.ListItem_SetFont(*args, **kwargs)
4294
4295 def GetMask(*args, **kwargs):
4296 """GetMask(self) -> long"""
4297 return _controls_.ListItem_GetMask(*args, **kwargs)
4298
4299 def GetId(*args, **kwargs):
4300 """GetId(self) -> long"""
4301 return _controls_.ListItem_GetId(*args, **kwargs)
4302
4303 def GetColumn(*args, **kwargs):
4304 """GetColumn(self) -> int"""
4305 return _controls_.ListItem_GetColumn(*args, **kwargs)
4306
4307 def GetState(*args, **kwargs):
4308 """GetState(self) -> long"""
4309 return _controls_.ListItem_GetState(*args, **kwargs)
4310
4311 def GetText(*args, **kwargs):
4312 """GetText(self) -> String"""
4313 return _controls_.ListItem_GetText(*args, **kwargs)
4314
4315 def GetImage(*args, **kwargs):
4316 """GetImage(self) -> int"""
4317 return _controls_.ListItem_GetImage(*args, **kwargs)
4318
4319 def GetData(*args, **kwargs):
4320 """GetData(self) -> long"""
4321 return _controls_.ListItem_GetData(*args, **kwargs)
4322
4323 def GetWidth(*args, **kwargs):
4324 """GetWidth(self) -> int"""
4325 return _controls_.ListItem_GetWidth(*args, **kwargs)
4326
4327 def GetAlign(*args, **kwargs):
4328 """GetAlign(self) -> int"""
4329 return _controls_.ListItem_GetAlign(*args, **kwargs)
4330
4331 def GetAttributes(*args, **kwargs):
4332 """GetAttributes(self) -> ListItemAttr"""
4333 return _controls_.ListItem_GetAttributes(*args, **kwargs)
4334
4335 def HasAttributes(*args, **kwargs):
4336 """HasAttributes(self) -> bool"""
4337 return _controls_.ListItem_HasAttributes(*args, **kwargs)
4338
4339 def GetTextColour(*args, **kwargs):
4340 """GetTextColour(self) -> Colour"""
4341 return _controls_.ListItem_GetTextColour(*args, **kwargs)
4342
4343 def GetBackgroundColour(*args, **kwargs):
4344 """GetBackgroundColour(self) -> Colour"""
4345 return _controls_.ListItem_GetBackgroundColour(*args, **kwargs)
4346
4347 def GetFont(*args, **kwargs):
4348 """GetFont(self) -> Font"""
4349 return _controls_.ListItem_GetFont(*args, **kwargs)
4350
4351 m_mask = property(_controls_.ListItem_m_mask_get, _controls_.ListItem_m_mask_set)
4352 m_itemId = property(_controls_.ListItem_m_itemId_get, _controls_.ListItem_m_itemId_set)
4353 m_col = property(_controls_.ListItem_m_col_get, _controls_.ListItem_m_col_set)
4354 m_state = property(_controls_.ListItem_m_state_get, _controls_.ListItem_m_state_set)
4355 m_stateMask = property(_controls_.ListItem_m_stateMask_get, _controls_.ListItem_m_stateMask_set)
4356 m_text = property(_controls_.ListItem_m_text_get, _controls_.ListItem_m_text_set)
4357 m_image = property(_controls_.ListItem_m_image_get, _controls_.ListItem_m_image_set)
4358 m_data = property(_controls_.ListItem_m_data_get, _controls_.ListItem_m_data_set)
4359 m_format = property(_controls_.ListItem_m_format_get, _controls_.ListItem_m_format_set)
4360 m_width = property(_controls_.ListItem_m_width_get, _controls_.ListItem_m_width_set)
4361 Align = property(GetAlign,SetAlign,doc="See `GetAlign` and `SetAlign`")
4362 Attributes = property(GetAttributes,doc="See `GetAttributes`")
4363 BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`")
4364 Column = property(GetColumn,SetColumn,doc="See `GetColumn` and `SetColumn`")
4365 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
4366 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
4367 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4368 Image = property(GetImage,SetImage,doc="See `GetImage` and `SetImage`")
4369 Mask = property(GetMask,SetMask,doc="See `GetMask` and `SetMask`")
4370 State = property(GetState,SetState,doc="See `GetState` and `SetState`")
4371 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
4372 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
4373 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
4374 _controls_.ListItem_swigregister(ListItem)
4375
4376 #---------------------------------------------------------------------------
4377
4378 class ListEvent(_core.NotifyEvent):
4379 """Proxy of C++ ListEvent class"""
4380 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4381 __repr__ = _swig_repr
4382 def __init__(self, *args, **kwargs):
4383 """__init__(self, EventType commandType=wxEVT_NULL, int id=0) -> ListEvent"""
4384 _controls_.ListEvent_swiginit(self,_controls_.new_ListEvent(*args, **kwargs))
4385 m_code = property(_controls_.ListEvent_m_code_get, _controls_.ListEvent_m_code_set)
4386 m_oldItemIndex = property(_controls_.ListEvent_m_oldItemIndex_get, _controls_.ListEvent_m_oldItemIndex_set)
4387 m_itemIndex = property(_controls_.ListEvent_m_itemIndex_get, _controls_.ListEvent_m_itemIndex_set)
4388 m_col = property(_controls_.ListEvent_m_col_get, _controls_.ListEvent_m_col_set)
4389 m_pointDrag = property(_controls_.ListEvent_m_pointDrag_get, _controls_.ListEvent_m_pointDrag_set)
4390 m_item = property(_controls_.ListEvent_m_item_get)
4391 def GetKeyCode(*args, **kwargs):
4392 """GetKeyCode(self) -> int"""
4393 return _controls_.ListEvent_GetKeyCode(*args, **kwargs)
4394
4395 GetCode = GetKeyCode
4396 def GetIndex(*args, **kwargs):
4397 """GetIndex(self) -> long"""
4398 return _controls_.ListEvent_GetIndex(*args, **kwargs)
4399
4400 def GetColumn(*args, **kwargs):
4401 """GetColumn(self) -> int"""
4402 return _controls_.ListEvent_GetColumn(*args, **kwargs)
4403
4404 def GetPoint(*args, **kwargs):
4405 """GetPoint(self) -> Point"""
4406 return _controls_.ListEvent_GetPoint(*args, **kwargs)
4407
4408 GetPosition = GetPoint
4409 def GetLabel(*args, **kwargs):
4410 """GetLabel(self) -> String"""
4411 return _controls_.ListEvent_GetLabel(*args, **kwargs)
4412
4413 def GetText(*args, **kwargs):
4414 """GetText(self) -> String"""
4415 return _controls_.ListEvent_GetText(*args, **kwargs)
4416
4417 def GetImage(*args, **kwargs):
4418 """GetImage(self) -> int"""
4419 return _controls_.ListEvent_GetImage(*args, **kwargs)
4420
4421 def GetData(*args, **kwargs):
4422 """GetData(self) -> long"""
4423 return _controls_.ListEvent_GetData(*args, **kwargs)
4424
4425 def GetMask(*args, **kwargs):
4426 """GetMask(self) -> long"""
4427 return _controls_.ListEvent_GetMask(*args, **kwargs)
4428
4429 def GetItem(*args, **kwargs):
4430 """GetItem(self) -> ListItem"""
4431 return _controls_.ListEvent_GetItem(*args, **kwargs)
4432
4433 def GetCacheFrom(*args, **kwargs):
4434 """GetCacheFrom(self) -> long"""
4435 return _controls_.ListEvent_GetCacheFrom(*args, **kwargs)
4436
4437 def GetCacheTo(*args, **kwargs):
4438 """GetCacheTo(self) -> long"""
4439 return _controls_.ListEvent_GetCacheTo(*args, **kwargs)
4440
4441 def IsEditCancelled(*args, **kwargs):
4442 """IsEditCancelled(self) -> bool"""
4443 return _controls_.ListEvent_IsEditCancelled(*args, **kwargs)
4444
4445 def SetEditCanceled(*args, **kwargs):
4446 """SetEditCanceled(self, bool editCancelled)"""
4447 return _controls_.ListEvent_SetEditCanceled(*args, **kwargs)
4448
4449 CacheFrom = property(GetCacheFrom,doc="See `GetCacheFrom`")
4450 CacheTo = property(GetCacheTo,doc="See `GetCacheTo`")
4451 Column = property(GetColumn,doc="See `GetColumn`")
4452 Data = property(GetData,doc="See `GetData`")
4453 Image = property(GetImage,doc="See `GetImage`")
4454 Index = property(GetIndex,doc="See `GetIndex`")
4455 Item = property(GetItem,doc="See `GetItem`")
4456 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
4457 Label = property(GetLabel,doc="See `GetLabel`")
4458 Mask = property(GetMask,doc="See `GetMask`")
4459 Point = property(GetPoint,doc="See `GetPoint`")
4460 Text = property(GetText,doc="See `GetText`")
4461 _controls_.ListEvent_swigregister(ListEvent)
4462
4463 wxEVT_COMMAND_LIST_BEGIN_DRAG = _controls_.wxEVT_COMMAND_LIST_BEGIN_DRAG
4464 wxEVT_COMMAND_LIST_BEGIN_RDRAG = _controls_.wxEVT_COMMAND_LIST_BEGIN_RDRAG
4465 wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT = _controls_.wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
4466 wxEVT_COMMAND_LIST_END_LABEL_EDIT = _controls_.wxEVT_COMMAND_LIST_END_LABEL_EDIT
4467 wxEVT_COMMAND_LIST_DELETE_ITEM = _controls_.wxEVT_COMMAND_LIST_DELETE_ITEM
4468 wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS = _controls_.wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
4469 wxEVT_COMMAND_LIST_ITEM_SELECTED = _controls_.wxEVT_COMMAND_LIST_ITEM_SELECTED
4470 wxEVT_COMMAND_LIST_ITEM_DESELECTED = _controls_.wxEVT_COMMAND_LIST_ITEM_DESELECTED
4471 wxEVT_COMMAND_LIST_KEY_DOWN = _controls_.wxEVT_COMMAND_LIST_KEY_DOWN
4472 wxEVT_COMMAND_LIST_INSERT_ITEM = _controls_.wxEVT_COMMAND_LIST_INSERT_ITEM
4473 wxEVT_COMMAND_LIST_COL_CLICK = _controls_.wxEVT_COMMAND_LIST_COL_CLICK
4474 wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK = _controls_.wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
4475 wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK = _controls_.wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK
4476 wxEVT_COMMAND_LIST_ITEM_ACTIVATED = _controls_.wxEVT_COMMAND_LIST_ITEM_ACTIVATED
4477 wxEVT_COMMAND_LIST_CACHE_HINT = _controls_.wxEVT_COMMAND_LIST_CACHE_HINT
4478 wxEVT_COMMAND_LIST_COL_RIGHT_CLICK = _controls_.wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
4479 wxEVT_COMMAND_LIST_COL_BEGIN_DRAG = _controls_.wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
4480 wxEVT_COMMAND_LIST_COL_DRAGGING = _controls_.wxEVT_COMMAND_LIST_COL_DRAGGING
4481 wxEVT_COMMAND_LIST_COL_END_DRAG = _controls_.wxEVT_COMMAND_LIST_COL_END_DRAG
4482 wxEVT_COMMAND_LIST_ITEM_FOCUSED = _controls_.wxEVT_COMMAND_LIST_ITEM_FOCUSED
4483 EVT_LIST_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_DRAG , 1)
4484 EVT_LIST_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_RDRAG , 1)
4485 EVT_LIST_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT , 1)
4486 EVT_LIST_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_LIST_END_LABEL_EDIT , 1)
4487 EVT_LIST_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ITEM , 1)
4488 EVT_LIST_DELETE_ALL_ITEMS = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS , 1)
4489
4490
4491
4492
4493 EVT_LIST_ITEM_SELECTED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_SELECTED , 1)
4494 EVT_LIST_ITEM_DESELECTED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_DESELECTED , 1)
4495 EVT_LIST_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_LIST_KEY_DOWN , 1)
4496 EVT_LIST_INSERT_ITEM = wx.PyEventBinder(wxEVT_COMMAND_LIST_INSERT_ITEM , 1)
4497 EVT_LIST_COL_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_CLICK , 1)
4498 EVT_LIST_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK , 1)
4499 EVT_LIST_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 1)
4500 EVT_LIST_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_ACTIVATED , 1)
4501 EVT_LIST_CACHE_HINT = wx.PyEventBinder(wxEVT_COMMAND_LIST_CACHE_HINT , 1)
4502 EVT_LIST_COL_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK , 1)
4503 EVT_LIST_COL_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG , 1)
4504 EVT_LIST_COL_DRAGGING = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_DRAGGING , 1)
4505 EVT_LIST_COL_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_END_DRAG , 1)
4506 EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED , 1)
4507
4508
4509
4510
4511
4512 #---------------------------------------------------------------------------
4513
4514 class ListCtrl(_core.Control):
4515 """Proxy of C++ ListCtrl class"""
4516 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4517 __repr__ = _swig_repr
4518 def __init__(self, *args, **kwargs):
4519 """
4520 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
4521 Size size=DefaultSize, long style=LC_ICON,
4522 Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListCtrl
4523 """
4524 _controls_.ListCtrl_swiginit(self,_controls_.new_ListCtrl(*args, **kwargs))
4525 self._setOORInfo(self);ListCtrl._setCallbackInfo(self, self, ListCtrl)
4526
4527 def Create(*args, **kwargs):
4528 """
4529 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
4530 Size size=DefaultSize, long style=LC_ICON,
4531 Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool
4532
4533 Do the 2nd phase and create the GUI control.
4534 """
4535 return _controls_.ListCtrl_Create(*args, **kwargs)
4536
4537 def _setCallbackInfo(*args, **kwargs):
4538 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
4539 return _controls_.ListCtrl__setCallbackInfo(*args, **kwargs)
4540
4541 def GetColumn(*args, **kwargs):
4542 """GetColumn(self, int col) -> ListItem"""
4543 val = _controls_.ListCtrl_GetColumn(*args, **kwargs)
4544 if val is not None: val.thisown = 1
4545 return val
4546
4547 def SetColumn(*args, **kwargs):
4548 """SetColumn(self, int col, ListItem item) -> bool"""
4549 return _controls_.ListCtrl_SetColumn(*args, **kwargs)
4550
4551 def GetColumnWidth(*args, **kwargs):
4552 """GetColumnWidth(self, int col) -> int"""
4553 return _controls_.ListCtrl_GetColumnWidth(*args, **kwargs)
4554
4555 def SetColumnWidth(*args, **kwargs):
4556 """SetColumnWidth(self, int col, int width) -> bool"""
4557 return _controls_.ListCtrl_SetColumnWidth(*args, **kwargs)
4558
4559 def GetCountPerPage(*args, **kwargs):
4560 """GetCountPerPage(self) -> int"""
4561 return _controls_.ListCtrl_GetCountPerPage(*args, **kwargs)
4562
4563 def GetViewRect(*args, **kwargs):
4564 """GetViewRect(self) -> Rect"""
4565 return _controls_.ListCtrl_GetViewRect(*args, **kwargs)
4566
4567 def GetEditControl(*args, **kwargs):
4568 """GetEditControl(self) -> TextCtrl"""
4569 return _controls_.ListCtrl_GetEditControl(*args, **kwargs)
4570
4571 def GetItem(*args, **kwargs):
4572 """GetItem(self, long itemId, int col=0) -> ListItem"""
4573 val = _controls_.ListCtrl_GetItem(*args, **kwargs)
4574 if val is not None: val.thisown = 1
4575 return val
4576
4577 def SetItem(*args, **kwargs):
4578 """SetItem(self, ListItem info) -> bool"""
4579 return _controls_.ListCtrl_SetItem(*args, **kwargs)
4580
4581 def SetStringItem(*args, **kwargs):
4582 """SetStringItem(self, long index, int col, String label, int imageId=-1) -> long"""
4583 return _controls_.ListCtrl_SetStringItem(*args, **kwargs)
4584
4585 def GetItemState(*args, **kwargs):
4586 """GetItemState(self, long item, long stateMask) -> int"""
4587 return _controls_.ListCtrl_GetItemState(*args, **kwargs)
4588
4589 def SetItemState(*args, **kwargs):
4590 """SetItemState(self, long item, long state, long stateMask) -> bool"""
4591 return _controls_.ListCtrl_SetItemState(*args, **kwargs)
4592
4593 def SetItemImage(*args, **kwargs):
4594 """SetItemImage(self, long item, int image, int selImage=-1) -> bool"""
4595 return _controls_.ListCtrl_SetItemImage(*args, **kwargs)
4596
4597 def SetItemColumnImage(*args, **kwargs):
4598 """SetItemColumnImage(self, long item, long column, int image) -> bool"""
4599 return _controls_.ListCtrl_SetItemColumnImage(*args, **kwargs)
4600
4601 def GetItemText(*args, **kwargs):
4602 """GetItemText(self, long item) -> String"""
4603 return _controls_.ListCtrl_GetItemText(*args, **kwargs)
4604
4605 def SetItemText(*args, **kwargs):
4606 """SetItemText(self, long item, String str)"""
4607 return _controls_.ListCtrl_SetItemText(*args, **kwargs)
4608
4609 def GetItemData(*args, **kwargs):
4610 """GetItemData(self, long item) -> long"""
4611 return _controls_.ListCtrl_GetItemData(*args, **kwargs)
4612
4613 def SetItemData(*args, **kwargs):
4614 """SetItemData(self, long item, long data) -> bool"""
4615 return _controls_.ListCtrl_SetItemData(*args, **kwargs)
4616
4617 def GetItemPosition(*args, **kwargs):
4618 """GetItemPosition(self, long item) -> Point"""
4619 return _controls_.ListCtrl_GetItemPosition(*args, **kwargs)
4620
4621 def GetItemRect(*args, **kwargs):
4622 """GetItemRect(self, long item, int code=LIST_RECT_BOUNDS) -> Rect"""
4623 return _controls_.ListCtrl_GetItemRect(*args, **kwargs)
4624
4625 def SetItemPosition(*args, **kwargs):
4626 """SetItemPosition(self, long item, Point pos) -> bool"""
4627 return _controls_.ListCtrl_SetItemPosition(*args, **kwargs)
4628
4629 def GetItemCount(*args, **kwargs):
4630 """GetItemCount(self) -> int"""
4631 return _controls_.ListCtrl_GetItemCount(*args, **kwargs)
4632
4633 def GetColumnCount(*args, **kwargs):
4634 """GetColumnCount(self) -> int"""
4635 return _controls_.ListCtrl_GetColumnCount(*args, **kwargs)
4636
4637 def GetItemSpacing(*args, **kwargs):
4638 """GetItemSpacing(self) -> Size"""
4639 return _controls_.ListCtrl_GetItemSpacing(*args, **kwargs)
4640
4641 GetItemSpacing = wx._deprecated(GetItemSpacing)
4642 def GetSelectedItemCount(*args, **kwargs):
4643 """GetSelectedItemCount(self) -> int"""
4644 return _controls_.ListCtrl_GetSelectedItemCount(*args, **kwargs)
4645
4646 def GetTextColour(*args, **kwargs):
4647 """GetTextColour(self) -> Colour"""
4648 return _controls_.ListCtrl_GetTextColour(*args, **kwargs)
4649
4650 def SetTextColour(*args, **kwargs):
4651 """SetTextColour(self, Colour col)"""
4652 return _controls_.ListCtrl_SetTextColour(*args, **kwargs)
4653
4654 def GetTopItem(*args, **kwargs):
4655 """GetTopItem(self) -> long"""
4656 return _controls_.ListCtrl_GetTopItem(*args, **kwargs)
4657
4658 def SetSingleStyle(*args, **kwargs):
4659 """SetSingleStyle(self, long style, bool add=True)"""
4660 return _controls_.ListCtrl_SetSingleStyle(*args, **kwargs)
4661
4662 def GetNextItem(*args, **kwargs):
4663 """GetNextItem(self, long item, int geometry=LIST_NEXT_ALL, int state=LIST_STATE_DONTCARE) -> long"""
4664 return _controls_.ListCtrl_GetNextItem(*args, **kwargs)
4665
4666 def GetImageList(*args, **kwargs):
4667 """GetImageList(self, int which) -> ImageList"""
4668 return _controls_.ListCtrl_GetImageList(*args, **kwargs)
4669
4670 def SetImageList(*args, **kwargs):
4671 """SetImageList(self, ImageList imageList, int which)"""
4672 return _controls_.ListCtrl_SetImageList(*args, **kwargs)
4673
4674 def AssignImageList(*args, **kwargs):
4675 """AssignImageList(self, ImageList imageList, int which)"""
4676 return _controls_.ListCtrl_AssignImageList(*args, **kwargs)
4677
4678 def InReportView(*args, **kwargs):
4679 """InReportView(self) -> bool"""
4680 return _controls_.ListCtrl_InReportView(*args, **kwargs)
4681
4682 def IsVirtual(*args, **kwargs):
4683 """IsVirtual(self) -> bool"""
4684 return _controls_.ListCtrl_IsVirtual(*args, **kwargs)
4685
4686 def RefreshItem(*args, **kwargs):
4687 """RefreshItem(self, long item)"""
4688 return _controls_.ListCtrl_RefreshItem(*args, **kwargs)
4689
4690 def RefreshItems(*args, **kwargs):
4691 """RefreshItems(self, long itemFrom, long itemTo)"""
4692 return _controls_.ListCtrl_RefreshItems(*args, **kwargs)
4693
4694 def Arrange(*args, **kwargs):
4695 """Arrange(self, int flag=LIST_ALIGN_DEFAULT) -> bool"""
4696 return _controls_.ListCtrl_Arrange(*args, **kwargs)
4697
4698 def DeleteItem(*args, **kwargs):
4699 """DeleteItem(self, long item) -> bool"""
4700 return _controls_.ListCtrl_DeleteItem(*args, **kwargs)
4701
4702 def DeleteAllItems(*args, **kwargs):
4703 """DeleteAllItems(self) -> bool"""
4704 return _controls_.ListCtrl_DeleteAllItems(*args, **kwargs)
4705
4706 def DeleteColumn(*args, **kwargs):
4707 """DeleteColumn(self, int col) -> bool"""
4708 return _controls_.ListCtrl_DeleteColumn(*args, **kwargs)
4709
4710 def DeleteAllColumns(*args, **kwargs):
4711 """DeleteAllColumns(self) -> bool"""
4712 return _controls_.ListCtrl_DeleteAllColumns(*args, **kwargs)
4713
4714 def ClearAll(*args, **kwargs):
4715 """ClearAll(self)"""
4716 return _controls_.ListCtrl_ClearAll(*args, **kwargs)
4717
4718 def EditLabel(*args, **kwargs):
4719 """EditLabel(self, long item) -> TextCtrl"""
4720 return _controls_.ListCtrl_EditLabel(*args, **kwargs)
4721
4722 def EndEditLabel(*args, **kwargs):
4723 """EndEditLabel(self, bool cancel) -> bool"""
4724 return _controls_.ListCtrl_EndEditLabel(*args, **kwargs)
4725
4726 def EnsureVisible(*args, **kwargs):
4727 """EnsureVisible(self, long item) -> bool"""
4728 return _controls_.ListCtrl_EnsureVisible(*args, **kwargs)
4729
4730 def FindItem(*args, **kwargs):
4731 """FindItem(self, long start, String str, bool partial=False) -> long"""
4732 return _controls_.ListCtrl_FindItem(*args, **kwargs)
4733
4734 def FindItemData(*args, **kwargs):
4735 """FindItemData(self, long start, long data) -> long"""
4736 return _controls_.ListCtrl_FindItemData(*args, **kwargs)
4737
4738 def FindItemAtPos(*args, **kwargs):
4739 """FindItemAtPos(self, long start, Point pt, int direction) -> long"""
4740 return _controls_.ListCtrl_FindItemAtPos(*args, **kwargs)
4741
4742 def HitTest(*args, **kwargs):
4743 """
4744 HitTest(Point point) -> (item, where)
4745
4746 Determines which item (if any) is at the specified point, giving
4747 in the second return value (see wx.LIST_HITTEST flags.)
4748 """
4749 return _controls_.ListCtrl_HitTest(*args, **kwargs)
4750
4751 def HitTestSubItem(*args, **kwargs):
4752 """
4753 HitTestSubItem(Point point) -> (item, where, subItem)
4754
4755 Determines which item (if any) is at the specified point, giving in
4756 the second return value (see wx.LIST_HITTEST flags) and also the subItem, if
4757 any.
4758 """
4759 return _controls_.ListCtrl_HitTestSubItem(*args, **kwargs)
4760
4761 def InsertItem(*args, **kwargs):
4762 """InsertItem(self, ListItem info) -> long"""
4763 return _controls_.ListCtrl_InsertItem(*args, **kwargs)
4764
4765 def InsertStringItem(*args, **kwargs):
4766 """InsertStringItem(self, long index, String label, int imageIndex=-1) -> long"""
4767 return _controls_.ListCtrl_InsertStringItem(*args, **kwargs)
4768
4769 def InsertImageItem(*args, **kwargs):
4770 """InsertImageItem(self, long index, int imageIndex) -> long"""
4771 return _controls_.ListCtrl_InsertImageItem(*args, **kwargs)
4772
4773 def InsertImageStringItem(*args, **kwargs):
4774 """InsertImageStringItem(self, long index, String label, int imageIndex) -> long"""
4775 return _controls_.ListCtrl_InsertImageStringItem(*args, **kwargs)
4776
4777 def InsertColumnItem(*args, **kwargs):
4778 """InsertColumnItem(self, long col, ListItem info) -> long"""
4779 return _controls_.ListCtrl_InsertColumnItem(*args, **kwargs)
4780
4781 InsertColumnInfo = InsertColumnItem
4782 def InsertColumn(*args, **kwargs):
4783 """
4784 InsertColumn(self, long col, String heading, int format=LIST_FORMAT_LEFT,
4785 int width=-1) -> long
4786 """
4787 return _controls_.ListCtrl_InsertColumn(*args, **kwargs)
4788
4789 def SetItemCount(*args, **kwargs):
4790 """SetItemCount(self, long count)"""
4791 return _controls_.ListCtrl_SetItemCount(*args, **kwargs)
4792
4793 def ScrollList(*args, **kwargs):
4794 """ScrollList(self, int dx, int dy) -> bool"""
4795 return _controls_.ListCtrl_ScrollList(*args, **kwargs)
4796
4797 def SetItemTextColour(*args, **kwargs):
4798 """SetItemTextColour(self, long item, Colour col)"""
4799 return _controls_.ListCtrl_SetItemTextColour(*args, **kwargs)
4800
4801 def GetItemTextColour(*args, **kwargs):
4802 """GetItemTextColour(self, long item) -> Colour"""
4803 return _controls_.ListCtrl_GetItemTextColour(*args, **kwargs)
4804
4805 def SetItemBackgroundColour(*args, **kwargs):
4806 """SetItemBackgroundColour(self, long item, Colour col)"""
4807 return _controls_.ListCtrl_SetItemBackgroundColour(*args, **kwargs)
4808
4809 def GetItemBackgroundColour(*args, **kwargs):
4810 """GetItemBackgroundColour(self, long item) -> Colour"""
4811 return _controls_.ListCtrl_GetItemBackgroundColour(*args, **kwargs)
4812
4813 def SetItemFont(*args, **kwargs):
4814 """SetItemFont(self, long item, Font f)"""
4815 return _controls_.ListCtrl_SetItemFont(*args, **kwargs)
4816
4817 def GetItemFont(*args, **kwargs):
4818 """GetItemFont(self, long item) -> Font"""
4819 return _controls_.ListCtrl_GetItemFont(*args, **kwargs)
4820
4821 #
4822 # Some helpers...
4823 def Select(self, idx, on=1):
4824 '''[de]select an item'''
4825 if on: state = wx.LIST_STATE_SELECTED
4826 else: state = 0
4827 self.SetItemState(idx, state, wx.LIST_STATE_SELECTED)
4828
4829 def Focus(self, idx):
4830 '''Focus and show the given item'''
4831 self.SetItemState(idx, wx.LIST_STATE_FOCUSED, wx.LIST_STATE_FOCUSED)
4832 self.EnsureVisible(idx)
4833
4834 def GetFocusedItem(self):
4835 '''get the currently focused item or -1 if none'''
4836 return self.GetNextItem(-1, wx.LIST_NEXT_ALL, wx.LIST_STATE_FOCUSED)
4837
4838 def GetFirstSelected(self, *args):
4839 '''return first selected item, or -1 when none'''
4840 return self.GetNextSelected(-1)
4841
4842 def GetNextSelected(self, item):
4843 '''return subsequent selected items, or -1 when no more'''
4844 return self.GetNextItem(item, wx.LIST_NEXT_ALL, wx.LIST_STATE_SELECTED)
4845
4846 def IsSelected(self, idx):
4847 '''return True if the item is selected'''
4848 return (self.GetItemState(idx, wx.LIST_STATE_SELECTED) & wx.LIST_STATE_SELECTED) != 0
4849
4850 def SetColumnImage(self, col, image):
4851 item = self.GetColumn(col)
4852 # preserve all other attributes too
4853 item.SetMask( wx.LIST_MASK_STATE |
4854 wx.LIST_MASK_TEXT |
4855 wx.LIST_MASK_IMAGE |
4856 wx.LIST_MASK_DATA |
4857 wx.LIST_SET_ITEM |
4858 wx.LIST_MASK_WIDTH |
4859 wx.LIST_MASK_FORMAT )
4860 item.SetImage(image)
4861 self.SetColumn(col, item)
4862
4863 def ClearColumnImage(self, col):
4864 self.SetColumnImage(col, -1)
4865
4866 def Append(self, entry):
4867 '''Append an item to the list control. The entry parameter should be a
4868 sequence with an item for each column'''
4869 if len(entry):
4870 if wx.USE_UNICODE:
4871 cvtfunc = unicode
4872 else:
4873 cvtfunc = str
4874 pos = self.GetItemCount()
4875 self.InsertStringItem(pos, cvtfunc(entry[0]))
4876 for i in range(1, len(entry)):
4877 self.SetStringItem(pos, i, cvtfunc(entry[i]))
4878 return pos
4879
4880 def SortItems(*args, **kwargs):
4881 """SortItems(self, PyObject func) -> bool"""
4882 return _controls_.ListCtrl_SortItems(*args, **kwargs)
4883
4884 def GetMainWindow(*args, **kwargs):
4885 """GetMainWindow(self) -> Window"""
4886 return _controls_.ListCtrl_GetMainWindow(*args, **kwargs)
4887
4888 def GetClassDefaultAttributes(*args, **kwargs):
4889 """
4890 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
4891
4892 Get the default attributes for this class. This is useful if you want
4893 to use the same font or colour in your own control as in a standard
4894 control -- which is a much better idea than hard coding specific
4895 colours or fonts which might look completely out of place on the
4896 user's system, especially if it uses themes.
4897
4898 The variant parameter is only relevant under Mac currently and is
4899 ignore under other platforms. Under Mac, it will change the size of
4900 the returned font. See `wx.Window.SetWindowVariant` for more about
4901 this.
4902 """
4903 return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs)
4904
4905 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
4906 ColumnCount = property(GetColumnCount,doc="See `GetColumnCount`")
4907 CountPerPage = property(GetCountPerPage,doc="See `GetCountPerPage`")
4908 EditControl = property(GetEditControl,doc="See `GetEditControl`")
4909 FocusedItem = property(GetFocusedItem,doc="See `GetFocusedItem`")
4910 ItemCount = property(GetItemCount,SetItemCount,doc="See `GetItemCount` and `SetItemCount`")
4911 MainWindow = property(GetMainWindow,doc="See `GetMainWindow`")
4912 SelectedItemCount = property(GetSelectedItemCount,doc="See `GetSelectedItemCount`")
4913 TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`")
4914 TopItem = property(GetTopItem,doc="See `GetTopItem`")
4915 ViewRect = property(GetViewRect,doc="See `GetViewRect`")
4916 _controls_.ListCtrl_swigregister(ListCtrl)
4917
4918 def PreListCtrl(*args, **kwargs):
4919 """PreListCtrl() -> ListCtrl"""
4920 val = _controls_.new_PreListCtrl(*args, **kwargs)
4921 return val
4922
4923 def ListCtrl_GetClassDefaultAttributes(*args, **kwargs):
4924 """
4925 ListCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
4926
4927 Get the default attributes for this class. This is useful if you want
4928 to use the same font or colour in your own control as in a standard
4929 control -- which is a much better idea than hard coding specific
4930 colours or fonts which might look completely out of place on the
4931 user's system, especially if it uses themes.
4932
4933 The variant parameter is only relevant under Mac currently and is
4934 ignore under other platforms. Under Mac, it will change the size of
4935 the returned font. See `wx.Window.SetWindowVariant` for more about
4936 this.
4937 """
4938 return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs)
4939
4940 #---------------------------------------------------------------------------
4941
4942 class ListView(ListCtrl):
4943 """Proxy of C++ ListView class"""
4944 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4945 __repr__ = _swig_repr
4946 def __init__(self, *args, **kwargs):
4947 """
4948 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
4949 Size size=DefaultSize, long style=LC_REPORT,
4950 Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListView
4951 """
4952 _controls_.ListView_swiginit(self,_controls_.new_ListView(*args, **kwargs))
4953 self._setOORInfo(self)
4954
4955 def Create(*args, **kwargs):
4956 """
4957 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
4958 Size size=DefaultSize, long style=LC_REPORT,
4959 Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool
4960
4961 Do the 2nd phase and create the GUI control.
4962 """
4963 return _controls_.ListView_Create(*args, **kwargs)
4964
4965 def Select(*args, **kwargs):
4966 """Select(self, long n, bool on=True)"""
4967 return _controls_.ListView_Select(*args, **kwargs)
4968
4969 def Focus(*args, **kwargs):
4970 """Focus(self, long index)"""
4971 return _controls_.ListView_Focus(*args, **kwargs)
4972
4973 def GetFocusedItem(*args, **kwargs):
4974 """GetFocusedItem(self) -> long"""
4975 return _controls_.ListView_GetFocusedItem(*args, **kwargs)
4976
4977 def GetNextSelected(*args, **kwargs):
4978 """GetNextSelected(self, long item) -> long"""
4979 return _controls_.ListView_GetNextSelected(*args, **kwargs)
4980
4981 def GetFirstSelected(*args, **kwargs):
4982 """GetFirstSelected(self) -> long"""
4983 return _controls_.ListView_GetFirstSelected(*args, **kwargs)
4984
4985 def IsSelected(*args, **kwargs):
4986 """IsSelected(self, long index) -> bool"""
4987 return _controls_.ListView_IsSelected(*args, **kwargs)
4988
4989 def SetColumnImage(*args, **kwargs):
4990 """SetColumnImage(self, int col, int image)"""
4991 return _controls_.ListView_SetColumnImage(*args, **kwargs)
4992
4993 def ClearColumnImage(*args, **kwargs):
4994 """ClearColumnImage(self, int col)"""
4995 return _controls_.ListView_ClearColumnImage(*args, **kwargs)
4996
4997 FocusedItem = property(GetFocusedItem,doc="See `GetFocusedItem`")
4998 _controls_.ListView_swigregister(ListView)
4999
5000 def PreListView(*args, **kwargs):
5001 """PreListView() -> ListView"""
5002 val = _controls_.new_PreListView(*args, **kwargs)
5003 return val
5004
5005 #---------------------------------------------------------------------------
5006
5007 TR_NO_BUTTONS = _controls_.TR_NO_BUTTONS
5008 TR_HAS_BUTTONS = _controls_.TR_HAS_BUTTONS
5009 TR_NO_LINES = _controls_.TR_NO_LINES
5010 TR_LINES_AT_ROOT = _controls_.TR_LINES_AT_ROOT
5011 TR_SINGLE = _controls_.TR_SINGLE
5012 TR_MULTIPLE = _controls_.TR_MULTIPLE
5013 TR_EXTENDED = _controls_.TR_EXTENDED
5014 TR_HAS_VARIABLE_ROW_HEIGHT = _controls_.TR_HAS_VARIABLE_ROW_HEIGHT
5015 TR_EDIT_LABELS = _controls_.TR_EDIT_LABELS
5016 TR_HIDE_ROOT = _controls_.TR_HIDE_ROOT
5017 TR_ROW_LINES = _controls_.TR_ROW_LINES
5018 TR_FULL_ROW_HIGHLIGHT = _controls_.TR_FULL_ROW_HIGHLIGHT
5019 TR_DEFAULT_STYLE = _controls_.TR_DEFAULT_STYLE
5020 TR_TWIST_BUTTONS = _controls_.TR_TWIST_BUTTONS
5021 # obsolete
5022 TR_MAC_BUTTONS = 0
5023 wxTR_AQUA_BUTTONS = 0
5024
5025 TreeItemIcon_Normal = _controls_.TreeItemIcon_Normal
5026 TreeItemIcon_Selected = _controls_.TreeItemIcon_Selected
5027 TreeItemIcon_Expanded = _controls_.TreeItemIcon_Expanded
5028 TreeItemIcon_SelectedExpanded = _controls_.TreeItemIcon_SelectedExpanded
5029 TreeItemIcon_Max = _controls_.TreeItemIcon_Max
5030 TREE_HITTEST_ABOVE = _controls_.TREE_HITTEST_ABOVE
5031 TREE_HITTEST_BELOW = _controls_.TREE_HITTEST_BELOW
5032 TREE_HITTEST_NOWHERE = _controls_.TREE_HITTEST_NOWHERE
5033 TREE_HITTEST_ONITEMBUTTON = _controls_.TREE_HITTEST_ONITEMBUTTON
5034 TREE_HITTEST_ONITEMICON = _controls_.TREE_HITTEST_ONITEMICON
5035 TREE_HITTEST_ONITEMINDENT = _controls_.TREE_HITTEST_ONITEMINDENT
5036 TREE_HITTEST_ONITEMLABEL = _controls_.TREE_HITTEST_ONITEMLABEL
5037 TREE_HITTEST_ONITEMRIGHT = _controls_.TREE_HITTEST_ONITEMRIGHT
5038 TREE_HITTEST_ONITEMSTATEICON = _controls_.TREE_HITTEST_ONITEMSTATEICON
5039 TREE_HITTEST_TOLEFT = _controls_.TREE_HITTEST_TOLEFT
5040 TREE_HITTEST_TORIGHT = _controls_.TREE_HITTEST_TORIGHT
5041 TREE_HITTEST_ONITEMUPPERPART = _controls_.TREE_HITTEST_ONITEMUPPERPART
5042 TREE_HITTEST_ONITEMLOWERPART = _controls_.TREE_HITTEST_ONITEMLOWERPART
5043 TREE_HITTEST_ONITEM = _controls_.TREE_HITTEST_ONITEM
5044 #---------------------------------------------------------------------------
5045
5046 class TreeItemId(object):
5047 """Proxy of C++ TreeItemId class"""
5048 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5049 __repr__ = _swig_repr
5050 def __init__(self, *args, **kwargs):
5051 """__init__(self) -> TreeItemId"""
5052 _controls_.TreeItemId_swiginit(self,_controls_.new_TreeItemId(*args, **kwargs))
5053 __swig_destroy__ = _controls_.delete_TreeItemId
5054 __del__ = lambda self : None;
5055 def IsOk(*args, **kwargs):
5056 """IsOk(self) -> bool"""
5057 return _controls_.TreeItemId_IsOk(*args, **kwargs)
5058
5059 def __eq__(*args, **kwargs):
5060 """__eq__(self, TreeItemId other) -> bool"""
5061 return _controls_.TreeItemId___eq__(*args, **kwargs)
5062
5063 def __ne__(*args, **kwargs):
5064 """__ne__(self, TreeItemId other) -> bool"""
5065 return _controls_.TreeItemId___ne__(*args, **kwargs)
5066
5067 m_pItem = property(_controls_.TreeItemId_m_pItem_get, _controls_.TreeItemId_m_pItem_set)
5068 Ok = IsOk
5069 def __nonzero__(self): return self.IsOk()
5070 _controls_.TreeItemId_swigregister(TreeItemId)
5071 TreeCtrlNameStr = cvar.TreeCtrlNameStr
5072
5073 class TreeItemData(object):
5074 """Proxy of C++ TreeItemData class"""
5075 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5076 __repr__ = _swig_repr
5077 def __init__(self, *args, **kwargs):
5078 """__init__(self, PyObject obj=None) -> TreeItemData"""
5079 _controls_.TreeItemData_swiginit(self,_controls_.new_TreeItemData(*args, **kwargs))
5080 __swig_destroy__ = _controls_.delete_TreeItemData
5081 __del__ = lambda self : None;
5082 def GetData(*args, **kwargs):
5083 """GetData(self) -> PyObject"""
5084 return _controls_.TreeItemData_GetData(*args, **kwargs)
5085
5086 def SetData(*args, **kwargs):
5087 """SetData(self, PyObject obj)"""
5088 return _controls_.TreeItemData_SetData(*args, **kwargs)
5089
5090 def GetId(*args, **kwargs):
5091 """GetId(self) -> TreeItemId"""
5092 return _controls_.TreeItemData_GetId(*args, **kwargs)
5093
5094 def SetId(*args, **kwargs):
5095 """SetId(self, TreeItemId id)"""
5096 return _controls_.TreeItemData_SetId(*args, **kwargs)
5097
5098 def Destroy(*args, **kwargs):
5099 """Destroy(self)"""
5100 args[0].this.own(False)
5101 return _controls_.TreeItemData_Destroy(*args, **kwargs)
5102
5103 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
5104 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
5105 _controls_.TreeItemData_swigregister(TreeItemData)
5106
5107 #---------------------------------------------------------------------------
5108
5109 wxEVT_COMMAND_TREE_BEGIN_DRAG = _controls_.wxEVT_COMMAND_TREE_BEGIN_DRAG
5110 wxEVT_COMMAND_TREE_BEGIN_RDRAG = _controls_.wxEVT_COMMAND_TREE_BEGIN_RDRAG
5111 wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT = _controls_.wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
5112 wxEVT_COMMAND_TREE_END_LABEL_EDIT = _controls_.wxEVT_COMMAND_TREE_END_LABEL_EDIT
5113 wxEVT_COMMAND_TREE_DELETE_ITEM = _controls_.wxEVT_COMMAND_TREE_DELETE_ITEM
5114 wxEVT_COMMAND_TREE_GET_INFO = _controls_.wxEVT_COMMAND_TREE_GET_INFO
5115 wxEVT_COMMAND_TREE_SET_INFO = _controls_.wxEVT_COMMAND_TREE_SET_INFO
5116 wxEVT_COMMAND_TREE_ITEM_EXPANDED = _controls_.wxEVT_COMMAND_TREE_ITEM_EXPANDED
5117 wxEVT_COMMAND_TREE_ITEM_EXPANDING = _controls_.wxEVT_COMMAND_TREE_ITEM_EXPANDING
5118 wxEVT_COMMAND_TREE_ITEM_COLLAPSED = _controls_.wxEVT_COMMAND_TREE_ITEM_COLLAPSED
5119 wxEVT_COMMAND_TREE_ITEM_COLLAPSING = _controls_.wxEVT_COMMAND_TREE_ITEM_COLLAPSING
5120 wxEVT_COMMAND_TREE_SEL_CHANGED = _controls_.wxEVT_COMMAND_TREE_SEL_CHANGED
5121 wxEVT_COMMAND_TREE_SEL_CHANGING = _controls_.wxEVT_COMMAND_TREE_SEL_CHANGING
5122 wxEVT_COMMAND_TREE_KEY_DOWN = _controls_.wxEVT_COMMAND_TREE_KEY_DOWN
5123 wxEVT_COMMAND_TREE_ITEM_ACTIVATED = _controls_.wxEVT_COMMAND_TREE_ITEM_ACTIVATED
5124 wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK = _controls_.wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
5125 wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK = _controls_.wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK
5126 wxEVT_COMMAND_TREE_END_DRAG = _controls_.wxEVT_COMMAND_TREE_END_DRAG
5127 wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK = _controls_.wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK
5128 wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP = _controls_.wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP
5129 wxEVT_COMMAND_TREE_ITEM_MENU = _controls_.wxEVT_COMMAND_TREE_ITEM_MENU
5130 EVT_TREE_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_DRAG , 1)
5131 EVT_TREE_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_RDRAG , 1)
5132 EVT_TREE_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT , 1)
5133 EVT_TREE_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_LABEL_EDIT , 1)
5134 EVT_TREE_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_TREE_DELETE_ITEM , 1)
5135 EVT_TREE_GET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_GET_INFO , 1)
5136 EVT_TREE_SET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_SET_INFO , 1)
5137 EVT_TREE_ITEM_EXPANDED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDED , 1)
5138 EVT_TREE_ITEM_EXPANDING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDING , 1)
5139 EVT_TREE_ITEM_COLLAPSED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSED , 1)
5140 EVT_TREE_ITEM_COLLAPSING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSING , 1)
5141 EVT_TREE_SEL_CHANGED = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGED , 1)
5142 EVT_TREE_SEL_CHANGING = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGING , 1)
5143 EVT_TREE_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_TREE_KEY_DOWN , 1)
5144 EVT_TREE_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_ACTIVATED , 1)
5145 EVT_TREE_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK , 1)
5146 EVT_TREE_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 1)
5147 EVT_TREE_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_DRAG , 1)
5148 EVT_TREE_STATE_IMAGE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 1)
5149 EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP, 1)
5150 EVT_TREE_ITEM_MENU = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_MENU, 1)
5151
5152 class TreeEvent(_core.NotifyEvent):
5153 """Proxy of C++ TreeEvent class"""
5154 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5155 __repr__ = _swig_repr
5156 def __init__(self, *args):
5157 """
5158 __init__(self, EventType commandType=wxEVT_NULL, int id=0) -> TreeEvent
5159 __init__(self, EventType commandType, TreeCtrl tree, TreeItemId item=NullTreeItemId) -> TreeEvent
5160 """
5161 _controls_.TreeEvent_swiginit(self,_controls_.new_TreeEvent(*args))
5162 def GetItem(*args, **kwargs):
5163 """GetItem(self) -> TreeItemId"""
5164 return _controls_.TreeEvent_GetItem(*args, **kwargs)
5165
5166 def SetItem(*args, **kwargs):
5167 """SetItem(self, TreeItemId item)"""
5168 return _controls_.TreeEvent_SetItem(*args, **kwargs)
5169
5170 def GetOldItem(*args, **kwargs):
5171 """GetOldItem(self) -> TreeItemId"""
5172 return _controls_.TreeEvent_GetOldItem(*args, **kwargs)
5173
5174 def SetOldItem(*args, **kwargs):
5175 """SetOldItem(self, TreeItemId item)"""
5176 return _controls_.TreeEvent_SetOldItem(*args, **kwargs)
5177
5178 def GetPoint(*args, **kwargs):
5179 """GetPoint(self) -> Point"""
5180 return _controls_.TreeEvent_GetPoint(*args, **kwargs)
5181
5182 def SetPoint(*args, **kwargs):
5183 """SetPoint(self, Point pt)"""
5184 return _controls_.TreeEvent_SetPoint(*args, **kwargs)
5185
5186 def GetKeyEvent(*args, **kwargs):
5187 """GetKeyEvent(self) -> KeyEvent"""
5188 return _controls_.TreeEvent_GetKeyEvent(*args, **kwargs)
5189
5190 def GetKeyCode(*args, **kwargs):
5191 """GetKeyCode(self) -> int"""
5192 return _controls_.TreeEvent_GetKeyCode(*args, **kwargs)
5193
5194 def SetKeyEvent(*args, **kwargs):
5195 """SetKeyEvent(self, KeyEvent evt)"""
5196 return _controls_.TreeEvent_SetKeyEvent(*args, **kwargs)
5197
5198 def GetLabel(*args, **kwargs):
5199 """GetLabel(self) -> String"""
5200 return _controls_.TreeEvent_GetLabel(*args, **kwargs)
5201
5202 def SetLabel(*args, **kwargs):
5203 """SetLabel(self, String label)"""
5204 return _controls_.TreeEvent_SetLabel(*args, **kwargs)
5205
5206 def IsEditCancelled(*args, **kwargs):
5207 """IsEditCancelled(self) -> bool"""
5208 return _controls_.TreeEvent_IsEditCancelled(*args, **kwargs)
5209
5210 def SetEditCanceled(*args, **kwargs):
5211 """SetEditCanceled(self, bool editCancelled)"""
5212 return _controls_.TreeEvent_SetEditCanceled(*args, **kwargs)
5213
5214 def SetToolTip(*args, **kwargs):
5215 """SetToolTip(self, String toolTip)"""
5216 return _controls_.TreeEvent_SetToolTip(*args, **kwargs)
5217
5218 def GetToolTip(*args, **kwargs):
5219 """GetToolTip(self) -> String"""
5220 return _controls_.TreeEvent_GetToolTip(*args, **kwargs)
5221
5222 Item = property(GetItem,SetItem,doc="See `GetItem` and `SetItem`")
5223 KeyCode = property(GetKeyCode,doc="See `GetKeyCode`")
5224 KeyEvent = property(GetKeyEvent,SetKeyEvent,doc="See `GetKeyEvent` and `SetKeyEvent`")
5225 Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`")
5226 OldItem = property(GetOldItem,SetOldItem,doc="See `GetOldItem` and `SetOldItem`")
5227 Point = property(GetPoint,SetPoint,doc="See `GetPoint` and `SetPoint`")
5228 ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`")
5229 EditCancelled = property(IsEditCancelled,SetEditCanceled,doc="See `IsEditCancelled` and `SetEditCanceled`")
5230 _controls_.TreeEvent_swigregister(TreeEvent)
5231
5232 #---------------------------------------------------------------------------
5233
5234 class TreeCtrl(_core.Control):
5235 """Proxy of C++ TreeCtrl class"""
5236 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5237 __repr__ = _swig_repr
5238 def __init__(self, *args, **kwargs):
5239 """
5240 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
5241 Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
5242 Validator validator=DefaultValidator,
5243 String name=TreeCtrlNameStr) -> TreeCtrl
5244 """
5245 _controls_.TreeCtrl_swiginit(self,_controls_.new_TreeCtrl(*args, **kwargs))
5246 self._setOORInfo(self);TreeCtrl._setCallbackInfo(self, self, TreeCtrl)
5247
5248 def Create(*args, **kwargs):
5249 """
5250 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
5251 Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
5252 Validator validator=DefaultValidator,
5253 String name=TreeCtrlNameStr) -> bool
5254
5255 Do the 2nd phase and create the GUI control.
5256 """
5257 return _controls_.TreeCtrl_Create(*args, **kwargs)
5258
5259 def _setCallbackInfo(*args, **kwargs):
5260 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5261 return _controls_.TreeCtrl__setCallbackInfo(*args, **kwargs)
5262
5263 def GetCount(*args, **kwargs):
5264 """GetCount(self) -> unsigned int"""
5265 return _controls_.TreeCtrl_GetCount(*args, **kwargs)
5266
5267 def GetIndent(*args, **kwargs):
5268 """GetIndent(self) -> unsigned int"""
5269 return _controls_.TreeCtrl_GetIndent(*args, **kwargs)
5270
5271 def SetIndent(*args, **kwargs):
5272 """SetIndent(self, unsigned int indent)"""
5273 return _controls_.TreeCtrl_SetIndent(*args, **kwargs)
5274
5275 def GetSpacing(*args, **kwargs):
5276 """GetSpacing(self) -> unsigned int"""
5277 return _controls_.TreeCtrl_GetSpacing(*args, **kwargs)
5278
5279 def SetSpacing(*args, **kwargs):
5280 """SetSpacing(self, unsigned int spacing)"""
5281 return _controls_.TreeCtrl_SetSpacing(*args, **kwargs)
5282
5283 def GetImageList(*args, **kwargs):
5284 """GetImageList(self) -> ImageList"""
5285 return _controls_.TreeCtrl_GetImageList(*args, **kwargs)
5286
5287 def GetStateImageList(*args, **kwargs):
5288 """GetStateImageList(self) -> ImageList"""
5289 return _controls_.TreeCtrl_GetStateImageList(*args, **kwargs)
5290
5291 def SetImageList(*args, **kwargs):
5292 """SetImageList(self, ImageList imageList)"""
5293 return _controls_.TreeCtrl_SetImageList(*args, **kwargs)
5294
5295 def SetStateImageList(*args, **kwargs):
5296 """SetStateImageList(self, ImageList imageList)"""
5297 return _controls_.TreeCtrl_SetStateImageList(*args, **kwargs)
5298
5299 def AssignImageList(*args, **kwargs):
5300 """AssignImageList(self, ImageList imageList)"""
5301 return _controls_.TreeCtrl_AssignImageList(*args, **kwargs)
5302
5303 def AssignStateImageList(*args, **kwargs):
5304 """AssignStateImageList(self, ImageList imageList)"""
5305 return _controls_.TreeCtrl_AssignStateImageList(*args, **kwargs)
5306
5307 def GetItemText(*args, **kwargs):
5308 """GetItemText(self, TreeItemId item) -> String"""
5309 return _controls_.TreeCtrl_GetItemText(*args, **kwargs)
5310
5311 def GetItemImage(*args, **kwargs):
5312 """GetItemImage(self, TreeItemId item, int which=TreeItemIcon_Normal) -> int"""
5313 return _controls_.TreeCtrl_GetItemImage(*args, **kwargs)
5314
5315 def GetItemData(*args, **kwargs):
5316 """GetItemData(self, TreeItemId item) -> TreeItemData"""
5317 return _controls_.TreeCtrl_GetItemData(*args, **kwargs)
5318
5319 def GetItemPyData(*args, **kwargs):
5320 """GetItemPyData(self, TreeItemId item) -> PyObject"""
5321 return _controls_.TreeCtrl_GetItemPyData(*args, **kwargs)
5322
5323 GetPyData = GetItemPyData
5324 def GetItemTextColour(*args, **kwargs):
5325 """GetItemTextColour(self, TreeItemId item) -> Colour"""
5326 return _controls_.TreeCtrl_GetItemTextColour(*args, **kwargs)
5327
5328 def GetItemBackgroundColour(*args, **kwargs):
5329 """GetItemBackgroundColour(self, TreeItemId item) -> Colour"""
5330 return _controls_.TreeCtrl_GetItemBackgroundColour(*args, **kwargs)
5331
5332 def GetItemFont(*args, **kwargs):
5333 """GetItemFont(self, TreeItemId item) -> Font"""
5334 return _controls_.TreeCtrl_GetItemFont(*args, **kwargs)
5335
5336 def SetItemText(*args, **kwargs):
5337 """SetItemText(self, TreeItemId item, String text)"""
5338 return _controls_.TreeCtrl_SetItemText(*args, **kwargs)
5339
5340 def SetItemImage(*args, **kwargs):
5341 """SetItemImage(self, TreeItemId item, int image, int which=TreeItemIcon_Normal)"""
5342 return _controls_.TreeCtrl_SetItemImage(*args, **kwargs)
5343
5344 def SetItemData(*args, **kwargs):
5345 """SetItemData(self, TreeItemId item, TreeItemData data)"""
5346 return _controls_.TreeCtrl_SetItemData(*args, **kwargs)
5347
5348 def SetItemPyData(*args, **kwargs):
5349 """SetItemPyData(self, TreeItemId item, PyObject obj)"""
5350 return _controls_.TreeCtrl_SetItemPyData(*args, **kwargs)
5351
5352 SetPyData = SetItemPyData
5353 def SetItemHasChildren(*args, **kwargs):
5354 """SetItemHasChildren(self, TreeItemId item, bool has=True)"""
5355 return _controls_.TreeCtrl_SetItemHasChildren(*args, **kwargs)
5356
5357 def SetItemBold(*args, **kwargs):
5358 """SetItemBold(self, TreeItemId item, bool bold=True)"""
5359 return _controls_.TreeCtrl_SetItemBold(*args, **kwargs)
5360
5361 def SetItemDropHighlight(*args, **kwargs):
5362 """SetItemDropHighlight(self, TreeItemId item, bool highlight=True)"""
5363 return _controls_.TreeCtrl_SetItemDropHighlight(*args, **kwargs)
5364
5365 def SetItemTextColour(*args, **kwargs):
5366 """SetItemTextColour(self, TreeItemId item, Colour col)"""
5367 return _controls_.TreeCtrl_SetItemTextColour(*args, **kwargs)
5368
5369 def SetItemBackgroundColour(*args, **kwargs):
5370 """SetItemBackgroundColour(self, TreeItemId item, Colour col)"""
5371 return _controls_.TreeCtrl_SetItemBackgroundColour(*args, **kwargs)
5372
5373 def SetItemFont(*args, **kwargs):
5374 """SetItemFont(self, TreeItemId item, Font font)"""
5375 return _controls_.TreeCtrl_SetItemFont(*args, **kwargs)
5376
5377 def IsVisible(*args, **kwargs):
5378 """IsVisible(self, TreeItemId item) -> bool"""
5379 return _controls_.TreeCtrl_IsVisible(*args, **kwargs)
5380
5381 def ItemHasChildren(*args, **kwargs):
5382 """ItemHasChildren(self, TreeItemId item) -> bool"""
5383 return _controls_.TreeCtrl_ItemHasChildren(*args, **kwargs)
5384
5385 def IsExpanded(*args, **kwargs):
5386 """IsExpanded(self, TreeItemId item) -> bool"""
5387 return _controls_.TreeCtrl_IsExpanded(*args, **kwargs)
5388
5389 def IsSelected(*args, **kwargs):
5390 """IsSelected(self, TreeItemId item) -> bool"""
5391 return _controls_.TreeCtrl_IsSelected(*args, **kwargs)
5392
5393 def IsBold(*args, **kwargs):
5394 """IsBold(self, TreeItemId item) -> bool"""
5395 return _controls_.TreeCtrl_IsBold(*args, **kwargs)
5396
5397 def IsEmpty(*args, **kwargs):
5398 """IsEmpty(self) -> bool"""
5399 return _controls_.TreeCtrl_IsEmpty(*args, **kwargs)
5400
5401 def GetChildrenCount(*args, **kwargs):
5402 """GetChildrenCount(self, TreeItemId item, bool recursively=True) -> size_t"""
5403 return _controls_.TreeCtrl_GetChildrenCount(*args, **kwargs)
5404
5405 def GetRootItem(*args, **kwargs):
5406 """GetRootItem(self) -> TreeItemId"""
5407 return _controls_.TreeCtrl_GetRootItem(*args, **kwargs)
5408
5409 def GetSelection(*args, **kwargs):
5410 """GetSelection(self) -> TreeItemId"""
5411 return _controls_.TreeCtrl_GetSelection(*args, **kwargs)
5412
5413 def GetSelections(*args, **kwargs):
5414 """GetSelections(self) -> PyObject"""
5415 return _controls_.TreeCtrl_GetSelections(*args, **kwargs)
5416
5417 def GetItemParent(*args, **kwargs):
5418 """GetItemParent(self, TreeItemId item) -> TreeItemId"""
5419 return _controls_.TreeCtrl_GetItemParent(*args, **kwargs)
5420
5421 def GetFirstChild(*args, **kwargs):
5422 """GetFirstChild(self, TreeItemId item) -> PyObject"""
5423 return _controls_.TreeCtrl_GetFirstChild(*args, **kwargs)
5424
5425 def GetNextChild(*args, **kwargs):
5426 """GetNextChild(self, TreeItemId item, void cookie) -> PyObject"""
5427 return _controls_.TreeCtrl_GetNextChild(*args, **kwargs)
5428
5429 def GetLastChild(*args, **kwargs):
5430 """GetLastChild(self, TreeItemId item) -> TreeItemId"""
5431 return _controls_.TreeCtrl_GetLastChild(*args, **kwargs)
5432
5433 def GetNextSibling(*args, **kwargs):
5434 """GetNextSibling(self, TreeItemId item) -> TreeItemId"""
5435 return _controls_.TreeCtrl_GetNextSibling(*args, **kwargs)
5436
5437 def GetPrevSibling(*args, **kwargs):
5438 """GetPrevSibling(self, TreeItemId item) -> TreeItemId"""
5439 return _controls_.TreeCtrl_GetPrevSibling(*args, **kwargs)
5440
5441 def GetFirstVisibleItem(*args, **kwargs):
5442 """GetFirstVisibleItem(self) -> TreeItemId"""
5443 return _controls_.TreeCtrl_GetFirstVisibleItem(*args, **kwargs)
5444
5445 def GetNextVisible(*args, **kwargs):
5446 """GetNextVisible(self, TreeItemId item) -> TreeItemId"""
5447 return _controls_.TreeCtrl_GetNextVisible(*args, **kwargs)
5448
5449 def GetPrevVisible(*args, **kwargs):
5450 """GetPrevVisible(self, TreeItemId item) -> TreeItemId"""
5451 return _controls_.TreeCtrl_GetPrevVisible(*args, **kwargs)
5452
5453 def AddRoot(*args, **kwargs):
5454 """AddRoot(self, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId"""
5455 return _controls_.TreeCtrl_AddRoot(*args, **kwargs)
5456
5457 def PrependItem(*args, **kwargs):
5458 """
5459 PrependItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1,
5460 TreeItemData data=None) -> TreeItemId
5461 """
5462 return _controls_.TreeCtrl_PrependItem(*args, **kwargs)
5463
5464 def InsertItem(*args, **kwargs):
5465 """
5466 InsertItem(self, TreeItemId parent, TreeItemId idPrevious, String text,
5467 int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId
5468 """
5469 return _controls_.TreeCtrl_InsertItem(*args, **kwargs)
5470
5471 def InsertItemBefore(*args, **kwargs):
5472 """
5473 InsertItemBefore(self, TreeItemId parent, size_t index, String text, int image=-1,
5474 int selectedImage=-1, TreeItemData data=None) -> TreeItemId
5475 """
5476 return _controls_.TreeCtrl_InsertItemBefore(*args, **kwargs)
5477
5478 def AppendItem(*args, **kwargs):
5479 """
5480 AppendItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1,
5481 TreeItemData data=None) -> TreeItemId
5482 """
5483 return _controls_.TreeCtrl_AppendItem(*args, **kwargs)
5484
5485 def Delete(*args, **kwargs):
5486 """Delete(self, TreeItemId item)"""
5487 return _controls_.TreeCtrl_Delete(*args, **kwargs)
5488
5489 def DeleteChildren(*args, **kwargs):
5490 """DeleteChildren(self, TreeItemId item)"""
5491 return _controls_.TreeCtrl_DeleteChildren(*args, **kwargs)
5492
5493 def DeleteAllItems(*args, **kwargs):
5494 """DeleteAllItems(self)"""
5495 return _controls_.TreeCtrl_DeleteAllItems(*args, **kwargs)
5496
5497 def Expand(*args, **kwargs):
5498 """Expand(self, TreeItemId item)"""
5499 return _controls_.TreeCtrl_Expand(*args, **kwargs)
5500
5501 def ExpandAllChildren(*args, **kwargs):
5502 """ExpandAllChildren(self, TreeItemId item)"""
5503 return _controls_.TreeCtrl_ExpandAllChildren(*args, **kwargs)
5504
5505 def ExpandAll(*args, **kwargs):
5506 """ExpandAll(self)"""
5507 return _controls_.TreeCtrl_ExpandAll(*args, **kwargs)
5508
5509 def Collapse(*args, **kwargs):
5510 """Collapse(self, TreeItemId item)"""
5511 return _controls_.TreeCtrl_Collapse(*args, **kwargs)
5512
5513 def CollapseAllChildren(*args, **kwargs):
5514 """CollapseAllChildren(self, TreeItemId item)"""
5515 return _controls_.TreeCtrl_CollapseAllChildren(*args, **kwargs)
5516
5517 def CollapseAll(*args, **kwargs):
5518 """CollapseAll(self)"""
5519 return _controls_.TreeCtrl_CollapseAll(*args, **kwargs)
5520
5521 def CollapseAndReset(*args, **kwargs):
5522 """CollapseAndReset(self, TreeItemId item)"""
5523 return _controls_.TreeCtrl_CollapseAndReset(*args, **kwargs)
5524
5525 def Toggle(*args, **kwargs):
5526 """Toggle(self, TreeItemId item)"""
5527 return _controls_.TreeCtrl_Toggle(*args, **kwargs)
5528
5529 def Unselect(*args, **kwargs):
5530 """Unselect(self)"""
5531 return _controls_.TreeCtrl_Unselect(*args, **kwargs)
5532
5533 def UnselectItem(*args, **kwargs):
5534 """UnselectItem(self, TreeItemId item)"""
5535 return _controls_.TreeCtrl_UnselectItem(*args, **kwargs)
5536
5537 def UnselectAll(*args, **kwargs):
5538 """UnselectAll(self)"""
5539 return _controls_.TreeCtrl_UnselectAll(*args, **kwargs)
5540
5541 def SelectItem(*args, **kwargs):
5542 """SelectItem(self, TreeItemId item, bool select=True)"""
5543 return _controls_.TreeCtrl_SelectItem(*args, **kwargs)
5544
5545 def ToggleItemSelection(*args, **kwargs):
5546 """ToggleItemSelection(self, TreeItemId item)"""
5547 return _controls_.TreeCtrl_ToggleItemSelection(*args, **kwargs)
5548
5549 def EnsureVisible(*args, **kwargs):
5550 """EnsureVisible(self, TreeItemId item)"""
5551 return _controls_.TreeCtrl_EnsureVisible(*args, **kwargs)
5552
5553 def ScrollTo(*args, **kwargs):
5554 """ScrollTo(self, TreeItemId item)"""
5555 return _controls_.TreeCtrl_ScrollTo(*args, **kwargs)
5556
5557 def EditLabel(*args, **kwargs):
5558 """EditLabel(self, TreeItemId item)"""
5559 return _controls_.TreeCtrl_EditLabel(*args, **kwargs)
5560
5561 def GetEditControl(*args, **kwargs):
5562 """GetEditControl(self) -> TextCtrl"""
5563 return _controls_.TreeCtrl_GetEditControl(*args, **kwargs)
5564
5565 def EndEditLabel(*args, **kwargs):
5566 """EndEditLabel(self, TreeItemId item, bool discardChanges=False)"""
5567 return _controls_.TreeCtrl_EndEditLabel(*args, **kwargs)
5568
5569 def SortChildren(*args, **kwargs):
5570 """SortChildren(self, TreeItemId item)"""
5571 return _controls_.TreeCtrl_SortChildren(*args, **kwargs)
5572
5573 def HitTest(*args, **kwargs):
5574 """
5575 HitTest(Point point) -> (item, where)
5576
5577 Determine which item (if any) belongs the given point. The coordinates
5578 specified are relative to the client area of tree ctrl and the where return
5579 value is set to a bitmask of wxTREE_HITTEST_xxx constants.
5580
5581 """
5582 return _controls_.TreeCtrl_HitTest(*args, **kwargs)
5583
5584 def GetBoundingRect(*args, **kwargs):
5585 """GetBoundingRect(self, TreeItemId item, bool textOnly=False) -> PyObject"""
5586 return _controls_.TreeCtrl_GetBoundingRect(*args, **kwargs)
5587
5588 def SetState(*args, **kwargs):
5589 """SetState(self, TreeItemId node, int state)"""
5590 return _controls_.TreeCtrl_SetState(*args, **kwargs)
5591
5592 def GetState(*args, **kwargs):
5593 """GetState(self, TreeItemId node) -> int"""
5594 return _controls_.TreeCtrl_GetState(*args, **kwargs)
5595
5596 def GetClassDefaultAttributes(*args, **kwargs):
5597 """
5598 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
5599
5600 Get the default attributes for this class. This is useful if you want
5601 to use the same font or colour in your own control as in a standard
5602 control -- which is a much better idea than hard coding specific
5603 colours or fonts which might look completely out of place on the
5604 user's system, especially if it uses themes.
5605
5606 The variant parameter is only relevant under Mac currently and is
5607 ignore under other platforms. Under Mac, it will change the size of
5608 the returned font. See `wx.Window.SetWindowVariant` for more about
5609 this.
5610 """
5611 return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs)
5612
5613 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
5614 def SetQuickBestSize(*args, **kwargs):
5615 """SetQuickBestSize(self, bool q)"""
5616 return _controls_.TreeCtrl_SetQuickBestSize(*args, **kwargs)
5617
5618 def GetQuickBestSize(*args, **kwargs):
5619 """GetQuickBestSize(self) -> bool"""
5620 return _controls_.TreeCtrl_GetQuickBestSize(*args, **kwargs)
5621
5622 Count = property(GetCount,doc="See `GetCount`")
5623 EditControl = property(GetEditControl,doc="See `GetEditControl`")
5624 FirstVisibleItem = property(GetFirstVisibleItem,doc="See `GetFirstVisibleItem`")
5625 ImageList = property(GetImageList,SetImageList,doc="See `GetImageList` and `SetImageList`")
5626 Indent = property(GetIndent,SetIndent,doc="See `GetIndent` and `SetIndent`")
5627 QuickBestSize = property(GetQuickBestSize,SetQuickBestSize,doc="See `GetQuickBestSize` and `SetQuickBestSize`")
5628 RootItem = property(GetRootItem,doc="See `GetRootItem`")
5629 Selection = property(GetSelection,doc="See `GetSelection`")
5630 Selections = property(GetSelections,doc="See `GetSelections`")
5631 Spacing = property(GetSpacing,SetSpacing,doc="See `GetSpacing` and `SetSpacing`")
5632 StateImageList = property(GetStateImageList,SetStateImageList,doc="See `GetStateImageList` and `SetStateImageList`")
5633 _controls_.TreeCtrl_swigregister(TreeCtrl)
5634
5635 def PreTreeCtrl(*args, **kwargs):
5636 """PreTreeCtrl() -> TreeCtrl"""
5637 val = _controls_.new_PreTreeCtrl(*args, **kwargs)
5638 return val
5639
5640 def TreeCtrl_GetClassDefaultAttributes(*args, **kwargs):
5641 """
5642 TreeCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
5643
5644 Get the default attributes for this class. This is useful if you want
5645 to use the same font or colour in your own control as in a standard
5646 control -- which is a much better idea than hard coding specific
5647 colours or fonts which might look completely out of place on the
5648 user's system, especially if it uses themes.
5649
5650 The variant parameter is only relevant under Mac currently and is
5651 ignore under other platforms. Under Mac, it will change the size of
5652 the returned font. See `wx.Window.SetWindowVariant` for more about
5653 this.
5654 """
5655 return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs)
5656
5657 #---------------------------------------------------------------------------
5658
5659 DIRCTRL_DIR_ONLY = _controls_.DIRCTRL_DIR_ONLY
5660 DIRCTRL_SELECT_FIRST = _controls_.DIRCTRL_SELECT_FIRST
5661 DIRCTRL_SHOW_FILTERS = _controls_.DIRCTRL_SHOW_FILTERS
5662 DIRCTRL_3D_INTERNAL = _controls_.DIRCTRL_3D_INTERNAL
5663 DIRCTRL_EDIT_LABELS = _controls_.DIRCTRL_EDIT_LABELS
5664 class GenericDirCtrl(_core.Control):
5665 """Proxy of C++ GenericDirCtrl class"""
5666 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5667 __repr__ = _swig_repr
5668 def __init__(self, *args, **kwargs):
5669 """
5670 __init__(self, Window parent, int id=-1, String dir=DirDialogDefaultFolderStr,
5671 Point pos=DefaultPosition, Size size=DefaultSize,
5672 long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
5673 String filter=EmptyString,
5674 int defaultFilter=0, String name=TreeCtrlNameStr) -> GenericDirCtrl
5675 """
5676 _controls_.GenericDirCtrl_swiginit(self,_controls_.new_GenericDirCtrl(*args, **kwargs))
5677 self._setOORInfo(self)
5678
5679 def Create(*args, **kwargs):
5680 """
5681 Create(self, Window parent, int id=-1, String dir=DirDialogDefaultFolderStr,
5682 Point pos=DefaultPosition, Size size=DefaultSize,
5683 long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
5684 String filter=EmptyString,
5685 int defaultFilter=0, String name=TreeCtrlNameStr) -> bool
5686 """
5687 return _controls_.GenericDirCtrl_Create(*args, **kwargs)
5688
5689 def ExpandPath(*args, **kwargs):
5690 """ExpandPath(self, String path) -> bool"""
5691 return _controls_.GenericDirCtrl_ExpandPath(*args, **kwargs)
5692
5693 def CollapsePath(*args, **kwargs):
5694 """CollapsePath(self, String path) -> bool"""
5695 return _controls_.GenericDirCtrl_CollapsePath(*args, **kwargs)
5696
5697 def GetDefaultPath(*args, **kwargs):
5698 """GetDefaultPath(self) -> String"""
5699 return _controls_.GenericDirCtrl_GetDefaultPath(*args, **kwargs)
5700
5701 def SetDefaultPath(*args, **kwargs):
5702 """SetDefaultPath(self, String path)"""
5703 return _controls_.GenericDirCtrl_SetDefaultPath(*args, **kwargs)
5704
5705 def GetPath(*args, **kwargs):
5706 """GetPath(self) -> String"""
5707 return _controls_.GenericDirCtrl_GetPath(*args, **kwargs)
5708
5709 def GetFilePath(*args, **kwargs):
5710 """GetFilePath(self) -> String"""
5711 return _controls_.GenericDirCtrl_GetFilePath(*args, **kwargs)
5712
5713 def SetPath(*args, **kwargs):
5714 """SetPath(self, String path)"""
5715 return _controls_.GenericDirCtrl_SetPath(*args, **kwargs)
5716
5717 def ShowHidden(*args, **kwargs):
5718 """ShowHidden(self, bool show)"""
5719 return _controls_.GenericDirCtrl_ShowHidden(*args, **kwargs)
5720
5721 def GetShowHidden(*args, **kwargs):
5722 """GetShowHidden(self) -> bool"""
5723 return _controls_.GenericDirCtrl_GetShowHidden(*args, **kwargs)
5724
5725 def GetFilter(*args, **kwargs):
5726 """GetFilter(self) -> String"""
5727 return _controls_.GenericDirCtrl_GetFilter(*args, **kwargs)
5728
5729 def SetFilter(*args, **kwargs):
5730 """SetFilter(self, String filter)"""
5731 return _controls_.GenericDirCtrl_SetFilter(*args, **kwargs)
5732
5733 def GetFilterIndex(*args, **kwargs):
5734 """GetFilterIndex(self) -> int"""
5735 return _controls_.GenericDirCtrl_GetFilterIndex(*args, **kwargs)
5736
5737 def SetFilterIndex(*args, **kwargs):
5738 """SetFilterIndex(self, int n)"""
5739 return _controls_.GenericDirCtrl_SetFilterIndex(*args, **kwargs)
5740
5741 def GetRootId(*args, **kwargs):
5742 """GetRootId(self) -> TreeItemId"""
5743 return _controls_.GenericDirCtrl_GetRootId(*args, **kwargs)
5744
5745 def GetTreeCtrl(*args, **kwargs):
5746 """GetTreeCtrl(self) -> TreeCtrl"""
5747 return _controls_.GenericDirCtrl_GetTreeCtrl(*args, **kwargs)
5748
5749 def GetFilterListCtrl(*args, **kwargs):
5750 """GetFilterListCtrl(self) -> DirFilterListCtrl"""
5751 return _controls_.GenericDirCtrl_GetFilterListCtrl(*args, **kwargs)
5752
5753 def FindChild(*args, **kwargs):
5754 """
5755 FindChild(wxTreeItemId parentId, wxString path) -> (item, done)
5756
5757 Find the child that matches the first part of 'path'. E.g. if a child
5758 path is "/usr" and 'path' is "/usr/include" then the child for
5759 /usr is returned. If the path string has been used (we're at the
5760 leaf), done is set to True.
5761
5762 """
5763 return _controls_.GenericDirCtrl_FindChild(*args, **kwargs)
5764
5765 def DoResize(*args, **kwargs):
5766 """DoResize(self)"""
5767 return _controls_.GenericDirCtrl_DoResize(*args, **kwargs)
5768
5769 def ReCreateTree(*args, **kwargs):
5770 """ReCreateTree(self)"""
5771 return _controls_.GenericDirCtrl_ReCreateTree(*args, **kwargs)
5772
5773 DefaultPath = property(GetDefaultPath,SetDefaultPath,doc="See `GetDefaultPath` and `SetDefaultPath`")
5774 FilePath = property(GetFilePath,doc="See `GetFilePath`")
5775 Filter = property(GetFilter,SetFilter,doc="See `GetFilter` and `SetFilter`")
5776 FilterIndex = property(GetFilterIndex,SetFilterIndex,doc="See `GetFilterIndex` and `SetFilterIndex`")
5777 FilterListCtrl = property(GetFilterListCtrl,doc="See `GetFilterListCtrl`")
5778 Path = property(GetPath,SetPath,doc="See `GetPath` and `SetPath`")
5779 RootId = property(GetRootId,doc="See `GetRootId`")
5780 TreeCtrl = property(GetTreeCtrl,doc="See `GetTreeCtrl`")
5781 _controls_.GenericDirCtrl_swigregister(GenericDirCtrl)
5782 DirDialogDefaultFolderStr = cvar.DirDialogDefaultFolderStr
5783
5784 def PreGenericDirCtrl(*args, **kwargs):
5785 """PreGenericDirCtrl() -> GenericDirCtrl"""
5786 val = _controls_.new_PreGenericDirCtrl(*args, **kwargs)
5787 return val
5788
5789 class DirFilterListCtrl(Choice):
5790 """Proxy of C++ DirFilterListCtrl class"""
5791 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5792 __repr__ = _swig_repr
5793 def __init__(self, *args, **kwargs):
5794 """
5795 __init__(self, GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition,
5796 Size size=DefaultSize, long style=0) -> DirFilterListCtrl
5797 """
5798 _controls_.DirFilterListCtrl_swiginit(self,_controls_.new_DirFilterListCtrl(*args, **kwargs))
5799 self._setOORInfo(self)
5800
5801 def Create(*args, **kwargs):
5802 """
5803 Create(self, GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition,
5804 Size size=DefaultSize, long style=0) -> bool
5805 """
5806 return _controls_.DirFilterListCtrl_Create(*args, **kwargs)
5807
5808 def FillFilterList(*args, **kwargs):
5809 """FillFilterList(self, String filter, int defaultFilter)"""
5810 return _controls_.DirFilterListCtrl_FillFilterList(*args, **kwargs)
5811
5812 _controls_.DirFilterListCtrl_swigregister(DirFilterListCtrl)
5813
5814 def PreDirFilterListCtrl(*args, **kwargs):
5815 """PreDirFilterListCtrl() -> DirFilterListCtrl"""
5816 val = _controls_.new_PreDirFilterListCtrl(*args, **kwargs)
5817 return val
5818
5819 #---------------------------------------------------------------------------
5820
5821 class PyControl(_core.Control):
5822 """Proxy of C++ PyControl class"""
5823 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5824 __repr__ = _swig_repr
5825 def __init__(self, *args, **kwargs):
5826 """
5827 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
5828 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
5829 String name=ControlNameStr) -> PyControl
5830 """
5831 _controls_.PyControl_swiginit(self,_controls_.new_PyControl(*args, **kwargs))
5832 self._setOORInfo(self);PyControl._setCallbackInfo(self, self, PyControl)
5833
5834 def _setCallbackInfo(*args, **kwargs):
5835 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5836 return _controls_.PyControl__setCallbackInfo(*args, **kwargs)
5837
5838 SetBestSize = wx.Window.SetInitialSize
5839 def DoEraseBackground(*args, **kwargs):
5840 """DoEraseBackground(self, DC dc) -> bool"""
5841 return _controls_.PyControl_DoEraseBackground(*args, **kwargs)
5842
5843 def DoMoveWindow(*args, **kwargs):
5844 """DoMoveWindow(self, int x, int y, int width, int height)"""
5845 return _controls_.PyControl_DoMoveWindow(*args, **kwargs)
5846
5847 def DoSetSize(*args, **kwargs):
5848 """DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)"""
5849 return _controls_.PyControl_DoSetSize(*args, **kwargs)
5850
5851 def DoSetClientSize(*args, **kwargs):
5852 """DoSetClientSize(self, int width, int height)"""
5853 return _controls_.PyControl_DoSetClientSize(*args, **kwargs)
5854
5855 def DoSetVirtualSize(*args, **kwargs):
5856 """DoSetVirtualSize(self, int x, int y)"""
5857 return _controls_.PyControl_DoSetVirtualSize(*args, **kwargs)
5858
5859 def DoGetSize(*args, **kwargs):
5860 """DoGetSize() -> (width, height)"""
5861 return _controls_.PyControl_DoGetSize(*args, **kwargs)
5862
5863 def DoGetClientSize(*args, **kwargs):
5864 """DoGetClientSize() -> (width, height)"""
5865 return _controls_.PyControl_DoGetClientSize(*args, **kwargs)
5866
5867 def DoGetPosition(*args, **kwargs):
5868 """DoGetPosition() -> (x,y)"""
5869 return _controls_.PyControl_DoGetPosition(*args, **kwargs)
5870
5871 def DoGetVirtualSize(*args, **kwargs):
5872 """DoGetVirtualSize(self) -> Size"""
5873 return _controls_.PyControl_DoGetVirtualSize(*args, **kwargs)
5874
5875 def DoGetBestSize(*args, **kwargs):
5876 """DoGetBestSize(self) -> Size"""
5877 return _controls_.PyControl_DoGetBestSize(*args, **kwargs)
5878
5879 def GetDefaultAttributes(*args, **kwargs):
5880 """GetDefaultAttributes(self) -> VisualAttributes"""
5881 return _controls_.PyControl_GetDefaultAttributes(*args, **kwargs)
5882
5883 def OnInternalIdle(*args, **kwargs):
5884 """OnInternalIdle(self)"""
5885 return _controls_.PyControl_OnInternalIdle(*args, **kwargs)
5886
5887 def base_DoMoveWindow(*args, **kw):
5888 return PyScrolledWindow.DoMoveWindow(*args, **kw)
5889 base_DoMoveWindow = wx._deprecated(base_DoMoveWindow,
5890 "Please use PyScrolledWindow.DoMoveWindow instead.")
5891
5892 def base_DoSetSize(*args, **kw):
5893 return PyScrolledWindow.DoSetSize(*args, **kw)
5894 base_DoSetSize = wx._deprecated(base_DoSetSize,
5895 "Please use PyScrolledWindow.DoSetSize instead.")
5896
5897 def base_DoSetClientSize(*args, **kw):
5898 return PyScrolledWindow.DoSetClientSize(*args, **kw)
5899 base_DoSetClientSize = wx._deprecated(base_DoSetClientSize,
5900 "Please use PyScrolledWindow.DoSetClientSize instead.")
5901
5902 def base_DoSetVirtualSize(*args, **kw):
5903 return PyScrolledWindow.DoSetVirtualSize(*args, **kw)
5904 base_DoSetVirtualSize = wx._deprecated(base_DoSetVirtualSize,
5905 "Please use PyScrolledWindow.DoSetVirtualSize instead.")
5906
5907 def base_DoGetSize(*args, **kw):
5908 return PyScrolledWindow.DoGetSize(*args, **kw)
5909 base_DoGetSize = wx._deprecated(base_DoGetSize,
5910 "Please use PyScrolledWindow.DoGetSize instead.")
5911
5912 def base_DoGetClientSize(*args, **kw):
5913 return PyScrolledWindow.DoGetClientSize(*args, **kw)
5914 base_DoGetClientSize = wx._deprecated(base_DoGetClientSize,
5915 "Please use PyScrolledWindow.DoGetClientSize instead.")
5916
5917 def base_DoGetPosition(*args, **kw):
5918 return PyScrolledWindow.DoGetPosition(*args, **kw)
5919 base_DoGetPosition = wx._deprecated(base_DoGetPosition,
5920 "Please use PyScrolledWindow.DoGetPosition instead.")
5921
5922 def base_DoGetVirtualSize(*args, **kw):
5923 return PyScrolledWindow.DoGetVirtualSize(*args, **kw)
5924 base_DoGetVirtualSize = wx._deprecated(base_DoGetVirtualSize,
5925 "Please use PyScrolledWindow.DoGetVirtualSize instead.")
5926
5927 def base_DoGetBestSize(*args, **kw):
5928 return PyScrolledWindow.DoGetBestSize(*args, **kw)
5929 base_DoGetBestSize = wx._deprecated(base_DoGetBestSize,
5930 "Please use PyScrolledWindow.DoGetBestSize instead.")
5931
5932 def base_InitDialog(*args, **kw):
5933 return PyScrolledWindow.InitDialog(*args, **kw)
5934 base_InitDialog = wx._deprecated(base_InitDialog,
5935 "Please use PyScrolledWindow.InitDialog instead.")
5936
5937 def base_TransferDataToWindow(*args, **kw):
5938 return PyScrolledWindow.TransferDataToWindow(*args, **kw)
5939 base_TransferDataToWindow = wx._deprecated(base_TransferDataToWindow,
5940 "Please use PyScrolledWindow.TransferDataToWindow instead.")
5941
5942 def base_TransferDataFromWindow(*args, **kw):
5943 return PyScrolledWindow.TransferDataFromWindow(*args, **kw)
5944 base_TransferDataFromWindow = wx._deprecated(base_TransferDataFromWindow,
5945 "Please use PyScrolledWindow.TransferDataFromWindow instead.")
5946
5947 def base_Validate(*args, **kw):
5948 return PyScrolledWindow.Validate(*args, **kw)
5949 base_Validate = wx._deprecated(base_Validate,
5950 "Please use PyScrolledWindow.Validate instead.")
5951
5952 def base_AcceptsFocus(*args, **kw):
5953 return PyScrolledWindow.AcceptsFocus(*args, **kw)
5954 base_AcceptsFocus = wx._deprecated(base_AcceptsFocus,
5955 "Please use PyScrolledWindow.AcceptsFocus instead.")
5956
5957 def base_AcceptsFocusFromKeyboard(*args, **kw):
5958 return PyScrolledWindow.AcceptsFocusFromKeyboard(*args, **kw)
5959 base_AcceptsFocusFromKeyboard = wx._deprecated(base_AcceptsFocusFromKeyboard,
5960 "Please use PyScrolledWindow.AcceptsFocusFromKeyboard instead.")
5961
5962 def base_GetMaxSize(*args, **kw):
5963 return PyScrolledWindow.GetMaxSize(*args, **kw)
5964 base_GetMaxSize = wx._deprecated(base_GetMaxSize,
5965 "Please use PyScrolledWindow.GetMaxSize instead.")
5966
5967 def base_AddChild(*args, **kw):
5968 return PyScrolledWindow.AddChild(*args, **kw)
5969 base_AddChild = wx._deprecated(base_AddChild,
5970 "Please use PyScrolledWindow.AddChild instead.")
5971
5972 def base_RemoveChild(*args, **kw):
5973 return PyScrolledWindow.RemoveChild(*args, **kw)
5974 base_RemoveChild = wx._deprecated(base_RemoveChild,
5975 "Please use PyScrolledWindow.RemoveChild instead.")
5976
5977 def base_ShouldInheritColours(*args, **kw):
5978 return PyScrolledWindow.ShouldInheritColours(*args, **kw)
5979 base_ShouldInheritColours = wx._deprecated(base_ShouldInheritColours,
5980 "Please use PyScrolledWindow.ShouldInheritColours instead.")
5981
5982 def base_GetDefaultAttributes(*args, **kw):
5983 return PyScrolledWindow.GetDefaultAttributes(*args, **kw)
5984 base_GetDefaultAttributes = wx._deprecated(base_GetDefaultAttributes,
5985 "Please use PyScrolledWindow.GetDefaultAttributes instead.")
5986
5987 def base_OnInternalIdle(*args, **kw):
5988 return PyScrolledWindow.OnInternalIdle(*args, **kw)
5989 base_OnInternalIdle = wx._deprecated(base_OnInternalIdle,
5990 "Please use PyScrolledWindow.OnInternalIdle instead.")
5991
5992 _controls_.PyControl_swigregister(PyControl)
5993
5994 def PrePyControl(*args, **kwargs):
5995 """PrePyControl() -> PyControl"""
5996 val = _controls_.new_PrePyControl(*args, **kwargs)
5997 return val
5998
5999 #---------------------------------------------------------------------------
6000
6001 wxEVT_HELP = _controls_.wxEVT_HELP
6002 wxEVT_DETAILED_HELP = _controls_.wxEVT_DETAILED_HELP
6003 EVT_HELP = wx.PyEventBinder( wxEVT_HELP, 1)
6004 EVT_HELP_RANGE = wx.PyEventBinder( wxEVT_HELP, 2)
6005 EVT_DETAILED_HELP = wx.PyEventBinder( wxEVT_DETAILED_HELP, 1)
6006 EVT_DETAILED_HELP_RANGE = wx.PyEventBinder( wxEVT_DETAILED_HELP, 2)
6007
6008 class HelpEvent(_core.CommandEvent):
6009 """
6010 A help event is sent when the user has requested context-sensitive
6011 help. This can either be caused by the application requesting
6012 context-sensitive help mode via wx.ContextHelp, or (on MS Windows) by
6013 the system generating a WM_HELP message when the user pressed F1 or
6014 clicked on the query button in a dialog caption.
6015
6016 A help event is sent to the window that the user clicked on, and is
6017 propagated up the window hierarchy until the event is processed or
6018 there are no more event handlers. The application should call
6019 event.GetId to check the identity of the clicked-on window, and then
6020 either show some suitable help or call event.Skip if the identifier is
6021 unrecognised. Calling Skip is important because it allows wxWindows to
6022 generate further events for ancestors of the clicked-on
6023 window. Otherwise it would be impossible to show help for container
6024 windows, since processing would stop after the first window found.
6025 """
6026 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6027 __repr__ = _swig_repr
6028 Origin_Unknown = _controls_.HelpEvent_Origin_Unknown
6029 Origin_Keyboard = _controls_.HelpEvent_Origin_Keyboard
6030 Origin_HelpButton = _controls_.HelpEvent_Origin_HelpButton
6031 def __init__(self, *args, **kwargs):
6032 """
6033 __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition,
6034 int origin=Origin_Unknown) -> HelpEvent
6035 """
6036 _controls_.HelpEvent_swiginit(self,_controls_.new_HelpEvent(*args, **kwargs))
6037 def GetPosition(*args, **kwargs):
6038 """
6039 GetPosition(self) -> Point
6040
6041 Returns the left-click position of the mouse, in screen
6042 coordinates. This allows the application to position the help
6043 appropriately.
6044 """
6045 return _controls_.HelpEvent_GetPosition(*args, **kwargs)
6046
6047 def SetPosition(*args, **kwargs):
6048 """
6049 SetPosition(self, Point pos)
6050
6051 Sets the left-click position of the mouse, in screen coordinates.
6052 """
6053 return _controls_.HelpEvent_SetPosition(*args, **kwargs)
6054
6055 def GetLink(*args, **kwargs):
6056 """
6057 GetLink(self) -> String
6058
6059 Get an optional link to further help
6060 """
6061 return _controls_.HelpEvent_GetLink(*args, **kwargs)
6062
6063 def SetLink(*args, **kwargs):
6064 """
6065 SetLink(self, String link)
6066
6067 Set an optional link to further help
6068 """
6069 return _controls_.HelpEvent_SetLink(*args, **kwargs)
6070
6071 def GetTarget(*args, **kwargs):
6072 """
6073 GetTarget(self) -> String
6074
6075 Get an optional target to display help in. E.g. a window specification
6076 """
6077 return _controls_.HelpEvent_GetTarget(*args, **kwargs)
6078
6079 def SetTarget(*args, **kwargs):
6080 """
6081 SetTarget(self, String target)
6082
6083 Set an optional target to display help in. E.g. a window specification
6084 """
6085 return _controls_.HelpEvent_SetTarget(*args, **kwargs)
6086
6087 def GetOrigin(*args, **kwargs):
6088 """
6089 GetOrigin(self) -> int
6090
6091 Optiononal indication of the source of the event.
6092 """
6093 return _controls_.HelpEvent_GetOrigin(*args, **kwargs)
6094
6095 def SetOrigin(*args, **kwargs):
6096 """SetOrigin(self, int origin)"""
6097 return _controls_.HelpEvent_SetOrigin(*args, **kwargs)
6098
6099 Link = property(GetLink,SetLink,doc="See `GetLink` and `SetLink`")
6100 Origin = property(GetOrigin,SetOrigin,doc="See `GetOrigin` and `SetOrigin`")
6101 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
6102 Target = property(GetTarget,SetTarget,doc="See `GetTarget` and `SetTarget`")
6103 _controls_.HelpEvent_swigregister(HelpEvent)
6104
6105 class ContextHelp(_core.Object):
6106 """
6107 This class changes the cursor to a query and puts the application into
6108 a 'context-sensitive help mode'. When the user left-clicks on a window
6109 within the specified window, a ``EVT_HELP`` event is sent to that
6110 control, and the application may respond to it by popping up some
6111 help.
6112
6113 There are a couple of ways to invoke this behaviour implicitly:
6114
6115 * Use the wx.WS_EX_CONTEXTHELP extended style for a dialog or frame
6116 (Windows only). This will put a question mark in the titlebar,
6117 and Windows will put the application into context-sensitive help
6118 mode automatically, with further programming.
6119
6120 * Create a `wx.ContextHelpButton`, whose predefined behaviour is
6121 to create a context help object. Normally you will write your
6122 application so that this button is only added to a dialog for
6123 non-Windows platforms (use ``wx.WS_EX_CONTEXTHELP`` on
6124 Windows).
6125
6126 :see: `wx.ContextHelpButton`
6127
6128 """
6129 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6130 __repr__ = _swig_repr
6131 def __init__(self, *args, **kwargs):
6132 """
6133 __init__(self, Window window=None, bool doNow=True) -> ContextHelp
6134
6135 Constructs a context help object, calling BeginContextHelp if doNow is
6136 true (the default).
6137
6138 If window is None, the top window is used.
6139 """
6140 _controls_.ContextHelp_swiginit(self,_controls_.new_ContextHelp(*args, **kwargs))
6141 __swig_destroy__ = _controls_.delete_ContextHelp
6142 __del__ = lambda self : None;
6143 def BeginContextHelp(*args, **kwargs):
6144 """
6145 BeginContextHelp(self, Window window=None) -> bool
6146
6147 Puts the application into context-sensitive help mode. window is the
6148 window which will be used to catch events; if NULL, the top window
6149 will be used.
6150
6151 Returns true if the application was successfully put into
6152 context-sensitive help mode. This function only returns when the event
6153 loop has finished.
6154 """
6155 return _controls_.ContextHelp_BeginContextHelp(*args, **kwargs)
6156
6157 def EndContextHelp(*args, **kwargs):
6158 """
6159 EndContextHelp(self) -> bool
6160
6161 Ends context-sensitive help mode. Not normally called by the
6162 application.
6163 """
6164 return _controls_.ContextHelp_EndContextHelp(*args, **kwargs)
6165
6166 _controls_.ContextHelp_swigregister(ContextHelp)
6167
6168 class ContextHelpButton(BitmapButton):
6169 """
6170 Instances of this class may be used to add a question mark button that
6171 when pressed, puts the application into context-help mode. It does
6172 this by creating a wx.ContextHelp object which itself generates a
6173 ``EVT_HELP`` event when the user clicks on a window.
6174
6175 On Windows, you may add a question-mark icon to a dialog by use of the
6176 ``wx.DIALOG_EX_CONTEXTHELP`` extra style, but on other platforms you
6177 will have to add a button explicitly, usually next to OK, Cancel or
6178 similar buttons.
6179
6180 :see: `wx.ContextHelp`, `wx.ContextHelpButton`
6181
6182 """
6183 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6184 __repr__ = _swig_repr
6185 def __init__(self, *args, **kwargs):
6186 """
6187 __init__(self, Window parent, int id=ID_CONTEXT_HELP, Point pos=DefaultPosition,
6188 Size size=DefaultSize, long style=BU_AUTODRAW) -> ContextHelpButton
6189
6190 Constructor, creating and showing a context help button.
6191 """
6192 _controls_.ContextHelpButton_swiginit(self,_controls_.new_ContextHelpButton(*args, **kwargs))
6193 self._setOORInfo(self)
6194
6195 _controls_.ContextHelpButton_swigregister(ContextHelpButton)
6196
6197 class HelpProvider(object):
6198 """
6199 wx.HelpProvider is an abstract class used by a program
6200 implementing context-sensitive help to show the help text for the
6201 given window.
6202
6203 The current help provider must be explicitly set by the
6204 application using wx.HelpProvider.Set().
6205 """
6206 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6207 def __init__(self): raise AttributeError, "No constructor defined"
6208 __repr__ = _swig_repr
6209 __swig_destroy__ = _controls_.delete_HelpProvider
6210 __del__ = lambda self : None;
6211 def Set(*args, **kwargs):
6212 """
6213 Set(HelpProvider helpProvider) -> HelpProvider
6214
6215 Sset the current, application-wide help provider. Returns the previous
6216 one. Unlike some other classes, the help provider is not created on
6217 demand. This must be explicitly done by the application.
6218 """
6219 return _controls_.HelpProvider_Set(*args, **kwargs)
6220
6221 Set = staticmethod(Set)
6222 def Get(*args, **kwargs):
6223 """
6224 Get() -> HelpProvider
6225
6226 Return the current application-wide help provider.
6227 """
6228 return _controls_.HelpProvider_Get(*args, **kwargs)
6229
6230 Get = staticmethod(Get)
6231 def GetHelp(*args, **kwargs):
6232 """
6233 GetHelp(self, Window window) -> String
6234
6235 Gets the help string for this window. Its interpretation is dependent
6236 on the help provider except that empty string always means that no
6237 help is associated with the window.
6238 """
6239 return _controls_.HelpProvider_GetHelp(*args, **kwargs)
6240
6241 def ShowHelp(*args, **kwargs):
6242 """
6243 ShowHelp(self, Window window) -> bool
6244
6245 Shows help for the given window. Uses GetHelp internally if
6246 applicable. Returns True if it was done, or False if no help was
6247 available for this window.
6248 """
6249 return _controls_.HelpProvider_ShowHelp(*args, **kwargs)
6250
6251 def ShowHelpAtPoint(*args, **kwargs):
6252 """
6253 ShowHelpAtPoint(self, wxWindowBase window, Point pt, int origin) -> bool
6254
6255 Show help for the given window (uses window.GetHelpAtPoint()
6256 internally if applicable), return true if it was done or false if no
6257 help available for this window.
6258 """
6259 return _controls_.HelpProvider_ShowHelpAtPoint(*args, **kwargs)
6260
6261 def AddHelp(*args, **kwargs):
6262 """
6263 AddHelp(self, Window window, String text)
6264
6265 Associates the text with the given window.
6266 """
6267 return _controls_.HelpProvider_AddHelp(*args, **kwargs)
6268
6269 def AddHelpById(*args, **kwargs):
6270 """
6271 AddHelpById(self, int id, String text)
6272
6273 This version associates the given text with all windows with this
6274 id. May be used to set the same help string for all Cancel buttons in
6275 the application, for example.
6276 """
6277 return _controls_.HelpProvider_AddHelpById(*args, **kwargs)
6278
6279 def RemoveHelp(*args, **kwargs):
6280 """
6281 RemoveHelp(self, Window window)
6282
6283 Removes the association between the window pointer and the help
6284 text. This is called by the wx.Window destructor. Without this, the
6285 table of help strings will fill up and when window pointers are
6286 reused, the wrong help string will be found.
6287 """
6288 return _controls_.HelpProvider_RemoveHelp(*args, **kwargs)
6289
6290 def Destroy(*args, **kwargs):
6291 """Destroy(self)"""
6292 args[0].this.own(False)
6293 return _controls_.HelpProvider_Destroy(*args, **kwargs)
6294
6295 _controls_.HelpProvider_swigregister(HelpProvider)
6296
6297 def HelpProvider_Set(*args, **kwargs):
6298 """
6299 HelpProvider_Set(HelpProvider helpProvider) -> HelpProvider
6300
6301 Sset the current, application-wide help provider. Returns the previous
6302 one. Unlike some other classes, the help provider is not created on
6303 demand. This must be explicitly done by the application.
6304 """
6305 return _controls_.HelpProvider_Set(*args, **kwargs)
6306
6307 def HelpProvider_Get(*args):
6308 """
6309 HelpProvider_Get() -> HelpProvider
6310
6311 Return the current application-wide help provider.
6312 """
6313 return _controls_.HelpProvider_Get(*args)
6314
6315 class SimpleHelpProvider(HelpProvider):
6316 """
6317 wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
6318 supports only plain text help strings, and shows the string associated
6319 with the control (if any) in a tooltip.
6320 """
6321 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6322 __repr__ = _swig_repr
6323 def __init__(self, *args, **kwargs):
6324 """
6325 __init__(self) -> SimpleHelpProvider
6326
6327 wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
6328 supports only plain text help strings, and shows the string associated
6329 with the control (if any) in a tooltip.
6330 """
6331 _controls_.SimpleHelpProvider_swiginit(self,_controls_.new_SimpleHelpProvider(*args, **kwargs))
6332 _controls_.SimpleHelpProvider_swigregister(SimpleHelpProvider)
6333
6334 #---------------------------------------------------------------------------
6335
6336 class DragImage(_core.Object):
6337 """Proxy of C++ DragImage class"""
6338 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6339 __repr__ = _swig_repr
6340 def __init__(self, *args, **kwargs):
6341 """__init__(self, Bitmap image, Cursor cursor=wxNullCursor) -> DragImage"""
6342 _controls_.DragImage_swiginit(self,_controls_.new_DragImage(*args, **kwargs))
6343 __swig_destroy__ = _controls_.delete_DragImage
6344 __del__ = lambda self : None;
6345 def SetBackingBitmap(*args, **kwargs):
6346 """SetBackingBitmap(self, Bitmap bitmap)"""
6347 return _controls_.DragImage_SetBackingBitmap(*args, **kwargs)
6348
6349 def BeginDrag(*args, **kwargs):
6350 """
6351 BeginDrag(self, Point hotspot, Window window, bool fullScreen=False,
6352 Rect rect=None) -> bool
6353 """
6354 return _controls_.DragImage_BeginDrag(*args, **kwargs)
6355
6356 def BeginDragBounded(*args, **kwargs):
6357 """BeginDragBounded(self, Point hotspot, Window window, Window boundingWindow) -> bool"""
6358 return _controls_.DragImage_BeginDragBounded(*args, **kwargs)
6359
6360 def EndDrag(*args, **kwargs):
6361 """EndDrag(self) -> bool"""
6362 return _controls_.DragImage_EndDrag(*args, **kwargs)
6363
6364 def Move(*args, **kwargs):
6365 """Move(self, Point pt) -> bool"""
6366 return _controls_.DragImage_Move(*args, **kwargs)
6367
6368 def Show(*args, **kwargs):
6369 """Show(self) -> bool"""
6370 return _controls_.DragImage_Show(*args, **kwargs)
6371
6372 def Hide(*args, **kwargs):
6373 """Hide(self) -> bool"""
6374 return _controls_.DragImage_Hide(*args, **kwargs)
6375
6376 def GetImageRect(*args, **kwargs):
6377 """GetImageRect(self, Point pos) -> Rect"""
6378 return _controls_.DragImage_GetImageRect(*args, **kwargs)
6379
6380 def DoDrawImage(*args, **kwargs):
6381 """DoDrawImage(self, DC dc, Point pos) -> bool"""
6382 return _controls_.DragImage_DoDrawImage(*args, **kwargs)
6383
6384 def UpdateBackingFromWindow(*args, **kwargs):
6385 """UpdateBackingFromWindow(self, DC windowDC, MemoryDC destDC, Rect sourceRect, Rect destRect) -> bool"""
6386 return _controls_.DragImage_UpdateBackingFromWindow(*args, **kwargs)
6387
6388 def RedrawImage(*args, **kwargs):
6389 """RedrawImage(self, Point oldPos, Point newPos, bool eraseOld, bool drawNew) -> bool"""
6390 return _controls_.DragImage_RedrawImage(*args, **kwargs)
6391
6392 ImageRect = property(GetImageRect,doc="See `GetImageRect`")
6393 _controls_.DragImage_swigregister(DragImage)
6394
6395 def DragIcon(*args, **kwargs):
6396 """DragIcon(Icon image, Cursor cursor=wxNullCursor) -> DragImage"""
6397 val = _controls_.new_DragIcon(*args, **kwargs)
6398 return val
6399
6400 def DragString(*args, **kwargs):
6401 """DragString(String str, Cursor cursor=wxNullCursor) -> DragImage"""
6402 val = _controls_.new_DragString(*args, **kwargs)
6403 return val
6404
6405 def DragTreeItem(*args, **kwargs):
6406 """DragTreeItem(TreeCtrl treeCtrl, TreeItemId id) -> DragImage"""
6407 val = _controls_.new_DragTreeItem(*args, **kwargs)
6408 return val
6409
6410 def DragListItem(*args, **kwargs):
6411 """DragListItem(ListCtrl listCtrl, long id) -> DragImage"""
6412 val = _controls_.new_DragListItem(*args, **kwargs)
6413 return val
6414
6415 #---------------------------------------------------------------------------
6416
6417 DP_DEFAULT = _controls_.DP_DEFAULT
6418 DP_SPIN = _controls_.DP_SPIN
6419 DP_DROPDOWN = _controls_.DP_DROPDOWN
6420 DP_SHOWCENTURY = _controls_.DP_SHOWCENTURY
6421 DP_ALLOWNONE = _controls_.DP_ALLOWNONE
6422 class DatePickerCtrl(_core.Control):
6423 """
6424 This control allows the user to select a date. Unlike
6425 `wx.calendar.CalendarCtrl`, which is a relatively big control,
6426 `wx.DatePickerCtrl` is implemented as a small window showing the
6427 currently selected date. The control can be edited using the keyboard,
6428 and can also display a popup window for more user-friendly date
6429 selection, depending on the styles used and the platform.
6430 """
6431 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6432 __repr__ = _swig_repr
6433 def __init__(self, *args, **kwargs):
6434 """
6435 __init__(self, Window parent, int id=-1, DateTime dt=wxDefaultDateTime,
6436 Point pos=DefaultPosition, Size size=DefaultSize,
6437 long style=wxDP_DEFAULT|wxDP_SHOWCENTURY,
6438 Validator validator=DefaultValidator,
6439 String name=DatePickerCtrlNameStr) -> DatePickerCtrl
6440
6441 Create a new DatePickerCtrl.
6442 """
6443 _controls_.DatePickerCtrl_swiginit(self,_controls_.new_DatePickerCtrl(*args, **kwargs))
6444 self._setOORInfo(self)
6445
6446 def Create(*args, **kwargs):
6447 """
6448 Create(self, Window parent, int id=-1, DateTime dt=wxDefaultDateTime,
6449 Point pos=DefaultPosition, Size size=DefaultSize,
6450 long style=wxDP_DEFAULT|wxDP_SHOWCENTURY,
6451 Validator validator=DefaultValidator,
6452 String name=DatePickerCtrlNameStr) -> bool
6453
6454 Create the GUI parts of the DatePickerCtrl, for use in 2-phase
6455 creation.
6456 """
6457 return _controls_.DatePickerCtrl_Create(*args, **kwargs)
6458
6459 def SetValue(*args, **kwargs):
6460 """
6461 SetValue(self, DateTime dt)
6462
6463 Changes the current value of the control. The date should be valid and
6464 included in the currently selected range, if any.
6465
6466 Calling this method does not result in a date change event.
6467 """
6468 return _controls_.DatePickerCtrl_SetValue(*args, **kwargs)
6469
6470 def GetValue(*args, **kwargs):
6471 """
6472 GetValue(self) -> DateTime
6473
6474 Returns the currently selected date. If there is no selection or the
6475 selection is outside of the current range, an invalid `wx.DateTime`
6476 object is returned.
6477 """
6478 return _controls_.DatePickerCtrl_GetValue(*args, **kwargs)
6479
6480 def SetRange(*args, **kwargs):
6481 """
6482 SetRange(self, DateTime dt1, DateTime dt2)
6483
6484 Sets the valid range for the date selection. If dt1 is valid, it
6485 becomes the earliest date (inclusive) accepted by the control. If dt2
6486 is valid, it becomes the latest possible date.
6487
6488 If the current value of the control is outside of the newly set range
6489 bounds, the behaviour is undefined.
6490 """
6491 return _controls_.DatePickerCtrl_SetRange(*args, **kwargs)
6492
6493 def GetLowerLimit(*args, **kwargs):
6494 """
6495 GetLowerLimit(self) -> DateTime
6496
6497 Get the lower limit of the valid range for the date selection, if any.
6498 If there is no range or there is no lower limit, then the
6499 `wx.DateTime` value returned will be invalid.
6500 """
6501 return _controls_.DatePickerCtrl_GetLowerLimit(*args, **kwargs)
6502
6503 def GetUpperLimit(*args, **kwargs):
6504 """
6505 GetUpperLimit(self) -> DateTime
6506
6507 Get the upper limit of the valid range for the date selection, if any.
6508 If there is no range or there is no upper limit, then the
6509 `wx.DateTime` value returned will be invalid.
6510 """
6511 return _controls_.DatePickerCtrl_GetUpperLimit(*args, **kwargs)
6512
6513 LowerLimit = property(GetLowerLimit,doc="See `GetLowerLimit`")
6514 UpperLimit = property(GetUpperLimit,doc="See `GetUpperLimit`")
6515 Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`")
6516 _controls_.DatePickerCtrl_swigregister(DatePickerCtrl)
6517 DatePickerCtrlNameStr = cvar.DatePickerCtrlNameStr
6518
6519 def PreDatePickerCtrl(*args, **kwargs):
6520 """
6521 PreDatePickerCtrl() -> DatePickerCtrl
6522
6523 Precreate a DatePickerCtrl for use in 2-phase creation.
6524 """
6525 val = _controls_.new_PreDatePickerCtrl(*args, **kwargs)
6526 return val
6527
6528 HL_CONTEXTMENU = _controls_.HL_CONTEXTMENU
6529 HL_ALIGN_LEFT = _controls_.HL_ALIGN_LEFT
6530 HL_ALIGN_RIGHT = _controls_.HL_ALIGN_RIGHT
6531 HL_ALIGN_CENTRE = _controls_.HL_ALIGN_CENTRE
6532 HL_DEFAULT_STYLE = _controls_.HL_DEFAULT_STYLE
6533 #---------------------------------------------------------------------------
6534
6535 class HyperlinkCtrl(_core.Control):
6536 """
6537 A static text control that emulates a hyperlink. The link is displayed
6538 in an appropriate text style, derived from the control's normal font.
6539 When the mouse rolls over the link, the cursor changes to a hand and
6540 the link's color changes to the active color.
6541
6542 Clicking on the link does not launch a web browser; instead, a
6543 wx.HyperlinkEvent is fired. Use the wx.EVT_HYPERLINK to catch link
6544 events.
6545
6546 """
6547 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6548 __repr__ = _swig_repr
6549 def __init__(self, *args, **kwargs):
6550 """
6551 __init__(self, Window parent, int id, String label, String url, Point pos=DefaultPosition,
6552 Size size=DefaultSize,
6553 long style=HL_DEFAULT_STYLE, String name=HyperlinkCtrlNameStr) -> HyperlinkCtrl
6554
6555 A static text control that emulates a hyperlink. The link is displayed
6556 in an appropriate text style, derived from the control's normal font.
6557 When the mouse rolls over the link, the cursor changes to a hand and
6558 the link's color changes to the active color.
6559
6560 Clicking on the link does not launch a web browser; instead, a
6561 wx.HyperlinkEvent is fired. Use the wx.EVT_HYPERLINK to catch link
6562 events.
6563
6564 """
6565 _controls_.HyperlinkCtrl_swiginit(self,_controls_.new_HyperlinkCtrl(*args, **kwargs))
6566 self._setOORInfo(self)
6567
6568 def Create(*args, **kwargs):
6569 """
6570 Create(self, Window parent, int id, String label, String url, Point pos=DefaultPosition,
6571 Size size=DefaultSize,
6572 long style=HL_DEFAULT_STYLE, String name=HyperlinkCtrlNameStr) -> bool
6573 """
6574 return _controls_.HyperlinkCtrl_Create(*args, **kwargs)
6575
6576 def GetHoverColour(*args, **kwargs):
6577 """GetHoverColour(self) -> Colour"""
6578 return _controls_.HyperlinkCtrl_GetHoverColour(*args, **kwargs)
6579
6580 def SetHoverColour(*args, **kwargs):
6581 """SetHoverColour(self, Colour colour)"""
6582 return _controls_.HyperlinkCtrl_SetHoverColour(*args, **kwargs)
6583
6584 def GetNormalColour(*args, **kwargs):
6585 """GetNormalColour(self) -> Colour"""
6586 return _controls_.HyperlinkCtrl_GetNormalColour(*args, **kwargs)
6587
6588 def SetNormalColour(*args, **kwargs):
6589 """SetNormalColour(self, Colour colour)"""
6590 return _controls_.HyperlinkCtrl_SetNormalColour(*args, **kwargs)
6591
6592 def GetVisitedColour(*args, **kwargs):
6593 """GetVisitedColour(self) -> Colour"""
6594 return _controls_.HyperlinkCtrl_GetVisitedColour(*args, **kwargs)
6595
6596 def SetVisitedColour(*args, **kwargs):
6597 """SetVisitedColour(self, Colour colour)"""
6598 return _controls_.HyperlinkCtrl_SetVisitedColour(*args, **kwargs)
6599
6600 def GetURL(*args, **kwargs):
6601 """GetURL(self) -> String"""
6602 return _controls_.HyperlinkCtrl_GetURL(*args, **kwargs)
6603
6604 def SetURL(*args, **kwargs):
6605 """SetURL(self, String url)"""
6606 return _controls_.HyperlinkCtrl_SetURL(*args, **kwargs)
6607
6608 def SetVisited(*args, **kwargs):
6609 """SetVisited(self, bool visited=True)"""
6610 return _controls_.HyperlinkCtrl_SetVisited(*args, **kwargs)
6611
6612 def GetVisited(*args, **kwargs):
6613 """GetVisited(self) -> bool"""
6614 return _controls_.HyperlinkCtrl_GetVisited(*args, **kwargs)
6615
6616 HoverColour = property(GetHoverColour,SetHoverColour,doc="See `GetHoverColour` and `SetHoverColour`")
6617 NormalColour = property(GetNormalColour,SetNormalColour,doc="See `GetNormalColour` and `SetNormalColour`")
6618 URL = property(GetURL,SetURL,doc="See `GetURL` and `SetURL`")
6619 Visited = property(GetVisited,SetVisited,doc="See `GetVisited` and `SetVisited`")
6620 VisitedColour = property(GetVisitedColour,SetVisitedColour,doc="See `GetVisitedColour` and `SetVisitedColour`")
6621 _controls_.HyperlinkCtrl_swigregister(HyperlinkCtrl)
6622 HyperlinkCtrlNameStr = cvar.HyperlinkCtrlNameStr
6623
6624 def PreHyperlinkCtrl(*args, **kwargs):
6625 """
6626 PreHyperlinkCtrl() -> HyperlinkCtrl
6627
6628 A static text control that emulates a hyperlink. The link is displayed
6629 in an appropriate text style, derived from the control's normal font.
6630 When the mouse rolls over the link, the cursor changes to a hand and
6631 the link's color changes to the active color.
6632
6633 Clicking on the link does not launch a web browser; instead, a
6634 wx.HyperlinkEvent is fired. Use the wx.EVT_HYPERLINK to catch link
6635 events.
6636
6637 """
6638 val = _controls_.new_PreHyperlinkCtrl(*args, **kwargs)
6639 return val
6640
6641 wxEVT_COMMAND_HYPERLINK = _controls_.wxEVT_COMMAND_HYPERLINK
6642 class HyperlinkEvent(_core.CommandEvent):
6643 """Proxy of C++ HyperlinkEvent class"""
6644 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6645 __repr__ = _swig_repr
6646 def __init__(self, *args, **kwargs):
6647 """__init__(self, Object generator, int id, String url) -> HyperlinkEvent"""
6648 _controls_.HyperlinkEvent_swiginit(self,_controls_.new_HyperlinkEvent(*args, **kwargs))
6649 def GetURL(*args, **kwargs):
6650 """GetURL(self) -> String"""
6651 return _controls_.HyperlinkEvent_GetURL(*args, **kwargs)
6652
6653 def SetURL(*args, **kwargs):
6654 """SetURL(self, String url)"""
6655 return _controls_.HyperlinkEvent_SetURL(*args, **kwargs)
6656
6657 URL = property(GetURL,SetURL,doc="See `GetURL` and `SetURL`")
6658 _controls_.HyperlinkEvent_swigregister(HyperlinkEvent)
6659
6660 EVT_HYPERLINK = wx.PyEventBinder( wxEVT_COMMAND_HYPERLINK, 1 )
6661
6662 #---------------------------------------------------------------------------
6663
6664 PB_USE_TEXTCTRL = _controls_.PB_USE_TEXTCTRL
6665 class PickerBase(_core.Control):
6666 """
6667 Base abstract class for all pickers which support an auxiliary text
6668 control. This class handles all positioning and sizing of the text
6669 control like a an horizontal `wx.BoxSizer` would do, with the text
6670 control on the left of the picker button and the proportion of the
6671 picker fixed to value 1.
6672 """
6673 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6674 def __init__(self): raise AttributeError, "No constructor defined"
6675 __repr__ = _swig_repr
6676 def CreateBase(*args, **kwargs):
6677 """
6678 CreateBase(self, Window parent, int id, String text=wxEmptyString, Point pos=DefaultPosition,
6679 Size size=DefaultSize,
6680 long style=0, Validator validator=DefaultValidator,
6681 String name=wxButtonNameStr) -> bool
6682 """
6683 return _controls_.PickerBase_CreateBase(*args, **kwargs)
6684
6685 def SetInternalMargin(*args, **kwargs):
6686 """
6687 SetInternalMargin(self, int newmargin)
6688
6689 Sets the margin (in pixels) between the picker and the text control.
6690 """
6691 return _controls_.PickerBase_SetInternalMargin(*args, **kwargs)
6692
6693 def GetInternalMargin(*args, **kwargs):
6694 """
6695 GetInternalMargin(self) -> int
6696
6697 Returns the margin (in pixels) between the picker and the text
6698 control.
6699 """
6700 return _controls_.PickerBase_GetInternalMargin(*args, **kwargs)
6701
6702 def SetTextCtrlProportion(*args, **kwargs):
6703 """
6704 SetTextCtrlProportion(self, int prop)
6705
6706 Sets the proportion between the text control and the picker button.
6707 This is used to set relative sizes of the text contorl and the picker.
6708 The value passed to this function must be >= 1.
6709 """
6710 return _controls_.PickerBase_SetTextCtrlProportion(*args, **kwargs)
6711
6712 def GetTextCtrlProportion(*args, **kwargs):
6713 """
6714 GetTextCtrlProportion(self) -> int
6715
6716 Returns the proportion between the text control and the picker.
6717 """
6718 return _controls_.PickerBase_GetTextCtrlProportion(*args, **kwargs)
6719
6720 def SetPickerCtrlProportion(*args, **kwargs):
6721 """
6722 SetPickerCtrlProportion(self, int prop)
6723
6724 Sets the proportion value of the picker.
6725 """
6726 return _controls_.PickerBase_SetPickerCtrlProportion(*args, **kwargs)
6727
6728 def GetPickerCtrlProportion(*args, **kwargs):
6729 """
6730 GetPickerCtrlProportion(self) -> int
6731
6732 Gets the proportion value of the picker.
6733 """
6734 return _controls_.PickerBase_GetPickerCtrlProportion(*args, **kwargs)
6735
6736 def IsTextCtrlGrowable(*args, **kwargs):
6737 """IsTextCtrlGrowable(self) -> bool"""
6738 return _controls_.PickerBase_IsTextCtrlGrowable(*args, **kwargs)
6739
6740 def SetTextCtrlGrowable(*args, **kwargs):
6741 """SetTextCtrlGrowable(self, bool grow=True)"""
6742 return _controls_.PickerBase_SetTextCtrlGrowable(*args, **kwargs)
6743
6744 def IsPickerCtrlGrowable(*args, **kwargs):
6745 """IsPickerCtrlGrowable(self) -> bool"""
6746 return _controls_.PickerBase_IsPickerCtrlGrowable(*args, **kwargs)
6747
6748 def SetPickerCtrlGrowable(*args, **kwargs):
6749 """SetPickerCtrlGrowable(self, bool grow=True)"""
6750 return _controls_.PickerBase_SetPickerCtrlGrowable(*args, **kwargs)
6751
6752 def HasTextCtrl(*args, **kwargs):
6753 """
6754 HasTextCtrl(self) -> bool
6755
6756 Returns true if this class has a valid text control (i.e. if the
6757 wx.PB_USE_TEXTCTRL style was given when creating this control).
6758 """
6759 return _controls_.PickerBase_HasTextCtrl(*args, **kwargs)
6760
6761 def GetTextCtrl(*args, **kwargs):
6762 """
6763 GetTextCtrl(self) -> TextCtrl
6764
6765 Returns a pointer to the text control handled by this class or None if
6766 the wx.PB_USE_TEXTCTRL style was not specified when this control was
6767 created.
6768
6769 Very important: the contents of the text control could be containing
6770 an invalid representation of the entity which can be chosen through
6771 the picker (e.g. the user entered an invalid colour syntax because of
6772 a typo). Thus you should never parse the content of the textctrl to
6773 get the user's input; rather use the derived-class getter
6774 (e.g. `wx.ColourPickerCtrl.GetColour`, `wx.FilePickerCtrl.GetPath`,
6775 etc).
6776 """
6777 return _controls_.PickerBase_GetTextCtrl(*args, **kwargs)
6778
6779 def GetPickerCtrl(*args, **kwargs):
6780 """GetPickerCtrl(self) -> Control"""
6781 return _controls_.PickerBase_GetPickerCtrl(*args, **kwargs)
6782
6783 InternalMargin = property(GetInternalMargin,SetInternalMargin,doc="See `GetInternalMargin` and `SetInternalMargin`")
6784 PickerCtrl = property(GetPickerCtrl,doc="See `GetPickerCtrl`")
6785 PickerCtrlProportion = property(GetPickerCtrlProportion,SetPickerCtrlProportion,doc="See `GetPickerCtrlProportion` and `SetPickerCtrlProportion`")
6786 TextCtrl = property(GetTextCtrl,doc="See `GetTextCtrl`")
6787 TextCtrlProportion = property(GetTextCtrlProportion,SetTextCtrlProportion,doc="See `GetTextCtrlProportion` and `SetTextCtrlProportion`")
6788 TextCtrlGrowable = property(IsTextCtrlGrowable,SetTextCtrlGrowable,doc="See `IsTextCtrlGrowable` and `SetTextCtrlGrowable`")
6789 PickerCtrlGrowable = property(IsPickerCtrlGrowable,SetPickerCtrlGrowable,doc="See `IsPickerCtrlGrowable` and `SetPickerCtrlGrowable`")
6790 _controls_.PickerBase_swigregister(PickerBase)
6791
6792 #---------------------------------------------------------------------------
6793
6794 CLRP_SHOW_LABEL = _controls_.CLRP_SHOW_LABEL
6795 CLRP_USE_TEXTCTRL = _controls_.CLRP_USE_TEXTCTRL
6796 CLRP_DEFAULT_STYLE = _controls_.CLRP_DEFAULT_STYLE
6797 class ColourPickerCtrl(PickerBase):
6798 """
6799 This control allows the user to select a colour. The generic
6800 implementation is a button which brings up a `wx.ColourDialog` when
6801 clicked. Native implementations may differ but this is usually a
6802 (small) widget which give access to the colour-chooser dialog.
6803 """
6804 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6805 __repr__ = _swig_repr
6806 def __init__(self, *args, **kwargs):
6807 """
6808 __init__(self, Window parent, int id=-1, Colour col=*wxBLACK, Point pos=DefaultPosition,
6809 Size size=DefaultSize,
6810 long style=CLRP_DEFAULT_STYLE, Validator validator=DefaultValidator,
6811 String name=ColourPickerCtrlNameStr) -> ColourPickerCtrl
6812
6813 This control allows the user to select a colour. The generic
6814 implementation is a button which brings up a `wx.ColourDialog` when
6815 clicked. Native implementations may differ but this is usually a
6816 (small) widget which give access to the colour-chooser dialog.
6817 """
6818 _controls_.ColourPickerCtrl_swiginit(self,_controls_.new_ColourPickerCtrl(*args, **kwargs))
6819 self._setOORInfo(self)
6820
6821 def Create(*args, **kwargs):
6822 """
6823 Create(self, Window parent, int id, Colour col=*wxBLACK, Point pos=DefaultPosition,
6824 Size size=DefaultSize, long style=CLRP_DEFAULT_STYLE,
6825 Validator validator=DefaultValidator,
6826 String name=ColourPickerCtrlNameStr) -> bool
6827 """
6828 return _controls_.ColourPickerCtrl_Create(*args, **kwargs)
6829
6830 def GetColour(*args, **kwargs):
6831 """
6832 GetColour(self) -> Colour
6833
6834 Returns the currently selected colour.
6835 """
6836 return _controls_.ColourPickerCtrl_GetColour(*args, **kwargs)
6837
6838 def SetColour(*args, **kwargs):
6839 """
6840 SetColour(self, Colour col)
6841
6842 Set the displayed colour.
6843 """
6844 return _controls_.ColourPickerCtrl_SetColour(*args, **kwargs)
6845
6846 Colour = property(GetColour,SetColour,doc="See `GetColour` and `SetColour`")
6847 _controls_.ColourPickerCtrl_swigregister(ColourPickerCtrl)
6848 ColourPickerCtrlNameStr = cvar.ColourPickerCtrlNameStr
6849
6850 def PreColourPickerCtrl(*args, **kwargs):
6851 """
6852 PreColourPickerCtrl() -> ColourPickerCtrl
6853
6854 This control allows the user to select a colour. The generic
6855 implementation is a button which brings up a `wx.ColourDialog` when
6856 clicked. Native implementations may differ but this is usually a
6857 (small) widget which give access to the colour-chooser dialog.
6858 """
6859 val = _controls_.new_PreColourPickerCtrl(*args, **kwargs)
6860 return val
6861
6862 wxEVT_COMMAND_COLOURPICKER_CHANGED = _controls_.wxEVT_COMMAND_COLOURPICKER_CHANGED
6863 EVT_COLOURPICKER_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_COLOURPICKER_CHANGED, 1 )
6864
6865 class ColourPickerEvent(_core.CommandEvent):
6866 """Proxy of C++ ColourPickerEvent class"""
6867 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6868 __repr__ = _swig_repr
6869 def __init__(self, *args, **kwargs):
6870 """__init__(self, Object generator, int id, Colour col) -> ColourPickerEvent"""
6871 _controls_.ColourPickerEvent_swiginit(self,_controls_.new_ColourPickerEvent(*args, **kwargs))
6872 def GetColour(*args, **kwargs):
6873 """GetColour(self) -> Colour"""
6874 return _controls_.ColourPickerEvent_GetColour(*args, **kwargs)
6875
6876 def SetColour(*args, **kwargs):
6877 """SetColour(self, Colour c)"""
6878 return _controls_.ColourPickerEvent_SetColour(*args, **kwargs)
6879
6880 Colour = property(GetColour,SetColour,doc="See `GetColour` and `SetColour`")
6881 _controls_.ColourPickerEvent_swigregister(ColourPickerEvent)
6882
6883 #---------------------------------------------------------------------------
6884
6885 FLP_OPEN = _controls_.FLP_OPEN
6886 FLP_SAVE = _controls_.FLP_SAVE
6887 FLP_OVERWRITE_PROMPT = _controls_.FLP_OVERWRITE_PROMPT
6888 FLP_FILE_MUST_EXIST = _controls_.FLP_FILE_MUST_EXIST
6889 FLP_CHANGE_DIR = _controls_.FLP_CHANGE_DIR
6890 DIRP_DIR_MUST_EXIST = _controls_.DIRP_DIR_MUST_EXIST
6891 DIRP_CHANGE_DIR = _controls_.DIRP_CHANGE_DIR
6892 FLP_USE_TEXTCTRL = _controls_.FLP_USE_TEXTCTRL
6893 FLP_DEFAULT_STYLE = _controls_.FLP_DEFAULT_STYLE
6894 DIRP_USE_TEXTCTRL = _controls_.DIRP_USE_TEXTCTRL
6895 DIRP_DEFAULT_STYLE = _controls_.DIRP_DEFAULT_STYLE
6896 class FilePickerCtrl(PickerBase):
6897 """Proxy of C++ FilePickerCtrl class"""
6898 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6899 __repr__ = _swig_repr
6900 def __init__(self, *args, **kwargs):
6901 """
6902 __init__(self, Window parent, int id=-1, String path=EmptyString,
6903 String message=FileSelectorPromptStr, String wildcard=FileSelectorDefaultWildcardStr,
6904 Point pos=DefaultPosition,
6905 Size size=DefaultSize,
6906 long style=FLP_DEFAULT_STYLE, Validator validator=DefaultValidator,
6907 String name=FilePickerCtrlNameStr) -> FilePickerCtrl
6908 """
6909 _controls_.FilePickerCtrl_swiginit(self,_controls_.new_FilePickerCtrl(*args, **kwargs))
6910 self._setOORInfo(self)
6911
6912 def Create(*args, **kwargs):
6913 """
6914 Create(self, Window parent, int id=-1, String path=EmptyString,
6915 String message=FileSelectorPromptStr, String wildcard=FileSelectorDefaultWildcardStr,
6916 Point pos=DefaultPosition,
6917 Size size=DefaultSize,
6918 long style=FLP_DEFAULT_STYLE, Validator validator=DefaultValidator,
6919 String name=FilePickerCtrlNameStr) -> bool
6920 """
6921 return _controls_.FilePickerCtrl_Create(*args, **kwargs)
6922
6923 def GetPath(*args, **kwargs):
6924 """GetPath(self) -> String"""
6925 return _controls_.FilePickerCtrl_GetPath(*args, **kwargs)
6926
6927 def SetPath(*args, **kwargs):
6928 """SetPath(self, String str)"""
6929 return _controls_.FilePickerCtrl_SetPath(*args, **kwargs)
6930
6931 def CheckPath(*args, **kwargs):
6932 """CheckPath(self, String path) -> bool"""
6933 return _controls_.FilePickerCtrl_CheckPath(*args, **kwargs)
6934
6935 def GetTextCtrlValue(*args, **kwargs):
6936 """GetTextCtrlValue(self) -> String"""
6937 return _controls_.FilePickerCtrl_GetTextCtrlValue(*args, **kwargs)
6938
6939 Path = property(GetPath,SetPath,doc="See `GetPath` and `SetPath`")
6940 TextCtrlValue = property(GetTextCtrlValue,doc="See `GetTextCtrlValue`")
6941 _controls_.FilePickerCtrl_swigregister(FilePickerCtrl)
6942 FilePickerCtrlNameStr = cvar.FilePickerCtrlNameStr
6943 FileSelectorPromptStr = cvar.FileSelectorPromptStr
6944 DirPickerCtrlNameStr = cvar.DirPickerCtrlNameStr
6945 DirSelectorPromptStr = cvar.DirSelectorPromptStr
6946 FileSelectorDefaultWildcardStr = cvar.FileSelectorDefaultWildcardStr
6947
6948 def PreFilePickerCtrl(*args, **kwargs):
6949 """PreFilePickerCtrl() -> FilePickerCtrl"""
6950 val = _controls_.new_PreFilePickerCtrl(*args, **kwargs)
6951 return val
6952
6953 class DirPickerCtrl(PickerBase):
6954 """Proxy of C++ DirPickerCtrl class"""
6955 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6956 __repr__ = _swig_repr
6957 def __init__(self, *args, **kwargs):
6958 """
6959 __init__(self, Window parent, int id=-1, String path=EmptyString,
6960 String message=DirSelectorPromptStr, Point pos=DefaultPosition,
6961 Size size=DefaultSize, long style=DIRP_DEFAULT_STYLE,
6962 Validator validator=DefaultValidator,
6963 String name=DirPickerCtrlNameStr) -> DirPickerCtrl
6964 """
6965 _controls_.DirPickerCtrl_swiginit(self,_controls_.new_DirPickerCtrl(*args, **kwargs))
6966 self._setOORInfo(self)
6967
6968 def Create(*args, **kwargs):
6969 """
6970 Create(self, Window parent, int id=-1, String path=EmptyString,
6971 String message=DirSelectorPromptStr, Point pos=DefaultPosition,
6972 Size size=DefaultSize, long style=DIRP_DEFAULT_STYLE,
6973 Validator validator=DefaultValidator,
6974 String name=DirPickerCtrlNameStr) -> bool
6975 """
6976 return _controls_.DirPickerCtrl_Create(*args, **kwargs)
6977
6978 def GetPath(*args, **kwargs):
6979 """GetPath(self) -> String"""
6980 return _controls_.DirPickerCtrl_GetPath(*args, **kwargs)
6981
6982 def SetPath(*args, **kwargs):
6983 """SetPath(self, String str)"""
6984 return _controls_.DirPickerCtrl_SetPath(*args, **kwargs)
6985
6986 def CheckPath(*args, **kwargs):
6987 """CheckPath(self, String path) -> bool"""
6988 return _controls_.DirPickerCtrl_CheckPath(*args, **kwargs)
6989
6990 def GetTextCtrlValue(*args, **kwargs):
6991 """GetTextCtrlValue(self) -> String"""
6992 return _controls_.DirPickerCtrl_GetTextCtrlValue(*args, **kwargs)
6993
6994 Path = property(GetPath,SetPath,doc="See `GetPath` and `SetPath`")
6995 TextCtrlValue = property(GetTextCtrlValue,doc="See `GetTextCtrlValue`")
6996 _controls_.DirPickerCtrl_swigregister(DirPickerCtrl)
6997
6998 def PreDirPickerCtrl(*args, **kwargs):
6999 """PreDirPickerCtrl() -> DirPickerCtrl"""
7000 val = _controls_.new_PreDirPickerCtrl(*args, **kwargs)
7001 return val
7002
7003 wxEVT_COMMAND_FILEPICKER_CHANGED = _controls_.wxEVT_COMMAND_FILEPICKER_CHANGED
7004 wxEVT_COMMAND_DIRPICKER_CHANGED = _controls_.wxEVT_COMMAND_DIRPICKER_CHANGED
7005 EVT_FILEPICKER_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_FILEPICKER_CHANGED, 1 )
7006 EVT_DIRPICKER_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_DIRPICKER_CHANGED, 1 )
7007
7008 class FileDirPickerEvent(_core.CommandEvent):
7009 """Proxy of C++ FileDirPickerEvent class"""
7010 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7011 __repr__ = _swig_repr
7012 def __init__(self, *args, **kwargs):
7013 """__init__(self, EventType type, Object generator, int id, String path) -> FileDirPickerEvent"""
7014 _controls_.FileDirPickerEvent_swiginit(self,_controls_.new_FileDirPickerEvent(*args, **kwargs))
7015 def GetPath(*args, **kwargs):
7016 """GetPath(self) -> String"""
7017 return _controls_.FileDirPickerEvent_GetPath(*args, **kwargs)
7018
7019 def SetPath(*args, **kwargs):
7020 """SetPath(self, String p)"""
7021 return _controls_.FileDirPickerEvent_SetPath(*args, **kwargs)
7022
7023 Path = property(GetPath,SetPath,doc="See `GetPath` and `SetPath`")
7024 _controls_.FileDirPickerEvent_swigregister(FileDirPickerEvent)
7025
7026 #---------------------------------------------------------------------------
7027
7028 FNTP_FONTDESC_AS_LABEL = _controls_.FNTP_FONTDESC_AS_LABEL
7029 FNTP_USEFONT_FOR_LABEL = _controls_.FNTP_USEFONT_FOR_LABEL
7030 FNTP_USE_TEXTCTRL = _controls_.FNTP_USE_TEXTCTRL
7031 FNTP_DEFAULT_STYLE = _controls_.FNTP_DEFAULT_STYLE
7032 class FontPickerCtrl(PickerBase):
7033 """Proxy of C++ FontPickerCtrl class"""
7034 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7035 __repr__ = _swig_repr
7036 def __init__(self, *args, **kwargs):
7037 """
7038 __init__(self, Window parent, int id=-1, Font initial=wxNullFont,
7039 Point pos=DefaultPosition, Size size=DefaultSize,
7040 long style=FNTP_DEFAULT_STYLE, Validator validator=DefaultValidator,
7041 String name=FontPickerCtrlNameStr) -> FontPickerCtrl
7042 """
7043 _controls_.FontPickerCtrl_swiginit(self,_controls_.new_FontPickerCtrl(*args, **kwargs))
7044 self._setOORInfo(self)
7045
7046 def Create(*args, **kwargs):
7047 """
7048 Create(self, Window parent, int id=-1, Font initial=wxNullFont,
7049 Point pos=DefaultPosition, Size size=DefaultSize,
7050 long style=FNTP_DEFAULT_STYLE, Validator validator=DefaultValidator,
7051 String name=FontPickerCtrlNameStr) -> bool
7052 """
7053 return _controls_.FontPickerCtrl_Create(*args, **kwargs)
7054
7055 def GetSelectedFont(*args, **kwargs):
7056 """GetSelectedFont(self) -> Font"""
7057 return _controls_.FontPickerCtrl_GetSelectedFont(*args, **kwargs)
7058
7059 def SetSelectedFont(*args, **kwargs):
7060 """SetSelectedFont(self, Font f)"""
7061 return _controls_.FontPickerCtrl_SetSelectedFont(*args, **kwargs)
7062
7063 def SetMaxPointSize(*args, **kwargs):
7064 """SetMaxPointSize(self, unsigned int max)"""
7065 return _controls_.FontPickerCtrl_SetMaxPointSize(*args, **kwargs)
7066
7067 def GetMaxPointSize(*args, **kwargs):
7068 """GetMaxPointSize(self) -> unsigned int"""
7069 return _controls_.FontPickerCtrl_GetMaxPointSize(*args, **kwargs)
7070
7071 MaxPointSize = property(GetMaxPointSize,SetMaxPointSize,doc="See `GetMaxPointSize` and `SetMaxPointSize`")
7072 SelectedFont = property(GetSelectedFont,SetSelectedFont,doc="See `GetSelectedFont` and `SetSelectedFont`")
7073 _controls_.FontPickerCtrl_swigregister(FontPickerCtrl)
7074 FontPickerCtrlNameStr = cvar.FontPickerCtrlNameStr
7075
7076 def PreFontPickerCtrl(*args, **kwargs):
7077 """PreFontPickerCtrl() -> FontPickerCtrl"""
7078 val = _controls_.new_PreFontPickerCtrl(*args, **kwargs)
7079 return val
7080
7081 wxEVT_COMMAND_FONTPICKER_CHANGED = _controls_.wxEVT_COMMAND_FONTPICKER_CHANGED
7082 EVT_FONTPICKER_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_FONTPICKER_CHANGED, 1 )
7083
7084 class FontPickerEvent(_core.CommandEvent):
7085 """Proxy of C++ FontPickerEvent class"""
7086 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7087 __repr__ = _swig_repr
7088 def __init__(self, *args, **kwargs):
7089 """__init__(self, Object generator, int id, Font f) -> FontPickerEvent"""
7090 _controls_.FontPickerEvent_swiginit(self,_controls_.new_FontPickerEvent(*args, **kwargs))
7091 def GetFont(*args, **kwargs):
7092 """GetFont(self) -> Font"""
7093 return _controls_.FontPickerEvent_GetFont(*args, **kwargs)
7094
7095 def SetFont(*args, **kwargs):
7096 """SetFont(self, Font c)"""
7097 return _controls_.FontPickerEvent_SetFont(*args, **kwargs)
7098
7099 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
7100 _controls_.FontPickerEvent_swigregister(FontPickerEvent)
7101
7102 #---------------------------------------------------------------------------
7103
7104 CP_DEFAULT_STYLE = _controls_.CP_DEFAULT_STYLE
7105 CP_NO_TLW_RESIZE = _controls_.CP_NO_TLW_RESIZE
7106 class CollapsiblePane(_core.Control):
7107 """
7108 A collapsable pane is a container with an embedded button-like
7109 control which can be used by the user to collapse or expand the pane's
7110 contents.
7111
7112 Once constructed you should use the `GetPane` function to access the
7113 pane and add your controls inside it (i.e. use the window returned
7114 from `GetPane` as the parent for the controls which must go in the
7115 pane, NOT the wx.CollapsiblePane itself!).
7116
7117 Note that because of its nature of control which can dynamically (and
7118 drastically) change its size at run-time under user-input, when
7119 putting a wx.CollapsiblePane inside a `wx.Sizer` you should be careful
7120 to add it with a proportion value of zero; this is because otherwise
7121 all other windows with non-zero proportion values would automatically
7122 get resized each time the user expands or collapses the pane window,
7123 usually resulting a weird, flickering effect.
7124 """
7125 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7126 __repr__ = _swig_repr
7127 def __init__(self, *args, **kwargs):
7128 """
7129 __init__(self, Window parent, int winid=-1, String label=EmptyString,
7130 Point pos=DefaultPosition, Size size=DefaultSize,
7131 long style=CP_DEFAULT_STYLE, Validator val=DefaultValidator,
7132 String name=CollapsiblePaneNameStr) -> CollapsiblePane
7133
7134 Create and show a wx.CollapsiblePane
7135 """
7136 _controls_.CollapsiblePane_swiginit(self,_controls_.new_CollapsiblePane(*args, **kwargs))
7137 self._setOORInfo(self)
7138
7139 def Create(*args, **kwargs):
7140 """
7141 Create(self, Window parent, int winid=-1, String label=EmptyString,
7142 Point pos=DefaultPosition, Size size=DefaultSize,
7143 long style=CP_DEFAULT_STYLE, Validator val=DefaultValidator,
7144 String name=CollapsiblePaneNameStr) -> bool
7145 """
7146 return _controls_.CollapsiblePane_Create(*args, **kwargs)
7147
7148 def Collapse(*args, **kwargs):
7149 """
7150 Collapse(self, bool collapse=True)
7151
7152 Collapses or expands the pane window.
7153 """
7154 return _controls_.CollapsiblePane_Collapse(*args, **kwargs)
7155
7156 def Expand(*args, **kwargs):
7157 """
7158 Expand(self)
7159
7160 Same as Collapse(False).
7161 """
7162 return _controls_.CollapsiblePane_Expand(*args, **kwargs)
7163
7164 def IsCollapsed(*args, **kwargs):
7165 """
7166 IsCollapsed(self) -> bool
7167
7168 Returns ``True`` if the pane window is currently hidden.
7169 """
7170 return _controls_.CollapsiblePane_IsCollapsed(*args, **kwargs)
7171
7172 def IsExpanded(*args, **kwargs):
7173 """
7174 IsExpanded(self) -> bool
7175
7176 Returns ``True`` if the pane window is currently shown.
7177 """
7178 return _controls_.CollapsiblePane_IsExpanded(*args, **kwargs)
7179
7180 def GetPane(*args, **kwargs):
7181 """
7182 GetPane(self) -> Window
7183
7184 Returns a reference to the pane window. Use the returned `wx.Window`
7185 as the parent of widgets to make them part of the collapsible area.
7186 """
7187 return _controls_.CollapsiblePane_GetPane(*args, **kwargs)
7188
7189 Expanded = property(IsExpanded)
7190 Collapsed = property(IsCollapsed)
7191 _controls_.CollapsiblePane_swigregister(CollapsiblePane)
7192 CollapsiblePaneNameStr = cvar.CollapsiblePaneNameStr
7193
7194 def PreCollapsiblePane(*args, **kwargs):
7195 """
7196 PreCollapsiblePane() -> CollapsiblePane
7197
7198 Precreate a wx.CollapsiblePane for 2-phase creation.
7199 """
7200 val = _controls_.new_PreCollapsiblePane(*args, **kwargs)
7201 return val
7202
7203 wxEVT_COMMAND_COLLPANE_CHANGED = _controls_.wxEVT_COMMAND_COLLPANE_CHANGED
7204 EVT_COLLAPSIBLEPANE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_COLLPANE_CHANGED, 1 )
7205
7206 class CollapsiblePaneEvent(_core.CommandEvent):
7207 """Proxy of C++ CollapsiblePaneEvent class"""
7208 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7209 __repr__ = _swig_repr
7210 def __init__(self, *args, **kwargs):
7211 """__init__(self, Object generator, int id, bool collapsed) -> CollapsiblePaneEvent"""
7212 _controls_.CollapsiblePaneEvent_swiginit(self,_controls_.new_CollapsiblePaneEvent(*args, **kwargs))
7213 def GetCollapsed(*args, **kwargs):
7214 """GetCollapsed(self) -> bool"""
7215 return _controls_.CollapsiblePaneEvent_GetCollapsed(*args, **kwargs)
7216
7217 def SetCollapsed(*args, **kwargs):
7218 """SetCollapsed(self, bool c)"""
7219 return _controls_.CollapsiblePaneEvent_SetCollapsed(*args, **kwargs)
7220
7221 Collapsed = property(GetCollapsed,SetCollapsed)
7222 _controls_.CollapsiblePaneEvent_swigregister(CollapsiblePaneEvent)
7223
7224 #---------------------------------------------------------------------------
7225
7226 class SearchCtrl(TextCtrl):
7227 """
7228 A search control is a composite of a `wx.TextCtrl` with optional
7229 bitmap buttons and a drop-down menu. Controls like this can typically
7230 be found on a toolbar of applications that support some form of search
7231 functionality. On the Mac this control is implemented using the
7232 native HISearchField control, on the other platforms a generic control
7233 is used, although that may change in the future as more platforms
7234 introduce native search widgets.
7235
7236 If you wish to use a drop-down menu with your wx.SearchCtrl then you
7237 will need to manage its content and handle the menu events yourself,
7238 but this is an easy thing to do. Simply build the menu, pass it to
7239 `SetMenu`, and also bind a handler for a range of EVT_MENU events.
7240 This gives you the flexibility to use the drop-down menu however you
7241 wish, such as for a history of searches, or as a way to select
7242 different kinds of searches. The ToolBar.py sample in the demo shows
7243 one way to do this.
7244
7245 Since the control derives from `wx.TextCtrl` it is convenient to use
7246 the styles and events designed for `wx.TextCtrl`. For example you can
7247 use the ``wx.TE_PROCESS_ENTER`` style and catch the
7248 ``wx.EVT_TEXT_ENTER`` event to know when the user has pressed the
7249 Enter key in the control and wishes to start a search.
7250
7251 """
7252 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
7253 __repr__ = _swig_repr
7254 def __init__(self, *args, **kwargs):
7255 """
7256 __init__(self, Window parent, int id=-1, String value=wxEmptyString,
7257 Point pos=DefaultPosition, Size size=DefaultSize,
7258 long style=0, Validator validator=DefaultValidator,
7259 String name=SearchCtrlNameStr) -> SearchCtrl
7260
7261 A search control is a composite of a `wx.TextCtrl` with optional
7262 bitmap buttons and a drop-down menu. Controls like this can typically
7263 be found on a toolbar of applications that support some form of search
7264 functionality. On the Mac this control is implemented using the
7265 native HISearchField control, on the other platforms a generic control
7266 is used, although that may change in the future as more platforms
7267 introduce native search widgets.
7268
7269 If you wish to use a drop-down menu with your wx.SearchCtrl then you
7270 will need to manage its content and handle the menu events yourself,
7271 but this is an easy thing to do. Simply build the menu, pass it to
7272 `SetMenu`, and also bind a handler for a range of EVT_MENU events.
7273 This gives you the flexibility to use the drop-down menu however you
7274 wish, such as for a history of searches, or as a way to select
7275 different kinds of searches. The ToolBar.py sample in the demo shows
7276 one way to do this.
7277
7278 Since the control derives from `wx.TextCtrl` it is convenient to use
7279 the styles and events designed for `wx.TextCtrl`. For example you can
7280 use the ``wx.TE_PROCESS_ENTER`` style and catch the
7281 ``wx.EVT_TEXT_ENTER`` event to know when the user has pressed the
7282 Enter key in the control and wishes to start a search.
7283
7284 """
7285 _controls_.SearchCtrl_swiginit(self,_controls_.new_SearchCtrl(*args, **kwargs))
7286 self._setOORInfo(self)
7287
7288 def Create(*args, **kwargs):
7289 """
7290 Create(self, Window parent, int id=-1, String value=wxEmptyString,
7291 Point pos=DefaultPosition, Size size=DefaultSize,
7292 long style=0, Validator validator=DefaultValidator,
7293 String name=SearchCtrlNameStr) -> bool
7294 """
7295 return _controls_.SearchCtrl_Create(*args, **kwargs)
7296
7297 def SetMenu(*args, **kwargs):
7298 """
7299 SetMenu(self, Menu menu)
7300
7301 Sets the search control's menu object. If there is already a menu
7302 associated with the search control it is deleted.
7303 """
7304 return _controls_.SearchCtrl_SetMenu(*args, **kwargs)
7305
7306 def GetMenu(*args, **kwargs):
7307 """
7308 GetMenu(self) -> Menu
7309
7310 Returns a pointer to the search control's menu object or None if there
7311 is no menu attached.
7312 """
7313 return _controls_.SearchCtrl_GetMenu(*args, **kwargs)
7314
7315 def ShowSearchButton(*args, **kwargs):
7316 """
7317 ShowSearchButton(self, bool show)
7318
7319 Sets the search button visibility value on the search control. If
7320 there is a menu attached, the search button will be visible regardless
7321 of the search button visibility value. This has no effect in Mac OS X
7322 v10.3
7323 """
7324 return _controls_.SearchCtrl_ShowSearchButton(*args, **kwargs)
7325
7326 def IsSearchButtonVisible(*args, **kwargs):
7327 """
7328 IsSearchButtonVisible(self) -> bool
7329
7330 Returns the search button visibility value. If there is a menu
7331 attached, the search button will be visible regardless of the search
7332 button visibility value. This always returns false in Mac OS X v10.3
7333 """
7334 return _controls_.SearchCtrl_IsSearchButtonVisible(*args, **kwargs)
7335
7336 def ShowCancelButton(*args, **kwargs):
7337 """
7338 ShowCancelButton(self, bool show)
7339
7340 Shows or hides the cancel button.
7341 """
7342 return _controls_.SearchCtrl_ShowCancelButton(*args, **kwargs)
7343
7344 def IsCancelButtonVisible(*args, **kwargs):
7345 """
7346 IsCancelButtonVisible(self) -> bool
7347
7348 Indicates whether the cancel button is visible.
7349 """
7350 return _controls_.SearchCtrl_IsCancelButtonVisible(*args, **kwargs)
7351
7352 def SetDescriptiveText(*args, **kwargs):
7353 """
7354 SetDescriptiveText(self, String text)
7355
7356 Set the text to be displayed when the user has not yet typed anything
7357 in the control.
7358 """
7359 return _controls_.SearchCtrl_SetDescriptiveText(*args, **kwargs)
7360
7361 def GetDescriptiveText(*args, **kwargs):
7362 """
7363 GetDescriptiveText(self) -> String
7364
7365 Get the text to be displayed when the user has not yet typed anything
7366 in the control.
7367 """
7368 return _controls_.SearchCtrl_GetDescriptiveText(*args, **kwargs)
7369
7370 def SetSearchBitmap(*args, **kwargs):
7371 """
7372 SetSearchBitmap(self, Bitmap bitmap)
7373
7374 Sets the bitmap to use for the search button. This currently does not
7375 work on the Mac.
7376 """
7377 return _controls_.SearchCtrl_SetSearchBitmap(*args, **kwargs)
7378
7379 def SetSearchMenuBitmap(*args, **kwargs):
7380 """
7381 SetSearchMenuBitmap(self, Bitmap bitmap)
7382
7383 Sets the bitmap to use for the search button when there is a drop-down
7384 menu associated with the search control. This currently does not work
7385 on the Mac.
7386 """
7387 return _controls_.SearchCtrl_SetSearchMenuBitmap(*args, **kwargs)
7388
7389 def SetCancelBitmap(*args, **kwargs):
7390 """
7391 SetCancelBitmap(self, Bitmap bitmap)
7392
7393 Sets the bitmap to use for the cancel button. This currently does not
7394 work on the Mac.
7395 """
7396 return _controls_.SearchCtrl_SetCancelBitmap(*args, **kwargs)
7397
7398 Menu = property(GetMenu,SetMenu)
7399 SearchButtonVisible = property(IsSearchButtonVisible,ShowSearchButton)
7400 CancelButtonVisible = property(IsCancelButtonVisible,ShowCancelButton)
7401 DescriptiveText = property(GetDescriptiveText,SetDescriptiveText)
7402 _controls_.SearchCtrl_swigregister(SearchCtrl)
7403 SearchCtrlNameStr = cvar.SearchCtrlNameStr
7404
7405 def PreSearchCtrl(*args, **kwargs):
7406 """
7407 PreSearchCtrl() -> SearchCtrl
7408
7409 Precreate a wx.SearchCtrl for 2-phase creation.
7410 """
7411 val = _controls_.new_PreSearchCtrl(*args, **kwargs)
7412 return val
7413
7414 wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN = _controls_.wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN
7415 wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN = _controls_.wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN
7416 EVT_SEARCHCTRL_CANCEL_BTN = wx.PyEventBinder( wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN, 1)
7417 EVT_SEARCHCTRL_SEARCH_BTN = wx.PyEventBinder( wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN, 1)
7418
7419
7420