X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..3ed3a1c846d66410872a15f746c432311e306e42:/interface/editlbox.h diff --git a/interface/editlbox.h b/interface/editlbox.h index c6c3bec5d4..ae0dcb2c22 100644 --- a/interface/editlbox.h +++ b/interface/editlbox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: editlbox.h -// Purpose: documentation for wxEditableListBox class +// Purpose: interface of wxEditableListBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -10,35 +10,38 @@ @class wxEditableListBox @wxheader{editlbox.h} - An editable listbox is composite control that lets the - user easily enter, delete and reorder a list of strings. + An editable listbox is composite control that lets the user easily enter, + delete and reorder a list of strings. @beginStyleTable - @style{wxEL_ALLOW_NEW}: + @style{wxEL_ALLOW_NEW} Allows the user to enter new strings. - @style{wxEL_ALLOW_EDIT}: + @style{wxEL_ALLOW_EDIT} Allows the user to edit existing strings. - @style{wxEL_ALLOW_DELETE}: + @style{wxEL_ALLOW_DELETE} Allows the user to delete existing strings. - @style{wxEL_NO_REORDER}: + @style{wxEL_NO_REORDER} Does not allow the user to reorder the strings. - @style{wxEL_DEFAULT_STYLE}: - wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE + @style{wxEL_DEFAULT_STYLE} + Default style: wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE. @endStyleTable @library{wxadv} - @category{FIXME} + @category{ctrl} - @seealso - wxListBox + @see wxListBox */ class wxEditableListBox : public wxPanel { public: - //@{ + /** + Default ctor. + */ + wxEditableListBox(); + /** Constructor, creating and showing a list box. - + @param parent Parent window. Must not be @NULL. @param id @@ -48,24 +51,21 @@ public: @param pos Window position. @param size - Window size. If wxDefaultSize is specified then the window is - sized + Window size. If wxDefaultSize is specified then the window is sized appropriately. @param style Window style. See wxEditableListBox. @param name Window name. - + @see Create() */ - wxEditableListBox(); wxEditableListBox(wxWindow* parent, wxWindowID id, const wxString& label, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxEL_DEFAULT_STYLE, const wxString& name = "editableListBox"); - //@} /** Destructor, destroying the list box. @@ -73,8 +73,8 @@ public: ~wxEditableListBox(); /** - Creates the editable listbox for two-step construction. See wxEditableListBox() - for further details. + Creates the editable listbox for two-step construction. + See wxEditableListBox() for further details. */ bool Create(wxWindow* parent, wxWindowID id, const wxString& label, @@ -87,4 +87,12 @@ public: Replaces current contents with given strings. */ void SetStrings(const wxArrayString& strings); + + + /** + Returns in the given array the current contents of the control + (the array will be erased before control's contents are appended). + */ + void GetSelections(wxArrayString& strings) const; }; +