X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/79fccf9d17b16573d824b79957e6d69dd59c3bf1..6028be3f39babc4530472a4139576fe318c6aa90:/wxPython/src/msw/_controls.py diff --git a/wxPython/src/msw/_controls.py b/wxPython/src/msw/_controls.py index 0c48cd251d..7aed3d7d7b 100644 --- a/wxPython/src/msw/_controls.py +++ b/wxPython/src/msw/_controls.py @@ -23,11 +23,16 @@ class Button(_core.Control): 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. + Create and show a button. The preferred way to create standard + buttons is to use a standard ID and an empty label. In this case + wxWigets will automatically use a stock label that coresponds to the + ID given. In additon, the button will be decorated with stock icons + under GTK+ 2. """ newobj = _controls_.new_Button(*args, **kwargs) self.this = newobj.this @@ -37,9 +42,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. """ @@ -69,12 +75,13 @@ class Button(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs) @@ -114,12 +121,13 @@ def Button_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs) @@ -134,9 +142,9 @@ class BitmapButton(Button): 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. @@ -149,9 +157,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. @@ -273,9 +281,10 @@ class CheckBox(_core.Control): 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 """ @@ -287,9 +296,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. """ @@ -369,12 +379,13 @@ class CheckBox(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs) @@ -405,12 +416,13 @@ def CheckBox_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs) @@ -443,6 +455,8 @@ class Choice(_core.ControlWithItems): Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, List choices=[], long style=0, Validator validator=DefaultValidator, String name=ChoiceNameStr) -> bool + + Actually create the GUI Choice control for 2-phase creation """ return _controls_.Choice_Create(*args, **kwargs) @@ -478,12 +492,13 @@ class Choice(_core.ControlWithItems): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs) @@ -514,12 +529,13 @@ def Choice_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs) @@ -557,6 +573,8 @@ class ComboBox(Choice): Point pos=DefaultPosition, Size size=DefaultSize, List choices=[], long style=0, Validator validator=DefaultValidator, String name=ChoiceNameStr) -> bool + + Actually create the GUI wxComboBox control for 2-phase creation """ return _controls_.ComboBox_Create(*args, **kwargs) @@ -688,12 +706,13 @@ class ComboBox(Choice): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs) @@ -724,12 +743,13 @@ def ComboBox_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs) @@ -744,7 +764,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 @@ -757,7 +777,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 @@ -807,12 +827,13 @@ class Gauge(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs) @@ -839,12 +860,13 @@ def Gauge_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs) @@ -855,9 +877,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 @@ -867,9 +889,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) @@ -880,12 +902,13 @@ class StaticBox(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs) @@ -914,12 +937,13 @@ def StaticBox_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs) @@ -930,8 +954,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) @@ -942,8 +966,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) @@ -964,12 +988,13 @@ class StaticLine(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs) @@ -999,12 +1024,13 @@ def StaticLine_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs) @@ -1015,9 +1041,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 @@ -1027,9 +1053,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) @@ -1040,12 +1066,13 @@ class StaticText(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs) @@ -1071,12 +1098,13 @@ def StaticText_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs) @@ -1087,9 +1115,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 @@ -1099,9 +1127,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) @@ -1124,12 +1152,13 @@ class StaticBitmap(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs) @@ -1155,12 +1184,13 @@ def StaticBitmap_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs) @@ -1171,8 +1201,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 """ @@ -1184,8 +1214,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 """ @@ -1279,12 +1309,13 @@ class ListBox(_core.ControlWithItems): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs) @@ -1311,12 +1342,13 @@ def ListBox_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs) @@ -1327,8 +1359,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 """ @@ -1340,8 +1372,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 """ @@ -1435,13 +1467,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 @@ -1476,7 +1507,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): @@ -1543,6 +1574,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) @@ -1578,8 +1613,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 """ @@ -1591,8 +1626,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 """ @@ -1639,7 +1674,11 @@ class TextCtrl(_core.Control): return _controls_.TextCtrl_IsMultiLine(*args, **kwargs) def GetSelection(*args, **kwargs): - """GetSelection() -> (from, to)""" + """ + GetSelection() -> (from, to) + + If the return values from and to are the same, there is no selection. + """ return _controls_.TextCtrl_GetSelection(*args, **kwargs) def GetStringSelection(*args, **kwargs): @@ -1719,9 +1758,25 @@ class TextCtrl(_core.Control): return _controls_.TextCtrl_ShowPosition(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point pt) -> (result, row, col)""" + """ + HitTest(Point pt) -> (result, row, col) + + 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) @@ -1813,12 +1868,13 @@ class TextCtrl(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -1844,12 +1900,13 @@ def TextCtrl_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -1959,12 +2016,13 @@ class ScrollBar(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs) @@ -1991,12 +2049,13 @@ def ScrollBar_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs) @@ -2068,12 +2127,13 @@ class SpinButton(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2101,12 +2161,13 @@ def SpinButton_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2170,12 +2231,13 @@ class SpinCtrl(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -2201,12 +2263,13 @@ def SpinCtrl_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -2248,10 +2311,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'] @@ -2263,10 +2327,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) @@ -2332,12 +2397,13 @@ class RadioBox(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs) @@ -2365,12 +2431,13 @@ def RadioBox_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs) @@ -2381,9 +2448,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 @@ -2393,9 +2461,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) @@ -2414,12 +2483,13 @@ class RadioButton(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2445,12 +2515,13 @@ def RadioButton_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2461,9 +2532,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'] @@ -2475,9 +2547,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) @@ -2573,12 +2646,13 @@ class Slider(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs) @@ -2605,12 +2679,13 @@ def Slider_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs) @@ -2624,9 +2699,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 @@ -2636,9 +2712,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) @@ -2665,12 +2742,13 @@ class ToggleButton(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2697,12 +2775,13 @@ def ToggleButton_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs) @@ -2798,12 +2877,13 @@ class BookCtrl(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.BookCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -2824,12 +2904,13 @@ def BookCtrl_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.BookCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -2897,8 +2978,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) @@ -2915,7 +2996,12 @@ class Notebook(BookCtrl): return _controls_.Notebook_SetTabSize(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point pt) -> (tab, where)""" + """ + HitTest(Point pt) -> (tab, where) + + Returns the tab which is hit, and flags indicating where using + wx.NB_HITTEST flags. + """ return _controls_.Notebook_HitTest(*args, **kwargs) def CalcSizeFromPage(*args, **kwargs): @@ -2933,12 +3019,13 @@ class Notebook(BookCtrl): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs) @@ -2964,12 +3051,13 @@ def Notebook_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs) @@ -3053,8 +3141,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) @@ -3062,6 +3150,10 @@ class Listbook(BookCtrl): """IsVertical(self) -> bool""" return _controls_.Listbook_IsVertical(*args, **kwargs) + def GetListView(*args, **kwargs): + """GetListView(self) -> ListView""" + return _controls_.Listbook_GetListView(*args, **kwargs) + class ListbookPtr(Listbook): def __init__(self, this): @@ -3115,11 +3207,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): @@ -3146,11 +3250,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): @@ -3440,6 +3556,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 = '', @@ -3640,8 +3757,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) @@ -3652,8 +3769,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) @@ -3669,12 +3786,13 @@ class ToolBar(ToolBarBase): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs) @@ -3700,12 +3818,13 @@ def ToolBar_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs) @@ -4368,7 +4487,12 @@ class ListCtrl(_core.Control): return _controls_.ListCtrl_FindItemAtPos(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point point) -> (item, where)""" + """ + HitTest(Point point) -> (item, where) + + 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) def InsertItem(*args, **kwargs): @@ -4496,12 +4620,13 @@ class ListCtrl(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -4527,12 +4652,13 @@ def ListCtrl_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -5164,13 +5290,28 @@ class TreeCtrl(_core.Control): return _controls_.TreeCtrl_SortChildren(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point point) -> (item, where)""" + """ + 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. + + """ return _controls_.TreeCtrl_HitTest(*args, **kwargs) def GetBoundingRect(*args, **kwargs): """GetBoundingRect(self, TreeItemId item, bool textOnly=False) -> PyObject""" return _controls_.TreeCtrl_GetBoundingRect(*args, **kwargs) + def SetState(*args, **kwargs): + """SetState(self, TreeItemId node, int state)""" + return _controls_.TreeCtrl_SetState(*args, **kwargs) + + def GetState(*args, **kwargs): + """GetState(self, TreeItemId node) -> int""" + return _controls_.TreeCtrl_GetState(*args, **kwargs) + def GetClassDefaultAttributes(*args, **kwargs): """ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes @@ -5178,12 +5319,13 @@ class TreeCtrl(_core.Control): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -5209,12 +5351,13 @@ def TreeCtrl_GetClassDefaultAttributes(*args, **kwargs): 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. + 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. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs) @@ -5313,7 +5456,15 @@ class GenericDirCtrl(_core.Control): return _controls_.GenericDirCtrl_GetFilterListCtrl(*args, **kwargs) def FindChild(*args, **kwargs): - """FindChild(wxTreeItemId parentId, wxString path) -> (item, done)""" + """ + 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. + + """ return _controls_.GenericDirCtrl_FindChild(*args, **kwargs) def DoResize(*args, **kwargs): @@ -5385,8 +5536,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) @@ -5399,6 +5550,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) @@ -5479,6 +5634,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):