Various tweaks, docstring fixes, etc.

[wxWidgets.git] / wxPython / src / _choice.i

diff --git a/wxPython/src/_choice.i b/wxPython/src/_choice.i
index 604cf4c8972c2cb4c3f89c4a968900a5e59fa263..a0472e1d96eb12654ff332848aac560902e395cd 100644 (file)
--- a/wxPython/src/_choice.i
+++ b/wxPython/src/_choice.i
@@ -20,42 +20,77 @@ 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:
     %pythonAppend wxChoice         "self._setOORInfo(self)"
     %pythonAppend wxChoice()       ""
 
-    wxChoice(wxWindow *parent, wxWindowID id,
-             const wxPoint& pos = wxDefaultPosition,
-             const wxSize& size = wxDefaultSize,
-             //int choices=0, wxString* choices_array=NULL,
-             const wxArrayString& choices = wxPyEmptyStringArray,
-             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,
-                const wxArrayString& choices = wxPyEmptyStringArray,
-                long style = 0,
-                const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = wxPyChoiceNameStr);
-
-#ifndef __WXX11__
-    int GetColumns();
-    void SetColumns(const int n = 1);
-#endif
-    void SetSelection(const int n);
-    void SetStringSelection(const wxString& string);
-    void SetString(int n, const wxString& s);
-
-    %pragma(python) addtoclass = "
-    Select = SetSelection
-    "
+    RefDoc(wxChoice, ""); // turn it off for the ctors
+    
+    DocCtorAStr(
+        wxChoice(wxWindow *parent, wxWindowID id=-1,
+                 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=-1,
+                     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 }
 };
 
 //---------------------------------------------------------------------------