Updated configure and aclocal.m4 for new 0.1.8 Bakefile on account of

[wxWidgets.git] / docs / latex / wx / vlbox.tex

diff --git a/docs/latex/wx/vlbox.tex b/docs/latex/wx/vlbox.tex
index 5b3f77a0aec510cdd6de7229c59facf2cad76fb1..d89098dd5cb7620ca5bfe5e6ef510895c23dcadb 100644 (file)
--- a/docs/latex/wx/vlbox.tex
+++ b/docs/latex/wx/vlbox.tex
@@ -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.
 
 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.
 
 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
 \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}
 
 
 \wxheading{See also}
 


@@ -173,6 +173,19 @@ may only return $0$ or $1$ however.
 Get the currently selected item or $-1$ if there is no selection.
 
 
 Get the currently selected item or $-1$ if there is no selection.
 
 

+\membersection{wxVListBox::GetSelectionBackground}\label{wxvlistboxgetselectionbackground}
+
+\constfunc{const wxColour\&}{GetSelectionBackground}{\void}
+
+Returns the background colour used for the selected cells. By default the
+standard system colour is used.
+
+\wxheading{See also}
+
+\helpref{wxSystemSettings::GetColour}{wxsystemsettingsgetcolour},\\
+\helpref{SetSelectionBackground}{wxvlistboxsetselectionbackground}
+
+

 \membersection{wxVListBox::HasMultipleSelection}\label{wxvlistboxishasmultipleselection}
 
 \constfunc{bool}{HasMultipleSelection}{\void}
 \membersection{wxVListBox::HasMultipleSelection}\label{wxvlistboxishasmultipleselection}
 
 \constfunc{bool}{HasMultipleSelection}{\void}


@@ -202,6 +215,19 @@ current.
 Returns {\tt true} if this item is selected, {\tt false} otherwise.
 
 
 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}}
 \membersection{wxVListBox::OnDrawItem}\label{wxvlistboxondrawitem}
 
 \constfunc{void}{OnDrawItem}{\param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{size\_t }{n}}


@@ -291,6 +317,7 @@ This method is only valid for multi selection listboxes.
 
 \helpref{SelectAll}{wxvlistboxselectall}, \helpref{Select}{wxvlistboxselect}
 
 
 \helpref{SelectAll}{wxvlistboxselectall}, \helpref{Select}{wxvlistboxselect}
 

+\membersection{wxVListBox::SetItemCount}\label{wxvlistboxsetitemcount}

 
 \func{void}{SetItemCount}{\param{size\_t }{count}}
 
 
 \func{void}{SetItemCount}{\param{size\_t }{count}}
 


@@ -321,12 +348,27 @@ Set the selection to the specified item, if it is $-1$ the selection is
 unset. The selected item will be automatically scrolled into view if it isn't
 currently visible.
 
 unset. The selected item will be automatically scrolled into view if it isn't
 currently visible.
 

+This method may be used both with single and multiple selection listboxes.
+
+
+\membersection{wxVListBox::SetSelectionBackground}\label{wxvlistboxsetselectionbackground}
+
+\func{void}{SetSelectionBackground}{\param{const wxColour\& }{col}}
+
+Sets the colour to be used for the selected cells background. The background of
+the standard cells may be changed by simply calling 
+\helpref{SetBackgroundColour}{wxwindowsetbackgroundcolour}.
+
+\wxheading{See also}
+
+\helpref{GetSelectionBackground}{wxvlistboxgetselectionbackground}
+

 
 \membersection{wxVListBox::Toggle}\label{wxvlistboxtoggle}
 
 \func{void}{Toggle}{\param{size\_t }{item}}
 
 
 \membersection{wxVListBox::Toggle}\label{wxvlistboxtoggle}
 
 \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.
 unselected and deselects it if it was selected.
 
 This method is only valid for multi selection listboxes.