X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b870f2e67d9af9bf09a1f50f2f96d02844665786..90fb367e86c1e82367f8d4781b8c1bdc31a26593:/wxPython/src/_control.i diff --git a/wxPython/src/_control.i b/wxPython/src/_control.i index be2565fa70..8e53cee9db 100644 --- a/wxPython/src/_control.i +++ b/wxPython/src/_control.i @@ -38,11 +38,11 @@ public: DocCtorStr( wxControl(wxWindow *parent, - wxWindowID id=-1, - const wxPoint& pos=wxDefaultPosition, - const wxSize& size=wxDefaultSize, - long style=0, - const wxValidator& validator=wxDefaultValidator, + wxWindowID id=-1, + const wxPoint& pos=wxDefaultPosition, + const wxSize& size=wxDefaultSize, + long style=0, + const wxValidator& validator=wxDefaultValidator, const wxString& name=wxPyControlNameStr), "Create a Control. Normally you should only call this from a subclass' __init__ as a plain old wx.Control is not very useful.", ""); @@ -67,6 +67,22 @@ __init__ as a plain old wx.Control is not very useful.", ""); "Do the 2nd phase and create the GUI control.", ""); + DocDeclStr( + int , GetAlignment() const, + "Get the control alignment (left/right/centre, top/bottom/centre)", ""); + + +// DocDeclStr( +// static wxString , GetLabelText(const wxString& label), +// "Get the string without mnemonic characters ('&')", ""); + + + DocDeclStr( + wxString , GetLabelText() const, + "Get just the text of the label, without mnemonic characters ('&')", ""); + + + DocDeclStr( void , Command(wxCommandEvent& event), "Simulates the effect of the user issuing a command to the item. @@ -106,11 +122,13 @@ __init__ as a plain old wx.Control is not very useful.", ""); %newgroup; + + DocStr(wxItemContainer, -"wx.ItemContainer defines an interface which is implemented by all -controls which have string subitems, each of which may be selected, -such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as -`wx.ComboBox` which implements an extended interface deriving from +"The wx.ItemContainer class defines an interface which is implemented +by all controls which have string subitems, each of which may be +selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well +as `wx.ComboBox` which implements an extended interface deriving from this one. It defines the methods for accessing the control's items and although @@ -155,7 +173,7 @@ need to add a lot of items.", "", DocStr(Insert, "Insert an item into the control before the item at the ``pos`` index, optionally associating some data object with the item.", ""); - int Insert(const wxString& item, int pos, PyObject* clientData=NULL) { + int Insert(const wxString& item, unsigned int pos, PyObject* clientData=NULL) { if (clientData) { wxPyClientData* data = new wxPyClientData(clientData); return self->Insert(item, pos, data); @@ -170,7 +188,7 @@ optionally associating some data object with the item.", ""); "Removes all items from the control.", ""); DocDeclStr( - virtual void , Delete(int n), + virtual void , Delete(unsigned int n), "Deletes the item at the zero-based index 'n' from the control. Note that it is an error (signalled by a `wx.PyAssertionError` exception if enabled) to remove an item with the index negative or greater or equal @@ -178,8 +196,33 @@ than the number of items in the control.", ""); + + %extend { + DocStr(GetClientData, + "Returns the client data associated with the given item, (if any.)", ""); + PyObject* GetClientData(unsigned int n) { + wxPyClientData* data = (wxPyClientData*)self->GetClientObject(n); + if (data) { + Py_INCREF(data->m_obj); + return data->m_obj; + } else { + Py_INCREF(Py_None); + return Py_None; + } + } + + DocStr(SetClientData, + "Associate the given client data with the item at position n.", ""); + void SetClientData(unsigned int n, PyObject* clientData) { + wxPyClientData* data = new wxPyClientData(clientData); + self->SetClientObject(n, data); + } + } + + + DocDeclStr( - virtual int , GetCount() const, + virtual unsigned int , GetCount() const, "Returns the number of items in the control.", ""); DocDeclStr( @@ -187,7 +230,7 @@ than the number of items in the control.", ""); "Returns True if the control is empty or False if it has some items.", ""); DocDeclStr( - virtual wxString , GetString(int n) const, + virtual wxString , GetString(unsigned int n) const, "Returns the label of the item with the given index.", ""); DocDeclStr( @@ -195,7 +238,7 @@ than the number of items in the control.", ""); "", ""); DocDeclStr( - virtual void , SetString(int n, const wxString& s), + virtual void , SetString(unsigned int n, const wxString& s), "Sets the label for the given item.", ""); DocDeclStr( @@ -205,12 +248,9 @@ zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not found.", ""); - DocDeclStr( - virtual void , Select(int n), + virtual void , SetSelection(int n), "Sets the item at index 'n' to be the selected item.", ""); - - %pythoncode { SetSelection = Select } DocDeclStr( virtual int , GetSelection() const, @@ -218,35 +258,21 @@ found.", ""); is selected.", ""); + bool SetStringSelection(const wxString& s); + DocDeclStr( wxString , GetStringSelection() const, "Returns the label of the selected item or an empty string if no item is selected.", ""); + DocDeclStr( + void , Select(int n), + "This is the same as `SetSelection` and exists only because it is +slightly more natural for controls which support multiple selection.", ""); + - %extend { - DocStr(GetClientData, - "Returns the client data associated with the given item, (if any.)", ""); - PyObject* GetClientData(int n) { - wxPyClientData* data = (wxPyClientData*)self->GetClientObject(n); - if (data) { - Py_INCREF(data->m_obj); - return data->m_obj; - } else { - Py_INCREF(Py_None); - return Py_None; - } - } - - DocStr(SetClientData, - "Associate the given client data with the item at position n.", ""); - void SetClientData(int n, PyObject* clientData) { - wxPyClientData* data = new wxPyClientData(clientData); - self->SetClientObject(n, data); - } - } - + };