X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/de5d3a20ce90c2e8b084350e987097cb63fd2172..1a87edf286921de9b182f3d19adb6bb63ba85ebd:/docs/latex/wx/vlbox.tex diff --git a/docs/latex/wx/vlbox.tex b/docs/latex/wx/vlbox.tex index b2d16c7d77..e57ca9fd69 100644 --- a/docs/latex/wx/vlbox.tex +++ b/docs/latex/wx/vlbox.tex @@ -6,7 +6,7 @@ %% Created: 01.06.03 %% RCS-ID: $Id$ %% Copyright: (c) 2003 Vadim Zeitlin -%% License: wxWindows license +%% License: wxWidgets license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxVListBox}}\label{wxvlistbox} @@ -95,7 +95,7 @@ This method is only valid for multi selection listboxes. Returns the index of the first selected item in the listbox or {\tt wxNOT\_FOUND} if no items are currently selected. -{\it cookie} is an opaque parameter which should be passed to the subsequent +\arg{cookie} is an opaque parameter which should be passed to the subsequent calls to \helpref{GetNextSelected}{wxvlistboxgetnextselected}. It is needed in order to allow parallel iterations over the selected items. @@ -129,7 +129,7 @@ Get the number of items in the control. \constfunc{wxPoint}{GetMargins}{\void} Returns the margins used by the control. The {\tt x} field of the returned -point is the horizontal margine and the {\tt y} field is the vertical one. +point is the horizontal margin and the {\tt y} field is the vertical one. \wxheading{See also} @@ -215,6 +215,19 @@ current. Returns {\tt true} if this item is selected, {\tt false} otherwise. +\membersection{wxVListBox::OnDrawBackground}\label{wxvlistboxondrawbackground} + +\constfunc{void}{OnDrawBackground}{\param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{size\_t }{n}} + +This method is used to draw the items background and, maybe, a border +around it. + +The base class version implements a reasonable default behaviour which +consists in drawing the selected item with the standard background +colour and drawing a border around the item if it is either selected or +current. + + \membersection{wxVListBox::OnDrawItem}\label{wxvlistboxondrawitem} \constfunc{void}{OnDrawItem}{\param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{size\_t }{n}} @@ -304,6 +317,7 @@ This method is only valid for multi selection listboxes. \helpref{SelectAll}{wxvlistboxselectall}, \helpref{Select}{wxvlistboxselect} +\membersection{wxVListBox::SetItemCount}\label{wxvlistboxsetitemcount} \func{void}{SetItemCount}{\param{size\_t }{count}} @@ -354,7 +368,7 @@ the standard cells may be changed by simply calling \func{void}{Toggle}{\param{size\_t }{item}} -Toggles the state of the specified {\it item}, i.e. selects it if it was +Toggles the state of the specified \arg{item}, i.e. selects it if it was unselected and deselects it if it was selected. This method is only valid for multi selection listboxes.