MAKE_CONST_WXSTRING(ChoiceNameStr);
-
//---------------------------------------------------------------------------
%newgroup;
+
+DocStr(wxChoice,
+"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.");
+
+RefDoc(wxChoice, "
+ Events
+ EVT_CHOICE: Sent when an item in the list is selected.
+");
+
+
class wxChoice : public wxControlWithItems
{
public:
- %addtofunc wxChoice "self._setOORInfo(self)"
- %addtofunc wxChoice() ""
-
- wxChoice(wxWindow *parent, wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- int choices=0, wxString* choices_array=NULL,
- long style = 0,
- const wxValidator& validator = wxDefaultValidator,
- const wxString& name = wxPyChoiceNameStr);
- %name(PreChoice)wxChoice();
-
- bool Create(wxWindow *parent, wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- int choices=0, wxString* choices_array=NULL,
- long style = 0,
- const wxValidator& validator = wxDefaultValidator,
- const wxString& name = wxPyChoiceNameStr);
-
- int GetColumns();
- void SetColumns(const int n = 1);
- void SetSelection(const int n);
- void SetStringSelection(const wxString& string);
- void SetString(int n, const wxString& s);
-
- %pragma(python) addtoclass = "
- Select = SetSelection
- "
+ %pythonAppend wxChoice "self._setOORInfo(self)"
+ %pythonAppend wxChoice() ""
+
+ RefDoc(wxChoice, ""); // turn it off for the ctors
+
+ DocCtorAStr(
+ wxChoice(wxWindow *parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ const wxArrayString& choices = wxPyEmptyStringArray,
+ long style = 0,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = wxPyChoiceNameStr),
+ "__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,\n"
+ " List choices=[], long style=0, Validator validator=DefaultValidator,\n"
+ " String name=ChoiceNameStr) -> Choice",
+ "Create and show a Choice control");
+
+ DocCtorStrName(
+ wxChoice(),
+ "Precreate a Choice control for 2-phase creation.",
+ PreChoice);
+
+
+ DocDeclAStr(
+ bool, Create(wxWindow *parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ const wxArrayString& choices = wxPyEmptyStringArray,
+ long style = 0,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = wxPyChoiceNameStr),
+ "Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,\n"
+ " List choices=[], long style=0, Validator validator=DefaultValidator,\n"
+ " String name=ChoiceNameStr) -> bool",
+ "Actually create the GUI Choice control for 2-phase creation");
+
+
+// // These are only meaningful on wxMotif...
+// int GetColumns();
+// void SetColumns(const int n = 1);
+
+
+ DocDeclStr(
+ void , SetSelection(const int n),
+ "Select the n'th item (zero based) in the list.");
+
+ DocDeclStr(
+ void , 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 }
};
//---------------------------------------------------------------------------