X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/908b74cdd65b7008c87809882a48a95e5851f249..d90a959f09c38c170a2c0035d99259234f7ff9b1:/wxPython/src/msw/_controls.py?ds=sidebyside diff --git a/wxPython/src/msw/_controls.py b/wxPython/src/msw/_controls.py index e79a33ba65..28a09bfedb 100644 --- a/wxPython/src/msw/_controls.py +++ b/wxPython/src/msw/_controls.py @@ -65,20 +65,7 @@ class Button(_core.Control): GetDefaultSize = staticmethod(GetDefaultSize) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -111,20 +98,7 @@ def Button_GetDefaultSize(*args, **kwargs): return _controls_.Button_GetDefaultSize(*args, **kwargs) def Button_GetClassDefaultAttributes(*args, **kwargs): - """ - Button_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """Button_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs) class BitmapButton(Button): @@ -369,20 +343,7 @@ class CheckBox(_core.Control): return _controls_.CheckBox_Is3rdStateAllowedForUser(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -406,20 +367,7 @@ def PreCheckBox(*args, **kwargs): return val def CheckBox_GetClassDefaultAttributes(*args, **kwargs): - """ - CheckBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """CheckBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -451,6 +399,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) @@ -480,20 +430,7 @@ class Choice(_core.ControlWithItems): Select = SetSelection def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -517,20 +454,7 @@ def PreChoice(*args, **kwargs): return val def Choice_GetClassDefaultAttributes(*args, **kwargs): - """ - Choice_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """Choice_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -567,6 +491,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) @@ -692,20 +618,7 @@ class ComboBox(Choice): return _controls_.ComboBox_Remove(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -729,20 +642,7 @@ def PreComboBox(*args, **kwargs): return val def ComboBox_GetClassDefaultAttributes(*args, **kwargs): - """ - ComboBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """ComboBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -813,20 +713,7 @@ class Gauge(_core.Control): return _controls_.Gauge_GetBezelFace(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -846,20 +733,7 @@ def PreGauge(*args, **kwargs): return val def Gauge_GetClassDefaultAttributes(*args, **kwargs): - """ - Gauge_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """Gauge_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -888,20 +762,7 @@ class StaticBox(_core.Control): return _controls_.StaticBox_Create(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -923,20 +784,7 @@ def PreStaticBox(*args, **kwargs): return val def StaticBox_GetClassDefaultAttributes(*args, **kwargs): - """ - StaticBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """StaticBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -974,20 +822,7 @@ class StaticLine(_core.Control): GetDefaultSize = staticmethod(GetDefaultSize) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -1010,20 +845,7 @@ def StaticLine_GetDefaultSize(*args, **kwargs): return _controls_.StaticLine_GetDefaultSize(*args, **kwargs) def StaticLine_GetClassDefaultAttributes(*args, **kwargs): - """ - StaticLine_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """StaticLine_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -1052,20 +874,7 @@ class StaticText(_core.Control): return _controls_.StaticText_Create(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -1084,20 +893,7 @@ def PreStaticText(*args, **kwargs): return val def StaticText_GetClassDefaultAttributes(*args, **kwargs): - """ - StaticText_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """StaticText_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -1138,20 +934,7 @@ class StaticBitmap(_core.Control): return _controls_.StaticBitmap_SetIcon(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -1170,20 +953,7 @@ def PreStaticBitmap(*args, **kwargs): return val def StaticBitmap_GetClassDefaultAttributes(*args, **kwargs): - """ - StaticBitmap_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """StaticBitmap_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -1295,20 +1065,7 @@ class ListBox(_core.ControlWithItems): return _controls_.ListBox_SetItemFont(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -1328,20 +1085,7 @@ def PreListBox(*args, **kwargs): return val 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 - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """ListBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -1666,7 +1410,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): @@ -1746,7 +1494,12 @@ 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 character at position 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 Copy(*args, **kwargs): @@ -1834,20 +1587,7 @@ class TextCtrl(_core.Control): return _controls_.TextCtrl_GetString(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -1866,20 +1606,7 @@ def PreTextCtrl(*args, **kwargs): return val def TextCtrl_GetClassDefaultAttributes(*args, **kwargs): - """ - TextCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """TextCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs) wxEVT_COMMAND_TEXT_UPDATED = _controls_.wxEVT_COMMAND_TEXT_UPDATED @@ -1982,20 +1709,7 @@ class ScrollBar(_core.Control): return _controls_.ScrollBar_SetScrollbar(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -2015,20 +1729,7 @@ def PreScrollBar(*args, **kwargs): return val def ScrollBar_GetClassDefaultAttributes(*args, **kwargs): - """ - ScrollBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """ScrollBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -2093,20 +1794,7 @@ class SpinButton(_core.Control): return _controls_.SpinButton_IsVertical(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -2127,20 +1815,7 @@ def PreSpinButton(*args, **kwargs): return val def SpinButton_GetClassDefaultAttributes(*args, **kwargs): - """ - SpinButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """SpinButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs) class SpinCtrl(_core.Control): @@ -2197,20 +1872,7 @@ class SpinCtrl(_core.Control): return _controls_.SpinCtrl_SetSelection(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -2229,20 +1891,7 @@ def PreSpinCtrl(*args, **kwargs): return val def SpinCtrl_GetClassDefaultAttributes(*args, **kwargs): - """ - SpinCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """SpinCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs) class SpinEvent(_core.NotifyEvent): @@ -2363,20 +2012,7 @@ class RadioBox(_core.Control): return _controls_.RadioBox_GetNextItem(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -2397,20 +2033,7 @@ def PreRadioBox(*args, **kwargs): return val def RadioBox_GetClassDefaultAttributes(*args, **kwargs): - """ - RadioBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """RadioBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -2449,20 +2072,7 @@ class RadioButton(_core.Control): return _controls_.RadioButton_SetValue(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -2481,20 +2091,7 @@ def PreRadioButton(*args, **kwargs): return val def RadioButton_GetClassDefaultAttributes(*args, **kwargs): - """ - RadioButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """RadioButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -2612,20 +2209,7 @@ class Slider(_core.Control): return _controls_.Slider_SetSelection(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -2645,20 +2229,7 @@ def PreSlider(*args, **kwargs): return val def Slider_GetClassDefaultAttributes(*args, **kwargs): - """ - Slider_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """Slider_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -2708,20 +2279,7 @@ class ToggleButton(_core.Control): return _controls_.ToggleButton_SetLabel(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -2741,20 +2299,7 @@ def PreToggleButton(*args, **kwargs): return val def ToggleButton_GetClassDefaultAttributes(*args, **kwargs): - """ - ToggleButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """ToggleButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -2843,20 +2388,7 @@ class BookCtrl(_core.Control): return _controls_.BookCtrl_AdvanceSelection(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.BookCtrl_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -2870,20 +2402,7 @@ _controls_.BookCtrl_swigregister(BookCtrlPtr) NOTEBOOK_NAME = cvar.NOTEBOOK_NAME def BookCtrl_GetClassDefaultAttributes(*args, **kwargs): - """ - BookCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """BookCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.BookCtrl_GetClassDefaultAttributes(*args, **kwargs) class BookCtrlEvent(_core.NotifyEvent): @@ -2968,7 +2487,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): @@ -2980,20 +2504,7 @@ class Notebook(BookCtrl): return _controls_.Notebook_ApplyThemeBackground(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -3012,20 +2523,7 @@ def PreNotebook(*args, **kwargs): return val def Notebook_GetClassDefaultAttributes(*args, **kwargs): - """ - Notebook_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """Notebook_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs) class NotebookEvent(BookCtrlEvent): @@ -3743,20 +3241,7 @@ class ToolBar(ToolBarBase): return _controls_.ToolBar_FindToolForPosition(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -3775,20 +3260,7 @@ def PreToolBar(*args, **kwargs): return val def ToolBar_GetClassDefaultAttributes(*args, **kwargs): - """ - ToolBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """ToolBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -4450,7 +3922,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): @@ -4572,20 +4049,7 @@ class ListCtrl(_core.Control): return _controls_.ListCtrl_GetMainWindow(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -4604,20 +4068,7 @@ def PreListCtrl(*args, **kwargs): return val 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 - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """ListCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -5248,7 +4699,14 @@ 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): @@ -5256,20 +4714,7 @@ class TreeCtrl(_core.Control): return _controls_.TreeCtrl_GetBoundingRect(*args, **kwargs) def GetClassDefaultAttributes(*args, **kwargs): - """ - GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes - - Get the default attributes for this class. This is useful if you want - to use the same font or colour in your own control as in a standard - control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) @@ -5288,20 +4733,7 @@ def PreTreeCtrl(*args, **kwargs): return val 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 - 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 `wx.Window.SetWindowVariant` for more about - this. - """ + """TreeCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes""" return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs) #--------------------------------------------------------------------------- @@ -5399,7 +4831,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):