X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/28ca76100ebffe6698f4ee33a503b5b1c21168fc..fbb2b01c2cef520bd91af451d8d18e4219b0a0c6:/docs/latex/wx/listbox.tex diff --git a/docs/latex/wx/listbox.tex b/docs/latex/wx/listbox.tex index 5954ebf2a3..e19a2e32ec 100644 --- a/docs/latex/wx/listbox.tex +++ b/docs/latex/wx/listbox.tex @@ -52,7 +52,7 @@ See also \helpref{window styles overview}{windowstyles}. \twocolitem{{\bf EVT\_LISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_SELECTED event, when an item on the list is selected.} \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} @@ -115,11 +115,11 @@ Destructor, destroying the list box. \membersection{wxListBox::Append}\label{wxlistboxappend} -\func{void}{Append}{\param{const wxString\& }{ item}} +\func{int}{Append}{\param{const wxString\& }{ item}} Adds the item to the end of the list box. -\func{void}{Append}{\param{const wxString\& }{ item}, \param{void* }{clientData}} +\func{int}{Append}{\param{const wxString\& }{ item}, \param{void* }{clientData}} Adds the item to the end of the list box, associating the given data with the item. @@ -130,6 +130,11 @@ with the item. \docparam{clientData}{Client data to associate with the item.} +\wxheading{Return value} + +The index of the newly added item, may be different from the last one if the +control has {\tt wxLB\_SORT} style. + \membersection{wxListBox::Clear}\label{wxlistboxclear} \func{void}{Clear}{\void} @@ -251,7 +256,7 @@ Use this with a multiple selection listbox. \pythonnote{The wxPython version of this method takes no parameters and returns a tuple of the selected items.} -\perlnote{In wxPerl this method takes no parameters and returna the +\perlnote{In wxPerl this method takes no parameters and return the selected items as a list.} \membersection{wxListBox::GetString}\label{wxlistboxgetstring} @@ -284,7 +289,7 @@ it. \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{int}{ pos}} Insert the given number of strings before the specified position. @@ -331,9 +336,11 @@ TRUE if the given item is selected, FALSE otherwise. \membersection{wxListBox::Set}\label{wxlistboxset} -\func{void}{Set}{\param{int}{ n}, \param{const wxString*}{ choices}} +\func{void}{Set}{\param{int}{ n}, \param{const wxString*}{ choices}, \param{void}{ **clientData = {\tt NULL}}} -Clears the list box and adds the given strings. Not implemented for GTK. +\func{void}{Set}{\param{const wxArrayString\&}{ choices}, \param{void}{ **clientData = {\tt NULL}}} + +Clears the list box and adds the given strings to it. \wxheading{Parameters} @@ -341,10 +348,12 @@ Clears the list box and adds the given strings. Not implemented for GTK. \docparam{choices}{An array of strings to set.} +\docparam{clientData}{Options array of client data pointers} + \wxheading{Remarks} -Deallocate the array from the calling program -after this function has been called. +You may free the array from the calling program after this function has been +called. \membersection{wxListBox::SetClientData}\label{wxlistboxsetclientdata}