QActionGroup

Synopsis

Functions

• def actions ()
• def addAction (a)
• def addAction (icon, text)
• def addAction (text)
• def checkedAction ()
• def isEnabled ()
• def isExclusive ()
• def isVisible ()
• def removeAction (a)

Slots

• def setDisabled (b)
• def setEnabled (arg__1)
• def setExclusive (arg__1)
• def setVisible (arg__1)

Signals

• def hovered (arg__1)
• def triggered (arg__1)

Detailed Description

The PySide.QtGui.QActionGroup class groups actions together.

In some situations it is useful to group actions together. For example, if you have a Left Align action, a Right Align action, a Justify action, and a Center action, only one of these actions should be active at any one time. One simple way of achieving this is to group the actions together in an action group.

Here’s a example (from the Menus example):

alignmentGroup =  QActionGroup(self)
alignmentGroup.addAction(leftAlignAct)
alignmentGroup.addAction(rightAlignAct)
alignmentGroup.addAction(justifyAct)
alignmentGroup.addAction(centerAct)
leftAlignAct.setChecked(True)

Here we create a new action group. Since the action group is exclusive by default, only one of the actions in the group is checked at any one time.

A PySide.QtGui.QActionGroup emits an PySide.QtGui.QActionGroup.triggered() signal when one of its actions is chosen. Each action in an action group emits its PySide.QtGui.QActionGroup.triggered() signal as usual.

As stated above, an action group is exclusive() by default; it ensures that only one checkable action is active at any one time. If you want to group checkable actions without making them exclusive, you can turn of exclusiveness by calling setExclusive(false).

Actions can be added to an action group using PySide.QtGui.QActionGroup.addAction() , but it is usually more convenient to specify a group when creating actions; this ensures that actions are automatically created with a parent. Actions can be visually separated from each other by adding a separator action to the group; create an action and use PySide.QtGui.QAction ‘s PySide.QtGui.QAction.setSeparator() function to make it considered a separator. Action groups are added to widgets with the QWidget.addActions() function.

See also

PySide.QtGui.QAction

class PySide.QtGui.QActionGroup(parent)

Parameters:parent – PySide.QtCore.QObject

Constructs an action group for the parent object.

The action group is exclusive by default. Call setExclusive(false) to make the action group non-exclusive.

PySide.QtGui.QActionGroup.actions()

Return type:

Returns the list of this groups’s actions. This may be empty.

PySide.QtGui.QActionGroup.addAction(text)

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

Creates and returns an action with text . The newly created action is a child of this action group.

Normally an action is added to a group by creating it with the group as parent, so this function is not usually used.

See also

QAction.setActionGroup()

PySide.QtGui.QActionGroup.addAction(a)

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

Adds the action to this group, and returns it.

Normally an action is added to a group by creating it with the group as its parent, so this function is not usually used.

See also

QAction.setActionGroup()

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

Parameters:

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

Return type:

PySide.QtGui.QAction

Creates and returns an action with text and an icon . The newly created action is a child of this action group.

Normally an action is added to a group by creating it with the group as its parent, so this function is not usually used.

See also

QAction.setActionGroup()

PySide.QtGui.QActionGroup.checkedAction()

Return type:PySide.QtGui.QAction

Returns the currently checked action in the group, or 0 if none are checked.

PySide.QtGui.QActionGroup.hovered(arg__1)

Parameters:arg__1 – PySide.QtGui.QAction

PySide.QtGui.QActionGroup.isEnabled()

Return type:PySide.QtCore.bool

This property holds whether the action group is enabled.

Each action in the group will be enabled or disabled unless it has been explicitly disabled.

See also

QAction.setEnabled()

PySide.QtGui.QActionGroup.isExclusive()

Return type:PySide.QtCore.bool

This property holds whether the action group does exclusive checking.

If exclusive is true, only one checkable action in the action group can ever be active at any time. If the user chooses another checkable action in the group, the one they chose becomes active and the one that was active becomes inactive.

See also

QAction.checkable

PySide.QtGui.QActionGroup.isVisible()

Return type:PySide.QtCore.bool

This property holds whether the action group is visible.

Each action in the action group will match the visible state of this group unless it has been explicitly hidden.

See also

QAction.setEnabled()

PySide.QtGui.QActionGroup.removeAction(a)

Parameters:a – PySide.QtGui.QAction

Removes the action from this group. The action will have no parent as a result.

See also

QAction.setActionGroup()

PySide.QtGui.QActionGroup.setDisabled(b)

Parameters:b – PySide.QtCore.bool

This is a convenience function for the enabled() property, that is useful for signals–slots connections. If b is true the action group is disabled; otherwise it is enabled.

PySide.QtGui.QActionGroup.setEnabled(arg__1)

Parameters:arg__1 – PySide.QtCore.bool

This property holds whether the action group is enabled.

Each action in the group will be enabled or disabled unless it has been explicitly disabled.

See also

QAction.setEnabled()

PySide.QtGui.QActionGroup.setExclusive(arg__1)

Parameters:arg__1 – PySide.QtCore.bool

This property holds whether the action group does exclusive checking.

If exclusive is true, only one checkable action in the action group can ever be active at any time. If the user chooses another checkable action in the group, the one they chose becomes active and the one that was active becomes inactive.

See also

QAction.checkable

PySide.QtGui.QActionGroup.setVisible(arg__1)

Parameters:arg__1 – PySide.QtCore.bool

This property holds whether the action group is visible.

Each action in the action group will match the visible state of this group unless it has been explicitly hidden.

See also

QAction.setEnabled()

PySide.QtGui.QActionGroup.triggered(arg__1)

Parameters:arg__1 – PySide.QtGui.QAction