Класс 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)

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

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

QAction::QAction(const QString &текст, QObject *родитель = nullptr)

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

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

QAction::QAction(QObject *родитель = nullptr)

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

Примечание: Аргумент родитель является необязательным начиная с 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 истинно, если действие выбрано, или ложно, если действие не выбрано.

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

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

[slot] void QAction::trigger()

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

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

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

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

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