QToolButton Class Reference
^{[QtGui module]}

Detailed Description

The QToolButton class provides a quick-access button to commands or options, usually used inside a QToolBar.

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.

Tool buttons are normally created when new QAction instances are created with QToolBar::addAction() or existing actions are added to a toolbar with QToolBar::addAction(). It is also possible to construct tool buttons in the same way as any other widget, and arrange them alongside other widgets in layouts.

One classic use of a tool button is to select tools; for example, the "pen" tool in a drawing program. This would be implemented by using a QToolButton as a toggle button (see setToggleButton()).

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 setAutoRaise().

A tool button's icon is set as QIcon. 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.

The button's look and dimension is adjustable with setToolButtonStyle() and setIconSize(). When used inside a QToolBar in a QMainWindow, the button automatically adjusts to QMainWindow's settings (see QMainWindow::setToolButtonStyle() and QMainWindow::setIconSize()). Instead of an icon, a tool button can also display an arrow symbol, specified with arrowType.

A tool button can offer additional choices in a popup menu. The popup menu can be set using setMenu(). Use setPopupMode() to configure the different modes available for tool buttons with a menu set. The default mode is DelayedPopupMode which 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. The default delay is 600 ms; you can adjust it with setPopupDelay().

Qt Assistant's toolbar contains tool buttons that are associated with actions used in other parts of the main window.

See also QPushButton, QToolBar, QMainWindow, QAction, and GUI Design Handbook: Push Button.

Member Type Documentation

enum QToolButton::ToolButtonPopupMode

Describes how a menu should be popped up for tool buttons that has a menu set or contains a list of actions.

Property Documentation

arrowType : Qt::ArrowType

This property holds whether the button displays an arrow instead of a normal icon.

This displays an arrow as the icon for the QToolButton.

Access functions:

• Qt::ArrowType arrowType () const
• void setArrowType ( Qt::ArrowType type )

autoRaise : bool

This property holds whether auto-raising is enabled or not.

The default is disabled (i.e. false).

This property is currently ignored on Mac OS X when using QMacStyle.

Access functions:

• bool autoRaise () const
• void setAutoRaise ( bool enable )

popupMode : ToolButtonPopupMode

This property holds describes the way that popup menus are used with tool buttons.

Access functions:

• ToolButtonPopupMode popupMode () const
• void setPopupMode ( ToolButtonPopupMode mode )

toolButtonStyle : Qt::ToolButtonStyle

This property holds whether the tool button displays an icon only, text only, or text beside/below the icon.

The default is Qt::ToolButtonIconOnly.

QToolButton automatically connects this slot to the relevant signal in the QMainWindow in which is resides.

Access functions:

• Qt::ToolButtonStyle toolButtonStyle () const
• void setToolButtonStyle ( Qt::ToolButtonStyle style )

Member Function Documentation

QToolButton::QToolButton ( QWidget * parent = 0 )

Constructs an empty tool button with parent parent.

QToolButton::~QToolButton ()

Destroys the object and frees any allocated resources.

QAction * QToolButton::defaultAction () const

Returns the default action.

See also setDefaultAction().

QMenu * QToolButton::menu () const

Returns the associated menu, or 0 if no menu has been defined.

See also setMenu().

void QToolButton::paintEvent ( QPaintEvent * event )   [virtual protected]

Paints the button in response to the paint event.

Reimplemented from QWidget.

void QToolButton::setDefaultAction ( QAction * action )   [slot]

Sets the default action to action.

If a tool button has a default action, the action defines the button's properties like text, icon, tool tip, etc.

See also defaultAction().

void QToolButton::setMenu ( QMenu * menu )

Associates the given menu with this tool button.

The menu will be shown according to the button's popupMode.

Ownership of the menu is not transferred to the tool button.

See also menu().

void QToolButton::showMenu ()   [slot]

Shows (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.

void QToolButton::triggered ( QAction * action )   [signal]

This signal is emitted when the given action is triggered.

The action may also be associated with other parts of the user interface, such as menu items and keyboard shortcuts. Sharing actions in this way helps make the user interface more consistent and is often less work to implement.

Member Type Documentation

enum QToolButton::TextPosition

This enum describes the position of the tool button's text label in relation to the tool button's icon.

Member Function Documentation

QToolButton::QToolButton ( QWidget * parent, const char * name )

Constructs an empty tool button called name, with parent parent.

QToolButton::QToolButton ( Qt::ArrowType type, QWidget * parent, const char * name )

Constructs a tool button as an arrow button. The Qt::ArrowType type defines the arrow direction. Possible values are Qt::LeftArrow, Qt::RightArrow, Qt::UpArrow, and Qt::DownArrow.

An arrow button has auto-repeat turned on by default.

The parent and name arguments are sent to the QWidget constructor.

QToolButton::QToolButton ( const QIcon & icon, const QString & textLabel, const QString & statusTip, QObject * receiver, const char * slot, QWidget * parent, const char * name = 0 )

Constructs a tool button called name, that is a child of parent.

The tool button will display the given icon, with its text label and tool tip set to textLabel and its status bar message set to statusTip. It will be connected to the slot in object receiver.

QIcon QToolButton::iconSet () const

Use icon() instead.

See also setIconSet().

QIcon QToolButton::iconSet ( bool on ) const

This is an overloaded member function, provided for convenience.

Since Qt 3.0, QIcon contains both the On and Off icons.

For ease of porting, this function ignores the on parameter and returns the icon property. If you relied on the on parameter, you probably want to update your code to use the QIcon On/Off mechanism.

QIcon QToolButton::offIconSet () const

Use icon() instead.

See also setOffIconSet().

QIcon QToolButton::onIconSet () const

Use icon() instead.

See also setOnIconSet().

void QToolButton::openPopup ()

Use showMenu() instead.

QMenu * QToolButton::popup () const

Use menu() instead.

See also setPopup().

int QToolButton::popupDelay () const

Use the style hint QStyle::SH_ToolButton_PopupDelay instead.

See also setPopupDelay().

void QToolButton::setIconSet ( const QIcon & icon )

Use setIcon() instead.

See also iconSet().

void QToolButton::setIconSet ( const QIcon & set, bool on )

This is an overloaded member function, provided for convenience.

Since Qt 3.0, QIcon contains both the On and Off icons.

For ease of porting, this function ignores the on parameter and sets the icon property. If you relied on the on parameter, you probably want to update your code to use the QIcon On/Off mechanism.

See also icon and QIcon::State.

void QToolButton::setOffIconSet ( const QIcon & set )

Use setIcon() instead.

See also offIconSet().

void QToolButton::setOnIconSet ( const QIcon & set )

Use setIcon() instead.

See also onIconSet().

void QToolButton::setPixmap ( const QPixmap & pixmap )

Use setIcon(QIcon(pixmap)) instead.

void QToolButton::setPopup ( QMenu * popup )

Use setMenu() instead.

See also popup().

void QToolButton::setPopupDelay ( int delay )

Use the style hint QStyle::SH_ToolButton_PopupDelay instead.

See also popupDelay().

void QToolButton::setTextLabel ( const QString & text, bool tooltip = true )

Use setText() and setToolTip() instead.

See also textLabel().

void QToolButton::setTextPosition ( QToolButton::TextPosition pos )   [slot]

Use setToolButtonStyle() instead.

See also textPosition().

void QToolButton::setUsesBigPixmap ( bool enable )   [slot]

Use setIconSize() instead.

See also usesBigPixmap().

void QToolButton::setUsesTextLabel ( bool enable )   [slot]

Use setToolButtonStyle() instead.

See also usesTextLabel().

QString QToolButton::textLabel () const

Use text() instead.

See also setTextLabel().

TextPosition QToolButton::textPosition () const

Use toolButtonStyle() instead.

See also setTextPosition().

bool QToolButton::usesBigPixmap () const

Use iconSize() instead.

See also setUsesBigPixmap().

bool QToolButton::usesTextLabel () const

Use toolButtonStyle() instead.

See also setUsesTextLabel().