Adding overview docs and a couple tweaks to the demo.

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

diff --git a/wxPython/src/_combobox.i b/wxPython/src/_combobox.i
index 6e955724add0aeb4d23559b8ab75db7cd87f917f..d593ea6f120b25800693503956817abbe5b6c31e 100644 (file)
--- a/wxPython/src/_combobox.i
+++ b/wxPython/src/_combobox.i
@@ -53,6 +53,8 @@ Events
                         Note that calling `GetValue` in this handler 
                         will return the newly selected value.
     EVT_TEXT            Sent when the combobox text changes.
+    EVT_TEXT_ENTER      Sent when the RETURN/ENTER key is pressed in
+                        the combobox.
     ================    ===============================================
 ");
 
@@ -81,7 +83,7 @@ public:
                    const wxString& name = wxPyComboBoxNameStr),
         "__init__(Window parent, int id, String value=EmptyString,
     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=ComboBoxNameStr) -> ComboBox",
         "Constructor, creates and shows a ComboBox control.", "");
 
@@ -102,7 +104,7 @@ public:
                      const wxString& name = wxPyChoiceNameStr),
         "Create(Window parent, int id, String value=EmptyString,
     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 wxComboBox control for 2-phase creation", "");
     
@@ -155,15 +157,30 @@ combobox text field.", "");
         "Selects the text between the two positions in the combobox text field.", "",
         SetMark);    
 
-#ifdef __WXMSW__
+#ifndef __WXMAC__
     DocDeclAStrName(
         virtual void , GetSelection(long* OUTPUT, long* OUTPUT),
         "GetMark(self) -> (from, to)",
         "Gets the positions of the begining and ending of the selection mark in
 the combobox text field.", "",
         GetMark);
+#else
+    %pythoncode {
+        def GetMark(self):
+            return (0,0)
+    }
 #endif
+    
 
+    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.", "");
+    
     DocDeclStr(
         bool , SetStringSelection(const wxString& string),
         "Select the item with the specifed string", "");
@@ -184,9 +201,64 @@ the combobox text field.", "",
     DocDeclStr(
         virtual void , Remove(long from, long to),
         "Removes the text between the two positions in the combobox text field.", "");
+
+
+
+    DocDeclStr(
+        bool , IsEditable() const,
+        "Returns True if the combo is ediatable (not read-only.)", "");
+    
+
+    DocDeclStr(
+        void , Undo(),
+        "Redoes the last undo in the text field. Windows only.", "");
+    
+    DocDeclStr(
+        void , Redo(),
+        "Undoes the last edit in the text field. Windows only.", "");
+    
+    DocDeclStr(
+        void , SelectAll(),
+        "Select all the text in the combo's text field.", "");
+    
+
+    DocDeclStr(
+        bool , CanCopy() const,
+        "Returns True if the combobox is editable and there is a text selection
+to copy to the clipboard.  Only available on Windows.", "");
+    
+    DocDeclStr(
+        bool , CanCut() const,
+        "Returns True if the combobox is editable and there is a text selection
+to copy to the clipboard.  Only available on Windows.", "");
+    
+    DocDeclStr(
+        bool , CanPaste() const,
+        "Returns True if the combobox is editable and there is text on the
+clipboard that can be pasted into the text field. Only available on
+Windows.", "");
+    
+    DocDeclStr(
+        bool , CanUndo() const,
+        "Returns True if the combobox is editable and the last edit can be
+undone.  Only available on Windows.", "");
+    
+    DocDeclStr(
+        bool , CanRedo() const,
+        "Returns True if the combobox is editable and the last undo can be
+redone.  Only available on Windows.", "");
+    
+
     
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+    %property(CurrentSelection, GetCurrentSelection, doc="See `GetCurrentSelection`");
+    %property(InsertionPoint, GetInsertionPoint, SetInsertionPoint, doc="See `GetInsertionPoint` and `SetInsertionPoint`");
+    %property(LastPosition, GetLastPosition, doc="See `GetLastPosition`");
+    %property(Mark, GetMark, SetMark, doc="See `GetMark` and `SetMark`");
+    %property(Value, GetValue, SetValue, doc="See `GetValue` and `SetValue`");
+
 };
 
 //---------------------------------------------------------------------------