1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/widgets/qtoolbutton.cpp:75 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>TQToolButton Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td 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="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQToolButton Class Reference</h1>
<p>The TQToolButton class provides a tquick-access button to
commands or options, usually used inside a TQToolBar.
<a href="#details">More...</a>
<p><tt>#include <<a href="qtoolbutton-h.html">ntqtoolbutton.h</a>></tt>
<p>Inherits <a href="ntqbutton.html">TQButton</a>.
<p><a href="qtoolbutton-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn>enum <a href="#TextPosition-enum"><b>TextPosition</b></a> { BesideIcon, BelowIcon, Right = BesideIcon, Under = BelowIcon }</li>
<li class=fn><a href="#TQToolButton"><b>TQToolButton</b></a> ( TQWidget * parent, const char * name = 0 )</li>
<li class=fn><a href="#TQToolButton-2"><b>TQToolButton</b></a> ( const TQIconSet & iconSet, const TQString & textLabel, const TQString & grouptext, TQObject * receiver, const char * slot, TQToolBar * parent, const char * name = 0 )</li>
<li class=fn><a href="#TQToolButton-3"><b>TQToolButton</b></a> ( ArrowType type, TQWidget * parent, const char * name = 0 )</li>
<li class=fn><a href="#~TQToolButton"><b>~TQToolButton</b></a> ()</li>
<li class=fn>void setOnIconSet ( const TQIconSet & ) <em>(obsolete)</em></li>
<li class=fn>void setOffIconSet ( const TQIconSet & ) <em>(obsolete)</em></li>
<li class=fn>void setIconSet ( const TQIconSet & set, bool on ) <em>(obsolete)</em></li>
<li class=fn>TQIconSet onIconSet () const <em>(obsolete)</em></li>
<li class=fn>TQIconSet offIconSet () const <em>(obsolete)</em></li>
<li class=fn>TQIconSet iconSet ( bool on ) const <em>(obsolete)</em></li>
<li class=fn>virtual void <a href="#setIconSet"><b>setIconSet</b></a> ( const TQIconSet & )</li>
<li class=fn>TQIconSet <a href="#iconSet"><b>iconSet</b></a> () const</li>
<li class=fn>bool <a href="#usesBigPixmap"><b>usesBigPixmap</b></a> () const</li>
<li class=fn>bool <a href="#usesTextLabel"><b>usesTextLabel</b></a> () const</li>
<li class=fn>TQString <a href="#textLabel"><b>textLabel</b></a> () const</li>
<li class=fn>void <a href="#setPopup"><b>setPopup</b></a> ( TQPopupMenu * popup )</li>
<li class=fn>TQPopupMenu * <a href="#popup"><b>popup</b></a> () const</li>
<li class=fn>void <a href="#setPopupDelay"><b>setPopupDelay</b></a> ( int delay )</li>
<li class=fn>int <a href="#popupDelay"><b>popupDelay</b></a> () const</li>
<li class=fn>void <a href="#openPopup"><b>openPopup</b></a> ()</li>
<li class=fn>void <a href="#setAutoRaise"><b>setAutoRaise</b></a> ( bool enable )</li>
<li class=fn>bool <a href="#autoRaise"><b>autoRaise</b></a> () const</li>
<li class=fn>TextPosition <a href="#textPosition"><b>textPosition</b></a> () const</li>
</ul>
<h2>Public Slots</h2>
<ul>
<li class=fn>virtual void <a href="#setUsesBigPixmap"><b>setUsesBigPixmap</b></a> ( bool enable )</li>
<li class=fn>virtual void <a href="#setUsesTextLabel"><b>setUsesTextLabel</b></a> ( bool enable )</li>
<li class=fn>virtual void <a href="#setTextLabel-2"><b>setTextLabel</b></a> ( const TQString & newLabel, bool tipToo )</li>
<li class=fn>virtual void <a href="#setToggleButton"><b>setToggleButton</b></a> ( bool enable )</li>
<li class=fn>virtual void <a href="#setOn"><b>setOn</b></a> ( bool enable )</li>
<li class=fn>void <a href="#toggle"><b>toggle</b></a> ()</li>
<li class=fn>void <a href="#setTextLabel"><b>setTextLabel</b></a> ( const TQString & )</li>
<li class=fn>void <a href="#setTextPosition"><b>setTextPosition</b></a> ( TextPosition pos )</li>
</ul>
<h2>Properties</h2>
<ul>
<li class=fn>bool <a href="#autoRaise-prop"><b>autoRaise</b></a> - whether auto-raising is enabled</li>
<li class=fn>BackgroundMode <a href="#backgroundMode-prop"><b>backgroundMode</b></a> - the toolbutton's background mode <em>(read only)</em></li>
<li class=fn>TQIconSet <a href="#iconSet-prop"><b>iconSet</b></a> - the icon set providing the icon shown on the button</li>
<li class=fn>TQIconSet offIconSet - the icon set that is used when the button is in an "off" state <em>(obsolete)</em></li>
<li class=fn>bool <a href="#on-prop"><b>on</b></a> - whether this tool button is on</li>
<li class=fn>TQIconSet onIconSet - the icon set that is used when the button is in an "on" state <em>(obsolete)</em></li>
<li class=fn>TQPixmap <a href="#pixmap-prop"><b>pixmap</b></a> - the pixmap of the button <em>(read only)</em></li>
<li class=fn>int <a href="#popupDelay-prop"><b>popupDelay</b></a> - the time delay between pressing the button and the appearance of the associated popup menu in milliseconds</li>
<li class=fn>TQString <a href="#textLabel-prop"><b>textLabel</b></a> - the label of this button</li>
<li class=fn>TextPosition <a href="#textPosition-prop"><b>textPosition</b></a> - the position of the text label of this button</li>
<li class=fn>bool <a href="#toggleButton-prop"><b>toggleButton</b></a> - whether this tool button is a toggle button</li>
<li class=fn>bool <a href="#usesBigPixmap-prop"><b>usesBigPixmap</b></a> - whether this toolbutton uses big pixmaps</li>
<li class=fn>bool <a href="#usesTextLabel-prop"><b>usesTextLabel</b></a> - whether the toolbutton displays a text label below the button pixmap</li>
</ul>
<h2>Protected Members</h2>
<ul>
<li class=fn>bool <a href="#uses3D"><b>uses3D</b></a> () const</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
The TQToolButton class provides a tquick-access button to
commands or options, usually used inside a <a href="ntqtoolbar.html">TQToolBar</a>.
<p>
<p> A tool button is a special button that provides tquick-access to
specific commands or options. As opposed to a normal command
button, a tool button usually doesn't show a text label, but shows
an icon instead. Its classic usage is to select tools, for example
the "pen" tool in a drawing program. This would be implemented
with a TQToolButton as toggle button (see <a href="#setToggleButton">setToggleButton</a>() ).
<p> TQToolButton supports auto-raising. In auto-raise mode, the button
draws a 3D frame only when the mouse points at it. The feature is
automatically turned on when a button is used inside a TQToolBar.
Change it with <a href="#setAutoRaise">setAutoRaise</a>().
<p> A tool button's icon is set as <a href="ntqiconset.html">TQIconSet</a>. This makes it possible to
specify different pixmaps for the disabled and active state. The
disabled pixmap is used when the button's functionality is not
available. The active pixmap is displayed when the button is
auto-raised because the mouse pointer is hovering over it.
<p> The button's look and dimension is adjustable with
<a href="#setUsesBigPixmap">setUsesBigPixmap</a>() and <a href="#setUsesTextLabel">setUsesTextLabel</a>(). When used inside a
<a href="ntqtoolbar.html">TQToolBar</a> in a <a href="ntqmainwindow.html">TQMainWindow</a>, the button automatically adjusts to
TQMainWindow's settings (see <a href="ntqmainwindow.html#setUsesTextLabel">TQMainWindow::setUsesTextLabel</a>() and
<a href="ntqmainwindow.html#setUsesBigPixmaps">TQMainWindow::setUsesBigPixmaps</a>()). The pixmap set on a TQToolButton
will be set to 22x22 if it is bigger than this size. If
<a href="#usesBigPixmap">usesBigPixmap</a>() is TRUE, then the pixmap will be set to 32x32.
<p> A tool button can offer additional choices in a popup menu. The
feature is sometimes used with the "Back" button in a web browser.
After pressing and holding the button down for a while, a menu
pops up showing a list of possible pages to jump to. With
TQToolButton you can set a popup menu using <a href="#setPopup">setPopup</a>(). The default
delay is 600ms; you can adjust it with <a href="#setPopupDelay">setPopupDelay</a>().
<p> <center><img src="qdockwindow.png" alt="Toolbar with Toolbuttons \caption A floating"></center> TQToolbar with TQToolbuttons
<p> <p>See also <a href="ntqpushbutton.html">TQPushButton</a>, <a href="ntqtoolbar.html">TQToolBar</a>, <a href="ntqmainwindow.html">TQMainWindow</a>, <a href="guibooks.html#fowler
">GUI Design Handbook: Push Button</a>, and <a href="basic.html">Basic Widgets</a>.
<hr><h2>Member Type Documentation</h2>
<h3 class=fn><a name="TextPosition-enum"></a>TQToolButton::TextPosition</h3>
<p> The position of the tool button's textLabel in relation to the
tool button's icon.
<ul>
<li><tt>TQToolButton::BesideIcon</tt> - The text appears beside the icon.
<li><tt>TQToolButton::BelowIcon</tt> - The text appears below the icon.
</ul>
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="TQToolButton"></a>TQToolButton::TQToolButton ( <a href="ntqwidget.html">TQWidget</a> * parent, const char * name = 0 )
</h3>
Constructs an empty tool button called <em>name</em>, with parent <em>parent</em>.
<h3 class=fn><a name="TQToolButton-2"></a>TQToolButton::TQToolButton ( const <a href="ntqiconset.html">TQIconSet</a> & iconSet, const <a href="ntqstring.html">TQString</a> & textLabel, const <a href="ntqstring.html">TQString</a> & grouptext, <a href="ntqobject.html">TQObject</a> * receiver, const char * slot, <a href="ntqtoolbar.html">TQToolBar</a> * parent, const char * name = 0 )
</h3>
Constructs a tool button called <em>name</em>, that is a child of <em>parent</em> (which must be a <a href="ntqtoolbar.html">TQToolBar</a>).
<p> The tool button will display <em>iconSet</em>, with its text label and
tool tip set to <em>textLabel</em> and its status bar message set to <em>grouptext</em>. It will be connected to the <em>slot</em> in object <em>receiver</em>.
<h3 class=fn><a name="TQToolButton-3"></a>TQToolButton::TQToolButton ( <a href="ntqt.html#ArrowType-enum">ArrowType</a> type, <a href="ntqwidget.html">TQWidget</a> * parent, const char * name = 0 )
</h3>
Constructs a tool button as an arrow button. The <a href="ntqt.html#ArrowType-enum">ArrowType</a> <em>type</em> defines the arrow direction. Possible values are <a href="ntqt.html#ArrowType-enum">LeftArrow</a>, <a href="ntqt.html#ArrowType-enum">RightArrow</a>, <a href="ntqt.html#ArrowType-enum">UpArrow</a> and <a href="ntqt.html#ArrowType-enum">DownArrow</a>.
<p> An arrow button has auto-repeat turned on by default.
<p> The <em>parent</em> and <em>name</em> arguments are sent to the <a href="ntqwidget.html">TQWidget</a>
constructor.
<h3 class=fn><a name="~TQToolButton"></a>TQToolButton::~TQToolButton ()
</h3>
Destroys the object and frees any allocated resources.
<h3 class=fn>bool <a name="autoRaise"></a>TQToolButton::autoRaise () const
</h3><p>Returns TRUE if auto-raising is enabled; otherwise returns FALSE.
See the <a href="ntqtoolbutton.html#autoRaise-prop">"autoRaise"</a> property for details.
<h3 class=fn><a href="ntqiconset.html">TQIconSet</a> <a name="iconSet"></a>TQToolButton::iconSet () const
</h3><p>Returns the icon set providing the icon shown on the button.
See the <a href="ntqtoolbutton.html#iconSet-prop">"iconSet"</a> property for details.
<h3 class=fn><a href="ntqiconset.html">TQIconSet</a> <a name="iconSet-2"></a>TQToolButton::iconSet ( bool on ) const
</h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> <b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code.
<p> Since TQt 3.0, <a href="ntqiconset.html">TQIconSet</a> contains both the On and Off icons.
<p> For ease of porting, this function ignores the <em>on</em> parameter and
returns the <a href="#iconSet-prop">iconSet</a> property. If you relied on the <em>on</em>
parameter, you probably want to update your code to use the TQIconSet
On/Off mechanism.
<h3 class=fn><a href="ntqiconset.html">TQIconSet</a> <a name="offIconSet"></a>TQToolButton::offIconSet () const
</h3><p>Returns the icon set that is used when the button is in an "off" state.
See the <a href="ntqtoolbutton.html#offIconSet-prop">"offIconSet"</a> property for details.
<h3 class=fn><a href="ntqiconset.html">TQIconSet</a> <a name="onIconSet"></a>TQToolButton::onIconSet () const
</h3><p>Returns the icon set that is used when the button is in an "on" state.
See the <a href="ntqtoolbutton.html#onIconSet-prop">"onIconSet"</a> property for details.
<h3 class=fn>void <a name="openPopup"></a>TQToolButton::openPopup ()
</h3>
Opens (pops up) the associated popup menu. If there is no such
menu, this function does nothing. This function does not return
until the popup menu has been closed by the user.
<h3 class=fn><a href="ntqpopupmenu.html">TQPopupMenu</a> * <a name="popup"></a>TQToolButton::popup () const
</h3>
Returns the associated popup menu, or 0 if no popup menu has been
defined.
<p> <p>See also <a href="#setPopup">setPopup</a>().
<h3 class=fn>int <a name="popupDelay"></a>TQToolButton::popupDelay () const
</h3><p>Returns the time delay between pressing the button and the appearance of the associated popup menu in milliseconds.
See the <a href="ntqtoolbutton.html#popupDelay-prop">"popupDelay"</a> property for details.
<h3 class=fn>void <a name="setAutoRaise"></a>TQToolButton::setAutoRaise ( bool enable )
</h3><p>Sets whether auto-raising is enabled to <em>enable</em>.
See the <a href="ntqtoolbutton.html#autoRaise-prop">"autoRaise"</a> property for details.
<h3 class=fn>void <a name="setIconSet"></a>TQToolButton::setIconSet ( const <a href="ntqiconset.html">TQIconSet</a> & )<tt> [virtual]</tt>
</h3><p>Sets the icon set providing the icon shown on the button.
See the <a href="ntqtoolbutton.html#iconSet-prop">"iconSet"</a> property for details.
<h3 class=fn>void <a name="setIconSet-2"></a>TQToolButton::setIconSet ( const <a href="ntqiconset.html">TQIconSet</a> & set, bool on )
</h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> <b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code.
<p> Since TQt 3.0, <a href="ntqiconset.html">TQIconSet</a> contains both the On and Off icons.
<p> For ease of porting, this function ignores the <em>on</em> parameter and
sets the <a href="#iconSet-prop">iconSet</a> property. If you relied on the <em>on</em> parameter,
you probably want to update your code to use the TQIconSet On/Off
mechanism.
<p> <p>See also <a href="#iconSet-prop">iconSet</a> and <a href="ntqiconset.html#State-enum">TQIconSet::State</a>.
<h3 class=fn>void <a name="setOffIconSet"></a>TQToolButton::setOffIconSet ( const <a href="ntqiconset.html">TQIconSet</a> & )
</h3><p>Sets the icon set that is used when the button is in an "off" state.
See the <a href="ntqtoolbutton.html#offIconSet-prop">"offIconSet"</a> property for details.
<h3 class=fn>void <a name="setOn"></a>TQToolButton::setOn ( bool enable )<tt> [virtual slot]</tt>
</h3><p>Sets whether this tool button is on to <em>enable</em>.
See the <a href="ntqtoolbutton.html#on-prop">"on"</a> property for details.
<h3 class=fn>void <a name="setOnIconSet"></a>TQToolButton::setOnIconSet ( const <a href="ntqiconset.html">TQIconSet</a> & )
</h3><p>Sets the icon set that is used when the button is in an "on" state.
See the <a href="ntqtoolbutton.html#onIconSet-prop">"onIconSet"</a> property for details.
<h3 class=fn>void <a name="setPopup"></a>TQToolButton::setPopup ( <a href="ntqpopupmenu.html">TQPopupMenu</a> * popup )
</h3>
Associates the popup menu <em>popup</em> with this tool button.
<p> The popup will be shown each time the tool button has been pressed
down for a certain amount of time. A typical application example
is the "back" button in some web browsers's tool bars. If the user
clicks it, the browser simply browses back to the previous page.
If the user presses and holds the button down for a while, the
tool button shows a menu containing the current history list.
<p> Ownership of the popup menu is not transferred to the tool button.
<p> <p>See also <a href="#popup">popup</a>().
<h3 class=fn>void <a name="setPopupDelay"></a>TQToolButton::setPopupDelay ( int delay )
</h3><p>Sets the time delay between pressing the button and the appearance of the associated popup menu in milliseconds to <em>delay</em>.
See the <a href="ntqtoolbutton.html#popupDelay-prop">"popupDelay"</a> property for details.
<h3 class=fn>void <a name="setTextLabel"></a>TQToolButton::setTextLabel ( const <a href="ntqstring.html">TQString</a> & )<tt> [slot]</tt>
</h3><p>Sets the label of this button.
See the <a href="ntqtoolbutton.html#textLabel-prop">"textLabel"</a> property for details.
<h3 class=fn>void <a name="setTextLabel-2"></a>TQToolButton::setTextLabel ( const <a href="ntqstring.html">TQString</a> & newLabel, bool tipToo )<tt> [virtual slot]</tt>
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Sets the label of this button to <em>newLabel</em> and automatically
sets it as a tool tip if <em>tipToo</em> is TRUE.
<h3 class=fn>void <a name="setTextPosition"></a>TQToolButton::setTextPosition ( <a href="ntqtoolbutton.html#TextPosition-enum">TextPosition</a> pos )<tt> [slot]</tt>
</h3><p>Sets the position of the text label of this button to <em>pos</em>.
See the <a href="ntqtoolbutton.html#textPosition-prop">"textPosition"</a> property for details.
<h3 class=fn>void <a name="setToggleButton"></a>TQToolButton::setToggleButton ( bool enable )<tt> [virtual slot]</tt>
</h3><p>Sets whether this tool button is a toggle button to <em>enable</em>.
See the <a href="ntqtoolbutton.html#toggleButton-prop">"toggleButton"</a> property for details.
<h3 class=fn>void <a name="setUsesBigPixmap"></a>TQToolButton::setUsesBigPixmap ( bool enable )<tt> [virtual slot]</tt>
</h3><p>Sets whether this toolbutton uses big pixmaps to <em>enable</em>.
See the <a href="ntqtoolbutton.html#usesBigPixmap-prop">"usesBigPixmap"</a> property for details.
<h3 class=fn>void <a name="setUsesTextLabel"></a>TQToolButton::setUsesTextLabel ( bool enable )<tt> [virtual slot]</tt>
</h3><p>Sets whether the toolbutton displays a text label below the button pixmap to <em>enable</em>.
See the <a href="ntqtoolbutton.html#usesTextLabel-prop">"usesTextLabel"</a> property for details.
<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="textLabel"></a>TQToolButton::textLabel () const
</h3><p>Returns the label of this button.
See the <a href="ntqtoolbutton.html#textLabel-prop">"textLabel"</a> property for details.
<h3 class=fn><a href="ntqtoolbutton.html#TextPosition-enum">TextPosition</a> <a name="textPosition"></a>TQToolButton::textPosition () const
</h3><p>Returns the position of the text label of this button.
See the <a href="ntqtoolbutton.html#textPosition-prop">"textPosition"</a> property for details.
<h3 class=fn>void <a name="toggle"></a>TQToolButton::toggle ()<tt> [slot]</tt>
</h3>
Toggles the state of this tool button.
<p> This function has no effect on <a href="ntqbutton.html#isToggleButton">non-toggling
buttons.</a>
<p> <p>See also <a href="#toggleButton-prop">toggleButton</a> and <a href="ntqbutton.html#toggled">toggled</a>().
<h3 class=fn>bool <a name="uses3D"></a>TQToolButton::uses3D () const<tt> [protected]</tt>
</h3>
Returns TRUE if this button should be drawn using raised edges;
otherwise returns FALSE.
<p> <p>See also <a href="ntqbutton.html#drawButton">drawButton</a>().
<h3 class=fn>bool <a name="usesBigPixmap"></a>TQToolButton::usesBigPixmap () const
</h3><p>Returns TRUE if this toolbutton uses big pixmaps; otherwise returns FALSE.
See the <a href="ntqtoolbutton.html#usesBigPixmap-prop">"usesBigPixmap"</a> property for details.
<h3 class=fn>bool <a name="usesTextLabel"></a>TQToolButton::usesTextLabel () const
</h3><p>Returns TRUE if the toolbutton displays a text label below the button pixmap; otherwise returns FALSE.
See the <a href="ntqtoolbutton.html#usesTextLabel-prop">"usesTextLabel"</a> property for details.
<hr><h2>Property Documentation</h2>
<h3 class=fn>bool <a name="autoRaise-prop"></a>autoRaise</h3>
<p>This property holds whether auto-raising is enabled.
<p>The default is disabled (i.e. FALSE).
<p>Set this property's value with <a href="#setAutoRaise">setAutoRaise</a>() and get this property's value with <a href="#autoRaise">autoRaise</a>().
<h3 class=fn><a href="ntqt.html#BackgroundMode-enum">BackgroundMode</a> <a name="backgroundMode-prop"></a>backgroundMode</h3>
<p>This property holds the toolbutton's background mode.
<p>Get this property with <a href="ntqwidget.html#backgroundMode">backgroundMode</a>().
<p> <p>See also <a href="ntqwidget.html#backgroundMode-prop">TQWidget::backgroundMode</a>.
<p><h3 class=fn><a href="ntqiconset.html">TQIconSet</a> <a name="iconSet-prop"></a>iconSet</h3>
<p>This property holds the icon set providing the icon shown on the button.
<p>Setting this property sets <a href="#pixmap-prop">TQToolButton::pixmap</a> to a null
pixmap. There is no default iconset.
<p> <p>See also <a href="#pixmap-prop">pixmap</a>, <a href="#toggleButton-prop">toggleButton</a>, and <a href="#on-prop">on</a>.
<p>Set this property's value with <a href="#setIconSet">setIconSet</a>() and get this property's value with <a href="#iconSet">iconSet</a>().
<h3 class=fn><a href="ntqiconset.html">TQIconSet</a> <a name="offIconSet-prop"></a>offIconSet</h3>
<p>This property holds the icon set that is used when the button is in an "off" state.
<p><b>This property is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code.
<p> Since TQt 3.0, <a href="ntqiconset.html">TQIconSet</a> contains both the On and Off icons. There is
now an <a href="#iconSet-prop">TQToolButton::iconSet</a> property that replaces both <a href="#onIconSet-prop">TQToolButton::onIconSet</a> and <a href="#offIconSet-prop">TQToolButton::offIconSet</a>.
<p> For ease of porting, this property is a synonym for <a href="#iconSet-prop">TQToolButton::iconSet</a>. You probably want to go over your application
code and use the TQIconSet On/Off mechanism.
<p> <p>See also <a href="#iconSet-prop">iconSet</a> and <a href="ntqiconset.html#State-enum">TQIconSet::State</a>.
<p>Set this property's value with <a href="#setOffIconSet">setOffIconSet</a>() and get this property's value with <a href="#offIconSet">offIconSet</a>().
<h3 class=fn>bool <a name="on-prop"></a>on</h3>
<p>This property holds whether this tool button is on.
<p>This property has no effect on <a href="ntqbutton.html#isToggleButton">non-toggling
buttons.</a> The default is FALSE (i.e. off).
<p> <p>See also <a href="#toggleButton-prop">toggleButton</a> and <a href="#toggle">toggle</a>().
<p>Set this property's value with <a href="#setOn">setOn</a>().
<h3 class=fn><a href="ntqiconset.html">TQIconSet</a> <a name="onIconSet-prop"></a>onIconSet</h3>
<p>This property holds the icon set that is used when the button is in an "on" state.
<p><b>This property is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code.
<p> Since TQt 3.0, <a href="ntqiconset.html">TQIconSet</a> contains both the On and Off icons. There is
now an <a href="#iconSet-prop">TQToolButton::iconSet</a> property that replaces both <a href="#onIconSet-prop">TQToolButton::onIconSet</a> and <a href="#offIconSet-prop">TQToolButton::offIconSet</a>.
<p> For ease of porting, this property is a synonym for <a href="#iconSet-prop">TQToolButton::iconSet</a>. You probably want to go over your application
code and use the TQIconSet On/Off mechanism.
<p> <p>See also <a href="#iconSet-prop">iconSet</a> and <a href="ntqiconset.html#State-enum">TQIconSet::State</a>.
<p>Set this property's value with <a href="#setOnIconSet">setOnIconSet</a>() and get this property's value with <a href="#onIconSet">onIconSet</a>().
<h3 class=fn><a href="ntqpixmap.html">TQPixmap</a> <a name="pixmap-prop"></a>pixmap</h3> <p>This property holds the pixmap of the button.
<p>The pixmap property has no meaning for tool buttons. Use the
iconSet property instead.
<p><h3 class=fn>int <a name="popupDelay-prop"></a>popupDelay</h3>
<p>This property holds the time delay between pressing the button and the appearance of the associated popup menu in milliseconds.
<p>Usually this is around half a second. A value of 0 draws the down
arrow button to the side of the button which can be used to open
up the popup menu.
<p> <p>See also <a href="#setPopup">setPopup</a>().
<p>Set this property's value with <a href="#setPopupDelay">setPopupDelay</a>() and get this property's value with <a href="#popupDelay">popupDelay</a>().
<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="textLabel-prop"></a>textLabel</h3>
<p>This property holds the label of this button.
<p>Setting this property automatically sets the text as a tool tip
too. There is no default text.
<p>Set this property's value with <a href="#setTextLabel">setTextLabel</a>() and get this property's value with <a href="#textLabel">textLabel</a>().
<h3 class=fn><a href="ntqtoolbutton.html#TextPosition-enum">TextPosition</a> <a name="textPosition-prop"></a>textPosition</h3>
<p>This property holds the position of the text label of this button.
<p>
<p>Set this property's value with <a href="#setTextPosition">setTextPosition</a>() and get this property's value with <a href="#textPosition">textPosition</a>().
<h3 class=fn>bool <a name="toggleButton-prop"></a>toggleButton</h3>
<p>This property holds whether this tool button is a toggle button.
<p>Toggle buttons have an on/off state similar to <a href="ntqcheckbox.html">check boxes.</a> A tool button is not a toggle button by
default.
<p> <p>See also <a href="#on-prop">on</a> and <a href="#toggle">toggle</a>().
<p>Set this property's value with <a href="#setToggleButton">setToggleButton</a>().
<h3 class=fn>bool <a name="usesBigPixmap-prop"></a>usesBigPixmap</h3>
<p>This property holds whether this toolbutton uses big pixmaps.
<p>TQToolButton automatically connects this property to the relevant
signal in the <a href="ntqmainwindow.html">TQMainWindow</a> in which it resides. We strongly
recommend that you use <a href="ntqmainwindow.html#setUsesBigPixmaps">TQMainWindow::setUsesBigPixmaps</a>() instead.
<p> This property's default is TRUE.
<p> <b>Warning:</b> If you set some buttons (in a TQMainWindow) to have big
pixmaps and others to have small pixmaps, TQMainWindow may not get
the geometry right.
<p>Set this property's value with <a href="#setUsesBigPixmap">setUsesBigPixmap</a>() and get this property's value with <a href="#usesBigPixmap">usesBigPixmap</a>().
<h3 class=fn>bool <a name="usesTextLabel-prop"></a>usesTextLabel</h3>
<p>This property holds whether the toolbutton displays a text label below the button pixmap.
<p>The default is FALSE.
<p> TQToolButton automatically connects this slot to the relevant
signal in the <a href="ntqmainwindow.html">TQMainWindow</a> in which is resides.
<p>Set this property's value with <a href="#setUsesTextLabel">setUsesTextLabel</a>() and get this property's value with <a href="#usesTextLabel">usesTextLabel</a>().
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">TQt toolkit</a>.
Copyright © 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright © 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>TQt 3.3.8</div>
</table></div></address></body>
</html>
|
