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