X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2edb0bdef6238c8c246b6978bc14828b7033d931..134198f1b773199b5506c302bf9510831d0319f5:/docs/latex/wx/listbox.tex diff --git a/docs/latex/wx/listbox.tex b/docs/latex/wx/listbox.tex index c81cb93fb6..8cdea83876 100644 --- a/docs/latex/wx/listbox.tex +++ b/docs/latex/wx/listbox.tex @@ -7,14 +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). -List box elements are numbered from zero. Their number is limited in -some platforms (e.g. ca. 2000 on GTK). +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} +\helpref{wxControlWithItems}{wxcontrolwithitems}\\ \helpref{wxControl}{wxcontrol}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ @@ -24,6 +25,10 @@ wxEVT\_COMMAND\_LISTBOX\_DOUBLE\_CLICKED for double clicks. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm}% @@ -50,7 +55,7 @@ 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, -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, when the listbox is double-clicked.} \end{twocollist} @@ -62,7 +67,7 @@ when the listbox is double-clicked.} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxListBox::wxListBox}\label{wxlistboxconstr} +\membersection{wxListBox::wxListBox}\label{wxlistboxctor} \func{}{wxListBox}{\void} @@ -70,7 +75,12 @@ Default constructor. \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. @@ -107,35 +117,12 @@ 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. -\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{void* }{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 @@ -143,18 +130,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"}} -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} @@ -170,60 +152,6 @@ Deselects an item in the list box. 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{void*}{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::GetCount}\label{wxlistboxgetcount} - -\constfunc{int}{GetCount}{\void} - -Returns the number of items in the listbox. - -\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} \constfunc{int}{GetSelections}{\param{wxArrayInt\& }{selections}} @@ -244,9 +172,9 @@ Use this with a multiple selection listbox. \wxheading{See also} -\helpref{wxListBox::GetSelection}{wxlistboxgetselection},\rtfsp -\helpref{wxListBox::GetStringSelection}{wxlistboxgetstringselection},\rtfsp -\helpref{wxListBox::SetSelection}{wxlistboxsetselection} +\helpref{wxControlWithItems::GetSelection}{wxcontrolwithitemsgetselection},\rtfsp +\helpref{wxControlWithItems::GetStringSelection}{wxcontrolwithitemsgetstringselection},\rtfsp +\helpref{wxControlWithItems::SetSelection}{wxcontrolwithitemssetselection} \pythonnote{The wxPython version of this method takes no parameters and returns a tuple of the selected items.} @@ -254,37 +182,11 @@ and returns a tuple of the selected items.} \perlnote{In wxPerl this method takes no parameters and return the selected items as a list.} -\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. - -\wxheading{See also} - -\helpref{wxListBox::GetSelection}{wxlistboxgetselection},\rtfsp -\helpref{wxListBox::GetSelections}{wxlistboxgetselections},\rtfsp -\helpref{wxListBox::SetSelection}{wxlistboxsetselection} - \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. @@ -303,21 +205,28 @@ parameter for wxPython, which is a list of strings.} \perlnote{In wxPerl there is just an array reference in place of {\tt nItems} and {\tt items}.} -\membersection{wxListBox::Number}\label{wxlistboxnumber} +\membersection{wxListBox::HitTest}\label{wxlistboxhittest} + +\constfunc{int}{HitTest}{\param{const wxPoint&}{ point}} + +Returns the item located at \arg{point}, or \texttt{wxNOT\_FOUND} if there +is no item located at \arg{point}. + +\newsince{2.7.0}. It is currently implemented for wxMSW, wxMac and wxGTK2 +ports. -\constfunc{int}{Number}{\void} +\wxheading{Parameters} + +\docparam{point}{Point of item (in client coordinates) to obtain} -{\bf Obsolescence note:} This method is obsolete and was replaced with -\helpref{GetCount}{wxlistboxgetcount}, please use the new method in the new -code. This method is only available if wxWindows was compiled with -{\tt WXWIN\_COMPATIBILITY\_2\_2} defined and will disappear completely in -future versions. +\wxheading{Return value} -Returns the number of items in the listbox. +Item located at \arg{point}, or \texttt{wxNOT\_FOUND} if unimplemented +or the item does not exist. -\membersection{wxListBox::Selected}\label{wxlistboxselected} +\membersection{wxListBox::IsSelected}\label{wxlistboxisselected} -\constfunc{bool}{Selected}{\param{int}{ n}} +\constfunc{bool}{IsSelected}{\param{int}{ n}} Determines whether an item is selected. @@ -327,13 +236,15 @@ Determines whether an item is selected. \wxheading{Return value} -TRUE if the given item is selected, FALSE otherwise. +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}}} + +\func{void}{Set}{\param{const wxArrayString\&}{ choices}, \param{void}{ **clientData = {\tt NULL}}} -Clears the list box and adds the given strings. Not implemented for GTK. +Clears the list box and adds the given strings to it. \wxheading{Parameters} @@ -341,22 +252,12 @@ Clears the list box and adds the given strings. Not implemented for GTK. \docparam{choices}{An array of strings to set.} -\wxheading{Remarks} - -Deallocate the array from the calling program -after this function has been called. - -\membersection{wxListBox::SetClientData}\label{wxlistboxsetclientdata} +\docparam{clientData}{Options array of client data pointers} -\func{void}{SetClientData}{\param{int}{ n}, \param{void* }{data}} - -Associates the given client data pointer with the given item. - -\wxheading{Parameters} - -\docparam{n}{The zero-based item index.} +\wxheading{Remarks} -\docparam{data}{The client data to associate with the item.} +You may free the array from the calling program after this function has been +called. \membersection{wxListBox::SetFirstItem}\label{wxlistboxsetfirstitem} @@ -364,7 +265,7 @@ Associates the given client data pointer with the given item. \func{void}{SetFirstItem}{\param{const wxString\& }{string}} -Set the specified item to be the first visible item. Windows only. +Set the specified item to be the first visible item. \wxheading{Parameters} @@ -372,41 +273,3 @@ Set the specified item to be the first visible item. Windows only. \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. This does not cause a -wxEVT\_COMMAND\_LISTBOX\_SELECT event to get emitted. - -\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. This does not cause a -wxEVT\_COMMAND\_LISTBOX\_SELECT event to get emitted. - -\wxheading{Parameters} - -\docparam{string}{The item to select.} - -\docparam{select}{If TRUE, will select the item. If FALSE, will deselect it.} -