X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..0ce6d6c89a540e707c4a91238e6460c0e4bae2a6:/interface/combobox.h?ds=sidebyside diff --git a/interface/combobox.h b/interface/combobox.h index a3d2dc584a..ac98f43f63 100644 --- a/interface/combobox.h +++ b/interface/combobox.h @@ -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 @@ -18,9 +18,8 @@ A combobox permits a single selection only. Combobox items are numbered from zero. - 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. @beginStyleTable @style{wxCB_SIMPLE}: @@ -40,7 +39,7 @@ only. @endStyleTable - @beginEventTable + @beginEventTable{wxCommandEvent} @event{EVT_COMBOBOX(id, func)}: Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on the list is selected. Note that calling GetValue returns the new @@ -58,8 +57,7 @@ @category{ctrl} @appearance{combobox.png} - @seealso - wxListBox, wxTextCtrl, wxChoice, wxCommandEvent + @see wxListBox, wxTextCtrl, wxChoice, wxCommandEvent */ class wxComboBox : public wxControlWithItems { @@ -67,7 +65,7 @@ public: //@{ /** Constructor, creating and showing a combobox. - + @param parent Parent window. Must not be @NULL. @param id @@ -90,7 +88,7 @@ public: Window validator. @param name Window name. - + @see Create(), wxValidator */ wxComboBox(); @@ -230,7 +228,7 @@ public: /** Removes the text between the two positions in the combobox text field. - + @param from The first position. @param to @@ -241,7 +239,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 +251,7 @@ public: /** Sets the insertion point in the combobox text field. - + @param pos The new insertion point. */ @@ -266,7 +264,7 @@ public: /** Selects the text between the two positions, in the combobox text field. - + @param from The first position. @param to @@ -276,9 +274,10 @@ 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. - + + @note 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(); }; +