]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/htmllbox.tex
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / docs / latex / wx / htmllbox.tex
... / ...
CommitLineData
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: htmllbox.tex
3%% Purpose: wxHtmlListBox documentation
4%% Author: Vadim Zeitlin
5%% Modified by:
6%% Created: 01.06.03
7%% RCS-ID: $Id$
8%% Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
9%% License: wxWidgets license
10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12\section{\class{wxHtmlListBox}}\label{wxhtmllistbox}
13
14wxHtmlListBox is an implementation of \helpref{wxVListBox}{wxvlistbox} which
15shows HTML content in the listbox rows. This is still an abstract base class
16and you will need to derive your own class from it (see htlbox sample for the
17example) but you will only need to override a single
18\helpref{OnGetItem()}{wxhtmllistboxongetitem} function.
19
20\wxheading{Derived from}
21
22\helpref{wxVListBox}{wxvlistbox}
23
24\wxheading{Include files}
25
26<wx/htmllbox.h>
27
28
29\latexignore{\rtfignore{\wxheading{Members}}}
30
31
32\membersection{wxHtmlListBox::wxHtmlListBox}\label{wxhtmllistboxwxhtmllistbox}
33
34\func{}{wxHtmlListBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{size\_t }{countItems = 0}, \param{long }{style = 0}, \param{const wxString\& }{name = wxVListBoxNameStr}}
35
36Normal constructor which calls \helpref{Create()}{wxhtmllistboxcreate}
37internally.
38
39\func{}{wxHtmlListBox}{\void}
40
41Default constructor, you must call \helpref{Create()}{wxhtmllistboxcreate}
42later.
43
44
45\membersection{wxHtmlListBox::\destruct{wxHtmlListBox}}\label{wxhtmllistboxdtor}
46
47\func{}{\destruct{wxHtmlListBox}}{\void}
48
49Destructor cleans up whatever resources we use.
50
51
52\membersection{wxHtmlListBox::Create}\label{wxhtmllistboxcreate}
53
54\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}}
55
56Creates the control and optionally sets the initial number of items in it
57(it may also be set or changed later with
58\helpref{SetItemCount()}{wxvlistboxsetitemcount}).
59
60There are no special styles defined for wxHtmlListBox, in particular the
61wxListBox styles can not be used here.
62
63Returns {\tt true} on success or {\tt false} if the control couldn't be created
64
65
66\membersection{wxHtmlListBox::GetFileSystem}\label{wxhtmllistboxgetfilesystem}
67
68\func{wxFileSystem\&}{GetFileSystem}{\void}
69
70\constfunc{const wxFileSystem\&}{GetFileSystem}{\void}
71
72Returns the \helpref{wxFileSystem}{wxfilesystem} used by the HTML parser of
73this object. The file system object is used to resolve the paths in HTML
74fragments displayed in the control and you should use
75\helpref{wxFileSystem::ChangePathTo}{wxfilesystemchangepathto} if you use
76relative paths for the images or other resources embedded in your HTML.
77
78
79\membersection{wxHtmlListBox::GetSelectedTextBgColour}\label{wxhtmllistboxgetselectedtextbgcolour}
80
81\constfunc{wxColour}{GetSelectedTextBgColour}{\param{const wxColour\& }{colBg}}
82
83This virtual function may be overridden to change the appearance of the
84background of the selected cells in the same way as
85\helpref{GetSelectedTextColour}{wxhtmllistboxgetselectedtextcolour}.
86
87It should be rarely, if ever, used because
88\helpref{SetSelectionBackground}{wxvlistboxsetselectionbackground} allows to
89change the selection background for all cells at once and doing anything more
90fancy is probably going to look strangely.
91
92\wxheading{See also}
93
94\helpref{GetSelectedTextColour}{wxhtmllistboxgetselectedtextcolour}
95
96
97\membersection{wxHtmlListBox::GetSelectedTextColour}\label{wxhtmllistboxgetselectedtextcolour}
98
99\constfunc{wxColour}{GetSelectedTextColour}{\param{const wxColour\& }{colFg}}
100
101This virtual function may be overridden to customize the appearance of the
102selected cells. It is used to determine how the colour {\it colFg} is going to
103look inside selection. By default all original colours are completely ignored
104and the standard, system-dependent, selection colour is used but the program
105may wish to override this to achieve some custom appearance.
106
107\wxheading{See also}
108
109\helpref{GetSelectedTextBgColour}{wxhtmllistboxgetselectedtextbgcolour},\\
110\helpref{SetSelectionBackground}{wxvlistboxsetselectionbackground},\\
111\helpref{wxSystemSettings::GetColour}{wxsystemsettingsgetcolour}
112
113
114\membersection{wxHtmlListBox::OnGetItem}\label{wxhtmllistboxongetitem}
115
116\constfunc{wxString}{OnGetItem}{\param{size\_t }{n}}
117
118This method must be implemented in the derived class and should return
119the body (i.e. without {\tt <html>} nor {\tt <body>} tags) of the HTML fragment
120for the given item.
121
122
123\membersection{wxHtmlListBox::OnGetItemMarkup}\label{wxhtmllistboxongetitemmarkup}
124
125\constfunc{wxString}{OnGetItemMarkup}{\param{size\_t }{n}}
126
127This function may be overridden to decorate HTML returned by
128\helpref{OnGetItem()}{wxhtmllistboxongetitem}.
129