~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QTabBar Class Reference</h1>

<p>The QTabBar class provides a tab bar, e.g. for use in tabbed dialogs. <a href="#details">More...</a></p>

<pre>#include <QTabBar></pre><p>Part of the <a href="qtgui.html">QtGui</a> module.</p>

<p>Inherits <a href="qwidget.html">QWidget</a>.</p>

<ul>

<li><a href="qtabbar-members.html">List of all members, including inherited members</a></li>

<li><a href="qtabbar-qt3.html">Qt 3 support members</a></li>

</ul>

<h3>Public Types</h3>

<ul>

<li><div class="fn"/>enum <b><a href="qtabbar.html#Shape-enum">Shape</a></b> { RoundedNorth, RoundedSouth, RoundedWest, RoundedEast, ..., TriangularEast }</li>

</ul>

<h3>Properties</h3>

<ul>

<li><div class="fn"/><b><a href="qtabbar.html#count-prop">count</a></b> : const int</li>

<li><div class="fn"/><b><a href="qtabbar.html#currentIndex-prop">currentIndex</a></b> : int</li>

<li><div class="fn"/><b><a href="qtabbar.html#drawBase-prop">drawBase</a></b> : bool</li>

<li><div class="fn"/><b><a href="qtabbar.html#shape-prop">shape</a></b> : Shape</li>

</ul>

<ul>

<li><div class="fn"/>52 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>

<li><div class="fn"/>1 property inherited from <a href="qobject.html#properties">QObject</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qtabbar.html#QTabBar">QTabBar</a></b> ( QWidget * <i>parent</i> = 0 )</li>

<li><div class="fn"/><b><a href="qtabbar.html#dtor.QTabBar">~QTabBar</a></b> ()</li>

<li><div class="fn"/>int <b><a href="qtabbar.html#addTab">addTab</a></b> ( const QString & <i>text</i> )</li>

<li><div class="fn"/>int <b><a href="qtabbar.html#addTab-2">addTab</a></b> ( const QIcon & <i>icon</i>, const QString & <i>text</i> )</li>

<li><div class="fn"/>int <b><a href="qtabbar.html#count-prop">count</a></b> () const</li>

<li><div class="fn"/>int <b><a href="qtabbar.html#currentIndex-prop">currentIndex</a></b> () const</li>

<li><div class="fn"/>bool <b><a href="qtabbar.html#drawBase-prop">drawBase</a></b> () const</li>

<li><div class="fn"/>int <b><a href="qtabbar.html#insertTab">insertTab</a></b> ( int <i>index</i>, const QString & <i>text</i> )</li>

<li><div class="fn"/>int <b><a href="qtabbar.html#insertTab-2">insertTab</a></b> ( int <i>index</i>, const QIcon & <i>icon</i>, const QString & <i>text</i> )</li>

<li><div class="fn"/>bool <b><a href="qtabbar.html#isTabEnabled">isTabEnabled</a></b> ( int <i>index</i> ) const</li>

<li><div class="fn"/>void <b><a href="qtabbar.html#removeTab">removeTab</a></b> ( int <i>index</i> )</li>

<li><div class="fn"/>void <b><a href="qtabbar.html#drawBase-prop">setDrawBase</a></b> ( bool <i>drawTheBase</i> )</li>

<li><div class="fn"/>void <b><a href="qtabbar.html#shape-prop">setShape</a></b> ( Shape <i>shape</i> )</li>

<li><div class="fn"/>void <b><a href="qtabbar.html#setTabData">setTabData</a></b> ( int <i>index</i>, const QVariant & <i>data</i> )</li>

<li><div class="fn"/>void <b><a href="qtabbar.html#setTabEnabled">setTabEnabled</a></b> ( int <i>index</i>, bool <i>enabled</i> )</li>

<li><div class="fn"/>void <b><a href="qtabbar.html#setTabIcon">setTabIcon</a></b> ( int <i>index</i>, const QIcon & <i>icon</i> )</li>

<li><div class="fn"/>void <b><a href="qtabbar.html#setTabText">setTabText</a></b> ( int <i>index</i>, const QString & <i>text</i> )</li>

<li><div class="fn"/>void <b><a href="qtabbar.html#setTabToolTip">setTabToolTip</a></b> ( int <i>index</i>, const QString & <i>tip</i> )</li>

<li><div class="fn"/>Shape <b><a href="qtabbar.html#shape-prop">shape</a></b> () const</li>

<li><div class="fn"/>QVariant <b><a href="qtabbar.html#tabData">tabData</a></b> ( int <i>index</i> ) const</li>

<li><div class="fn"/>QIcon <b><a href="qtabbar.html#tabIcon">tabIcon</a></b> ( int <i>index</i> ) const</li>

<li><div class="fn"/>QRect <b><a href="qtabbar.html#tabRect">tabRect</a></b> ( int <i>index</i> ) const</li>

<li><div class="fn"/>QString <b><a href="qtabbar.html#tabText">tabText</a></b> ( int <i>index</i> ) const</li>

<li><div class="fn"/>QString <b><a href="qtabbar.html#tabToolTip">tabToolTip</a></b> ( int <i>index</i> ) const</li>

</ul>

<ul>

<li><div class="fn"/>183 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>

<li><div class="fn"/>28 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>

<li><div class="fn"/>10 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>

</ul>

<h3>Public Slots</h3>

<ul>

<li><div class="fn"/>void <b><a href="qtabbar.html#currentIndex-prop">setCurrentIndex</a></b> ( int <i>index</i> )</li>

</ul>

<ul>

<li><div class="fn"/>17 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>

<li><div class="fn"/>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>

</ul>

<h3>Signals</h3>

<ul>

<li><div class="fn"/>void <b><a href="qtabbar.html#currentChanged">currentChanged</a></b> ( int <i>index</i> )</li>

</ul>

<ul>

<li><div class="fn"/>1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>

</ul>

<h3>Protected Functions</h3>

<ul>

<li><div class="fn"/>virtual void <b><a href="qtabbar.html#tabInserted">tabInserted</a></b> ( int <i>index</i> )</li>

100

<li><div class="fn"/>virtual void <b><a href="qtabbar.html#tabLayoutChange">tabLayoutChange</a></b> ()</li>

101

<li><div class="fn"/>virtual void <b><a href="qtabbar.html#tabRemoved">tabRemoved</a></b> ( int <i>index</i> )</li>

102

<li><div class="fn"/>virtual QSize <b><a href="qtabbar.html#tabSizeHint">tabSizeHint</a></b> ( int <i>index</i> ) const</li>

103

</ul>

104

<ul>

105

<li><div class="fn"/>39 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>

106

<li><div class="fn"/>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>

107

</ul>

108

<h3>Additional Inherited Members</h3>

109

<ul>

110

<li><div class="fn"/>4 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li>

111

<li><div class="fn"/>4 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>

112

</ul>

113

114

<hr />

115

<h2>Detailed Description</h2>

116

<p>The QTabBar class provides a tab bar, e.g. for use in tabbed dialogs.</p>

117

<p>QTabBar is straightforward to use; it draws the tabs using one of the predefined <a href="qtabbar.html#Shape-enum">shapes</a>, and emits a signal when a tab is selected. It can be subclassed to tailor the look and feel. Qt also provides a ready-made <a href="qtabwidget.html">QTabWidget</a>.</p>

118

<p>Each tab has a <a href="qtabbar.html#tabText">tabText</a>(), an optional <a href="qtabbar.html#tabIcon">tabIcon</a>(), an optional <a href="qtabbar.html#tabToolTip">tabToolTip</a>(), and optional <a href="qtabbar.html#tabData">tabData</a>(). The tabs's attributes can be changed with <a href="qtabbar.html#setTabText">setTabText</a>(), <a href="qtabbar.html#setTabIcon">setTabIcon</a>(), <a href="qtabbar.html#setTabToolTip">setTabToolTip</a>(), and <a href="qtabbar.html#setTabData">setTabData</a>(). Each tabs can be enabled or disabled individually with <a href="qtabbar.html#setTabEnabled">setTabEnabled</a>().</p>

119

<p>Tabs are added using <a href="qtabbar.html#addTab">addTab</a>(), or inserted at particular positions using <a href="qtabbar.html#insertTab">insertTab</a>(). The total number of tabs is given by <a href="qtabbar.html#count-prop">count</a>(). Tabs can be removed from the tab bar with <a href="qtabbar.html#removeTab">removeTab</a>(). Combining <a href="qtabbar.html#removeTab">removeTab</a>() and <a href="qtabbar.html#insertTab">insertTab</a>() allows you to move tabs to different positions.</p>

120

<p>The <a href="qtabbar.html#shape-prop">shape</a> property defines the tabs' appearance. The choice of shape is a matter of taste, although tab dialogs (for preferences and similar) invariably use <tt>RoundedNorth</tt>. Tab controls in windows other than dialogs almost always use either <tt>RoundedSouth</tt> or <tt>TriangularSouth</tt>. Many spreadsheets and other tab controls in which all the pages are essentially similar use <tt>TriangularSouth</tt>, whereas <tt>RoundedSouth</tt> is used mostly when the pages are different (e.g. a multi-page tool palette). The default in QTabBar is <tt>RoundedNorth</tt>.</p>

121

<p>The most important part of QTabBar's API is the <a href="qtabbar.html#currentChanged">currentChanged</a>() signal. This is emitted whenever the current tab changes (even at startup, when the current tab changes from 'none'). There is also a slot, <a href="qtabbar.html#currentIndex-prop">setCurrentIndex</a>(), which can be used to select a tab programmatically. The function <a href="qtabbar.html#currentIndex-prop">currentIndex</a>() returns the index of the current tab, <a href="qtabbar.html#count-prop">count</a> holds the number of tabs.</p>

122

<p>QTabBar creates automatic mnemonic keys in the manner of <a href="qabstractbutton.html">QAbstractButton</a>; e.g. if a tab's label is "&Graphics", Alt+G becomes a shortcut key for switching to that tab.</p>

123

<p>The following virtual functions may need to be reimplemented in order to tailor the look and feel or store extra data with each tab:</p>

124

<ul>

125

<li><a href="qtabbar.html#tabSizeHint">tabSizeHint</a>() calcuates the size of a tab.</li>

126

<li><a href="qtabbar.html#tabInserted">tabInserted</a>() notifies that a new tab was added.</li>

127

<li><a href="qtabbar.html#tabRemoved">tabRemoved</a>() notifies that a tab was removed.</li>

128

<li><a href="qtabbar.html#tabLayoutChange">tabLayoutChange</a>() notifies that the tabs have been re-laid out.</li>

129

<li><a href="qtabbar.html#paintEvent">paintEvent</a>() paints all tabs.</li>

130

</ul>

131

<p>For subclasses, you might also need the <a href="qtabbar.html#tabRect">tabRect</a>() functions which returns the visual geometry of a single tab.</p>

132

133

<hr />

134

<h2>Member Type Documentation</h2>

135

<h3 class="fn"><a name="Shape-enum"></a>enum QTabBar::Shape</h3>

136

<p>This enum type lists the built-in shapes supported by <a href="qtabbar.html">QTabBar</a>. Treat these as hints as some styles may not render some of the shapes. However, position should be honored.</p>

137

138

<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>

139

<tr><td valign="top"><tt>QTabBar::RoundedNorth</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">The normal rounded look above the pages</td></tr>

140

<tr><td valign="top"><tt>QTabBar::RoundedSouth</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">The normal rounded look below the pages</td></tr>

141

<tr><td valign="top"><tt>QTabBar::RoundedWest</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">The normal rounded look on the left side of the pages</td></tr>

142

<tr><td valign="top"><tt>QTabBar::RoundedEast</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">The normal rounded look on the right side the pages</td></tr>

143

<tr><td valign="top"><tt>QTabBar::TriangularNorth</tt></td><td align="center" valign="top"><tt>4</tt></td><td valign="top">Triangular tabs above the pages.</td></tr>

144

<tr><td valign="top"><tt>QTabBar::TriangularSouth</tt></td><td align="center" valign="top"><tt>5</tt></td><td valign="top">Triangular tabs similar to those used in the Excel spreadsheet, for example</td></tr>

145

<tr><td valign="top"><tt>QTabBar::TriangularWest</tt></td><td align="center" valign="top"><tt>6</tt></td><td valign="top">Triangular tabs on the left of the pages.</td></tr>

146

<tr><td valign="top"><tt>QTabBar::TriangularEast</tt></td><td align="center" valign="top"><tt>7</tt></td><td valign="top">Triangular tabs on the right of the pages.</td></tr>

147

</table>

148

<hr />

149

<h2>Property Documentation</h2>

150

<h3 class="fn"><a name="count-prop"></a>count : const int</h3>

151

<p>This property holds the number of tabs in the tab bar.</p>

152

<p>Access functions:</p>

153

<ul>

154

<li><div class="fn"/><b>int count () const</b></li>

155

</ul>

156

<h3 class="fn"><a name="currentIndex-prop"></a>currentIndex : int</h3>

157

<p>This property holds the index of the tab bar's visible tab.</p>

158

<p>Access functions:</p>

159

<ul>

160

<li><div class="fn"/><b>int currentIndex () const</b></li>

161

<li><div class="fn"/><b>void setCurrentIndex ( int <i>index</i> )</b></li>

162

</ul>

163

<h3 class="fn"><a name="drawBase-prop"></a>drawBase : bool</h3>

164

<p>This property holds defines whether or not tabbar should draw it's base.</p>

165

<p>If true then <a href="qtabbar.html">QTabBar</a> draws a base in relation to the styles overlab. Otherwise only the tabs are drawn.</p>

166

<p>Access functions:</p>

167

<ul>

168

<li><div class="fn"/><b>bool drawBase () const</b></li>

169

<li><div class="fn"/><b>void setDrawBase ( bool <i>drawTheBase</i> )</b></li>

170

</ul>

171

<p>See also <a href="qstyle.html#pixelMetric">QStyle::pixelMetric</a>() and <a href="qstyle.html#PixelMetric-enum">QStyle::PM_TabBarBaseOverlap</a>.</p>

172

<h3 class="fn"><a name="shape-prop"></a>shape : <a href="qtabbar.html#Shape-enum">Shape</a></h3>

173

<p>This property holds the shape of the tabs in the tab bar.</p>

174

<p>The value of this property is one of the following: <tt>RoundedNorth</tt> (default), <tt>RoundedSouth</tt>, <tt>TriangularNorth</tt> or <tt>TriangularBelow</tt>.</p>

175

<p>Access functions:</p>

176

<ul>

177

<li><div class="fn"/><b>Shape shape () const</b></li>

178

<li><div class="fn"/><b>void setShape ( Shape <i>shape</i> )</b></li>

179

</ul>

180

<p>See also <a href="qtabbar.html#Shape-enum">Shape</a>.</p>

181

<hr />

182

<h2>Member Function Documentation</h2>

183

<h3 class="fn"><a name="QTabBar"></a>QTabBar::QTabBar ( <a href="qwidget.html">QWidget</a> * <i>parent</i> = 0 )</h3>

184

<p>Creates a new tab bar with the given <i>parent</i>.</p>

185

<h3 class="fn"><a name="dtor.QTabBar"></a>QTabBar::~QTabBar ()</h3>

186

<p>Destroys the tab bar.</p>

187

<h3 class="fn"><a name="addTab"></a>int QTabBar::addTab ( const <a href="qstring.html">QString</a> & <i>text</i> )</h3>

188

<p>Adds a new tab with text <i>text</i>. Returns the new tab's index.</p>

189

<h3 class="fn"><a name="addTab-2"></a>int QTabBar::addTab ( const <a href="qicon.html">QIcon</a> & <i>icon</i>, const <a href="qstring.html">QString</a> & <i>text</i> )</h3>

190

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

191

<p>Adds a new tab with icon <i>icon</i> and text <i>text</i>. Returns the new tab's index.</p>

192

<h3 class="fn"><a name="currentChanged"></a>void QTabBar::currentChanged ( int <i>index</i> )  <tt> [signal]</tt></h3>

193

<p>This signal is emitted when the tab bar's current tab changes. The new current has the given <i>index</i>.</p>

194

<h3 class="fn"><a name="insertTab"></a>int QTabBar::insertTab ( int <i>index</i>, const <a href="qstring.html">QString</a> & <i>text</i> )</h3>

195

<p>Inserts a new tab with text <i>text</i> at position <i>index</i>. If <i>index</i> is out of range, the new tab is appened. Returns the new tab's index.</p>

196

<h3 class="fn"><a name="insertTab-2"></a>int QTabBar::insertTab ( int <i>index</i>, const <a href="qicon.html">QIcon</a> & <i>icon</i>, const <a href="qstring.html">QString</a> & <i>text</i> )</h3>

197

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

198

<p>Inserts a new tab with icon <i>icon</i> and text <i>text</i> at position <i>index</i>. If <i>index</i> is out of range, the new tab is appended. Returns the new tab's index.</p>

199

<h3 class="fn"><a name="isTabEnabled"></a>bool QTabBar::isTabEnabled ( int <i>index</i> ) const</h3>

200

<p>Returns true if the tab at position <i>index</i> is enabled; otherwise returns false.</p>

201

<h3 class="fn"><a name="removeTab"></a>void QTabBar::removeTab ( int <i>index</i> )</h3>

202

<p>Removes the tab at position <i>index</i>.</p>

203

<h3 class="fn"><a name="setTabData"></a>void QTabBar::setTabData ( int <i>index</i>, const <a href="qvariant.html">QVariant</a> & <i>data</i> )</h3>

204

<p>Sets the data of the tab at position <i>index</i> to <i>data</i>.</p>

205

<h3 class="fn"><a name="setTabEnabled"></a>void QTabBar::setTabEnabled ( int <i>index</i>, bool <i>enabled</i> )</h3>

206

<p>If <i>enabled</i> is true then the tab at position <i>index</i> is enabled; otherwise the item at position <i>index</i> is disabled.</p>

207

<h3 class="fn"><a name="setTabIcon"></a>void QTabBar::setTabIcon ( int <i>index</i>, const <a href="qicon.html">QIcon</a> & <i>icon</i> )</h3>

208

<p>Sets the icon of the tab at position <i>index</i> to <i>icon</i>.</p>

209

<h3 class="fn"><a name="setTabText"></a>void QTabBar::setTabText ( int <i>index</i>, const <a href="qstring.html">QString</a> & <i>text</i> )</h3>

210

<p>Sets the text of the tab at position <i>index</i> to <i>text</i>.</p>

211

<h3 class="fn"><a name="setTabToolTip"></a>void QTabBar::setTabToolTip ( int <i>index</i>, const <a href="qstring.html">QString</a> & <i>tip</i> )</h3>

212

<p>Sets the tool tip of the tab at position <i>index</i> to <i>tip</i>.</p>

213

<h3 class="fn"><a name="tabData"></a><a href="qvariant.html">QVariant</a> QTabBar::tabData ( int <i>index</i> ) const</h3>

214

<p>Returns the datad of the tab at position <i>index</i>, or a null variant if <i>index</i> is out of range.</p>

215

<h3 class="fn"><a name="tabIcon"></a><a href="qicon.html">QIcon</a> QTabBar::tabIcon ( int <i>index</i> ) const</h3>

216

<p>Returns the icon of the tab at position <i>index</i>, or a null icon if <i>index</i> is out of range.</p>

217

<h3 class="fn"><a name="tabInserted"></a>void QTabBar::tabInserted ( int <i>index</i> )  <tt> [virtual protected]</tt></h3>

218

<p>This virtual handler is called after a new tab was added or inserted at position <i>index</i>.</p>

219

<p>See also <a href="qtabbar.html#tabRemoved">tabRemoved</a>().</p>

220

<h3 class="fn"><a name="tabLayoutChange"></a>void QTabBar::tabLayoutChange ()  <tt> [virtual protected]</tt></h3>

221

<p>This virtual handler is called whenever the tab layout changes.</p>

222

<p>See also <a href="qtabbar.html#tabRect">tabRect</a>().</p>

223

<h3 class="fn"><a name="tabRect"></a><a href="qrect.html">QRect</a> QTabBar::tabRect ( int <i>index</i> ) const</h3>

224

<p>Returns the visual rectangle of the of the tab at position <i>index</i>, or a null rectangle if <i>index</i> is out of range.</p>

225

<h3 class="fn"><a name="tabRemoved"></a>void QTabBar::tabRemoved ( int <i>index</i> )  <tt> [virtual protected]</tt></h3>

226

<p>This virtual handler is called after a tab was removed from position <i>index</i>.</p>

227

<p>See also <a href="qtabbar.html#tabInserted">tabInserted</a>().</p>

228

<h3 class="fn"><a name="tabSizeHint"></a><a href="qsize.html">QSize</a> QTabBar::tabSizeHint ( int <i>index</i> ) const  <tt> [virtual protected]</tt></h3>

229

<p>Returns the size hint for the tab at position <i>index</i>.</p>

230

<h3 class="fn"><a name="tabText"></a><a href="qstring.html">QString</a> QTabBar::tabText ( int <i>index</i> ) const</h3>

231

<p>Returns the text of the tab at position <i>index</i>, or an empty string if <i>index</i> is out of range.</p>

232

<h3 class="fn"><a name="tabToolTip"></a><a href="qstring.html">QString</a> QTabBar::tabToolTip ( int <i>index</i> ) const</h3>

233

<p>Returns the tool tip of the tab at position <i>index</i>, or an empty string if <i>index</i> is out of range.</p>

234

235

236

237

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

238

239

</tr></table></div></address></body>

240

</html>

Older »