QAction Class Reference

 #include <QAction>

     openAct = new QAction(QIcon(":/images/open.png"), tr("&Open..."), this);
     openAct->setShortcuts(QKeySequence::Open);
     openAct->setStatusTip(tr("Open an existing file"));
     connect(openAct, SIGNAL(triggered()), this, SLOT(open()));

     fileMenu->addAction(openAct);
     fileToolBar->addAction(openAct);

Property Documentation

autoRepeat : bool

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

checkable : bool

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

checked : bool

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.

enabled : bool

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.

font : QFont

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.

icon : QIcon

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.

On Symbian the icons which are passed to softkeys, i.e. to actions with softkey role, need to have pixmap alpha channel correctly set otherwise drawing artifacts will appear when softkey is pressed down.

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

iconText : QString

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

iconVisibleInMenu : bool

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 QApplication::setAttribute().

menuRole : MenuRole

This property holds the action's menu role.

This indicates what role the action serves in the application menu on Mac OS X. By default all action 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 Mac OS X (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 ()

priority : Priority

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 )

shortcut : QKeySequence

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

shortcutContext : Qt::ShortcutContext

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

softKeyRole : SoftKeyRole

This property holds the action's softkey role.

This indicates what type of role this action describes in the softkey framework on platforms where such a framework is supported. Currently this is only supported on the Symbian platform.

The softkey role can be changed any time.

This property was introduced in Qt 4.6.

Access functions:

SoftKeyRole	softKeyRole () const
void	setSoftKeyRole ( SoftKeyRole softKeyRole )

Notifier signal:

void	changed ()

statusTip : QString

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

text : QString

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.

toolTip : QString

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

visible : bool

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

whatsThis : QString

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 and Q3StyleSheet.