Contents

• Public Types
• Properties
• Public Functions
• Reimplemented Public Functions
• Public Slots
• Signals
• Protected Functions
• Reimplemented Protected Functions
• Detailed Description

Detailed Description

TheQToolButton class provides a quick-access button to commands or options, usually used inside aQToolBar.

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 newQAction instances are created withQToolBar::addAction() or existing actions are added to a toolbar withQToolBar::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 aQToolButton as a toggle button (seesetToggleButton()).

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 aQToolBar. Change it withsetAutoRaise().

A tool button's icon is set asQIcon. 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 withsetToolButtonStyle() andsetIconSize(). When used inside aQToolBar in aQMainWindow, the button automatically adjusts toQMainWindow's settings (seeQMainWindow::setToolButtonStyle() andQMainWindow::setIconSize()). Instead of an icon, a tool button can also display an arrow symbol, specified witharrowType.

A tool button can offer additional choices in a popup menu. The popup menu can be set usingsetMenu(). UsesetPopupMode() 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 withsetPopupDelay().

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

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 theQToolButton.

By default, this property is set toQt::NoArrow.

Access functions:

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 usingQMacStyle.

Access functions:

popupMode :ToolButtonPopupMode

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

By default, this property is set toDelayedPopup.

Access functions:

toolButtonStyle :Qt::ToolButtonStyle

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

The default isQt::ToolButtonIconOnly.

To have the style of toolbuttons follow the system settings (as available in GNOME and KDE desktop environments), set this property toQt::ToolButtonFollowStyle.

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

Access functions:

Member Function Documentation

QToolButton::QToolButton(QWidget * parent = 0)

Constructs an empty tool button with parentparent.

QToolButton::~QToolButton()

Destroys the object and frees any allocated resources.

[virtual protected]void QToolButton::actionEvent(QActionEvent * event)

Reimplemented fromQWidget::actionEvent().

[virtual protected]void QToolButton::changeEvent(QEvent * e)

Reimplemented fromQWidget::changeEvent().

QAction * QToolButton::defaultAction() const

Returns the default action.

See alsosetDefaultAction().

[virtual protected]void QToolButton::enterEvent(QEvent * e)

Reimplemented fromQWidget::enterEvent().

[virtual protected]bool QToolButton::event(QEvent * event)

Reimplemented fromQObject::event().

[virtual protected]bool QToolButton::hitButton(constQPoint & pos) const

Reimplemented fromQAbstractButton::hitButton().

[protected]void QToolButton::initStyleOption(QStyleOptionToolButton * option) const

Initializeoption with the values from thisQToolButton. This method is useful for subclasses when they need aQStyleOptionToolButton, but don't want to fill in all the information themselves.

See alsoQStyleOption::initFrom().

[virtual protected]void QToolButton::leaveEvent(QEvent * e)

Reimplemented fromQWidget::leaveEvent().

QMenu * QToolButton::menu() const

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

See alsosetMenu().

[virtual]QSize QToolButton::minimumSizeHint() const

Reimplemented fromQWidget::minimumSizeHint().

[virtual protected]void QToolButton::mousePressEvent(QMouseEvent * e)

Reimplemented fromQWidget::mousePressEvent().

[virtual protected]void QToolButton::mouseReleaseEvent(QMouseEvent * e)

Reimplemented fromQWidget::mouseReleaseEvent().

[virtual protected]void QToolButton::nextCheckState()

Reimplemented fromQAbstractButton::nextCheckState().

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

Reimplemented fromQWidget::paintEvent().

Paints the button in response to the paintevent.

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

Sets the default action toaction.

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

See alsodefaultAction().

void QToolButton::setMenu(QMenu * menu)

Associates the givenmenu with this tool button.

The menu will be shown according to the button'spopupMode.

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

See alsomenu().

[slot]void QToolButton::showMenu()

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.

[virtual]QSize QToolButton::sizeHint() const

Reimplemented fromQWidget::sizeHint().

[virtual protected]void QToolButton::timerEvent(QTimerEvent * e)

Reimplemented fromQObject::timerEvent().

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

This signal is emitted when the givenaction 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.