docs/latex/wx/listbook.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        listbook.tex
   3 %% Purpose:     wxListbook documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Modified by:
   6 %% Created:     22.08.03
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxListbook}}\label{wxlistbook}
  13
  14 wxListbook is a class similar to \helpref{wxNotebook}{wxnotebook} but which
  15 uses a \helpref{wxListCtrl}{wxlistctrl} to show the labels instead of the
  16 tabs.
  17
  18 There is no documentation for this class yet but its usage is
  19 identical to wxNotebook (except for the features clearly related to tabs
  20 only), so please refer to that class documentation for now. You can also
  21 use the \helpref{notebook sample}{samplenotebook} to see wxListbook in action.
  22
  23 \wxheading{Derived from}
  24
  25 wxBookCtrlBase (see \helpref{wxBookCtrl overview}{wxbookctrloverview})\\
  26 \helpref{wxControl}{wxcontrol}\\
  27 \helpref{wxWindow}{wxwindow}\\
  28 \helpref{wxEvtHandler}{wxevthandler}\\
  29 \helpref{wxObject}{wxobject}
  30
  31 \wxheading{Include files}
  32
  33 <wx/listbook.h>
  34
  35 \wxheading{Window styles}
  36
  37 \twocolwidtha{5cm}
  38 \begin{twocollist}\itemsep=0pt
  39
  40 \twocolitem{\windowstyle{wxLB\_DEFAULT}}{Choose the default location for the
  41 labels depending on the current platform (left everywhere except Mac where
  42 it is top).}
  43 \twocolitem{\windowstyle{wxLB\_TOP}}{Place labels above the page area.}
  44 \twocolitem{\windowstyle{wxLB\_LEFT}}{Place labels on the left side.}
  45 \twocolitem{\windowstyle{wxLB\_RIGHT}}{Place labels on the right side.}
  46 \twocolitem{\windowstyle{wxLB\_BOTTOM}}{Place labels below the page area.}
  47
  48 \end{twocollist}
  49
  50 \input listbevt.inc
  51
  52 \wxheading{See also}
  53
  54 \helpref{wxBookCtrl}{wxbookctrloverview}, \helpref{wxNotebook}{wxnotebook}, \helpref{notebook sample}{samplenotebook}
  55
  56 \latexignore{\rtfignore{\wxheading{Members}}}
  57
  58 \membersection{wxListbook::wxListbook}\label{wxlistbookctor}
  59
  60 \func{}{wxListbook}{\void}
  61
  62 Default constructor.
  63
  64 \func{}{wxListbook}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
  65  \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0}, \param{const wxString\& }{name = wxEmptyStr}}
  66
  67 Constructs a listbook control.
  68
  69 \membersection{wxListbook::GetListView}\label{wxlistbookgetlistview}
  70
  71 \constfunc{wxListView *}{GetListView}{\void}
  72
  73 Returns the \helpref{wxListView}{wxlistview} associated with the control.