X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dce2bd223c2370f001f9ca93e04cbd437ff3f988..d9b33d7001af25479a63df96ca2f130b2cbc21aa:/wxPython/src/_choice.i diff --git a/wxPython/src/_choice.i b/wxPython/src/_choice.i index fa5deae4ca..b642a6b784 100644 --- a/wxPython/src/_choice.i +++ b/wxPython/src/_choice.i @@ -24,7 +24,7 @@ MAKE_CONST_WXSTRING(ChoiceNameStr); DocStr(wxChoice, "A Choice control is used to select one of a list of strings. Unlike a `wx.ListBox`, only the selection is visible until the -user pulls down the menu of choices. +user pulls down the menu of choices.", " Events ------ @@ -34,14 +34,14 @@ Events "); +MustHaveApp(wxChoice); + class wxChoice : public wxControlWithItems { public: %pythonAppend wxChoice "self._setOORInfo(self)" %pythonAppend wxChoice() "" - RefDoc(wxChoice, ""); // turn it off for the ctors - DocCtorAStr( wxChoice(wxWindow *parent, wxWindowID id=-1, const wxPoint& pos = wxDefaultPosition, @@ -51,13 +51,13 @@ public: const wxValidator& validator = wxDefaultValidator, const wxString& name = wxPyChoiceNameStr), "__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - List choices=[], long style=0, Validator validator=DefaultValidator, + List choices=EmptyList, long style=0, Validator validator=DefaultValidator, String name=ChoiceNameStr) -> Choice", - "Create and show a Choice control"); + "Create and show a Choice control", ""); DocCtorStrName( wxChoice(), - "Precreate a Choice control for 2-phase creation.", + "Precreate a Choice control for 2-phase creation.", "", PreChoice); @@ -70,30 +70,26 @@ public: const wxValidator& validator = wxDefaultValidator, const wxString& name = wxPyChoiceNameStr), "Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - List choices=[], long style=0, Validator validator=DefaultValidator, + List choices=EmptyList, long style=0, Validator validator=DefaultValidator, String name=ChoiceNameStr) -> bool", - "Actually create the GUI Choice control for 2-phase creation"); + "Actually create the GUI Choice control for 2-phase creation", ""); + + DocDeclStr( + int , GetCurrentSelection() const, + "Unlike `GetSelection` which only returns the accepted selection value, +i.e. the selection in the control once the user closes the dropdown +list, this function returns the current selection. That is, while the +dropdown list is shown, it returns the currently selected item in +it. When it is not shown, its result is the same as for the other +function.", ""); -// // These are only meaningful on wxMotif... -// int GetColumns(); -// void SetColumns(const int n = 1); + static wxVisualAttributes + GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); - DocDeclStr( - void , SetSelection(const int n), - "Select the n'th item (zero based) in the list."); + %property(CurrentSelection, GetCurrentSelection, doc="See `GetCurrentSelection`"); - DocDeclStr( - bool , SetStringSelection(const wxString& string), - "Select the item with the specifed string"); - - DocDeclStr( - void , SetString(int n, const wxString& string), - "Set the label for the n'th item (zero based) in the list."); - - - %pythoncode { Select = SetSelection } }; //---------------------------------------------------------------------------