[wxWidgets.git] / docs / latex / wx / editlistbox.tex

\section{\class{wxEditableListBox}}\label{wxeditablelistbox}

An editable listbox is composite control that lets the
user easily enter, delete and reorder a list of strings.

\wxheading{Derived from}

\helpref{wxPanel}{wxpanel}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/editlbox.h>

\wxheading{Library}

\helpref{wxAdv}{librarieslist}

\wxheading{Window styles}

\twocolwidtha{5cm}%
\begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxEL\_ALLOW\_NEW}}{Allows the user to enter new strings.}
\twocolitem{\windowstyle{wxEL\_ALLOW\_EDIT}}{Allows the user to edit existing strings.}
\twocolitem{\windowstyle{wxEL\_ALLOW\_DELETE}}{Allows the user to delete existing strings.}
\twocolitem{\windowstyle{wxEL\_NO\_REORDER}}{Does not allow the user to reorder the strings.}
\twocolitem{\windowstyle{wxEL\_DEFAULT\_STYLE}}{wxEL\_ALLOW\_NEW|wxEL\_ALLOW\_EDIT|wxEL\_ALLOW\_DELETE}
\end{twocollist}

See also \helpref{window styles overview}{windowstyles}.

\wxheading{See also}

\helpref{wxListBox}{wxlistbox}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxEditableListBox::wxEditableListBox}\label{wxeditablelistboxctor}

\func{}{wxEditableListBox}{\void}

Default constructor.

\func{}{wxEditableListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxString\&}{ label},\param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{long}{ style = wxEL\_DEFAULT\_STYLE}, \param{const wxString\& }{name = ``editableListBox"}}

Constructor, creating and showing a list box.

\wxheading{Parameters}

\docparam{parent}{Parent window. Must not be NULL.}

\docparam{id}{Window identifier. A value of -1 indicates a default value.}

\docparam{label}{The text shown just before the list control.}

\docparam{pos}{Window position.}

\docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
appropriately.}

\docparam{style}{Window style. See \helpref{wxEditableListBox}{wxeditablelistbox}.}

\docparam{name}{Window name.}

\wxheading{See also}

\helpref{wxEditableListBox::Create}{wxeditablelistboxcreate}

\membersection{wxEditableListBox::\destruct{wxEditableListBox}}\label{wxeditablelistboxdtor}

\func{void}{\destruct{wxEditableListBox}}{\void}

Destructor, destroying the list box.

\membersection{wxEditableListBox::Create}\label{wxeditablelistboxcreate}

\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxString\&}{ label},\param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
\param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{long}{ style = wxEL\_DEFAULT\_STYLE}, \param{const wxString\& }{name = ``editableListBox"}}

Creates the editable listbox for two-step construction. See \helpref{wxEditableListBox::wxEditableListBox}{wxeditablelistboxctor}\rtfsp
for further details.

\membersection{wxEditableListBox::SetStrings}\label{wxeditablelistboxsetstrings}

\func{void}{SetStrings}{\param{const wxArrayString\&}{ strings}}

Replaces current contents with given strings.

\membersection{wxEditableListBox::GetStrings}\label{wxeditablelistboxgetstrings}

\constfunc{void}{GetSelections}{\param{wxArrayString\& }{strings}}

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