]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/listbox.tex
SetMenuBar potential memory leak fixed; added wxTAB_TRAVERSAL as dummy (0) style
[wxWidgets.git] / docs / latex / wx / listbox.tex
index 0c6c93ec27e5edaab11422af746e2a26dc04f66a..8e8780ffa8d7870b58f5c497cffdc54f4c6da49f 100644 (file)
@@ -35,7 +35,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}.
@@ -113,7 +113,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 +180,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,14 +214,13 @@ Applicable to single selection list boxes only.
 
 \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}
 
-\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}
 
@@ -237,6 +236,9 @@ Use this with a multiple selection listbox.
 \helpref{wxListBox::GetStringSelection}{wxlistboxgetstringselection},\rtfsp
 \helpref{wxListBox::SetSelection}{wxlistboxsetselection}
 
+\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}}
@@ -304,7 +306,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}
 
@@ -319,7 +321,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.
 
@@ -335,7 +337,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.
+Set the specified item to be the first visible item. Windows only.
 
 \wxheading{Parameters}
 
@@ -347,7 +349,8 @@ Set the specified item to be the first visible item.
 
 \func{void}{SetSelection}{\param{int}{ n}, \param{const bool }{select = TRUE}}
 
-Selects or deselects the given item.
+Selects or deselects the given item. This does not cause a
+wxEVT\_COMMAND\_LISTBOX\_SELECT event to get emitted.
 
 \wxheading{Parameters}
 
@@ -371,7 +374,8 @@ Sets the string value of an item.
 
 \func{void}{SetStringSelection}{\param{const wxString\& }{ string}, \param{const bool}{ select = TRUE}}
 
-Sets the current selection.
+Sets the current selection. This does not cause a
+wxEVT\_COMMAND\_LISTBOX\_SELECT event to get emitted.
 
 \wxheading{Parameters}