docs/latex/wx/pantabv.tex

   1 \section{\class{wxPanelTabView}}\label{wxpaneltabview}
   2
   3 The wxPanelTabView is responsible for input and output on a wxPanel.
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxTabView}{wxtabview}\\
   8 \helpref{wxObject}{wxobject}
   9
  10 \wxheading{Include files}
  11
  12 <wx/tab.h>
  13
  14 \wxheading{See also}
  15
  16 \helpref{wxTabView overview}{wxtabviewoverview}, \helpref{wxTabView}{wxtabview}
  17
  18 \latexignore{\rtfignore{\wxheading{Members}}}
  19
  20 \membersection{wxPanelTabView::wxPanelTabView}\label{wxpaneltabviewconstr}
  21
  22 \func{void}{wxPanelTabView}{\param{wxPanel *}{panel}, \param{long }{style = wxTAB\_STYLE\_DRAW\_BOX \pipe wxTAB\_STYLE\_COLOUR\_INTERIOR}}
  23
  24 Constructor. {\it panel} should be a wxTabbedPanel or wxTabbedDialog: the type will be checked by the view at run time.
  25
  26 {\it style} may be a bit list of the following:
  27
  28 \begin{twocollist}\itemsep=0pt
  29 \twocolitem{wxTAB\_STYLE\_DRAW\_BOX}{Draw a box around the view area. Most commonly used for dialogs.}
  30 \twocolitem{wxTAB\_STYLE\_COLOUR\_INTERIOR}{Draw tab backgrounds in the specified colour. Omitting this style
  31 will ensure that the tab background matches the dialog background.}
  32 \end{twocollist}
  33
  34 \membersection{wxPanelTabView::\destruct{wxPanelTabView}}
  35
  36 \func{void}{\destruct{wxPanelTabView}}{\void}
  37
  38 Destructor. This destructor deletes all the panels associated with the view.
  39 If you do not wish this to happen, call ClearWindows with argument FALSE before the
  40 view is likely to be destroyed. This will clear the list of windows, without deleting them.
  41
  42 \membersection{wxPanelTabView::AddTabWindow}\label{wxpaneltabviewaddtabwindow}
  43
  44 \func{void}{AddTabPanel}{\param{int}{ id}, \param{wxWindow *}{window}}
  45
  46 Adds a window to the view. The window is associated with the tab identifier, and will be shown or hidden as the tab
  47 is selected or deselected.
  48
  49 \membersection{wxPanelTabView::ClearWindows}
  50
  51 \func{void}{ClearWindows}{\param{bool}{ deleteWindows = TRUE}}
  52
  53 Removes the child windows from the view. If {\it deleteWindows} is TRUE, the windows will be deleted.
  54
  55 \membersection{wxPanelTabView::GetCurrentWindow}
  56
  57 \func{wxPanel *}{GetCurrentWindow}{\void}
  58
  59 Returns the child window currently being displayed on the tabbed panel or dialog box.
  60
  61 \membersection{wxPanelTabView::GetTabWindow}
  62
  63 \func{wxWindow *}{GetTabWindow}{\param{int}{ id}}
  64
  65 Returns the window associated with the tab identifier.
  66
  67 \membersection{wxPanelTabView::ShowWindowForTab}
  68
  69 \func{void}{ShowWindowForTab}{\param{int}{ id}}
  70
  71 Shows the child window corresponding to the tab identifier, and hides the previously shown window.
  72
  73