Класс QAction

Класс QAction предоставляет абстрактное действие пользовательского интерфейса, которое можно вставить в виджеты. Подробнее...

• Список всех членов, включая унаследованные

Открытые типы

Свойства

Открытые функции

Public Slots

Signals

Реализованные защищённые функции

Подробное описание

Во многих приложениях многие распространённые команды могут быть вызваны через меню, кнопки панели инструментов и сочетания клавиш. Поскольку пользователь ожидает, что каждая команда будет выполняться одинаково независимо от используемого пользовательского интерфейса, полезно представлять каждую команду как действие.

Действия могут быть добавлены в меню и панели инструментов и будут автоматически синхронизироваться. Например, в текстовом редакторе, если пользователь нажмёт кнопку «Жирный» на панели инструментов, элемент меню «Жирный» будет автоматически отмечен.

Действия могут создаваться как независимые объекты, но они также могут быть созданы во время построения меню; класс QMenu содержит удобные функции для создания действий, подходящих для использования в качестве пунктов меню.

Объект QAction может содержать значок, текст меню, сочетание клавиш, текст состояния, текст «Что это?», и всплывающую подсказку. Большинство из них могут быть заданы в конструкторе. Они также могут быть заданы независимо с помощью setIcon(), setText(), setIconText(), setShortcut(), setStatusTip(), setWhatsThis(), и setToolTip(). Для пунктов меню можно задать отдельный шрифт с помощью setFont().

Действия добавляются к виджетам с помощью QWidget::addAction() или QGraphicsWidget::addAction(). Обратите внимание, что действие должно быть добавлено к виджету перед его использованием; это также верно, когда сочетание клавиш должно быть глобальным (т. е. Qt::ApplicationShortcut как Qt::ShortcutContext).

После создания действия QAction его следует добавить в соответствующее меню и панель инструментов, а затем подключить к слоту, который выполнит действие. Например:

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

Рекомендуется создавать действия как дочерние элементы окна, в котором они используются. В большинстве случаев действия будут дочерними элементами главного окна приложения.

См. также QMenu, QToolBar и Пример приложения.

Документация по типам членов

перечисление QAction::ActionEvent

Этот тип перечисления используется при вызове QAction::activate()

перечисление QAction::MenuRole

Это перечисление описывает, как действие должно быть перемещено в меню приложения на macOS.

Установка этого значения имеет эффект только для элементов, которые находятся в непосредственных меню панели меню, а не в подменю этих меню. Например, если у вас есть меню «Файл» в вашей панели меню, и меню «Файл» имеет подменю, установка MenuRole для действий в этом подменю не имеет эффекта. Они никогда не будут перемещены.

перечисление QAction::Priority

Это перечисление определяет приоритеты действий в пользовательском интерфейсе.

Это перечисление было добавлено или изменено в Qt 4.6.

См. также priority.

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.

Документация по членам функций

QAction::QAction(const QIcon &icon, const QString &text, QObject *parent = nullptr)

Создаёт действие с иконкой, некоторым текстом и родителем. Если родитель является группой действий, действие будет автоматически вставлено в группу.

Действие использует упрощённую версию текста (например, «&Вариант меню…» становится «Вариант меню») в качестве описательного текста для кнопок инструментов. Вы можете переопределить это, задав конкретное описание с помощью setText(). Тот же текст будет использоваться для всплывающих подсказок, если вы не укажете другой текст с помощью setToolTip().

QAction::QAction(const QString &text, QObject *parent = nullptr)

Создаёт действие с некоторым текстом и родителем. Если родитель является группой действий, действие будет автоматически вставлено в группу.

Действие использует упрощённую версию текста (например, «&Вариант меню…» становится «Вариант меню») в качестве описательного текста для кнопок инструментов. Вы можете переопределить это, задав конкретное описание с помощью setText(). Тот же текст будет использоваться для всплывающих подсказок, если вы не укажете другой текст с помощью setToolTip().

QAction::QAction(QObject *parent = nullptr)

Создаёт действие с родителем. Если родитель является группой действий, действие будет автоматически вставлено в группу.

Примечание: Аргумент parent является необязательным начиная с Qt 5.7.

[signal] void QAction::changed()

Этот сигнал испускается, когда действие изменилось. Если вас интересуют только действия в заданном виджете, вы можете проследить за QWidget::actionEvent(), отправленным с QEvent::ActionChanged.

Примечание: Сигнал-уведомление для свойства autoRepeat. Сигнал-уведомление для свойства checkable. Сигнал-уведомление для свойства enabled. Сигнал-уведомление для свойства font. Сигнал-уведомление для свойства icon. Сигнал-уведомление для свойства iconText. Сигнал-уведомление для свойства iconVisibleInMenu. Сигнал-уведомление для свойства menuRole. Сигнал-уведомление для свойства shortcut. Сигнал-уведомление для свойства shortcutContext. Сигнал-уведомление для свойства shortcutVisibleInContextMenu. Сигнал-уведомление для свойства statusTip. Сигнал-уведомление для свойства text. Сигнал-уведомление для свойства toolTip. Сигнал-уведомление для свойства visible. Сигнал-уведомление для свойства whatsThis.

См. также QWidget::actionEvent().

[slot] void QAction::hover()

Это вспомогательный слот, вызывающий activate(Hover).

[signal] void QAction::hovered()

Этот сигнал испускается, когда действие выделяется пользователем; например, когда пользователь останавливает курсор над элементом меню, кнопкой на панели инструментов или нажимает комбинацию клавиш быстрого вызова действия.

См. также QAction::activate().

[slot] void QAction::setDisabled(bool b)

Это вспомогательная функция для свойства enabled, которая полезна для соединений сигналов—слотов. Если b истинно, действие отключается; в противном случае — включается.

[slot] void QAction::toggle()

Это вспомогательная функция для свойства checked. Подключитесь к ней, чтобы изменить состояние выбора на противоположное.

[signal] void QAction::toggled(bool checked)

Этот сигнал испускается всякий раз, когда изменяется состояние выбора действия isChecked(). Это может быть результатом взаимодействия пользователя или вызова setChecked(). Поскольку setChecked() изменяет QAction, он испускает changed() в дополнение к toggled().

checked — true, если действие выбрано, или false, если действие не выбрано.

Примечание: Сигнал-уведомление для свойства checked.

См. также QAction::activate(), QAction::triggered() и checked.

[slot] void QAction::trigger()

Это вспомогательный слот, вызывающий activate(Trigger).

[signal] void QAction::triggered(bool checked = false)

Этот сигнал испускается, когда действие активируется пользователем; например, когда пользователь нажимает элемент меню, кнопку на панели инструментов или комбинацию клавиш быстрого вызова действия или когда был вызван trigger(). Обратите внимание, что он не испускается, когда вызывается setChecked() или toggle().

Если действие может быть выбрано, checked — true, если действие выбрано, или false, если действие не выбрано.

См. также QAction::activate(), QAction::toggled() и checked.

[virtual] QAction::~QAction()

Удаляет объект и освобождает выделенные ресурсы.

QActionGroup *QAction::actionGroup() const

Возвращает группу действий для этого действия. Если ни одна группа действий не управляет этим действием, возвращается 0.

См. также QActionGroup и QAction::setActionGroup().

void QAction::activate(QAction::ActionEvent event)

Отправляет соответствующие сигналы для ActionEvent event.

Виджеты на основе действий используют этот API, чтобы заставить QAction испускать сигналы, а также испускать свои собственные.

QList<QGraphicsWidget *> QAction::associatedGraphicsWidgets() const

Возвращает список виджетов, к которым было добавлено это действие.

Эта функция была добавлена в Qt 4.5.

См. также QWidget::addAction() и associatedWidgets().

QList<QWidget *> QAction::associatedWidgets() const

Возвращает список виджетов, к которым было добавлено это действие.

Эта функция была добавлена в Qt 4.2.

См. также QWidget::addAction() и associatedGraphicsWidgets().

QVariant QAction::data() const

Возвращает пользовательские данные, заданные в QAction::setData.

См. также setData().

[override virtual protected] bool QAction::event(QEvent *e)

Переопределяет: QObject::event(QEvent *e).

bool QAction::isSeparator() const

Возвращает true , если это действие — действие разделителя; в противном случае возвращает false.

См. также QAction::setSeparator().

QMenu *QAction::menu() const

Возвращает меню, содержащееся в этом действии. Действия, содержащие меню, могут использоваться для создания пунктов меню с подменю или вставляться в панели инструментов для создания кнопок с выпадающими меню.

См. также setMenu() и QMenu::addAction().

QWidget *QAction::parentWidget() const

Возвращает родительский виджет.

void QAction::setActionGroup(QActionGroup *group)

Устанавливает эту группу действий для group. Действие будет автоматически добавлено в список действий группы.

Действия в группе будут взаимно исключать друг друга.

См. также QActionGroup и QAction::actionGroup().

void QAction::setData(const QVariant &userData)

Устанавливает внутренние данные действия в указанные userData.

См. также data().

void QAction::setMenu(QMenu *menu)

Устанавливает меню, содержащееся в этом действии, на указанное menu.

См. также menu().

void QAction::setSeparator(bool b)

Если b истинно, это действие будет рассматриваться как разделитель.

Способ представления разделителя зависит от виджета, в который он вставлен. В большинстве случаев текст, подменю и значок будут игнорироваться для действий-разделителей.

См. также QAction::isSeparator().

void QAction::setShortcuts(const QList<QKeySequence> &shortcuts)

Устанавливает shortcuts в качестве списка сокращений, которые вызывают действие. Первый элемент списка — это основное сокращение.

Эта функция была добавлена в Qt 4.2.

См. также shortcuts() и shortcut.

void QAction::setShortcuts(QKeySequence::StandardKey key)

Устанавливает зависящий от платформы список сокращений, основанный на key. Результат вызова этой функции зависит от текущей платформы. Обратите внимание, что это действие может назначить более одного сокращения. Если требуется только основное сокращение, используйте setShortcut вместо этого.

Эта функция была добавлена в Qt 4.2.

См. также QKeySequence::keyBindings().

QKeySequence QAction::shortcut() const

Возвращает основное сокращение.

Примечание: Функция-геттер для свойства shortcut.

См. также setShortcuts().

QList<QKeySequence> QAction::shortcuts() const

Возвращает список сокращений, где основное сокращение является первым элементом списка.

Эта функция была добавлена в Qt 4.2.

См. также setShortcuts().

bool QAction::showStatusText(QWidget *widget = nullptr)

Обновляет соответствующую строку состояния для widget, отправляя QStatusTipEvent родительскому элементу widget. Возвращает true, если событие было отправлено; в противном случае возвращает false.

Если указан нулевой widget, событие отправляется родителю действия.

См. также statusTip.