Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[ 1507795 ] Small doc patch.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39792 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Włodzimierz Skiba
2006-06-19 09:20:16 +00:00
parent d924939be8
commit 410bfc9383
4 changed files with 58 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/latex/wx/vlbox.tex
View File

@@ -13,9 +13,9 @@
wxVListBox is a listbox-like control with the following two main differences
from a regular listbox: it can have an arbitrarily huge number of items because
it doesn't store them itself but uses \helpref{OnDrawItem()}{wxvlistboxondrawitem}
it doesn't store them itself but uses \helpref{OnDrawItem()}{wxvlistboxondrawitem}
callback to draw them (so it is a {\Large V}irtual listbox) and its items can
have variable height as determined by
have variable height as determined by
\helpref{OnMeasureItem()}{wxvlistboxonmeasureitem} (so it is also a listbox
with the lines of {\Large V}ariable height).
@@ -28,10 +28,14 @@ derive your own class, such as \helpref{wxHtmlListBox}{wxhtmllistbox}, from it.
However it emits the same events as \helpref{wxListBox}{wxlistbox} and the same
event macros may be used with it.
\wxheading{Derived from}
\helpref{wxVScrolledWindow}{wxvscrolledwindow}
\helpref{wxVScrolledWindow}{wxvscrolledwindow}\\
\helpref{wxPanel}{wxpanel}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
@@ -62,11 +66,11 @@ Deletes all items from the control.
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}, \param{const wxString\& }{name = wxVListBoxNameStr}}
Creates the control. To finish creating it you also should call
Creates the control. To finish creating it you also should call
\helpref{SetItemCount()}{wxvlistboxsetitemcount} to let it know about the
number of items it contains.
The only special style which may be used with wxVListBox is {\tt wxLB\_MULTIPLE}
The only special style which may be used with wxVListBox is {\tt wxLB\_MULTIPLE}
which indicates that the listbox should support multiple selection.
Returns {\tt true} on success or {\tt false} if the control couldn't be created
@@ -92,7 +96,7 @@ This method is only valid for multi selection listboxes.
\constfunc{int}{GetFirstSelected}{\param{unsigned long\& }{cookie}}
Returns the index of the first selected item in the listbox or
Returns the index of the first selected item in the listbox or
{\tt wxNOT\_FOUND} if no items are currently selected.
\arg{cookie} is an opaque parameter which should be passed to the subsequent
@@ -170,7 +174,7 @@ may only return $0$ or $1$ however.
\constfunc{int}{GetSelection}{\void}
Get the currently selected item or $-1$ if there is no selection.
Get the currently selected item or {\tt wxNOT\_FOUND} if there is no selection.
\membersection{wxVListBox::GetSelectionBackground}\label{wxvlistboxgetselectionbackground}
@@ -202,7 +206,7 @@ listbox.
Returns {\tt true} if this item is the current one, {\tt false} otherwise.
Current item is always the same as selected one for the single selection
listbox and in this case this method is equivalent to
listbox and in this case this method is equivalent to
\helpref{IsSelected}{wxvlistboxisselected} but they are different for multi
selection listboxes where many items may be selected but only one (at most) is
current.
@@ -282,7 +286,7 @@ equal to {\tt wxNOT\_FOUND}).
Return {\tt true} if the items selection status has changed or {\tt false}
otherwise.
This function is only valid for the multiple selection listboxes, use
This function is only valid for the multiple selection listboxes, use
\helpref{SetSelection}{wxvlistboxsetselection} for the single selection ones.
@@ -356,7 +360,7 @@ This method may be used both with single and multiple selection listboxes.
\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
the standard cells may be changed by simply calling
\helpref{SetBackgroundColour}{wxwindowsetbackgroundcolour}.
\wxheading{See also}
@@ -376,4 +380,3 @@ This method is only valid for multi selection listboxes.
\wxheading{See also}
\helpref{Select}{wxvlistboxselect}