make it explicitly clear that the len parameter of SetData() is in bytes

[wxWidgets.git] / interface / wx / combobox.h

diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h
index 2054fbd949aec4771fb0407626410aa3d9df529d..1e344758af562d095a098cecc00199f49ae8ad43 100644 (file)
--- a/interface/wx/combobox.h
+++ b/interface/wx/combobox.h
@@ -9,9 +9,11 @@
 /**
     @class wxComboBox
 
 /**
     @class wxComboBox
 

-    A combobox is like a combination of an edit control and a listbox. It can
-    be displayed as static list with editable or read-only text field; or a
-    drop-down list with text field; or a drop-down list without a text field.
+    A combobox is like a combination of an edit control and a listbox.
+
+    It can be displayed as static list with editable or read-only text field;
+    or a drop-down list with text field; or a drop-down list without a text
+    field.

 
     A combobox permits a single selection only. Combobox items are numbered
     from zero.
 
     A combobox permits a single selection only. Combobox items are numbered
     from zero.


@@ -19,6 +21,9 @@
     If you need a customized combobox, have a look at wxComboCtrl,
     wxOwnerDrawnComboBox, wxComboPopup and the ready-to-use wxBitmapComboBox.
 
     If you need a customized combobox, have a look at wxComboCtrl,
     wxOwnerDrawnComboBox, wxComboPopup and the ready-to-use wxBitmapComboBox.
 

+    Please refer to wxTextEntry documentation for the description of methods
+    operating with the text entry part of the combobox.
+

     @beginStyleTable
     @style{wxCB_SIMPLE}
            Creates a combobox with a permanently displayed list. Windows only.
     @beginStyleTable
     @style{wxCB_SIMPLE}
            Creates a combobox with a permanently displayed list. Windows only.


@@ -49,6 +54,16 @@
            Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
            the combobox (notice that the combobox must have been created with
            wxTE_PROCESS_ENTER style to receive this event).
            Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
            the combobox (notice that the combobox must have been created with
            wxTE_PROCESS_ENTER style to receive this event).

+    @event{EVT_COMBOX_DROPDOWN(id, func)}
+           Process a wxEVT_COMMAND_COMBOBOX_DROPDOWN event, which is generated
+           when the list box part of the combo box is shown (drops down).
+           Notice that this event is currently only supported by wxMSW and
+           wxGTK with GTK+ 2.10 or later.
+    @event{EVT_COMBOX_CLOSEUP(id, func)}
+           Process a wxEVT_COMMAND_COMBOBOX_CLOSEUP event, which is generated
+           when the list box of the combo box disappears (closes up). This
+           event is only generated for the same platforms as
+           wxEVT_COMMAND_COMBOBOX_DROPDOWN above.

     @endEventTable
 
     @library{wxcore}
     @endEventTable
 
     @library{wxcore}


@@ -57,7 +72,9 @@
 
     @see wxListBox, wxTextCtrl, wxChoice, wxCommandEvent
 */
 
     @see wxListBox, wxTextCtrl, wxChoice, wxCommandEvent
 */

-class wxComboBox : public wxControl, public wxItemContainer
+class wxComboBox : public wxControl,
+                   public wxItemContainer,
+                   public wxTextEntry

 {
 public:
     /**
 {
 public:
     /**


@@ -75,6 +92,8 @@ public:
             Window identifier. The value wxID_ANY indicates a default value.
         @param value
             Initial selection string. An empty string indicates no selection.
             Window identifier. The value wxID_ANY indicates a default value.
         @param value
             Initial selection string. An empty string indicates no selection.

+            Notice that for the controls with @c wxCB_READONLY style this
+            string must be one of the valid choices if it is not empty.

         @param pos
             Window position.
         @param size
         @param pos
             Window position.
         @param size


@@ -176,47 +195,8 @@ public:
     //@}
 
     /**
     //@}
 
     /**

-        Returns @true if the combobox is editable and there is a text selection
-        to copy to the clipboard. Only available on Windows.
-    */
-    virtual 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.
-    */
-    virtual bool CanCut() 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.
-    */
-    virtual bool CanPaste() const;
-
-    /**
-        Returns @true if the combobox is editable and the last undo can be
-        redone. Only available on Windows.
-    */
-    virtual bool CanRedo() const;
-
-    /**
-        Returns @true if the combobox is editable and the last edit can be
-        undone. Only available on Windows.
-    */
-    virtual bool CanUndo() const;
-
-    /**
-        Copies the selected text to the clipboard.
-    */
-    virtual void Copy();
-
-    /**
-        Copies the selected text to the clipboard and removes the selection.
-    */
-    virtual void Cut();
+        Returns the item being selected right now.

 
 

-    /**

         This function does the same things as wxChoice::GetCurrentSelection()
         and returns the item currently selected in the dropdown list if it's
         open or the same thing as wxControlWithItems::GetSelection() otherwise.
         This function does the same things as wxChoice::GetCurrentSelection()
         and returns the item currently selected in the dropdown list if it's
         open or the same thing as wxControlWithItems::GetSelection() otherwise.


@@ -224,7 +204,7 @@ public:
     virtual int GetCurrentSelection() const;
 
     /**
     virtual int GetCurrentSelection() const;
 
     /**

-        Returns the insertion point for the combobox's text field.
+        Same as wxTextEntry::GetInsertionPoint().

 
         @note Under wxMSW, this function always returns 0 if the combobox
               doesn't have the focus.
 
         @note Under wxMSW, this function always returns 0 if the combobox
               doesn't have the focus.


@@ -232,77 +212,7 @@ public:
     virtual long GetInsertionPoint() const;
 
     /**
     virtual long GetInsertionPoint() const;
 
     /**

-        Returns the last position in the combobox text field.
-    */
-    virtual long GetLastPosition() const;
-
-    /**
-        This is the same as wxTextCtrl::GetSelection() for the text control
-        which is part of the combobox. Notice that this is a different method
-        from wxControlWithItems::GetSelection().
-
-        Currently this method is only implemented in wxMSW and wxGTK.
-    */
-    virtual void GetSelection(long* from, long* to) const;
-
-    /**
-        Returns the current value in the combobox text field.
-    */
-    virtual wxString GetValue() const;
-
-    /**
-        Pastes text from the clipboard to the text field.
-    */
-    virtual void Paste();
-
-    /**
-        Redoes the last undo in the text field. Windows only.
-    */
-    virtual void Redo();
-
-    /**
-        Removes the text between the two positions in the combobox text field.
-
-        @param from
-            The first position.
-        @param to
-            The last position.
-    */
-    virtual void Remove(long from, long to);
-
-    /**
-        Replaces the text between two positions with the given text, in the
-        combobox text field.
-
-        @param from
-            The first position.
-        @param to
-            The second position.
-        @param text
-            The text to insert.
-    */
-    virtual void Replace(long from, long to, const wxString& text);
-
-    /**
-        Sets the insertion point in the combobox text field.
-
-        @param pos
-            The new insertion point.
-    */
-    virtual void SetInsertionPoint(long pos);
-
-    /**
-        Sets the insertion point at the end of the combobox text field.
-    */
-    virtual void SetInsertionPointEnd();
-
-    /**
-        Selects the text between the two positions, in the combobox text field.
-
-        @param from
-            The first position.
-        @param to
-            The second position.
+        Same as wxTextEntry::SetSelection().

 
         @beginWxPythonOnly
         This method is called SetMark() in wxPython, "SetSelection" is kept for
 
         @beginWxPythonOnly
         This method is called SetMark() in wxPython, "SetSelection" is kept for


@@ -322,10 +232,5 @@ public:
             The text to set.
     */
     virtual void SetValue(const wxString& text);
             The text to set.
     */
     virtual void SetValue(const wxString& text);

-
-    /**
-        Undoes the last edit in the text field. Windows only.
-    */
-    virtual void Undo();

 };
 
 };