X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f20a2e1f4066e4f0235698e6220f1eed91c73326..91a40e94b9efe799e401638edf84e75d3285d11b:/wxPython/src/mac/_controls.py diff --git a/wxPython/src/mac/_controls.py b/wxPython/src/mac/_controls.py index d137b533b4..063ba32b2b 100644 --- a/wxPython/src/mac/_controls.py +++ b/wxPython/src/mac/_controls.py @@ -18,37 +18,15 @@ 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,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=ButtonNameStr) -> Button + __init__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=ButtonNameStr) -> Button Create and show a button. """ @@ -60,9 +38,10 @@ class Button(_core.Control): 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=ButtonNameStr) -> bool + Create(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=ButtonNameStr) -> bool Acutally create the GUI Button for 2-phase creation. """ @@ -89,15 +68,16 @@ class Button(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs) @@ -134,15 +114,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs) @@ -152,43 +133,14 @@ class BitmapButton(Button): 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,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=BU_AUTODRAW, - Validator validator=DefaultValidator, + __init__(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=BU_AUTODRAW, Validator validator=DefaultValidator, String name=ButtonNameStr) -> BitmapButton Create and show a button with a bitmap for the label. @@ -201,9 +153,9 @@ class BitmapButton(Button): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=BU_AUTODRAW, - Validator validator=DefaultValidator, + Create(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=BU_AUTODRAW, Validator validator=DefaultValidator, String name=ButtonNameStr) -> bool Acutally create the GUI BitmapButton for 2-phase creation. @@ -320,39 +272,15 @@ class CheckBox(_core.Control): 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,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> CheckBox + __init__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=CheckBoxNameStr) -> CheckBox Creates and shows a CheckBox control """ @@ -364,9 +292,10 @@ class CheckBox(_core.Control): 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=CheckBoxNameStr) -> bool + Create(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=CheckBoxNameStr) -> bool Actually create the GUI CheckBox for 2-phase creation. """ @@ -443,15 +372,16 @@ class CheckBox(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs) @@ -479,15 +409,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs) @@ -498,13 +429,6 @@ class Choice(_core.ControlWithItems): 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,) @@ -561,15 +485,16 @@ class Choice(_core.ControlWithItems): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs) @@ -597,15 +522,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs) @@ -613,9 +539,12 @@ def 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,) @@ -623,8 +552,8 @@ class ComboBox(_core.Control,_core.ItemContainer): """ __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. """ @@ -770,15 +699,16 @@ class ComboBox(_core.Control,_core.ItemContainer): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs) @@ -806,15 +736,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs) @@ -829,7 +760,7 @@ class Gauge(_core.Control): return "<%s.%s; proxy of C++ wxGauge instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, int range, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, int range=100, Point pos=DefaultPosition, Size size=DefaultSize, long style=GA_HORIZONTAL, Validator validator=DefaultValidator, String name=GaugeNameStr) -> Gauge @@ -842,7 +773,7 @@ class Gauge(_core.Control): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, int range, Point pos=DefaultPosition, + Create(self, Window parent, int id=-1, int range=100, Point pos=DefaultPosition, Size size=DefaultSize, long style=GA_HORIZONTAL, Validator validator=DefaultValidator, String name=GaugeNameStr) -> bool @@ -889,15 +820,16 @@ class Gauge(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs) @@ -921,15 +853,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs) @@ -940,9 +873,9 @@ class StaticBox(_core.Control): return "<%s.%s; proxy of C++ wxStaticBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBoxNameStr) -> StaticBox + __init__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBoxNameStr) -> StaticBox """ newobj = _controls_.new_StaticBox(*args, **kwargs) self.this = newobj.this @@ -952,9 +885,9 @@ class StaticBox(_core.Control): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBoxNameStr) -> bool + Create(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBoxNameStr) -> bool """ return _controls_.StaticBox_Create(*args, **kwargs) @@ -962,15 +895,16 @@ class StaticBox(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs) @@ -996,15 +930,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs) @@ -1015,8 +950,8 @@ class StaticLine(_core.Control): return "<%s.%s; proxy of C++ wxStaticLine instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=LI_HORIZONTAL, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=LI_HORIZONTAL, String name=StaticTextNameStr) -> StaticLine """ newobj = _controls_.new_StaticLine(*args, **kwargs) @@ -1027,8 +962,8 @@ class StaticLine(_core.Control): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=LI_HORIZONTAL, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=LI_HORIZONTAL, String name=StaticTextNameStr) -> bool """ return _controls_.StaticLine_Create(*args, **kwargs) @@ -1046,15 +981,16 @@ class StaticLine(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs) @@ -1081,15 +1017,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs) @@ -1100,9 +1037,9 @@ class StaticText(_core.Control): return "<%s.%s; proxy of C++ wxStaticText instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticTextNameStr) -> StaticText + __init__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticTextNameStr) -> StaticText """ newobj = _controls_.new_StaticText(*args, **kwargs) self.this = newobj.this @@ -1112,9 +1049,9 @@ class StaticText(_core.Control): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticTextNameStr) -> bool + Create(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticTextNameStr) -> bool """ return _controls_.StaticText_Create(*args, **kwargs) @@ -1122,15 +1059,16 @@ class StaticText(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs) @@ -1153,15 +1091,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs) @@ -1172,9 +1111,9 @@ class StaticBitmap(_core.Control): return "<%s.%s; proxy of C++ wxStaticBitmap instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBitmapNameStr) -> StaticBitmap + __init__(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBitmapNameStr) -> StaticBitmap """ newobj = _controls_.new_StaticBitmap(*args, **kwargs) self.this = newobj.this @@ -1184,9 +1123,9 @@ class StaticBitmap(_core.Control): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBitmapNameStr) -> bool + Create(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBitmapNameStr) -> bool """ return _controls_.StaticBitmap_Create(*args, **kwargs) @@ -1206,15 +1145,16 @@ class StaticBitmap(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs) @@ -1237,15 +1177,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs) @@ -1256,8 +1197,8 @@ class ListBox(_core.ControlWithItems): return "<%s.%s; proxy of C++ wxListBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - wxArrayString choices=wxPyEmptyStringArray, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray, long style=0, Validator validator=DefaultValidator, String name=ListBoxNameStr) -> ListBox """ @@ -1269,8 +1210,8 @@ class ListBox(_core.ControlWithItems): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - wxArrayString choices=wxPyEmptyStringArray, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray, long style=0, Validator validator=DefaultValidator, String name=ListBoxNameStr) -> bool """ @@ -1280,7 +1221,7 @@ 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) @@ -1361,15 +1302,16 @@ class ListBox(_core.ControlWithItems): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs) @@ -1393,15 +1335,16 @@ def 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs) @@ -1412,8 +1355,8 @@ class CheckListBox(ListBox): return "<%s.%s; proxy of C++ wxCheckListBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - wxArrayString choices=wxPyEmptyStringArray, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray, long style=0, Validator validator=DefaultValidator, String name=ListBoxNameStr) -> CheckListBox """ @@ -1425,8 +1368,8 @@ class CheckListBox(ListBox): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - wxArrayString choices=wxPyEmptyStringArray, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray, long style=0, Validator validator=DefaultValidator, String name=ListBoxNameStr) -> bool """ @@ -1516,13 +1459,12 @@ TE_HT_BEYOND = _controls_.TE_HT_BEYOND class TextAttr(object): def __repr__(self): return "<%s.%s; proxy of C++ wxTextAttr instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args): + def __init__(self, *args, **kwargs): """ - __init__(self) -> TextAttr - __init__(self, Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, - int alignment=TEXT_ALIGNMENT_DEFAULT) -> TextAttr + __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour, + Font font=wxNullFont, int alignment=TEXT_ALIGNMENT_DEFAULT) -> TextAttr """ - newobj = _controls_.new_TextAttr(*args) + newobj = _controls_.new_TextAttr(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown @@ -1557,7 +1499,7 @@ class TextAttr(object): return _controls_.TextAttr_SetTabs(*args, **kwargs) def SetLeftIndent(*args, **kwargs): - """SetLeftIndent(self, int indent)""" + """SetLeftIndent(self, int indent, int subIndent=0)""" return _controls_.TextAttr_SetLeftIndent(*args, **kwargs) def SetRightIndent(*args, **kwargs): @@ -1624,6 +1566,10 @@ class TextAttr(object): """GetLeftIndent(self) -> long""" return _controls_.TextAttr_GetLeftIndent(*args, **kwargs) + def GetLeftSubIndent(*args, **kwargs): + """GetLeftSubIndent(self) -> long""" + return _controls_.TextAttr_GetLeftSubIndent(*args, **kwargs) + def GetRightIndent(*args, **kwargs): """GetRightIndent(self) -> long""" return _controls_.TextAttr_GetRightIndent(*args, **kwargs) @@ -1659,8 +1605,8 @@ class TextCtrl(_core.Control): return "<%s.%s; proxy of C++ wxTextCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, - Size size=DefaultSize, + __init__(self, Window parent, int id=-1, String value=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, String name=TextCtrlNameStr) -> TextCtrl """ @@ -1672,8 +1618,8 @@ class TextCtrl(_core.Control): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, - Size size=DefaultSize, + Create(self, Window parent, int id=-1, String value=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, String name=TextCtrlNameStr) -> bool """ @@ -1807,12 +1753,22 @@ class TextCtrl(_core.Control): """ 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) + Find the row, col coresponding to the character at the point given in + pixels. NB: pt is in device coords but is not adjusted for the client + area origin nor scrolling. """ return _controls_.TextCtrl_HitTest(*args, **kwargs) + def HitTestPos(*args, **kwargs): + """ + HitTestPos(Point pt) -> (result, position) + + Find the character position in the text coresponding to the point + given in pixels. NB: pt is in device coords but is not adjusted for + the client area origin nor scrolling. + """ + return _controls_.TextCtrl_HitTestPos(*args, **kwargs) + def Copy(*args, **kwargs): """Copy(self)""" return _controls_.TextCtrl_Copy(*args, **kwargs) @@ -1893,15 +1849,16 @@ class TextCtrl(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -1924,15 +1881,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -2032,18 +1990,6 @@ class ScrollBar(_core.Control): bool refresh=True) Sets the scrollbar properties of a built-in scrollbar. - - 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. - - range: The maximum position of the scrollbar. - - refresh: True to redraw the scrollbar, false otherwise. """ return _controls_.ScrollBar_SetScrollbar(*args, **kwargs) @@ -2051,15 +1997,16 @@ class ScrollBar(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs) @@ -2083,15 +2030,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs) @@ -2160,15 +2108,16 @@ class SpinButton(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2193,15 +2142,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2262,15 +2212,16 @@ class SpinCtrl(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -2293,15 +2244,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -2343,10 +2295,11 @@ class RadioBox(_core.Control): return "<%s.%s; proxy of C++ wxRadioBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray, - int majorDimension=0, - long style=RA_HORIZONTAL, Validator validator=DefaultValidator, + __init__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + wxArrayString choices=wxPyEmptyStringArray, + int majorDimension=0, long style=RA_HORIZONTAL, + Validator validator=DefaultValidator, String name=RadioBoxNameStr) -> RadioBox """ if kwargs.has_key('point'): kwargs['pos'] = kwargs['point'];del kwargs['point'] @@ -2358,10 +2311,11 @@ class RadioBox(_core.Control): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray, - int majorDimension=0, - long style=RA_HORIZONTAL, Validator validator=DefaultValidator, + Create(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + wxArrayString choices=wxPyEmptyStringArray, + int majorDimension=0, long style=RA_HORIZONTAL, + Validator validator=DefaultValidator, String name=RadioBoxNameStr) -> bool """ return _controls_.RadioBox_Create(*args, **kwargs) @@ -2424,15 +2378,16 @@ class RadioBox(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs) @@ -2457,15 +2412,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs) @@ -2476,9 +2432,10 @@ class RadioButton(_core.Control): return "<%s.%s; proxy of C++ wxRadioButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=RadioButtonNameStr) -> RadioButton + __init__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=RadioButtonNameStr) -> RadioButton """ newobj = _controls_.new_RadioButton(*args, **kwargs) self.this = newobj.this @@ -2488,9 +2445,10 @@ class RadioButton(_core.Control): 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=RadioButtonNameStr) -> bool + Create(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=RadioButtonNameStr) -> bool """ return _controls_.RadioButton_Create(*args, **kwargs) @@ -2506,15 +2464,16 @@ class RadioButton(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2537,15 +2496,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2556,9 +2516,10 @@ class Slider(_core.Control): return "<%s.%s; proxy of C++ wxSlider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, int value, int minValue, int maxValue, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=SL_HORIZONTAL, Validator validator=DefaultValidator, + __init__(self, Window parent, int id=-1, int value=0, int minValue=0, + int maxValue=100, Point pos=DefaultPosition, + Size size=DefaultSize, long style=SL_HORIZONTAL, + Validator validator=DefaultValidator, String name=SliderNameStr) -> Slider """ if kwargs.has_key('point'): kwargs['pos'] = kwargs['point'];del kwargs['point'] @@ -2570,9 +2531,10 @@ class Slider(_core.Control): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, int value, int minValue, int maxValue, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=SL_HORIZONTAL, Validator validator=DefaultValidator, + Create(self, Window parent, int id=-1, int value=0, int minValue=0, + int maxValue=100, Point pos=DefaultPosition, + Size size=DefaultSize, long style=SL_HORIZONTAL, + Validator validator=DefaultValidator, String name=SliderNameStr) -> bool """ return _controls_.Slider_Create(*args, **kwargs) @@ -2665,15 +2627,16 @@ class Slider(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs) @@ -2697,15 +2660,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs) @@ -2719,9 +2683,10 @@ class ToggleButton(_core.Control): return "<%s.%s; proxy of C++ wxToggleButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=ToggleButtonNameStr) -> ToggleButton + __init__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=ToggleButtonNameStr) -> ToggleButton """ newobj = _controls_.new_ToggleButton(*args, **kwargs) self.this = newobj.this @@ -2731,9 +2696,10 @@ class ToggleButton(_core.Control): 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 + Create(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=ToggleButtonNameStr) -> bool """ return _controls_.ToggleButton_Create(*args, **kwargs) @@ -2757,15 +2723,16 @@ class ToggleButton(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2789,15 +2756,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2890,15 +2858,16 @@ class BookCtrl(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.BookCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -2916,15 +2885,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.BookCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -2992,8 +2962,8 @@ class Notebook(BookCtrl): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=NOTEBOOK_NAME) -> bool + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=NOTEBOOK_NAME) -> bool """ return _controls_.Notebook_Create(*args, **kwargs) @@ -3013,7 +2983,8 @@ class Notebook(BookCtrl): """ HitTest(Point pt) -> (tab, where) - Returns the tab which is hit, and flags indicating where using wx.NB_HITTEST_ flags. + Returns the tab which is hit, and flags indicating where using + wx.NB_HITTEST flags. """ return _controls_.Notebook_HitTest(*args, **kwargs) @@ -3025,15 +2996,16 @@ class Notebook(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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs) @@ -3056,15 +3028,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs) @@ -3148,8 +3121,8 @@ class Listbook(BookCtrl): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=EmptyString) -> bool + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=EmptyString) -> bool """ return _controls_.Listbook_Create(*args, **kwargs) @@ -3210,11 +3183,23 @@ class BookCtrlSizer(_core.Sizer): self._setOORInfo(self) def RecalcSizes(*args, **kwargs): - """RecalcSizes(self)""" + """ + RecalcSizes(self) + + Using the sizes calculated by `CalcMin` reposition and resize all the + items managed by this sizer. You should not need to call this directly as + it is called by `Layout`. + """ return _controls_.BookCtrlSizer_RecalcSizes(*args, **kwargs) def CalcMin(*args, **kwargs): - """CalcMin(self) -> Size""" + """ + CalcMin(self) -> Size + + This method is where the sizer will do the actual calculation of its + children's minimal sizes. You should not need to call this directly as + it is called by `Layout`. + """ return _controls_.BookCtrlSizer_CalcMin(*args, **kwargs) def GetControl(*args, **kwargs): @@ -3241,11 +3226,23 @@ class NotebookSizer(_core.Sizer): self._setOORInfo(self) def RecalcSizes(*args, **kwargs): - """RecalcSizes(self)""" + """ + RecalcSizes(self) + + Using the sizes calculated by `CalcMin` reposition and resize all the + items managed by this sizer. You should not need to call this directly as + it is called by `Layout`. + """ return _controls_.NotebookSizer_RecalcSizes(*args, **kwargs) def CalcMin(*args, **kwargs): - """CalcMin(self) -> Size""" + """ + CalcMin(self) -> Size + + This method is where the sizer will do the actual calculation of its + children's minimal sizes. You should not need to call this directly as + it is called by `Layout`. + """ return _controls_.NotebookSizer_CalcMin(*args, **kwargs) def GetNotebook(*args, **kwargs): @@ -3535,6 +3532,7 @@ class ToolBarBase(_core.Control): # For consistency with the backwards compatible methods above, here are # some non-'Label' versions of the Check and Radio methods + def AddCheckTool(self, id, bitmap, bmpDisabled = wx.NullBitmap, shortHelp = '', longHelp = '', @@ -3735,8 +3733,8 @@ class ToolBar(ToolBarBase): return "<%s.%s; proxy of C++ wxToolBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxNO_BORDER|wxTB_HORIZONTAL, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL, String name=wxPyToolBarNameStr) -> ToolBar """ newobj = _controls_.new_ToolBar(*args, **kwargs) @@ -3747,8 +3745,8 @@ class ToolBar(ToolBarBase): def Create(*args, **kwargs): """ - Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxNO_BORDER|wxTB_HORIZONTAL, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL, String name=wxPyToolBarNameStr) -> bool """ return _controls_.ToolBar_Create(*args, **kwargs) @@ -3761,15 +3759,16 @@ class ToolBar(ToolBarBase): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs) @@ -3792,15 +3791,16 @@ 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. + 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs) @@ -4375,10 +4375,10 @@ class ListCtrl(_core.Control): """ 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) @@ -4462,8 +4462,8 @@ class ListCtrl(_core.Control): """ 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.) + Determines which item (if any) is at the specified point, giving + in the second return value (see wxLIST_HITTEST_... flags.) """ return _controls_.ListCtrl_HitTest(*args, **kwargs) @@ -4589,15 +4589,16 @@ class ListCtrl(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -4620,15 +4621,16 @@ def 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -5255,10 +5257,9 @@ class TreeCtrl(_core.Control): """ 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. + 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. """ return _controls_.TreeCtrl_HitTest(*args, **kwargs) @@ -5271,15 +5272,16 @@ class TreeCtrl(_core.Control): """ 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -5302,15 +5304,16 @@ def 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 + user's 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 `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -5412,9 +5415,10 @@ class GenericDirCtrl(_core.Control): """ 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 + 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. """ return _controls_.GenericDirCtrl_FindChild(*args, **kwargs) @@ -5488,8 +5492,8 @@ class PyControl(_core.Control): return "<%s.%s; proxy of C++ wxPyControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, String name=ControlNameStr) -> PyControl """ newobj = _controls_.new_PyControl(*args, **kwargs) @@ -5502,6 +5506,10 @@ class PyControl(_core.Control): """_setCallbackInfo(self, PyObject self, PyObject _class)""" return _controls_.PyControl__setCallbackInfo(*args, **kwargs) + def SetBestSize(*args, **kwargs): + """SetBestSize(self, Size size)""" + return _controls_.PyControl_SetBestSize(*args, **kwargs) + def base_DoMoveWindow(*args, **kwargs): """base_DoMoveWindow(self, int x, int y, int width, int height)""" return _controls_.PyControl_base_DoMoveWindow(*args, **kwargs) @@ -5582,6 +5590,10 @@ class PyControl(_core.Control): """base_ApplyParentThemeBackground(self, Colour c)""" return _controls_.PyControl_base_ApplyParentThemeBackground(*args, **kwargs) + def base_GetDefaultAttributes(*args, **kwargs): + """base_GetDefaultAttributes(self) -> VisualAttributes""" + return _controls_.PyControl_base_GetDefaultAttributes(*args, **kwargs) + class PyControlPtr(PyControl): def __init__(self, this): @@ -5609,29 +5621,21 @@ EVT_DETAILED_HELP_RANGE = wx.PyEventBinder( wxEVT_DETAILED_HELP, 2) 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,) @@ -5701,25 +5705,26 @@ _controls_.HelpEvent_swigregister(HelpEventPtr) 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): @@ -5728,8 +5733,8 @@ class ContextHelp(_core.Object): """ __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. """ @@ -5747,13 +5752,13 @@ class ContextHelp(_core.Object): """ 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) @@ -5776,16 +5781,17 @@ _controls_.ContextHelp_swigregister(ContextHelpPtr) 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): @@ -5827,10 +5833,9 @@ class HelpProvider(object): """ 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) @@ -5848,9 +5853,9 @@ class HelpProvider(object): """ 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) @@ -5859,10 +5864,8 @@ class HelpProvider(object): 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) @@ -5879,8 +5882,8 @@ class HelpProvider(object): 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) @@ -5889,9 +5892,9 @@ class HelpProvider(object): 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) @@ -5911,10 +5914,9 @@ def HelpProvider_Set(*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) @@ -5928,9 +5930,9 @@ def HelpProvider_Get(*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,) @@ -5938,9 +5940,9 @@ class SimpleHelpProvider(HelpProvider): """ __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