X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fd9811b13784a58dd58126bc4b7d5f4c195839b2..80d2803f703d1b238f42725504f08266ef02defe:/docs/latex/wx/listbox.tex diff --git a/docs/latex/wx/listbox.tex b/docs/latex/wx/listbox.tex index ea6620608f..59f09a388e 100644 --- a/docs/latex/wx/listbox.tex +++ b/docs/latex/wx/listbox.tex @@ -7,7 +7,8 @@ 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. +List box elements are numbered from zero. Their number is limited in +some platforms (e.g. ca. 2000 on GTK). A listbox callback gets an event wxEVT\_COMMAND\_LISTBOX\_SELECT for single clicks, and wxEVT\_COMMAND\_LISTBOX\_DOUBLE\_CLICKED for double clicks. @@ -35,7 +36,7 @@ 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.} +\twocolitem{\windowstyle{wxLB\_SORT}}{The listbox contents are sorted in alphabetical order. No effect for GTK.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -95,8 +96,8 @@ 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.} @@ -113,7 +114,7 @@ Destructor, destroying the list box. Adds the item to the end of the list box. -\func{void}{Append}{\param{const wxString\& }{ item}, \param{char* }{clientData}} +\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. @@ -180,7 +181,7 @@ 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}} +\constfunc{void*}{GetClientData}{\param{int}{ n}} Returns a pointer to the client data associated with the given item (if any). @@ -214,7 +215,7 @@ Applicable to single selection list boxes only. \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. @@ -282,6 +283,9 @@ 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} +\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} @@ -306,7 +310,7 @@ TRUE if the given item is selected, FALSE otherwise. \func{void}{Set}{\param{int}{ n}, \param{const wxString*}{ choices}} -Clears the list box and adds the given strings. +Clears the list box and adds the given strings. Not implemented for GTK. \wxheading{Parameters} @@ -321,7 +325,7 @@ after this function has been called. \membersection{wxListBox::SetClientData}\label{wxlistboxsetclientdata} -\func{void}{SetClientData}{\param{int}{ n}, \param{char* }{data}} +\func{void}{SetClientData}{\param{int}{ n}, \param{void* }{data}} Associates the given client data pointer with the given item.