docs/latex/wx/tab.tex

   1 \section{\class{wxTabbedDialog}}\label{wxtabbeddialog}
   2
   3 A dialog suitable for handling tabs.
   4
   5 Please note that the preferred class for programming tabbed windows is \helpref{wxNotebook}{wxnotebook}.
   6 This class is retained for backward compatibility.
   7
   8 \wxheading{Derived from}
   9
  10 \helpref{wxDialog}{wxdialog}\\
  11 \helpref{wxEvtHandler}{wxevthandler}\\
  12 \helpref{wxObject}{wxobject}
  13
  14 \wxheading{Include files}
  15
  16 <wx/tab.h>
  17
  18 \wxheading{See also}
  19
  20 \helpref{Tab classes overview}{wxtaboverview}
  21
  22 \latexignore{\rtfignore{\wxheading{Members}}}
  23
  24 \membersection{wxTabbedDialog::wxTabbedDialog}
  25
  26 \func{}{wxTabbedDialog}{\param{wxWindow *}{parent}, \param{wxWindowID }{id},
  27  \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size},
  28  \param{long}{ style=wxDEFAULT\_DIALOG\_STYLE}, \param{const wxString\& }{name="dialogBox"}}
  29
  30 Constructor.
  31
  32 \membersection{wxTabbedDialog::\destruct{wxTabbedDialog}}
  33
  34 \func{}{\destruct{wxTabbedDialog}}{\void}
  35
  36 Destructor. This destructor deletes the tab view associated with the dialog box.
  37 If you do not wish this to happen, set the tab view to NULL before destruction (for example,
  38 in the OnCloseWindow event handler).
  39
  40 \membersection{wxTabbedDialog::SetTabView}
  41
  42 \func{void}{SetTabView}{\param{wxTabView *}{view}}
  43
  44 Sets the tab view associated with the dialog box.
  45
  46 \membersection{wxTabbedDialog::GetTabView}
  47
  48 \func{wxTabView *}{GetTabView}{\void}
  49
  50 Returns the tab view associated with the dialog box.
  51
  52 \section{\class{wxTabbedPanel}}\label{wxtabbedpanel}
  53
  54 A panel suitable for handling tabs.
  55
  56 Please note that the preferred class for programming tabbed windows is \helpref{wxNotebook}{wxnotebook}.
  57 This class is retained for backward compatibility.
  58
  59 \wxheading{Derived from}
  60
  61 \helpref{wxPanel}{wxpanel}\\
  62 \helpref{wxEvtHandler}{wxevthandler}\\
  63 \helpref{wxObject}{wxobject}
  64
  65 \wxheading{Include files}
  66
  67 <wx/tab.h>
  68
  69 \wxheading{See also}
  70
  71 \helpref{Tab classes overview}{wxtaboverview}
  72
  73 \latexignore{\rtfignore{\wxheading{Members}}}
  74
  75 \membersection{wxTabbedPanel::wxTabbedPanel}
  76
  77 \func{}{wxTabbedPanel}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},
  78  \param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size},
  79  \param{long}{ style=0}, \param{const wxString\& }{name="panel"}}
  80
  81 Constructor.
  82
  83 \membersection{wxTabbedPanel::SetTabView}
  84
  85 \func{void}{SetTabView}{\param{wxTabView *}{view}}
  86
  87 Sets the tab view associated with the panel.
  88
  89 \membersection{wxTabbedPanel::GetTabView}
  90
  91 \func{wxTabView *}{GetTabView}{\void}
  92
  93 Returns the tab view associated with the panel.
  94
  95 \section{\class{wxTabControl}}\label{wxtabcontrol}
  96
  97 You will rarely need to use this class directly.
  98
  99 Please note that the preferred class for programming tabbed windows is \helpref{wxNotebook}{wxnotebook}.
 100 This class is retained for backward compatibility.
 101
 102 \wxheading{Derived from}
 103
 104 \helpref{wxObject}{wxobject}
 105
 106 \wxheading{Include files}
 107
 108 <wx/tab.h>
 109
 110 \wxheading{See also}
 111
 112 \overview{Tab classes overview}{wxtaboverview}
 113
 114 \latexignore{\rtfignore{\wxheading{Members}}}
 115
 116 \membersection{wxTabControl::wxTabControl}
 117
 118 \func{void}{wxTabControl}{\param{wxTabView *}{view = NULL}}
 119
 120 Constructor.
 121
 122 \membersection{wxTabControl::GetColPosition}
 123
 124 \func{int}{GetColPosition}{\void}
 125
 126 Returns the position of the tab in the tab column.
 127
 128 \membersection{wxTabControl::GetFont}
 129
 130 \func{wxFont *}{GetFont}{\void}
 131
 132 Returns the font to be used for this tab.
 133
 134 \membersection{wxTabControl::GetHeight}
 135
 136 \func{int}{GetHeight}{\void}
 137
 138 Returns the tab height.
 139
 140 \membersection{wxTabControl::GetId}
 141
 142 \func{int}{GetId}{\void}
 143
 144 Returns the tab identifier.
 145
 146 \membersection{wxTabControl::GetLabel}
 147
 148 \func{wxString}{GetLabel}{\void}
 149
 150 Returns the tab label.
 151
 152 \membersection{wxTabControl::GetRowPosition}
 153
 154 \func{int}{GetRowPosition}{\void}
 155
 156 Returns the position of the tab in the layer or row.
 157
 158 \membersection{wxTabControl::GetSelected}
 159
 160 \func{bool}{GetSelected}{\void}
 161
 162 Returns the selected flag.
 163
 164 \membersection{wxTabControl::GetWidth}
 165
 166 \func{int}{GetWidth}{\void}
 167
 168 Returns the tab width.
 169
 170 \membersection{wxTabControl::GetX}
 171
 172 \func{int}{GetX}{\void}
 173
 174 Returns the x offset from the top-left of the view area.
 175
 176 \membersection{wxTabControl::GetY}
 177
 178 \func{int}{GetY}{\void}
 179
 180 Returns the y offset from the top-left of the view area.
 181
 182 \membersection{wxTabControl::HitTest}
 183
 184 \func{bool}{HitTest}{\param{int}{ x}, \param{int}{ y}}
 185
 186 Returns TRUE if the point x, y is within the tab area.
 187
 188 \membersection{wxTabControl::OnDraw}
 189
 190 \func{void}{OnDraw}{\param{wxDC\& }{dc}, \param{bool}{ lastInRow}}
 191
 192 Draws the tab control on the given device context.
 193
 194 \membersection{wxTabControl::SetColPosition}
 195
 196 \func{void}{SetColPosition}{\param{int}{ pos}}
 197
 198 Sets the position in the column.
 199
 200 \membersection{wxTabControl::SetFont}
 201
 202 \func{void}{SetFont}{\param{wxFont *}{font}}
 203
 204 Sets the font to be used for this tab.
 205
 206 \membersection{wxTabControl::SetId}
 207
 208 \func{void}{SetId}{\param{int}{ id}}
 209
 210 Sets the tab identifier.
 211
 212 \membersection{wxTabControl::SetLabel}
 213
 214 \func{void}{SetLabel}{\param{const wxString\& }{str}}
 215
 216 Sets the label for the tab.
 217
 218 \membersection{wxTabControl::SetPosition}
 219
 220 \func{void}{SetPosition}{\param{int}{ x}, \param{int}{ y}}
 221
 222 Sets the x and y offsets for this tab, measured from the top-left of the view area.
 223
 224 \membersection{wxTabControl::SetRowPosition}
 225
 226 \func{void}{SetRowPosition}{\param{int}{ pos}}
 227
 228 Sets the position on the layer (row).
 229
 230 \membersection{wxTabControl::SetSelected}
 231
 232 \func{void}{SetSelected}{\param{bool }{selected}}
 233
 234 Sets the selection flag for this tab (does not set the current tab for the view;
 235 use wxTabView::SetSelectedTab for that).
 236
 237 \membersection{wxTabControl::SetSize}
 238
 239 \func{void}{SetSize}{\param{int}{ width}, \param{int}{ height}}
 240
 241 Sets the width and height for this tab.
 242