docs/latex/wx/htmllbox.tex

   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:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxHtmlListBox}}\label{wxhtmllistbox}
  13
  14 wxHtmlListBox is an implementation of \helpref{wxVListBox}{wxvlistbox} which
  15 shows HTML content in the listbox rows. This is still an abstract base class
  16 and you will need to derive your own class from it (see htlbox sample for the
  17 example) 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{long }{style = 0}, \param{const wxString\& }{name = wxVListBoxNameStr}}
  35
  36 Normal constructor which calls \helpref{Create()}{wxhtmllistboxcreate}
  37 internally.
  38
  39 \func{}{wxHtmlListBox}{\void}
  40
  41 Default constructor, you must call \helpref{Create()}{wxhtmllistboxcreate}
  42 later.
  43
  44
  45 \membersection{wxHtmlListBox::\destruct{wxHtmlListBox}}\label{wxhtmllistboxdtor}
  46
  47 \func{}{\destruct{wxHtmlListBox}}{\void}
  48
  49 Destructor 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
  56 Creates 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
  60 There are no special styles defined for wxHtmlListBox, in particular the
  61 wxListBox styles can not be used here.
  62
  63 Returns {\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
  72 Returns the \helpref{wxFileSystem}{wxfilesystem} used by the HTML parser of
  73 this object. The file system object is used to resolve the paths in HTML
  74 fragments displayed in the control and you should use
  75 \helpref{wxFileSystem::ChangePathTo}{wxfilesystemchangepathto} if you use
  76 relative 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
  83 This virtual function may be overridden to change the appearance of the
  84 background of the selected cells in the same way as
  85 \helpref{GetSelectedTextColour}{wxhtmllistboxgetselectedtextcolour}.
  86
  87 It should be rarely, if ever, used because
  88 \helpref{SetSelectionBackground}{wxvlistboxsetselectionbackground} allows to
  89 change the selection background for all cells at once and doing anything more
  90 fancy 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
 101 This virtual function may be overridden to customize the appearance of the
 102 selected cells. It is used to determine how the colour {\it colFg} is going to
 103 look inside selection. By default all original colours are completely ignored
 104 and the standard, system-dependent, selection colour is used but the program
 105 may 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
 118 This method must be implemented in the derived class and should return
 119 the body (i.e. without {\tt <html>} nor {\tt <body>} tags) of the HTML fragment
 120 for the given item.
 121
 122
 123 \membersection{wxHtmlListBox::OnGetItemMarkup}\label{wxhtmllistboxongetitemmarkup}
 124
 125 \constfunc{wxString}{OnGetItemMarkup}{\param{size\_t }{n}}
 126
 127 This function may be overridden to decorate HTML returned by
 128 \helpref{OnGetItem()}{wxhtmllistboxongetitem}.
 129
 130 \membersection{wxHtmlListBox::OnLinkClicked}\label{wxhtmlistboxonlinkclicked}
 131
 132 \func{virtual void}{OnLinkClicked}{\param{size\_t }{n}, \param{const wxHtmlLinkInfo\& }{link}}
 133
 134 Called when the user clicks on hypertext link. Does nothing by default.
 135
 136 \wxheading{Parameters}
 137
 138 \docparam{n}{Index of the item containing the link.}
 139
 140 \docparam{link}{Description of the link.}
 141
 142 \wxheading{See also}
 143
 144 See also \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}.