Struct QAction

#[repr(C)]
pub struct QAction { /* private fields */ }

The QAction class provides an abstract user interface action that can be inserted into widgets.

C++ class: QAction.

C++ documentation:

The QAction class provides an abstract user interface action that can be inserted into widgets.

In applications many common commands can be invoked via menus, toolbar buttons, and keyboard shortcuts. Since the user expects each command to be performed in the same way, regardless of the user interface used, it is useful to represent each command as an action.

Actions can be added to menus and toolbars, and will automatically keep them in sync. For example, in a word processor, if the user presses a Bold toolbar button, the Bold menu item will automatically be checked.

Actions can be created as independent objects, but they may also be created during the construction of menus; the QMenu class contains convenience functions for creating actions suitable for use as menu items.

A QAction may contain an icon, menu text, a shortcut, status text, "What's This?" text, and a tooltip. Most of these can be set in the constructor. They can also be set independently with setIcon(), setText(), setIconText(), setShortcut(), setStatusTip(), setWhatsThis(), and setToolTip(). For menu items, it is possible to set an individual font with setFont().

Actions are added to widgets using QWidget::addAction() or QGraphicsWidget::addAction(). Note that an action must be added to a widget before it can be used; this is also true when the shortcut should be global (i.e., Qt::ApplicationShortcut as Qt::ShortcutContext).

Once a QAction has been created it should be added to the relevant menu and toolbar, then connected to the slot which will perform the action. For example:

      const QIcon openIcon = QIcon::fromTheme(“document-open”, QIcon(“:/images/open.png”));
      QAction *openAct = new QAction(openIcon, tr(“&Open…”), this);
      openAct->setShortcuts(QKeySequence::Open);
      openAct->setStatusTip(tr(“Open an existing file”));
      connect(openAct, &QAction::triggered, this, &MainWindow::open);
      fileMenu->addAction(openAct);
      fileToolBar->addAction(openAct);

fileMenu->addAction(openAct);

We recommend that actions are created as children of the window they are used in. In most cases actions will be children of the application's main window.

Implementations

impl QAction

pub fn slot_trigger(&self) -> Receiver<()>

This is a convenience slot that calls activate(Trigger).

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

C++ documentation:

This is a convenience slot that calls activate(Trigger).

pub fn slot_hover(&self) -> Receiver<()>

This is a convenience slot that calls activate(Hover).

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

C++ documentation:

This is a convenience slot that calls activate(Hover).

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

This property holds whether the action is checked.

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

C++ documentation:

This property holds whether the action is checked.

Only checkable actions can be checked. By default, this is false (the action is unchecked).

Access functions:

bool	isChecked() const
void	setChecked(bool)

Notifier signal:

void	toggled(bool checked)

See also checkable.

pub fn slot_toggle(&self) -> Receiver<()>

This is a convenience function for the checked property. Connect to it to change the checked state to its opposite state.

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

C++ documentation:

This is a convenience function for the checked property. Connect to it to change the checked state to its opposite state.

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

This property holds whether the action is enabled

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

C++ documentation:

This property holds whether the action is enabled

Disabled actions cannot be chosen by the user. They do not disappear from menus or toolbars, but they are displayed in a way which indicates that they are unavailable. For example, they might be displayed using only shades of gray.

What's This? help on disabled actions is still available, provided that the QAction::whatsThis property is set.

An action will be disabled when all widgets to which it is added (with QWidget::addAction()) are disabled or not visible. When an action is disabled, it is not possible to trigger it through its shortcut.

By default, this property is true (actions are enabled).

Access functions:

bool	isEnabled() const
void	setEnabled(bool)

Notifier signal:

void

changed()

See also text.

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 is disabled; otherwise it is enabled.

Returns a built-in Qt slot QAction::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 is disabled; otherwise it is enabled.

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

This property holds whether the action can be seen (e.g. in menus and toolbars)

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

C++ documentation:

This property holds whether the action can be seen (e.g. in menus and toolbars)

If visible is true the action can be seen (e.g. in menus and toolbars) and chosen by the user; if visible is false the action cannot be seen or chosen by the user.

Actions which are not visible are not grayed out; they do not appear at all.

By default, this property is true (actions are visible).

Access functions:

bool	isVisible() const
void	setVisible(bool)

Notifier signal:

void

changed()

pub fn changed(&self) -> Signal<()>

This signal is emitted when an action has changed. If you are only interested in actions in a given widget, you can watch for QWidget::actionEvent() sent with an QEvent::ActionChanged.

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

C++ documentation:

This signal is emitted when an action has changed. If you are only interested in actions in a given widget, you can watch for QWidget::actionEvent() sent with an QEvent::ActionChanged.

Note: Notifier signal for property autoRepeat. Notifier signal for property checkable. Notifier signal for property enabled. Notifier signal for property font. Notifier signal for property icon. Notifier signal for property iconText. Notifier signal for property iconVisibleInMenu. Notifier signal for property menuRole. Notifier signal for property shortcut. Notifier signal for property shortcutContext. Notifier signal for property statusTip. Notifier signal for property text. Notifier signal for property toolTip. Notifier signal for property visible. Notifier signal for property whatsThis.

See also QWidget::actionEvent().

pub fn triggered(&self) -> Signal<(bool,)>

This signal is emitted when an action is activated by the user; for example, when the user clicks a menu option, toolbar button, or presses an action's shortcut key combination, or when trigger() was called. Notably, it is not emitted when setChecked() or toggle() is called.

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

C++ documentation:

This signal is emitted when an action is activated by the user; for example, when the user clicks a menu option, toolbar button, or presses an action’s shortcut key combination, or when trigger() was called. Notably, it is not emitted when setChecked() or toggle() is called.

If the action is checkable, checked is true if the action is checked, or false if the action is unchecked.

See also QAction::activate(), QAction::toggled(), and checked.

pub fn hovered(&self) -> Signal<()>

This signal is emitted when an action 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 QAction::hovered that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when an action 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 fn toggled(&self) -> Signal<(bool,)>

This signal is emitted whenever a checkable action changes its isChecked() status. This can be the result of a user interaction, or because setChecked() was called.

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

C++ documentation:

This signal is emitted whenever a checkable action changes its isChecked() status. This can be the result of a user interaction, or because setChecked() was called.

checked is true if the action is checked, or false if the action is unchecked.

Note: Notifier signal for property checked.

See also QAction::activate(), QAction::triggered(), and checked.

pub unsafe fn action_group(&self) -> QPtr<QActionGroup>

Returns the action group for this action. If no action group manages this action then 0 will be returned.

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

C++ documentation:

Returns the action group for this action. If no action group manages this action then 0 will be returned.

See also QActionGroup and QAction::setActionGroup().

pub unsafe fn activate(&self, event: ActionEvent)

Sends the relevant signals for ActionEvent event.

Calls C++ function: void QAction::activate(QAction::ActionEvent event).

C++ documentation:

Sends the relevant signals for ActionEvent event.

Action based widgets use this API to cause the QAction to emit signals as well as emitting their own.

pub unsafe fn associated_graphics_widgets( &self, ) -> CppBox<QListOfQGraphicsWidget>

Returns a list of widgets this action has been added to.

Calls C++ function: QList<QGraphicsWidget*> QAction::associatedGraphicsWidgets() const.

C++ documentation:

Returns a list of widgets this action has been added to.

This function was introduced in Qt 4.5.

See also QWidget::addAction() and associatedWidgets().

pub unsafe fn associated_widgets(&self) -> CppBox<QListOfQWidget>

Returns a list of widgets this action has been added to.

Calls C++ function: QList<QWidget*> QAction::associatedWidgets() const.

C++ documentation:

Returns a list of widgets this action has been added to.

This function was introduced in Qt 4.2.

See also QWidget::addAction() and associatedGraphicsWidgets().

pub unsafe fn auto_repeat(&self) -> bool

This property holds whether the action can auto repeat

Calls C++ function: bool QAction::autoRepeat() const.

C++ documentation:

This property holds whether the action can auto repeat

If true, the action will auto repeat when the keyboard shortcut combination is held down, provided that keyboard auto repeat is enabled on the system. The default value is true.

This property was introduced in Qt 4.2.

Access functions:

bool	autoRepeat() const
void	setAutoRepeat(bool)

Notifier signal:

void

changed()

pub unsafe fn data(&self) -> CppBox<QVariant>

Returns the user data as set in QAction::setData.

Calls C++ function: QVariant QAction::data() const.

C++ documentation:

Returns the user data as set in QAction::setData.

See also setData().

pub unsafe fn font(&self) -> CppBox<QFont>

This property holds the action's font

Calls C++ function: QFont QAction::font() const.

C++ documentation:

This property holds the action’s font

The font property is used to render the text set on the QAction. The font will can be considered a hint as it will not be consulted in all cases based upon application and style.

By default, this property contains the application's default font.

Access functions:

QFont	font() const
void	setFont(const QFont &font)

Notifier signal:

void

changed()

See also QAction::setText() and QStyle.

pub unsafe fn hover(&self)

This is a convenience slot that calls activate(Hover).

Calls C++ function: [slot] void QAction::hover().

C++ documentation:

This is a convenience slot that calls activate(Hover).

pub unsafe fn icon(&self) -> CppBox<QIcon>

This property holds the action's icon

Calls C++ function: QIcon QAction::icon() const.

C++ documentation:

This property holds the action’s icon

In toolbars, the icon is used as the tool button icon; in menus, it is displayed to the left of the menu text. There is no default icon.

If a null icon (QIcon::isNull()) is passed into this function, the icon of the action is cleared.

Access functions:

QIcon	icon() const
void	setIcon(const QIcon &icon)

Notifier signal:

void

changed()

pub unsafe fn icon_text(&self) -> CppBox<QString>

This property holds the action's descriptive icon text

Calls C++ function: QString QAction::iconText() const.

C++ documentation:

This property holds the action’s descriptive icon text

If QToolBar::toolButtonStyle is set to a value that permits text to be displayed, the text defined held in this property appears as a label in the relevant tool button.

It also serves as the default text in menus and tooltips if the action has not been defined with setText() or setToolTip(), and will also be used in toolbar buttons if no icon has been defined using setIcon().

If the icon text is not explicitly set, the action's normal text will be used for the icon text.

By default, this property contains an empty string.

Access functions:

QString	iconText() const
void	setIconText(const QString &text)

Notifier signal:

void

changed()

See also setToolTip() and setStatusTip().

pub unsafe fn is_checkable(&self) -> bool

This property holds whether the action is a checkable action

Calls C++ function: bool QAction::isCheckable() const.

C++ documentation:

This property holds whether the action is a checkable action

A checkable action is one which has an on/off state. For example, in a word processor, a Bold toolbar button may be either on or off. An action which is not a toggle action is a command action; a command action is simply executed, e.g. file save. By default, this property is false.

In some situations, the state of one toggle action should depend on the state of others. For example, "Left Align", "Center" and "Right Align" toggle actions are mutually exclusive. To achieve exclusive toggling, add the relevant toggle actions to a QActionGroup with the QActionGroup::exclusive property set to true.

Access functions:

bool	isCheckable() const
void	setCheckable(bool)

Notifier signal:

void

changed()

See also QAction::setChecked().

pub unsafe fn is_checked(&self) -> bool

This property holds whether the action is checked.

Calls C++ function: bool QAction::isChecked() const.

C++ documentation:

This property holds whether the action is checked.

Only checkable actions can be checked. By default, this is false (the action is unchecked).

Access functions:

bool	isChecked() const
void	setChecked(bool)

Notifier signal:

void	toggled(bool checked)

See also checkable.

pub unsafe fn is_enabled(&self) -> bool

This property holds whether the action is enabled

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

C++ documentation:

This property holds whether the action is enabled

Disabled actions cannot be chosen by the user. They do not disappear from menus or toolbars, but they are displayed in a way which indicates that they are unavailable. For example, they might be displayed using only shades of gray.

What's This? help on disabled actions is still available, provided that the QAction::whatsThis property is set.

An action will be disabled when all widgets to which it is added (with QWidget::addAction()) are disabled or not visible. When an action is disabled, it is not possible to trigger it through its shortcut.

By default, this property is true (actions are enabled).

Access functions:

bool	isEnabled() const
void	setEnabled(bool)

Notifier signal:

void

changed()

See also text.

pub unsafe fn is_icon_visible_in_menu(&self) -> bool

This property holds whether or not an action should show an icon in a menu

Calls C++ function: bool QAction::isIconVisibleInMenu() const.

C++ documentation:

This property holds whether or not an action should show an icon in a menu

In some applications, it may make sense to have actions with icons in the toolbar, but not in menus. If true, the icon (if valid) is shown in the menu, when it is false, it is not shown.

The default is to follow whether the Qt::AA_DontShowIconsInMenus attribute is set for the application. Explicitly settings this property overrides the presence (or abscence) of the attribute.

For example:

QApplication app(argc, argv);
app.setAttribute(Qt::AA_DontShowIconsInMenus);  // Icons are no longer shown in menus
// …
QAction *myAction = new QAction();
// …
myAction->setIcon(SomeIcon);
myAction->setIconVisibleInMenu(true);   // Icon will be shown in menus for this action.

This property was introduced in Qt 4.4.

Access functions:

bool	isIconVisibleInMenu() const
void	setIconVisibleInMenu(bool visible)

Notifier signal:

void

changed()

See also QAction::icon and QCoreApplication::setAttribute().

pub unsafe fn is_separator(&self) -> bool

Returns true if this action is a separator action; otherwise it returns false.

Calls C++ function: bool QAction::isSeparator() const.

C++ documentation:

Returns true if this action is a separator action; otherwise it returns false.

See also QAction::setSeparator().

pub unsafe fn is_shortcut_visible_in_context_menu(&self) -> bool

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

This property holds whether or not an action should show a shortcut in a context menu

Calls C++ function: bool QAction::isShortcutVisibleInContextMenu() const.

C++ documentation:

This property holds whether or not an action should show a shortcut in a context menu

In some applications, it may make sense to have actions with shortcuts in context menus. If true, the shortcut (if valid) is shown when the action is shown via a context menu, when it is false, it is not shown.

The default is to follow whether the Qt::AA_DontShowShortcutsInContextMenus attribute is set for the application, falling back to the widget style hint. Explicitly setting this property overrides the presence (or abscence) of the attribute.

This property was introduced in Qt 5.10.

Access functions:

bool	isShortcutVisibleInContextMenu() const
void	setShortcutVisibleInContextMenu(bool show)

Notifier signal:

void

changed()

See also QAction::shortcut and QCoreApplication::setAttribute().

pub unsafe fn is_visible(&self) -> bool

This property holds whether the action can be seen (e.g. in menus and toolbars)

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

C++ documentation:

This property holds whether the action can be seen (e.g. in menus and toolbars)

If visible is true the action can be seen (e.g. in menus and toolbars) and chosen by the user; if visible is false the action cannot be seen or chosen by the user.

Actions which are not visible are not grayed out; they do not appear at all.

By default, this property is true (actions are visible).

Access functions:

bool	isVisible() const
void	setVisible(bool)

Notifier signal:

void

changed()

pub unsafe fn menu(&self) -> QPtr<QMenu>

Returns the menu contained by this action. Actions that contain menus can be used to create menu items with submenus, or inserted into toolbars to create buttons with popup menus.

Calls C++ function: QMenu* QAction::menu() const.

C++ documentation:

Returns the menu contained by this action. Actions that contain menus can be used to create menu items with submenus, or inserted into toolbars to create buttons with popup menus.

See also setMenu() and QMenu::addAction().

pub unsafe fn menu_role(&self) -> MenuRole

This property holds the action's menu role

Calls C++ function: QAction::MenuRole QAction::menuRole() const.

C++ documentation:

This property holds the action’s menu role

This indicates what role the action serves in the application menu on macOS. By default all actions have the TextHeuristicRole, which means that the action is added based on its text (see QMenuBar for more information).

The menu role can only be changed before the actions are put into the menu bar in macOS (usually just before the first application window is shown).

This property was introduced in Qt 4.2.

Access functions:

MenuRole	menuRole() const
void	setMenuRole(MenuRole menuRole)

Notifier signal:

void

changed()

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

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

pub unsafe fn from_q_object( parent: impl CastInto<Ptr<QObject>>, ) -> QBox<QAction>

Constructs an action with parent. If parent is an action group the action will be automatically inserted into the group.

Calls C++ function: [constructor] void QAction::QAction(QObject* parent = …).

C++ documentation:

Constructs an action with parent. If parent is an action group the action will be automatically inserted into the group.

Note: The parent argument is optional since Qt 5.7.

pub unsafe fn from_q_string_q_object( text: impl CastInto<Ref<QString>>, parent: impl CastInto<Ptr<QObject>>, ) -> QBox<QAction>

Constructs an action with some text and parent. If parent is an action group the action will be automatically inserted into the group.

Calls C++ function: [constructor] void QAction::QAction(const QString& text, QObject* parent = …).

C++ documentation:

Constructs an action with some text and parent. If parent is an action group the action will be automatically inserted into the group.

The action uses a stripped version of text (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for tool buttons. You can override this by setting a specific description with setText(). The same text will be used for tooltips unless you specify a different text using setToolTip().

pub unsafe fn from_q_icon_q_string_q_object( icon: impl CastInto<Ref<QIcon>>, text: impl CastInto<Ref<QString>>, parent: impl CastInto<Ptr<QObject>>, ) -> QBox<QAction>

Constructs an action with an icon and some text and parent. If parent is an action group the action will be automatically inserted into the group.

Calls C++ function: [constructor] void QAction::QAction(const QIcon& icon, const QString& text, QObject* parent = …).

C++ documentation:

Constructs an action with an icon and some text and parent. If parent is an action group the action will be automatically inserted into the group.

The action uses a stripped version of text (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for tool buttons. You can override this by setting a specific description with setText(). The same text will be used for tooltips unless you specify a different text using setToolTip().

pub unsafe fn new() -> QBox<QAction>

The QAction class provides an abstract user interface action that can be inserted into widgets.

Calls C++ function: [constructor] void QAction::QAction().

C++ documentation:

The QAction class provides an abstract user interface action that can be inserted into widgets.

In applications many common commands can be invoked via menus, toolbar buttons, and keyboard shortcuts. Since the user expects each command to be performed in the same way, regardless of the user interface used, it is useful to represent each command as an action.

Actions can be added to menus and toolbars, and will automatically keep them in sync. For example, in a word processor, if the user presses a Bold toolbar button, the Bold menu item will automatically be checked.

Actions can be created as independent objects, but they may also be created during the construction of menus; the QMenu class contains convenience functions for creating actions suitable for use as menu items.

A QAction may contain an icon, menu text, a shortcut, status text, "What's This?" text, and a tooltip. Most of these can be set in the constructor. They can also be set independently with setIcon(), setText(), setIconText(), setShortcut(), setStatusTip(), setWhatsThis(), and setToolTip(). For menu items, it is possible to set an individual font with setFont().

Actions are added to widgets using QWidget::addAction() or QGraphicsWidget::addAction(). Note that an action must be added to a widget before it can be used; this is also true when the shortcut should be global (i.e., Qt::ApplicationShortcut as Qt::ShortcutContext).

Once a QAction has been created it should be added to the relevant menu and toolbar, then connected to the slot which will perform the action. For example:

      const QIcon openIcon = QIcon::fromTheme(“document-open”, QIcon(“:/images/open.png”));
      QAction *openAct = new QAction(openIcon, tr(“&Open…”), this);
      openAct->setShortcuts(QKeySequence::Open);
      openAct->setStatusTip(tr(“Open an existing file”));
      connect(openAct, &QAction::triggered, this, &MainWindow::open);
      fileMenu->addAction(openAct);
      fileToolBar->addAction(openAct);

fileMenu->addAction(openAct);

We recommend that actions are created as children of the window they are used in. In most cases actions will be children of the application's main window.

pub unsafe fn from_q_string(text: impl CastInto<Ref<QString>>) -> QBox<QAction>

Constructs an action with some text and parent. If parent is an action group the action will be automatically inserted into the group.

Calls C++ function: [constructor] void QAction::QAction(const QString& text).

C++ documentation:

Constructs an action with some text and parent. If parent is an action group the action will be automatically inserted into the group.

The action uses a stripped version of text (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for tool buttons. You can override this by setting a specific description with setText(). The same text will be used for tooltips unless you specify a different text using setToolTip().

pub unsafe fn from_q_icon_q_string( icon: impl CastInto<Ref<QIcon>>, text: impl CastInto<Ref<QString>>, ) -> QBox<QAction>

Constructs an action with an icon and some text and parent. If parent is an action group the action will be automatically inserted into the group.

Calls C++ function: [constructor] void QAction::QAction(const QIcon& icon, const QString& text).

C++ documentation:

Constructs an action with an icon and some text and parent. If parent is an action group the action will be automatically inserted into the group.

The action uses a stripped version of text (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for tool buttons. You can override this by setting a specific description with setText(). The same text will be used for tooltips unless you specify a different text using setToolTip().

pub unsafe fn parent_widget(&self) -> QPtr<QWidget>

Returns the parent widget.

Calls C++ function: QWidget* QAction::parentWidget() const.

C++ documentation:

Returns the parent widget.

pub unsafe fn priority(&self) -> Priority

This property holds the actions's priority in the user interface.

Calls C++ function: QAction::Priority QAction::priority() const.

C++ documentation:

This property holds the actions’s priority in the user interface.

This property can be set to indicate how the action should be prioritized in the user interface.

For instance, when toolbars have the Qt::ToolButtonTextBesideIcon mode set, then actions with LowPriority will not show the text labels.

This property was introduced in Qt 4.6.

Access functions:

Priority	priority() const
void	setPriority(Priority priority)

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

Calls C++ function: virtual int QAction::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* QAction::qt_metacast(const char* arg1).

pub unsafe fn set_action_group(&self, group: impl CastInto<Ptr<QActionGroup>>)

Sets this action group to group. The action will be automatically added to the group's list of actions.

Calls C++ function: void QAction::setActionGroup(QActionGroup* group).

C++ documentation:

Sets this action group to group. The action will be automatically added to the group’s list of actions.

Actions within the group will be mutually exclusive.

See also QActionGroup and QAction::actionGroup().

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

This property holds whether the action can auto repeat

Calls C++ function: void QAction::setAutoRepeat(bool arg1).

C++ documentation:

This property holds whether the action can auto repeat

If true, the action will auto repeat when the keyboard shortcut combination is held down, provided that keyboard auto repeat is enabled on the system. The default value is true.

This property was introduced in Qt 4.2.

Access functions:

bool	autoRepeat() const
void	setAutoRepeat(bool)

Notifier signal:

void

changed()

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

This property holds whether the action is a checkable action

Calls C++ function: void QAction::setCheckable(bool arg1).

C++ documentation:

This property holds whether the action is a checkable action

A checkable action is one which has an on/off state. For example, in a word processor, a Bold toolbar button may be either on or off. An action which is not a toggle action is a command action; a command action is simply executed, e.g. file save. By default, this property is false.

In some situations, the state of one toggle action should depend on the state of others. For example, "Left Align", "Center" and "Right Align" toggle actions are mutually exclusive. To achieve exclusive toggling, add the relevant toggle actions to a QActionGroup with the QActionGroup::exclusive property set to true.

Access functions:

bool	isCheckable() const
void	setCheckable(bool)

Notifier signal:

void

changed()

See also QAction::setChecked().

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

This property holds whether the action is checked.

Calls C++ function: [slot] void QAction::setChecked(bool arg1).

C++ documentation:

This property holds whether the action is checked.

Only checkable actions can be checked. By default, this is false (the action is unchecked).

Access functions:

bool	isChecked() const
void	setChecked(bool)

Notifier signal:

void	toggled(bool checked)

See also checkable.

pub unsafe fn set_data(&self, var: impl CastInto<Ref<QVariant>>)

Sets the action's internal data to the given userData.

Calls C++ function: void QAction::setData(const QVariant& var).

C++ documentation:

Sets the action’s internal data to the given userData.

See also data().

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 is disabled; otherwise it is enabled.

Calls C++ function: [slot] void QAction::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 is disabled; otherwise it is enabled.

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

This property holds whether the action is enabled

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

C++ documentation:

This property holds whether the action is enabled

Disabled actions cannot be chosen by the user. They do not disappear from menus or toolbars, but they are displayed in a way which indicates that they are unavailable. For example, they might be displayed using only shades of gray.

What's This? help on disabled actions is still available, provided that the QAction::whatsThis property is set.

An action will be disabled when all widgets to which it is added (with QWidget::addAction()) are disabled or not visible. When an action is disabled, it is not possible to trigger it through its shortcut.

By default, this property is true (actions are enabled).

Access functions:

bool	isEnabled() const
void	setEnabled(bool)

Notifier signal:

void

changed()

See also text.

pub unsafe fn set_font(&self, font: impl CastInto<Ref<QFont>>)

This property holds the action's font

Calls C++ function: void QAction::setFont(const QFont& font).

C++ documentation:

This property holds the action’s font

The font property is used to render the text set on the QAction. The font will can be considered a hint as it will not be consulted in all cases based upon application and style.

By default, this property contains the application's default font.

Access functions:

QFont	font() const
void	setFont(const QFont &font)

Notifier signal:

void

changed()

See also QAction::setText() and QStyle.

pub unsafe fn set_icon(&self, icon: impl CastInto<Ref<QIcon>>)

This property holds the action's icon

Calls C++ function: void QAction::setIcon(const QIcon& icon).

C++ documentation:

This property holds the action’s icon

In toolbars, the icon is used as the tool button icon; in menus, it is displayed to the left of the menu text. There is no default icon.

If a null icon (QIcon::isNull()) is passed into this function, the icon of the action is cleared.

Access functions:

QIcon	icon() const
void	setIcon(const QIcon &icon)

Notifier signal:

void

changed()

pub unsafe fn set_icon_text(&self, text: impl CastInto<Ref<QString>>)

This property holds the action's descriptive icon text

Calls C++ function: void QAction::setIconText(const QString& text).

C++ documentation:

This property holds the action’s descriptive icon text

If QToolBar::toolButtonStyle is set to a value that permits text to be displayed, the text defined held in this property appears as a label in the relevant tool button.

It also serves as the default text in menus and tooltips if the action has not been defined with setText() or setToolTip(), and will also be used in toolbar buttons if no icon has been defined using setIcon().

If the icon text is not explicitly set, the action's normal text will be used for the icon text.

By default, this property contains an empty string.

Access functions:

QString	iconText() const
void	setIconText(const QString &text)

Notifier signal:

void

changed()

See also setToolTip() and setStatusTip().

pub unsafe fn set_icon_visible_in_menu(&self, visible: bool)

This property holds whether or not an action should show an icon in a menu

Calls C++ function: void QAction::setIconVisibleInMenu(bool visible).

C++ documentation:

This property holds whether or not an action should show an icon in a menu

In some applications, it may make sense to have actions with icons in the toolbar, but not in menus. If true, the icon (if valid) is shown in the menu, when it is false, it is not shown.

The default is to follow whether the Qt::AA_DontShowIconsInMenus attribute is set for the application. Explicitly settings this property overrides the presence (or abscence) of the attribute.

For example:

QApplication app(argc, argv);
app.setAttribute(Qt::AA_DontShowIconsInMenus);  // Icons are no longer shown in menus
// …
QAction *myAction = new QAction();
// …
myAction->setIcon(SomeIcon);
myAction->setIconVisibleInMenu(true);   // Icon will be shown in menus for this action.

This property was introduced in Qt 4.4.

Access functions:

bool	isIconVisibleInMenu() const
void	setIconVisibleInMenu(bool visible)

Notifier signal:

void

changed()

See also QAction::icon and QCoreApplication::setAttribute().

pub unsafe fn set_menu(&self, menu: impl CastInto<Ptr<QMenu>>)

Sets the menu contained by this action to the specified menu.

Calls C++ function: void QAction::setMenu(QMenu* menu).

C++ documentation:

Sets the menu contained by this action to the specified menu.

See also menu().

pub unsafe fn set_menu_role(&self, menu_role: MenuRole)

This property holds the action's menu role

Calls C++ function: void QAction::setMenuRole(QAction::MenuRole menuRole).

C++ documentation:

This property holds the action’s menu role

This indicates what role the action serves in the application menu on macOS. By default all actions have the TextHeuristicRole, which means that the action is added based on its text (see QMenuBar for more information).

The menu role can only be changed before the actions are put into the menu bar in macOS (usually just before the first application window is shown).

This property was introduced in Qt 4.2.

Access functions:

MenuRole	menuRole() const
void	setMenuRole(MenuRole menuRole)

Notifier signal:

void

changed()

pub unsafe fn set_priority(&self, priority: Priority)

This property holds the actions's priority in the user interface.

Calls C++ function: void QAction::setPriority(QAction::Priority priority).

C++ documentation:

This property holds the actions’s priority in the user interface.

This property can be set to indicate how the action should be prioritized in the user interface.

For instance, when toolbars have the Qt::ToolButtonTextBesideIcon mode set, then actions with LowPriority will not show the text labels.

This property was introduced in Qt 4.6.

Access functions:

Priority	priority() const
void	setPriority(Priority priority)

pub unsafe fn set_separator(&self, b: bool)

If b is true then this action will be considered a separator.

Calls C++ function: void QAction::setSeparator(bool b).

C++ documentation:

If b is true then this action will be considered a separator.

How a separator is represented depends on the widget it is inserted into. Under most circumstances the text, submenu, and icon will be ignored for separator actions.

See also QAction::isSeparator().

pub unsafe fn set_shortcut(&self, shortcut: impl CastInto<Ref<QKeySequence>>)

This property holds the action's primary shortcut key

Calls C++ function: void QAction::setShortcut(const QKeySequence& shortcut).

C++ documentation:

This property holds the action’s primary shortcut key

Valid keycodes for this property can be found in Qt::Key and Qt::Modifier. There is no default shortcut key.

Access functions:

QKeySequence	shortcut() const
void	setShortcut(const QKeySequence &shortcut)

Notifier signal:

void

changed()

pub unsafe fn set_shortcut_context(&self, context: ShortcutContext)

This property holds the context for the action's shortcut

Calls C++ function: void QAction::setShortcutContext(Qt::ShortcutContext context).

C++ documentation:

This property holds the context for the action’s shortcut

Valid values for this property can be found in Qt::ShortcutContext. The default value is Qt::WindowShortcut.

Access functions:

Qt::ShortcutContext	shortcutContext() const
void	setShortcutContext(Qt::ShortcutContext context)

Notifier signal:

void

changed()

pub unsafe fn set_shortcut_visible_in_context_menu(&self, show: bool)

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

This property holds whether or not an action should show a shortcut in a context menu

Calls C++ function: void QAction::setShortcutVisibleInContextMenu(bool show).

C++ documentation:

This property holds whether or not an action should show a shortcut in a context menu

In some applications, it may make sense to have actions with shortcuts in context menus. If true, the shortcut (if valid) is shown when the action is shown via a context menu, when it is false, it is not shown.

The default is to follow whether the Qt::AA_DontShowShortcutsInContextMenus attribute is set for the application, falling back to the widget style hint. Explicitly setting this property overrides the presence (or abscence) of the attribute.

This property was introduced in Qt 5.10.

Access functions:

bool	isShortcutVisibleInContextMenu() const
void	setShortcutVisibleInContextMenu(bool show)

Notifier signal:

void

changed()

See also QAction::shortcut and QCoreApplication::setAttribute().

pub unsafe fn set_shortcuts_q_list_of_q_key_sequence( &self, shortcuts: impl CastInto<Ref<QListOfQKeySequence>>, )

Sets shortcuts as the list of shortcuts that trigger the action. The first element of the list is the primary shortcut.

Calls C++ function: void QAction::setShortcuts(const QList<QKeySequence>& shortcuts).

C++ documentation:

Sets shortcuts as the list of shortcuts that trigger the action. The first element of the list is the primary shortcut.

This function was introduced in Qt 4.2.

See also shortcuts() and shortcut.

pub unsafe fn set_shortcuts_standard_key(&self, arg1: StandardKey)

Sets a platform dependent list of shortcuts based on the key. The result of calling this function will depend on the currently running platform. Note that more than one shortcut can assigned by this action. If only the primary shortcut is required, use setShortcut instead.

Calls C++ function: void QAction::setShortcuts(QKeySequence::StandardKey arg1).

C++ documentation:

Sets a platform dependent list of shortcuts based on the key. The result of calling this function will depend on the currently running platform. Note that more than one shortcut can assigned by this action. If only the primary shortcut is required, use setShortcut instead.

This function was introduced in Qt 4.2.

See also QKeySequence::keyBindings().

pub unsafe fn set_status_tip(&self, status_tip: impl CastInto<Ref<QString>>)

This property holds the action's status tip

Calls C++ function: void QAction::setStatusTip(const QString& statusTip).

C++ documentation:

This property holds the action’s status tip

The status tip is displayed on all status bars provided by the action's top-level parent widget.

By default, this property contains an empty string.

Access functions:

QString	statusTip() const
void	setStatusTip(const QString &statusTip)

Notifier signal:

void

changed()

See also setToolTip() and showStatusText().

pub unsafe fn set_text(&self, text: impl CastInto<Ref<QString>>)

This property holds the action's descriptive text

Calls C++ function: void QAction::setText(const QString& text).

C++ documentation:

This property holds the action’s descriptive text

If the action is added to a menu, the menu option will consist of the icon (if there is one), the text, and the shortcut (if there is one). If the text is not explicitly set in the constructor, or by using setText(), the action's description icon text will be used as text. There is no default text.

Access functions:

QString	text() const
void	setText(const QString &text)

Notifier signal:

void

changed()

See also iconText.

pub unsafe fn set_tool_tip(&self, tip: impl CastInto<Ref<QString>>)

This property holds the action's tooltip

Calls C++ function: void QAction::setToolTip(const QString& tip).

C++ documentation:

This property holds the action’s tooltip

This text is used for the tooltip. If no tooltip is specified, the action's text is used.

By default, this property contains the action's text.

Access functions:

QString	toolTip() const
void	setToolTip(const QString &tip)

Notifier signal:

void

changed()

See also setStatusTip() and setShortcut().

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

This property holds whether the action can be seen (e.g. in menus and toolbars)

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

C++ documentation:

This property holds whether the action can be seen (e.g. in menus and toolbars)

If visible is true the action can be seen (e.g. in menus and toolbars) and chosen by the user; if visible is false the action cannot be seen or chosen by the user.

Actions which are not visible are not grayed out; they do not appear at all.

By default, this property is true (actions are visible).

Access functions:

bool	isVisible() const
void	setVisible(bool)

Notifier signal:

void

changed()

pub unsafe fn set_whats_this(&self, what: impl CastInto<Ref<QString>>)

This property holds the action's "What's This?" help text

Calls C++ function: void QAction::setWhatsThis(const QString& what).

C++ documentation:

This property holds the action’s “What’s This?” help text

The "What's This?" text is used to provide a brief description of the action. The text may contain rich text. There is no default "What's This?" text.

Access functions:

QString	whatsThis() const
void	setWhatsThis(const QString &what)

Notifier signal:

void

changed()

See also QWhatsThis.

pub unsafe fn shortcut(&self) -> CppBox<QKeySequence>

This property holds the action's primary shortcut key

Calls C++ function: QKeySequence QAction::shortcut() const.

C++ documentation:

This property holds the action’s primary shortcut key

Valid keycodes for this property can be found in Qt::Key and Qt::Modifier. There is no default shortcut key.

Access functions:

QKeySequence	shortcut() const
void	setShortcut(const QKeySequence &shortcut)

Notifier signal:

void

changed()

pub unsafe fn shortcut_context(&self) -> ShortcutContext

This property holds the context for the action's shortcut

Calls C++ function: Qt::ShortcutContext QAction::shortcutContext() const.

C++ documentation:

This property holds the context for the action’s shortcut

Valid values for this property can be found in Qt::ShortcutContext. The default value is Qt::WindowShortcut.

Access functions:

Qt::ShortcutContext	shortcutContext() const
void	setShortcutContext(Qt::ShortcutContext context)

Notifier signal:

void

changed()

pub unsafe fn shortcuts(&self) -> CppBox<QListOfQKeySequence>

Returns the list of shortcuts, with the primary shortcut as the first element of the list.

Calls C++ function: QList<QKeySequence> QAction::shortcuts() const.

C++ documentation:

Returns the list of shortcuts, with the primary shortcut as the first element of the list.

This function was introduced in Qt 4.2.

See also setShortcuts().

pub unsafe fn show_status_text_1a( &self, widget: impl CastInto<Ptr<QWidget>>, ) -> bool

Updates the relevant status bar for the widget specified by sending a QStatusTipEvent to its parent widget. Returns true if an event was sent; otherwise returns false.

Calls C++ function: bool QAction::showStatusText(QWidget* widget = …).

C++ documentation:

Updates the relevant status bar for the widget specified by sending a QStatusTipEvent to its parent widget. Returns true if an event was sent; otherwise returns false.

If a null widget is specified, the event is sent to the action's parent.

See also statusTip.

pub unsafe fn show_status_text_0a(&self) -> bool

Updates the relevant status bar for the widget specified by sending a QStatusTipEvent to its parent widget. Returns true if an event was sent; otherwise returns false.

Calls C++ function: bool QAction::showStatusText().

C++ documentation:

Updates the relevant status bar for the widget specified by sending a QStatusTipEvent to its parent widget. Returns true if an event was sent; otherwise returns false.

If a null widget is specified, the event is sent to the action's parent.

See also statusTip.

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

Returns a reference to the staticMetaObject field.

pub unsafe fn status_tip(&self) -> CppBox<QString>

This property holds the action's status tip

Calls C++ function: QString QAction::statusTip() const.

C++ documentation:

This property holds the action’s status tip

The status tip is displayed on all status bars provided by the action's top-level parent widget.

By default, this property contains an empty string.

Access functions:

QString	statusTip() const
void	setStatusTip(const QString &statusTip)

Notifier signal:

void

changed()

See also setToolTip() and showStatusText().

pub unsafe fn text(&self) -> CppBox<QString>

This property holds the action's descriptive text

Calls C++ function: QString QAction::text() const.

C++ documentation:

This property holds the action’s descriptive text

If the action is added to a menu, the menu option will consist of the icon (if there is one), the text, and the shortcut (if there is one). If the text is not explicitly set in the constructor, or by using setText(), the action's description icon text will be used as text. There is no default text.

Access functions:

QString	text() const
void	setText(const QString &text)

Notifier signal:

void

changed()

See also iconText.

pub unsafe fn toggle(&self)

This is a convenience function for the checked property. Connect to it to change the checked state to its opposite state.

Calls C++ function: [slot] void QAction::toggle().

C++ documentation:

This is a convenience function for the checked property. Connect to it to change the checked state to its opposite state.

pub unsafe fn tool_tip(&self) -> CppBox<QString>

This property holds the action's tooltip

Calls C++ function: QString QAction::toolTip() const.

C++ documentation:

This property holds the action’s tooltip

This text is used for the tooltip. If no tooltip is specified, the action's text is used.

By default, this property contains the action's text.

Access functions:

QString	toolTip() const
void	setToolTip(const QString &tip)

Notifier signal:

void

changed()

See also setStatusTip() and setShortcut().

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

Calls C++ function: static QString QAction::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 QAction::trUtf8(const char* s, const char* c, int n).

pub unsafe fn trigger(&self)

This is a convenience slot that calls activate(Trigger).

Calls C++ function: [slot] void QAction::trigger().

C++ documentation:

This is a convenience slot that calls activate(Trigger).

pub unsafe fn whats_this(&self) -> CppBox<QString>

This property holds the action's "What's This?" help text

Calls C++ function: QString QAction::whatsThis() const.

C++ documentation:

This property holds the action’s “What’s This?” help text

The "What's This?" text is used to provide a brief description of the action. The text may contain rich text. There is no default "What's This?" text.

Access functions:

QString	whatsThis() const
void	setWhatsThis(const QString &what)

Notifier signal:

void

changed()

See also QWhatsThis.

Methods from Deref<Target = QObject>

pub unsafe fn find_child<T>( &self, name: &str, ) -> Result<QPtr<T>, FindChildError>

where QObject: DynamicCast<T>, T: StaticUpcast<QObject>,

Finds a child of self with the specified object name and casts it to type T.

The search is performed recursively. If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned.

Returns an error if there is no child object with object name name or the found object cannot be cast to T.

pub fn destroyed(&self) -> Signal<(*mut QObject,)>

This signal is emitted immediately before the object obj is destroyed, and can not be blocked.

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

C++ documentation:

This signal is emitted immediately before the object obj is destroyed, and can not be blocked.

All the objects's children are destroyed immediately after this signal is emitted.

See also deleteLater() and QPointer.

pub fn object_name_changed(&self) -> Signal<(*const QString,)>

This signal is emitted after the object's name has been changed. The new object name is passed as objectName.

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

C++ documentation:

This signal is emitted after the object’s name has been changed. The new object name is passed as objectName.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

Note: Notifier signal for property objectName.

See also QObject::objectName.

pub fn slot_delete_later(&self) -> Receiver<()>

Schedules this object for deletion.

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

C++ documentation:

Schedules this object for deletion.

The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.

Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.

Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.

See also destroyed() and QPointer.

pub unsafe fn block_signals(&self, b: bool) -> bool

If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.

Calls C++ function: bool QObject::blockSignals(bool b).

C++ documentation:

If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.

The return value is the previous value of signalsBlocked().

Note that the destroyed() signal will be emitted even if the signals for this object have been blocked.

Signals emitted while being blocked are not buffered.

See also signalsBlocked() and QSignalBlocker.

pub unsafe fn children(&self) -> Ref<QListOfQObject>

Returns a list of child objects. The QObjectList class is defined in the <QObject> header file as the following:

Calls C++ function: const QList<QObject*>& QObject::children() const.

C++ documentation:

Returns a list of child objects. The QObjectList class is defined in the <QObject> header file as the following:

  typedef QList<QObject*> QObjectList;

The first child added is the first object in the list and the last child added is the last object in the list, i.e. new children are appended at the end.

Note that the list order changes when QWidget children are raised or lowered. A widget that is raised becomes the last object in the list, and a widget that is lowered becomes the first object in the list.

See also findChild(), findChildren(), parent(), and setParent().

pub unsafe fn delete_later(&self)

Schedules this object for deletion.

Calls C++ function: [slot] void QObject::deleteLater().

C++ documentation:

Schedules this object for deletion.

The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.

Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.

Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.

See also destroyed() and QPointer.

pub unsafe fn disconnect_char_q_object_char( &self, signal: *const i8, receiver: impl CastInto<Ptr<QObject>>, member: *const i8, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const char* signal = …, const QObject* receiver = …, const char* member = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect_q_object_char( &self, receiver: impl CastInto<Ptr<QObject>>, member: *const i8, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const QObject* receiver, const char* member = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects all signals in this object from receiver's method.

A signal-slot connection is removed when either of the objects involved are destroyed.

pub unsafe fn disconnect_char_q_object( &self, signal: *const i8, receiver: impl CastInto<Ptr<QObject>>, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const char* signal = …, const QObject* receiver = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect_char(&self, signal: *const i8) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const char* signal = …) const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect(&self) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect() const.

C++ documentation:

This function overloads disconnect().

Disconnects signal from method of receiver.

A signal-slot connection is removed when either of the objects involved are destroyed.

Note: This function is thread-safe.

pub unsafe fn disconnect_q_object( &self, receiver: impl CastInto<Ptr<QObject>>, ) -> bool

This function overloads disconnect().

Calls C++ function: bool QObject::disconnect(const QObject* receiver) const.

C++ documentation:

This function overloads disconnect().

Disconnects all signals in this object from receiver's method.

A signal-slot connection is removed when either of the objects involved are destroyed.

pub unsafe fn dump_object_info_mut(&self)

Dumps information about signal connections, etc. for this object to the debug output.

Calls C++ function: void QObject::dumpObjectInfo().

C++ documentation:

Dumps information about signal connections, etc. for this object to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectTree().

pub unsafe fn dump_object_info(&self)

Dumps information about signal connections, etc. for this object to the debug output.

Calls C++ function: void QObject::dumpObjectInfo() const.

C++ documentation:

Dumps information about signal connections, etc. for this object to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectTree().

pub unsafe fn dump_object_tree_mut(&self)

Dumps a tree of children to the debug output.

Calls C++ function: void QObject::dumpObjectTree().

C++ documentation:

Dumps a tree of children to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectInfo().

pub unsafe fn dump_object_tree(&self)

Dumps a tree of children to the debug output.

Calls C++ function: void QObject::dumpObjectTree() const.

C++ documentation:

Dumps a tree of children to the debug output.

Note: before Qt 5.9, this function was not const.

See also dumpObjectInfo().

pub unsafe fn dynamic_property_names(&self) -> CppBox<QListOfQByteArray>

Returns the names of all properties that were dynamically added to the object using setProperty().

Calls C++ function: QList<QByteArray> QObject::dynamicPropertyNames() const.

C++ documentation:

Returns the names of all properties that were dynamically added to the object using setProperty().

This function was introduced in Qt 4.2.

pub unsafe fn eq(&self, p: impl CastInto<Ref<QPointerOfQObject>>) -> bool

Returns true if c1 and c2 are the same Unicode character; otherwise returns false.

Calls C++ function: bool operator==(QObject* o, const QPointer<QObject>& p).

Warning: no exact match found in C++ documentation. Below is the C++ documentation for bool operator==(QChar c1, QChar c2):

Returns true if c1 and c2 are the same Unicode character; otherwise returns false.

pub unsafe fn event(&self, event: impl CastInto<Ptr<QEvent>>) -> bool

This virtual function receives events to an object and should return true if the event e was recognized and processed.

Calls C++ function: virtual bool QObject::event(QEvent* event).

C++ documentation:

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
      Q_OBJECT
public:
      MyClass(QWidget *parent = 0);
      ~MyClass();
      bool event(QEvent* ev)
      {
          if (ev->type() == QEvent::PolishRequest) {
              // overwrite handling of PolishRequest if any
              doThings();
              return true;
          } else  if (ev->type() == QEvent::Show) {
              // complement handling of Show if any
              doThings2();
              QWidget::event(ev);
              return true;
          }
          // Make sure the rest of events are handled
          return QWidget::event(ev);
      }
};

See also installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), and QCoreApplication::postEvent().

pub unsafe fn event_filter( &self, watched: impl CastInto<Ptr<QObject>>, event: impl CastInto<Ptr<QEvent>>, ) -> bool

Filters events if this object has been installed as an event filter for the watched object.

Calls C++ function: virtual bool QObject::eventFilter(QObject* watched, QEvent* event).

C++ documentation:

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
      MainWindow();
protected:
      bool eventFilter(QObject obj, QEvent ev);
private:
      QTextEdit *textEdit;
};
MainWindow::MainWindow()
{
      textEdit = new QTextEdit;
      setCentralWidget(textEdit);
      textEdit->installEventFilter(this);
}
bool MainWindow::eventFilter(QObject obj, QEvent event)
{
      if (obj == textEdit) {
          if (event->type() == QEvent::KeyPress) {
              QKeyEvent keyEvent = static_cast<QKeyEvent>(event);
              qDebug() << “Ate key press” << keyEvent->key();
              return true;
          } else {
              return false;
          }
      } else {
          // pass the event on to the parent class
          return QMainWindow::eventFilter(obj, event);
      }
}

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Warning: If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.

See also installEventFilter().

pub unsafe fn find_child_q_object_2a( &self, a_name: impl CastInto<Ref<QString>>, options: QFlags<FindChildOption>, ) -> QPtr<QObject>

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QObject* QObject::findChild<QObject*>(const QString& aName = …, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.

This example returns a child QPushButton of parentWidget named "button1", even if the button isn't a direct child of the parent:

QPushButton button = parentWidget->findChild<QPushButton >(“button1”);

This example returns a QListWidget child of parentWidget:

QListWidget list = parentWidget->findChild<QListWidget >();

This example returns a child QPushButton of parentWidget (its direct parent) named "button1":

QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);

This example returns a QListWidget child of parentWidget, its direct parent:

QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);

See also findChildren().

pub unsafe fn find_child_q_object_1a( &self, a_name: impl CastInto<Ref<QString>>, ) -> QPtr<QObject>

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QObject* QObject::findChild<QObject*>(const QString& aName = …) const.

C++ documentation:

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.

This example returns a child QPushButton of parentWidget named "button1", even if the button isn't a direct child of the parent:

QPushButton button = parentWidget->findChild<QPushButton >(“button1”);

This example returns a QListWidget child of parentWidget:

QListWidget list = parentWidget->findChild<QListWidget >();

This example returns a child QPushButton of parentWidget (its direct parent) named "button1":

QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);

This example returns a QListWidget child of parentWidget, its direct parent:

QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);

See also findChildren().

pub unsafe fn find_child_q_object_0a(&self) -> QPtr<QObject>

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QObject* QObject::findChild<QObject*>() const.

C++ documentation:

Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.

This example returns a child QPushButton of parentWidget named "button1", even if the button isn't a direct child of the parent:

QPushButton button = parentWidget->findChild<QPushButton >(“button1”);

This example returns a QListWidget child of parentWidget:

QListWidget list = parentWidget->findChild<QListWidget >();

This example returns a child QPushButton of parentWidget (its direct parent) named "button1":

QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);

This example returns a QListWidget child of parentWidget, its direct parent:

QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);

See also findChildren().

pub unsafe fn find_children_q_object_q_string_q_flags_find_child_option( &self, a_name: impl CastInto<Ref<QString>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QString& aName = …, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

The following example shows how to find a list of child QWidgets of the specified parentWidget named widgetname:

QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);

This example returns all QPushButtons that are children of parentWidget:

QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();

This example returns all QPushButtons that are immediate children of parentWidget:

QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);

See also findChild().

pub unsafe fn find_children_q_object_q_reg_exp_q_flags_find_child_option( &self, re: impl CastInto<Ref<QRegExp>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegExp& re, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression regExp, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

pub unsafe fn find_children_q_object_q_regular_expression_q_flags_find_child_option( &self, re: impl CastInto<Ref<QRegularExpression>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegularExpression& re, QFlags<Qt::FindChildOption> options = …) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression re, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

This function was introduced in Qt 5.0.

pub unsafe fn find_children_q_object_q_string( &self, a_name: impl CastInto<Ref<QString>>, ) -> CppBox<QListOfQObject>

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QString& aName = …) const.

C++ documentation:

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

The following example shows how to find a list of child QWidgets of the specified parentWidget named widgetname:

QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);

This example returns all QPushButtons that are children of parentWidget:

QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();

This example returns all QPushButtons that are immediate children of parentWidget:

QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);

See also findChild().

pub unsafe fn find_children_q_object(&self) -> CppBox<QListOfQObject>

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>() const.

C++ documentation:

Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

The following example shows how to find a list of child QWidgets of the specified parentWidget named widgetname:

QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);

This example returns all QPushButtons that are children of parentWidget:

QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();

This example returns all QPushButtons that are immediate children of parentWidget:

QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);

See also findChild().

pub unsafe fn find_children_q_object_q_reg_exp( &self, re: impl CastInto<Ref<QRegExp>>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegExp& re) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression regExp, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

pub unsafe fn find_children_q_object_q_regular_expression( &self, re: impl CastInto<Ref<QRegularExpression>>, ) -> CppBox<QListOfQObject>

This function overloads findChildren().

Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegularExpression& re) const.

C++ documentation:

This function overloads findChildren().

Returns the children of this object that can be cast to type T and that have names matching the regular expression re, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.

This function was introduced in Qt 5.0.

pub unsafe fn inherits(&self, classname: *const i8) -> bool

Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Calls C++ function: bool QObject::inherits(const char* classname) const.

C++ documentation:

Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

A class is considered to inherit itself.

Example:

QTimer *timer = new QTimer;         // QTimer inherits QObject
timer->inherits(“QTimer”);          // returns true
timer->inherits(“QObject”);         // returns true
timer->inherits(“QAbstractButton”); // returns false
// QVBoxLayout inherits QObject and QLayoutItem
QVBoxLayout *layout = new QVBoxLayout;
layout->inherits(“QObject”);        // returns true
layout->inherits(“QLayoutItem”);    // returns true (even though QLayoutItem is not a QObject)

If you need to determine whether an object is an instance of a particular class for the purpose of casting it, consider using qobject_cast<Type *>(object) instead.

See also metaObject() and qobject_cast().

pub unsafe fn install_event_filter( &self, filter_obj: impl CastInto<Ptr<QObject>>, )

Installs an event filter filterObj on this object. For example:

Calls C++ function: void QObject::installEventFilter(QObject* filterObj).

C++ documentation:

Installs an event filter filterObj on this object. For example:

  monitoredObj->installEventFilter(filterObj);

An event filter is an object that receives all events that are sent to this object. The filter can either stop the event or forward it to this object. The event filter filterObj receives events via its eventFilter() function. The eventFilter() function must return true if the event should be filtered, (i.e. stopped); otherwise it must return false.

If multiple event filters are installed on a single object, the filter that was installed last is activated first.

Here's a KeyPressEater class that eats the key presses of its monitored objects:

class KeyPressEater : public QObject
{
      Q_OBJECT
      ...
protected:
      bool eventFilter(QObject obj, QEvent event);
};
bool KeyPressEater::eventFilter(QObject obj, QEvent event)
{
      if (event->type() == QEvent::KeyPress) {
          QKeyEvent keyEvent = static_cast<QKeyEvent >(event);
          qDebug(“Ate key press %d”, keyEvent->key());
          return true;
      } else {
          // standard event processing
          return QObject::eventFilter(obj, event);
      }
}

And here's how to install it on two widgets:

KeyPressEater keyPressEater = new KeyPressEater(this);
QPushButton pushButton = new QPushButton(this);
QListView *listView = new QListView(this);
pushButton->installEventFilter(keyPressEater);
listView->installEventFilter(keyPressEater);

The QShortcut class, for example, uses this technique to intercept shortcut key presses.

Warning: If you delete the receiver object in your eventFilter() function, be sure to return true. If you return false, Qt sends the event to the deleted object and the program will crash.

Note that the filtering object must be in the same thread as this object. If filterObj is in a different thread, this function does nothing. If either filterObj or this object are moved to a different thread after calling this function, the event filter will not be called until both objects have the same thread affinity again (it is not removed).

See also removeEventFilter(), eventFilter(), and event().

pub unsafe fn is_widget_type(&self) -> bool

Returns true if the object is a widget; otherwise returns false.

Calls C++ function: bool QObject::isWidgetType() const.

C++ documentation:

Returns true if the object is a widget; otherwise returns false.

Calling this function is equivalent to calling inherits("QWidget"), except that it is much faster.

pub unsafe fn is_window_type(&self) -> bool

Returns true if the object is a window; otherwise returns false.

Calls C++ function: bool QObject::isWindowType() const.

C++ documentation:

Returns true if the object is a window; otherwise returns false.

Calling this function is equivalent to calling inherits("QWindow"), except that it is much faster.

pub unsafe fn kill_timer(&self, id: i32)

Kills the timer with timer identifier, id.

Calls C++ function: void QObject::killTimer(int id).

C++ documentation:

Kills the timer with timer identifier, id.

The timer identifier is returned by startTimer() when a timer event is started.

See also timerEvent() and startTimer().

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

Returns a pointer to the meta-object of this object.

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

C++ documentation:

Returns a pointer to the meta-object of this object.

A meta-object contains information about a class that inherits QObject, e.g. class name, superclass name, properties, signals and slots. Every QObject subclass that contains the Q_OBJECT macro will have a meta-object.

The meta-object information is required by the signal/slot connection mechanism and the property system. The inherits() function also makes use of the meta-object.

If you have no pointer to an actual object instance but still want to access the meta-object of a class, you can use staticMetaObject.

Example:

QObject *obj = new QPushButton;
obj->metaObject()->className();             // returns “QPushButton”
QPushButton::staticMetaObject.className();  // returns “QPushButton”

See also staticMetaObject.

pub unsafe fn move_to_thread(&self, thread: impl CastInto<Ptr<QThread>>)

Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread.

Calls C++ function: void QObject::moveToThread(QThread* thread).

C++ documentation:

Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread.

To move an object to the main thread, use QApplication::instance() to retrieve a pointer to the current application, and then use QApplication::thread() to retrieve the thread in which the application lives. For example:

myObject->moveToThread(QApplication::instance()->thread());

If targetThread is zero, all event processing for this object and its children stops.

Note that all active timers for the object will be reset. The timers are first stopped in the current thread and restarted (with the same interval) in the targetThread. As a result, constantly moving an object between threads can postpone timer events indefinitely.

A QEvent::ThreadChange event is sent to this object just before the thread affinity is changed. You can handle this event to perform any special processing. Note that any new events that are posted to this object will be handled in the targetThread.

Warning: This function is not thread-safe; the current thread must be same as the current thread affinity. In other words, this function can only "push" an object from the current thread to another thread, it cannot "pull" an object from any arbitrary thread to the current thread.

See also thread().

pub unsafe fn object_name(&self) -> CppBox<QString>

This property holds the name of this object

Calls C++ function: QString QObject::objectName() const.

C++ documentation:

This property holds the name of this object

You can find an object by name (and type) using findChild(). You can find a set of objects with findChildren().

qDebug(“MyClass::setPrecision(): (%s) invalid precision %f”,
         qPrintable(objectName()), newPrecision);

By default, this property contains an empty string.

Access functions:

QString	objectName() const
void	setObjectName(const QString &name)

Notifier signal:

void

objectNameChanged(const QString &objectName)

[see note below]

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also metaObject() and QMetaObject::className().

pub unsafe fn parent(&self) -> QPtr<QObject>

Returns a pointer to the parent object.

Calls C++ function: QObject* QObject::parent() const.

C++ documentation:

Returns a pointer to the parent object.

See also setParent() and children().

pub unsafe fn property(&self, name: *const i8) -> CppBox<QVariant>

Returns the value of the object's name property.

Calls C++ function: QVariant QObject::property(const char* name) const.

C++ documentation:

Returns the value of the object’s name property.

If no such property exists, the returned variant is invalid.

Information about all available properties is provided through the metaObject() and dynamicPropertyNames().

See also setProperty(), QVariant::isValid(), metaObject(), and dynamicPropertyNames().

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

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

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

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

pub unsafe fn remove_event_filter(&self, obj: impl CastInto<Ptr<QObject>>)

Removes an event filter object obj from this object. The request is ignored if such an event filter has not been installed.

Calls C++ function: void QObject::removeEventFilter(QObject* obj).

C++ documentation:

Removes an event filter object obj from this object. The request is ignored if such an event filter has not been installed.

All event filters for this object are automatically removed when this object is destroyed.

It is always safe to remove an event filter, even during event filter activation (i.e. from the eventFilter() function).

See also installEventFilter(), eventFilter(), and event().

pub unsafe fn set_object_name(&self, name: impl CastInto<Ref<QString>>)

This property holds the name of this object

Calls C++ function: void QObject::setObjectName(const QString& name).

C++ documentation:

This property holds the name of this object

You can find an object by name (and type) using findChild(). You can find a set of objects with findChildren().

qDebug(“MyClass::setPrecision(): (%s) invalid precision %f”,
         qPrintable(objectName()), newPrecision);

By default, this property contains an empty string.

Access functions:

QString	objectName() const
void	setObjectName(const QString &name)

Notifier signal:

void

objectNameChanged(const QString &objectName)

[see note below]

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also metaObject() and QMetaObject::className().

pub unsafe fn set_parent(&self, parent: impl CastInto<Ptr<QObject>>)

Makes the object a child of parent.

Calls C++ function: void QObject::setParent(QObject* parent).

C++ documentation:

Makes the object a child of parent.

See also parent() and children().

pub unsafe fn set_property( &self, name: *const i8, value: impl CastInto<Ref<QVariant>>, ) -> bool

Sets the value of the object's name property to value.

Calls C++ function: bool QObject::setProperty(const char* name, const QVariant& value).

C++ documentation:

Sets the value of the object’s name property to value.

If the property is defined in the class using Q_PROPERTY then true is returned on success and false otherwise. If the property is not defined using Q_PROPERTY, and therefore not listed in the meta-object, it is added as a dynamic property and false is returned.

Information about all available properties is provided through the metaObject() and dynamicPropertyNames().

Dynamic properties can be queried again using property() and can be removed by setting the property value to an invalid QVariant. Changing the value of a dynamic property causes a QDynamicPropertyChangeEvent to be sent to the object.

Note: Dynamic properties starting with "_q_" are reserved for internal purposes.

See also property(), metaObject(), dynamicPropertyNames(), and QMetaProperty::write().

pub unsafe fn signals_blocked(&self) -> bool

Returns true if signals are blocked; otherwise returns false.

Calls C++ function: bool QObject::signalsBlocked() const.

C++ documentation:

Returns true if signals are blocked; otherwise returns false.

Signals are not blocked by default.

See also blockSignals() and QSignalBlocker.

pub unsafe fn start_timer_2a(&self, interval: i32, timer_type: TimerType) -> i32

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

Calls C++ function: int QObject::startTimer(int interval, Qt::TimerType timerType = …).

C++ documentation:

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

A timer event will occur every interval milliseconds until killTimer() is called. If interval is 0, then the timer event occurs once every time there are no more window system events to process.

The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events.

If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated.

Example:

class MyObject : public QObject
{
      Q_OBJECT
public:
      MyObject(QObject *parent = 0);
protected:
      void timerEvent(QTimerEvent *event);
};
MyObject::MyObject(QObject *parent)
      : QObject(parent)
{
      startTimer(50);     // 50-millisecond timer
      startTimer(1000);   // 1-second timer
      startTimer(60000);  // 1-minute timer
      using namespace std::chrono;
      startTimer(milliseconds(50));
      startTimer(seconds(1));
      startTimer(minutes(1));
      // since C++14 we can use std::chrono::duration literals, e.g.:
      startTimer(100ms);
      startTimer(5s);
      startTimer(2min);
      startTimer(1h);
}
void MyObject::timerEvent(QTimerEvent *event)
{
      qDebug() << “Timer ID:” << event->timerId();
}

Note that QTimer's accuracy depends on the underlying operating system and hardware. The timerType argument allows you to customize the accuracy of the timer. See Qt::TimerType for information on the different timer types. Most platforms support an accuracy of 20 milliseconds; some provide more. If Qt is unable to deliver the requested number of timer events, it will silently discard some.

The QTimer class provides a high-level programming interface with single-shot timers and timer signals instead of events. There is also a QBasicTimer class that is more lightweight than QTimer and less clumsy than using timer IDs directly.

See also timerEvent(), killTimer(), and QTimer::singleShot().

pub unsafe fn start_timer_1a(&self, interval: i32) -> i32

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

Calls C++ function: int QObject::startTimer(int interval).

C++ documentation:

Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.

A timer event will occur every interval milliseconds until killTimer() is called. If interval is 0, then the timer event occurs once every time there are no more window system events to process.

The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events.

If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated.

Example:

class MyObject : public QObject
{
      Q_OBJECT
public:
      MyObject(QObject *parent = 0);
protected:
      void timerEvent(QTimerEvent *event);
};
MyObject::MyObject(QObject *parent)
      : QObject(parent)
{
      startTimer(50);     // 50-millisecond timer
      startTimer(1000);   // 1-second timer
      startTimer(60000);  // 1-minute timer
      using namespace std::chrono;
      startTimer(milliseconds(50));
      startTimer(seconds(1));
      startTimer(minutes(1));
      // since C++14 we can use std::chrono::duration literals, e.g.:
      startTimer(100ms);
      startTimer(5s);
      startTimer(2min);
      startTimer(1h);
}
void MyObject::timerEvent(QTimerEvent *event)
{
      qDebug() << “Timer ID:” << event->timerId();
}

Note that QTimer's accuracy depends on the underlying operating system and hardware. The timerType argument allows you to customize the accuracy of the timer. See Qt::TimerType for information on the different timer types. Most platforms support an accuracy of 20 milliseconds; some provide more. If Qt is unable to deliver the requested number of timer events, it will silently discard some.

The QTimer class provides a high-level programming interface with single-shot timers and timer signals instead of events. There is also a QBasicTimer class that is more lightweight than QTimer and less clumsy than using timer IDs directly.

See also timerEvent(), killTimer(), and QTimer::singleShot().

pub unsafe fn thread(&self) -> QPtr<QThread>

Returns the thread in which the object lives.

Calls C++ function: QThread* QObject::thread() const.

C++ documentation:

Returns the thread in which the object lives.

See also moveToThread().

Trait Implementations

impl CppDeletable for QAction

unsafe fn delete(&self)

Destroys the object and frees allocated resources.

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

C++ documentation:

Destroys the object and frees allocated resources.

impl Deref for QAction

fn deref(&self) -> &QObject

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

type Target = QObject

The resulting type after dereferencing.

impl DynamicCast<QAction> for QObject

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

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

impl DynamicCast<QWidgetAction> for QAction

unsafe fn dynamic_cast(ptr: Ptr<QAction>) -> Ptr<QWidgetAction>

Calls C++ function: QWidgetAction* dynamic_cast<QWidgetAction*>(QAction* ptr).

impl StaticDowncast<QAction> for QObject

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

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

impl StaticDowncast<QWidgetAction> for QAction

unsafe fn static_downcast(ptr: Ptr<QAction>) -> Ptr<QWidgetAction>

Calls C++ function: QWidgetAction* static_cast<QWidgetAction*>(QAction* ptr).

impl StaticUpcast<QAction> for QWidgetAction

unsafe fn static_upcast(ptr: Ptr<QWidgetAction>) -> Ptr<QAction>

Calls C++ function: QAction* static_cast<QAction*>(QWidgetAction* ptr).

impl StaticUpcast<QObject> for QAction

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

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