Класс QAction

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

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

Публичные типы

Свойства

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

Публичные функции

• 31 общедоступные функции, унаследованные от QObject

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

• 1 общедоступный слот, унаследованный от QObject

Сигналы

• 2 сигнала, унаследованные от 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)

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

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

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

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

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

Создаёт действие с 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.