interface/editlbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        editlbox.h
   3 // Purpose:     interface of wxEditableListBox
   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     @see wxListBox
  33 */
  34 class wxEditableListBox : public wxPanel
  35 {
  36 public:
  37     //@{
  38     /**
  39         Constructor, creating and showing a list box.
  40
  41         @param parent
  42             Parent window. Must not be @NULL.
  43         @param id
  44             Window identifier. The value wxID_ANY indicates a default value.
  45         @param label
  46             The text shown just before the list control.
  47         @param pos
  48             Window position.
  49         @param size
  50             Window size. If wxDefaultSize is specified then the window is
  51         sized
  52             appropriately.
  53         @param style
  54             Window style. See wxEditableListBox.
  55         @param name
  56             Window name.
  57
  58         @see Create()
  59     */
  60     wxEditableListBox();
  61     wxEditableListBox(wxWindow* parent, wxWindowID id,
  62                       const wxString& label,
  63                       const wxPoint& pos = wxDefaultPosition,
  64                       const wxSize& size = wxDefaultSize,
  65                       long style = wxEL_DEFAULT_STYLE,
  66                       const wxString& name = "editableListBox");
  67     //@}
  68
  69     /**
  70         Destructor, destroying the list box.
  71     */
  72     ~wxEditableListBox();
  73
  74     /**
  75         Creates the editable listbox for two-step construction. See wxEditableListBox()
  76         for further details.
  77     */
  78     bool Create(wxWindow* parent, wxWindowID id,
  79                 const wxString& label,
  80                 const wxPoint& pos = wxDefaultPosition,
  81                 const wxSize& size = wxDefaultSize,
  82                 long style = wxEL_DEFAULT_STYLE,
  83                 const wxString& name = "editableListBox");
  84
  85     /**
  86         Replaces current contents with given strings.
  87     */
  88     void SetStrings(const wxArrayString& strings);
  89 };
  90