Класс QAction

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

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

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

Свойства

• 1 свойство унаследовано от QObject

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

• 34 public functions inherited from QObject

Public Slots

• 1 public slot inherited from QObject

Сигналы

• 2 сигнала унаследованы от QObject

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

• 9 защищённых функций унаследованы от QObject

Дополнительные унаследованные члены

• 1 общедоступная переменная унаследована от QObject
• 10 статические общедоступные члены унаследованы от QObject
• 9 защищённых функций унаследованы от QObject
• 2 защищённые переменные унаследованы от QObject

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

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

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

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

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

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

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

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

    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(QObject *parent = nullptr)

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

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

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

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

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

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

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

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

[virtual] QAction::~QAction()

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

QActionGroup *QAction::actionGroup() const

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

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

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

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

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

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

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

Функция была введена в Qt 4.5.

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

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

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

Функция была введена в Qt 4.2.

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

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

QVariant QAction::data() const

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

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

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

Переопределено из QObject::event().

[slot] void QAction::hover()

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

[signal] void QAction::hovered()

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

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

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

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

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

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 его родительскому виджету. Возвращает true, если событие было отправлено; в противном случае возвращает false.

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

См. также statusTip.

[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.