]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/combobox.h
add default parameters for width and style parameters of FindOrCreatePen() for consis...
[wxWidgets.git] / interface / combobox.h
index b47bb712dc768b6c049c45dc88d3aeae4afe4c5a..082f052cff9af3d820769d767ba8af2d5168d94c 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        combobox.h
-// Purpose:     documentation for wxComboBox class
+// Purpose:     interface of wxComboBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -58,8 +58,7 @@
     @category{ctrl}
     @appearance{combobox.png}
 
-    @seealso
-    wxListBox, wxTextCtrl, wxChoice, wxCommandEvent
+    @see wxListBox, wxTextCtrl, wxChoice, wxCommandEvent
 */
 class wxComboBox : public wxControlWithItems
 {
@@ -67,7 +66,7 @@ public:
     //@{
     /**
         Constructor, creating and showing a combobox.
-        
+
         @param parent
             Parent window. Must not be @NULL.
         @param id
@@ -90,7 +89,7 @@ public:
             Window validator.
         @param name
             Window name.
-        
+
         @see Create(), wxValidator
     */
     wxComboBox();
@@ -123,33 +122,33 @@ public:
         to the clipboard.
         Only available on Windows.
     */
-    bool CanCopy();
+    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.
     */
-    bool CanCut();
+    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.
     */
-    bool CanPaste();
+    bool CanPaste() const;
 
     /**
         Returns @true if the combobox is editable and the last undo can be redone.
         Only available on Windows.
     */
-    bool CanRedo();
+    bool CanRedo() const;
 
     /**
         Returns @true if the combobox is editable and the last edit can be undone.
         Only available on Windows.
     */
-    bool CanUndo();
+    bool CanUndo() const;
 
     /**
         Copies the selected text to the clipboard.
@@ -191,19 +190,19 @@ public:
         returns the item currently selected in the dropdown list if it's open or the
         same thing as wxControlWithItems::GetSelection otherwise.
     */
-    int GetCurrentSelection();
+    int GetCurrentSelection() const;
 
     /**
         Returns the insertion point for the combobox's text field.
         @b Note: Under wxMSW, this function always returns 0 if the combobox
         doesn't have the focus.
     */
-    long GetInsertionPoint();
+    long GetInsertionPoint() const;
 
     /**
         Returns the last position in the combobox text field.
     */
-    virtual wxTextPos GetLastPosition();
+    virtual wxTextPos GetLastPosition() const;
 
     /**
         This is the same as wxTextCtrl::GetSelection
@@ -211,12 +210,12 @@ public:
         different method from wxControlWithItems::GetSelection.
         Currently this method is only implemented in wxMSW and wxGTK.
     */
-    void GetSelection(long* from, long* to);
+    void GetSelection(long* from, long* to) const;
 
     /**
         Returns the current value in the combobox text field.
     */
-    wxString GetValue();
+    wxString GetValue() const;
 
     /**
         Pastes text from the clipboard to the text field.
@@ -230,7 +229,7 @@ public:
 
     /**
         Removes the text between the two positions in the combobox text field.
-        
+
         @param from
             The first position.
         @param to
@@ -241,7 +240,7 @@ public:
     /**
         Replaces the text between two positions with the given text, in the combobox
         text field.
-        
+
         @param from
             The first position.
         @param to
@@ -253,7 +252,7 @@ public:
 
     /**
         Sets the insertion point in the combobox text field.
-        
+
         @param pos
             The new insertion point.
     */
@@ -266,7 +265,7 @@ public:
 
     /**
         Selects the text between the two positions, in the combobox text field.
-        
+
         @param from
             The first position.
         @param to
@@ -278,7 +277,7 @@ public:
         Sets the text for the combobox text field.
         @b NB: For a combobox with @c wxCB_READONLY style the string must be in
         the combobox choices list, otherwise the call to SetValue() is ignored.
-        
+
         @param text
             The text to set.
     */
@@ -289,3 +288,4 @@ public:
     */
     void Undo();
 };
+