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