Класс QAction

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

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

Общедоступные типы

Свойства

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

Общедоступные функции

• 32 public functions inherited from QObject

Public Slots

• 1 public slot inherited from QObject

Сигналы

• 2 signals inherited from QObject

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

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

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

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

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

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

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

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

Действия можно создавать как независимые объекты, но их также можно создавать во время создания меню; класс 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);

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

QAction::~QAction()

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

QActionGroup *QAction::actionGroup() const

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

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

void QAction::activate(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().

[signal] void QAction::changed()

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

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

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

QVariant QAction::data() const

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

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

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

void QAction::setMenu(QMenu *menu)

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

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

void QAction::setSeparator(bool b)

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

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

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

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

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

См. также statusTip.

[slot] void QAction::toggle()

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

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

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

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.