QToolBar

Synopsis

Functions

• def actionAt (p)
• def actionAt (x, y)
• def actionGeometry (action)
• def addAction (icon, text)
• def addAction (icon, text, receiver)
• def addAction (text)
• def addAction (text, receiver)
• def addSeparator ()
• def addWidget (widget)
• def allowedAreas ()
• def clear ()
• def iconSize ()
• def initStyleOption (option)
• def insertSeparator (before)
• def insertWidget (before, widget)
• def isAreaAllowed (area)
• def isFloatable ()
• def isFloating ()
• def isMovable ()
• def orientation ()
• def setAllowedAreas (areas)
• def setFloatable (floatable)
• def setMovable (movable)
• def setOrientation (orientation)
• def toggleViewAction ()
• def toolButtonStyle ()
• def widgetForAction (action)

Slots

• def setIconSize (iconSize)
• def setToolButtonStyle (toolButtonStyle)

Signals

• def actionTriggered (action)
• def allowedAreasChanged (allowedAreas)
• def iconSizeChanged (iconSize)
• def movableChanged (movable)
• def orientationChanged (orientation)
• def toolButtonStyleChanged (toolButtonStyle)
• def topLevelChanged (topLevel)
• def visibilityChanged (visible)

Detailed Description

The PySide.QtGui.QToolBar class provides a movable panel that contains a set of controls.

Toolbar buttons are added by adding actions , using PySide.QtGui.QToolBar.addAction() or PySide.QtGui.QWidget.insertAction() . Groups of buttons can be separated using PySide.QtGui.QToolBar.addSeparator() or PySide.QtGui.QToolBar.insertSeparator() . If a toolbar button is not appropriate, a widget can be inserted instead using PySide.QtGui.QToolBar.addWidget() or PySide.QtGui.QToolBar.insertWidget() ; examples of suitable widgets are PySide.QtGui.QSpinBox , PySide.QtGui.QDoubleSpinBox , and PySide.QtGui.QComboBox . When a toolbar button is pressed it emits the PySide.QtGui.QToolBar.actionTriggered() signal.

A toolbar can be fixed in place in a particular area (e.g. at the top of the window), or it can be movable ( PySide.QtGui.QToolBar.isMovable() ) between toolbar areas; see PySide.QtGui.QToolBar.allowedAreas() and PySide.QtGui.QToolBar.isAreaAllowed() .

When a toolbar is resized in such a way that it is too small to show all the items it contains, an extension button will appear as the last item in the toolbar. Pressing the extension button will pop up a menu containing the items that does not currently fit in the toolbar.

When a PySide.QtGui.QToolBar is not a child of a PySide.QtGui.QMainWindow , it looses the ability to populate the extension pop up with widgets added to the toolbar using PySide.QtGui.QToolBar.addWidget() . Please use widget actions created by inheriting PySide.QtGui.QWidgetAction and implementing QWidgetAction.createWidget() instead.

See also

PySide.QtGui.QToolButton PySide.QtGui.QMenu PySide.QtGui.QAction Application Example

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

class PySide.QtGui.QToolBar(title[, parent=None])

Parameters:

• title – unicode
• parent – PySide.QtGui.QWidget

Constructs a PySide.QtGui.QToolBar with the given parent .

Constructs a PySide.QtGui.QToolBar with the given parent .

The given window title identifies the toolbar and is shown in the context menu provided by PySide.QtGui.QMainWindow .

See also

PySide.QtGui.QWidget.setWindowTitle()

PySide.QtGui.QToolBar.actionAt(p)

Parameters:p – PySide.QtCore.QPoint Return type:PySide.QtGui.QAction

Returns the action at point p . This function returns zero if no action was found.

See also

QWidget.childAt()

PySide.QtGui.QToolBar.actionAt(x, y)

Parameters:

• x – PySide.QtCore.int
• y – PySide.QtCore.int

Return type:

PySide.QtGui.QAction

This is an overloaded function.

Returns the action at the point x , y . This function returns zero if no action was found.

PySide.QtGui.QToolBar.actionGeometry(action)

Parameters:action – PySide.QtGui.QAction Return type:PySide.QtCore.QRect

Returns the geometry of the toolbar item associated with the given action , or an invalid PySide.QtCore.QRect if no matching item is found.

PySide.QtGui.QToolBar.actionTriggered(action)

Parameters:action – PySide.QtGui.QAction

PySide.QtGui.QToolBar.addAction(text, receiver)

Parameters:

• text – unicode
• receiver – PySide.QtCore.QObject

Return type:

PySide.QtGui.QAction

This is an overloaded function.

Creates a new action with the given text . This action is added to the end of the toolbar. The action’s PySide.QtGui.QAction.triggered() signal is connected to member in receiver .

PySide.QtGui.QToolBar.addAction(text)

Parameters:text – unicode Return type:PySide.QtGui.QAction

This is an overloaded function.

Creates a new action with the given text . This action is added to the end of the toolbar.

PySide.QtGui.QToolBar.addAction(icon, text, receiver)

Parameters:

• icon – PySide.QtGui.QIcon
• text – unicode
• receiver – PySide.QtCore.QObject

Return type:

PySide.QtGui.QAction

This is an overloaded function.

Creates a new action with the icon icon and text text . This action is added to the end of the toolbar. The action’s PySide.QtGui.QAction.triggered() signal is connected to member in receiver .

PySide.QtGui.QToolBar.addAction(icon, text)

Parameters:

• icon – PySide.QtGui.QIcon
• text – unicode

Return type:

PySide.QtGui.QAction

This is an overloaded function.

Creates a new action with the given icon and text . This action is added to the end of the toolbar.

PySide.QtGui.QToolBar.addSeparator()

Return type:PySide.QtGui.QAction

Adds a separator to the end of the toolbar.

See also

PySide.QtGui.QToolBar.insertSeparator()

PySide.QtGui.QToolBar.addWidget(widget)

Parameters:widget – PySide.QtGui.QWidget Return type:PySide.QtGui.QAction

Adds the given widget to the toolbar as the toolbar’s last item.

The toolbar takes ownership of widget .

If you add a PySide.QtGui.QToolButton with this method, the tools bar’s Qt.ToolButtonStyle will not be respected.

Note

You should use QAction.setVisible() to change the visibility of the widget. Using QWidget.setVisible() , QWidget.show() and QWidget.hide() does not work.

See also

PySide.QtGui.QToolBar.insertWidget()

PySide.QtGui.QToolBar.allowedAreas()

Return type:PySide.QtCore.Qt.ToolBarAreas

See also

PySide.QtGui.QToolBar.setAllowedAreas()

PySide.QtGui.QToolBar.allowedAreasChanged(allowedAreas)

Parameters:allowedAreas – PySide.QtCore.Qt.ToolBarAreas

PySide.QtGui.QToolBar.clear()

Removes all actions from the toolbar.

See also

PySide.QtGui.QWidget.removeAction()

PySide.QtGui.QToolBar.iconSize()

Return type:PySide.QtCore.QSize

See also

PySide.QtGui.QToolBar.setIconSize()

PySide.QtGui.QToolBar.iconSizeChanged(iconSize)

Parameters:iconSize – PySide.QtCore.QSize

PySide.QtGui.QToolBar.initStyleOption(option)

Parameters:option – PySide.QtGui.QStyleOptionToolBar

PySide.QtGui.QToolBar.insertSeparator(before)

Parameters:before – PySide.QtGui.QAction Return type:PySide.QtGui.QAction

Inserts a separator into the toolbar in front of the toolbar item associated with the before action.

See also

PySide.QtGui.QToolBar.addSeparator()

PySide.QtGui.QToolBar.insertWidget(before, widget)

Parameters:

• before – PySide.QtGui.QAction
• widget – PySide.QtGui.QWidget

Return type:

PySide.QtGui.QAction

Inserts the given widget in front of the toolbar item associated with the before action.

Note: You should use QAction.setVisible() to change the visibility of the widget. Using QWidget.setVisible() , QWidget.show() and QWidget.hide() does not work.

See also

PySide.QtGui.QToolBar.addWidget()

PySide.QtGui.QToolBar.isAreaAllowed(area)

Parameters:area – PySide.QtCore.Qt.ToolBarArea Return type:PySide.QtCore.bool

PySide.QtGui.QToolBar.isFloatable()

Return type:PySide.QtCore.bool

PySide.QtGui.QToolBar.isFloating()

Return type:PySide.QtCore.bool

PySide.QtGui.QToolBar.isMovable()

Return type:PySide.QtCore.bool

This property holds whether the user can move the toolbar within the toolbar area, or between toolbar areas.

By default, this property is true.

This property only makes sense if the toolbar is in a PySide.QtGui.QMainWindow .

See also

PySide.QtGui.QToolBar.allowedAreas()

PySide.QtGui.QToolBar.movableChanged(movable)

Parameters:movable – PySide.QtCore.bool

PySide.QtGui.QToolBar.orientation()

Return type:PySide.QtCore.Qt.Orientation

See also

PySide.QtGui.QToolBar.setOrientation()

PySide.QtGui.QToolBar.orientationChanged(orientation)

Parameters:orientation – PySide.QtCore.Qt.Orientation

PySide.QtGui.QToolBar.setAllowedAreas(areas)

Parameters:areas – PySide.QtCore.Qt.ToolBarAreas

PySide.QtGui.QToolBar.setFloatable(floatable)

Parameters:floatable – PySide.QtCore.bool

See also

PySide.QtGui.QToolBar.isFloatable()

PySide.QtGui.QToolBar.setIconSize(iconSize)

Parameters:iconSize – PySide.QtCore.QSize

See also

PySide.QtGui.QToolBar.iconSize()

PySide.QtGui.QToolBar.setMovable(movable)

Parameters:movable – PySide.QtCore.bool

See also

PySide.QtGui.QToolBar.isMovable()

PySide.QtGui.QToolBar.setOrientation(orientation)

Parameters:orientation – PySide.QtCore.Qt.Orientation

PySide.QtGui.QToolBar.setToolButtonStyle(toolButtonStyle)

Parameters:toolButtonStyle – PySide.QtCore.Qt.ToolButtonStyle

PySide.QtGui.QToolBar.toggleViewAction()

Return type:PySide.QtGui.QAction

Returns a checkable action that can be used to show or hide this toolbar.

The action’s text is set to the toolbar’s window title.

See also

QAction.text QWidget.windowTitle

PySide.QtGui.QToolBar.toolButtonStyle()

Return type:PySide.QtCore.Qt.ToolButtonStyle

See also

PySide.QtGui.QToolBar.setToolButtonStyle()

PySide.QtGui.QToolBar.toolButtonStyleChanged(toolButtonStyle)

Parameters:toolButtonStyle – PySide.QtCore.Qt.ToolButtonStyle

PySide.QtGui.QToolBar.topLevelChanged(topLevel)

Parameters:topLevel – PySide.QtCore.bool

PySide.QtGui.QToolBar.visibilityChanged(visible)

Parameters:visible – PySide.QtCore.bool

PySide.QtGui.QToolBar.widgetForAction(action)

Parameters:action – PySide.QtGui.QAction Return type:PySide.QtGui.QWidget

Returns the widget associated with the specified action .

See also

PySide.QtGui.QToolBar.addWidget()