]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/listbox.tex
don't make read-only text controls editable when enabled
[wxWidgets.git] / docs / latex / wx / listbox.tex
index 0c6c93ec27e5edaab11422af746e2a26dc04f66a..ab6ffc3709d21589b85c8c906d3c258b220e52ac 100644 (file)
@@ -7,13 +7,15 @@ is selected, the previous selection is removed) or multiple selection
 (clicking an item toggles the item on or off independently of other
 selections).
 
 (clicking an item toggles the item on or off independently of other
 selections).
 
-List box elements are numbered from zero.
+List box elements are numbered from zero. Their number may be limited
+under some platforms.
 
 
-A listbox callback gets an event wxEVT\_COMMAND\_LISTBOX\_SELECT for single clicks, and
+A listbox callback gets an event wxEVT\_COMMAND\_LISTBOX\_SELECTED for single clicks, and
 wxEVT\_COMMAND\_LISTBOX\_DOUBLE\_CLICKED for double clicks.
 
 \wxheading{Derived from}
 
 wxEVT\_COMMAND\_LISTBOX\_DOUBLE\_CLICKED for double clicks.
 
 \wxheading{Derived from}
 
+\helpref{wxControlWithItems}{wxcontrolwithitems}\\
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
@@ -38,6 +40,10 @@ select multiple items using the SHIFT key and the mouse or special key combinati
 \twocolitem{\windowstyle{wxLB\_SORT}}{The listbox contents are sorted in alphabetical order.}
 \end{twocollist}
 
 \twocolitem{\windowstyle{wxLB\_SORT}}{The listbox contents are sorted in alphabetical order.}
 \end{twocollist}
 
+Note that {\tt wxLB\_SINGLE}, {\tt wxLB\_MULTIPLE} and {\tt wxLB\_EXTENDED}
+styles are mutually exclusive and you can specify at most one of them (single
+selection is the default).
+
 See also \helpref{window styles overview}{windowstyles}.
 
 \wxheading{Event handling}
 See also \helpref{window styles overview}{windowstyles}.
 
 \wxheading{Event handling}
@@ -45,9 +51,9 @@ See also \helpref{window styles overview}{windowstyles}.
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_LISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_SELECTED event,
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_LISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_SELECTED event,
-when an item on the list is selected.}
+when an item on the list is selected or the selection changes.}
 \twocolitem{{\bf EVT\_LISTBOX\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_DOUBLECLICKED event,
 \twocolitem{{\bf EVT\_LISTBOX\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_DOUBLECLICKED event,
-when the listbox is doubleclicked.}
+when the listbox is double-clicked.}
 \end{twocollist}
 
 \wxheading{See also}
 \end{twocollist}
 
 \wxheading{See also}
@@ -57,7 +63,7 @@ when the listbox is doubleclicked.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxListBox::wxListBox}\label{wxlistboxconstr}
+\membersection{wxListBox::wxListBox}\label{wxlistboxctor}
 
 \func{}{wxListBox}{\void}
 
 
 \func{}{wxListBox}{\void}
 
@@ -65,7 +71,12 @@ Default constructor.
 
 \func{}{wxListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
 
 \func{}{wxListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
-\param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
+\param{int}{ n = 0}, \param{const wxString }{choices[] = NULL},\rtfsp
+\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
+
+\func{}{wxListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
+\param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size},\rtfsp
+\param{const wxArrayString\& }{choices},\rtfsp
 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
 
 Constructor, creating and showing a list box.
 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
 
 Constructor, creating and showing a list box.
@@ -95,41 +106,19 @@ appropriately.}
 
 \helpref{wxListBox::Create}{wxlistboxcreate}, \helpref{wxValidator}{wxvalidator}
 
 
 \helpref{wxListBox::Create}{wxlistboxcreate}, \helpref{wxValidator}{wxvalidator}
 
-\pythonnote{The wxListBox constructor in wxPython reduces the \tt{n}
-and \tt{choices} arguments are to a single argument, which is
+\pythonnote{The wxListBox constructor in wxPython reduces the {\tt n}
+and {\tt choices} arguments are to a single argument, which is
 a list of strings.}
 
 a list of strings.}
 
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
 
 
-
-\membersection{wxListBox::\destruct{wxListBox}}
+\membersection{wxListBox::\destruct{wxListBox}}\label{wxlistboxdtor}
 
 \func{void}{\destruct{wxListBox}}{\void}
 
 Destructor, destroying the list box.
 
 
 \func{void}{\destruct{wxListBox}}{\void}
 
 Destructor, destroying the list box.
 
-\membersection{wxListBox::Append}\label{wxlistboxappend}
-
-\func{void}{Append}{\param{const wxString\& }{ item}}
-
-Adds the item to the end of the list box.
-
-\func{void}{Append}{\param{const wxString\& }{ item}, \param{char* }{clientData}}
-
-Adds the item to the end of the list box, associating the given data
-with the item.
-
-\wxheading{Parameters}
-
-\docparam{item}{String to add.}
-
-\docparam{clientData}{Client data to associate with the item.}
-
-\membersection{wxListBox::Clear}\label{wxlistboxclear}
-
-\func{void}{Clear}{\void}
-
-Clears all strings from the list box.
-
 \membersection{wxListBox::Create}\label{wxlistboxcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
 \membersection{wxListBox::Create}\label{wxlistboxcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
@@ -137,18 +126,13 @@ Clears all strings from the list box.
 \param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
 
 \param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
 
-Creates the listbox for two-step construction. See \helpref{wxListBox::wxListBox}{wxlistboxconstr}\rtfsp
-for further details.
-
-\membersection{wxListBox::Delete}\label{wxlistboxdelete}
-
-\func{void}{Delete}{\param{int}{ n}}
-
-Deletes an item from the listbox.
-
-\wxheading{Parameters}
+\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
+\param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size},\rtfsp
+\param{const wxArrayString\& }{choices},\rtfsp
+\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
 
 
-\docparam{n}{The zero-based item index.}
+Creates the listbox for two-step construction. See \helpref{wxListBox::wxListBox}{wxlistboxctor}\rtfsp
+for further details.
 
 \membersection{wxListBox::Deselect}\label{wxlistboxdeselect}
 
 
 \membersection{wxListBox::Deselect}\label{wxlistboxdeselect}
 
@@ -164,64 +148,15 @@ Deselects an item in the list box.
 
 This applies to multiple selection listboxes only.
 
 
 This applies to multiple selection listboxes only.
 
-\membersection{wxListBox::FindString}\label{wxlistboxfindstring}
-
-\func{int}{FindString}{\param{const wxString\& }{string}}
-
-Finds an item matching the given string.
-
-\wxheading{Parameters}
-
-\docparam{string}{String to find.}
-
-\wxheading{Return value}
-
-The zero-based position of the item, or -1 if the string was not found.
-
-\membersection{wxListBox::GetClientData}\label{wxlistboxgetclientdata}
-
-\constfunc{char*}{GetClientData}{\param{int}{ n}}
-
-Returns a pointer to the client data associated with the given item (if any).
-
-\wxheading{Parameters}
-
-\docparam{n}{The zero-based position of the item.}
-
-\wxheading{Return value}
-
-A pointer to the client data, or NULL if not present.
-
-\membersection{wxListBox::GetSelection}\label{wxlistboxgetselection}
-
-\constfunc{int}{GetSelection}{\void}
-
-Gets the position of the selected item.
-
-\wxheading{Return value}
-
-The position of the current selection.
-
-\wxheading{Remarks}
-
-Applicable to single selection list boxes only.
-
-\wxheading{See also}
-
-\helpref{wxListBox::SetSelection}{wxlistboxsetselection},\rtfsp
-\helpref{wxListBox::GetStringSelection}{wxlistboxgetstringselection},\rtfsp
-\helpref{wxListBox::GetSelections}{wxlistboxgetselections}
-
 \membersection{wxListBox::GetSelections}\label{wxlistboxgetselections}
 
 \membersection{wxListBox::GetSelections}\label{wxlistboxgetselections}
 
-\constfunc{int}{GetSelections}{\param{int **}{selections}}
+\constfunc{int}{GetSelections}{\param{wxArrayInt\& }{selections}}
 
 
-Gets an array containing the positions of the selected strings.
+Fill an array of ints with the positions of the currently selected items.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 
-\docparam{selections}{A pointer to an integer array, which will be allocated by the function if
-selects are present. Do not deallocate the returned array - it will be deallocated by the listbox.}
+\docparam{selections}{A reference to an wxArrayInt instance that is used to store the result of the query.}
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 
@@ -233,41 +168,21 @@ Use this with a multiple selection listbox.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 
-\helpref{wxListBox::GetSelection}{wxlistboxgetselection},\rtfsp
-\helpref{wxListBox::GetStringSelection}{wxlistboxgetstringselection},\rtfsp
-\helpref{wxListBox::SetSelection}{wxlistboxsetselection}
-
-\membersection{wxListBox::GetString}\label{wxlistboxgetstring}
-
-\constfunc{wxString}{GetString}{\param{int}{ n}}
-
-Returns the string at the given position.
-
-\wxheading{Parameters}
-
-\docparam{n}{The zero-based position.}
-
-\wxheading{Return value}
-
-The string, or an empty string if the position was invalid.
-
-\membersection{wxListBox::GetStringSelection}\label{wxlistboxgetstringselection}
-
-\constfunc{wxString}{GetStringSelection}{\void}
-
-Gets the selected string - for single selection list boxes only. This
-must be copied by the calling program if long term use is to be made of
-it.
+\helpref{wxControlWithItems::GetSelection}{wxcontrolwithitemsgetselection},\rtfsp
+\helpref{wxControlWithItems::GetStringSelection}{wxcontrolwithitemsgetstringselection},\rtfsp
+\helpref{wxControlWithItems::SetSelection}{wxcontrolwithitemssetselection}
 
 
-\wxheading{See also}
+\pythonnote{The wxPython version of this method takes no parameters
+and returns a tuple of the selected items.}
 
 
-\helpref{wxListBox::GetSelection}{wxlistboxgetselection},\rtfsp
-\helpref{wxListBox::GetSelections}{wxlistboxgetselections},\rtfsp
-\helpref{wxListBox::SetSelection}{wxlistboxsetselection}
+\perlnote{In wxPerl this method takes no parameters and return the
+selected items as a list.}
 
 \membersection{wxListBox::InsertItems}\label{wxlistboxinsertitems}
 
 
 \membersection{wxListBox::InsertItems}\label{wxlistboxinsertitems}
 
-\func{void}{InsertItems}{\param{int}{ nItems}, \param{const wxString}{ items}, \param{int}{ pos}}
+\func{void}{InsertItems}{\param{int}{ nItems}, \param{const wxString}{ *items}, \param{unsigned int}{ pos}}
+
+\func{void}{InsertItems}{\param{const wxArrayString\&}{ nItems}, \param{unsigned int}{ pos}}
 
 Insert the given number of strings before the specified position.
 
 
 Insert the given number of strings before the specified position.
 
@@ -280,54 +195,65 @@ Insert the given number of strings before the specified position.
 \docparam{pos}{Position before which to insert the items: for example, if {\it pos} is 0 the items
 will be inserted in the beginning of the listbox}
 
 \docparam{pos}{Position before which to insert the items: for example, if {\it pos} is 0 the items
 will be inserted in the beginning of the listbox}
 
-\membersection{wxListBox::Number}\label{wxlistboxnumber}
+\pythonnote{The first two parameters are collapsed into a single
+parameter for wxPython, which is a list of strings.}
 
 
-\constfunc{int}{Number}{\void}
+\perlnote{In wxPerl there is just an array reference in place of {\tt nItems}
+and {\tt items}.}
 
 
-Returns the number of items in the listbox.
+\membersection{wxListBox::HitTest}\label{wxlistboxhittest}
 
 
-\membersection{wxListBox::Selected}\label{wxlistboxselected}
+\constfunc{int}{HitTest}{\param{const wxPoint&}{ point}}
 
 
-\constfunc{bool}{Selected}{\param{int}{ n}}
+Returns the item located at \arg{point}, or \texttt{wxNOT\_FOUND} if there
+is no item located at \arg{point}.
 
 
-Determines whether an item is selected.
+\newsince{2.7.0}. It is currently implemented for wxMSW, wxMac and wxGTK2
+ports.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 
-\docparam{n}{The zero-based item index.}
+\docparam{point}{Point of item (in client coordinates) to obtain}
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 
-TRUE if the given item is selected, FALSE otherwise.
+Item located at \arg{point}, or \texttt{wxNOT\_FOUND} if unimplemented
+or the item does not exist.
 
 
-\membersection{wxListBox::Set}\label{wxlistboxset}
+\membersection{wxListBox::IsSelected}\label{wxlistboxisselected}
 
 
-\func{void}{Set}{\param{int}{ n}, \param{const wxString*}{ choices}}
+\constfunc{bool}{IsSelected}{\param{int}{ n}}
 
 
-Clears the list box and adds the given strings.
+Determines whether an item is selected.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 
-\docparam{n}{The number of strings to set.}
+\docparam{n}{The zero-based item index.}
 
 
-\docparam{choices}{An array of strings to set.}
+\wxheading{Return value}
 
 
-\wxheading{Remarks}
+true if the given item is selected, false otherwise.
 
 
-Deallocate the array from the calling program
-after this function has been called.
+\membersection{wxListBox::Set}\label{wxlistboxset}
 
 
-\membersection{wxListBox::SetClientData}\label{wxlistboxsetclientdata}
+\func{void}{Set}{\param{int}{ n}, \param{const wxString*}{ choices}, \param{void}{ **clientData = {\tt NULL}}}
 
 
-\func{void}{SetClientData}{\param{int}{ n}, \param{char* }{data}}
+\func{void}{Set}{\param{const wxArrayString\&}{ choices}, \param{void}{ **clientData = {\tt NULL}}}
 
 
-Associates the given client data pointer with the given item.
+Clears the list box and adds the given strings to it.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 
-\docparam{n}{The zero-based item index.}
+\docparam{n}{The number of strings to set.}
 
 
-\docparam{data}{The client data to associate with the item.}
+\docparam{choices}{An array of strings to set.}
+
+\docparam{clientData}{Options array of client data pointers}
+
+\wxheading{Remarks}
+
+You may free the array from the calling program after this function has been
+called.
 
 \membersection{wxListBox::SetFirstItem}\label{wxlistboxsetfirstitem}
 
 
 \membersection{wxListBox::SetFirstItem}\label{wxlistboxsetfirstitem}
 
@@ -343,39 +269,3 @@ Set the specified item to be the first visible item.
 
 \docparam{string}{The string that should be visible.}
 
 
 \docparam{string}{The string that should be visible.}
 
-\membersection{wxListBox::SetSelection}\label{wxlistboxsetselection}
-
-\func{void}{SetSelection}{\param{int}{ n}, \param{const bool }{select = TRUE}}
-
-Selects or deselects the given item.
-
-\wxheading{Parameters}
-
-\docparam{n}{The zero-based item index.}
-
-\docparam{select}{If TRUE, will select the item. If FALSE, will deselect it.}
-
-\membersection{wxListBox::SetString}\label{wxlistboxsetstring}
-
-\func{void}{SetString}{\param{int}{ n}, \param{const wxString\& }{ string}}
-
-Sets the string value of an item.
-
-\wxheading{Parameters}
-
-\docparam{n}{The zero-based item index.}
-
-\docparam{string}{The string to set.}
-
-\membersection{wxListBox::SetStringSelection}\label{wxlistboxsetstringselection}
-
-\func{void}{SetStringSelection}{\param{const wxString\& }{ string}, \param{const bool}{ select = TRUE}}
-
-Sets the current selection.
-
-\wxheading{Parameters}
-
-\docparam{string}{The item to select.}
-
-\docparam{select}{If TRUE, will select the item. If FALSE, will deselect it.}
-