import _core
wx = _core
-__docfilter__ = wx.__docfilter__
#---------------------------------------------------------------------------
BU_LEFT = _controls_.BU_LEFT
return _controls_.Button_SetDefault(*args, **kwargs)
def GetDefaultSize(*args, **kwargs):
- """Button.GetDefaultSize() -> Size"""
+ """
+ GetDefaultSize() -> Size
+
+ Returns the default button size for this platform.
+ """
return _controls_.Button_GetDefaultSize(*args, **kwargs)
GetDefaultSize = staticmethod(GetDefaultSize)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class ButtonPtr(Button):
def __init__(self, this):
return val
def Button_GetDefaultSize(*args, **kwargs):
- """Button_GetDefaultSize() -> Size"""
+ """
+ Button_GetDefaultSize() -> Size
+
+ Returns the default button size for this platform.
+ """
return _controls_.Button_GetDefaultSize(*args, **kwargs)
+def Button_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ Button_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs)
+
class BitmapButton(Button):
"""
A Button that contains a bitmap. A bitmap button can be supplied with a
- single bitmap, and wxWindows will draw all button states using this bitmap. If
+ single bitmap, and wxWidgets will draw all button states using this bitmap. If
the application needs more control, additional bitmaps for the selected state,
unpressed focused state, and greyed-out state may be supplied.
-
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxBitmapButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
CHK_UNDETERMINED = _controls_.CHK_UNDETERMINED
class CheckBox(_core.Control):
"""
- A checkbox is a labelled box which by default is either on (checkmark is
- visible) or off (no checkmark). Optionally (When the wxCHK_3STATE style flag
- is set) it can have a third state, called the mixed or undetermined
- state. Often this is used as a "Does Not Apply" state.
+ A checkbox is a labelled box which by default is either on (the
+ checkmark is visible) or off (no checkmark). Optionally (When the
+ wx.CHK_3STATE style flag is set) it can have a third state, called the
+ mixed or undetermined state. Often this is used as a "Does Not
+ Apply" state.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxCheckBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
IsChecked(self) -> bool
- Similar to GetValue, but raises an exception if it is not a 2-state CheckBox.
+ Similar to GetValue, but raises an exception if it is not a 2-state
+ CheckBox.
"""
return _controls_.CheckBox_IsChecked(*args, **kwargs)
"""
SetValue(self, bool state)
- Set the state of a 2-state CheckBox. Pass True for checked,
- False for unchecked.
+ Set the state of a 2-state CheckBox. Pass True for checked, False for
+ unchecked.
"""
return _controls_.CheckBox_SetValue(*args, **kwargs)
"""
Get3StateValue(self) -> int
- Returns wx.CHK_UNCHECKED when the CheckBox is unchecked, wx.CHK_CHECKED when
- it is checked and wx.CHK_UNDETERMINED when it's in the undetermined state.
- Raises an exceptiion when the function is used with a 2-state CheckBox.
+ Returns wx.CHK_UNCHECKED when the CheckBox is unchecked,
+ wx.CHK_CHECKED when it is checked and wx.CHK_UNDETERMINED when it's in
+ the undetermined state. Raises an exceptiion when the function is
+ used with a 2-state CheckBox.
"""
return _controls_.CheckBox_Get3StateValue(*args, **kwargs)
"""
Set3StateValue(self, int state)
- Sets the CheckBox to the given state. The state parameter can be
- one of the following: wx.CHK_UNCHECKED (Check is off), wx.CHK_CHECKED
- (Check is on) or wx.CHK_UNDETERMINED (Check is mixed). Raises an
- exception when the CheckBox is a 2-state checkbox and setting the state
- to wx.CHK_UNDETERMINED.
+ Sets the CheckBox to the given state. The state parameter can be one
+ of the following: wx.CHK_UNCHECKED (Check is off), wx.CHK_CHECKED (the
+ Check is on) or wx.CHK_UNDETERMINED (Check is mixed). Raises an
+ exception when the CheckBox is a 2-state checkbox and setting the
+ state to wx.CHK_UNDETERMINED.
"""
return _controls_.CheckBox_Set3StateValue(*args, **kwargs)
"""
Is3rdStateAllowedForUser(self) -> bool
- Returns whether or not the user can set the CheckBox to the third state.
+ Returns whether or not the user can set the CheckBox to the third
+ state.
"""
return _controls_.CheckBox_Is3rdStateAllowedForUser(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class CheckBoxPtr(CheckBox):
def __init__(self, this):
val.thisown = 1
return val
+def CheckBox_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ CheckBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class Choice(_core.ControlWithItems):
"""
- A Choice control is used to select one of a list of strings. Unlike a ListBox,
- only the selection is visible until the user pulls down the menu of choices.
+ A Choice control is used to select one of a list of strings.
+ Unlike a `wx.ListBox`, only the selection is visible until the
+ user pulls down the menu of choices.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxChoice instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
List choices=[], long style=0, Validator validator=DefaultValidator,
String name=ChoiceNameStr) -> bool
-
- Actually create the GUI Choice control for 2-phase creation
"""
return _controls_.Choice_Create(*args, **kwargs)
def SetStringSelection(*args, **kwargs):
"""
- SetStringSelection(self, String string)
+ SetStringSelection(self, String string) -> bool
Select the item with the specifed string
"""
return _controls_.Choice_SetString(*args, **kwargs)
Select = SetSelection
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class ChoicePtr(Choice):
def __init__(self, this):
val.thisown = 1
return val
+def Choice_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ Choice_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class ComboBox(_core.Control,_core.ItemContainer):
"""
- A combobox is like a combination of an edit control and a listbox. It can be
- displayed as static list with editable or read-only text field; or a drop-down
- list with text field.
+ A combobox is like a combination of an edit control and a
+ listbox. It can be displayed as static list with editable or
+ read-only text field; or a drop-down list with text field.
+
+ A combobox permits a single selection only. Combobox items are
+ numbered from zero.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxComboBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
__init__(Window parent, int id, String value=EmptyString,
Point pos=DefaultPosition, Size size=DefaultSize,
- List choices=[], long style=0, Validator validator=DefaultValidator,
- String name=ComboBoxNameStr) -> ComboBox
+ List choices=[], long style=0, Validator validator=DefaultValidator,
+ String name=ComboBoxNameStr) -> ComboBox
Constructor, creates and shows a ComboBox control.
"""
Point pos=DefaultPosition, Size size=DefaultSize,
List choices=[], long style=0, Validator validator=DefaultValidator,
String name=ChoiceNameStr) -> bool
-
- Actually create the GUI wxComboBox control for 2-phase creation
"""
return _controls_.ComboBox_Create(*args, **kwargs)
"""
SetSelection(self, int n)
- Selects the text between the two positions, in the combobox text field.
+ Sets the item at index 'n' to be the selected item.
"""
return _controls_.ComboBox_SetSelection(*args, **kwargs)
def SetMark(*args, **kwargs):
- """SetMark(self, long from, long to)"""
+ """
+ SetMark(self, long from, long to)
+
+ Selects the text between the two positions in the combobox text field.
+ """
return _controls_.ComboBox_SetMark(*args, **kwargs)
+ def SetStringSelection(*args, **kwargs):
+ """
+ SetStringSelection(self, String string) -> bool
+
+ Select the item with the specifed string
+ """
+ return _controls_.ComboBox_SetStringSelection(*args, **kwargs)
+
+ def SetString(*args, **kwargs):
+ """
+ SetString(self, int n, String string)
+
+ Set the label for the n'th item (zero based) in the list.
+ """
+ return _controls_.ComboBox_SetString(*args, **kwargs)
+
def SetEditable(*args, **kwargs):
"""SetEditable(self, bool editable)"""
return _controls_.ComboBox_SetEditable(*args, **kwargs)
"""
return _controls_.ComboBox_Remove(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class ComboBoxPtr(ComboBox):
def __init__(self, this):
val.thisown = 1
return val
+def ComboBox_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ ComboBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
GA_HORIZONTAL = _controls_.GA_HORIZONTAL
"""GetBezelFace(self) -> int"""
return _controls_.Gauge_GetBezelFace(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class GaugePtr(Gauge):
def __init__(self, this):
val.thisown = 1
return val
+def Gauge_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ Gauge_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class StaticBox(_core.Control):
"""
return _controls_.StaticBox_Create(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class StaticBoxPtr(StaticBox):
def __init__(self, this):
val.thisown = 1
return val
+def StaticBox_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ StaticBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class StaticLine(_core.Control):
return _controls_.StaticLine_IsVertical(*args, **kwargs)
def GetDefaultSize(*args, **kwargs):
- """StaticLine.GetDefaultSize() -> int"""
+ """GetDefaultSize() -> int"""
return _controls_.StaticLine_GetDefaultSize(*args, **kwargs)
GetDefaultSize = staticmethod(GetDefaultSize)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class StaticLinePtr(StaticLine):
def __init__(self, this):
"""StaticLine_GetDefaultSize() -> int"""
return _controls_.StaticLine_GetDefaultSize(*args, **kwargs)
+def StaticLine_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ StaticLine_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class StaticText(_core.Control):
"""
return _controls_.StaticText_Create(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class StaticTextPtr(StaticText):
def __init__(self, this):
val.thisown = 1
return val
+def StaticText_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ StaticText_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class StaticBitmap(_core.Control):
"""SetIcon(self, Icon icon)"""
return _controls_.StaticBitmap_SetIcon(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class StaticBitmapPtr(StaticBitmap):
def __init__(self, this):
val.thisown = 1
return val
+def StaticBitmap_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ StaticBitmap_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class ListBox(_core.ControlWithItems):
"""
Insert(self, String item, int pos, PyObject clientData=None)
- Insert an item into the control before the item at the pos index,
+ Insert an item into the control before the item at the ``pos`` index,
optionally associating some data object with the item.
"""
return _controls_.ListBox_Insert(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
"""
- ListBox.GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
"""
return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs)
"""
ListBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
"""
return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs)
return _controls_.TextAttr_IsDefault(*args, **kwargs)
def Combine(*args, **kwargs):
- """TextAttr.Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr"""
+ """Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr"""
return _controls_.TextAttr_Combine(*args, **kwargs)
Combine = staticmethod(Combine)
return _controls_.TextCtrl_IsMultiLine(*args, **kwargs)
def GetSelection(*args, **kwargs):
- """
- GetSelection() -> (from, to)
-
- If the return values from and to are the same, there is no selection.
- """
+ """GetSelection() -> (from, to)"""
return _controls_.TextCtrl_GetSelection(*args, **kwargs)
def GetStringSelection(*args, **kwargs):
return _controls_.TextCtrl_ShowPosition(*args, **kwargs)
def HitTest(*args, **kwargs):
- """
- HitTest(Point pt) -> (result, row, col)
-
- Find the character at position given in pixels.
- NB: pt is in device coords (not adjusted for the client area
- origin nor scrolling)
- """
+ """HitTest(Point pt) -> (result, row, col)"""
return _controls_.TextCtrl_HitTest(*args, **kwargs)
def Copy(*args, **kwargs):
"""GetString(self, long from, long to) -> String"""
return _controls_.TextCtrl_GetString(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class TextCtrlPtr(TextCtrl):
def __init__(self, this):
val.thisown = 1
return val
+def TextCtrl_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ TextCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs)
+
wxEVT_COMMAND_TEXT_UPDATED = _controls_.wxEVT_COMMAND_TEXT_UPDATED
wxEVT_COMMAND_TEXT_ENTER = _controls_.wxEVT_COMMAND_TEXT_ENTER
wxEVT_COMMAND_TEXT_URL = _controls_.wxEVT_COMMAND_TEXT_URL
bool refresh=True)
Sets the scrollbar properties of a built-in scrollbar.
+ """
+ return _controls_.ScrollBar_SetScrollbar(*args, **kwargs)
- orientation: Determines the scrollbar whose page size is to be
- set. May be wx.HORIZONTAL or wx.VERTICAL.
-
- position: The position of the scrollbar in scroll units.
-
- thumbSize: The size of the thumb, or visible portion of the
- scrollbar, in scroll units.
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
- range: The maximum position of the scrollbar.
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
- refresh: True to redraw the scrollbar, false otherwise.
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
"""
- return _controls_.ScrollBar_SetScrollbar(*args, **kwargs)
+ return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs)
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class ScrollBarPtr(ScrollBar):
def __init__(self, this):
val.thisown = 1
return val
+def ScrollBar_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ ScrollBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
SP_HORIZONTAL = _controls_.SP_HORIZONTAL
"""IsVertical(self) -> bool"""
return _controls_.SpinButton_IsVertical(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class SpinButtonPtr(SpinButton):
def __init__(self, this):
val.thisown = 1
return val
+def SpinButton_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ SpinButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs)
+
class SpinCtrl(_core.Control):
def __repr__(self):
return "<%s.%s; proxy of C++ wxSpinCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""SetSelection(self, long from, long to)"""
return _controls_.SpinCtrl_SetSelection(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class SpinCtrlPtr(SpinCtrl):
def __init__(self, this):
val.thisown = 1
return val
+def SpinCtrl_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ SpinCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs)
+
class SpinEvent(_core.NotifyEvent):
def __repr__(self):
return "<%s.%s; proxy of C++ wxSpinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""GetNextItem(self, int item, int dir, long style) -> int"""
return _controls_.RadioBox_GetNextItem(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class RadioBoxPtr(RadioBox):
def __init__(self, this):
val.thisown = 1
return val
+def RadioBox_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ RadioBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class RadioButton(_core.Control):
"""SetValue(self, bool value)"""
return _controls_.RadioButton_SetValue(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class RadioButtonPtr(RadioButton):
def __init__(self, this):
val.thisown = 1
return val
+def RadioButton_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ RadioButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class Slider(_core.Control):
"""SetSelection(self, int min, int max)"""
return _controls_.Slider_SetSelection(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class SliderPtr(Slider):
def __init__(self, this):
val.thisown = 1
return val
+def Slider_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ Slider_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
wxEVT_COMMAND_TOGGLEBUTTON_CLICKED = _controls_.wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
del newobj.thisown
self._setOORInfo(self)
+ def Create(*args, **kwargs):
+ """
+ Create(self, Window parent, int id, String label, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0,
+ Validator validator=DefaultValidator, String name=ToggleButtonNameStr) -> bool
+ """
+ return _controls_.ToggleButton_Create(*args, **kwargs)
+
+ def SetValue(*args, **kwargs):
+ """SetValue(self, bool value)"""
+ return _controls_.ToggleButton_SetValue(*args, **kwargs)
+
+ def GetValue(*args, **kwargs):
+ """GetValue(self) -> bool"""
+ return _controls_.ToggleButton_GetValue(*args, **kwargs)
+
+ def SetLabel(*args, **kwargs):
+ """
+ SetLabel(self, String label)
+
+ Sets the item's text.
+ """
+ return _controls_.ToggleButton_SetLabel(*args, **kwargs)
+
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class ToggleButtonPtr(ToggleButton):
def __init__(self, this):
val.thisown = 1
return val
+def ToggleButton_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ ToggleButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
class BookCtrl(_core.Control):
"""AdvanceSelection(self, bool forward=True)"""
return _controls_.BookCtrl_AdvanceSelection(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.BookCtrl_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class BookCtrlPtr(BookCtrl):
def __init__(self, this):
_controls_.BookCtrl_swigregister(BookCtrlPtr)
NOTEBOOK_NAME = cvar.NOTEBOOK_NAME
+def BookCtrl_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ BookCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.BookCtrl_GetClassDefaultAttributes(*args, **kwargs)
+
class BookCtrlEvent(_core.NotifyEvent):
def __repr__(self):
return "<%s.%s; proxy of C++ wxBookCtrlEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
return _controls_.Notebook_SetTabSize(*args, **kwargs)
def HitTest(*args, **kwargs):
- """
- HitTest(Point pt) -> (tab, where)
-
- Returns the tab which is hit, and flags indicating where using wx.NB_HITTEST_ flags.
- """
+ """HitTest(Point pt) -> (tab, where)"""
return _controls_.Notebook_HitTest(*args, **kwargs)
def CalcSizeFromPage(*args, **kwargs):
"""CalcSizeFromPage(self, Size sizePage) -> Size"""
return _controls_.Notebook_CalcSizeFromPage(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class NotebookPtr(Notebook):
def __init__(self, this):
val.thisown = 1
return val
+def Notebook_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ Notebook_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs)
+
class NotebookEvent(BookCtrlEvent):
def __repr__(self):
return "<%s.%s; proxy of C++ wxNotebookEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""FindToolForPosition(self, int x, int y) -> ToolBarToolBase"""
return _controls_.ToolBar_FindToolForPosition(*args, **kwargs)
+ def GetClassDefaultAttributes(*args, **kwargs):
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs)
+
+ GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
class ToolBarPtr(ToolBar):
def __init__(self, this):
val.thisown = 1
return val
+def ToolBar_GetClassDefaultAttributes(*args, **kwargs):
+ """
+ ToolBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
+ """
+ return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs)
+
#---------------------------------------------------------------------------
LC_VRULES = _controls_.LC_VRULES
"""
SetWindowStyleFlag(self, long style)
- Sets the style of the window. Please note that some styles cannot
- be changed after the window creation and that Refresh() might
- need to be called after changing the others for the change to
- take place immediately.
+ Sets the style of the window. Please note that some styles cannot be
+ changed after the window creation and that Refresh() might need to be
+ called after changing the others for the change to take place
+ immediately.
"""
return _controls_.ListCtrl_SetWindowStyleFlag(*args, **kwargs)
return _controls_.ListCtrl_FindItemAtPos(*args, **kwargs)
def HitTest(*args, **kwargs):
- """
- HitTest(Point point) -> (item, where)
-
- Determines which item (if any) is at the specified point,
- giving details in the second return value (see wxLIST_HITTEST_... flags.)
- """
+ """HitTest(Point point) -> (item, where)"""
return _controls_.ListCtrl_HitTest(*args, **kwargs)
def InsertItem(*args, **kwargs):
def GetClassDefaultAttributes(*args, **kwargs):
"""
- ListCtrl.GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
"""
return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs)
"""
ListCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
"""
return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs)
return _controls_.TreeCtrl_SortChildren(*args, **kwargs)
def HitTest(*args, **kwargs):
- """
- HitTest(Point point) -> (item, where)
-
- Determine which item (if any) belongs the given point. The
- coordinates specified are relative to the client area of tree ctrl
- and the where return value is set to a bitmask of wxTREE_HITTEST_xxx
- constants.
-
- """
+ """HitTest(Point point) -> (item, where)"""
return _controls_.TreeCtrl_HitTest(*args, **kwargs)
def GetBoundingRect(*args, **kwargs):
def GetClassDefaultAttributes(*args, **kwargs):
"""
- TreeCtrl.GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
"""
return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs)
"""
TreeCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the users
+ system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See SetWindowVariant for more about this.
"""
return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs)
return _controls_.GenericDirCtrl_GetFilterListCtrl(*args, **kwargs)
def FindChild(*args, **kwargs):
- """
- FindChild(wxTreeItemId parentId, wxString path) -> (item, done)
-
- Find the child that matches the first part of 'path'. E.g. if a child path is
- "/usr" and 'path' is "/usr/include" then the child for /usr is returned.
- If the path string has been used (we're at the leaf), done is set to True
-
- """
+ """FindChild(wxTreeItemId parentId, wxString path) -> (item, done)"""
return _controls_.GenericDirCtrl_FindChild(*args, **kwargs)
def DoResize(*args, **kwargs):
class HelpEvent(_core.CommandEvent):
"""
- A help event is sent when the user has requested
- context-sensitive help. This can either be caused by the
- application requesting context-sensitive help mode via
- wx.ContextHelp, or (on MS Windows) by the system generating a
- WM_HELP message when the user pressed F1 or clicked on the query
- button in a dialog caption.
-
- A help event is sent to the window that the user clicked on, and
- is propagated up the window hierarchy until the event is
- processed or there are no more event handlers. The application
- should call event.GetId to check the identity of the clicked-on
- window, and then either show some suitable help or call
- event.Skip if the identifier is unrecognised. Calling Skip is
- important because it allows wxWindows to generate further events
- for ancestors of the clicked-on window. Otherwise it would be
- impossible to show help for container windows, since processing
- would stop after the first window found.
-
- Events
- EVT_HELP Sent when the user has requested context-
- sensitive help.
- EVT_HELP_RANGE Allows to catch EVT_HELP for a range of IDs
-
+ A help event is sent when the user has requested context-sensitive
+ help. This can either be caused by the application requesting
+ context-sensitive help mode via wx.ContextHelp, or (on MS Windows) by
+ the system generating a WM_HELP message when the user pressed F1 or
+ clicked on the query button in a dialog caption.
+
+ A help event is sent to the window that the user clicked on, and is
+ propagated up the window hierarchy until the event is processed or
+ there are no more event handlers. The application should call
+ event.GetId to check the identity of the clicked-on window, and then
+ either show some suitable help or call event.Skip if the identifier is
+ unrecognised. Calling Skip is important because it allows wxWindows to
+ generate further events for ancestors of the clicked-on
+ window. Otherwise it would be impossible to show help for container
+ windows, since processing would stop after the first window found.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxHelpEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
class ContextHelp(_core.Object):
"""
- This class changes the cursor to a query and puts the application
- into a 'context-sensitive help mode'. When the user left-clicks
- on a window within the specified window, a EVT_HELP event is sent
- to that control, and the application may respond to it by popping
- up some help.
+ This class changes the cursor to a query and puts the application into
+ a 'context-sensitive help mode'. When the user left-clicks on a window
+ within the specified window, a ``EVT_HELP`` event is sent to that
+ control, and the application may respond to it by popping up some
+ help.
There are a couple of ways to invoke this behaviour implicitly:
- * Use the wx.DIALOG_EX_CONTEXTHELP extended style for a
- dialog (Windows only). This will put a question mark in the
- titlebar, and Windows will put the application into
- context-sensitive help mode automatically, with further
- programming.
+ * Use the wx.DIALOG_EX_CONTEXTHELP extended style for a dialog
+ (Windows only). This will put a question mark in the titlebar,
+ and Windows will put the application into context-sensitive help
+ mode automatically, with further programming.
+
+ * Create a `wx.ContextHelpButton`, whose predefined behaviour is
+ to create a context help object. Normally you will write your
+ application so that this button is only added to a dialog for
+ non-Windows platforms (use ``wx.DIALOG_EX_CONTEXTHELP`` on
+ Windows).
- * Create a wx.ContextHelpButton, whose predefined behaviour
- is to create a context help object. Normally you will write
- your application so that this button is only added to a
- dialog for non-Windows platforms (use
- wx.DIALOG_EX_CONTEXTHELP on Windows).
+ :see: `wx.ContextHelpButton`
"""
def __repr__(self):
"""
__init__(self, Window window=None, bool doNow=True) -> ContextHelp
- Constructs a context help object, calling BeginContextHelp if
- doNow is true (the default).
+ Constructs a context help object, calling BeginContextHelp if doNow is
+ true (the default).
If window is None, the top window is used.
"""
"""
BeginContextHelp(self, Window window=None) -> bool
- Puts the application into context-sensitive help mode. window is
- the window which will be used to catch events; if NULL, the top
- window will be used.
+ Puts the application into context-sensitive help mode. window is the
+ window which will be used to catch events; if NULL, the top window
+ will be used.
Returns true if the application was successfully put into
- context-sensitive help mode. This function only returns when the
- event loop has finished.
+ context-sensitive help mode. This function only returns when the event
+ loop has finished.
"""
return _controls_.ContextHelp_BeginContextHelp(*args, **kwargs)
class ContextHelpButton(BitmapButton):
"""
- Instances of this class may be used to add a question mark button
- that when pressed, puts the application into context-help
- mode. It does this by creating a wx.ContextHelp object which
- itself generates a EVT_HELP event when the user clicks on a
- window.
+ Instances of this class may be used to add a question mark button that
+ when pressed, puts the application into context-help mode. It does
+ this by creating a wx.ContextHelp object which itself generates a
+ ``EVT_HELP`` event when the user clicks on a window.
+
+ On Windows, you may add a question-mark icon to a dialog by use of the
+ ``wx.DIALOG_EX_CONTEXTHELP`` extra style, but on other platforms you
+ will have to add a button explicitly, usually next to OK, Cancel or
+ similar buttons.
- On Windows, you may add a question-mark icon to a dialog by use
- of the wx.DIALOG_EX_CONTEXTHELP extra style, but on other
- platforms you will have to add a button explicitly, usually next
- to OK, Cancel or similar buttons.
+ :see: `wx.ContextHelp`, `wx.ContextHelpButton`
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxHelpProvider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def Set(*args, **kwargs):
"""
- HelpProvider.Set(HelpProvider helpProvider) -> HelpProvider
+ Set(HelpProvider helpProvider) -> HelpProvider
- Sset the current, application-wide help provider. Returns the
- previous one. Unlike some other classes, the help provider is
- not created on demand. This must be explicitly done by the
- application.
+ Sset the current, application-wide help provider. Returns the previous
+ one. Unlike some other classes, the help provider is not created on
+ demand. This must be explicitly done by the application.
"""
return _controls_.HelpProvider_Set(*args, **kwargs)
Set = staticmethod(Set)
def Get(*args, **kwargs):
"""
- HelpProvider.Get() -> HelpProvider
+ Get() -> HelpProvider
Return the current application-wide help provider.
"""
"""
GetHelp(self, Window window) -> String
- Gets the help string for this window. Its interpretation is
- dependent on the help provider except that empty string always
- means that no help is associated with the window.
+ Gets the help string for this window. Its interpretation is dependent
+ on the help provider except that empty string always means that no
+ help is associated with the window.
"""
return _controls_.HelpProvider_GetHelp(*args, **kwargs)
ShowHelp(self, Window window) -> bool
Shows help for the given window. Uses GetHelp internally if
- applicable.
-
- Returns true if it was done, or false if no help was available
- for this window.
+ applicable. Returns True if it was done, or False if no help was
+ available for this window.
"""
return _controls_.HelpProvider_ShowHelp(*args, **kwargs)
AddHelpById(self, int id, String text)
This version associates the given text with all windows with this
- id. May be used to set the same help string for all Cancel
- buttons in the application, for example.
+ id. May be used to set the same help string for all Cancel buttons in
+ the application, for example.
"""
return _controls_.HelpProvider_AddHelpById(*args, **kwargs)
RemoveHelp(self, Window window)
Removes the association between the window pointer and the help
- text. This is called by the wx.Window destructor. Without this,
- the table of help strings will fill up and when window pointers
- are reused, the wrong help string will be found.
+ text. This is called by the wx.Window destructor. Without this, the
+ table of help strings will fill up and when window pointers are
+ reused, the wrong help string will be found.
"""
return _controls_.HelpProvider_RemoveHelp(*args, **kwargs)
"""
HelpProvider_Set(HelpProvider helpProvider) -> HelpProvider
- Sset the current, application-wide help provider. Returns the
- previous one. Unlike some other classes, the help provider is
- not created on demand. This must be explicitly done by the
- application.
+ Sset the current, application-wide help provider. Returns the previous
+ one. Unlike some other classes, the help provider is not created on
+ demand. This must be explicitly done by the application.
"""
return _controls_.HelpProvider_Set(*args, **kwargs)
class SimpleHelpProvider(HelpProvider):
"""
- wx.SimpleHelpProvider is an implementation of wx.HelpProvider
- which supports only plain text help strings, and shows the string
- associated with the control (if any) in a tooltip.
+ wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
+ supports only plain text help strings, and shows the string associated
+ with the control (if any) in a tooltip.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxSimpleHelpProvider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
__init__(self) -> SimpleHelpProvider
- wx.SimpleHelpProvider is an implementation of wx.HelpProvider
- which supports only plain text help strings, and shows the string
- associated with the control (if any) in a tooltip.
+ wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
+ supports only plain text help strings, and shows the string associated
+ with the control (if any) in a tooltip.
"""
newobj = _controls_.new_SimpleHelpProvider(*args, **kwargs)
self.this = newobj.this
projects / wxWidgets.git / blobdiff