You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qt3/doc/html/qtoolbutton.html

393 lines
28 KiB

<!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>QToolButton 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&nbsp;Classes</font></a>
| <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
| <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
| <a href="groups.html">
<font color="#004faf">Grouped&nbsp;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>QToolButton Class Reference</h1>
<p>The QToolButton class provides a quick-access button to
commands or options, usually used inside a QToolBar.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qtoolbutton-h.html">qtoolbutton.h</a>&gt;</tt>
<p>Inherits <a href="qbutton.html">QButton</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="#QToolButton"><b>QToolButton</b></a> ( QWidget&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
<li class=fn><a href="#QToolButton-2"><b>QToolButton</b></a> ( const&nbsp;QIconSet&nbsp;&amp;&nbsp;iconSet, const&nbsp;QString&nbsp;&amp;&nbsp;textLabel, const&nbsp;QString&nbsp;&amp;&nbsp;grouptext, QObject&nbsp;*&nbsp;receiver, const&nbsp;char&nbsp;*&nbsp;slot, QToolBar&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
<li class=fn><a href="#QToolButton-3"><b>QToolButton</b></a> ( ArrowType&nbsp;type, QWidget&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
<li class=fn><a href="#~QToolButton"><b>~QToolButton</b></a> ()</li>
<li class=fn>void setOnIconSet ( const QIconSet &amp; ) &nbsp;<em>(obsolete)</em></li>
<li class=fn>void setOffIconSet ( const QIconSet &amp; ) &nbsp;<em>(obsolete)</em></li>
<li class=fn>void setIconSet ( const&nbsp;QIconSet&nbsp;&amp;&nbsp;set, bool&nbsp;on ) &nbsp;<em>(obsolete)</em></li>
<li class=fn>QIconSet onIconSet () const &nbsp;<em>(obsolete)</em></li>
<li class=fn>QIconSet offIconSet () const &nbsp;<em>(obsolete)</em></li>
<li class=fn>QIconSet iconSet ( bool&nbsp;on ) const &nbsp;<em>(obsolete)</em></li>
<li class=fn>virtual void <a href="#setIconSet"><b>setIconSet</b></a> ( const QIconSet &amp; )</li>
<li class=fn>QIconSet <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>QString <a href="#textLabel"><b>textLabel</b></a> () const</li>
<li class=fn>void <a href="#setPopup"><b>setPopup</b></a> ( QPopupMenu&nbsp;*&nbsp;popup )</li>
<li class=fn>QPopupMenu * <a href="#popup"><b>popup</b></a> () const</li>
<li class=fn>void <a href="#setPopupDelay"><b>setPopupDelay</b></a> ( int&nbsp;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&nbsp;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&nbsp;enable )</li>
<li class=fn>virtual void <a href="#setUsesTextLabel"><b>setUsesTextLabel</b></a> ( bool&nbsp;enable )</li>
<li class=fn>virtual void <a href="#setTextLabel-2"><b>setTextLabel</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;newLabel, bool&nbsp;tipToo )</li>
<li class=fn>virtual void <a href="#setToggleButton"><b>setToggleButton</b></a> ( bool&nbsp;enable )</li>
<li class=fn>virtual void <a href="#setOn"><b>setOn</b></a> ( bool&nbsp;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 QString &amp; )</li>
<li class=fn>void <a href="#setTextPosition"><b>setTextPosition</b></a> ( TextPosition&nbsp;pos )</li>
</ul>
<h2>Properties</h2>
<ul>
<li class=fn>bool <a href="#autoRaise-prop"><b>autoRaise</b></a>&nbsp;- whether auto-raising is enabled</li>
<li class=fn>BackgroundMode <a href="#backgroundMode-prop"><b>backgroundMode</b></a>&nbsp;- the toolbutton's background mode &nbsp;<em>(read only)</em></li>
<li class=fn>QIconSet <a href="#iconSet-prop"><b>iconSet</b></a>&nbsp;- the icon set providing the icon shown on the button</li>
<li class=fn>QIconSet offIconSet&nbsp;- the icon set that is used when the button is in an "off" state &nbsp;<em>(obsolete)</em></li>
<li class=fn>bool <a href="#on-prop"><b>on</b></a>&nbsp;- whether this tool button is on</li>
<li class=fn>QIconSet onIconSet&nbsp;- the icon set that is used when the button is in an "on" state &nbsp;<em>(obsolete)</em></li>
<li class=fn>QPixmap <a href="#pixmap-prop"><b>pixmap</b></a>&nbsp;- the pixmap of the button &nbsp;<em>(read only)</em></li>
<li class=fn>int <a href="#popupDelay-prop"><b>popupDelay</b></a>&nbsp;- the time delay between pressing the button and the appearance of the associated popup menu in milliseconds</li>
<li class=fn>QString <a href="#textLabel-prop"><b>textLabel</b></a>&nbsp;- the label of this button</li>
<li class=fn>TextPosition <a href="#textPosition-prop"><b>textPosition</b></a>&nbsp;- the position of the text label of this button</li>
<li class=fn>bool <a href="#toggleButton-prop"><b>toggleButton</b></a>&nbsp;- whether this tool button is a toggle button</li>
<li class=fn>bool <a href="#usesBigPixmap-prop"><b>usesBigPixmap</b></a>&nbsp;- whether this toolbutton uses big pixmaps</li>
<li class=fn>bool <a href="#usesTextLabel-prop"><b>usesTextLabel</b></a>&nbsp;- 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 QToolButton class provides a quick-access button to
commands or options, usually used inside a <a href="qtoolbar.html">QToolBar</a>.
<p>
<p> A tool button is a special button that provides quick-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 QToolButton as toggle button (see <a href="#setToggleButton">setToggleButton</a>() ).
<p> QToolButton 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 QToolBar.
Change it with <a href="#setAutoRaise">setAutoRaise</a>().
<p> A tool button's icon is set as <a href="qiconset.html">QIconSet</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="qtoolbar.html">QToolBar</a> in a <a href="qmainwindow.html">QMainWindow</a>, the button automatically adjusts to
QMainWindow's settings (see <a href="qmainwindow.html#setUsesTextLabel">QMainWindow::setUsesTextLabel</a>() and
<a href="qmainwindow.html#setUsesBigPixmaps">QMainWindow::setUsesBigPixmaps</a>()). The pixmap set on a QToolButton
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
QToolButton 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 &#92;caption A floating"></center> QToolbar with QToolbuttons
<p> <p>See also <a href="qpushbutton.html">QPushButton</a>, <a href="qtoolbar.html">QToolBar</a>, <a href="qmainwindow.html">QMainWindow</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>QToolButton::TextPosition</h3>
<p> The position of the tool button's textLabel in relation to the
tool button's icon.
<ul>
<li><tt>QToolButton::BesideIcon</tt> - The text appears beside the icon.
<li><tt>QToolButton::BelowIcon</tt> - The text appears below the icon.
</ul>
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QToolButton"></a>QToolButton::QToolButton ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )
</h3>
Constructs an empty tool button called <em>name</em>, with parent <em>parent</em>.
<h3 class=fn><a name="QToolButton-2"></a>QToolButton::QToolButton ( const&nbsp;<a href="qiconset.html">QIconSet</a>&nbsp;&amp;&nbsp;iconSet, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;textLabel, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;grouptext, <a href="qobject.html">QObject</a>&nbsp;*&nbsp;receiver, const&nbsp;char&nbsp;*&nbsp;slot, <a href="qtoolbar.html">QToolBar</a>&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;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="qtoolbar.html">QToolBar</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="QToolButton-3"></a>QToolButton::QToolButton ( <a href="qt.html#ArrowType-enum">ArrowType</a>&nbsp;type, <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )
</h3>
Constructs a tool button as an arrow button. The <a href="qt.html#ArrowType-enum">ArrowType</a> <em>type</em> defines the arrow direction. Possible values are <a href="qt.html#ArrowType-enum">LeftArrow</a>, <a href="qt.html#ArrowType-enum">RightArrow</a>, <a href="qt.html#ArrowType-enum">UpArrow</a> and <a href="qt.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="qwidget.html">QWidget</a>
constructor.
<h3 class=fn><a name="~QToolButton"></a>QToolButton::~QToolButton ()
</h3>
Destroys the object and frees any allocated resources.
<h3 class=fn>bool <a name="autoRaise"></a>QToolButton::autoRaise () const
</h3><p>Returns TRUE if auto-raising is enabled; otherwise returns FALSE.
See the <a href="qtoolbutton.html#autoRaise-prop">"autoRaise"</a> property for details.
<h3 class=fn><a href="qiconset.html">QIconSet</a> <a name="iconSet"></a>QToolButton::iconSet () const
</h3><p>Returns the icon set providing the icon shown on the button.
See the <a href="qtoolbutton.html#iconSet-prop">"iconSet"</a> property for details.
<h3 class=fn><a href="qiconset.html">QIconSet</a> <a name="iconSet-2"></a>QToolButton::iconSet ( bool&nbsp;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 Qt 3.0, <a href="qiconset.html">QIconSet</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 QIconSet
On/Off mechanism.
<h3 class=fn><a href="qiconset.html">QIconSet</a> <a name="offIconSet"></a>QToolButton::offIconSet () const
</h3><p>Returns the icon set that is used when the button is in an "off" state.
See the <a href="qtoolbutton.html#offIconSet-prop">"offIconSet"</a> property for details.
<h3 class=fn><a href="qiconset.html">QIconSet</a> <a name="onIconSet"></a>QToolButton::onIconSet () const
</h3><p>Returns the icon set that is used when the button is in an "on" state.
See the <a href="qtoolbutton.html#onIconSet-prop">"onIconSet"</a> property for details.
<h3 class=fn>void <a name="openPopup"></a>QToolButton::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="qpopupmenu.html">QPopupMenu</a>&nbsp;* <a name="popup"></a>QToolButton::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>QToolButton::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="qtoolbutton.html#popupDelay-prop">"popupDelay"</a> property for details.
<h3 class=fn>void <a name="setAutoRaise"></a>QToolButton::setAutoRaise ( bool&nbsp;enable )
</h3><p>Sets whether auto-raising is enabled to <em>enable</em>.
See the <a href="qtoolbutton.html#autoRaise-prop">"autoRaise"</a> property for details.
<h3 class=fn>void <a name="setIconSet"></a>QToolButton::setIconSet ( const&nbsp;<a href="qiconset.html">QIconSet</a>&nbsp;&amp; )<tt> [virtual]</tt>
</h3><p>Sets the icon set providing the icon shown on the button.
See the <a href="qtoolbutton.html#iconSet-prop">"iconSet"</a> property for details.
<h3 class=fn>void <a name="setIconSet-2"></a>QToolButton::setIconSet ( const&nbsp;<a href="qiconset.html">QIconSet</a>&nbsp;&amp;&nbsp;set, bool&nbsp;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 Qt 3.0, <a href="qiconset.html">QIconSet</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 QIconSet On/Off
mechanism.
<p> <p>See also <a href="#iconSet-prop">iconSet</a> and <a href="qiconset.html#State-enum">QIconSet::State</a>.
<h3 class=fn>void <a name="setOffIconSet"></a>QToolButton::setOffIconSet ( const&nbsp;<a href="qiconset.html">QIconSet</a>&nbsp;&amp; )
</h3><p>Sets the icon set that is used when the button is in an "off" state.
See the <a href="qtoolbutton.html#offIconSet-prop">"offIconSet"</a> property for details.
<h3 class=fn>void <a name="setOn"></a>QToolButton::setOn ( bool&nbsp;enable )<tt> [virtual slot]</tt>
</h3><p>Sets whether this tool button is on to <em>enable</em>.
See the <a href="qtoolbutton.html#on-prop">"on"</a> property for details.
<h3 class=fn>void <a name="setOnIconSet"></a>QToolButton::setOnIconSet ( const&nbsp;<a href="qiconset.html">QIconSet</a>&nbsp;&amp; )
</h3><p>Sets the icon set that is used when the button is in an "on" state.
See the <a href="qtoolbutton.html#onIconSet-prop">"onIconSet"</a> property for details.
<h3 class=fn>void <a name="setPopup"></a>QToolButton::setPopup ( <a href="qpopupmenu.html">QPopupMenu</a>&nbsp;*&nbsp;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>QToolButton::setPopupDelay ( int&nbsp;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="qtoolbutton.html#popupDelay-prop">"popupDelay"</a> property for details.
<h3 class=fn>void <a name="setTextLabel"></a>QToolButton::setTextLabel ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp; )<tt> [slot]</tt>
</h3><p>Sets the label of this button.
See the <a href="qtoolbutton.html#textLabel-prop">"textLabel"</a> property for details.
<h3 class=fn>void <a name="setTextLabel-2"></a>QToolButton::setTextLabel ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;newLabel, bool&nbsp;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>QToolButton::setTextPosition ( <a href="qtoolbutton.html#TextPosition-enum">TextPosition</a>&nbsp;pos )<tt> [slot]</tt>
</h3><p>Sets the position of the text label of this button to <em>pos</em>.
See the <a href="qtoolbutton.html#textPosition-prop">"textPosition"</a> property for details.
<h3 class=fn>void <a name="setToggleButton"></a>QToolButton::setToggleButton ( bool&nbsp;enable )<tt> [virtual slot]</tt>
</h3><p>Sets whether this tool button is a toggle button to <em>enable</em>.
See the <a href="qtoolbutton.html#toggleButton-prop">"toggleButton"</a> property for details.
<h3 class=fn>void <a name="setUsesBigPixmap"></a>QToolButton::setUsesBigPixmap ( bool&nbsp;enable )<tt> [virtual slot]</tt>
</h3><p>Sets whether this toolbutton uses big pixmaps to <em>enable</em>.
See the <a href="qtoolbutton.html#usesBigPixmap-prop">"usesBigPixmap"</a> property for details.
<h3 class=fn>void <a name="setUsesTextLabel"></a>QToolButton::setUsesTextLabel ( bool&nbsp;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="qtoolbutton.html#usesTextLabel-prop">"usesTextLabel"</a> property for details.
<h3 class=fn><a href="qstring.html">QString</a> <a name="textLabel"></a>QToolButton::textLabel () const
</h3><p>Returns the label of this button.
See the <a href="qtoolbutton.html#textLabel-prop">"textLabel"</a> property for details.
<h3 class=fn><a href="qtoolbutton.html#TextPosition-enum">TextPosition</a> <a name="textPosition"></a>QToolButton::textPosition () const
</h3><p>Returns the position of the text label of this button.
See the <a href="qtoolbutton.html#textPosition-prop">"textPosition"</a> property for details.
<h3 class=fn>void <a name="toggle"></a>QToolButton::toggle ()<tt> [slot]</tt>
</h3>
Toggles the state of this tool button.
<p> This function has no effect on <a href="qbutton.html#isToggleButton">non-toggling
buttons.</a>
<p> <p>See also <a href="#toggleButton-prop">toggleButton</a> and <a href="qbutton.html#toggled">toggled</a>().
<h3 class=fn>bool <a name="uses3D"></a>QToolButton::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="qbutton.html#drawButton">drawButton</a>().
<h3 class=fn>bool <a name="usesBigPixmap"></a>QToolButton::usesBigPixmap () const
</h3><p>Returns TRUE if this toolbutton uses big pixmaps; otherwise returns FALSE.
See the <a href="qtoolbutton.html#usesBigPixmap-prop">"usesBigPixmap"</a> property for details.
<h3 class=fn>bool <a name="usesTextLabel"></a>QToolButton::usesTextLabel () const
</h3><p>Returns TRUE if the toolbutton displays a text label below the button pixmap; otherwise returns FALSE.
See the <a href="qtoolbutton.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="qt.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="qwidget.html#backgroundMode">backgroundMode</a>().
<p> <p>See also <a href="qwidget.html#backgroundMode-prop">QWidget::backgroundMode</a>.
<p><h3 class=fn><a href="qiconset.html">QIconSet</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">QToolButton::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="qiconset.html">QIconSet</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 Qt 3.0, <a href="qiconset.html">QIconSet</a> contains both the On and Off icons. There is
now an <a href="#iconSet-prop">QToolButton::iconSet</a> property that replaces both <a href="#onIconSet-prop">QToolButton::onIconSet</a> and <a href="#offIconSet-prop">QToolButton::offIconSet</a>.
<p> For ease of porting, this property is a synonym for <a href="#iconSet-prop">QToolButton::iconSet</a>. You probably want to go over your application
code and use the QIconSet On/Off mechanism.
<p> <p>See also <a href="#iconSet-prop">iconSet</a> and <a href="qiconset.html#State-enum">QIconSet::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="qbutton.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="qiconset.html">QIconSet</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 Qt 3.0, <a href="qiconset.html">QIconSet</a> contains both the On and Off icons. There is
now an <a href="#iconSet-prop">QToolButton::iconSet</a> property that replaces both <a href="#onIconSet-prop">QToolButton::onIconSet</a> and <a href="#offIconSet-prop">QToolButton::offIconSet</a>.
<p> For ease of porting, this property is a synonym for <a href="#iconSet-prop">QToolButton::iconSet</a>. You probably want to go over your application
code and use the QIconSet On/Off mechanism.
<p> <p>See also <a href="#iconSet-prop">iconSet</a> and <a href="qiconset.html#State-enum">QIconSet::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="qpixmap.html">QPixmap</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="qstring.html">QString</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="qtoolbutton.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="qcheckbox.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>QToolButton automatically connects this property to the relevant
signal in the <a href="qmainwindow.html">QMainWindow</a> in which it resides. We strongly
recommend that you use <a href="qmainwindow.html#setUsesBigPixmaps">QMainWindow::setUsesBigPixmaps</a>() instead.
<p> This property's default is TRUE.
<p> <b>Warning:</b> If you set some buttons (in a QMainWindow) to have big
pixmaps and others to have small pixmaps, QMainWindow 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> QToolButton automatically connects this slot to the relevant
signal in the <a href="qmainwindow.html">QMainWindow</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">Qt toolkit</a>.
Copyright &copy; 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 &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>