return _controls.Button_GetDefaultSize(*args, **kwargs)
class BitmapButton(Button):
- """A Buttont that contains a bitmap."""
+ """
+ A Button that contains a bitmap. A bitmap button can be supplied with a
+ single bitmap, and wxWindows will draw all button states using this bitmap. If
+ the application needs more control, additional bitmaps for the selected state,
+ unpressed focused state, and greyed-out state may be supplied.
+
+ """
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):
Validator validator=DefaultValidator,
String name=ButtonNameStr) -> BitmapButton
- Create and show a button.
+ Create and show a button with a bitmap for the label.
"""
newobj = _controls.new_BitmapButton(*args, **kwargs)
self.this = newobj.this
CHK_CHECKED = _controls.CHK_CHECKED
CHK_UNDETERMINED = _controls.CHK_UNDETERMINED
class CheckBox(core.Control):
+ """
+ A checkbox is a labelled box which by default is either on (checkmark is
+ visible) or off (no checkmark). Optionally (When the wxCHK_3STATE style flag
+ is set) it can have a third state, called the mixed or undetermined
+ state. Often this is used as a "Does Not Apply" state.
+ """
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__(Window parent, int id, String label, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0,
Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> CheckBox
+
+ Creates and shows a CheckBox control
"""
newobj = _controls.new_CheckBox(*args, **kwargs)
self.this = newobj.this
Create(Window parent, int id, String label, 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_Create(*args, **kwargs)
def GetValue(*args, **kwargs):
- """GetValue() -> bool"""
+ """
+ GetValue() -> bool
+
+ Gets the state of a 2-state CheckBox. Returns True if it is checked,
+ False otherwise.
+ """
return _controls.CheckBox_GetValue(*args, **kwargs)
def IsChecked(*args, **kwargs):
- """IsChecked() -> bool"""
+ """
+ IsChecked() -> bool
+
+ Similar to GetValue, but raises an exception if it is not a 2-state CheckBox.
+ """
return _controls.CheckBox_IsChecked(*args, **kwargs)
def SetValue(*args, **kwargs):
- """SetValue(bool state)"""
+ """
+ SetValue(bool state)
+
+ Set the state of a 2-state CheckBox. Pass True for checked,
+ False for unchecked.
+ """
return _controls.CheckBox_SetValue(*args, **kwargs)
def Get3StateValue(*args, **kwargs):
- """Get3StateValue() -> int"""
+ """
+ Get3StateValue() -> int
+
+ Returns wx.CHK_UNCHECKED when the CheckBox is unchecked, wx.CHK_CHECKED when
+ it is checked and wx.CHK_UNDETERMINED when it's in the undetermined state.
+ Raises an exceptiion when the function is used with a 2-state CheckBox.
+ """
return _controls.CheckBox_Get3StateValue(*args, **kwargs)
def Set3StateValue(*args, **kwargs):
- """Set3StateValue(int state)"""
+ """
+ Set3StateValue(int state)
+
+ Sets the CheckBox to the given state. The state parameter can be
+ one of the following: wx.CHK_UNCHECKED (Check is off), wx.CHK_CHECKED
+ (Check is on) or wx.CHK_UNDETERMINED (Check is mixed). Raises an
+ exception when the CheckBox is a 2-state checkbox and setting the state
+ to wx.CHK_UNDETERMINED.
+ """
return _controls.CheckBox_Set3StateValue(*args, **kwargs)
def Is3State(*args, **kwargs):
- """Is3State() -> bool"""
+ """
+ Is3State() -> bool
+
+ Returns whether or not the CheckBox is a 3-state CheckBox.
+ """
return _controls.CheckBox_Is3State(*args, **kwargs)
def Is3rdStateAllowedForUser(*args, **kwargs):
- """Is3rdStateAllowedForUser() -> bool"""
+ """
+ Is3rdStateAllowedForUser() -> bool
+
+ Returns whether or not the user can set the CheckBox to the third state.
+ """
return _controls.CheckBox_Is3rdStateAllowedForUser(*args, **kwargs)
CheckBoxNameStr = cvar.CheckBoxNameStr
def PreCheckBox(*args, **kwargs):
- """PreCheckBox() -> CheckBox"""
+ """
+ PreCheckBox() -> CheckBox
+
+ Precreate a CheckBox for 2-phase creation.
+ """
val = _controls.new_PreCheckBox(*args, **kwargs)
val.thisown = 1
return val
#---------------------------------------------------------------------------
class Choice(core.ControlWithItems):
+ """
+ A Choice control is used to select one of a list of strings. Unlike a ListBox,
+ only the selection is visible until the user pulls down the menu of choices.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxChoice instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
"""
- __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
- long style=0, Validator validator=DefaultValidator,
+ __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
+ List choices=[], long style=0, Validator validator=DefaultValidator,
String name=ChoiceNameStr) -> Choice
+
+ Create and show a Choice control
"""
newobj = _controls.new_Choice(*args, **kwargs)
self.this = newobj.this
def Create(*args, **kwargs):
"""
- Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
- long style=0, Validator validator=DefaultValidator,
+ 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)
- def GetColumns(*args, **kwargs):
- """GetColumns() -> int"""
- return _controls.Choice_GetColumns(*args, **kwargs)
-
- def SetColumns(*args, **kwargs):
- """SetColumns(int n=1)"""
- return _controls.Choice_SetColumns(*args, **kwargs)
-
def SetSelection(*args, **kwargs):
- """SetSelection(int n)"""
+ """
+ SetSelection(int n)
+
+ Select the n'th item (zero based) in the list.
+ """
return _controls.Choice_SetSelection(*args, **kwargs)
def SetStringSelection(*args, **kwargs):
- """SetStringSelection(String string)"""
+ """
+ SetStringSelection(String string)
+
+ Select the item with the specifed string
+ """
return _controls.Choice_SetStringSelection(*args, **kwargs)
def SetString(*args, **kwargs):
- """SetString(int n, String s)"""
+ """
+ SetString(int n, String string)
+
+ Set the label for the n'th item (zero based) in the list.
+ """
return _controls.Choice_SetString(*args, **kwargs)
+ Select = SetSelection
class ChoicePtr(Choice):
def __init__(self, this):
ChoiceNameStr = cvar.ChoiceNameStr
def PreChoice(*args, **kwargs):
- """PreChoice() -> Choice"""
+ """
+ PreChoice() -> Choice
+
+ Precreate a Choice control for 2-phase creation.
+ """
val = _controls.new_PreChoice(*args, **kwargs)
val.thisown = 1
return val
#---------------------------------------------------------------------------
class ComboBox(core.Control,core.ItemContainer):
+ """
+ A combobox is like a combination of an edit control and a listbox. It can be
+ displayed as static list with editable or read-only text field; or a drop-down
+ list with text field.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxComboBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
"""
- __init__(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition,
- Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
- long style=0, Validator validator=DefaultValidator,
- String name=ComboBoxNameStr) -> ComboBox
+ __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
+
+ Constructor, creates and shows a ComboBox control.
"""
newobj = _controls.new_ComboBox(*args, **kwargs)
self.this = newobj.this
def Create(*args, **kwargs):
"""
- Create(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition,
- Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
- long style=0, Validator validator=DefaultValidator,
- String name=ComboBoxNameStr) -> bool
+ Create(Window parent, int id, String value=EmptyString,
+ 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)
def GetValue(*args, **kwargs):
- """GetValue() -> String"""
+ """
+ GetValue() -> String
+
+ Returns the current value in the combobox text field.
+ """
return _controls.ComboBox_GetValue(*args, **kwargs)
def SetValue(*args, **kwargs):
return _controls.ComboBox_SetValue(*args, **kwargs)
def Copy(*args, **kwargs):
- """Copy()"""
+ """
+ Copy()
+
+ Copies the selected text to the clipboard.
+ """
return _controls.ComboBox_Copy(*args, **kwargs)
def Cut(*args, **kwargs):
- """Cut()"""
+ """
+ Cut()
+
+ Copies the selected text to the clipboard and removes the selection.
+ """
return _controls.ComboBox_Cut(*args, **kwargs)
def Paste(*args, **kwargs):
- """Paste()"""
+ """
+ Paste()
+
+ Pastes text from the clipboard to the text field.
+ """
return _controls.ComboBox_Paste(*args, **kwargs)
def SetInsertionPoint(*args, **kwargs):
- """SetInsertionPoint(long pos)"""
+ """
+ SetInsertionPoint(long pos)
+
+ Sets the insertion point in the combobox text field.
+ """
return _controls.ComboBox_SetInsertionPoint(*args, **kwargs)
def GetInsertionPoint(*args, **kwargs):
- """GetInsertionPoint() -> long"""
+ """
+ GetInsertionPoint() -> long
+
+ Returns the insertion point for the combobox's text field.
+ """
return _controls.ComboBox_GetInsertionPoint(*args, **kwargs)
def GetLastPosition(*args, **kwargs):
- """GetLastPosition() -> long"""
+ """
+ GetLastPosition() -> long
+
+ Returns the last position in the combobox text field.
+ """
return _controls.ComboBox_GetLastPosition(*args, **kwargs)
def Replace(*args, **kwargs):
- """Replace(long from, long to, String value)"""
+ """
+ Replace(long from, long to, String value)
+
+ Replaces the text between two positions with the given text, in the
+ combobox text field.
+ """
return _controls.ComboBox_Replace(*args, **kwargs)
def SetSelection(*args, **kwargs):
- """SetSelection(int n)"""
+ """
+ SetSelection(int n)
+
+ Selects the text between the two positions, in the combobox text field.
+ """
return _controls.ComboBox_SetSelection(*args, **kwargs)
def SetMark(*args, **kwargs):
return _controls.ComboBox_SetEditable(*args, **kwargs)
def SetInsertionPointEnd(*args, **kwargs):
- """SetInsertionPointEnd()"""
+ """
+ SetInsertionPointEnd()
+
+ Sets the insertion point at the end of the combobox text field.
+ """
return _controls.ComboBox_SetInsertionPointEnd(*args, **kwargs)
def Remove(*args, **kwargs):
- """Remove(long from, long to)"""
+ """
+ Remove(long from, long to)
+
+ Removes the text between the two positions in the combobox text field.
+ """
return _controls.ComboBox_Remove(*args, **kwargs)
ComboBoxNameStr = cvar.ComboBoxNameStr
def PreComboBox(*args, **kwargs):
- """PreComboBox() -> ComboBox"""
+ """
+ PreComboBox() -> ComboBox
+
+ Precreate a ComboBox control for 2-phase creation.
+ """
val = _controls.new_PreComboBox(*args, **kwargs)
val.thisown = 1
return val
return _controls.ListBox_Create(*args, **kwargs)
def Insert(*args, **kwargs):
- """Insert(String item, int pos, PyObject clientData=None)"""
+ """
+ Insert(String item, int pos, PyObject clientData=None)
+
+ 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)
def InsertItems(*args, **kwargs):
return _controls.ListBox_SetSelection(*args, **kwargs)
def Select(*args, **kwargs):
- """Select(int n)"""
+ """
+ Select(int n)
+
+ Sets the item at index 'n' to be the selected item.
+ """
return _controls.ListBox_Select(*args, **kwargs)
def Deselect(*args, **kwargs):
"""IsSorted() -> bool"""
return _controls.ListBox_IsSorted(*args, **kwargs)
+ def SetItemForegroundColour(*args, **kwargs):
+ """SetItemForegroundColour(int item, Colour c)"""
+ return _controls.ListBox_SetItemForegroundColour(*args, **kwargs)
+
+ def SetItemBackgroundColour(*args, **kwargs):
+ """SetItemBackgroundColour(int item, Colour c)"""
+ return _controls.ListBox_SetItemBackgroundColour(*args, **kwargs)
+
+ def SetItemFont(*args, **kwargs):
+ """SetItemFont(int item, Font f)"""
+ return _controls.ListBox_SetItemFont(*args, **kwargs)
+
class ListBoxPtr(ListBox):
def __init__(self, this):
return _controls.CheckListBox_GetItemHeight(*args, **kwargs)
def HitTest(*args, **kwargs):
- """HitTest(Point pt) -> int"""
+ """
+ HitTest(Point pt) -> int
+
+ Test where the given (in client coords) point lies
+ """
return _controls.CheckListBox_HitTest(*args, **kwargs)
def HitTestXY(*args, **kwargs):
- """HitTestXY(int x, int y) -> int"""
+ """
+ HitTestXY(int x, int y) -> int
+
+ Test where the given (in client coords) point lies
+ """
return _controls.CheckListBox_HitTestXY(*args, **kwargs)
TEXT_ATTR_LEFT_INDENT = _controls.TEXT_ATTR_LEFT_INDENT
TEXT_ATTR_RIGHT_INDENT = _controls.TEXT_ATTR_RIGHT_INDENT
TEXT_ATTR_TABS = _controls.TEXT_ATTR_TABS
-wxTE_HT_UNKNOWN = _controls.wxTE_HT_UNKNOWN
-wxTE_HT_BEFORE = _controls.wxTE_HT_BEFORE
-wxTE_HT_ON_TEXT = _controls.wxTE_HT_ON_TEXT
-wxTE_HT_BELOW = _controls.wxTE_HT_BELOW
-wxTE_HT_BEYOND = _controls.wxTE_HT_BEYOND
+TE_HT_UNKNOWN = _controls.TE_HT_UNKNOWN
+TE_HT_BEFORE = _controls.TE_HT_BEFORE
+TE_HT_ON_TEXT = _controls.TE_HT_ON_TEXT
+TE_HT_BELOW = _controls.TE_HT_BELOW
+TE_HT_BEYOND = _controls.TE_HT_BEYOND
class TextAttr(object):
def __repr__(self):
return "<%s.%s; proxy of C++ wxTextAttr instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
Create(Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=SB_HORIZONTAL,
Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> bool
+
+ Do the 2nd phase and create the GUI control.
"""
return _controls.ScrollBar_Create(*args, **kwargs)
"""
SetScrollbar(int position, int thumbSize, int range, int pageSize,
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)
return _controls.ToggleButton_GetValue(*args, **kwargs)
def SetLabel(*args, **kwargs):
- """SetLabel(String label)"""
+ """
+ SetLabel(String label)
+
+ Sets the item's text.
+ """
return _controls.ToggleButton_SetLabel(*args, **kwargs)
Create(Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=LC_ICON,
Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool
+
+ Do the 2nd phase and create the GUI control.
"""
return _controls.ListCtrl_Create(*args, **kwargs)
return _controls.ListCtrl__setCallbackInfo(*args, **kwargs)
def SetForegroundColour(*args, **kwargs):
- """SetForegroundColour(Colour col) -> bool"""
+ """
+ SetForegroundColour(Colour col) -> bool
+
+ Sets the foreground colour of the window. Returns True is the colour
+ was changed. The interpretation of foreground colour is dependent on
+ the window class; it may be the text colour or other colour, or it may
+ not be used at all.
+ """
return _controls.ListCtrl_SetForegroundColour(*args, **kwargs)
def SetBackgroundColour(*args, **kwargs):
- """SetBackgroundColour(Colour col) -> bool"""
+ """
+ SetBackgroundColour(Colour col) -> bool
+
+ Sets the background colour of the window. Returns True if the colour
+ was changed. The background colour is usually painted by the default
+ EVT_ERASE_BACKGROUND event handler function under Windows and
+ automatically under GTK.
+
+ Note that setting the background colour does not cause an immediate
+ refresh, so you may wish to call ClearBackground or Refresh after
+ calling this function.
+
+ Use this function with care under GTK+ as the new appearance of the
+ window might not look equally well when used with themes, i.e GTK+'s
+ ability to change its look as the user wishes with run-time loadable
+ modules.
+ """
return _controls.ListCtrl_SetBackgroundColour(*args, **kwargs)
def GetColumn(*args, **kwargs):
return _controls.ListCtrl_SetSingleStyle(*args, **kwargs)
def SetWindowStyleFlag(*args, **kwargs):
- """SetWindowStyleFlag(long style)"""
+ """
+ SetWindowStyleFlag(long style)
+
+ Sets the style of the window. Please note that some styles cannot be
+ changed after the window creation and that Refresh() might be called
+ after changing the others for the change to take place immediately.
+ """
return _controls.ListCtrl_SetWindowStyleFlag(*args, **kwargs)
def GetNextItem(*args, **kwargs):
"""AssignImageList(ImageList imageList, int which)"""
return _controls.ListCtrl_AssignImageList(*args, **kwargs)
+ def InReportView(*args, **kwargs):
+ """InReportView() -> bool"""
+ return _controls.ListCtrl_InReportView(*args, **kwargs)
+
def IsVirtual(*args, **kwargs):
"""IsVirtual() -> bool"""
return _controls.ListCtrl_IsVirtual(*args, **kwargs)
Create(Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=LC_REPORT,
Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool
+
+ Do the 2nd phase and create the GUI control.
"""
return _controls.ListView_Create(*args, **kwargs)
Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
Validator validator=DefaultValidator,
String name=TreeCtrlNameStr) -> bool
+
+ Do the 2nd phase and create the GUI control.
"""
return _controls.TreeCtrl_Create(*args, **kwargs)
"""Unselect()"""
return _controls.TreeCtrl_Unselect(*args, **kwargs)
+ def UnselectItem(*args, **kwargs):
+ """UnselectItem(TreeItemId item)"""
+ return _controls.TreeCtrl_UnselectItem(*args, **kwargs)
+
def UnselectAll(*args, **kwargs):
"""UnselectAll()"""
return _controls.TreeCtrl_UnselectAll(*args, **kwargs)
def SelectItem(*args, **kwargs):
- """SelectItem(TreeItemId item)"""
+ """SelectItem(TreeItemId item, bool select=True)"""
return _controls.TreeCtrl_SelectItem(*args, **kwargs)
+ def ToggleItemSelection(*args, **kwargs):
+ """ToggleItemSelection(TreeItemId item)"""
+ return _controls.TreeCtrl_ToggleItemSelection(*args, **kwargs)
+
def EnsureVisible(*args, **kwargs):
"""EnsureVisible(TreeItemId item)"""
return _controls.TreeCtrl_EnsureVisible(*args, **kwargs)
EVT_DETAILED_HELP_RANGE = wx.PyEventBinder( wxEVT_DETAILED_HELP, 2)
class HelpEvent(core.CommandEvent):
+ """
+ A help event is sent when the user has requested
+ context-sensitive help. This can either be caused by the
+ application requesting context-sensitive help mode via
+ wx.ContextHelp, or (on MS Windows) by the system generating a
+ WM_HELP message when the user pressed F1 or clicked on the query
+ button in a dialog caption.
+
+ A help event is sent to the window that the user clicked on, and
+ is propagated up the window hierarchy until the event is
+ processed or there are no more event handlers. The application
+ should call event.GetId to check the identity of the clicked-on
+ window, and then either show some suitable help or call
+ event.Skip if the identifier is unrecognised. Calling Skip is
+ important because it allows wxWindows to generate further events
+ for ancestors of the clicked-on window. Otherwise it would be
+ impossible to show help for container windows, since processing
+ would stop after the first window found.
+
+ Events
+ EVT_HELP Sent when the user has requested context-
+ sensitive help.
+ EVT_HELP_RANGE Allows to catch EVT_HELP for a range of IDs
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxHelpEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
self.thisown = 1
del newobj.thisown
def GetPosition(*args, **kwargs):
- """GetPosition() -> Point"""
+ """
+ GetPosition() -> Point
+
+ Returns the left-click position of the mouse, in screen
+ coordinates. This allows the application to position the help
+ appropriately.
+ """
return _controls.HelpEvent_GetPosition(*args, **kwargs)
def SetPosition(*args, **kwargs):
- """SetPosition(Point pos)"""
+ """
+ SetPosition(Point pos)
+
+ Sets the left-click position of the mouse, in screen coordinates.
+ """
return _controls.HelpEvent_SetPosition(*args, **kwargs)
def GetLink(*args, **kwargs):
- """GetLink() -> String"""
+ """
+ GetLink() -> String
+
+ Get an optional link to further help
+ """
return _controls.HelpEvent_GetLink(*args, **kwargs)
def SetLink(*args, **kwargs):
- """SetLink(String link)"""
+ """
+ SetLink(String link)
+
+ Set an optional link to further help
+ """
return _controls.HelpEvent_SetLink(*args, **kwargs)
def GetTarget(*args, **kwargs):
- """GetTarget() -> String"""
+ """
+ GetTarget() -> String
+
+ Get an optional target to display help in. E.g. a window specification
+ """
return _controls.HelpEvent_GetTarget(*args, **kwargs)
def SetTarget(*args, **kwargs):
- """SetTarget(String target)"""
+ """
+ SetTarget(String target)
+
+ Set an optional target to display help in. E.g. a window specification
+ """
return _controls.HelpEvent_SetTarget(*args, **kwargs)
_controls.HelpEvent_swigregister(HelpEventPtr)
class ContextHelp(core.Object):
+ """
+ This class changes the cursor to a query and puts the application
+ into a 'context-sensitive help mode'. When the user left-clicks
+ on a window within the specified window, a EVT_HELP event is sent
+ to that control, and the application may respond to it by popping
+ up some help.
+
+ 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.
+
+ * 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).
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxContextHelp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(Window window=None, bool doNow=True) -> ContextHelp"""
+ """
+ __init__(Window window=None, bool doNow=True) -> ContextHelp
+
+ Constructs a context help object, calling BeginContextHelp if
+ doNow is true (the default).
+
+ If window is None, the top window is used.
+ """
newobj = _controls.new_ContextHelp(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
except: pass
def BeginContextHelp(*args, **kwargs):
- """BeginContextHelp(Window window=None) -> bool"""
+ """
+ BeginContextHelp(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.
+
+ Returns true if the application was successfully put into
+ context-sensitive help mode. This function only returns when the
+ event loop has finished.
+ """
return _controls.ContextHelp_BeginContextHelp(*args, **kwargs)
def EndContextHelp(*args, **kwargs):
- """EndContextHelp() -> bool"""
+ """
+ EndContextHelp() -> bool
+
+ Ends context-sensitive help mode. Not normally called by the
+ application.
+ """
return _controls.ContextHelp_EndContextHelp(*args, **kwargs)
_controls.ContextHelp_swigregister(ContextHelpPtr)
class ContextHelpButton(BitmapButton):
+ """
+ Instances of this class may be used to add a question mark button
+ that when pressed, puts the application into context-help
+ mode. It does this by creating a wx.ContextHelp object which
+ itself generates a EVT_HELP event when the user clicks on a
+ window.
+
+ 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.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxContextHelpButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
"""
__init__(Window parent, int id=ID_CONTEXT_HELP, Point pos=DefaultPosition,
Size size=DefaultSize, long style=BU_AUTODRAW) -> ContextHelpButton
+
+ Constructor, creating and showing a context help button.
"""
newobj = _controls.new_ContextHelpButton(*args, **kwargs)
self.this = newobj.this
_controls.ContextHelpButton_swigregister(ContextHelpButtonPtr)
class HelpProvider(object):
+ """
+ wx.HelpProvider is an abstract class used by a program
+ implementing context-sensitive help to show the help text for the
+ given window.
+
+ The current help provider must be explicitly set by the
+ application using wx.HelpProvider.Set().
+ """
def __init__(self): raise RuntimeError, "No constructor defined"
def __repr__(self):
return "<%s.%s; proxy of C++ wxHelpProvider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def Set(*args, **kwargs):
- """Set(HelpProvider helpProvider) -> HelpProvider"""
+ """
+ Set(HelpProvider helpProvider) -> HelpProvider
+
+ Sset the current, application-wide help provider. Returns the
+ previous one. Unlike some other classes, the help provider is
+ not created on demand. This must be explicitly done by the
+ application.
+ """
return _controls.HelpProvider_Set(*args, **kwargs)
Set = staticmethod(Set)
def Get(*args, **kwargs):
- """Get() -> HelpProvider"""
+ """
+ Get() -> HelpProvider
+
+ Return the current application-wide help provider.
+ """
return _controls.HelpProvider_Get(*args, **kwargs)
Get = staticmethod(Get)
def GetHelp(*args, **kwargs):
- """GetHelp(Window window) -> String"""
+ """
+ GetHelp(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.
+ """
return _controls.HelpProvider_GetHelp(*args, **kwargs)
def ShowHelp(*args, **kwargs):
- """ShowHelp(Window window) -> bool"""
+ """
+ ShowHelp(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.
+ """
return _controls.HelpProvider_ShowHelp(*args, **kwargs)
def AddHelp(*args, **kwargs):
- """AddHelp(Window window, String text)"""
+ """
+ AddHelp(Window window, String text)
+
+ Associates the text with the given window.
+ """
return _controls.HelpProvider_AddHelp(*args, **kwargs)
def AddHelpById(*args, **kwargs):
- """AddHelpById(int id, String text)"""
+ """
+ AddHelpById(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.
+ """
return _controls.HelpProvider_AddHelpById(*args, **kwargs)
+ def RemoveHelp(*args, **kwargs):
+ """
+ RemoveHelp(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.
+ """
+ return _controls.HelpProvider_RemoveHelp(*args, **kwargs)
+
def Destroy(*args, **kwargs):
"""Destroy()"""
return _controls.HelpProvider_Destroy(*args, **kwargs)
_controls.HelpProvider_swigregister(HelpProviderPtr)
def HelpProvider_Set(*args, **kwargs):
- """HelpProvider_Set(HelpProvider helpProvider) -> HelpProvider"""
+ """
+ HelpProvider_Set(HelpProvider helpProvider) -> HelpProvider
+
+ Sset the current, application-wide help provider. Returns the
+ previous one. Unlike some other classes, the help provider is
+ not created on demand. This must be explicitly done by the
+ application.
+ """
return _controls.HelpProvider_Set(*args, **kwargs)
def HelpProvider_Get(*args, **kwargs):
- """HelpProvider_Get() -> HelpProvider"""
+ """
+ HelpProvider_Get() -> HelpProvider
+
+ Return the current application-wide help provider.
+ """
return _controls.HelpProvider_Get(*args, **kwargs)
class SimpleHelpProvider(HelpProvider):
+ """
+ wx.SimpleHelpProvider is an implementation of wx.HelpProvider
+ which supports only plain text help strings, and shows the string
+ associated with the control (if any) in a tooltip.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxSimpleHelpProvider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__() -> SimpleHelpProvider"""
+ """
+ __init__() -> 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.
+ """
newobj = _controls.new_SimpleHelpProvider(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
projects / wxWidgets.git / blobdiff