source: trunk/doc/html/qtabwidget.html

Last change on this file was 190, checked in by rudi, 14 years ago

reference documentation added
File size: 28.9 KB
RevLine 
[190]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/widgets/qtabwidget.cpp:54 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QTabWidget Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QTabWidget Class Reference</h1>
33
34<p>The QTabWidget class provides a stack of tabbed widgets.
35<a href="#details">More...</a>
36<p><tt>#include &lt;<a href="qtabwidget-h.html">qtabwidget.h</a>&gt;</tt>
37<p>Inherits <a href="qwidget.html">QWidget</a>.
38<p><a href="qtabwidget-members.html">List of all member functions.</a>
39<h2>Public Members</h2>
40<ul>
41<li class=fn><a href="#QTabWidget"><b>QTabWidget</b></a> ( QWidget&nbsp;*&nbsp;parent = 0, const&nbsp;char&nbsp;*&nbsp;name = 0, WFlags&nbsp;f = 0 )</li>
42<li class=fn>virtual void <a href="#addTab"><b>addTab</b></a> ( QWidget&nbsp;*&nbsp;child, const&nbsp;QString&nbsp;&amp;&nbsp;label )</li>
43<li class=fn>virtual void <a href="#addTab-2"><b>addTab</b></a> ( QWidget&nbsp;*&nbsp;child, const&nbsp;QIconSet&nbsp;&amp;&nbsp;iconset, const&nbsp;QString&nbsp;&amp;&nbsp;label )</li>
44<li class=fn>virtual void <a href="#addTab-3"><b>addTab</b></a> ( QWidget&nbsp;*&nbsp;child, QTab&nbsp;*&nbsp;tab )</li>
45<li class=fn>virtual void <a href="#insertTab"><b>insertTab</b></a> ( QWidget&nbsp;*&nbsp;child, const&nbsp;QString&nbsp;&amp;&nbsp;label, int&nbsp;index = -1 )</li>
46<li class=fn>virtual void <a href="#insertTab-2"><b>insertTab</b></a> ( QWidget&nbsp;*&nbsp;child, const&nbsp;QIconSet&nbsp;&amp;&nbsp;iconset, const&nbsp;QString&nbsp;&amp;&nbsp;label, int&nbsp;index = -1 )</li>
47<li class=fn>virtual void <a href="#insertTab-3"><b>insertTab</b></a> ( QWidget&nbsp;*&nbsp;child, QTab&nbsp;*&nbsp;tab, int&nbsp;index = -1 )</li>
48<li class=fn>void <a href="#changeTab"><b>changeTab</b></a> ( QWidget&nbsp;*&nbsp;w, const&nbsp;QString&nbsp;&amp;&nbsp;label )</li>
49<li class=fn>void <a href="#changeTab-2"><b>changeTab</b></a> ( QWidget&nbsp;*&nbsp;w, const&nbsp;QIconSet&nbsp;&amp;&nbsp;iconset, const&nbsp;QString&nbsp;&amp;&nbsp;label )</li>
50<li class=fn>bool <a href="#isTabEnabled"><b>isTabEnabled</b></a> ( QWidget&nbsp;*&nbsp;w ) const</li>
51<li class=fn>void <a href="#setTabEnabled"><b>setTabEnabled</b></a> ( QWidget&nbsp;*&nbsp;w, bool&nbsp;enable )</li>
52<li class=fn>void <a href="#setCornerWidget"><b>setCornerWidget</b></a> ( QWidget&nbsp;*&nbsp;w, Qt::Corner&nbsp;corner = Qt::TopRight )</li>
53<li class=fn>QWidget * <a href="#cornerWidget"><b>cornerWidget</b></a> ( Qt::Corner&nbsp;corner = Qt::TopRight ) const</li>
54<li class=fn>QString <a href="#tabLabel"><b>tabLabel</b></a> ( QWidget&nbsp;*&nbsp;w ) const</li>
55<li class=fn>void <a href="#setTabLabel"><b>setTabLabel</b></a> ( QWidget&nbsp;*&nbsp;w, const&nbsp;QString&nbsp;&amp;&nbsp;l )</li>
56<li class=fn>QIconSet <a href="#tabIconSet"><b>tabIconSet</b></a> ( QWidget&nbsp;*&nbsp;w ) const</li>
57<li class=fn>void <a href="#setTabIconSet"><b>setTabIconSet</b></a> ( QWidget&nbsp;*&nbsp;w, const&nbsp;QIconSet&nbsp;&amp;&nbsp;iconset )</li>
58<li class=fn>void <a href="#removeTabToolTip"><b>removeTabToolTip</b></a> ( QWidget&nbsp;*&nbsp;w )</li>
59<li class=fn>void <a href="#setTabToolTip"><b>setTabToolTip</b></a> ( QWidget&nbsp;*&nbsp;w, const&nbsp;QString&nbsp;&amp;&nbsp;tip )</li>
60<li class=fn>QString <a href="#tabToolTip"><b>tabToolTip</b></a> ( QWidget&nbsp;*&nbsp;w ) const</li>
61<li class=fn>QWidget * <a href="#currentPage"><b>currentPage</b></a> () const</li>
62<li class=fn>QWidget * <a href="#page"><b>page</b></a> ( int&nbsp;index ) const</li>
63<li class=fn>QString <a href="#label"><b>label</b></a> ( int&nbsp;index ) const</li>
64<li class=fn>int <a href="#currentPageIndex"><b>currentPageIndex</b></a> () const</li>
65<li class=fn>int <a href="#indexOf"><b>indexOf</b></a> ( QWidget&nbsp;*&nbsp;w ) const</li>
66<li class=fn>enum <a href="#TabPosition-enum"><b>TabPosition</b></a> { Top, Bottom }</li>
67<li class=fn>TabPosition <a href="#tabPosition"><b>tabPosition</b></a> () const</li>
68<li class=fn>void <a href="#setTabPosition"><b>setTabPosition</b></a> ( TabPosition )</li>
69<li class=fn>enum <a href="#TabShape-enum"><b>TabShape</b></a> { Rounded, Triangular }</li>
70<li class=fn>TabShape <a href="#tabShape"><b>tabShape</b></a> () const</li>
71<li class=fn>void <a href="#setTabShape"><b>setTabShape</b></a> ( TabShape&nbsp;s )</li>
72<li class=fn>int <a href="#margin"><b>margin</b></a> () const</li>
73<li class=fn>void <a href="#setMargin"><b>setMargin</b></a> ( int )</li>
74<li class=fn>int <a href="#count"><b>count</b></a> () const</li>
75</ul>
76<h2>Public Slots</h2>
77<ul>
78<li class=fn>void <a href="#setCurrentPage"><b>setCurrentPage</b></a> ( int )</li>
79<li class=fn>virtual void <a href="#showPage"><b>showPage</b></a> ( QWidget&nbsp;*&nbsp;w )</li>
80<li class=fn>virtual void <a href="#removePage"><b>removePage</b></a> ( QWidget&nbsp;*&nbsp;w )</li>
81</ul>
82<h2>Signals</h2>
83<ul>
84<li class=fn>void <a href="#currentChanged"><b>currentChanged</b></a> ( QWidget * )</li>
85</ul>
86<h2>Properties</h2>
87<ul>
88<li class=fn>bool <a href="#autoMask-prop"><b>autoMask</b></a>&nbsp;- whether the tab widget is automatically masked &nbsp;<em>(read only)</em></li>
89<li class=fn>int <a href="#count-prop"><b>count</b></a>&nbsp;- the number of tabs in the tab bar &nbsp;<em>(read only)</em></li>
90<li class=fn>int <a href="#currentPage-prop"><b>currentPage</b></a>&nbsp;- the index position of the current tab page</li>
91<li class=fn>int <a href="#margin-prop"><b>margin</b></a>&nbsp;- the margin in this tab widget</li>
92<li class=fn>TabPosition <a href="#tabPosition-prop"><b>tabPosition</b></a>&nbsp;- the position of the tabs in this tab widget</li>
93<li class=fn>TabShape <a href="#tabShape-prop"><b>tabShape</b></a>&nbsp;- the shape of the tabs in this tab widget</li>
94</ul>
95<h2>Protected Members</h2>
96<ul>
97<li class=fn>void <a href="#setTabBar"><b>setTabBar</b></a> ( QTabBar&nbsp;*&nbsp;tb )</li>
98<li class=fn>QTabBar * <a href="#tabBar"><b>tabBar</b></a> () const</li>
99</ul>
100<hr><a name="details"></a><h2>Detailed Description</h2>
101
102
103The QTabWidget class provides a stack of tabbed widgets.
104<p>
105
106
107<p> A tab widget provides a tab bar of tabs and a `page area' below
108(or above, see <a href="#TabPosition-enum">TabPosition</a>) the tabs. Each tab is associated
109with a different widget (called a `page'). Only the current tab's
110page is shown in the page area; all the other tabs' pages are
111hidden. The user can show a different page by clicking on its tab
112or by pressing its Alt+<em>letter</em> accelerator if it has one.
113<p> The normal way to use QTabWidget is to do the following in the
114constructor:
115<ol type=1>
116<li> Create a QTabWidget.
117<li> Create a <a href="qwidget.html">QWidget</a> for each of the pages in the tab dialog,
118insert children into it, set up geometry management for it and use
119<a href="#addTab">addTab</a>() (or <a href="#insertTab">insertTab</a>()) to set up a tab and keyboard accelerator
120for it.
121<li> Connect to the signals and slots.
122</ol>
123<p> The position of the tabs is set with <a href="#setTabPosition">setTabPosition</a>(), their shape
124with <a href="#setTabShape">setTabShape</a>(), and their margin with <a href="#setMargin">setMargin</a>().
125<p> If you don't call addTab() and the QTabWidget is already visible,
126then the page you have created will not be visible. Don't
127confuse the object name you supply to the QWidget constructor and
128the tab label you supply to addTab(). addTab() takes a name which
129indicates an accelerator and is meaningful and descriptive to the
130user, whereas the widget name is used primarily for debugging.
131<p> The signal <a href="#currentChanged">currentChanged</a>() is emitted when the user selects a
132page.
133<p> The current page is available as an index position with
134<a href="#currentPageIndex">currentPageIndex</a>() or as a wiget pointer with <a href="#currentPage">currentPage</a>(). You
135can retrieve a pointer to a page with a given index using <a href="#page">page</a>(),
136and can find the index position of a page with <a href="#indexOf">indexOf</a>(). Use
137<a href="#setCurrentPage">setCurrentPage</a>() to show a particular page by index, or <a href="#showPage">showPage</a>()
138to show a page by widget pointer.
139<p> You can change a tab's label and iconset using <a href="#changeTab">changeTab</a>() or
140<a href="#setTabLabel">setTabLabel</a>() and <a href="#setTabIconSet">setTabIconSet</a>(). A tab page can be removed with
141<a href="#removePage">removePage</a>().
142<p> Each tab is either enabled or disabled at any given time (see
143<a href="#setTabEnabled">setTabEnabled</a>()). If a tab is enabled, the tab text is drawn
144normally and the user can select that tab. If it is disabled, the
145tab is drawn in a different way and the user cannot select that
146tab. Note that even if a tab is disabled, the page can still be
147visible, for example if all of the tabs happen to be disabled.
148<p> Although tab widgets can be a very good way to split up a complex
149dialog, it's also very easy to get into a mess. See <a href="qtabdialog.html">QTabDialog</a> for
150some design hints. An alternative is to use a <a href="qwidgetstack.html">QWidgetStack</a> for
151which you provide some means of navigating between pages, for
152example, a <a href="qtoolbar.html">QToolBar</a> or a <a href="qlistbox.html">QListBox</a>.
153<p> Most of the functionality in QTabWidget is provided by a <a href="qtabbar.html">QTabBar</a>
154(at the top, providing the tabs) and a QWidgetStack (most of the
155area, organizing the individual pages).
156<p> <img src=qtabwidget-m.png> <img src=qtabwidget-w.png>
157<p> <p>See also <a href="qtabdialog.html">QTabDialog</a>, <a href="qtoolbox.html">QToolBox</a>, <a href="advanced.html">Advanced Widgets</a>, and <a href="organizers.html">Organizers</a>.
158
159<hr><h2>Member Type Documentation</h2>
160<h3 class=fn><a name="TabPosition-enum"></a>QTabWidget::TabPosition</h3>
161
162<p> This enum type defines where QTabWidget draws the tab row:
163<ul>
164<li><tt>QTabWidget::Top</tt> - above the pages
165<li><tt>QTabWidget::Bottom</tt> - below the pages
166</ul>
167<h3 class=fn><a name="TabShape-enum"></a>QTabWidget::TabShape</h3>
168
169<p> This enum type defines the shape of the tabs:
170<ul>
171<li><tt>QTabWidget::Rounded</tt> - rounded look (normal)
172<li><tt>QTabWidget::Triangular</tt> - triangular look (very unusual, included for completeness)
173</ul>
174<hr><h2>Member Function Documentation</h2>
175<h3 class=fn><a name="QTabWidget"></a>QTabWidget::QTabWidget ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;parent = 0, const&nbsp;char&nbsp;*&nbsp;name = 0, WFlags&nbsp;f = 0 )
176</h3>
177Constructs a tabbed widget called <em>name</em> with parent <em>parent</em>,
178and widget flags <em>f</em>.
179
180<h3 class=fn>void <a name="addTab"></a>QTabWidget::addTab ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;child, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;label )<tt> [virtual]</tt>
181</h3>
182Adds another tab and page to the tab view.
183<p> The new page is <em>child</em>; the tab's label is <em>label</em>. Note the
184difference between the widget name (which you supply to widget
185constructors and to <a href="#setTabEnabled">setTabEnabled</a>(), for example) and the tab
186label. The name is internal to the program and invariant, whereas
187the label is shown on-screen and may vary according to language
188and other factors.
189<p> If the tab's <em>label</em> contains an ampersand, the letter following
190the ampersand is used as an accelerator for the tab, e.g. if the
191label is "Bro&amp;wse" then Alt+W becomes an accelerator which will
192move the focus to this tab.
193<p> If you call <a href="#addTab">addTab</a>() after <a href="qwidget.html#show">show</a>() the screen will flicker and the
194user may be confused.
195<p> Adding the same child twice will have undefined behavior.
196<p> <p>See also <a href="#insertTab">insertTab</a>().
197
198<p>Examples: <a href="addressbook-example.html#x600">addressbook/centralwidget.cpp</a> and <a href="themes-example.html#x343">themes/themes.cpp</a>.
199<h3 class=fn>void <a name="addTab-2"></a>QTabWidget::addTab ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;child, const&nbsp;<a href="qiconset.html">QIconSet</a>&nbsp;&amp;&nbsp;iconset, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;label )<tt> [virtual]</tt>
200</h3>
201This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
202<p> Adds another tab and page to the tab view.
203<p> This function is the same as <a href="#addTab">addTab</a>(), but with an additional <em>iconset</em>.
204
205<h3 class=fn>void <a name="addTab-3"></a>QTabWidget::addTab ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;child, <a href="qtab.html">QTab</a>&nbsp;*&nbsp;tab )<tt> [virtual]</tt>
206</h3>
207This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
208<p> This is a low-level function for adding tabs. It is useful if you
209are using <a href="#setTabBar">setTabBar</a>() to set a <a href="qtabbar.html">QTabBar</a> subclass with an overridden
210<a href="qtabbar.html#paint">QTabBar::paint</a>() function for a subclass of <a href="qtab.html">QTab</a>. The <em>child</em> is
211the new page and <em>tab</em> is the tab to put the <em>child</em> on.
212
213<h3 class=fn>void <a name="changeTab"></a>QTabWidget::changeTab ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;label )
214</h3>
215Defines a new <em>label</em> for page <em>w</em>'s tab.
216
217<h3 class=fn>void <a name="changeTab-2"></a>QTabWidget::changeTab ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w, const&nbsp;<a href="qiconset.html">QIconSet</a>&nbsp;&amp;&nbsp;iconset, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;label )
218</h3>
219This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
220<p> Defines a new <em>iconset</em> and a new <em>label</em> for page <em>w</em>'s tab.
221
222<h3 class=fn><a href="qwidget.html">QWidget</a>&nbsp;* <a name="cornerWidget"></a>QTabWidget::cornerWidget ( <a href="qt.html#Corner-enum">Qt::Corner</a>&nbsp;corner = Qt::TopRight ) const
223</h3>
224Returns the widget shown in the <em>corner</em> of the tab widget or 0.
225
226<h3 class=fn>int <a name="count"></a>QTabWidget::count () const
227</h3><p>Returns the number of tabs in the tab bar.
228See the <a href="qtabwidget.html#count-prop">"count"</a> property for details.
229<h3 class=fn>void <a name="currentChanged"></a>QTabWidget::currentChanged ( <a href="qwidget.html">QWidget</a>&nbsp;* )<tt> [signal]</tt>
230</h3>
231
232<p> This signal is emitted whenever the current page changes. The
233parameter is the new current page.
234<p> <p>See also <a href="#currentPage">currentPage</a>(), <a href="#showPage">showPage</a>(), and <a href="#tabLabel">tabLabel</a>().
235
236<h3 class=fn><a href="qwidget.html">QWidget</a>&nbsp;* <a name="currentPage"></a>QTabWidget::currentPage () const
237</h3>
238Returns a pointer to the page currently being displayed by the tab
239dialog. The tab dialog does its best to make sure that this value
240is never 0 (but if you try hard enough, it can be).
241
242<h3 class=fn>int <a name="currentPageIndex"></a>QTabWidget::currentPageIndex () const
243</h3><p>Returns the index position of the current tab page.
244See the <a href="qtabwidget.html#currentPage-prop">"currentPage"</a> property for details.
245<h3 class=fn>int <a name="indexOf"></a>QTabWidget::indexOf ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w ) const
246</h3>
247Returns the index position of page <em>w</em>, or -1 if the widget
248cannot be found.
249
250<h3 class=fn>void <a name="insertTab"></a>QTabWidget::insertTab ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;child, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;label, int&nbsp;index = -1 )<tt> [virtual]</tt>
251</h3>
252Inserts another tab and page to the tab view.
253<p> The new page is <em>child</em>; the tab's label is <em>label</em>. Note the
254difference between the widget name (which you supply to widget
255constructors and to <a href="#setTabEnabled">setTabEnabled</a>(), for example) and the tab
256label. The name is internal to the program and invariant, whereas
257the label is shown on-screen and may vary according to language
258and other factors.
259<p> If the tab's <em>label</em> contains an ampersand, the letter following
260the ampersand is used as an accelerator for the tab, e.g. if the
261label is "Bro&amp;wse" then Alt+W becomes an accelerator which will
262move the focus to this tab.
263<p> If <em>index</em> is not specified, the tab is simply appended.
264Otherwise it is inserted at the specified position.
265<p> If you call <a href="#insertTab">insertTab</a>() after <a href="qwidget.html#show">show</a>(), the screen will flicker and
266the user may be confused.
267<p> <p>See also <a href="#addTab">addTab</a>().
268
269<h3 class=fn>void <a name="insertTab-2"></a>QTabWidget::insertTab ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;child, const&nbsp;<a href="qiconset.html">QIconSet</a>&nbsp;&amp;&nbsp;iconset, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;label, int&nbsp;index = -1 )<tt> [virtual]</tt>
270</h3>
271This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
272<p> Inserts another tab and page to the tab view.
273<p> This function is the same as <a href="#insertTab">insertTab</a>(), but with an additional
274<em>iconset</em>.
275
276<h3 class=fn>void <a name="insertTab-3"></a>QTabWidget::insertTab ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;child, <a href="qtab.html">QTab</a>&nbsp;*&nbsp;tab, int&nbsp;index = -1 )<tt> [virtual]</tt>
277</h3>
278This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
279<p> This is a lower-level method for inserting tabs, similar to the
280other <a href="#insertTab">insertTab</a>() method. It is useful if you are using
281<a href="#setTabBar">setTabBar</a>() to set a <a href="qtabbar.html">QTabBar</a> subclass with an overridden
282<a href="qtabbar.html#paint">QTabBar::paint</a>() function for a subclass of <a href="qtab.html">QTab</a>. The <em>child</em> is
283the new page, <em>tab</em> is the tab to put the <em>child</em> on and <em>index</em> is the position in the tab bar that this page should occupy.
284
285<h3 class=fn>bool <a name="isTabEnabled"></a>QTabWidget::isTabEnabled ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w ) const
286</h3>
287Returns TRUE if the page <em>w</em> is enabled; otherwise returns FALSE.
288<p> <p>See also <a href="#setTabEnabled">setTabEnabled</a>() and <a href="qwidget.html#enabled-prop">QWidget::enabled</a>.
289
290<h3 class=fn><a href="qstring.html">QString</a> <a name="label"></a>QTabWidget::label ( int&nbsp;index ) const
291</h3>
292Returns the label of the tab at index position <em>index</em> or
293<a href="qstring.html#QString-null">QString::null</a> if the <em>index</em> is out of range.
294
295<h3 class=fn>int <a name="margin"></a>QTabWidget::margin () const
296</h3><p>Returns the margin in this tab widget.
297See the <a href="qtabwidget.html#margin-prop">"margin"</a> property for details.
298<h3 class=fn><a href="qwidget.html">QWidget</a>&nbsp;* <a name="page"></a>QTabWidget::page ( int&nbsp;index ) const
299</h3>
300Returns the tab page at index position <em>index</em> or 0 if the <em>index</em> is out of range.
301
302<h3 class=fn>void <a name="removePage"></a>QTabWidget::removePage ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w )<tt> [virtual slot]</tt>
303</h3>
304Removes page <em>w</em> from this stack of widgets. Does not delete <em>w</em>.
305<p> <p>See also <a href="#addTab">addTab</a>(), <a href="#showPage">showPage</a>(), and <a href="qwidgetstack.html#removeWidget">QWidgetStack::removeWidget</a>().
306
307<h3 class=fn>void <a name="removeTabToolTip"></a>QTabWidget::removeTabToolTip ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w )
308</h3>
309Removes the tab tool tip for page <em>w</em>. If the page does not have
310a tip, nothing happens.
311<p> <p>See also <a href="#setTabToolTip">setTabToolTip</a>() and <a href="#tabToolTip">tabToolTip</a>().
312
313<h3 class=fn>void <a name="setCornerWidget"></a>QTabWidget::setCornerWidget ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w, <a href="qt.html#Corner-enum">Qt::Corner</a>&nbsp;corner = Qt::TopRight )
314</h3>
315Sets widget <em>w</em> to be the shown in the specified <em>corner</em> of the
316tab widget.
317<p> Only the horizontal element of the <em>corner</em> will be used.
318<p> <p>See also <a href="#cornerWidget">cornerWidget</a>() and <a href="#tabPosition-prop">tabPosition</a>.
319
320<h3 class=fn>void <a name="setCurrentPage"></a>QTabWidget::setCurrentPage ( int )<tt> [slot]</tt>
321</h3><p>Sets the index position of the current tab page.
322See the <a href="qtabwidget.html#currentPage-prop">"currentPage"</a> property for details.
323<h3 class=fn>void <a name="setMargin"></a>QTabWidget::setMargin ( int )
324</h3><p>Sets the margin in this tab widget.
325See the <a href="qtabwidget.html#margin-prop">"margin"</a> property for details.
326<h3 class=fn>void <a name="setTabBar"></a>QTabWidget::setTabBar ( <a href="qtabbar.html">QTabBar</a>&nbsp;*&nbsp;tb )<tt> [protected]</tt>
327</h3>
328Replaces the dialog's <a href="qtabbar.html">QTabBar</a> heading with the tab bar <em>tb</em>. Note
329that this must be called <em>before</em> any tabs have been added, or
330the behavior is undefined.
331<p> <p>See also <a href="#tabBar">tabBar</a>().
332
333<h3 class=fn>void <a name="setTabEnabled"></a>QTabWidget::setTabEnabled ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w, bool&nbsp;enable )
334</h3>
335If <em>enable</em> is TRUE, page <em>w</em> is enabled; otherwise page <em>w</em> is
336disabled. The page's tab is redrawn appropriately.
337<p> QTabWidget uses <a href="qwidget.html#setEnabled">QWidget::setEnabled</a>() internally, rather than
338keeping a separate flag.
339<p> Note that even a disabled tab/page may be visible. If the page is
340visible already, QTabWidget will not hide it; if all the pages are
341disabled, QTabWidget will show one of them.
342<p> <p>See also <a href="#isTabEnabled">isTabEnabled</a>() and <a href="qwidget.html#enabled-prop">QWidget::enabled</a>.
343
344<h3 class=fn>void <a name="setTabIconSet"></a>QTabWidget::setTabIconSet ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w, const&nbsp;<a href="qiconset.html">QIconSet</a>&nbsp;&amp;&nbsp;iconset )
345</h3>
346Sets the iconset for page <em>w</em> to <em>iconset</em>.
347
348<h3 class=fn>void <a name="setTabLabel"></a>QTabWidget::setTabLabel ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;l )
349</h3>
350Sets the tab label for page <em>w</em> to <em>l</em>
351
352<h3 class=fn>void <a name="setTabPosition"></a>QTabWidget::setTabPosition ( <a href="qtabwidget.html#TabPosition-enum">TabPosition</a> )
353</h3><p>Sets the position of the tabs in this tab widget.
354See the <a href="qtabwidget.html#tabPosition-prop">"tabPosition"</a> property for details.
355<h3 class=fn>void <a name="setTabShape"></a>QTabWidget::setTabShape ( <a href="qtabwidget.html#TabShape-enum">TabShape</a>&nbsp;s )
356</h3><p>Sets the shape of the tabs in this tab widget to <em>s</em>.
357See the <a href="qtabwidget.html#tabShape-prop">"tabShape"</a> property for details.
358<h3 class=fn>void <a name="setTabToolTip"></a>QTabWidget::setTabToolTip ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;tip )
359</h3>
360Sets the tab tool tip for page <em>w</em> to <em>tip</em>.
361<p> <p>See also <a href="#removeTabToolTip">removeTabToolTip</a>() and <a href="#tabToolTip">tabToolTip</a>().
362
363<h3 class=fn>void <a name="showPage"></a>QTabWidget::showPage ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w )<tt> [virtual slot]</tt>
364</h3>
365Ensures that page <em>w</em> is shown. This is useful mainly for
366accelerators.
367<p> <b>Warning:</b> Used carelessly, this function can easily surprise or
368confuse the user.
369<p> <p>See also <a href="qtabbar.html#currentTab-prop">QTabBar::currentTab</a>.
370
371<h3 class=fn><a href="qtabbar.html">QTabBar</a>&nbsp;* <a name="tabBar"></a>QTabWidget::tabBar () const<tt> [protected]</tt>
372</h3>
373Returns the current <a href="qtabbar.html">QTabBar</a>.
374<p> <p>See also <a href="#setTabBar">setTabBar</a>().
375
376<h3 class=fn><a href="qiconset.html">QIconSet</a> <a name="tabIconSet"></a>QTabWidget::tabIconSet ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w ) const
377</h3>
378Returns the iconset of page <em>w</em> or a <a href="qiconset.html#QIconSet">null iconset</a> if <em>w</em> is not a tab page or does not have an
379iconset.
380
381<h3 class=fn><a href="qstring.html">QString</a> <a name="tabLabel"></a>QTabWidget::tabLabel ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w ) const
382</h3>
383Returns the label text for the tab on page <em>w</em>.
384
385<h3 class=fn><a href="qtabwidget.html#TabPosition-enum">TabPosition</a> <a name="tabPosition"></a>QTabWidget::tabPosition () const
386</h3><p>Returns the position of the tabs in this tab widget.
387See the <a href="qtabwidget.html#tabPosition-prop">"tabPosition"</a> property for details.
388<h3 class=fn><a href="qtabwidget.html#TabShape-enum">TabShape</a> <a name="tabShape"></a>QTabWidget::tabShape () const
389</h3><p>Returns the shape of the tabs in this tab widget.
390See the <a href="qtabwidget.html#tabShape-prop">"tabShape"</a> property for details.
391<h3 class=fn><a href="qstring.html">QString</a> <a name="tabToolTip"></a>QTabWidget::tabToolTip ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;w ) const
392</h3>
393Returns the tab tool tip for page <em>w</em> or <a href="qstring.html#QString-null">QString::null</a> if no tool
394tip has been set.
395<p> <p>See also <a href="#setTabToolTip">setTabToolTip</a>() and <a href="#removeTabToolTip">removeTabToolTip</a>().
396
397<hr><h2>Property Documentation</h2>
398<h3 class=fn>bool <a name="autoMask-prop"></a>autoMask</h3>
399<p>This property holds whether the tab widget is automatically masked.
400<p><p><p>See also <a href="qwidget.html#autoMask-prop">QWidget::autoMask</a>.
401
402<h3 class=fn>int <a name="count-prop"></a>count</h3>
403<p>This property holds the number of tabs in the tab bar.
404<p>
405<p>Get this property's value with <a href="#count">count</a>().
406<h3 class=fn>int <a name="currentPage-prop"></a>currentPage</h3>
407<p>This property holds the index position of the current tab page.
408<p>Set this property's value with <a href="#setCurrentPage">setCurrentPage</a>() and get this property's value with <a href="#currentPageIndex">currentPageIndex</a>().
409<p><p>See also <a href="qtabbar.html#currentTab-prop">QTabBar::currentTab</a>.
410
411<h3 class=fn>int <a name="margin-prop"></a>margin</h3>
412<p>This property holds the margin in this tab widget.
413<p>The margin is the distance between the innermost pixel of the
414frame and the outermost pixel of the pages.
415
416<p>Set this property's value with <a href="#setMargin">setMargin</a>() and get this property's value with <a href="#margin">margin</a>().
417<h3 class=fn><a href="qtabwidget.html#TabPosition-enum">TabPosition</a> <a name="tabPosition-prop"></a>tabPosition</h3>
418<p>This property holds the position of the tabs in this tab widget.
419<p>Possible values for this property are <a href="#TabPosition-enum">QTabWidget::Top</a> and <a href="#TabPosition-enum">QTabWidget::Bottom</a>.
420<p> <p>See also <a href="#TabPosition-enum">TabPosition</a>.
421
422<p>Set this property's value with <a href="#setTabPosition">setTabPosition</a>() and get this property's value with <a href="#tabPosition">tabPosition</a>().
423<h3 class=fn><a href="qtabwidget.html#TabShape-enum">TabShape</a> <a name="tabShape-prop"></a>tabShape</h3>
424<p>This property holds the shape of the tabs in this tab widget.
425<p>Possible values for this property are <a href="#TabShape-enum">QTabWidget::Rounded</a>
426(default) or <a href="#TabShape-enum">QTabWidget::Triangular</a>.
427<p> <p>See also <a href="#TabShape-enum">TabShape</a>.
428
429<p>Set this property's value with <a href="#setTabShape">setTabShape</a>() and get this property's value with <a href="#tabShape">tabShape</a>().
430<!-- eof -->
431<hr><p>
432This file is part of the <a href="index.html">Qt toolkit</a>.
433Copyright &copy; 1995-2007
434<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
435<table width=100% cellspacing=0 border=0><tr>
436<td>Copyright &copy; 2007
437<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
438<td align=right><div align=right>Qt 3.3.8</div>
439</table></div></address></body>
440</html>
Note: See TracBrowser for help on using the repository browser.