Класс QAction

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

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

Типы

Свойства

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

Публичные слоты

Сигналы

Переопределённые защищённые функции

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

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

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

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

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

QAction в приложениях с виджетами

После создания 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);

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

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

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

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

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

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

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

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

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

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

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

См. также 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)

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

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

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

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

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

QAction::QAction(QObject *parent = nullptr)

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

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

[signal] void QAction::changed()

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

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

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

[slot] void QAction::hover()

Это удобный слот, который вызывает activate(Hover).

[signal] void QAction::hovered()

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

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

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

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

[slot] void QAction::toggle()

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

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

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

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

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

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

[slot] void QAction::trigger()

Это удобный слот, который вызывает activate(Trigger).

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

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

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

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

[virtual] QAction::~QAction()

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

QActionGroup *QAction::actionGroup() const

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

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

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

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

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

[since 6.0] QList<QObject *> QAction::associatedObjects() const

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

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

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

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.

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

void QAction::setActionGroup(QActionGroup *group)

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

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

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

void QAction::setData(const QVariant &data)

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

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

void QAction::setSeparator(bool b)

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

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

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

void QAction::setShortcut(const QKeySequence &shortcut)

Устанавливает shortcut как единственное сочетание клавиш, которое активирует действие.

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

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

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

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

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

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

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

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

QKeySequence QAction::shortcut() const

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

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

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

QList<QKeySequence> QAction::shortcuts() const

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

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

bool QAction::showStatusText(QObject *object = nullptr)

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

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

См. также statusTip.