QToolButton Class Reference

#include <qtoolbutton.h>

Inheritance diagram for QToolButton:

[legend]Collaboration diagram for QToolButton:

[legend]List of all members.

---

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

100% assistant-toolbar1.png Qt Assistant's toolbar with tool buttons 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, {fowler}{GUI Design Handbook: Push Button}

Definition at line 38 of file qtoolbutton.h.

Public Types
enum	ToolButtonPopupMode
Public Slots
void	showMenu ()
void	setToolButtonStyle (Qt::ToolButtonStyle style)
void	setDefaultAction (QAction *)
Signals
void	triggered (QAction *)
Public Member Functions
	QToolButton (QWidget *parent=0)
	~QToolButton ()
QSize	sizeHint () const
QSize	minimumSizeHint () const
Qt::ToolButtonStyle	toolButtonStyle () const
Qt::ArrowType	arrowType () const
void	setArrowType (Qt::ArrowType type)
void	setMenu (QMenu *menu)
QMenu *	menu () const
void	setPopupMode (ToolButtonPopupMode mode)
ToolButtonPopupMode	popupMode () const
QAction *	defaultAction () const
void	setAutoRaise (bool enable)
bool	autoRaise () const
Protected Member Functions
	QToolButton (QToolButtonPrivate &, QWidget *parent)
bool	event (QEvent *e)
void	mousePressEvent (QMouseEvent *)
void	mouseReleaseEvent (QMouseEvent *)
void	paintEvent (QPaintEvent *)
void	actionEvent (QActionEvent *)
void	enterEvent (QEvent *)
void	leaveEvent (QEvent *)
void	timerEvent (QTimerEvent *)
void	changeEvent (QEvent *)
bool	hitButton (const QPoint &pos) const
void	nextCheckState ()
Private Member Functions
	Q_PRIVATE_SLOT (d_func(), void _q_buttonPressed()) Q_PRIVATE_SLOT(d_func()

---

Member Enumeration 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.

DelayedPopup After pressing and holding the tool button down for a certain amount of time (the timeout is style dependant, see QStyle::SH_ToolButton_PopupDelay), the menu is displayed. 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

MenuButtonPopup In this mode the tool button displays a special arrow to indicate that a menu is present. The menu is displayed when the arrow part of the button is pressed.

InstantPopup The menu is displayed, without delay, when the tool button is pressed. In this mode, the button's own action is not triggered.

Definition at line 50 of file qtoolbutton.h.

                             {
        DelayedPopup,
        MenuButtonPopup,
        InstantPopup
    };

---

Constructor & Destructor Documentation

QToolButton::QToolButton

(

QWidget *

parent = 0

)

[explicit]

Constructs an empty tool button with parent parent.

Definition at line 158 of file qtoolbutton.cpp.

References d.

    : QAbstractButton(*new QToolButtonPrivate, parent)
{
    Q_D(QToolButton);
    d->init();
}

QToolButton::~QToolButton

(

)

Destroys the object and frees any allocated resources.

Definition at line 345 of file qtoolbutton.cpp.

{
}

QToolButton::QToolButton	(	QToolButtonPrivate &	,
		QWidget *	parent
	)			[protected]

Definition at line 1016 of file qtoolbutton.cpp.

References d.

    :QAbstractButton(dd, parent)
{
    Q_D(QToolButton);
    d->init();
}

---

Member Function Documentation

QSize QToolButton::sizeHint

(

)

const [virtual]

Reimplemented from QWidget.

Definition at line 352 of file qtoolbutton.cpp.

References QStyle::CT_ToolButton, d, QWidget::ensurePolished(), QWidget::fontMetrics(), QApplication::globalStrut(), h, QSize::height(), QAbstractButton::icon(), QStyleOptionToolButton::iconSize, MenuButtonPopup, QStyle::pixelMetric(), QStyle::PM_MenuButtonIndicator, QStyleOption::rect, QRect::setHeight(), QSize::setWidth(), QFontMetrics::size(), QStyle::sizeFromContents(), QWidget::style(), QAbstractButton::text(), Qt::TextShowMnemonic, Qt::ToolButtonIconOnly, QStyleOptionToolButton::toolButtonStyle, Qt::ToolButtonTextBesideIcon, Qt::ToolButtonTextOnly, Qt::ToolButtonTextUnderIcon, w, QSize::width(), and QFontMetrics::width().

Referenced by minimumSizeHint(), Button::sizeHint(), and SortingBox::updateButtonGeometry().

{
    Q_D(const QToolButton);
    ensurePolished();

    int w = 0, h = 0;
    QStyleOptionToolButton opt = d->getStyleOption();

    QFontMetrics fm = fontMetrics();
    if (opt.toolButtonStyle != Qt::ToolButtonTextOnly) {
        QSize icon = opt.iconSize;
        w = icon.width();
        h = icon.height();
    }

    if (opt.toolButtonStyle != Qt::ToolButtonIconOnly) {
        QSize textSize = fm.size(Qt::TextShowMnemonic, text());
        textSize.setWidth(textSize.width() + fm.width(QLatin1Char(' '))*2);
        if (opt.toolButtonStyle == Qt::ToolButtonTextUnderIcon) {
            h += 4 + textSize.height();
            if (textSize.width() > w)
                w = textSize.width();
        } else if (opt.toolButtonStyle == Qt::ToolButtonTextBesideIcon) {
            w += 4 + textSize.width();
            if (textSize.height() > h)
                h = textSize.height();
        } else { // TextOnly
            w = textSize.width();
            h = textSize.height();
        }
    }

    opt.rect.setHeight(h); // PM_MenuButtonIndicator depends on the height
    if (d->popupMode == MenuButtonPopup)
        w += style()->pixelMetric(QStyle::PM_MenuButtonIndicator, &opt, this);

    return style()->sizeFromContents(QStyle::CT_ToolButton, &opt, QSize(w, h), this).
            expandedTo(QApplication::globalStrut());
}

Here is the call graph for this function:

QSize QToolButton::minimumSizeHint

(

)

const [virtual]

Reimplemented from QWidget.

Definition at line 395 of file qtoolbutton.cpp.

References sizeHint().

{
    return sizeHint();
}

Here is the call graph for this function:

Qt::ToolButtonStyle QToolButton::toolButtonStyle

(

)

const

Definition at line 431 of file qtoolbutton.cpp.

References d.

{
    Q_D(const QToolButton);
    return d->toolButtonStyle;
}

Qt::ArrowType QToolButton::arrowType

(

)

const

Definition at line 437 of file qtoolbutton.cpp.

References d.

{
    Q_D(const QToolButton);
    return d->arrowType;
}

void QToolButton::setArrowType

(

Qt::ArrowType

type

)

Definition at line 457 of file qtoolbutton.cpp.

References d, QWidget::isVisible(), QWidget::update(), and QWidget::updateGeometry().

Referenced by QTabBarPrivate::layoutTabs(), QDesignerQ3WidgetStack::QDesignerQ3WidgetStack(), and QDesignerStackedWidget::QDesignerStackedWidget().

{
    Q_D(QToolButton);
    if (d->arrowType == type)
        return;

    d->arrowType = type;
    updateGeometry();
    if (isVisible()) {
        update();
    }
}

Here is the call graph for this function:

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

Definition at line 704 of file qtoolbutton.cpp.

References QWidget::addAction(), d, menu(), QMenu::menuAction(), QWidget::removeAction(), and QWidget::update().

Referenced by QCalendarWidgetPrivate::createHeader(), and QMenuBarPrivate::updateGeometries().

{
    Q_D(QToolButton);

    if (d->menuAction)
        removeAction(d->menuAction);

    if (menu) {
        d->menuAction = menu->menuAction();
        addAction(d->menuAction);
    } else {
        d->menuAction = 0;
    }
    update();
}

Here is the call graph for this function:

QMenu * QToolButton::menu

(

)

const

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

See also:

setMenu()

Definition at line 725 of file qtoolbutton.cpp.

References d.

Referenced by QAccessibleToolButton::actionCount(), QAccessibleToolButton::isSplitButton(), QCalToolButton::paintEvent(), setMenu(), and QMenuBarPrivate::updateGeometries().

{
    Q_D(const QToolButton);
    if (d->menuAction)
        return d->menuAction->menu();
    return 0;
}

void QToolButton::setPopupMode

(

ToolButtonPopupMode

mode

)

Definition at line 903 of file qtoolbutton.cpp.

References d.

Referenced by QCalendarWidgetPrivate::createHeader(), Q3ToolBar::createPopup(), QMenuBarExtension::QMenuBarExtension(), QToolBarExtension::QToolBarExtension(), and setDefaultAction().

{
    Q_D(QToolButton);
    d->popupMode = mode;
}

QToolButton::ToolButtonPopupMode QToolButton::popupMode

(

)

const

Definition at line 909 of file qtoolbutton.cpp.

References d.

Referenced by QAccessibleToolButton::isSplitButton().

{
    Q_D(const QToolButton);
    return d->popupMode;
}

QAction * QToolButton::defaultAction

(

)

const

Returns the default action.

See also:

setDefaultAction()

Definition at line 988 of file qtoolbutton.cpp.

References d.

{
    Q_D(const QToolButton);
    return d->defaultAction;
}

void QToolButton::setAutoRaise

(

bool

enable

)

Definition at line 924 of file qtoolbutton.cpp.

References d, and QWidget::update().

Referenced by QCalendarWidgetPrivate::createHeader(), QToolBarPrivate::createItem(), Q3FileDialog::init(), TabbedBrowser::init(), Q3ToolBarExtensionWidget::Q3ToolBarExtensionWidget(), QDesignerQ3WidgetStack::QDesignerQ3WidgetStack(), QDesignerStackedWidget::QDesignerStackedWidget(), QMenuBarExtension::QMenuBarExtension(), QToolBarExtension::QToolBarExtension(), and QFileDialogPrivate::setupToolButtons().

{
    Q_D(QToolButton);
    d->autoRaise = enable;

    update();
}

bool QToolButton::autoRaise

(

)

const

Definition at line 932 of file qtoolbutton.cpp.

References d.

{
    Q_D(const QToolButton);
    return d->autoRaise;
}

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.

Definition at line 738 of file qtoolbutton.cpp.

References d, and QWidget::repaint().

Referenced by QAccessibleToolButton::doAction(), and mousePressEvent().

{
    Q_D(QToolButton);
    if (!d->hasMenu()) {
        d->menuButtonDown = false;
        return; // no menu to show
    }

    d->menuButtonDown = true;
    repaint();
    d->popupTimer.stop();
    d->popupTimerDone();
}

void QToolButton::setToolButtonStyle

(

Qt::ToolButtonStyle

style

)

[slot]

Definition at line 444 of file qtoolbutton.cpp.

References d, QWidget::isVisible(), QWidget::update(), and QWidget::updateGeometry().

Referenced by QToolBarPrivate::createItem(), EditorWithReset::EditorWithReset(), qdesigner_internal::RoleEditor::RoleEditor(), and qdesigner_internal::Sentinel::Sentinel().

{
    Q_D(QToolButton);
    if (d->toolButtonStyle == style)
        return;

    d->toolButtonStyle = style;
    updateGeometry();
    if (isVisible()) {
        update();
    }
}

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.

Definition at line 944 of file qtoolbutton.cpp.

References QWidget::actions(), QWidget::addAction(), d, MenuButtonPopup, QAbstractButton::setCheckable(), QAbstractButton::setChecked(), QWidget::setEnabled(), QWidget::setFont(), QAbstractButton::setIcon(), setPopupMode(), QWidget::setStatusTip(), QAbstractButton::setText(), QWidget::setToolTip(), and QWidget::setWhatsThis().

Referenced by Q3ToolBar::actionEvent(), actionEvent(), and QToolBarPrivate::createItem().

{
    Q_D(QToolButton);
#ifndef QT_NO_MENU
    bool hadMenu = false;
    hadMenu = d->hasMenu();
#endif
    d->defaultAction = action;
    if (!action)
        return;
    if (!actions().contains(action))
        addAction(action);
    setText(action->iconText());
    setIcon(action->icon());
#ifndef QT_NO_TOOLTIP
    setToolTip(action->toolTip());
#endif
#ifndef QT_NO_STATUSTIP
    setStatusTip(action->statusTip());
#endif
#ifndef QT_NO_WHATSTHIS
    setWhatsThis(action->whatsThis());
#endif
#ifndef QT_NO_MENU
    if (action->menu() && !hadMenu) {
        // new 'default' popup mode defined introduced by tool bar. We
        // should have changed QToolButton's default instead. Do that
        // in 4.2.
        setPopupMode(QToolButton::MenuButtonPopup);
    }
#endif
    setCheckable(action->isCheckable());
    setChecked(action->isChecked());
    setEnabled(action->isEnabled());
    if (action->d_func()->fontSet)
        setFont(action->font());
}

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.

Referenced by actionEvent().

bool QToolButton::event

(

QEvent *

e

)

[protected, virtual]

Reimplemented from QAbstractButton.

Definition at line 1009 of file qtoolbutton.cpp.

References QAbstractButton::event().

Referenced by actionEvent().

{
    return QAbstractButton::event(e);
}

Here is the call graph for this function:

void QToolButton::mousePressEvent

(

QMouseEvent *

e

)

[protected, virtual]

Reimplemented from QAbstractButton.

Definition at line 579 of file qtoolbutton.cpp.

References QMouseEvent::button(), QStyle::CC_ToolButton, d, Qt::LeftButton, MenuButtonPopup, QToolButtonPrivate::MenuButtonPressed, QAbstractButton::mousePressEvent(), QMouseEvent::pos(), QStyle::SC_ToolButtonMenu, showMenu(), QWidget::style(), QStyle::subControlRect(), and QToolButtonPrivate::ToolButtonPressed.

Referenced by QCalToolButton::mousePressEvent().

{
    Q_D(QToolButton);
#ifndef QT_NO_MENU
    QStyleOptionToolButton opt = d->getStyleOption();
    if (e->button() == Qt::LeftButton && d->popupMode == MenuButtonPopup) {
        QRect popupr = style()->subControlRect(QStyle::CC_ToolButton, &opt,
                                               QStyle::SC_ToolButtonMenu, this);
        if (popupr.isValid() && popupr.contains(e->pos())) {
            d->buttonPressed = QToolButtonPrivate::MenuButtonPressed;
            showMenu();
            return;
        }
    }
#endif
    d->buttonPressed = QToolButtonPrivate::ToolButtonPressed;
    QAbstractButton::mousePressEvent(e);
}

Here is the call graph for this function:

void QToolButton::mouseReleaseEvent

(

QMouseEvent *

e

)

[protected, virtual]

Reimplemented from QAbstractButton.

Definition at line 601 of file qtoolbutton.cpp.

References d, QAbstractButton::mouseReleaseEvent(), and QToolButtonPrivate::NoButtonPressed.

Referenced by QCalToolButton::mouseReleaseEvent().

{
    Q_D(QToolButton);
    QAbstractButton::mouseReleaseEvent(e);
    d->buttonPressed = QToolButtonPrivate::NoButtonPressed;
}

Here is the call graph for this function:

void QToolButton::paintEvent

(

QPaintEvent *

event

)

[protected, virtual]

Paints the button in response to the paint event.

Implements QAbstractButton.

Definition at line 475 of file qtoolbutton.cpp.

References QStyle::CC_ToolButton, d, and p.

Referenced by qdesigner_internal::QtBrushButton::paintEvent(), qdesigner_internal::QtColorButton::paintEvent(), and QCalToolButton::paintEvent().

{
    Q_D(QToolButton);
    QStylePainter p(this);
    p.drawComplexControl(QStyle::CC_ToolButton, d->getStyleOption());
}

void QToolButton::actionEvent

(

QActionEvent *

event

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 485 of file qtoolbutton.cpp.

References QEvent::ActionAdded, QEvent::ActionChanged, QWidget::actionEvent(), QEvent::ActionRemoved, QObject::connect(), d, QObject::disconnect(), event(), setDefaultAction(), SIGNAL, SLOT, and triggered().

{
    Q_D(QToolButton);
    QAction *action = event->action();
    switch (event->type()) {
    case QEvent::ActionChanged:
        if (action == d->defaultAction)
            setDefaultAction(action); // update button state
        break;
    case QEvent::ActionAdded:
        connect(action, SIGNAL(triggered()), this, SLOT(_q_actionTriggered()));
        break;
    case QEvent::ActionRemoved:
        if (d->defaultAction == action)
            d->defaultAction = 0;
#ifndef QT_NO_MENU
        if (action == d->menuAction)
            d->menuAction = 0;
#endif
        action->disconnect(this);
        break;
    default:
        ;
    }
    QAbstractButton::actionEvent(event);
}

Here is the call graph for this function:

void QToolButton::enterEvent

(

QEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 522 of file qtoolbutton.cpp.

References d, QWidget::enterEvent(), and QWidget::update().

Referenced by QCalToolButton::enterEvent().

{
    Q_D(QToolButton);
    if (d->autoRaise)
        update();

    QAbstractButton::enterEvent(e);
}

Here is the call graph for this function:

void QToolButton::leaveEvent

(

QEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 535 of file qtoolbutton.cpp.

References d, QWidget::leaveEvent(), and QWidget::update().

Referenced by QCalToolButton::leaveEvent().

{
    Q_D(QToolButton);
    if (d->autoRaise)
        update();

    QAbstractButton::leaveEvent(e);
}

Here is the call graph for this function:

void QToolButton::timerEvent

(

QTimerEvent *

e

)

[protected, virtual]

Reimplemented from QAbstractButton.

Definition at line 548 of file qtoolbutton.cpp.

References d, QAbstractButton::timerEvent(), and QTimerEvent::timerId().

{
#ifndef QT_NO_MENU
    Q_D(QToolButton);
    if (e->timerId() == d->popupTimer.timerId()) {
        d->popupTimerDone();
        return;
    }
#endif
    QAbstractButton::timerEvent(e);
}

Here is the call graph for this function:

void QToolButton::changeEvent

(

QEvent *

e

)

[protected, virtual]

Reimplemented from QAbstractButton.

Definition at line 564 of file qtoolbutton.cpp.

References QAbstractButton::changeEvent(), d, QEvent::ParentChange, QWidget::parentWidget(), and QEvent::type().

{
#ifndef QT_NO_TOOLBAR
    Q_D(QToolButton);
    if (e->type() == QEvent::ParentChange) {
        if (qobject_cast<QToolBar*>(parentWidget()))
            d->autoRaise = true;
    }
#endif
    QAbstractButton::changeEvent(e);
}

Here is the call graph for this function:

bool QToolButton::hitButton

(

const QPoint &

pos

)

const [protected, virtual]

Reimplemented from QAbstractButton.

Definition at line 611 of file qtoolbutton.cpp.

References d, QAbstractButton::hitButton(), QToolButtonPrivate::MenuButtonPressed, and QWidget::pos().

{
    Q_D(const QToolButton);
    if(QAbstractButton::hitButton(pos))
        return (d->buttonPressed != QToolButtonPrivate::MenuButtonPressed);
    return false;
}

Here is the call graph for this function:

void QToolButton::nextCheckState

(

)

[protected, virtual]

Reimplemented from QAbstractButton.

Definition at line 999 of file qtoolbutton.cpp.

References d, and QAbstractButton::nextCheckState().

{
    Q_D(QToolButton);
    if (!d->defaultAction)
        QAbstractButton::nextCheckState();
    else
        d->defaultAction->trigger();
}

Here is the call graph for this function:

QToolButton::Q_PRIVATE_SLOT	(	d_func()	,
		void	_q_buttonPressed()
	)			[private]

Reimplemented from QWidget.

---

The documentation for this class was generated from the following files:

• src/gui/widgets/qtoolbutton.h
• src/gui/widgets/qtoolbutton.cpp

---