Класс 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 является группой действий, действие будет автоматически добавлено в группу.

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

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

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

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

QAction::QAction(QObject *parent = nullptr)

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

[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

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

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

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

QList<QKeySequence> QAction::shortcuts() const

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

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

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

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

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

См. также statusTip.