interface/editlbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        editlbox.h
   3 // Purpose:     documentation for wxEditableListBox class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxEditableListBox
  11     @wxheader{editlbox.h}
  12
  13     An editable listbox is composite control that lets the
  14     user easily enter, delete and reorder a list of strings.
  15
  16     @beginStyleTable
  17     @style{wxEL_ALLOW_NEW}:
  18            Allows the user to enter new strings.
  19     @style{wxEL_ALLOW_EDIT}:
  20            Allows the user to edit existing strings.
  21     @style{wxEL_ALLOW_DELETE}:
  22            Allows the user to delete existing strings.
  23     @style{wxEL_NO_REORDER}:
  24            Does not allow the user to reorder the strings.
  25     @style{wxEL_DEFAULT_STYLE}:
  26            wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE
  27     @endStyleTable
  28
  29     @library{wxadv}
  30     @category{FIXME}
  31
  32     @seealso
  33     wxListBox
  34 */
  35 class wxEditableListBox : public wxPanel
  36 {
  37 public:
  38     //@{
  39     /**
  40         Constructor, creating and showing a list box.
  41
  42         @param parent
  43             Parent window. Must not be @NULL.
  44         @param id
  45             Window identifier. The value wxID_ANY indicates a default value.
  46         @param label
  47             The text shown just before the list control.
  48         @param pos
  49             Window position.
  50         @param size
  51             Window size. If wxDefaultSize is specified then the window is
  52         sized
  53             appropriately.
  54         @param style
  55             Window style. See wxEditableListBox.
  56         @param name
  57             Window name.
  58
  59         @see Create()
  60     */
  61     wxEditableListBox();
  62     wxEditableListBox(wxWindow* parent, wxWindowID id,
  63                       const wxString& label,
  64                       const wxPoint& pos = wxDefaultPosition,
  65                       const wxSize& size = wxDefaultSize,
  66                       long style = wxEL_DEFAULT_STYLE,
  67                       const wxString& name = "editableListBox");
  68     //@}
  69
  70     /**
  71         Destructor, destroying the list box.
  72     */
  73     ~wxEditableListBox();
  74
  75     /**
  76         Creates the editable listbox for two-step construction. See wxEditableListBox()
  77         for further details.
  78     */
  79     bool Create(wxWindow* parent, wxWindowID id,
  80                 const wxString& label,
  81                 const wxPoint& pos = wxDefaultPosition,
  82                 const wxSize& size = wxDefaultSize,
  83                 long style = wxEL_DEFAULT_STYLE,
  84                 const wxString& name = "editableListBox");
  85
  86     /**
  87         Replaces current contents with given strings.
  88     */
  89     void SetStrings(const wxArrayString& strings);
  90 };