A button is a control that contains a text string, and is one of the most
common elements of a GUI. It may be placed on a dialog box or panel, or
indeed almost any other window.
-
- Window Styles
- -------------
- ============== ==========================================
- wx.BU_LEFT Left-justifies the label. WIN32 only.
- wx.BU_TOP Aligns the label to the top of the button.
- WIN32 only.
- wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only.
- wx.BU_BOTTOM Aligns the label to the bottom of the button.
- WIN32 only.
- wx.BU_EXACTFIT Creates the button as small as possible
- instead of making it of the standard size
- (which is the default behaviour.)
- ============== ==========================================
-
- Events
- ------
- ============ ==========================================
- EVT_BUTTON Sent when the button is clicked.
- ============ ==========================================
-
- :see: `wx.BitmapButton`
-
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
"""
- __init__(self, Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- Validator validator=DefaultValidator, String name=ButtonNameStr) -> Button
+ __init__(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, Validator validator=DefaultValidator,
+ String name=ButtonNameStr) -> Button
Create and show a button.
"""
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.
"""
GetDefaultSize = staticmethod(GetDefaultSize)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return _controls_.Button_GetDefaultSize(*args, **kwargs)
def Button_GetClassDefaultAttributes(*args, **kwargs):
- """
- Button_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """Button_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.Button_GetClassDefaultAttributes(*args, **kwargs)
class BitmapButton(Button):
single bitmap, and wxWidgets will draw all button states using this bitmap. If
the application needs more control, additional bitmaps for the selected state,
unpressed focused state, and greyed-out state may be supplied.
-
- Window Styles
- -------------
- ============== =============================================
- wx.BU_AUTODRAW If this is specified, the button will be drawn
- automatically using the label bitmap only,
- providing a 3D-look border. If this style is
- not specified, the button will be drawn
- without borders and using all provided
- bitmaps. WIN32 only.
- wx.BU_LEFT Left-justifies the label. WIN32 only.
- wx.BU_TOP Aligns the label to the top of the button. WIN32
- only.
- wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only.
- wx.BU_BOTTOM Aligns the label to the bottom of the
- button. WIN32 only.
- wx.BU_EXACTFIT Creates the button as small as possible
- instead of making it of the standard size
- (which is the default behaviour.)
- ============== =============================================
-
- Events
- ------
- =========== ==================================
- EVT_BUTTON Sent when the button is clicked.
- =========== ==================================
-
- :see: `wx.Button`, `wx.Bitmap`
-
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxBitmapButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
"""
- __init__(self, Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=BU_AUTODRAW,
- Validator validator=DefaultValidator,
+ __init__(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=BU_AUTODRAW, Validator validator=DefaultValidator,
String name=ButtonNameStr) -> BitmapButton
Create and show a button with a bitmap for the label.
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.
wx.CHK_3STATE style flag is set) it can have a third state, called the
mixed or undetermined state. Often this is used as a "Does Not
Apply" state.
-
- Window Styles
- -------------
- ================================= ===============================
- wx.CHK_2STATE Create a 2-state checkbox.
- This is the default.
- wx.CHK_3STATE Create a 3-state checkbox.
- wx.CHK_ALLOW_3RD_STATE_FOR_USER By default a user can't set a
- 3-state checkbox to the
- third state. It can only be
- done from code. Using this
- flags allows the user to set
- the checkbox to the third
- state by clicking.
- wx.ALIGN_RIGHT Makes the
- text appear on the left of
- the checkbox.
- ================================= ===============================
-
- Events
- ------
- =============================== ===============================
- EVT_CHECKBOX Sent when checkbox is clicked.
- =============================== ===============================
-
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxCheckBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
"""
- __init__(self, Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> CheckBox
+ __init__(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, Validator validator=DefaultValidator,
+ String name=CheckBoxNameStr) -> CheckBox
Creates and shows a CheckBox control
"""
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.
"""
return _controls_.CheckBox_Is3rdStateAllowedForUser(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def CheckBox_GetClassDefaultAttributes(*args, **kwargs):
- """
- CheckBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """CheckBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.CheckBox_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
A Choice control is used to select one of a list of strings.
Unlike a `wx.ListBox`, only the selection is visible until the
user pulls down the menu of choices.
-
- Events
- ------
- ================ ==========================================
- EVT_CHOICE Sent when an item in the list is selected.
- ================ ==========================================
-
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxChoice instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
Select = SetSelection
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def Choice_GetClassDefaultAttributes(*args, **kwargs):
- """
- Choice_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """Choice_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.Choice_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
class ComboBox(Choice):
"""
- A combobox is like a combination of an edit control and a listbox. It can be
- displayed as static list with editable or read-only text field; or a drop-down
- list with text field.
+ A combobox is like a combination of an edit control and a
+ listbox. It can be displayed as static list with editable or
+ read-only text field; or a drop-down list with text field.
+
+ A combobox permits a single selection only. Combobox items are
+ numbered from zero.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxComboBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
__init__(Window parent, int id, String value=EmptyString,
Point pos=DefaultPosition, Size size=DefaultSize,
- List choices=[], long style=0, Validator validator=DefaultValidator,
- String name=ComboBoxNameStr) -> ComboBox
+ List choices=[], long style=0, Validator validator=DefaultValidator,
+ String name=ComboBoxNameStr) -> ComboBox
Constructor, creates and shows a ComboBox control.
"""
return _controls_.ComboBox_Remove(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def ComboBox_GetClassDefaultAttributes(*args, **kwargs):
- """
- ComboBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """ComboBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ComboBox_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
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
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
return _controls_.Gauge_GetBezelFace(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def Gauge_GetClassDefaultAttributes(*args, **kwargs):
- """
- Gauge_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """Gauge_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.Gauge_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
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
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)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def StaticBox_GetClassDefaultAttributes(*args, **kwargs):
- """
- StaticBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """StaticBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.StaticBox_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
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)
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)
GetDefaultSize = staticmethod(GetDefaultSize)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return _controls_.StaticLine_GetDefaultSize(*args, **kwargs)
def StaticLine_GetClassDefaultAttributes(*args, **kwargs):
- """
- StaticLine_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """StaticLine_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.StaticLine_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
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
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)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def StaticText_GetClassDefaultAttributes(*args, **kwargs):
- """
- StaticText_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """StaticText_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.StaticText_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
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
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)
return _controls_.StaticBitmap_SetIcon(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def StaticBitmap_GetClassDefaultAttributes(*args, **kwargs):
- """
- StaticBitmap_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """StaticBitmap_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.StaticBitmap_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
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
"""
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
"""
"""
Insert(self, String item, int pos, PyObject clientData=None)
- Insert an item into the control before the item at the pos index,
+ Insert an item into the control before the item at the ``pos`` index,
optionally associating some data object with the item.
"""
return _controls_.ListBox_Insert(*args, **kwargs)
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 users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
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 users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """ListBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ListBox_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
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
"""
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
"""
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
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):
"""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)
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
"""
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
"""
"""
HitTest(Point pt) -> (result, row, col)
- Find the character at position given in pixels.
- NB: pt is in device coords (not adjusted for the client area
- origin nor scrolling)
+ Find the 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)
return _controls_.TextCtrl_GetString(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def TextCtrl_GetClassDefaultAttributes(*args, **kwargs):
- """
- TextCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """TextCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.TextCtrl_GetClassDefaultAttributes(*args, **kwargs)
wxEVT_COMMAND_TEXT_UPDATED = _controls_.wxEVT_COMMAND_TEXT_UPDATED
bool refresh=True)
Sets the scrollbar properties of a built-in scrollbar.
-
- orientation: Determines the scrollbar whose page size is to be
- set. May be wx.HORIZONTAL or wx.VERTICAL.
-
- position: The position of the scrollbar in scroll units.
-
- thumbSize: The size of the thumb, or visible portion of the
- scrollbar, in scroll units.
-
- range: The maximum position of the scrollbar.
-
- refresh: True to redraw the scrollbar, false otherwise.
"""
return _controls_.ScrollBar_SetScrollbar(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def ScrollBar_GetClassDefaultAttributes(*args, **kwargs):
- """
- ScrollBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """ScrollBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ScrollBar_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
return _controls_.SpinButton_IsVertical(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def SpinButton_GetClassDefaultAttributes(*args, **kwargs):
- """
- SpinButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """SpinButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.SpinButton_GetClassDefaultAttributes(*args, **kwargs)
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 users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def SpinCtrl_GetClassDefaultAttributes(*args, **kwargs):
- """
- SpinCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """SpinCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.SpinCtrl_GetClassDefaultAttributes(*args, **kwargs)
class SpinEvent(_core.NotifyEvent):
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']
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)
return _controls_.RadioBox_GetNextItem(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def RadioBox_GetClassDefaultAttributes(*args, **kwargs):
- """
- RadioBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """RadioBox_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.RadioBox_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
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
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)
return _controls_.RadioButton_SetValue(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def RadioButton_GetClassDefaultAttributes(*args, **kwargs):
- """
- RadioButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """RadioButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.RadioButton_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
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']
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)
return _controls_.Slider_SetSelection(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def Slider_GetClassDefaultAttributes(*args, **kwargs):
- """
- Slider_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """Slider_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.Slider_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
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
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)
return _controls_.ToggleButton_SetLabel(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def ToggleButton_GetClassDefaultAttributes(*args, **kwargs):
- """
- ToggleButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """ToggleButton_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ToggleButton_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
return _controls_.BookCtrl_AdvanceSelection(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.BookCtrl_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
NOTEBOOK_NAME = cvar.NOTEBOOK_NAME
def BookCtrl_GetClassDefaultAttributes(*args, **kwargs):
- """
- BookCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """BookCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.BookCtrl_GetClassDefaultAttributes(*args, **kwargs)
class BookCtrlEvent(_core.NotifyEvent):
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)
"""
HitTest(Point pt) -> (tab, where)
- Returns the tab which is hit, and flags indicating where using wx.NB_HITTEST_ flags.
+ Returns the tab which is hit, and flags indicating where using
+ wx.NB_HITTEST flags.
"""
return _controls_.Notebook_HitTest(*args, **kwargs)
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 users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def Notebook_GetClassDefaultAttributes(*args, **kwargs):
- """
- Notebook_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """Notebook_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.Notebook_GetClassDefaultAttributes(*args, **kwargs)
class NotebookEvent(BookCtrlEvent):
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)
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):
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):
# 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 = '',
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)
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)
return _controls_.ToolBar_FindToolForPosition(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def ToolBar_GetClassDefaultAttributes(*args, **kwargs):
- """
- ToolBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
-
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """ToolBar_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ToolBar_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
"""
SetWindowStyleFlag(self, long style)
- Sets the style of the window. Please note that some styles cannot
- be changed after the window creation and that Refresh() might
- need to be called after changing the others for the change to
- take place immediately.
+ Sets the style of the window. Please note that some styles cannot be
+ changed after the window creation and that Refresh() might need to be
+ called after changing the others for the change to take place
+ immediately.
"""
return _controls_.ListCtrl_SetWindowStyleFlag(*args, **kwargs)
"""
HitTest(Point point) -> (item, where)
- Determines which item (if any) is at the specified point,
- giving details in the second return value (see wxLIST_HITTEST_... flags.)
+ Determines which item (if any) is at the specified point, giving
+ in the second return value (see wxLIST_HITTEST_... flags.)
"""
return _controls_.ListCtrl_HitTest(*args, **kwargs)
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 users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
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 users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """ListCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.ListCtrl_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
"""
HitTest(Point point) -> (item, where)
- Determine which item (if any) belongs the given point. The
- coordinates specified are relative to the client area of tree ctrl
- and the where return value is set to a bitmask of wxTREE_HITTEST_xxx
- constants.
+ 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)
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 users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
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 users system, especially if it uses themes.
-
- The variant parameter is only relevant under Mac currently and is
- ignore under other platforms. Under Mac, it will change the size of the
- returned font. See SetWindowVariant for more about this.
- """
+ """TreeCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _controls_.TreeCtrl_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
"""
FindChild(wxTreeItemId parentId, wxString path) -> (item, done)
- Find the child that matches the first part of 'path'. E.g. if a child path is
- "/usr" and 'path' is "/usr/include" then the child for /usr is returned.
- If the path string has been used (we're at the leaf), done is set to True
+ 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)
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)
"""_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)
"""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):
class HelpEvent(_core.CommandEvent):
"""
- A help event is sent when the user has requested
- context-sensitive help. This can either be caused by the
- application requesting context-sensitive help mode via
- wx.ContextHelp, or (on MS Windows) by the system generating a
- WM_HELP message when the user pressed F1 or clicked on the query
- button in a dialog caption.
-
- A help event is sent to the window that the user clicked on, and
- is propagated up the window hierarchy until the event is
- processed or there are no more event handlers. The application
- should call event.GetId to check the identity of the clicked-on
- window, and then either show some suitable help or call
- event.Skip if the identifier is unrecognised. Calling Skip is
- important because it allows wxWindows to generate further events
- for ancestors of the clicked-on window. Otherwise it would be
- impossible to show help for container windows, since processing
- would stop after the first window found.
-
- Events
- EVT_HELP Sent when the user has requested context-
- sensitive help.
- EVT_HELP_RANGE Allows to catch EVT_HELP for a range of IDs
-
+ A help event is sent when the user has requested context-sensitive
+ help. This can either be caused by the application requesting
+ context-sensitive help mode via wx.ContextHelp, or (on MS Windows) by
+ the system generating a WM_HELP message when the user pressed F1 or
+ clicked on the query button in a dialog caption.
+
+ A help event is sent to the window that the user clicked on, and is
+ propagated up the window hierarchy until the event is processed or
+ there are no more event handlers. The application should call
+ event.GetId to check the identity of the clicked-on window, and then
+ either show some suitable help or call event.Skip if the identifier is
+ unrecognised. Calling Skip is important because it allows wxWindows to
+ generate further events for ancestors of the clicked-on
+ window. Otherwise it would be impossible to show help for container
+ windows, since processing would stop after the first window found.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxHelpEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
class ContextHelp(_core.Object):
"""
- This class changes the cursor to a query and puts the application
- into a 'context-sensitive help mode'. When the user left-clicks
- on a window within the specified window, a EVT_HELP event is sent
- to that control, and the application may respond to it by popping
- up some help.
+ This class changes the cursor to a query and puts the application into
+ a 'context-sensitive help mode'. When the user left-clicks on a window
+ within the specified window, a ``EVT_HELP`` event is sent to that
+ control, and the application may respond to it by popping up some
+ help.
There are a couple of ways to invoke this behaviour implicitly:
- * Use the wx.DIALOG_EX_CONTEXTHELP extended style for a
- dialog (Windows only). This will put a question mark in the
- titlebar, and Windows will put the application into
- context-sensitive help mode automatically, with further
- programming.
+ * Use the wx.DIALOG_EX_CONTEXTHELP extended style for a dialog
+ (Windows only). This will put a question mark in the titlebar,
+ and Windows will put the application into context-sensitive help
+ mode automatically, with further programming.
- * Create a wx.ContextHelpButton, whose predefined behaviour
- is to create a context help object. Normally you will write
- your application so that this button is only added to a
- dialog for non-Windows platforms (use
- wx.DIALOG_EX_CONTEXTHELP on Windows).
+ * Create a `wx.ContextHelpButton`, whose predefined behaviour is
+ to create a context help object. Normally you will write your
+ application so that this button is only added to a dialog for
+ non-Windows platforms (use ``wx.DIALOG_EX_CONTEXTHELP`` on
+ Windows).
+
+ :see: `wx.ContextHelpButton`
"""
def __repr__(self):
"""
__init__(self, Window window=None, bool doNow=True) -> ContextHelp
- Constructs a context help object, calling BeginContextHelp if
- doNow is true (the default).
+ Constructs a context help object, calling BeginContextHelp if doNow is
+ true (the default).
If window is None, the top window is used.
"""
"""
BeginContextHelp(self, Window window=None) -> bool
- Puts the application into context-sensitive help mode. window is
- the window which will be used to catch events; if NULL, the top
- window will be used.
+ Puts the application into context-sensitive help mode. window is the
+ window which will be used to catch events; if NULL, the top window
+ will be used.
Returns true if the application was successfully put into
- context-sensitive help mode. This function only returns when the
- event loop has finished.
+ context-sensitive help mode. This function only returns when the event
+ loop has finished.
"""
return _controls_.ContextHelp_BeginContextHelp(*args, **kwargs)
class ContextHelpButton(BitmapButton):
"""
- Instances of this class may be used to add a question mark button
- that when pressed, puts the application into context-help
- mode. It does this by creating a wx.ContextHelp object which
- itself generates a EVT_HELP event when the user clicks on a
- window.
+ Instances of this class may be used to add a question mark button that
+ when pressed, puts the application into context-help mode. It does
+ this by creating a wx.ContextHelp object which itself generates a
+ ``EVT_HELP`` event when the user clicks on a window.
+
+ On Windows, you may add a question-mark icon to a dialog by use of the
+ ``wx.DIALOG_EX_CONTEXTHELP`` extra style, but on other platforms you
+ will have to add a button explicitly, usually next to OK, Cancel or
+ similar buttons.
- On Windows, you may add a question-mark icon to a dialog by use
- of the wx.DIALOG_EX_CONTEXTHELP extra style, but on other
- platforms you will have to add a button explicitly, usually next
- to OK, Cancel or similar buttons.
+ :see: `wx.ContextHelp`, `wx.ContextHelpButton`
"""
def __repr__(self):
"""
Set(HelpProvider helpProvider) -> HelpProvider
- Sset the current, application-wide help provider. Returns the
- previous one. Unlike some other classes, the help provider is
- not created on demand. This must be explicitly done by the
- application.
+ Sset the current, application-wide help provider. Returns the previous
+ one. Unlike some other classes, the help provider is not created on
+ demand. This must be explicitly done by the application.
"""
return _controls_.HelpProvider_Set(*args, **kwargs)
"""
GetHelp(self, Window window) -> String
- Gets the help string for this window. Its interpretation is
- dependent on the help provider except that empty string always
- means that no help is associated with the window.
+ Gets the help string for this window. Its interpretation is dependent
+ on the help provider except that empty string always means that no
+ help is associated with the window.
"""
return _controls_.HelpProvider_GetHelp(*args, **kwargs)
ShowHelp(self, Window window) -> bool
Shows help for the given window. Uses GetHelp internally if
- applicable.
-
- Returns true if it was done, or false if no help was available
- for this window.
+ applicable. Returns True if it was done, or False if no help was
+ available for this window.
"""
return _controls_.HelpProvider_ShowHelp(*args, **kwargs)
AddHelpById(self, int id, String text)
This version associates the given text with all windows with this
- id. May be used to set the same help string for all Cancel
- buttons in the application, for example.
+ id. May be used to set the same help string for all Cancel buttons in
+ the application, for example.
"""
return _controls_.HelpProvider_AddHelpById(*args, **kwargs)
RemoveHelp(self, Window window)
Removes the association between the window pointer and the help
- text. This is called by the wx.Window destructor. Without this,
- the table of help strings will fill up and when window pointers
- are reused, the wrong help string will be found.
+ text. This is called by the wx.Window destructor. Without this, the
+ table of help strings will fill up and when window pointers are
+ reused, the wrong help string will be found.
"""
return _controls_.HelpProvider_RemoveHelp(*args, **kwargs)
"""
HelpProvider_Set(HelpProvider helpProvider) -> HelpProvider
- Sset the current, application-wide help provider. Returns the
- previous one. Unlike some other classes, the help provider is
- not created on demand. This must be explicitly done by the
- application.
+ Sset the current, application-wide help provider. Returns the previous
+ one. Unlike some other classes, the help provider is not created on
+ demand. This must be explicitly done by the application.
"""
return _controls_.HelpProvider_Set(*args, **kwargs)
class SimpleHelpProvider(HelpProvider):
"""
- wx.SimpleHelpProvider is an implementation of wx.HelpProvider
- which supports only plain text help strings, and shows the string
- associated with the control (if any) in a tooltip.
+ wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
+ supports only plain text help strings, and shows the string associated
+ with the control (if any) in a tooltip.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxSimpleHelpProvider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
__init__(self) -> SimpleHelpProvider
- wx.SimpleHelpProvider is an implementation of wx.HelpProvider
- which supports only plain text help strings, and shows the string
- associated with the control (if any) in a tooltip.
+ wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
+ supports only plain text help strings, and shows the string associated
+ with the control (if any) in a tooltip.
"""
newobj = _controls_.new_SimpleHelpProvider(*args, **kwargs)
self.this = newobj.this
projects / wxWidgets.git / blobdiff