docs/latex/wx/choicebk.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        choicebk.tex
   3 %% Purpose:     wxChoicebook documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Modified by: Wlodzimierz ABX Skiba from listbook.tex
   6 %% Created:     15.09.04
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) Vadim Zeitlin, Wlodzimierz Skiba
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxChoicebook}}\label{wxchoicebook}
  13
  14 wxChoicebook is a class similar to \helpref{wxNotebook}{wxnotebook} but which
  15 uses a \helpref{wxChoice}{wxchoice} 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 wxChoicebook in action.
  22
  23 wxChoicebook allows the use of wxBookCtrl::GetControlSizer, allowing a program
  24 to add other controls next to the choice control. This is particularly useful
  25 when screen space is restricted, as it often is when wxChoicebook is being employed.
  26
  27 \wxheading{Derived from}
  28
  29 wxBookCtrlBase (see \helpref{wxBookCtrl overview}{wxbookctrloverview})\\
  30 \helpref{wxControl}{wxcontrol}\\
  31 \helpref{wxWindow}{wxwindow}\\
  32 \helpref{wxEvtHandler}{wxevthandler}\\
  33 \helpref{wxObject}{wxobject}
  34
  35 \wxheading{Include files}
  36
  37 <wx/choicebk.h>
  38
  39 \wxheading{Library}
  40
  41 \helpref{wxCore}{librarieslist}
  42
  43 \wxheading{Window styles}
  44
  45 \twocolwidtha{5cm}
  46 \begin{twocollist}\itemsep=0pt
  47
  48 \twocolitem{\windowstyle{wxCHB\_DEFAULT}}{Choose the default location for the
  49 labels depending on the current platform (left everywhere except Mac where
  50 it is top).}
  51 \twocolitem{\windowstyle{wxCHB\_TOP}}{Place labels above the page area.}
  52 \twocolitem{\windowstyle{wxCHB\_LEFT}}{Place labels on the left side.}
  53 \twocolitem{\windowstyle{wxCHB\_RIGHT}}{Place labels on the right side.}
  54 \twocolitem{\windowstyle{wxCHB\_BOTTOM}}{Place labels below the page area.}
  55
  56 \end{twocollist}
  57
  58 \input choicebevt.inc
  59
  60 \wxheading{See also}
  61
  62 \helpref{wxBookCtrl}{wxbookctrloverview}, \helpref{wxNotebook}{wxnotebook}, \helpref{notebook sample}{samplenotebook}
  63
  64 \latexignore{\rtfignore{\wxheading{Members}}}
  65
  66 \membersection{wxChoicebook::wxChoicebook}\label{wxchoicebookctor}
  67
  68 \func{}{wxChoicebook}{\void}
  69
  70 Default constructor.
  71
  72 \func{}{wxChoicebook}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
  73  \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0}, \param{const wxString\& }{name = wxEmptyStr}}
  74
  75 Constructs a choicebook control.
  76
  77 \membersection{wxChoicebook::GetChoiceCtrl}\label{wxchoicebookgetchoicectrl}
  78
  79 \constfunc{wxChoice *}{GetChoiceCtrl}{\void}
  80
  81 Returns the \helpref{wxChoice}{wxchoice} associated with the control.