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
  45         @param id
  46         Window identifier. The value wxID_ANY indicates a default value.
  47
  48         @param label
  49         The text shown just before the list control.
  50
  51         @param pos
  52         Window position.
  53
  54         @param size
  55         Window size. If wxDefaultSize is specified then the window is sized
  56         appropriately.
  57
  58         @param style
  59         Window style. See wxEditableListBox.
  60
  61         @param name
  62         Window name.
  63
  64         @sa Create()
  65     */
  66     wxEditableListBox();
  67     wxEditableListBox(wxWindow* parent, wxWindowID id,
  68                       const wxString& label,
  69                       const wxPoint& pos = wxDefaultPosition,
  70                       const wxSize& size = wxDefaultSize,
  71                       long style = wxEL_DEFAULT_STYLE,
  72                       const wxString& name = "editableListBox");
  73     //@}
  74
  75     /**
  76         Destructor, destroying the list box.
  77     */
  78     ~wxEditableListBox();
  79
  80     /**
  81         Creates the editable listbox for two-step construction. See wxEditableListBox()
  82         for further details.
  83     */
  84     bool Create(wxWindow* parent, wxWindowID id,
  85                 const wxString& label,
  86                 const wxPoint& pos = wxDefaultPosition,
  87                 const wxSize& size = wxDefaultSize,
  88                 long style = wxEL_DEFAULT_STYLE,
  89                 const wxString& name = "editableListBox");
  90
  91     /**
  92         Replaces current contents with given strings.
  93     */
  94     void SetStrings(const wxArrayString& strings);
  95 };