docs/latex/wx/editlistbox.tex

   1 \section{\class{wxEditableListBox}}\label{wxeditablelistbox}
   2
   3 An editable listbox is composite control that lets the
   4 user easily enter, delete and reorder a list of strings.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxPanel}{wxpanel}\\
   9 \helpref{wxWindow}{wxwindow}\\
  10 \helpref{wxEvtHandler}{wxevthandler}\\
  11 \helpref{wxObject}{wxobject}
  12
  13 \wxheading{Include files}
  14
  15 <wx/editlbox.h>
  16
  17 \wxheading{Window styles}
  18
  19 \twocolwidtha{5cm}%
  20 \begin{twocollist}\itemsep=0pt
  21 \twocolitem{\windowstyle{wxEL\_ALLOW\_NEW}}{Allows the user to enter new strings.}
  22 \twocolitem{\windowstyle{wxEL\_ALLOW\_EDIT}}{Allows the user to edit existing strings.}
  23 \twocolitem{\windowstyle{wxEL\_ALLOW\_DELETE}}{Allows the user to delete existing strings.}
  24 \twocolitem{\windowstyle{wxEL\_NO\_REORDER}}{Does not allow the user to reorder the strings.}
  25 \twocolitem{\windowstyle{wxEL\_DEFAULT\_STYLE}}{wxEL\_ALLOW\_NEW|wxEL\_ALLOW\_EDIT|wxEL\_ALLOW\_DELETE}
  26 \end{twocollist}
  27
  28 See also \helpref{window styles overview}{windowstyles}.
  29
  30 \wxheading{See also}
  31
  32 \helpref{wxListBox}{wxlistbox}
  33
  34 \latexignore{\rtfignore{\wxheading{Members}}}
  35
  36 \membersection{wxEditableListBox::wxEditableListBox}\label{wxeditablelistboxctor}
  37
  38 \func{}{wxEditableListBox}{\void}
  39
  40 Default constructor.
  41
  42 \func{}{wxEditableListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
  43 \param{const wxString\&}{ label},\param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
  44 \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
  45 \param{long}{ style = wxEL\_DEFAULT\_STYLE}, \param{const wxString\& }{name = ``editableListBox"}}
  46
  47 Constructor, creating and showing a list box.
  48
  49 \wxheading{Parameters}
  50
  51 \docparam{parent}{Parent window. Must not be NULL.}
  52
  53 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
  54
  55 \docparam{label}{The text shown just before the list control.}
  56
  57 \docparam{pos}{Window position.}
  58
  59 \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
  60 appropriately.}
  61
  62 \docparam{style}{Window style. See \helpref{wxEditableListBox}{wxeditablelistbox}.}
  63
  64 \docparam{name}{Window name.}
  65
  66 \wxheading{See also}
  67
  68 \helpref{wxEditableListBox::Create}{wxeditablelistboxcreate}
  69
  70 \membersection{wxEditableListBox::\destruct{wxEditableListBox}}\label{wxeditablelistboxdtor}
  71
  72 \func{void}{\destruct{wxEditableListBox}}{\void}
  73
  74 Destructor, destroying the list box.
  75
  76 \membersection{wxEditableListBox::Create}\label{wxeditablelistboxcreate}
  77
  78 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
  79 \param{const wxString\&}{ label},\param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
  80 \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
  81 \param{long}{ style = wxEL\_DEFAULT\_STYLE}, \param{const wxString\& }{name = ``editableListBox"}}
  82
  83 Creates the editable listbox for two-step construction. See \helpref{wxEditableListBox::wxEditableListBox}{wxeditablelistboxctor}\rtfsp
  84 for further details.
  85
  86 \membersection{wxEditableListBox::SetStrings}\label{wxeditablelistboxsetstrings}
  87
  88 \func{void}{SetStrings}{\param{const wxArrayString\&}{ strings}}
  89
  90 Replaces current contents with given strings.
  91
  92 \membersection{wxEditableListBox::GetStrings}\label{wxeditablelistboxgetstrings}
  93
  94 \constfunc{void}{GetSelections}{\param{wxArrayString\& }{strings}}
  95
  96 Returns in the given array the current contents of the control
  97 (the array will be erased before control's contents are appended).