QToolButton

Synopsis

Functions

• def arrowType ()
• def autoRaise ()
• def defaultAction ()
• def initStyleOption (option)
• def menu ()
• def popupMode ()
• def setArrowType (type)
• def setAutoRaise (enable)
• def setMenu (menu)
• def setPopupMode (mode)
• def toolButtonStyle ()

Slots

• def setDefaultAction (arg__1)
• def setToolButtonStyle (style)
• def showMenu ()

Signals

• def triggered (arg__1)

Detailed Description

The PySide.QtGui.QToolButton class provides a quick-access button to commands or options, usually used inside a PySide.QtGui.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 PySide.QtGui.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 PySide.QtGui.QToolButton as a toggle button (see setToggleButton() ).

PySide.QtGui.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 PySide.QtGui.QToolBar . Change it with PySide.QtGui.QToolButton.setAutoRaise() .

A tool button’s icon is set as PySide.QtGui.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 PySide.QtGui.QToolButton.setToolButtonStyle() and PySide.QtGui.QAbstractButton.setIconSize() . When used inside a PySide.QtGui.QToolBar in a PySide.QtGui.QMainWindow , the button automatically adjusts to PySide.QtGui.QMainWindow ‘s settings (see QMainWindow.setToolButtonStyle() and QMainWindow.setIconSize() ). Instead of an icon, a tool button can also display an arrow symbol, specified with PySide.QtGui.QToolButton.arrowType() .

A tool button can offer additional choices in a popup menu. The popup menu can be set using PySide.QtGui.QToolButton.setMenu() . Use PySide.QtGui.QToolButton.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

PySide.QtGui.QPushButton PySide.QtGui.QToolBar PySide.QtGui.QMainWindow PySide.QtGui.QAction GUI Design Handbook: Push Button

class PySide.QtGui.QToolButton([parent=None])

Parameters:parent – PySide.QtGui.QWidget

Constructs an empty tool button with parent parent .

PySide.QtGui.QToolButton.ToolButtonPopupMode

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

Constant	Description
QToolButton.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
QToolButton.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.
QToolButton.InstantPopup	The menu is displayed, without delay, when the tool button is pressed. In this mode, the button’s own action is not triggered.

PySide.QtGui.QToolButton.arrowType()

Return type:PySide.QtCore.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 PySide.QtGui.QToolButton .

By default, this property is set to Qt.NoArrow .

PySide.QtGui.QToolButton.autoRaise()

Return type:PySide.QtCore.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 .

PySide.QtGui.QToolButton.defaultAction()

Return type:PySide.QtGui.QAction

Returns the default action.

See also

PySide.QtGui.QToolButton.setDefaultAction()

PySide.QtGui.QToolButton.initStyleOption(option)

Parameters:option – PySide.QtGui.QStyleOptionToolButton

Initialize option with the values from this PySide.QtGui.QToolButton . This method is useful for subclasses when they need a PySide.QtGui.QStyleOptionToolButton , but don’t want to fill in all the information themselves.

See also

QStyleOption.initFrom()

PySide.QtGui.QToolButton.menu()

Return type:PySide.QtGui.QMenu

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

See also

PySide.QtGui.QToolButton.setMenu()

PySide.QtGui.QToolButton.popupMode()

Return type:PySide.QtGui.QToolButton.ToolButtonPopupMode

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

By default, this property is set to DelayedPopup .

PySide.QtGui.QToolButton.setArrowType(type)

Parameters:type – PySide.QtCore.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 PySide.QtGui.QToolButton .

By default, this property is set to Qt.NoArrow .

PySide.QtGui.QToolButton.setAutoRaise(enable)

Parameters:enable – PySide.QtCore.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 .

PySide.QtGui.QToolButton.setDefaultAction(arg__1)

Parameters:arg__1 – PySide.QtGui.QAction

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

PySide.QtGui.QToolButton.defaultAction()

PySide.QtGui.QToolButton.setMenu(menu)

Parameters:menu – PySide.QtGui.QMenu

Associates the given menu with this tool button.

The menu will be shown according to the button’s PySide.QtGui.QToolButton.popupMode() .

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

See also

PySide.QtGui.QToolButton.menu()

PySide.QtGui.QToolButton.setPopupMode(mode)

Parameters:mode – PySide.QtGui.QToolButton.ToolButtonPopupMode

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

By default, this property is set to DelayedPopup .

PySide.QtGui.QToolButton.setToolButtonStyle(style)

Parameters:style – PySide.QtCore.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 .

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

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

PySide.QtGui.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.

PySide.QtGui.QToolButton.toolButtonStyle()

Return type:PySide.QtCore.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 .

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

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

PySide.QtGui.QToolButton.triggered(arg__1)

Parameters:arg__1 – PySide.QtGui.QAction