use the right number in the tarball filename

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

diff --git a/wxPython/src/_control.i b/wxPython/src/_control.i
index 555f535ad90a2055ad6428a1667d367ff3c724de..94b33f048a1793ad37785f9217fd37937f9884cb 100644 (file)
--- a/wxPython/src/_control.i
+++ b/wxPython/src/_control.i
@@ -34,14 +34,15 @@ class wxControl : public wxWindow
 public:
     %pythonAppend wxControl         "self._setOORInfo(self)"
     %pythonAppend wxControl()       ""
 public:
     %pythonAppend wxControl         "self._setOORInfo(self)"
     %pythonAppend wxControl()       ""

+    %typemap(out) wxControl*;    // turn off this typemap

 
     DocCtorStr(
         wxControl(wxWindow *parent,
 
     DocCtorStr(
         wxControl(wxWindow *parent,

-              wxWindowID id,
-              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.", "");
                   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.", "");


@@ -51,9 +52,13 @@ __init__ as a plain old wx.Control is not very useful.", "");
         "Precreate a Control control for 2-phase creation", "",
         PreControl);
 
         "Precreate a Control control for 2-phase creation", "",
         PreControl);
 

+    // Turn it back on again
+    %typemap(out) wxControl* { $result = wxPyMake_wxObject($1, $owner); }
+
+

     DocDeclStr(
         bool , Create(wxWindow *parent,
     DocDeclStr(
         bool , Create(wxWindow *parent,

-                      wxWindowID id,
+                      wxWindowID id=-1,

                       const wxPoint& pos=wxDefaultPosition,
                       const wxSize& size=wxDefaultSize,
                       long style=0,
                       const wxPoint& pos=wxDefaultPosition,
                       const wxSize& size=wxDefaultSize,
                       long style=0,


@@ -62,6 +67,17 @@ __init__ as a plain old wx.Control is not very useful.", "");
         "Do the 2nd phase and create the GUI control.", "");
     
 
         "Do the 2nd phase and create the GUI control.", "");
     
 

+    DocDeclStr(
+        int , GetAlignment() const,
+        "Get the control alignment (left/right/centre, top/bottom/centre)", "");
+    
+
+    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.
     DocDeclStr(
         void , Command(wxCommandEvent& event),
         "Simulates the effect of the user issuing a command to the item.


@@ -69,17 +85,27 @@ __init__ as a plain old wx.Control is not very useful.", "");
 :see: `wx.CommandEvent`
 ", "");
    
 :see: `wx.CommandEvent`
 ", "");
    

-    DocDeclStr(
-        wxString , GetLabel(),
-        "Return a control's text.", "");
-    
-    DocDeclStr(
-        void , SetLabel(const wxString& label),
-        "Sets the item's text.", "");

 
 

+//     DocDeclStr(
+//         bool , GetAdjustMinSizeFlag(),
+//         "Returns whether the minsize should be adjusted for this control when
+// `SetLabel` or `SetFont` are called.", "");
+    
+//     DocDeclStr(
+//         void , SetAdjustMinSizeFlag(bool adjust),
+//         "By default controls will readjust their size and minsize when
+// `SetLabel` or `SetFont` are called.  This flag will allow you to
+// control this behavior.", "
+
+// :see: `GetAdjustMinSizeFlag`
+// ");

     
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
     
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

+
+    %property(Alignment, GetAlignment, doc="See `GetAlignment`");
+    %property(LabelText, GetLabelText, doc="See `GetLabelText`");
+

 };
 
 
 };
 
 


@@ -87,11 +113,13 @@ __init__ as a plain old wx.Control is not very useful.", "");
 %newgroup;
 
 
 %newgroup;
 
 

+
+

 DocStr(wxItemContainer,
 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
 this one.
 
 It defines the methods for accessing the control's items and although


@@ -105,7 +133,7 @@ optionally, client data associated with them.
 class wxItemContainer
 {
 public:
 class wxItemContainer
 {
 public:

-    // wxItemContainer() { m_clientDataItemsType = wxClientData_None; }  ** It's an ABC
+    // wxItemContainer()  ** It's an ABC

     
 
     %extend {
     
 
     %extend {


@@ -123,8 +151,9 @@ has wx.LB_SORT or wx.CB_SORT style).", "");
         }
     }
     
         }
     }
     

-    DocDeclStrName(
+    DocDeclAStrName(

         void , Append(const wxArrayString& strings),
         void , Append(const wxArrayString& strings),

+        "AppendItems(self, List strings)",

         "Apend several items at once to the control.  Notice that calling this
 method may be much faster than appending the items one by one if you
 need to add a lot of items.", "",
         "Apend several items at once to the control.  Notice that calling this
 method may be much faster than appending the items one by one if you
 need to add a lot of items.", "",


@@ -135,7 +164,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.", "");
         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);
             if (clientData) {
                 wxPyClientData* data = new wxPyClientData(clientData);
                 return self->Insert(item, pos, data);


@@ -150,7 +179,7 @@ optionally associating some data object with the item.", "");
         "Removes all items from the control.", "");
     
     DocDeclStr(
         "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
         "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


@@ -158,8 +187,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(
     DocDeclStr(

-        virtual int , GetCount() const,
+        virtual unsigned int , GetCount() const,

         "Returns the number of items in the control.", "");
     
     DocDeclStr(
         "Returns the number of items in the control.", "");
     
     DocDeclStr(


@@ -167,7 +221,7 @@ than the number of items in the control.", "");
         "Returns True if the control is empty or False if it has some items.", "");
     
     DocDeclStr(
         "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(
         "Returns the label of the item with the given index.", "");
     
     DocDeclStr(


@@ -175,7 +229,7 @@ than the number of items in the control.", "");
         "", "");
     
     DocDeclStr(
         "", "");
     
     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(
         "Sets the label for the given item.", "");
     
     DocDeclStr(


@@ -185,12 +239,9 @@ zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
 found.", "");
     
 
 found.", "");
     
 

-    

     DocDeclStr(
     DocDeclStr(

-        virtual void , Select(int n),
+        virtual void , SetSelection(int n),

         "Sets the item at index 'n' to be the selected item.", "");
         "Sets the item at index 'n' to be the selected item.", "");

-
-    %pythoncode { SetSelection = Select }

     
     DocDeclStr(
         virtual int , GetSelection() const,
     
     DocDeclStr(
         virtual int , GetSelection() const,


@@ -198,35 +249,38 @@ found.", "");
 is selected.", "");
     
 
 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(
         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);
-        }
+    %pythoncode {
+        def GetItems(self):
+            """Return a list of the strings in the control"""
+            return [self.GetString(i) for i in xrange(self.GetCount())]
+            
+        def SetItems(self, items):
+            """Clear and set the strings in the control from a list"""
+            self.Clear()
+            for i in items:
+                self.Append(i)        

     }
     }

-      
+    
+    %property(Count, GetCount, doc="See `GetCount`");
+    %property(Items, GetItems, SetItems, doc="See `GetItems` and `SetItems`");
+    %property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`");
+    %property(StringSelection, GetStringSelection, SetStringSelection, doc="See `GetStringSelection` and `SetStringSelection`");
+    %property(Strings, GetStrings, doc="See `GetStrings`");
+    

 };
 
 
 };