Remove wrong const from wxMenu::GetMenuItems() documentation.

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

diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h
index 4ea775ec238dfa2d1af656169eecd3b18a51b891..8a78e9c4c83ad0b507d1602a3fa837d52187dcc2 100644 (file)
--- a/interface/wx/combobox.h
+++ b/interface/wx/combobox.h
@@ -41,7 +41,7 @@
     @style{wxCB_SORT}
            Sorts the entries in the list alphabetically.
     @style{wxTE_PROCESS_ENTER}
-           The control will generate the event wxEVT_COMMAND_TEXT_ENTER
+           The control will generate the event @c wxEVT_COMMAND_TEXT_ENTER
            (otherwise pressing Enter key is either processed internally by the
            control or used for navigation between dialog controls). Windows
            only.
@@ -49,26 +49,26 @@
 
     @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_COMBOBOX(id, func)}
-           Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
+           Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
            the list is selected. Note that calling GetValue() returns the new
            value of selection.
     @event{EVT_TEXT(id, func)}
-           Process a wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text
+           Process a @c wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text
            changes.
     @event{EVT_TEXT_ENTER(id, func)}
-           Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
+           Process a @c 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_COMBOBOX_DROPDOWN(id, func)}
-           Process a wxEVT_COMMAND_COMBOBOX_DROPDOWN event, which is generated
+           Process a @c 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_COMBOBOX_CLOSEUP(id, func)}
-           Process a wxEVT_COMMAND_COMBOBOX_CLOSEUP event, which is generated
+           Process a @c 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. Also note that only wxMSW
+           @c wxEVT_COMMAND_COMBOBOX_DROPDOWN above. Also note that only wxMSW
            supports adding or deleting items in this event.
     @endEventTable
 
@@ -224,6 +224,39 @@ public:
     */
     virtual long GetInsertionPoint() const;
 
+    /**
+        IsEmpty() is not available in this class.
+
+        This method is documented here only to notice that it can't be used
+        with this class because of the ambiguity between the methods with the
+        same name inherited from wxItemContainer and wxTextEntry base classes.
+
+        Because of this, any attempt to call it results in a compilation error
+        and you should use either IsListEmpty() or IsTextEmpty() depending on
+        what exactly do you want to test.
+     */
+    bool IsEmpty() const;
+
+    /**
+        Returns true if the list of combobox choices is empty.
+
+        Use this method instead of (not available in this class) IsEmpty() to
+        test if the list of items is empty.
+
+        @since 2.9.3
+     */
+    bool IsListEmpty() const;
+
+    /**
+        Returns true if the text of the combobox is empty.
+
+        Use this method instead of (not available in this class) IsEmpty() to
+        test if the text currently entered into the combobox is empty.
+
+        @since 2.9.3
+     */
+    bool IsTextEmpty() const;
+
     /**
         Same as wxTextEntry::SetSelection().
 
@@ -237,7 +270,7 @@ public:
     /**
         Sets the text for the combobox text field.
 
-        Notice that this method will generate a wxEVT_COMMAND_TEXT_UPDATED
+        Notice that this method will generate a @c wxEVT_COMMAND_TEXT_UPDATED
         event, use wxTextEntry::ChangeValue() if this is undesirable.
 
         @note For a combobox with @c wxCB_READONLY style the string must be in
@@ -252,10 +285,11 @@ public:
     /**
         Shows the list box portion of the combo box.
 
-        Currently only implemented in wxMSW and wxGTK.
+        Currently this method is implemented in wxMSW, wxGTK and wxOSX/Cocoa.
 
         Notice that calling this function will generate a
-        wxEVT_COMMAND_COMBOBOX_DROPDOWN event.
+        @c wxEVT_COMMAND_COMBOBOX_DROPDOWN event except under wxOSX where
+        generation of this event is not supported at all.
 
         @since 2.9.1
     */
@@ -264,13 +298,32 @@ public:
     /**
         Hides the list box portion of the combo box.
 
-        Currently only implemented in wxMSW and wxGTK.
+        Currently this method is implemented in wxMSW, wxGTK and wxOSX/Cocoa.
 
         Notice that calling this function will generate a
-        wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
+        @c wxEVT_COMMAND_COMBOBOX_CLOSEUP event except under wxOSX where
+        generation of this event is not supported at all.
 
         @since 2.9.1
     */
     virtual void Dismiss();
+
+    virtual int GetSelection() const;
+    virtual void GetSelection(long *from, long *to) const;
+    virtual void SetSelection(int n);
+    virtual int FindString(const wxString& s, bool bCase = false) const;
+    virtual wxString GetString(unsigned int n) const;
+    virtual wxString GetStringSelection() const;
+
+    /**
+        Changes the text of the specified combobox item.
+
+        Notice that if the item is the currently selected one, i.e. if its text
+        is displayed in the text part of the combobox, then the text is also
+        replaced with the new @a text.
+     */
+    virtual void SetString(unsigned int n, const wxString& text);
+
+    virtual unsigned int GetCount() const;
 };