X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/27d029c722b88a50f27ea912754ae3e3d4aeb190..fe161a2685012cf90bb5bfe95f2260aee71d8ad7:/docs/latex/wx/listbox.tex diff --git a/docs/latex/wx/listbox.tex b/docs/latex/wx/listbox.tex index 5fb33ba364..3251f89763 100644 --- a/docs/latex/wx/listbox.tex +++ b/docs/latex/wx/listbox.tex @@ -15,6 +15,7 @@ wxEVT\_COMMAND\_LISTBOX\_DOUBLE\_CLICKED for double clicks. \wxheading{Derived from} +\helpref{wxControlWithItems}{wxcontrolwithitems}\\ \helpref{wxControl}{wxcontrol}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ @@ -36,9 +37,13 @@ select multiple items using the SHIFT key and the mouse or special key combinati \twocolitem{\windowstyle{wxLB\_HSCROLL}}{Create horizontal scrollbar if contents are too wide (Windows only).} \twocolitem{\windowstyle{wxLB\_ALWAYS\_SB}}{Always show a vertical scrollbar.} \twocolitem{\windowstyle{wxLB\_NEEDED\_SB}}{Only create a vertical scrollbar if needed.} -\twocolitem{\windowstyle{wxLB\_SORT}}{The listbox contents are sorted in alphabetical order. No effect for GTK.} +\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} @@ -48,7 +53,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} @@ -69,6 +74,11 @@ Default constructor. \param{int}{ n}, \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. \wxheading{Parameters} @@ -96,11 +106,12 @@ appropriately.} \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.} - +\perlnote{In wxPerl there is just an array reference in place of {\tt n} +and {\tt choices}.} \membersection{wxListBox::\destruct{wxListBox}} @@ -108,29 +119,6 @@ a list of strings.} 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 @@ -138,19 +126,14 @@ 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"}} +\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"}} + 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} - -\docparam{n}{The zero-based item index.} - \membersection{wxListBox::Deselect}\label{wxlistboxdeselect} \func{void}{Deselect}{\param{int}{ n}} @@ -165,57 +148,9 @@ 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::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}} +\constfunc{int}{GetSelections}{\param{wxArrayInt\& }{selections}} Fill an array of ints with the positions of the currently selected items. @@ -233,44 +168,19 @@ 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.} -\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} +\perlnote{In wxPerl this method takes no parameters and return the +selected items as a list.} \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. @@ -286,11 +196,8 @@ will be inserted in the beginning of the listbox} \pythonnote{The first two parameters are collapsed into a single parameter for wxPython, which is a list of strings.} -\membersection{wxListBox::Number}\label{wxlistboxnumber} - -\constfunc{int}{Number}{\void} - -Returns the number of items in the listbox. +\perlnote{In wxPerl there is just an array reference in place of {\tt nItems} +and {\tt items}.} \membersection{wxListBox::Selected}\label{wxlistboxselected} @@ -304,13 +211,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} @@ -318,22 +227,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} @@ -349,41 +248,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.} -