X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/423f194a1411e8aac372de29ef4a7ab5f90acb04..3cebfef17b54f9dacc386f090827b8badb2773d2:/wxPython/src/msw/controls.py diff --git a/wxPython/src/msw/controls.py b/wxPython/src/msw/controls.py index 28796b0332..be2571c57e 100644 --- a/wxPython/src/msw/controls.py +++ b/wxPython/src/msw/controls.py @@ -14,14 +14,21 @@ BU_BOTTOM = _controls.BU_BOTTOM BU_EXACTFIT = _controls.BU_EXACTFIT BU_AUTODRAW = _controls.BU_AUTODRAW class Button(core.Control): - """""" + """ + 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. + """ 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__(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, - wxString name=wxPyButtonNameStr) -> Button""" + """ + __init__(Window parent, int id, String label, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, + Validator validator=DefaultValidator, String name=ButtonNameStr) -> Button + + Create and show a button. + """ newobj = _controls.new_Button(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -29,26 +36,25 @@ class Button(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, - wxString name=wxPyButtonNameStr) -> bool""" + """ + Create(Window parent, int id, String label, 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. + """ return _controls.Button_Create(*args, **kwargs) def SetDefault(*args, **kwargs): - """SetDefault()""" - return _controls.Button_SetDefault(*args, **kwargs) - - def SetImageLabel(*args, **kwargs): - """SetImageLabel(wxBitmap bitmap)""" - return _controls.Button_SetImageLabel(*args, **kwargs) + """ + SetDefault() - def SetImageMargins(*args, **kwargs): - """SetImageMargins(int x, int y)""" - return _controls.Button_SetImageMargins(*args, **kwargs) + This sets the button to be the default item for the panel or dialog box. + """ + return _controls.Button_SetDefault(*args, **kwargs) def GetDefaultSize(*args, **kwargs): - """Button.GetDefaultSize() -> Size""" + """GetDefaultSize() -> Size""" return _controls.Button_GetDefaultSize(*args, **kwargs) GetDefaultSize = staticmethod(GetDefaultSize) @@ -59,9 +65,15 @@ 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): - """PreButton() -> Button""" + """ + PreButton() -> Button + + Precreate a Button for 2-phase creation. + """ val = _controls.new_PreButton(*args, **kwargs) val.thisown = 1 return val @@ -71,14 +83,24 @@ def Button_GetDefaultSize(*args, **kwargs): return _controls.Button_GetDefaultSize(*args, **kwargs) class BitmapButton(Button): - """""" + """ + 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): - """__init__(Window parent, int id, wxBitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=BU_AUTODRAW, - Validator validator=DefaultValidator, - wxString name=wxPyButtonNameStr) -> BitmapButton""" + """ + __init__(Window parent, int id, Bitmap bitmap, 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. + """ newobj = _controls.new_BitmapButton(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -86,42 +108,79 @@ class BitmapButton(Button): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, wxBitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=BU_AUTODRAW, - Validator validator=DefaultValidator, - wxString name=wxPyButtonNameStr) -> bool""" + """ + Create(Window parent, int id, Bitmap bitmap, 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. + """ return _controls.BitmapButton_Create(*args, **kwargs) def GetBitmapLabel(*args, **kwargs): - """GetBitmapLabel() -> wxBitmap""" + """ + GetBitmapLabel() -> Bitmap + + Returns the label bitmap (the one passed to the constructor). + """ return _controls.BitmapButton_GetBitmapLabel(*args, **kwargs) def GetBitmapDisabled(*args, **kwargs): - """GetBitmapDisabled() -> wxBitmap""" + """ + GetBitmapDisabled() -> Bitmap + + Returns the bitmap for the disabled state. + """ return _controls.BitmapButton_GetBitmapDisabled(*args, **kwargs) def GetBitmapFocus(*args, **kwargs): - """GetBitmapFocus() -> wxBitmap""" + """ + GetBitmapFocus() -> Bitmap + + Returns the bitmap for the focused state. + """ return _controls.BitmapButton_GetBitmapFocus(*args, **kwargs) def GetBitmapSelected(*args, **kwargs): - """GetBitmapSelected() -> wxBitmap""" + """ + GetBitmapSelected() -> Bitmap + + Returns the bitmap for the selected state. + """ return _controls.BitmapButton_GetBitmapSelected(*args, **kwargs) def SetBitmapDisabled(*args, **kwargs): - """SetBitmapDisabled(wxBitmap bitmap)""" + """ + SetBitmapDisabled(Bitmap bitmap) + + Sets the bitmap for the disabled button appearance. + """ return _controls.BitmapButton_SetBitmapDisabled(*args, **kwargs) def SetBitmapFocus(*args, **kwargs): - """SetBitmapFocus(wxBitmap bitmap)""" + """ + SetBitmapFocus(Bitmap bitmap) + + Sets the bitmap for the button appearance when it has the keyboard focus. + """ return _controls.BitmapButton_SetBitmapFocus(*args, **kwargs) def SetBitmapSelected(*args, **kwargs): - """SetBitmapSelected(wxBitmap bitmap)""" + """ + SetBitmapSelected(Bitmap bitmap) + + Sets the bitmap for the selected (depressed) button appearance. + """ return _controls.BitmapButton_SetBitmapSelected(*args, **kwargs) def SetBitmapLabel(*args, **kwargs): - """SetBitmapLabel(wxBitmap bitmap)""" + """ + SetBitmapLabel(Bitmap bitmap) + + Sets the bitmap label for the button. This is the bitmap used for the + unselected state, and for all other states if no other bitmaps are provided. + """ return _controls.BitmapButton_SetBitmapLabel(*args, **kwargs) def SetMargins(*args, **kwargs): @@ -145,7 +204,11 @@ class BitmapButtonPtr(BitmapButton): _controls.BitmapButton_swigregister(BitmapButtonPtr) def PreBitmapButton(*args, **kwargs): - """PreBitmapButton() -> BitmapButton""" + """ + PreBitmapButton() -> BitmapButton + + Precreate a BitmapButton for 2-phase creation. + """ val = _controls.new_PreBitmapButton(*args, **kwargs) val.thisown = 1 return val @@ -159,14 +222,22 @@ 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, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, - wxString name=wxPyCheckBoxNameStr) -> CheckBox""" + """ + __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 self.thisown = 1 @@ -174,38 +245,77 @@ class CheckBox(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, - wxString name=wxPyCheckBoxNameStr) -> bool""" + """ + 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() -> wxCheckBoxState""" + """ + 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(wxCheckBoxState 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) @@ -215,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 @@ -225,14 +340,20 @@ 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, wxString choices_array=None, - long style=0, Validator validator=DefaultValidator, - wxString 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 self.thisown = 1 @@ -240,32 +361,40 @@ class Choice(core.ControlWithItems): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, wxString choices_array=None, - long style=0, Validator validator=DefaultValidator, - wxString name=wxPyChoiceNameStr) -> bool""" - return _controls.Choice_Create(*args, **kwargs) + """ + Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + List choices=[], long style=0, Validator validator=DefaultValidator, + String name=ChoiceNameStr) -> bool - 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) + Actually create the GUI Choice control for 2-phase creation + """ + return _controls.Choice_Create(*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(wxString string)""" + """ + SetStringSelection(String string) + + Select the item with the specifed string + """ return _controls.Choice_SetStringSelection(*args, **kwargs) def SetString(*args, **kwargs): - """SetString(int n, wxString 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): @@ -273,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 @@ -283,15 +417,22 @@ def PreChoice(*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. + """ 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, wxString value=wxPyEmptyString, - Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, wxString choices_array=None, - long style=0, Validator validator=DefaultValidator, - wxString 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 self.thisown = 1 @@ -299,49 +440,93 @@ class ComboBox(Choice): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, wxString value=wxPyEmptyString, - Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, wxString choices_array=None, - long style=0, Validator validator=DefaultValidator, - wxString 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() -> wxString""" + """ + GetValue() -> String + + Returns the current value in the combobox text field. + """ return _controls.ComboBox_GetValue(*args, **kwargs) def SetValue(*args, **kwargs): - """SetValue(wxString value)""" + """SetValue(String value)""" 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, wxString 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) + + Selects the text between the two positions, in the combobox text field. + """ + return _controls.ComboBox_SetSelection(*args, **kwargs) + def SetMark(*args, **kwargs): """SetMark(long from, long to)""" return _controls.ComboBox_SetMark(*args, **kwargs) @@ -351,11 +536,19 @@ class ComboBox(Choice): 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) @@ -365,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 @@ -379,14 +577,15 @@ GA_VERTICAL = _controls.GA_VERTICAL GA_SMOOTH = _controls.GA_SMOOTH GA_PROGRESSBAR = _controls.GA_PROGRESSBAR class Gauge(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxGauge instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id, int range, Point pos=DefaultPosition, - Size size=DefaultSize, long style=GA_HORIZONTAL, - Validator validator=DefaultValidator, - wxString name=wxPyGaugeNameStr) -> Gauge""" + """ + __init__(Window parent, int id, int range, Point pos=DefaultPosition, + Size size=DefaultSize, long style=GA_HORIZONTAL, + Validator validator=DefaultValidator, + String name=GaugeNameStr) -> Gauge + """ newobj = _controls.new_Gauge(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -394,10 +593,12 @@ class Gauge(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, int range, Point pos=DefaultPosition, - Size size=DefaultSize, long style=GA_HORIZONTAL, - Validator validator=DefaultValidator, - wxString name=wxPyGaugeNameStr) -> bool""" + """ + Create(Window parent, int id, int range, Point pos=DefaultPosition, + Size size=DefaultSize, long style=GA_HORIZONTAL, + Validator validator=DefaultValidator, + String name=GaugeNameStr) -> bool + """ return _controls.Gauge_Create(*args, **kwargs) def SetRange(*args, **kwargs): @@ -443,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""" @@ -453,13 +655,14 @@ def PreGauge(*args, **kwargs): #--------------------------------------------------------------------------- class StaticBox(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxStaticBox instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - wxString name=wxPyStaticBoxNameStr) -> StaticBox""" + """ + __init__(Window parent, int id, String label, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, + String name=StaticBoxNameStr) -> StaticBox + """ newobj = _controls.new_StaticBox(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -467,9 +670,11 @@ class StaticBox(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - wxString name=wxPyStaticBoxNameStr) -> bool""" + """ + Create(Window parent, int id, String label, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, + String name=StaticBoxNameStr) -> bool + """ return _controls.StaticBox_Create(*args, **kwargs) @@ -479,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""" @@ -489,13 +697,14 @@ def PreStaticBox(*args, **kwargs): #--------------------------------------------------------------------------- class StaticLine(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxStaticLine 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, - long style=LI_HORIZONTAL, - wxString name=wxPyStaticTextNameStr) -> StaticLine""" + """ + __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + long style=LI_HORIZONTAL, + String name=StaticTextNameStr) -> StaticLine + """ newobj = _controls.new_StaticLine(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -503,9 +712,11 @@ class StaticLine(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=LI_HORIZONTAL, - wxString name=wxPyStaticTextNameStr) -> bool""" + """ + Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + long style=LI_HORIZONTAL, + String name=StaticTextNameStr) -> bool + """ return _controls.StaticLine_Create(*args, **kwargs) def IsVertical(*args, **kwargs): @@ -513,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) @@ -538,13 +749,14 @@ def StaticLine_GetDefaultSize(*args, **kwargs): #--------------------------------------------------------------------------- class StaticText(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxStaticText instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - wxString name=wxPyStaticTextNameStr) -> StaticText""" + """ + __init__(Window parent, int id, String label, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, + String name=StaticTextNameStr) -> StaticText + """ newobj = _controls.new_StaticText(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -552,9 +764,11 @@ class StaticText(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - wxString name=wxPyStaticTextNameStr) -> bool""" + """ + Create(Window parent, int id, String label, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, + String name=StaticTextNameStr) -> bool + """ return _controls.StaticText_Create(*args, **kwargs) @@ -574,33 +788,38 @@ def PreStaticText(*args, **kwargs): #--------------------------------------------------------------------------- class StaticBitmap(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxStaticBitmap instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id, wxBitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - wxString name=wxPyStaticBitmapNameStr) -> StaticBitmap""" + """ + __init__(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, + String name=StaticBitmapNameStr) -> StaticBitmap + """ newobj = _controls.new_StaticBitmap(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown + self._setOORInfo(self) + def Create(*args, **kwargs): - """Create(Window parent, int id, wxBitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - wxString name=wxPyStaticBitmapNameStr) -> bool""" + """ + Create(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, + String name=StaticBitmapNameStr) -> bool + """ return _controls.StaticBitmap_Create(*args, **kwargs) def GetBitmap(*args, **kwargs): - """GetBitmap() -> wxBitmap""" + """GetBitmap() -> Bitmap""" return _controls.StaticBitmap_GetBitmap(*args, **kwargs) def SetBitmap(*args, **kwargs): - """SetBitmap(wxBitmap bitmap)""" + """SetBitmap(Bitmap bitmap)""" return _controls.StaticBitmap_SetBitmap(*args, **kwargs) def SetIcon(*args, **kwargs): - """SetIcon(wxIcon icon)""" + """SetIcon(Icon icon)""" return _controls.StaticBitmap_SetIcon(*args, **kwargs) @@ -620,14 +839,15 @@ def PreStaticBitmap(*args, **kwargs): #--------------------------------------------------------------------------- class ListBox(core.ControlWithItems): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxListBox 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, wxString choices_array=None, - long style=0, Validator validator=DefaultValidator, - wxString name=wxPyListBoxNameStr) -> ListBox""" + """ + __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + wxArrayString choices=wxPyEmptyStringArray, + long style=0, Validator validator=DefaultValidator, + String name=ListBoxNameStr) -> ListBox + """ newobj = _controls.new_ListBox(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -635,14 +855,21 @@ class ListBox(core.ControlWithItems): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, wxString choices_array=None, - long style=0, Validator validator=DefaultValidator, - wxString name=wxPyListBoxNameStr) -> bool""" + """ + Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + wxArrayString choices=wxPyEmptyStringArray, + long style=0, Validator validator=DefaultValidator, + String name=ListBoxNameStr) -> bool + """ return _controls.ListBox_Create(*args, **kwargs) def Insert(*args, **kwargs): - """Insert(wxString 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): @@ -662,7 +889,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): @@ -674,7 +905,7 @@ class ListBox(core.ControlWithItems): return _controls.ListBox_DeselectAll(*args, **kwargs) def SetStringSelection(*args, **kwargs): - """SetStringSelection(wxString s, bool select=True) -> bool""" + """SetStringSelection(String s, bool select=True) -> bool""" return _controls.ListBox_SetStringSelection(*args, **kwargs) def GetSelections(*args, **kwargs): @@ -686,7 +917,7 @@ class ListBox(core.ControlWithItems): return _controls.ListBox_SetFirstItem(*args, **kwargs) def SetFirstItemStr(*args, **kwargs): - """SetFirstItemStr(wxString s)""" + """SetFirstItemStr(String s)""" return _controls.ListBox_SetFirstItemStr(*args, **kwargs) def EnsureVisible(*args, **kwargs): @@ -694,13 +925,25 @@ class ListBox(core.ControlWithItems): return _controls.ListBox_EnsureVisible(*args, **kwargs) def AppendAndEnsureVisible(*args, **kwargs): - """AppendAndEnsureVisible(wxString s)""" + """AppendAndEnsureVisible(String s)""" return _controls.ListBox_AppendAndEnsureVisible(*args, **kwargs) def IsSorted(*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): @@ -708,6 +951,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""" @@ -718,23 +962,28 @@ def PreListBox(*args, **kwargs): #--------------------------------------------------------------------------- class CheckListBox(ListBox): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxCheckListBox 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, wxString choices_array=None, - long style=0, Validator validator=DefaultValidator, - wxString name=wxPyListBoxNameStr) -> CheckListBox""" + """ + __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + wxArrayString choices=wxPyEmptyStringArray, + long style=0, Validator validator=DefaultValidator, + 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, wxString choices_array=None, - long style=0, Validator validator=DefaultValidator, - wxString name=wxPyListBoxNameStr) -> bool""" + """ + Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + wxArrayString choices=wxPyEmptyStringArray, + long style=0, Validator validator=DefaultValidator, + String name=ListBoxNameStr) -> bool + """ return _controls.CheckListBox_Create(*args, **kwargs) def IsChecked(*args, **kwargs): @@ -750,11 +999,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) @@ -809,36 +1066,48 @@ 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,) def __init__(self, *args): - """__init__() -> TextAttr -__init__(wxColour colText, wxColour colBack=wxNullColour, wxFont font=wxNullFont, - wxTextAttrAlignment alignment=TEXT_ALIGNMENT_DEFAULT) -> TextAttr""" + """ + __init__() -> TextAttr + __init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, + int alignment=TEXT_ALIGNMENT_DEFAULT) -> TextAttr + """ newobj = _controls.new_TextAttr(*args) 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) def SetTextColour(*args, **kwargs): - """SetTextColour(wxColour colText)""" + """SetTextColour(Colour colText)""" return _controls.TextAttr_SetTextColour(*args, **kwargs) def SetBackgroundColour(*args, **kwargs): - """SetBackgroundColour(wxColour colBack)""" + """SetBackgroundColour(Colour colBack)""" return _controls.TextAttr_SetBackgroundColour(*args, **kwargs) def SetFont(*args, **kwargs): - """SetFont(wxFont font, long flags=TEXT_ATTR_FONT)""" + """SetFont(Font font, long flags=TEXT_ATTR_FONT)""" return _controls.TextAttr_SetFont(*args, **kwargs) def SetAlignment(*args, **kwargs): - """SetAlignment(wxTextAttrAlignment alignment)""" + """SetAlignment(int alignment)""" return _controls.TextAttr_SetAlignment(*args, **kwargs) def SetTabs(*args, **kwargs): @@ -890,19 +1159,19 @@ __init__(wxColour colText, wxColour colBack=wxNullColour, wxFont font=wxNullFont return _controls.TextAttr_HasFlag(*args, **kwargs) def GetTextColour(*args, **kwargs): - """GetTextColour() -> wxColour""" + """GetTextColour() -> Colour""" return _controls.TextAttr_GetTextColour(*args, **kwargs) def GetBackgroundColour(*args, **kwargs): - """GetBackgroundColour() -> wxColour""" + """GetBackgroundColour() -> Colour""" return _controls.TextAttr_GetBackgroundColour(*args, **kwargs) def GetFont(*args, **kwargs): - """GetFont() -> wxFont""" + """GetFont() -> Font""" return _controls.TextAttr_GetFont(*args, **kwargs) def GetAlignment(*args, **kwargs): - """GetAlignment() -> wxTextAttrAlignment""" + """GetAlignment() -> int""" return _controls.TextAttr_GetAlignment(*args, **kwargs) def GetTabs(*args, **kwargs): @@ -926,7 +1195,7 @@ __init__(wxColour colText, wxColour colBack=wxNullColour, wxFont font=wxNullFont 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) @@ -937,20 +1206,22 @@ 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""" return _controls.TextAttr_Combine(*args, **kwargs) class TextCtrl(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxTextCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id, wxString value=wxPyEmptyString, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, - wxString name=wxPyTextCtrlNameStr) -> TextCtrl""" + """ + __init__(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, + Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=TextCtrlNameStr) -> TextCtrl + """ newobj = _controls.new_TextCtrl(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -958,22 +1229,24 @@ class TextCtrl(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, wxString value=wxPyEmptyString, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, - wxString name=wxPyTextCtrlNameStr) -> bool""" + """ + Create(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, + Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=TextCtrlNameStr) -> bool + """ return _controls.TextCtrl_Create(*args, **kwargs) def GetValue(*args, **kwargs): - """GetValue() -> wxString""" + """GetValue() -> String""" return _controls.TextCtrl_GetValue(*args, **kwargs) def SetValue(*args, **kwargs): - """SetValue(wxString value)""" + """SetValue(String value)""" return _controls.TextCtrl_SetValue(*args, **kwargs) def GetRange(*args, **kwargs): - """GetRange(long from, long to) -> wxString""" + """GetRange(long from, long to) -> String""" return _controls.TextCtrl_GetRange(*args, **kwargs) def GetLineLength(*args, **kwargs): @@ -981,7 +1254,7 @@ class TextCtrl(core.Control): return _controls.TextCtrl_GetLineLength(*args, **kwargs) def GetLineText(*args, **kwargs): - """GetLineText(long lineNo) -> wxString""" + """GetLineText(long lineNo) -> String""" return _controls.TextCtrl_GetLineText(*args, **kwargs) def GetNumberOfLines(*args, **kwargs): @@ -1005,11 +1278,15 @@ class TextCtrl(core.Control): return _controls.TextCtrl_IsMultiLine(*args, **kwargs) def GetSelection(*args, **kwargs): - """GetSelection(long OUTPUT, long OUTPUT)""" + """ + GetSelection() -> (from, to) + + If the return values from and to are the same, there is no selection. + """ return _controls.TextCtrl_GetSelection(*args, **kwargs) def GetStringSelection(*args, **kwargs): - """GetStringSelection() -> wxString""" + """GetStringSelection() -> String""" return _controls.TextCtrl_GetStringSelection(*args, **kwargs) def Clear(*args, **kwargs): @@ -1017,7 +1294,7 @@ class TextCtrl(core.Control): return _controls.TextCtrl_Clear(*args, **kwargs) def Replace(*args, **kwargs): - """Replace(long from, long to, wxString value)""" + """Replace(long from, long to, String value)""" return _controls.TextCtrl_Replace(*args, **kwargs) def Remove(*args, **kwargs): @@ -1025,11 +1302,11 @@ class TextCtrl(core.Control): return _controls.TextCtrl_Remove(*args, **kwargs) def LoadFile(*args, **kwargs): - """LoadFile(wxString file) -> bool""" + """LoadFile(String file) -> bool""" return _controls.TextCtrl_LoadFile(*args, **kwargs) def SaveFile(*args, **kwargs): - """SaveFile(wxString file=wxPyEmptyString) -> bool""" + """SaveFile(String file=EmptyString) -> bool""" return _controls.TextCtrl_SaveFile(*args, **kwargs) def MarkDirty(*args, **kwargs): @@ -1045,11 +1322,11 @@ class TextCtrl(core.Control): return _controls.TextCtrl_SetMaxLength(*args, **kwargs) def WriteText(*args, **kwargs): - """WriteText(wxString text)""" + """WriteText(String text)""" return _controls.TextCtrl_WriteText(*args, **kwargs) def AppendText(*args, **kwargs): - """AppendText(wxString text)""" + """AppendText(String text)""" return _controls.TextCtrl_AppendText(*args, **kwargs) def EmulateKeyPress(*args, **kwargs): @@ -1077,13 +1354,23 @@ class TextCtrl(core.Control): return _controls.TextCtrl_XYToPosition(*args, **kwargs) def PositionToXY(*args, **kwargs): - """PositionToXY(long pos, long OUTPUT, long OUTPUT)""" + """PositionToXY(long pos) -> (x, y)""" return _controls.TextCtrl_PositionToXY(*args, **kwargs) def ShowPosition(*args, **kwargs): """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) @@ -1161,11 +1448,11 @@ class TextCtrl(core.Control): return _controls.TextCtrl_HideNativeCaret(*args, **kwargs) def write(*args, **kwargs): - """write(wxString text)""" + """write(String text)""" return _controls.TextCtrl_write(*args, **kwargs) def GetString(*args, **kwargs): - """GetString(long from, long to) -> wxString""" + """GetString(long from, long to) -> String""" return _controls.TextCtrl_GetString(*args, **kwargs) @@ -1187,7 +1474,6 @@ wxEVT_COMMAND_TEXT_ENTER = _controls.wxEVT_COMMAND_TEXT_ENTER wxEVT_COMMAND_TEXT_URL = _controls.wxEVT_COMMAND_TEXT_URL wxEVT_COMMAND_TEXT_MAXLEN = _controls.wxEVT_COMMAND_TEXT_MAXLEN class TextUrlEvent(core.CommandEvent): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxTextUrlEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1224,13 +1510,14 @@ EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) #--------------------------------------------------------------------------- class ScrollBar(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxScrollBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=SB_HORIZONTAL, - Validator validator=DefaultValidator, wxString name=wxPyScrollBarNameStr) -> ScrollBar""" + """ + __init__(Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=SB_HORIZONTAL, + Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> ScrollBar + """ newobj = _controls.new_ScrollBar(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1238,9 +1525,13 @@ class ScrollBar(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=SB_HORIZONTAL, - Validator validator=DefaultValidator, wxString name=wxPyScrollBarNameStr) -> bool""" + """ + 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) def GetThumbPosition(*args, **kwargs): @@ -1269,8 +1560,24 @@ class ScrollBar(core.Control): return _controls.ScrollBar_SetThumbPosition(*args, **kwargs) def SetScrollbar(*args, **kwargs): - """SetScrollbar(int position, int thumbSize, int range, int pageSize, - bool refresh=True)""" + """ + 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) @@ -1280,6 +1587,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""" @@ -1294,13 +1602,14 @@ SP_VERTICAL = _controls.SP_VERTICAL SP_ARROW_KEYS = _controls.SP_ARROW_KEYS SP_WRAP = _controls.SP_WRAP class SpinButton(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxSpinButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=SP_HORIZONTAL, - wxString name=wxPySPIN_BUTTON_NAME) -> SpinButton""" + """ + __init__(Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=SP_HORIZONTAL, + String name=SPIN_BUTTON_NAME) -> SpinButton + """ newobj = _controls.new_SpinButton(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1308,9 +1617,11 @@ class SpinButton(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=SP_HORIZONTAL, - wxString name=wxPySPIN_BUTTON_NAME) -> bool""" + """ + Create(Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=SP_HORIZONTAL, + String name=SPIN_BUTTON_NAME) -> bool + """ return _controls.SpinButton_Create(*args, **kwargs) def GetValue(*args, **kwargs): @@ -1352,6 +1663,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""" @@ -1360,14 +1673,15 @@ def PreSpinButton(*args, **kwargs): return val class SpinCtrl(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxSpinCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id=-1, wxString value=wxPyEmptyString, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=SP_ARROW_KEYS, int min=0, - int max=100, int initial=0, wxString name=wxPySpinCtrlNameStr) -> SpinCtrl""" + """ + __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=SpinCtrlNameStr) -> SpinCtrl + """ newobj = _controls.new_SpinCtrl(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1375,10 +1689,12 @@ class SpinCtrl(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id=-1, wxString value=wxPyEmptyString, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=SP_ARROW_KEYS, int min=0, - int max=100, int initial=0, wxString name=wxPySpinCtrlNameStr) -> bool""" + """ + 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=SpinCtrlNameStr) -> bool + """ return _controls.SpinCtrl_Create(*args, **kwargs) def GetValue(*args, **kwargs): @@ -1390,7 +1706,7 @@ class SpinCtrl(core.Control): return _controls.SpinCtrl_SetValue(*args, **kwargs) def SetValueString(*args, **kwargs): - """SetValueString(wxString text)""" + """SetValueString(String text)""" return _controls.SpinCtrl_SetValueString(*args, **kwargs) def SetRange(*args, **kwargs): @@ -1423,21 +1739,51 @@ 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) #--------------------------------------------------------------------------- class RadioBox(core.Control): - """""" def __repr__(self): 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, wxString label, Point point=DefaultPosition, - Size size=DefaultSize, int choices=0, - wxString choices_array=None, int majorDimension=0, - long style=RA_HORIZONTAL, Validator validator=DefaultValidator, - wxString name=wxPyRadioBoxNameStr) -> RadioBox""" + """ + __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=RadioBoxNameStr) -> RadioBox + """ + if kwargs.has_key('point'): kwargs['pos'] = kwargs['point'] newobj = _controls.new_RadioBox(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1445,11 +1791,13 @@ class RadioBox(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, wxString label, Point point=DefaultPosition, - Size size=DefaultSize, int choices=0, - wxString choices_array=None, int majorDimension=0, - long style=RA_HORIZONTAL, Validator validator=DefaultValidator, - wxString name=wxPyRadioBoxNameStr) -> bool""" + """ + 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=RadioBoxNameStr) -> bool + """ return _controls.RadioBox_Create(*args, **kwargs) def SetSelection(*args, **kwargs): @@ -1461,11 +1809,11 @@ class RadioBox(core.Control): return _controls.RadioBox_GetSelection(*args, **kwargs) def GetStringSelection(*args, **kwargs): - """GetStringSelection() -> wxString""" + """GetStringSelection() -> String""" return _controls.RadioBox_GetStringSelection(*args, **kwargs) def SetStringSelection(*args, **kwargs): - """SetStringSelection(wxString s) -> bool""" + """SetStringSelection(String s) -> bool""" return _controls.RadioBox_SetStringSelection(*args, **kwargs) def GetCount(*args, **kwargs): @@ -1473,15 +1821,15 @@ class RadioBox(core.Control): return _controls.RadioBox_GetCount(*args, **kwargs) def FindString(*args, **kwargs): - """FindString(wxString s) -> int""" + """FindString(String s) -> int""" return _controls.RadioBox_FindString(*args, **kwargs) def GetString(*args, **kwargs): - """GetString(int n) -> wxString""" + """GetString(int n) -> String""" return _controls.RadioBox_GetString(*args, **kwargs) def SetString(*args, **kwargs): - """SetString(int n, wxString label)""" + """SetString(int n, String label)""" return _controls.RadioBox_SetString(*args, **kwargs) GetItemLabel = GetString @@ -1503,7 +1851,7 @@ class RadioBox(core.Control): return _controls.RadioBox_GetRowCount(*args, **kwargs) def GetNextItem(*args, **kwargs): - """GetNextItem(int item, wxDirection dir, long style) -> int""" + """GetNextItem(int item, int dir, long style) -> int""" return _controls.RadioBox_GetNextItem(*args, **kwargs) @@ -1513,6 +1861,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""" @@ -1523,14 +1873,14 @@ def PreRadioBox(*args, **kwargs): #--------------------------------------------------------------------------- class RadioButton(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxRadioButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, - wxString name=wxPyRadioButtonNameStr) -> RadioButton""" + """ + __init__(Window parent, int id, String label, 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 self.thisown = 1 @@ -1538,10 +1888,11 @@ class RadioButton(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, - wxString name=wxPyRadioButtonNameStr) -> bool""" + """ + Create(Window parent, int id, String label, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, + Validator validator=DefaultValidator, String name=RadioButtonNameStr) -> bool + """ return _controls.RadioButton_Create(*args, **kwargs) def GetValue(*args, **kwargs): @@ -1569,14 +1920,16 @@ def PreRadioButton(*args, **kwargs): #--------------------------------------------------------------------------- class Slider(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxSlider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id, int value, int minValue, int maxValue, - Point point=DefaultPosition, Size size=DefaultSize, - long style=SL_HORIZONTAL, Validator validator=DefaultValidator, - wxString name=wxPySliderNameStr) -> Slider""" + """ + __init__(Window parent, int id, int value, int minValue, int maxValue, + 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'] newobj = _controls.new_Slider(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1584,10 +1937,12 @@ class Slider(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, int value, int minValue, int maxValue, - Point point=DefaultPosition, Size size=DefaultSize, - long style=SL_HORIZONTAL, Validator validator=DefaultValidator, - wxString name=wxPySliderNameStr) -> bool""" + """ + Create(Window parent, int id, int value, int minValue, int maxValue, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=SL_HORIZONTAL, Validator validator=DefaultValidator, + String name=SliderNameStr) -> bool + """ return _controls.Slider_Create(*args, **kwargs) def GetValue(*args, **kwargs): @@ -1643,7 +1998,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): @@ -1681,6 +2036,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""" @@ -1694,14 +2050,14 @@ wxEVT_COMMAND_TOGGLEBUTTON_CLICKED = _controls.wxEVT_COMMAND_TOGGLEBUTTON_CLICKE EVT_TOGGLEBUTTON = wx.PyEventBinder( wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, 1) class ToggleButton(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxToggleButton instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, - wxString name=wxPyToggleButtonNameStr) -> ToggleButton""" + """ + __init__(Window parent, int id, String label, 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 self.thisown = 1 @@ -1709,10 +2065,11 @@ class ToggleButton(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, wxString label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, - wxString name=wxPyToggleButtonNameStr) -> bool""" + """ + Create(Window parent, int id, String label, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, + Validator validator=DefaultValidator, String name=ToggleButtonNameStr) -> bool + """ return _controls.ToggleButton_Create(*args, **kwargs) def SetValue(*args, **kwargs): @@ -1724,7 +2081,11 @@ class ToggleButton(core.Control): return _controls.ToggleButton_GetValue(*args, **kwargs) def SetLabel(*args, **kwargs): - """SetLabel(wxString label)""" + """ + SetLabel(String label) + + Sets the item's text. + """ return _controls.ToggleButton_SetLabel(*args, **kwargs) @@ -1734,6 +2095,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""" @@ -1744,7 +2106,6 @@ def PreToggleButton(*args, **kwargs): #--------------------------------------------------------------------------- class BookCtrl(core.Control): - """""" def __init__(self): raise RuntimeError, "No constructor defined" def __repr__(self): return "<%s.%s; proxy of C++ wxBookCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) @@ -1761,25 +2122,23 @@ class BookCtrl(core.Control): return _controls.BookCtrl_GetSelection(*args, **kwargs) def SetPageText(*args, **kwargs): - """SetPageText(size_t n, wxString strText) -> bool""" + """SetPageText(size_t n, String strText) -> bool""" return _controls.BookCtrl_SetPageText(*args, **kwargs) def GetPageText(*args, **kwargs): - """GetPageText(size_t n) -> wxString""" + """GetPageText(size_t n) -> String""" 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): @@ -1811,12 +2170,14 @@ class BookCtrl(core.Control): return _controls.BookCtrl_DeleteAllPages(*args, **kwargs) def AddPage(*args, **kwargs): - """AddPage(Window page, wxString text, bool select=False, int imageId=-1) -> bool""" + """AddPage(Window page, String text, bool select=False, int imageId=-1) -> bool""" return _controls.BookCtrl_AddPage(*args, **kwargs) def InsertPage(*args, **kwargs): - """InsertPage(size_t n, Window page, wxString text, bool select=False, - int imageId=-1) -> bool""" + """ + InsertPage(size_t n, Window page, String text, bool select=False, + int imageId=-1) -> bool + """ return _controls.BookCtrl_InsertPage(*args, **kwargs) def SetSelection(*args, **kwargs): @@ -1834,14 +2195,16 @@ 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): return "<%s.%s; proxy of C++ wxBookCtrlEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, - int nOldSel=-1) -> BookCtrlEvent""" + """ + __init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, + int nOldSel=-1) -> BookCtrlEvent + """ newobj = _controls.new_BookCtrlEvent(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1883,12 +2246,13 @@ NB_HITTEST_ONICON = _controls.NB_HITTEST_ONICON NB_HITTEST_ONLABEL = _controls.NB_HITTEST_ONLABEL NB_HITTEST_ONITEM = _controls.NB_HITTEST_ONITEM class Notebook(BookCtrl): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxNotebook 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, - long style=0, wxString name=wxPyNOTEBOOK_NAME) -> Notebook""" + """ + __init__(Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=NOTEBOOK_NAME) -> Notebook + """ newobj = _controls.new_Notebook(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -1896,8 +2260,10 @@ class Notebook(BookCtrl): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, wxString name=wxPyNOTEBOOK_NAME) -> bool""" + """ + Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=NOTEBOOK_NAME) -> bool + """ return _controls.Notebook_Create(*args, **kwargs) def GetRowCount(*args, **kwargs): @@ -1913,7 +2279,11 @@ class Notebook(BookCtrl): return _controls.Notebook_SetTabSize(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point pt, long OUTPUT) -> int""" + """ + HitTest(Point pt) -> (tab, where) + + Returns the tab which is hit, and flags indicating where using wx.NB_HITTEST_ flags. + """ return _controls.Notebook_HitTest(*args, **kwargs) def CalcSizeFromPage(*args, **kwargs): @@ -1921,7 +2291,7 @@ class Notebook(BookCtrl): return _controls.Notebook_CalcSizeFromPage(*args, **kwargs) def ApplyThemeBackground(*args, **kwargs): - """ApplyThemeBackground(Window window, wxColour colour)""" + """ApplyThemeBackground(Window window, Colour colour)""" return _controls.Notebook_ApplyThemeBackground(*args, **kwargs) @@ -1939,12 +2309,13 @@ def PreNotebook(*args, **kwargs): return val class NotebookEvent(BookCtrlEvent): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxNotebookEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, - int nOldSel=-1) -> NotebookEvent""" + """ + __init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, + int nOldSel=-1) -> NotebookEvent + """ newobj = _controls.new_NotebookEvent(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -2002,12 +2373,13 @@ LB_LEFT = _controls.LB_LEFT LB_RIGHT = _controls.LB_RIGHT LB_ALIGN_MASK = _controls.LB_ALIGN_MASK class Listbook(BookCtrl): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxListbook 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, - long style=0, wxString name=wxPyEmptyString) -> Listbook""" + """ + __init__(Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=EmptyString) -> Listbook + """ newobj = _controls.new_Listbook(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -2015,8 +2387,10 @@ class Listbook(BookCtrl): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, wxString name=wxPyEmptyString) -> bool""" + """ + Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=EmptyString) -> bool + """ return _controls.Listbook_Create(*args, **kwargs) def IsVertical(*args, **kwargs): @@ -2038,12 +2412,13 @@ def PreListbook(*args, **kwargs): return val class ListbookEvent(BookCtrlEvent): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxListbookEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, - int nOldSel=-1) -> ListbookEvent""" + """ + __init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, + int nOldSel=-1) -> ListbookEvent + """ newobj = _controls.new_ListbookEvent(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -2064,7 +2439,6 @@ EVT_LISTBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANG #--------------------------------------------------------------------------- class BookCtrlSizer(core.Sizer): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxBookCtrlSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -2096,7 +2470,6 @@ class BookCtrlSizerPtr(BookCtrlSizer): _controls.BookCtrlSizer_swigregister(BookCtrlSizerPtr) class NotebookSizer(core.Sizer): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxNotebookSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -2144,7 +2517,6 @@ TB_NOALIGN = _controls.TB_NOALIGN TB_HORZ_LAYOUT = _controls.TB_HORZ_LAYOUT TB_HORZ_TEXT = _controls.TB_HORZ_TEXT class ToolBarToolBase(core.Object): - """""" def __init__(self): raise RuntimeError, "No constructor defined" def __repr__(self): return "<%s.%s; proxy of C++ wxToolBarToolBase instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) @@ -2177,7 +2549,7 @@ class ToolBarToolBase(core.Object): return _controls.ToolBarToolBase_GetStyle(*args, **kwargs) def GetKind(*args, **kwargs): - """GetKind() -> wxItemKind""" + """GetKind() -> int""" return _controls.ToolBarToolBase_GetKind(*args, **kwargs) def IsEnabled(*args, **kwargs): @@ -2193,27 +2565,27 @@ class ToolBarToolBase(core.Object): return _controls.ToolBarToolBase_CanBeToggled(*args, **kwargs) def GetNormalBitmap(*args, **kwargs): - """GetNormalBitmap() -> wxBitmap""" + """GetNormalBitmap() -> Bitmap""" return _controls.ToolBarToolBase_GetNormalBitmap(*args, **kwargs) def GetDisabledBitmap(*args, **kwargs): - """GetDisabledBitmap() -> wxBitmap""" + """GetDisabledBitmap() -> Bitmap""" return _controls.ToolBarToolBase_GetDisabledBitmap(*args, **kwargs) def GetBitmap(*args, **kwargs): - """GetBitmap() -> wxBitmap""" + """GetBitmap() -> Bitmap""" return _controls.ToolBarToolBase_GetBitmap(*args, **kwargs) def GetLabel(*args, **kwargs): - """GetLabel() -> wxString""" + """GetLabel() -> String""" return _controls.ToolBarToolBase_GetLabel(*args, **kwargs) def GetShortHelp(*args, **kwargs): - """GetShortHelp() -> wxString""" + """GetShortHelp() -> String""" return _controls.ToolBarToolBase_GetShortHelp(*args, **kwargs) def GetLongHelp(*args, **kwargs): - """GetLongHelp() -> wxString""" + """GetLongHelp() -> String""" return _controls.ToolBarToolBase_GetLongHelp(*args, **kwargs) def Enable(*args, **kwargs): @@ -2229,23 +2601,23 @@ class ToolBarToolBase(core.Object): return _controls.ToolBarToolBase_SetToggle(*args, **kwargs) def SetShortHelp(*args, **kwargs): - """SetShortHelp(wxString help) -> bool""" + """SetShortHelp(String help) -> bool""" return _controls.ToolBarToolBase_SetShortHelp(*args, **kwargs) def SetLongHelp(*args, **kwargs): - """SetLongHelp(wxString help) -> bool""" + """SetLongHelp(String help) -> bool""" return _controls.ToolBarToolBase_SetLongHelp(*args, **kwargs) def SetNormalBitmap(*args, **kwargs): - """SetNormalBitmap(wxBitmap bmp)""" + """SetNormalBitmap(Bitmap bmp)""" return _controls.ToolBarToolBase_SetNormalBitmap(*args, **kwargs) def SetDisabledBitmap(*args, **kwargs): - """SetDisabledBitmap(wxBitmap bmp)""" + """SetDisabledBitmap(Bitmap bmp)""" return _controls.ToolBarToolBase_SetDisabledBitmap(*args, **kwargs) def SetLabel(*args, **kwargs): - """SetLabel(wxString label)""" + """SetLabel(String label)""" return _controls.ToolBarToolBase_SetLabel(*args, **kwargs) def Detach(*args, **kwargs): @@ -2278,23 +2650,25 @@ class ToolBarToolBasePtr(ToolBarToolBase): _controls.ToolBarToolBase_swigregister(ToolBarToolBasePtr) class ToolBarBase(core.Control): - """""" def __init__(self): raise RuntimeError, "No constructor defined" def __repr__(self): return "<%s.%s; proxy of C++ wxToolBarBase instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def DoAddTool(*args, **kwargs): - """DoAddTool(int id, wxString label, wxBitmap bitmap, wxBitmap bmpDisabled=wxNullBitmap, - wxItemKind kind=ITEM_NORMAL, - wxString shortHelp=wxPyEmptyString, - wxString longHelp=wxPyEmptyString, PyObject clientData=None) -> ToolBarToolBase""" + """ + DoAddTool(int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap, + int kind=ITEM_NORMAL, String shortHelp=EmptyString, + String longHelp=EmptyString, + PyObject clientData=None) -> ToolBarToolBase + """ return _controls.ToolBarBase_DoAddTool(*args, **kwargs) def DoInsertTool(*args, **kwargs): - """DoInsertTool(size_t pos, int id, wxString label, wxBitmap bitmap, - wxBitmap bmpDisabled=wxNullBitmap, wxItemKind kind=ITEM_NORMAL, - wxString shortHelp=wxPyEmptyString, - wxString longHelp=wxPyEmptyString, - PyObject clientData=None) -> ToolBarToolBase""" + """ + DoInsertTool(size_t pos, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap, + int kind=ITEM_NORMAL, + String shortHelp=EmptyString, String longHelp=EmptyString, + PyObject clientData=None) -> ToolBarToolBase + """ return _controls.ToolBarBase_DoInsertTool(*args, **kwargs) # These match the original Add methods for this class, kept for @@ -2420,6 +2794,14 @@ class ToolBarBase(core.Control): return self.DoAddTool(id, '', bitmap, bmpDisabled, wx.ITEM_RADIO, shortHelp, longHelp, clientData) + def AddToolItem(*args, **kwargs): + """AddToolItem(ToolBarToolBase tool) -> ToolBarToolBase""" + return _controls.ToolBarBase_AddToolItem(*args, **kwargs) + + def InsertToolItem(*args, **kwargs): + """InsertToolItem(size_t pos, ToolBarToolBase tool) -> ToolBarToolBase""" + return _controls.ToolBarBase_InsertToolItem(*args, **kwargs) + def AddControl(*args, **kwargs): """AddControl(Control control) -> ToolBarToolBase""" return _controls.ToolBarBase_AddControl(*args, **kwargs) @@ -2493,19 +2875,19 @@ class ToolBarBase(core.Control): return _controls.ToolBarBase_GetToolEnabled(*args, **kwargs) def SetToolShortHelp(*args, **kwargs): - """SetToolShortHelp(int id, wxString helpString)""" + """SetToolShortHelp(int id, String helpString)""" return _controls.ToolBarBase_SetToolShortHelp(*args, **kwargs) def GetToolShortHelp(*args, **kwargs): - """GetToolShortHelp(int id) -> wxString""" + """GetToolShortHelp(int id) -> String""" return _controls.ToolBarBase_GetToolShortHelp(*args, **kwargs) def SetToolLongHelp(*args, **kwargs): - """SetToolLongHelp(int id, wxString helpString)""" + """SetToolLongHelp(int id, String helpString)""" return _controls.ToolBarBase_SetToolLongHelp(*args, **kwargs) def GetToolLongHelp(*args, **kwargs): - """GetToolLongHelp(int id) -> wxString""" + """GetToolLongHelp(int id) -> String""" return _controls.ToolBarBase_GetToolLongHelp(*args, **kwargs) def SetMarginsXY(*args, **kwargs): @@ -2572,6 +2954,10 @@ class ToolBarBase(core.Control): """FindToolForPosition(int x, int y) -> ToolBarToolBase""" return _controls.ToolBarBase_FindToolForPosition(*args, **kwargs) + def FindById(*args, **kwargs): + """FindById(int toolid) -> ToolBarToolBase""" + return _controls.ToolBarBase_FindById(*args, **kwargs) + def IsVertical(*args, **kwargs): """IsVertical() -> bool""" return _controls.ToolBarBase_IsVertical(*args, **kwargs) @@ -2585,13 +2971,14 @@ class ToolBarBasePtr(ToolBarBase): _controls.ToolBarBase_swigregister(ToolBarBasePtr) class ToolBar(ToolBarBase): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxToolBar 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, - long style=wxNO_BORDER|wxTB_HORIZONTAL, - wxString name=wxPyToolBarNameStr) -> ToolBar""" + """ + __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + long style=wxNO_BORDER|wxTB_HORIZONTAL, + String name=wxPyToolBarNameStr) -> ToolBar + """ newobj = _controls.new_ToolBar(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -2599,9 +2986,11 @@ class ToolBar(ToolBarBase): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxNO_BORDER|wxTB_HORIZONTAL, - wxString name=wxPyToolBarNameStr) -> bool""" + """ + Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + long style=wxNO_BORDER|wxTB_HORIZONTAL, + String name=wxPyToolBarNameStr) -> bool + """ return _controls.ToolBar_Create(*args, **kwargs) def FindToolForPosition(*args, **kwargs): @@ -2695,26 +3084,27 @@ LIST_FIND_RIGHT = _controls.LIST_FIND_RIGHT #--------------------------------------------------------------------------- class ListItemAttr(object): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxListItemAttr instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(wxColour colText=wxNullColour, wxColour colBack=wxNullColour, - wxFont font=wxNullFont) -> ListItemAttr""" + """ + __init__(Colour colText=wxNullColour, Colour colBack=wxNullColour, + Font font=wxNullFont) -> ListItemAttr + """ newobj = _controls.new_ListItemAttr(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown def SetTextColour(*args, **kwargs): - """SetTextColour(wxColour colText)""" + """SetTextColour(Colour colText)""" return _controls.ListItemAttr_SetTextColour(*args, **kwargs) def SetBackgroundColour(*args, **kwargs): - """SetBackgroundColour(wxColour colBack)""" + """SetBackgroundColour(Colour colBack)""" return _controls.ListItemAttr_SetBackgroundColour(*args, **kwargs) def SetFont(*args, **kwargs): - """SetFont(wxFont font)""" + """SetFont(Font font)""" return _controls.ListItemAttr_SetFont(*args, **kwargs) def HasTextColour(*args, **kwargs): @@ -2730,15 +3120,15 @@ class ListItemAttr(object): return _controls.ListItemAttr_HasFont(*args, **kwargs) def GetTextColour(*args, **kwargs): - """GetTextColour() -> wxColour""" + """GetTextColour() -> Colour""" return _controls.ListItemAttr_GetTextColour(*args, **kwargs) def GetBackgroundColour(*args, **kwargs): - """GetBackgroundColour() -> wxColour""" + """GetBackgroundColour() -> Colour""" return _controls.ListItemAttr_GetBackgroundColour(*args, **kwargs) def GetFont(*args, **kwargs): - """GetFont() -> wxFont""" + """GetFont() -> Font""" return _controls.ListItemAttr_GetFont(*args, **kwargs) def Destroy(*args, **kwargs): @@ -2752,11 +3142,11 @@ class ListItemAttrPtr(ListItemAttr): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = ListItemAttr _controls.ListItemAttr_swigregister(ListItemAttrPtr) +ListCtrlNameStr = cvar.ListCtrlNameStr #--------------------------------------------------------------------------- class ListItem(core.Object): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxListItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -2800,7 +3190,7 @@ class ListItem(core.Object): return _controls.ListItem_SetStateMask(*args, **kwargs) def SetText(*args, **kwargs): - """SetText(wxString text)""" + """SetText(String text)""" return _controls.ListItem_SetText(*args, **kwargs) def SetImage(*args, **kwargs): @@ -2816,19 +3206,19 @@ class ListItem(core.Object): return _controls.ListItem_SetWidth(*args, **kwargs) def SetAlign(*args, **kwargs): - """SetAlign(wxListColumnFormat align)""" + """SetAlign(int align)""" return _controls.ListItem_SetAlign(*args, **kwargs) def SetTextColour(*args, **kwargs): - """SetTextColour(wxColour colText)""" + """SetTextColour(Colour colText)""" return _controls.ListItem_SetTextColour(*args, **kwargs) def SetBackgroundColour(*args, **kwargs): - """SetBackgroundColour(wxColour colBack)""" + """SetBackgroundColour(Colour colBack)""" return _controls.ListItem_SetBackgroundColour(*args, **kwargs) def SetFont(*args, **kwargs): - """SetFont(wxFont font)""" + """SetFont(Font font)""" return _controls.ListItem_SetFont(*args, **kwargs) def GetMask(*args, **kwargs): @@ -2848,7 +3238,7 @@ class ListItem(core.Object): return _controls.ListItem_GetState(*args, **kwargs) def GetText(*args, **kwargs): - """GetText() -> wxString""" + """GetText() -> String""" return _controls.ListItem_GetText(*args, **kwargs) def GetImage(*args, **kwargs): @@ -2864,7 +3254,7 @@ class ListItem(core.Object): return _controls.ListItem_GetWidth(*args, **kwargs) def GetAlign(*args, **kwargs): - """GetAlign() -> wxListColumnFormat""" + """GetAlign() -> int""" return _controls.ListItem_GetAlign(*args, **kwargs) def GetAttributes(*args, **kwargs): @@ -2876,15 +3266,15 @@ class ListItem(core.Object): return _controls.ListItem_HasAttributes(*args, **kwargs) def GetTextColour(*args, **kwargs): - """GetTextColour() -> wxColour""" + """GetTextColour() -> Colour""" return _controls.ListItem_GetTextColour(*args, **kwargs) def GetBackgroundColour(*args, **kwargs): - """GetBackgroundColour() -> wxColour""" + """GetBackgroundColour() -> Colour""" return _controls.ListItem_GetBackgroundColour(*args, **kwargs) def GetFont(*args, **kwargs): - """GetFont() -> wxFont""" + """GetFont() -> Font""" return _controls.ListItem_GetFont(*args, **kwargs) m_mask = property(_controls.ListItem_m_mask_get, _controls.ListItem_m_mask_set) @@ -2908,7 +3298,6 @@ _controls.ListItem_swigregister(ListItemPtr) #--------------------------------------------------------------------------- class ListEvent(core.NotifyEvent): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxListEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -2940,13 +3329,13 @@ class ListEvent(core.NotifyEvent): """GetPoint() -> Point""" return _controls.ListEvent_GetPoint(*args, **kwargs) - GetPostiion = GetPoint + GetPosition = GetPoint def GetLabel(*args, **kwargs): - """GetLabel() -> wxString""" + """GetLabel() -> String""" return _controls.ListEvent_GetLabel(*args, **kwargs) def GetText(*args, **kwargs): - """GetText() -> wxString""" + """GetText() -> String""" return _controls.ListEvent_GetText(*args, **kwargs) def GetImage(*args, **kwargs): @@ -3037,13 +3426,14 @@ EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED #--------------------------------------------------------------------------- class ListCtrl(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyListCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=LC_ICON, - Validator validator=DefaultValidator, wxString name=wxPyListCtrlNameStr) -> ListCtrl""" + """ + __init__(Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=LC_ICON, + Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListCtrl + """ newobj = _controls.new_ListCtrl(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -3051,9 +3441,13 @@ class ListCtrl(core.Control): self._setOORInfo(self);self._setCallbackInfo(self, ListCtrl) def Create(*args, **kwargs): - """Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=LC_ICON, - Validator validator=DefaultValidator, wxString name=wxPyListCtrlNameStr) -> bool""" + """ + 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) def _setCallbackInfo(*args, **kwargs): @@ -3061,11 +3455,11 @@ class ListCtrl(core.Control): return _controls.ListCtrl__setCallbackInfo(*args, **kwargs) def SetForegroundColour(*args, **kwargs): - """SetForegroundColour(wxColour col) -> bool""" + """SetForegroundColour(Colour col) -> bool""" return _controls.ListCtrl_SetForegroundColour(*args, **kwargs) def SetBackgroundColour(*args, **kwargs): - """SetBackgroundColour(wxColour col) -> bool""" + """SetBackgroundColour(Colour col) -> bool""" return _controls.ListCtrl_SetBackgroundColour(*args, **kwargs) def GetColumn(*args, **kwargs): @@ -3109,7 +3503,7 @@ class ListCtrl(core.Control): return _controls.ListCtrl_SetItem(*args, **kwargs) def SetStringItem(*args, **kwargs): - """SetStringItem(long index, int col, wxString label, int imageId=-1) -> long""" + """SetStringItem(long index, int col, String label, int imageId=-1) -> long""" return _controls.ListCtrl_SetStringItem(*args, **kwargs) def GetItemState(*args, **kwargs): @@ -3125,11 +3519,11 @@ class ListCtrl(core.Control): return _controls.ListCtrl_SetItemImage(*args, **kwargs) def GetItemText(*args, **kwargs): - """GetItemText(long item) -> wxString""" + """GetItemText(long item) -> String""" return _controls.ListCtrl_GetItemText(*args, **kwargs) def SetItemText(*args, **kwargs): - """SetItemText(long item, wxString str)""" + """SetItemText(long item, String str)""" return _controls.ListCtrl_SetItemText(*args, **kwargs) def GetItemData(*args, **kwargs): @@ -3169,11 +3563,11 @@ class ListCtrl(core.Control): return _controls.ListCtrl_GetSelectedItemCount(*args, **kwargs) def GetTextColour(*args, **kwargs): - """GetTextColour() -> wxColour""" + """GetTextColour() -> Colour""" return _controls.ListCtrl_GetTextColour(*args, **kwargs) def SetTextColour(*args, **kwargs): - """SetTextColour(wxColour col)""" + """SetTextColour(Colour col)""" return _controls.ListCtrl_SetTextColour(*args, **kwargs) def GetTopItem(*args, **kwargs): @@ -3185,7 +3579,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): @@ -3193,18 +3593,20 @@ 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 InReportView(*args, **kwargs): + """InReportView() -> bool""" + return _controls.ListCtrl_InReportView(*args, **kwargs) def IsVirtual(*args, **kwargs): """IsVirtual() -> bool""" @@ -3255,7 +3657,7 @@ class ListCtrl(core.Control): return _controls.ListCtrl_EnsureVisible(*args, **kwargs) def FindItem(*args, **kwargs): - """FindItem(long start, wxString str, bool partial=False) -> long""" + """FindItem(long start, String str, bool partial=False) -> long""" return _controls.ListCtrl_FindItem(*args, **kwargs) def FindItemData(*args, **kwargs): @@ -3267,7 +3669,12 @@ class ListCtrl(core.Control): return _controls.ListCtrl_FindItemAtPos(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point point, int OUTPUT) -> long""" + """ + 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.) + """ return _controls.ListCtrl_HitTest(*args, **kwargs) def InsertItem(*args, **kwargs): @@ -3275,7 +3682,7 @@ class ListCtrl(core.Control): return _controls.ListCtrl_InsertItem(*args, **kwargs) def InsertStringItem(*args, **kwargs): - """InsertStringItem(long index, wxString label) -> long""" + """InsertStringItem(long index, String label) -> long""" return _controls.ListCtrl_InsertStringItem(*args, **kwargs) def InsertImageItem(*args, **kwargs): @@ -3283,7 +3690,7 @@ class ListCtrl(core.Control): return _controls.ListCtrl_InsertImageItem(*args, **kwargs) def InsertImageStringItem(*args, **kwargs): - """InsertImageStringItem(long index, wxString label, int imageIndex) -> long""" + """InsertImageStringItem(long index, String label, int imageIndex) -> long""" return _controls.ListCtrl_InsertImageStringItem(*args, **kwargs) def InsertColumnInfo(*args, **kwargs): @@ -3291,8 +3698,10 @@ class ListCtrl(core.Control): return _controls.ListCtrl_InsertColumnInfo(*args, **kwargs) def InsertColumn(*args, **kwargs): - """InsertColumn(long col, wxString heading, int format=LIST_FORMAT_LEFT, - int width=-1) -> long""" + """ + InsertColumn(long col, String heading, int format=LIST_FORMAT_LEFT, + int width=-1) -> long + """ return _controls.ListCtrl_InsertColumn(*args, **kwargs) def SetItemCount(*args, **kwargs): @@ -3304,19 +3713,19 @@ class ListCtrl(core.Control): return _controls.ListCtrl_ScrollList(*args, **kwargs) def SetItemTextColour(*args, **kwargs): - """SetItemTextColour(long item, wxColour col)""" + """SetItemTextColour(long item, Colour col)""" return _controls.ListCtrl_SetItemTextColour(*args, **kwargs) def GetItemTextColour(*args, **kwargs): - """GetItemTextColour(long item) -> wxColour""" + """GetItemTextColour(long item) -> Colour""" return _controls.ListCtrl_GetItemTextColour(*args, **kwargs) def SetItemBackgroundColour(*args, **kwargs): - """SetItemBackgroundColour(long item, wxColour col)""" + """SetItemBackgroundColour(long item, Colour col)""" return _controls.ListCtrl_SetItemBackgroundColour(*args, **kwargs) def GetItemBackgroundColour(*args, **kwargs): - """GetItemBackgroundColour(long item) -> wxColour""" + """GetItemBackgroundColour(long item) -> Colour""" return _controls.ListCtrl_GetItemBackgroundColour(*args, **kwargs) # @@ -3403,13 +3812,14 @@ def PreListCtrl(*args, **kwargs): #--------------------------------------------------------------------------- class ListView(ListCtrl): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxListView instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=LC_REPORT, - Validator validator=DefaultValidator, wxString name=wxPyListCtrlNameStr) -> ListView""" + """ + __init__(Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=LC_REPORT, + Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListView + """ newobj = _controls.new_ListView(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -3417,9 +3827,13 @@ class ListView(ListCtrl): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=LC_REPORT, - Validator validator=DefaultValidator, wxString name=wxPyListCtrlNameStr) -> bool""" + """ + 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) def Select(*args, **kwargs): @@ -3508,7 +3922,6 @@ TREE_HITTEST_ONITEM = _controls.TREE_HITTEST_ONITEM #--------------------------------------------------------------------------- class TreeItemId(object): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxTreeItemId instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -3545,9 +3958,9 @@ 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): return "<%s.%s; proxy of C++ wxPyTreeItemData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -3605,6 +4018,7 @@ wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK = _controls.wxEVT_COMMAND_TREE_ITEM_RIGHT_CL wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK = _controls.wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK wxEVT_COMMAND_TREE_END_DRAG = _controls.wxEVT_COMMAND_TREE_END_DRAG wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK = _controls.wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK +wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP = _controls.wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP EVT_TREE_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_DRAG , 1) EVT_TREE_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_RDRAG , 1) EVT_TREE_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT , 1) @@ -3624,10 +4038,9 @@ EVT_TREE_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLIC EVT_TREE_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 1) EVT_TREE_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_DRAG , 1) EVT_TREE_STATE_IMAGE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 1) - +EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP, 1) class TreeEvent(core.NotifyEvent): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxTreeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -3673,11 +4086,11 @@ class TreeEvent(core.NotifyEvent): return _controls.TreeEvent_SetKeyEvent(*args, **kwargs) def GetLabel(*args, **kwargs): - """GetLabel() -> wxString""" + """GetLabel() -> String""" return _controls.TreeEvent_GetLabel(*args, **kwargs) def SetLabel(*args, **kwargs): - """SetLabel(wxString label)""" + """SetLabel(String label)""" return _controls.TreeEvent_SetLabel(*args, **kwargs) def IsEditCancelled(*args, **kwargs): @@ -3688,6 +4101,10 @@ class TreeEvent(core.NotifyEvent): """SetEditCanceled(bool editCancelled)""" return _controls.TreeEvent_SetEditCanceled(*args, **kwargs) + def SetToolTip(*args, **kwargs): + """SetToolTip(String toolTip)""" + return _controls.TreeEvent_SetToolTip(*args, **kwargs) + class TreeEventPtr(TreeEvent): def __init__(self, this): @@ -3699,14 +4116,15 @@ _controls.TreeEvent_swigregister(TreeEventPtr) #--------------------------------------------------------------------------- class TreeCtrl(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyTreeCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=TR_DEFAULT_STYLE, - Validator validator=DefaultValidator, - wxString name=wxPy_TreeCtrlNameStr) -> TreeCtrl""" + """ + __init__(Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=TR_DEFAULT_STYLE, + Validator validator=DefaultValidator, + String name=TreeCtrlNameStr) -> TreeCtrl + """ newobj = _controls.new_TreeCtrl(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -3714,10 +4132,14 @@ class TreeCtrl(core.Control): self._setOORInfo(self);self._setCallbackInfo(self, TreeCtrl) def Create(*args, **kwargs): - """Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=TR_DEFAULT_STYLE, - Validator validator=DefaultValidator, - wxString name=wxPy_TreeCtrlNameStr) -> bool""" + """ + Create(Window parent, int id=-1, Point pos=DefaultPosition, + 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) def _setCallbackInfo(*args, **kwargs): @@ -3745,39 +4167,35 @@ 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) -> wxString""" + """GetItemText(TreeItemId item) -> String""" return _controls.TreeCtrl_GetItemText(*args, **kwargs) def GetItemImage(*args, **kwargs): - """GetItemImage(TreeItemId item, wxTreeItemIcon which=TreeItemIcon_Normal) -> int""" + """GetItemImage(TreeItemId item, int which=TreeItemIcon_Normal) -> int""" return _controls.TreeCtrl_GetItemImage(*args, **kwargs) def GetItemData(*args, **kwargs): @@ -3790,23 +4208,23 @@ class TreeCtrl(core.Control): GetPyData = GetItemPyData def GetItemTextColour(*args, **kwargs): - """GetItemTextColour(TreeItemId item) -> wxColour""" + """GetItemTextColour(TreeItemId item) -> Colour""" return _controls.TreeCtrl_GetItemTextColour(*args, **kwargs) def GetItemBackgroundColour(*args, **kwargs): - """GetItemBackgroundColour(TreeItemId item) -> wxColour""" + """GetItemBackgroundColour(TreeItemId item) -> Colour""" return _controls.TreeCtrl_GetItemBackgroundColour(*args, **kwargs) def GetItemFont(*args, **kwargs): - """GetItemFont(TreeItemId item) -> wxFont""" + """GetItemFont(TreeItemId item) -> Font""" return _controls.TreeCtrl_GetItemFont(*args, **kwargs) def SetItemText(*args, **kwargs): - """SetItemText(TreeItemId item, wxString text)""" + """SetItemText(TreeItemId item, String text)""" return _controls.TreeCtrl_SetItemText(*args, **kwargs) def SetItemImage(*args, **kwargs): - """SetItemImage(TreeItemId item, int image, wxTreeItemIcon which=TreeItemIcon_Normal)""" + """SetItemImage(TreeItemId item, int image, int which=TreeItemIcon_Normal)""" return _controls.TreeCtrl_SetItemImage(*args, **kwargs) def SetItemData(*args, **kwargs): @@ -3831,15 +4249,15 @@ class TreeCtrl(core.Control): return _controls.TreeCtrl_SetItemDropHighlight(*args, **kwargs) def SetItemTextColour(*args, **kwargs): - """SetItemTextColour(TreeItemId item, wxColour col)""" + """SetItemTextColour(TreeItemId item, Colour col)""" return _controls.TreeCtrl_SetItemTextColour(*args, **kwargs) def SetItemBackgroundColour(*args, **kwargs): - """SetItemBackgroundColour(TreeItemId item, wxColour col)""" + """SetItemBackgroundColour(TreeItemId item, Colour col)""" return _controls.TreeCtrl_SetItemBackgroundColour(*args, **kwargs) def SetItemFont(*args, **kwargs): - """SetItemFont(TreeItemId item, wxFont font)""" + """SetItemFont(TreeItemId item, Font font)""" return _controls.TreeCtrl_SetItemFont(*args, **kwargs) def IsVisible(*args, **kwargs): @@ -3887,7 +4305,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): @@ -3915,28 +4333,35 @@ class TreeCtrl(core.Control): return _controls.TreeCtrl_GetPrevVisible(*args, **kwargs) def AddRoot(*args, **kwargs): - """AddRoot(wxString text, int image=-1, int selectedImage=-1, - TreeItemData data=None) -> TreeItemId""" + """AddRoot(String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId""" return _controls.TreeCtrl_AddRoot(*args, **kwargs) def PrependItem(*args, **kwargs): - """PrependItem(TreeItemId parent, wxString text, int image=-1, int selectedImage=-1, - TreeItemData data=None) -> TreeItemId""" + """ + PrependItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1, + TreeItemData data=None) -> TreeItemId + """ return _controls.TreeCtrl_PrependItem(*args, **kwargs) def InsertItem(*args, **kwargs): - """InsertItem(TreeItemId parent, TreeItemId idPrevious, wxString text, - int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId""" + """ + InsertItem(TreeItemId parent, TreeItemId idPrevious, String text, + int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId + """ return _controls.TreeCtrl_InsertItem(*args, **kwargs) def InsertItemBefore(*args, **kwargs): - """InsertItemBefore(TreeItemId parent, size_t index, wxString text, int image=-1, - int selectedImage=-1, TreeItemData data=None) -> TreeItemId""" + """ + InsertItemBefore(TreeItemId parent, size_t index, String text, int image=-1, + int selectedImage=-1, TreeItemData data=None) -> TreeItemId + """ return _controls.TreeCtrl_InsertItemBefore(*args, **kwargs) def AppendItem(*args, **kwargs): - """AppendItem(TreeItemId parent, wxString text, int image=-1, int selectedImage=-1, - TreeItemData data=None) -> TreeItemId""" + """ + AppendItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1, + TreeItemData data=None) -> TreeItemId + """ return _controls.TreeCtrl_AppendItem(*args, **kwargs) def Delete(*args, **kwargs): @@ -3971,14 +4396,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) @@ -4004,7 +4437,15 @@ class TreeCtrl(core.Control): return _controls.TreeCtrl_SortChildren(*args, **kwargs) def HitTest(*args, **kwargs): - """HitTest(Point point, int OUTPUT) -> TreeItemId""" + """ + HitTest(Point point) -> (item, where) + + Determine which item (if any) belongs the given point. The + coordinates specified are relative to the client area of tree ctrl + and the where return value is set to a bitmask of wxTREE_HITTEST_xxx + constants. + + """ return _controls.TreeCtrl_HitTest(*args, **kwargs) def GetBoundingRect(*args, **kwargs): @@ -4033,15 +4474,16 @@ DIRCTRL_SHOW_FILTERS = _controls.DIRCTRL_SHOW_FILTERS DIRCTRL_3D_INTERNAL = _controls.DIRCTRL_3D_INTERNAL DIRCTRL_EDIT_LABELS = _controls.DIRCTRL_EDIT_LABELS class GenericDirCtrl(core.Control): - """""" def __repr__(self): 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, wxString dir=wxPyDirDialogDefaultFolderStr, - Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER, - wxString filter=wxPyEmptyString, - int defaultFilter=0, wxString name=wxPy_TreeCtrlNameStr) -> GenericDirCtrl""" + """ + __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=TreeCtrlNameStr) -> GenericDirCtrl + """ newobj = _controls.new_GenericDirCtrl(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -4049,35 +4491,37 @@ class GenericDirCtrl(core.Control): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(Window parent, int id=-1, wxString dir=wxPyDirDialogDefaultFolderStr, - Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER, - wxString filter=wxPyEmptyString, - int defaultFilter=0, wxString name=wxPy_TreeCtrlNameStr) -> bool""" + """ + 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=TreeCtrlNameStr) -> bool + """ return _controls.GenericDirCtrl_Create(*args, **kwargs) def ExpandPath(*args, **kwargs): - """ExpandPath(wxString path) -> bool""" + """ExpandPath(String path) -> bool""" return _controls.GenericDirCtrl_ExpandPath(*args, **kwargs) def GetDefaultPath(*args, **kwargs): - """GetDefaultPath() -> wxString""" + """GetDefaultPath() -> String""" return _controls.GenericDirCtrl_GetDefaultPath(*args, **kwargs) def SetDefaultPath(*args, **kwargs): - """SetDefaultPath(wxString path)""" + """SetDefaultPath(String path)""" return _controls.GenericDirCtrl_SetDefaultPath(*args, **kwargs) def GetPath(*args, **kwargs): - """GetPath() -> wxString""" + """GetPath() -> String""" return _controls.GenericDirCtrl_GetPath(*args, **kwargs) def GetFilePath(*args, **kwargs): - """GetFilePath() -> wxString""" + """GetFilePath() -> String""" return _controls.GenericDirCtrl_GetFilePath(*args, **kwargs) def SetPath(*args, **kwargs): - """SetPath(wxString path)""" + """SetPath(String path)""" return _controls.GenericDirCtrl_SetPath(*args, **kwargs) def ShowHidden(*args, **kwargs): @@ -4089,11 +4533,11 @@ class GenericDirCtrl(core.Control): return _controls.GenericDirCtrl_GetShowHidden(*args, **kwargs) def GetFilter(*args, **kwargs): - """GetFilter() -> wxString""" + """GetFilter() -> String""" return _controls.GenericDirCtrl_GetFilter(*args, **kwargs) def SetFilter(*args, **kwargs): - """SetFilter(wxString filter)""" + """SetFilter(String filter)""" return _controls.GenericDirCtrl_SetFilter(*args, **kwargs) def GetFilterIndex(*args, **kwargs): @@ -4109,7 +4553,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): @@ -4117,7 +4561,14 @@ class GenericDirCtrl(core.Control): return _controls.GenericDirCtrl_GetFilterListCtrl(*args, **kwargs) def FindChild(*args, **kwargs): - """FindChild(TreeItemId parentId, wxString path, bool OUTPUT) -> TreeItemId""" + """ + FindChild(wxTreeItemId parentId, wxString path) -> (item, done) + + Find the child that matches the first part of 'path'. E.g. if a child path is + "/usr" and 'path' is "/usr/include" then the child for /usr is returned. + If the path string has been used (we're at the leaf), done is set to True + + """ return _controls.GenericDirCtrl_FindChild(*args, **kwargs) def DoResize(*args, **kwargs): @@ -4135,6 +4586,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""" @@ -4143,12 +4595,13 @@ def PreGenericDirCtrl(*args, **kwargs): return val class DirFilterListCtrl(Choice): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxDirFilterListCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0) -> DirFilterListCtrl""" + """ + __init__(GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0) -> DirFilterListCtrl + """ newobj = _controls.new_DirFilterListCtrl(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -4156,12 +4609,14 @@ class DirFilterListCtrl(Choice): self._setOORInfo(self) def Create(*args, **kwargs): - """Create(GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0) -> bool""" + """ + Create(GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0) -> bool + """ return _controls.DirFilterListCtrl_Create(*args, **kwargs) def FillFilterList(*args, **kwargs): - """FillFilterList(wxString filter, int defaultFilter)""" + """FillFilterList(String filter, int defaultFilter)""" return _controls.DirFilterListCtrl_FillFilterList(*args, **kwargs) @@ -4181,13 +4636,14 @@ def PreDirFilterListCtrl(*args, **kwargs): #--------------------------------------------------------------------------- class PyControl(core.Control): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyControl 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, - long style=0, Validator validator=DefaultValidator, - wxString name=wxPyControlNameStr) -> PyControl""" + """ + __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, Validator validator=DefaultValidator, + String name=ControlNameStr) -> PyControl + """ newobj = _controls.new_PyControl(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -4215,15 +4671,15 @@ class PyControl(core.Control): return _controls.PyControl_base_DoSetVirtualSize(*args, **kwargs) def base_DoGetSize(*args, **kwargs): - """base_DoGetSize(int OUTPUT, int OUTPUT)""" + """base_DoGetSize() -> (width, height)""" return _controls.PyControl_base_DoGetSize(*args, **kwargs) def base_DoGetClientSize(*args, **kwargs): - """base_DoGetClientSize(int OUTPUT, int OUTPUT)""" + """base_DoGetClientSize() -> (width, height)""" return _controls.PyControl_base_DoGetClientSize(*args, **kwargs) def base_DoGetPosition(*args, **kwargs): - """base_DoGetPosition(int OUTPUT, int OUTPUT)""" + """base_DoGetPosition() -> (x,y)""" return _controls.PyControl_base_DoGetPosition(*args, **kwargs) def base_DoGetVirtualSize(*args, **kwargs): @@ -4270,6 +4726,14 @@ class PyControl(core.Control): """base_RemoveChild(Window child)""" return _controls.PyControl_base_RemoveChild(*args, **kwargs) + def base_ShouldInheritColours(*args, **kwargs): + """base_ShouldInheritColours() -> bool""" + return _controls.PyControl_base_ShouldInheritColours(*args, **kwargs) + + def base_ApplyParentThemeBackground(*args, **kwargs): + """base_ApplyParentThemeBackground(Colour c)""" + return _controls.PyControl_base_ApplyParentThemeBackground(*args, **kwargs) + class PyControlPtr(PyControl): def __init__(self, this): @@ -4278,6 +4742,12 @@ class PyControlPtr(PyControl): self.__class__ = PyControl _controls.PyControl_swigregister(PyControlPtr) +def PrePyControl(*args, **kwargs): + """PrePyControl() -> PyControl""" + val = _controls.new_PrePyControl(*args, **kwargs) + val.thisown = 1 + return val + #--------------------------------------------------------------------------- FRAME_EX_CONTEXTHELP = _controls.FRAME_EX_CONTEXTHELP @@ -4290,7 +4760,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): @@ -4300,27 +4794,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() -> wxString""" + """ + GetLink() -> String + + Get an optional link to further help + """ return _controls.HelpEvent_GetLink(*args, **kwargs) def SetLink(*args, **kwargs): - """SetLink(wxString link)""" + """ + SetLink(String link) + + Set an optional link to further help + """ return _controls.HelpEvent_SetLink(*args, **kwargs) def GetTarget(*args, **kwargs): - """GetTarget() -> wxString""" + """ + 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(wxString target)""" + """ + SetTarget(String target) + + Set an optional target to display help in. E.g. a window specification + """ return _controls.HelpEvent_SetTarget(*args, **kwargs) @@ -4332,11 +4852,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 @@ -4348,11 +4896,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) @@ -4364,12 +4927,28 @@ 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""" + """ + __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 self.thisown = 1 @@ -4385,36 +4964,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) -> wxString""" + """ + 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, wxString 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, wxString 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) @@ -4428,19 +5060,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 @@ -4456,11 +5109,10 @@ _controls.SimpleHelpProvider_swigregister(SimpleHelpProviderPtr) #--------------------------------------------------------------------------- class DragImage(core.Object): - """""" def __repr__(self): return "<%s.%s; proxy of C++ wxGenericDragImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(wxBitmap image, wxCursor cursor=wxNullCursor) -> DragImage""" + """__init__(Bitmap image, Cursor cursor=wxNullCursor) -> DragImage""" newobj = _controls.new_DragImage(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -4472,12 +5124,14 @@ class DragImage(core.Object): except: pass def SetBackingBitmap(*args, **kwargs): - """SetBackingBitmap(wxBitmap bitmap)""" + """SetBackingBitmap(Bitmap bitmap)""" return _controls.DragImage_SetBackingBitmap(*args, **kwargs) def BeginDrag(*args, **kwargs): - """BeginDrag(Point hotspot, Window window, bool fullScreen=False, - Rect rect=None) -> bool""" + """ + BeginDrag(Point hotspot, Window window, bool fullScreen=False, + Rect rect=None) -> bool + """ return _controls.DragImage_BeginDrag(*args, **kwargs) def BeginDragBounded(*args, **kwargs): @@ -4505,12 +5159,11 @@ class DragImage(core.Object): return _controls.DragImage_GetImageRect(*args, **kwargs) def DoDrawImage(*args, **kwargs): - """DoDrawImage(wxDC dc, Point pos) -> bool""" + """DoDrawImage(DC dc, Point pos) -> bool""" return _controls.DragImage_DoDrawImage(*args, **kwargs) def UpdateBackingFromWindow(*args, **kwargs): - """UpdateBackingFromWindow(wxDC 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): @@ -4526,13 +5179,13 @@ class DragImagePtr(DragImage): _controls.DragImage_swigregister(DragImagePtr) def DragIcon(*args, **kwargs): - """DragIcon(wxIcon image, wxCursor cursor=wxNullCursor) -> DragImage""" + """DragIcon(Icon image, Cursor cursor=wxNullCursor) -> DragImage""" val = _controls.new_DragIcon(*args, **kwargs) val.thisown = 1 return val def DragString(*args, **kwargs): - """DragString(wxString str, wxCursor cursor=wxNullCursor) -> DragImage""" + """DragString(String str, Cursor cursor=wxNullCursor) -> DragImage""" val = _controls.new_DragString(*args, **kwargs) val.thisown = 1 return val