X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/196addbfe0f00b96fdeff1f6f29dae33cf95d071..660658398148d82d492a5d1a944bc4058a082267:/wxPython/src/gtk/controls.py diff --git a/wxPython/src/gtk/controls.py b/wxPython/src/gtk/controls.py index 22b6c09959..19204981f5 100644 --- a/wxPython/src/gtk/controls.py +++ b/wxPython/src/gtk/controls.py @@ -25,7 +25,7 @@ class Button(core.Control): """ __init__(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=wxPyButtonNameStr) -> Button + Validator validator=DefaultValidator, String name=ButtonNameStr) -> Button Create and show a button. """ @@ -39,7 +39,7 @@ class Button(core.Control): """ Create(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=wxPyButtonNameStr) -> bool + Validator validator=DefaultValidator, String name=ButtonNameStr) -> bool Acutally create the GUI Button for 2-phase creation. """ @@ -54,7 +54,7 @@ class Button(core.Control): return _controls.Button_SetDefault(*args, **kwargs) def GetDefaultSize(*args, **kwargs): - """Button.GetDefaultSize() -> Size""" + """GetDefaultSize() -> Size""" return _controls.Button_GetDefaultSize(*args, **kwargs) GetDefaultSize = staticmethod(GetDefaultSize) @@ -65,6 +65,8 @@ class ButtonPtr(Button): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = Button _controls.Button_swigregister(ButtonPtr) +cvar = _controls.cvar +ButtonNameStr = cvar.ButtonNameStr def PreButton(*args, **kwargs): """ @@ -81,7 +83,13 @@ def Button_GetDefaultSize(*args, **kwargs): 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): @@ -89,9 +97,9 @@ class BitmapButton(Button): __init__(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, Size size=DefaultSize, long style=BU_AUTODRAW, Validator validator=DefaultValidator, - String name=wxPyButtonNameStr) -> BitmapButton + 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 @@ -104,7 +112,7 @@ class BitmapButton(Button): Create(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, Size size=DefaultSize, long style=BU_AUTODRAW, Validator validator=DefaultValidator, - String name=wxPyButtonNameStr) -> bool + String name=ButtonNameStr) -> bool Acutally create the GUI BitmapButton for 2-phase creation. """ @@ -214,13 +222,21 @@ CHK_UNCHECKED = _controls.CHK_UNCHECKED 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=wxPyCheckBoxNameStr) -> CheckBox + Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> CheckBox + + Creates and shows a CheckBox control """ newobj = _controls.new_CheckBox(*args, **kwargs) self.this = newobj.this @@ -232,36 +248,74 @@ class CheckBox(core.Control): """ Create(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=wxPyCheckBoxNameStr) -> bool + 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) @@ -271,9 +325,14 @@ class CheckBoxPtr(CheckBox): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = CheckBox _controls.CheckBox_swigregister(CheckBoxPtr) +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 @@ -281,14 +340,19 @@ def PreCheckBox(*args, **kwargs): #--------------------------------------------------------------------------- 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, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=wxPyChoiceNameStr) -> Choice + __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 @@ -298,33 +362,39 @@ class Choice(core.ControlWithItems): def Create(*args, **kwargs): """ - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=wxPyChoiceNameStr) -> bool + 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): @@ -332,9 +402,14 @@ class ChoicePtr(Choice): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = Choice _controls.Choice_swigregister(ChoicePtr) +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 @@ -342,15 +417,21 @@ def PreChoice(*args, **kwargs): #--------------------------------------------------------------------------- class ComboBox(core.Control,core.ItemContainer): + """ + A combobox is like a combination of an edit control and a listbox. It can be + displayed as static list with editable or read-only text field; or a drop-down + list with text field. + """ 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, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=wxPyComboBoxNameStr) -> 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 @@ -360,16 +441,21 @@ class ComboBox(core.Control,core.ItemContainer): def Create(*args, **kwargs): """ - Create(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, - Size size=DefaultSize, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=wxPyComboBoxNameStr) -> 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): @@ -377,35 +463,68 @@ class ComboBox(core.Control,core.ItemContainer): 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): @@ -417,11 +536,19 @@ class ComboBox(core.Control,core.ItemContainer): 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) @@ -431,9 +558,14 @@ class ComboBoxPtr(ComboBox): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = ComboBox _controls.ComboBox_swigregister(ComboBoxPtr) +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 @@ -452,7 +584,7 @@ class Gauge(core.Control): __init__(Window parent, int id, int range, Point pos=DefaultPosition, Size size=DefaultSize, long style=GA_HORIZONTAL, Validator validator=DefaultValidator, - String name=wxPyGaugeNameStr) -> Gauge + String name=GaugeNameStr) -> Gauge """ newobj = _controls.new_Gauge(*args, **kwargs) self.this = newobj.this @@ -465,7 +597,7 @@ class Gauge(core.Control): Create(Window parent, int id, int range, Point pos=DefaultPosition, Size size=DefaultSize, long style=GA_HORIZONTAL, Validator validator=DefaultValidator, - String name=wxPyGaugeNameStr) -> bool + String name=GaugeNameStr) -> bool """ return _controls.Gauge_Create(*args, **kwargs) @@ -512,6 +644,7 @@ class GaugePtr(Gauge): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = Gauge _controls.Gauge_swigregister(GaugePtr) +GaugeNameStr = cvar.GaugeNameStr def PreGauge(*args, **kwargs): """PreGauge() -> Gauge""" @@ -528,7 +661,7 @@ class StaticBox(core.Control): """ __init__(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - String name=wxPyStaticBoxNameStr) -> StaticBox + String name=StaticBoxNameStr) -> StaticBox """ newobj = _controls.new_StaticBox(*args, **kwargs) self.this = newobj.this @@ -540,7 +673,7 @@ class StaticBox(core.Control): """ Create(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - String name=wxPyStaticBoxNameStr) -> bool + String name=StaticBoxNameStr) -> bool """ return _controls.StaticBox_Create(*args, **kwargs) @@ -551,6 +684,9 @@ class StaticBoxPtr(StaticBox): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = StaticBox _controls.StaticBox_swigregister(StaticBoxPtr) +StaticBitmapNameStr = cvar.StaticBitmapNameStr +StaticBoxNameStr = cvar.StaticBoxNameStr +StaticTextNameStr = cvar.StaticTextNameStr def PreStaticBox(*args, **kwargs): """PreStaticBox() -> StaticBox""" @@ -567,7 +703,7 @@ class StaticLine(core.Control): """ __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, long style=LI_HORIZONTAL, - String name=wxPyStaticTextNameStr) -> StaticLine + String name=StaticTextNameStr) -> StaticLine """ newobj = _controls.new_StaticLine(*args, **kwargs) self.this = newobj.this @@ -579,7 +715,7 @@ class StaticLine(core.Control): """ Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, long style=LI_HORIZONTAL, - String name=wxPyStaticTextNameStr) -> bool + String name=StaticTextNameStr) -> bool """ return _controls.StaticLine_Create(*args, **kwargs) @@ -588,7 +724,7 @@ class StaticLine(core.Control): return _controls.StaticLine_IsVertical(*args, **kwargs) def GetDefaultSize(*args, **kwargs): - """StaticLine.GetDefaultSize() -> int""" + """GetDefaultSize() -> int""" return _controls.StaticLine_GetDefaultSize(*args, **kwargs) GetDefaultSize = staticmethod(GetDefaultSize) @@ -619,7 +755,7 @@ class StaticText(core.Control): """ __init__(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - String name=wxPyStaticTextNameStr) -> StaticText + String name=StaticTextNameStr) -> StaticText """ newobj = _controls.new_StaticText(*args, **kwargs) self.this = newobj.this @@ -631,7 +767,7 @@ class StaticText(core.Control): """ Create(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - String name=wxPyStaticTextNameStr) -> bool + String name=StaticTextNameStr) -> bool """ return _controls.StaticText_Create(*args, **kwargs) @@ -658,7 +794,7 @@ class StaticBitmap(core.Control): """ __init__(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - String name=wxPyStaticBitmapNameStr) -> StaticBitmap + String name=StaticBitmapNameStr) -> StaticBitmap """ newobj = _controls.new_StaticBitmap(*args, **kwargs) self.this = newobj.this @@ -668,7 +804,7 @@ class StaticBitmap(core.Control): """ Create(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - String name=wxPyStaticBitmapNameStr) -> bool + String name=StaticBitmapNameStr) -> bool """ return _controls.StaticBitmap_Create(*args, **kwargs) @@ -681,7 +817,7 @@ class StaticBitmap(core.Control): return _controls.StaticBitmap_SetBitmap(*args, **kwargs) def SetIcon(*args, **kwargs): - """SetIcon(wxIcon icon)""" + """SetIcon(Icon icon)""" return _controls.StaticBitmap_SetIcon(*args, **kwargs) @@ -706,9 +842,9 @@ class ListBox(core.ControlWithItems): def __init__(self, *args, **kwargs): """ __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, + wxArrayString choices=wxPyEmptyStringArray, long style=0, Validator validator=DefaultValidator, - String name=wxPyListBoxNameStr) -> ListBox + String name=ListBoxNameStr) -> ListBox """ newobj = _controls.new_ListBox(*args, **kwargs) self.this = newobj.this @@ -719,14 +855,19 @@ class ListBox(core.ControlWithItems): def Create(*args, **kwargs): """ Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, + wxArrayString choices=wxPyEmptyStringArray, long style=0, Validator validator=DefaultValidator, - String name=wxPyListBoxNameStr) -> bool + String name=ListBoxNameStr) -> bool """ 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): @@ -746,7 +887,11 @@ class ListBox(core.ControlWithItems): 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): @@ -785,6 +930,18 @@ class ListBox(core.ControlWithItems): """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): @@ -792,6 +949,7 @@ class ListBoxPtr(ListBox): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = ListBox _controls.ListBox_swigregister(ListBoxPtr) +ListBoxNameStr = cvar.ListBoxNameStr def PreListBox(*args, **kwargs): """PreListBox() -> ListBox""" @@ -807,20 +965,22 @@ class CheckListBox(ListBox): def __init__(self, *args, **kwargs): """ __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, + wxArrayString choices=wxPyEmptyStringArray, long style=0, Validator validator=DefaultValidator, - String name=wxPyListBoxNameStr) -> CheckListBox + String name=ListBoxNameStr) -> CheckListBox """ newobj = _controls.new_CheckListBox(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown + self._setOORInfo(self) + def Create(*args, **kwargs): """ Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, + wxArrayString choices=wxPyEmptyStringArray, long style=0, Validator validator=DefaultValidator, - String name=wxPyListBoxNameStr) -> bool + String name=ListBoxNameStr) -> bool """ return _controls.CheckListBox_Create(*args, **kwargs) @@ -837,11 +997,19 @@ class CheckListBox(ListBox): 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) @@ -896,6 +1064,11 @@ TEXT_ATTR_ALIGNMENT = _controls.TEXT_ATTR_ALIGNMENT 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 +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,) @@ -909,6 +1082,12 @@ class TextAttr(object): self.this = newobj.this self.thisown = 1 del newobj.thisown + def __del__(self, destroy=_controls.delete_TextAttr): + """__del__()""" + try: + if self.thisown: destroy(self) + except: pass + def Init(*args, **kwargs): """Init()""" return _controls.TextAttr_Init(*args, **kwargs) @@ -1014,7 +1193,7 @@ class TextAttr(object): return _controls.TextAttr_IsDefault(*args, **kwargs) def Combine(*args, **kwargs): - """TextAttr.Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr""" + """Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr""" return _controls.TextAttr_Combine(*args, **kwargs) Combine = staticmethod(Combine) @@ -1025,6 +1204,7 @@ class TextAttrPtr(TextAttr): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = TextAttr _controls.TextAttr_swigregister(TextAttrPtr) +TextCtrlNameStr = cvar.TextCtrlNameStr def TextAttr_Combine(*args, **kwargs): """TextAttr_Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr""" @@ -1038,7 +1218,7 @@ class TextCtrl(core.Control): __init__(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, - String name=wxPyTextCtrlNameStr) -> TextCtrl + String name=TextCtrlNameStr) -> TextCtrl """ newobj = _controls.new_TextCtrl(*args, **kwargs) self.this = newobj.this @@ -1051,7 +1231,7 @@ class TextCtrl(core.Control): Create(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, - String name=wxPyTextCtrlNameStr) -> bool + String name=TextCtrlNameStr) -> bool """ return _controls.TextCtrl_Create(*args, **kwargs) @@ -1179,6 +1359,16 @@ class TextCtrl(core.Control): """ShowPosition(long pos)""" return _controls.TextCtrl_ShowPosition(*args, **kwargs) + def HitTest(*args, **kwargs): + """ + 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) + """ + return _controls.TextCtrl_HitTest(*args, **kwargs) + def Copy(*args, **kwargs): """Copy()""" return _controls.TextCtrl_Copy(*args, **kwargs) @@ -1316,7 +1506,7 @@ class ScrollBar(core.Control): """ __init__(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=SB_HORIZONTAL, - Validator validator=DefaultValidator, String name=wxPyScrollBarNameStr) -> ScrollBar + Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> ScrollBar """ newobj = _controls.new_ScrollBar(*args, **kwargs) self.this = newobj.this @@ -1328,7 +1518,9 @@ class ScrollBar(core.Control): """ Create(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=SB_HORIZONTAL, - Validator validator=DefaultValidator, String name=wxPyScrollBarNameStr) -> bool + Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> bool + + Do the 2nd phase and create the GUI control. """ return _controls.ScrollBar_Create(*args, **kwargs) @@ -1361,6 +1553,20 @@ class ScrollBar(core.Control): """ 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) @@ -1371,6 +1577,7 @@ class ScrollBarPtr(ScrollBar): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = ScrollBar _controls.ScrollBar_swigregister(ScrollBarPtr) +ScrollBarNameStr = cvar.ScrollBarNameStr def PreScrollBar(*args, **kwargs): """PreScrollBar() -> ScrollBar""" @@ -1391,7 +1598,7 @@ class SpinButton(core.Control): """ __init__(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=SP_HORIZONTAL, - String name=wxPySPIN_BUTTON_NAME) -> SpinButton + String name=SPIN_BUTTON_NAME) -> SpinButton """ newobj = _controls.new_SpinButton(*args, **kwargs) self.this = newobj.this @@ -1403,7 +1610,7 @@ class SpinButton(core.Control): """ Create(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=SP_HORIZONTAL, - String name=wxPySPIN_BUTTON_NAME) -> bool + String name=SPIN_BUTTON_NAME) -> bool """ return _controls.SpinButton_Create(*args, **kwargs) @@ -1446,6 +1653,8 @@ class SpinButtonPtr(SpinButton): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = SpinButton _controls.SpinButton_swigregister(SpinButtonPtr) +SPIN_BUTTON_NAME = cvar.SPIN_BUTTON_NAME +SpinCtrlNameStr = cvar.SpinCtrlNameStr def PreSpinButton(*args, **kwargs): """PreSpinButton() -> SpinButton""" @@ -1461,7 +1670,7 @@ class SpinCtrl(core.Control): __init__(Window parent, int id=-1, String value=EmptyString, Point pos=DefaultPosition, Size size=DefaultSize, long style=SP_ARROW_KEYS, int min=0, int max=100, - int initial=0, String name=wxPySpinCtrlNameStr) -> SpinCtrl + int initial=0, String name=SpinCtrlNameStr) -> SpinCtrl """ newobj = _controls.new_SpinCtrl(*args, **kwargs) self.this = newobj.this @@ -1474,7 +1683,7 @@ class SpinCtrl(core.Control): Create(Window parent, int id=-1, String value=EmptyString, Point pos=DefaultPosition, Size size=DefaultSize, long style=SP_ARROW_KEYS, int min=0, int max=100, - int initial=0, String name=wxPySpinCtrlNameStr) -> bool + int initial=0, String name=SpinCtrlNameStr) -> bool """ return _controls.SpinCtrl_Create(*args, **kwargs) @@ -1520,8 +1729,36 @@ def PreSpinCtrl(*args, **kwargs): val.thisown = 1 return val +class SpinEvent(core.NotifyEvent): + def __repr__(self): + return "<%s.%s; proxy of C++ wxSpinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) + def __init__(self, *args, **kwargs): + """__init__(wxEventType commandType=wxEVT_NULL, int winid=0) -> SpinEvent""" + newobj = _controls.new_SpinEvent(*args, **kwargs) + self.this = newobj.this + self.thisown = 1 + del newobj.thisown + def GetPosition(*args, **kwargs): + """GetPosition() -> int""" + return _controls.SpinEvent_GetPosition(*args, **kwargs) + + def SetPosition(*args, **kwargs): + """SetPosition(int pos)""" + return _controls.SpinEvent_SetPosition(*args, **kwargs) + + +class SpinEventPtr(SpinEvent): + def __init__(self, this): + self.this = this + if not hasattr(self,"thisown"): self.thisown = 0 + self.__class__ = SpinEvent +_controls.SpinEvent_swigregister(SpinEventPtr) + wxEVT_COMMAND_SPINCTRL_UPDATED = _controls.wxEVT_COMMAND_SPINCTRL_UPDATED -EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) +EVT_SPIN_UP = wx.PyEventBinder( wx.wxEVT_SCROLL_LINEUP, 1) +EVT_SPIN_DOWN = wx.PyEventBinder( wx.wxEVT_SCROLL_LINEDOWN, 1) +EVT_SPIN = wx.PyEventBinder( wx.wxEVT_SCROLL_THUMBTRACK, 1) +EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) #--------------------------------------------------------------------------- @@ -1530,12 +1767,13 @@ class RadioBox(core.Control): return "<%s.%s; proxy of C++ wxRadioBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(Window parent, int id, String label, Point point=DefaultPosition, - Size size=DefaultSize, int choices=0, - String choices_array=None, int majorDimension=0, + __init__(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, - String name=wxPyRadioBoxNameStr) -> RadioBox + String name=RadioBoxNameStr) -> RadioBox """ + if kwargs.has_key('point'): kwargs['pos'] = kwargs['point'] newobj = _controls.new_RadioBox(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1544,11 +1782,11 @@ class RadioBox(core.Control): def Create(*args, **kwargs): """ - Create(Window parent, int id, String label, Point point=DefaultPosition, - Size size=DefaultSize, int choices=0, - String choices_array=None, int majorDimension=0, + Create(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, - String name=wxPyRadioBoxNameStr) -> bool + String name=RadioBoxNameStr) -> bool """ return _controls.RadioBox_Create(*args, **kwargs) @@ -1613,6 +1851,8 @@ class RadioBoxPtr(RadioBox): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = RadioBox _controls.RadioBox_swigregister(RadioBoxPtr) +RadioBoxNameStr = cvar.RadioBoxNameStr +RadioButtonNameStr = cvar.RadioButtonNameStr def PreRadioBox(*args, **kwargs): """PreRadioBox() -> RadioBox""" @@ -1629,7 +1869,7 @@ class RadioButton(core.Control): """ __init__(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=wxPyRadioButtonNameStr) -> RadioButton + Validator validator=DefaultValidator, String name=RadioButtonNameStr) -> RadioButton """ newobj = _controls.new_RadioButton(*args, **kwargs) self.this = newobj.this @@ -1641,7 +1881,7 @@ class RadioButton(core.Control): """ Create(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=wxPyRadioButtonNameStr) -> bool + Validator validator=DefaultValidator, String name=RadioButtonNameStr) -> bool """ return _controls.RadioButton_Create(*args, **kwargs) @@ -1675,10 +1915,11 @@ class Slider(core.Control): def __init__(self, *args, **kwargs): """ __init__(Window parent, int id, int value, int minValue, int maxValue, - Point point=DefaultPosition, Size size=DefaultSize, + Point pos=DefaultPosition, Size size=DefaultSize, long style=SL_HORIZONTAL, Validator validator=DefaultValidator, - String name=wxPySliderNameStr) -> Slider + String name=SliderNameStr) -> Slider """ + if kwargs.has_key('point'): kwargs['pos'] = kwargs['point'] newobj = _controls.new_Slider(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1688,9 +1929,9 @@ class Slider(core.Control): def Create(*args, **kwargs): """ Create(Window parent, int id, int value, int minValue, int maxValue, - Point point=DefaultPosition, Size size=DefaultSize, + Point pos=DefaultPosition, Size size=DefaultSize, long style=SL_HORIZONTAL, Validator validator=DefaultValidator, - String name=wxPySliderNameStr) -> bool + String name=SliderNameStr) -> bool """ return _controls.Slider_Create(*args, **kwargs) @@ -1747,7 +1988,7 @@ class Slider(core.Control): return _controls.Slider_GetThumbLength(*args, **kwargs) def SetTickFreq(*args, **kwargs): - """SetTickFreq(int n, int pos)""" + """SetTickFreq(int n, int pos=1)""" return _controls.Slider_SetTickFreq(*args, **kwargs) def GetTickFreq(*args, **kwargs): @@ -1785,6 +2026,7 @@ class SliderPtr(Slider): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = Slider _controls.Slider_swigregister(SliderPtr) +SliderNameStr = cvar.SliderNameStr def PreSlider(*args, **kwargs): """PreSlider() -> Slider""" @@ -1804,7 +2046,7 @@ class ToggleButton(core.Control): """ __init__(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=wxPyToggleButtonNameStr) -> ToggleButton + Validator validator=DefaultValidator, String name=ToggleButtonNameStr) -> ToggleButton """ newobj = _controls.new_ToggleButton(*args, **kwargs) self.this = newobj.this @@ -1816,7 +2058,7 @@ class ToggleButton(core.Control): """ Create(Window parent, int id, String label, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=wxPyToggleButtonNameStr) -> bool + Validator validator=DefaultValidator, String name=ToggleButtonNameStr) -> bool """ return _controls.ToggleButton_Create(*args, **kwargs) @@ -1829,7 +2071,11 @@ class ToggleButton(core.Control): 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) @@ -1839,6 +2085,7 @@ class ToggleButtonPtr(ToggleButton): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = ToggleButton _controls.ToggleButton_swigregister(ToggleButtonPtr) +ToggleButtonNameStr = cvar.ToggleButtonNameStr def PreToggleButton(*args, **kwargs): """PreToggleButton() -> ToggleButton""" @@ -1873,17 +2120,15 @@ class BookCtrl(core.Control): return _controls.BookCtrl_GetPageText(*args, **kwargs) def SetImageList(*args, **kwargs): - """SetImageList(wxImageList imageList)""" + """SetImageList(ImageList imageList)""" return _controls.BookCtrl_SetImageList(*args, **kwargs) def AssignImageList(*args, **kwargs): - """AssignImageList(wxImageList imageList)""" - val = _controls.BookCtrl_AssignImageList(*args, **kwargs) - args[1].thisown = 0 - return val + """AssignImageList(ImageList imageList)""" + return _controls.BookCtrl_AssignImageList(*args, **kwargs) def GetImageList(*args, **kwargs): - """GetImageList() -> wxImageList""" + """GetImageList() -> ImageList""" return _controls.BookCtrl_GetImageList(*args, **kwargs) def GetPageImage(*args, **kwargs): @@ -1940,6 +2185,7 @@ class BookCtrlPtr(BookCtrl): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = BookCtrl _controls.BookCtrl_swigregister(BookCtrlPtr) +NOTEBOOK_NAME = cvar.NOTEBOOK_NAME class BookCtrlEvent(core.NotifyEvent): def __repr__(self): @@ -1995,7 +2241,7 @@ class Notebook(BookCtrl): def __init__(self, *args, **kwargs): """ __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=wxPyNOTEBOOK_NAME) -> Notebook + long style=0, String name=NOTEBOOK_NAME) -> Notebook """ newobj = _controls.new_Notebook(*args, **kwargs) self.this = newobj.this @@ -2006,7 +2252,7 @@ class Notebook(BookCtrl): def Create(*args, **kwargs): """ Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=wxPyNOTEBOOK_NAME) -> bool + long style=0, String name=NOTEBOOK_NAME) -> bool """ return _controls.Notebook_Create(*args, **kwargs) @@ -2026,7 +2272,7 @@ class Notebook(BookCtrl): """ HitTest(Point pt) -> (tab, where) - Returns the tab which is hit, and flags indicating where using wxNB_HITTEST_ flags. + Returns the tab which is hit, and flags indicating where using wx.NB_HITTEST_ flags. """ return _controls.Notebook_HitTest(*args, **kwargs) @@ -2882,6 +3128,7 @@ class ListItemAttrPtr(ListItemAttr): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = ListItemAttr _controls.ListItemAttr_swigregister(ListItemAttrPtr) +ListCtrlNameStr = cvar.ListCtrlNameStr #--------------------------------------------------------------------------- @@ -3171,7 +3418,7 @@ class ListCtrl(core.Control): """ __init__(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=LC_ICON, - Validator validator=DefaultValidator, String name=wxPyListCtrlNameStr) -> ListCtrl + Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListCtrl """ newobj = _controls.new_ListCtrl(*args, **kwargs) self.this = newobj.this @@ -3183,7 +3430,9 @@ class ListCtrl(core.Control): """ Create(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=LC_ICON, - Validator validator=DefaultValidator, String name=wxPyListCtrlNameStr) -> bool + Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool + + Do the 2nd phase and create the GUI control. """ return _controls.ListCtrl_Create(*args, **kwargs) @@ -3192,11 +3441,34 @@ class ListCtrl(core.Control): 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): @@ -3316,7 +3588,13 @@ class ListCtrl(core.Control): 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): @@ -3324,18 +3602,16 @@ class ListCtrl(core.Control): return _controls.ListCtrl_GetNextItem(*args, **kwargs) def GetImageList(*args, **kwargs): - """GetImageList(int which) -> wxImageList""" + """GetImageList(int which) -> ImageList""" return _controls.ListCtrl_GetImageList(*args, **kwargs) def SetImageList(*args, **kwargs): - """SetImageList(wxImageList imageList, int which)""" + """SetImageList(ImageList imageList, int which)""" return _controls.ListCtrl_SetImageList(*args, **kwargs) def AssignImageList(*args, **kwargs): - """AssignImageList(wxImageList imageList, int which)""" - val = _controls.ListCtrl_AssignImageList(*args, **kwargs) - args[1].thisown = 0 - return val + """AssignImageList(ImageList imageList, int which)""" + return _controls.ListCtrl_AssignImageList(*args, **kwargs) def IsVirtual(*args, **kwargs): """IsVirtual() -> bool""" @@ -3543,7 +3819,7 @@ class ListView(ListCtrl): """ __init__(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=LC_REPORT, - Validator validator=DefaultValidator, String name=wxPyListCtrlNameStr) -> ListView + Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListView """ newobj = _controls.new_ListView(*args, **kwargs) self.this = newobj.this @@ -3555,7 +3831,9 @@ class ListView(ListCtrl): """ Create(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=LC_REPORT, - Validator validator=DefaultValidator, String name=wxPyListCtrlNameStr) -> bool + Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool + + Do the 2nd phase and create the GUI control. """ return _controls.ListView_Create(*args, **kwargs) @@ -3681,6 +3959,7 @@ class TreeItemIdPtr(TreeItemId): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = TreeItemId _controls.TreeItemId_swigregister(TreeItemIdPtr) +TreeCtrlNameStr = cvar.TreeCtrlNameStr class TreeItemData(object): def __repr__(self): @@ -3845,7 +4124,7 @@ class TreeCtrl(core.Control): __init__(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=TR_DEFAULT_STYLE, Validator validator=DefaultValidator, - String name=wxPy_TreeCtrlNameStr) -> TreeCtrl + String name=TreeCtrlNameStr) -> TreeCtrl """ newobj = _controls.new_TreeCtrl(*args, **kwargs) self.this = newobj.this @@ -3858,7 +4137,9 @@ class TreeCtrl(core.Control): Create(Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=TR_DEFAULT_STYLE, Validator validator=DefaultValidator, - String name=wxPy_TreeCtrlNameStr) -> bool + String name=TreeCtrlNameStr) -> bool + + Do the 2nd phase and create the GUI control. """ return _controls.TreeCtrl_Create(*args, **kwargs) @@ -3887,32 +4168,28 @@ class TreeCtrl(core.Control): return _controls.TreeCtrl_SetSpacing(*args, **kwargs) def GetImageList(*args, **kwargs): - """GetImageList() -> wxImageList""" + """GetImageList() -> ImageList""" return _controls.TreeCtrl_GetImageList(*args, **kwargs) def GetStateImageList(*args, **kwargs): - """GetStateImageList() -> wxImageList""" + """GetStateImageList() -> ImageList""" return _controls.TreeCtrl_GetStateImageList(*args, **kwargs) def SetImageList(*args, **kwargs): - """SetImageList(wxImageList imageList)""" + """SetImageList(ImageList imageList)""" return _controls.TreeCtrl_SetImageList(*args, **kwargs) def SetStateImageList(*args, **kwargs): - """SetStateImageList(wxImageList imageList)""" + """SetStateImageList(ImageList imageList)""" return _controls.TreeCtrl_SetStateImageList(*args, **kwargs) def AssignImageList(*args, **kwargs): - """AssignImageList(wxImageList imageList)""" - val = _controls.TreeCtrl_AssignImageList(*args, **kwargs) - args[1].thisown = 0 - return val + """AssignImageList(ImageList imageList)""" + return _controls.TreeCtrl_AssignImageList(*args, **kwargs) def AssignStateImageList(*args, **kwargs): - """AssignStateImageList(wxImageList imageList)""" - val = _controls.TreeCtrl_AssignStateImageList(*args, **kwargs) - args[1].thisown = 0 - return val + """AssignStateImageList(ImageList imageList)""" + return _controls.TreeCtrl_AssignStateImageList(*args, **kwargs) def GetItemText(*args, **kwargs): """GetItemText(TreeItemId item) -> String""" @@ -4025,7 +4302,7 @@ class TreeCtrl(core.Control): return _controls.TreeCtrl_GetFirstChild(*args, **kwargs) def GetNextChild(*args, **kwargs): - """GetNextChild(TreeItemId item, wxTreeItemIdValue cookie) -> PyObject""" + """GetNextChild(TreeItemId item, void cookie) -> PyObject""" return _controls.TreeCtrl_GetNextChild(*args, **kwargs) def GetLastChild(*args, **kwargs): @@ -4116,14 +4393,22 @@ class TreeCtrl(core.Control): """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) @@ -4186,11 +4471,11 @@ class GenericDirCtrl(core.Control): return "<%s.%s; proxy of C++ wxGenericDirCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): """ - __init__(Window parent, int id=-1, String dir=wxPyDirDialogDefaultFolderStr, + __init__(Window parent, int id=-1, String dir=DirDialogDefaultFolderStr, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER, String filter=EmptyString, - int defaultFilter=0, String name=wxPy_TreeCtrlNameStr) -> GenericDirCtrl + int defaultFilter=0, String name=TreeCtrlNameStr) -> GenericDirCtrl """ newobj = _controls.new_GenericDirCtrl(*args, **kwargs) self.this = newobj.this @@ -4200,11 +4485,11 @@ class GenericDirCtrl(core.Control): def Create(*args, **kwargs): """ - Create(Window parent, int id=-1, String dir=wxPyDirDialogDefaultFolderStr, + Create(Window parent, int id=-1, String dir=DirDialogDefaultFolderStr, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER, String filter=EmptyString, - int defaultFilter=0, String name=wxPy_TreeCtrlNameStr) -> bool + int defaultFilter=0, String name=TreeCtrlNameStr) -> bool """ return _controls.GenericDirCtrl_Create(*args, **kwargs) @@ -4261,7 +4546,7 @@ class GenericDirCtrl(core.Control): return _controls.GenericDirCtrl_GetRootId(*args, **kwargs) def GetTreeCtrl(*args, **kwargs): - """GetTreeCtrl() -> wxTreeCtrl""" + """GetTreeCtrl() -> TreeCtrl""" return _controls.GenericDirCtrl_GetTreeCtrl(*args, **kwargs) def GetFilterListCtrl(*args, **kwargs): @@ -4294,6 +4579,7 @@ class GenericDirCtrlPtr(GenericDirCtrl): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = GenericDirCtrl _controls.GenericDirCtrl_swigregister(GenericDirCtrlPtr) +DirDialogDefaultFolderStr = cvar.DirDialogDefaultFolderStr def PreGenericDirCtrl(*args, **kwargs): """PreGenericDirCtrl() -> GenericDirCtrl""" @@ -4349,7 +4635,7 @@ class PyControl(core.Control): """ __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, - String name=wxPyControlNameStr) -> PyControl + String name=ControlNameStr) -> PyControl """ newobj = _controls.new_PyControl(*args, **kwargs) self.this = newobj.this @@ -4453,6 +4739,31 @@ EVT_DETAILED_HELP = wx.PyEventBinder( wxEVT_DETAILED_HELP, 1) 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): @@ -4462,27 +4773,53 @@ class HelpEvent(core.CommandEvent): 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) @@ -4494,10 +4831,39 @@ class HelpEventPtr(HelpEvent): _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 @@ -4509,11 +4875,26 @@ class ContextHelp(core.Object): 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) @@ -4525,12 +4906,27 @@ class ContextHelpPtr(ContextHelp): _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 @@ -4547,35 +4943,89 @@ class ContextHelpButtonPtr(ContextHelpButton): _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): - """HelpProvider.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): - """HelpProvider.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) @@ -4589,18 +5039,40 @@ class HelpProviderPtr(HelpProvider): _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 @@ -4670,7 +5142,7 @@ class DragImage(core.Object): return _controls.DragImage_DoDrawImage(*args, **kwargs) def UpdateBackingFromWindow(*args, **kwargs): - """UpdateBackingFromWindow(DC windowDC, wxMemoryDC destDC, Rect sourceRect, Rect destRect) -> bool""" + """UpdateBackingFromWindow(DC windowDC, MemoryDC destDC, Rect sourceRect, Rect destRect) -> bool""" return _controls.DragImage_UpdateBackingFromWindow(*args, **kwargs) def RedrawImage(*args, **kwargs): @@ -4686,7 +5158,7 @@ class DragImagePtr(DragImage): _controls.DragImage_swigregister(DragImagePtr) def DragIcon(*args, **kwargs): - """DragIcon(wxIcon image, Cursor cursor=wxNullCursor) -> DragImage""" + """DragIcon(Icon image, Cursor cursor=wxNullCursor) -> DragImage""" val = _controls.new_DragIcon(*args, **kwargs) val.thisown = 1 return val