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{size\_t }{countItems = 0}, \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{size\_t }{countItems = 0}, \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
  67 \membersection{wxHtmlListBox::OnGetItem}\label{wxhtmllistboxongetitem}
  68
  69 \constfunc{wxString}{OnGetItem}{\param{size\_t }{n}}
  70
  71 This method must be implemented in the derived class and should return
  72 the body (i.e. without {\tt <html>} nor {\tt <body>} tags) of the HTML fragment
  73 for the given item.
  74
  75
  76 \membersection{wxHtmlListBox::OnGetItemMarkup}\label{wxhtmllistboxongetitemmarkup}
  77
  78 \constfunc{wxString}{OnGetItemMarkup}{\param{size\_t }{n}}
  79
  80 This function may be overridden to decorate HTML returned by
  81 \helpref{OnGetItem()}{wxhtmllistboxongetitem}.
  82