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