Struct qt_widgets::QActionGroup

#[repr(C)]pub struct QActionGroup { /* fields omitted */ }

The QActionGroup class groups actions together.

C++ class: QActionGroup.

C++ documentation:

The QActionGroup class groups actions together.

In some situations it is useful to group QAction objects 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 = new QActionGroup(this);
      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 QActionGroup emits an triggered() signal when one of its actions is chosen. Each action in an action group emits its 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 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 QAction's setSeparator() function to make it considered a separator. Action groups are added to widgets with the QWidget::addActions() function.

Methods

impl QActionGroup

pub fn slot_set_enabled(&self) -> Receiver<(bool,)>

This property holds whether the action group is enabled

Returns a built-in Qt slot QActionGroup::setEnabled that can be passed to qt_core::Signal::connect.

C++ documentation:

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.

Access functions:

bool	isEnabled() const
void	setEnabled(bool)

See also QAction::setEnabled().

pub fn slot_set_disabled(&self) -> Receiver<(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.

Returns a built-in Qt slot QActionGroup::setDisabled that can be passed to qt_core::Signal::connect.

C++ documentation:

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.

pub fn slot_set_visible(&self) -> Receiver<(bool,)>

This property holds whether the action group is visible

Returns a built-in Qt slot QActionGroup::setVisible that can be passed to qt_core::Signal::connect.

C++ documentation:

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.

Access functions:

bool	isVisible() const
void	setVisible(bool)

See also QAction::setEnabled().

pub fn slot_set_exclusive(&self) -> Receiver<(bool,)>

This property holds whether the action group does exclusive checking

Returns a built-in Qt slot QActionGroup::setExclusive that can be passed to qt_core::Signal::connect.

C++ documentation:

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.

Access functions:

bool	isExclusive() const
void	setExclusive(bool)

See also QAction::checkable.

pub fn triggered(&self) -> Signal<(*mut QAction,)>

This signal is emitted when the given action in the action group is activated by the user; for example, when the user clicks a menu option, toolbar button, or presses an action's shortcut key combination.

Returns a built-in Qt signal QActionGroup::triggered that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the given action in the action group is activated by the user; for example, when the user clicks a menu option, toolbar button, or presses an action's shortcut key combination.

Connect to this signal for command actions.

See also QAction::activate().

pub fn hovered(&self) -> Signal<(*mut QAction,)>

This signal is emitted when the given action in the action group is highlighted by the user; for example, when the user pauses with the cursor over a menu option, toolbar button, or presses an action's shortcut key combination.

Returns a built-in Qt signal QActionGroup::hovered that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the given action in the action group is highlighted by the user; for example, when the user pauses with the cursor over a menu option, toolbar button, or presses an action's shortcut key combination.

See also QAction::activate().

pub unsafe fn actions(&self) -> CppBox<QListOfQAction>

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

Calls C++ function: QList<QAction*> QActionGroup::actions() const.

C++ documentation:

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

pub unsafe fn add_action_q_action(
    &self,
    a: impl CastInto<Ptr<QAction>>
) -> QPtr<QAction>

Adds the action to this group, and returns it.

Calls C++ function: QAction* QActionGroup::addAction(QAction* a).

C++ documentation:

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

pub unsafe fn add_action_q_string(
    &self,
    text: impl CastInto<Ref<QString>>
) -> QPtr<QAction>

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

Calls C++ function: QAction* QActionGroup::addAction(const QString& text).

C++ documentation:

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

pub unsafe fn add_action_q_icon_q_string(
    &self,
    icon: impl CastInto<Ref<QIcon>>,
    text: impl CastInto<Ref<QString>>
) -> QPtr<QAction>

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

Calls C++ function: QAction* QActionGroup::addAction(const QIcon& icon, const QString& text).

C++ documentation:

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

pub unsafe fn checked_action(&self) -> QPtr<QAction>

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

Calls C++ function: QAction* QActionGroup::checkedAction() const.

C++ documentation:

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

pub unsafe fn exclusion_policy(&self) -> ExclusionPolicy

This is supported on cpp_lib_version="5.14.0" only.

This property holds the group exclusive checking policy

Calls C++ function: QActionGroup::ExclusionPolicy QActionGroup::exclusionPolicy() const.

C++ documentation:

This property holds the group exclusive checking policy

If exclusionPolicy is set to Exclusive, 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. If exclusionPolicy is set to ExclusionOptional the group is exclusive but the active checkable action in the group can be unchecked leaving the group with no actions checked.

This property was introduced in Qt 5.14.

Access functions:

QActionGroup::ExclusionPolicy	exclusionPolicy() const
void	setExclusionPolicy(QActionGroup::ExclusionPolicy policy)

See also QAction::checkable.

pub unsafe fn is_enabled(&self) -> bool

This property holds whether the action group is enabled

Calls C++ function: bool QActionGroup::isEnabled() const.

C++ documentation:

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.

Access functions:

bool	isEnabled() const
void	setEnabled(bool)

See also QAction::setEnabled().

pub unsafe fn is_exclusive(&self) -> bool

This property holds whether the action group does exclusive checking

Calls C++ function: bool QActionGroup::isExclusive() const.

C++ documentation:

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.

Access functions:

bool	isExclusive() const
void	setExclusive(bool)

See also QAction::checkable.

pub unsafe fn is_visible(&self) -> bool

This property holds whether the action group is visible

Calls C++ function: bool QActionGroup::isVisible() const.

C++ documentation:

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.

Access functions:

bool	isVisible() const
void	setVisible(bool)

See also QAction::setEnabled().

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* QActionGroup::metaObject() const.

pub unsafe fn new(parent: impl CastInto<Ptr<QObject>>) -> QBox<QActionGroup>

Constructs an action group for the parent object.

Calls C++ function: [constructor] void QActionGroup::QActionGroup(QObject* parent).

C++ documentation:

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.

pub unsafe fn qt_metacall(
    &self,
    arg1: Call,
    arg2: c_int,
    arg3: *mut *mut c_void
) -> c_int

Calls C++ function: virtual int QActionGroup::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

Calls C++ function: virtual void* QActionGroup::qt_metacast(const char* arg1).

pub unsafe fn remove_action(&self, a: impl CastInto<Ptr<QAction>>)

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

Calls C++ function: void QActionGroup::removeAction(QAction* a).

C++ documentation:

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

See also QAction::setActionGroup().

pub unsafe fn set_disabled(&self, b: 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.

Calls C++ function: [slot] void QActionGroup::setDisabled(bool b).

C++ documentation:

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.

pub unsafe fn set_enabled(&self, arg1: bool)

This property holds whether the action group is enabled

Calls C++ function: [slot] void QActionGroup::setEnabled(bool arg1).

C++ documentation:

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.

Access functions:

bool	isEnabled() const
void	setEnabled(bool)

See also QAction::setEnabled().

pub unsafe fn set_exclusion_policy(&self, policy: ExclusionPolicy)

This is supported on cpp_lib_version="5.14.0" only.

This property holds the group exclusive checking policy

Calls C++ function: void QActionGroup::setExclusionPolicy(QActionGroup::ExclusionPolicy policy).

C++ documentation:

This property holds the group exclusive checking policy

If exclusionPolicy is set to Exclusive, 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. If exclusionPolicy is set to ExclusionOptional the group is exclusive but the active checkable action in the group can be unchecked leaving the group with no actions checked.

This property was introduced in Qt 5.14.

Access functions:

QActionGroup::ExclusionPolicy	exclusionPolicy() const
void	setExclusionPolicy(QActionGroup::ExclusionPolicy policy)

See also QAction::checkable.

pub unsafe fn set_exclusive(&self, arg1: bool)

This property holds whether the action group does exclusive checking

Calls C++ function: [slot] void QActionGroup::setExclusive(bool arg1).

C++ documentation:

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.

Access functions:

bool	isExclusive() const
void	setExclusive(bool)

See also QAction::checkable.

pub unsafe fn set_visible(&self, arg1: bool)

This property holds whether the action group is visible

Calls C++ function: [slot] void QActionGroup::setVisible(bool arg1).

C++ documentation:

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.

Access functions:

bool	isVisible() const
void	setVisible(bool)

See also QAction::setEnabled().

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn tr(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QActionGroup::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QActionGroup::trUtf8(const char* s, const char* c, int n).

Trait Implementations

impl CppDeletable for QActionGroup

unsafe fn delete(&self)

Destroys the action group.

Calls C++ function: virtual [destructor] void QActionGroup::~QActionGroup().

C++ documentation:

Destroys the action group.

impl Deref for QActionGroup

type Target = QObject

The resulting type after dereferencing.

fn deref(&self) -> &QObject

Calls C++ function: QObject* static_cast<QObject*>(QActionGroup* ptr).

impl DynamicCast<QActionGroup> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QActionGroup>

Calls C++ function: QActionGroup* dynamic_cast<QActionGroup*>(QObject* ptr).

impl StaticDowncast<QActionGroup> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QActionGroup>

Calls C++ function: QActionGroup* static_cast<QActionGroup*>(QObject* ptr).

impl StaticUpcast<QObject> for QActionGroup

unsafe fn static_upcast(ptr: Ptr<QActionGroup>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(QActionGroup* ptr).