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