X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/54f9ee450905e98296e6afd1376b3d1e06a1e00f..165e6ca32aa83302b31a20bdce2ff9d3b9710192:/wxPython/src/gtk/_controls.py diff --git a/wxPython/src/gtk/_controls.py b/wxPython/src/gtk/_controls.py index 4c9ef52811..8d9f184b8a 100644 --- a/wxPython/src/gtk/_controls.py +++ b/wxPython/src/gtk/_controls.py @@ -5,7 +5,6 @@ import _controls_ import _core wx = _core -__docfilter__ = wx.__docfilter__ #--------------------------------------------------------------------------- BU_LEFT = _controls_.BU_LEFT @@ -19,6 +18,29 @@ class Button(_core.Control): A button is a control that contains a text string, and is one of the most common elements of a GUI. It may be placed on a dialog box or panel, or indeed almost any other window. + + Window Styles + ------------- + ============== ========================================== + wx.BU_LEFT Left-justifies the label. WIN32 only. + wx.BU_TOP Aligns the label to the top of the button. + WIN32 only. + wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only. + wx.BU_BOTTOM Aligns the label to the bottom of the button. + WIN32 only. + wx.BU_EXACTFIT Creates the button as small as possible + instead of making it of the standard size + (which is the default behaviour.) + ============== ========================================== + + Events + ------ + ============ ========================================== + EVT_BUTTON Sent when the button is clicked. + ============ ========================================== + + :see: `wx.BitmapButton` + """ def __repr__(self): return "<%s.%s; proxy of C++ wxButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) @@ -55,10 +77,31 @@ class Button(_core.Control): 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): @@ -80,16 +123,64 @@ def PreButton(*args, **kwargs): 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. + Window Styles + ------------- + ============== ============================================= + wx.BU_AUTODRAW If this is specified, the button will be drawn + automatically using the label bitmap only, + providing a 3D-look border. If this style is + not specified, the button will be drawn + without borders and using all provided + bitmaps. WIN32 only. + wx.BU_LEFT Left-justifies the label. WIN32 only. + wx.BU_TOP Aligns the label to the top of the button. WIN32 + only. + wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only. + wx.BU_BOTTOM Aligns the label to the bottom of the + button. WIN32 only. + wx.BU_EXACTFIT Creates the button as small as possible + instead of making it of the standard size + (which is the default behaviour.) + ============== ============================================= + + Events + ------ + =========== ================================== + EVT_BUTTON Sent when the button is clicked. + =========== ================================== + + :see: `wx.Button`, `wx.Bitmap` + """ def __repr__(self): return "<%s.%s; proxy of C++ wxBitmapButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) @@ -224,10 +315,36 @@ CHK_CHECKED = _controls_.CHK_CHECKED 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. + + Window Styles + ------------- + ================================= =============================== + wx.CHK_2STATE Create a 2-state checkbox. + This is the default. + wx.CHK_3STATE Create a 3-state checkbox. + wx.CHK_ALLOW_3RD_STATE_FOR_USER By default a user can't set a + 3-state checkbox to the + third state. It can only be + done from code. Using this + flags allows the user to set + the checkbox to the third + state by clicking. + wx.ALIGN_RIGHT Makes the + text appear on the left of + the checkbox. + ================================= =============================== + + Events + ------ + =============================== =============================== + EVT_CHECKBOX Sent when checkbox is clicked. + =============================== =============================== + """ def __repr__(self): return "<%s.%s; proxy of C++ wxCheckBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) @@ -268,7 +385,8 @@ class CheckBox(_core.Control): """ 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) @@ -276,8 +394,8 @@ class CheckBox(_core.Control): """ 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) @@ -285,9 +403,10 @@ class CheckBox(_core.Control): """ 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) @@ -295,11 +414,11 @@ class CheckBox(_core.Control): """ 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) @@ -315,10 +434,28 @@ class CheckBox(_core.Control): """ 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): @@ -338,12 +475,36 @@ def PreCheckBox(*args, **kwargs): 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. + + Events + ------ + ================ ========================================== + EVT_CHOICE Sent when an item in the list is selected. + ================ ========================================== + """ def __repr__(self): return "<%s.%s; proxy of C++ wxChoice instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) @@ -381,7 +542,7 @@ class Choice(_core.ControlWithItems): def SetStringSelection(*args, **kwargs): """ - SetStringSelection(self, String string) + SetStringSelection(self, String string) -> bool Select the item with the specifed string """ @@ -396,6 +557,23 @@ class Choice(_core.ControlWithItems): 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): @@ -415,6 +593,22 @@ def PreChoice(*args, **kwargs): 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): @@ -524,14 +718,34 @@ class ComboBox(_core.Control,_core.ItemContainer): """ 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) @@ -552,6 +766,23 @@ class ComboBox(_core.Control,_core.ItemContainer): """ 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): @@ -571,6 +802,22 @@ def PreComboBox(*args, **kwargs): 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 @@ -638,6 +885,23 @@ class Gauge(_core.Control): """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): @@ -653,6 +917,22 @@ def PreGauge(*args, **kwargs): 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): @@ -678,6 +958,23 @@ 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): @@ -695,6 +992,22 @@ def PreStaticBox(*args, **kwargs): 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): @@ -725,10 +1038,27 @@ 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): @@ -747,6 +1077,22 @@ def StaticLine_GetDefaultSize(*args, **kwargs): """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): @@ -772,6 +1118,23 @@ 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): @@ -786,6 +1149,22 @@ def PreStaticText(*args, **kwargs): 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): @@ -823,6 +1202,23 @@ 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): @@ -837,6 +1233,22 @@ def PreStaticBitmap(*args, **kwargs): 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): @@ -947,7 +1359,7 @@ class ListBox(_core.ControlWithItems): 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 @@ -1229,7 +1641,7 @@ class TextAttr(object): 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) @@ -1481,6 +1893,23 @@ class TextCtrl(_core.Control): """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): @@ -1495,6 +1924,22 @@ def PreTextCtrl(*args, **kwargs): 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 @@ -1606,6 +2051,23 @@ class ScrollBar(_core.Control): """ return _controls_.ScrollBar_SetScrollbar(*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_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs) + + GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) class ScrollBarPtr(ScrollBar): def __init__(self, this): @@ -1621,6 +2083,22 @@ def PreScrollBar(*args, **kwargs): 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 @@ -1682,6 +2160,23 @@ class SpinButton(_core.Control): """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): @@ -1698,6 +2193,22 @@ def PreSpinButton(*args, **kwargs): 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,) @@ -1751,6 +2262,23 @@ class SpinCtrl(_core.Control): """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): @@ -1765,6 +2293,22 @@ def PreSpinCtrl(*args, **kwargs): 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,) @@ -1880,6 +2424,23 @@ class RadioBox(_core.Control): """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): @@ -1896,6 +2457,22 @@ def PreRadioBox(*args, **kwargs): 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): @@ -1929,6 +2506,23 @@ 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): @@ -1943,6 +2537,22 @@ def PreRadioButton(*args, **kwargs): 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): @@ -2055,6 +2665,23 @@ 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): @@ -2070,6 +2697,22 @@ def PreSlider(*args, **kwargs): 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 @@ -2114,6 +2757,23 @@ class ToggleButton(_core.Control): """ 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): @@ -2129,6 +2789,22 @@ def PreToggleButton(*args, **kwargs): 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): @@ -2214,6 +2890,23 @@ 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): @@ -2223,6 +2916,22 @@ class BookCtrlPtr(BookCtrl): _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,) @@ -2316,6 +3025,23 @@ class Notebook(BookCtrl): """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): @@ -2330,6 +3056,22 @@ def PreNotebook(*args, **kwargs): 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,) @@ -3019,6 +3761,23 @@ class ToolBar(ToolBarBase): """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): @@ -3033,6 +3792,22 @@ def PreToolBar(*args, **kwargs): 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 @@ -3816,7 +4591,7 @@ class ListCtrl(_core.Control): 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 @@ -4498,7 +5273,7 @@ class TreeCtrl(_core.Control): 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 @@ -5054,7 +5829,7 @@ class HelpProvider(object): 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 @@ -5066,7 +5841,7 @@ class HelpProvider(object): Set = staticmethod(Set) def Get(*args, **kwargs): """ - HelpProvider.Get() -> HelpProvider + Get() -> HelpProvider Return the current application-wide help provider. """