QMenu Class

Documentation des fonctions membres

[explicit] QMenu::QMenu(QWidget *parent = nullptr)

Construit un menu avec le parent parent.

Bien qu'un menu contextuel soit toujours un widget de premier niveau, si un parent est transmis, le menu contextuel sera supprimé lorsque ce parent sera détruit (comme pour tout autre QObject).

[explicit] QMenu::QMenu(const QString &title, QWidget *parent = nullptr)

Construit un menu avec un title et un parent.

Bien qu'un menu contextuel soit toujours un widget de premier niveau, si un parent est transmis, le menu contextuel sera supprimé lorsque ce parent sera détruit (comme pour tout autre QObject).

Voir également title.

[virtual noexcept] QMenu::~QMenu()

Détruit le menu.

[signal] void QMenu::aboutToHide()

Ce signal est émis juste avant que le menu ne soit caché à l'utilisateur.

Voir aussi aboutToShow() et hide().

[signal] void QMenu::aboutToShow()

Ce signal est émis juste avant que le menu ne soit montré à l'utilisateur.

Voir aussi aboutToHide() et show().

QAction *QMenu::actionAt(const QPoint &pt) const

Renvoie l'élément à pt; renvoie nullptr s'il n'y a pas d'élément à cet endroit.

[override virtual protected] void QMenu::actionEvent(QActionEvent *e)

Réimplémente : QWidget::actionEvent(QActionEvent *event).

QRect QMenu::actionGeometry(QAction *act) const

Renvoie la géométrie de l'action act.

QAction *QMenu::activeAction() const

Renvoie l'action actuellement mise en évidence, ou nullptr si aucune action n'est actuellement mise en évidence.

Voir également setActiveAction().

QAction *QMenu::addMenu(QMenu *menu)

Cette fonction de commodité ajoute menu comme sous-menu à ce menu. Elle renvoie menu's menuAction(). Ce menu n'est pas propriétaire de menu.

Voir aussi QWidget::addAction() et QMenu::menuAction().

QMenu *QMenu::addMenu(const QString &title)

Ajoute un nouveau QMenu avec title au menu. Le menu devient propriétaire du menu. Retourne le nouveau menu.

Voir aussi QWidget::addAction() et QMenu::menuAction().

QMenu *QMenu::addMenu(const QIcon &icon, const QString &title)

Ajoute au menu un nouveau QMenu avec icon et title. Le menu devient propriétaire du menu. Retourne le nouveau menu.

Voir aussi QWidget::addAction() et QMenu::menuAction().

QAction *QMenu::addSection(const QString &text)

Cette fonction de commodité crée une nouvelle action de section, c'est-à-dire une action avec QAction::isSeparator() retournant true mais ayant également text hint, et ajoute la nouvelle action à la liste des actions de ce menu. Elle renvoie l'action nouvellement créée.

Le rendu de l'indice dépend du style et de la plate-forme. Les styles de widgets peuvent utiliser les informations textuelles dans le rendu des sections, ou peuvent choisir de les ignorer et de rendre les sections comme de simples séparateurs.

QMenu prend la propriété de l'objet retourné QAction.

Voir également QWidget::addAction().

QAction *QMenu::addSection(const QIcon &icon, const QString &text)

Cette fonction de commodité crée une nouvelle action de section, c'est-à-dire une action avec QAction::isSeparator() retournant true mais ayant également des indices text et icon, et ajoute la nouvelle action à la liste des actions de ce menu. Il renvoie l'action nouvellement créée.

Le rendu des indices dépend du style et de la plate-forme. Les styles de widgets peuvent utiliser les informations relatives au texte et à l'icône dans le rendu des sections, ou peuvent choisir de les ignorer et de rendre les sections comme de simples séparateurs.

QMenu prend la propriété de l'objet retourné QAction.

Voir également QWidget::addAction().

QAction *QMenu::addSeparator()

Cette fonction de commodité crée une nouvelle action de séparation, c'est-à-dire une action dont QAction::isSeparator() renvoie true, et ajoute la nouvelle action à la liste des actions de ce menu. Elle renvoie l'action nouvellement créée.

QMenu prend possession de l'action retournée QAction.

Voir aussi QWidget::addAction().

[override virtual protected] void QMenu::changeEvent(QEvent *e)

Réimplémente : QWidget::changeEvent(QEvent *event).

void QMenu::clear()

Supprime toutes les actions du menu. Les actions appartenant au menu et n'apparaissant dans aucun autre widget sont supprimées.

Voir également removeAction().

[protected] int QMenu::columnCount() const

Si un menu ne tient pas sur l'écran, il se présente de lui-même de manière à ce qu'il tienne sur l'écran. La définition de la disposition dépend du style (par exemple, sous Windows, il utilisera plusieurs colonnes).

Cette fonction renvoie le nombre de colonnes nécessaires.

QAction *QMenu::defaultAction() const

Renvoie l'action par défaut actuelle.

Voir aussi setDefaultAction().

[override virtual protected] void QMenu::enterEvent(QEnterEvent *)

Réimplémente : QWidget::enterEvent(QEnterEvent *event).

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

Réimplémente : QWidget::event(QEvent *event).

QAction *QMenu::exec()

Exécute ce menu de manière synchrone.

Cela équivaut à exec(pos()).

Cela renvoie l'élément déclenché QAction dans le menu contextuel ou l'un de ses sous-menus, ou nullptr si aucun élément n'a été déclenché (normalement parce que l'utilisateur a appuyé sur Echap).

Dans la plupart des cas, vous voudrez spécifier vous-même la position, par exemple la position actuelle de la souris :

exec(QCursor::pos());

ou alignée sur un widget :

exec(somewidget.mapToGlobal(QPoint(0,0)));

ou en réaction à un QMouseEvent *e :

exec(e->globalPosition().toPoint());

QAction *QMenu::exec(const QPoint &p, QAction *action = nullptr)

Exécute ce menu de manière synchrone.

Ouvre le menu de sorte que l'action action se trouve à la position globale spécifiée p. Pour traduire les coordonnées locales d'un widget en coordonnées globales, utilisez QWidget::mapToGlobal().

Cette action renvoie l'élément déclenché QAction dans le menu contextuel ou l'un de ses sous-menus, ou nullptr si aucun élément n'a été déclenché (normalement parce que l'utilisateur a appuyé sur Esc).

Notez que tous les signaux sont émis comme d'habitude. Si vous connectez un QAction à un slot et que vous appelez exec() du menu, vous obtenez le résultat à la fois via la connexion signal-slot et dans la valeur de retour de exec().

L'usage courant est de positionner le menu à la position actuelle de la souris :

exec(QCursor::pos());

ou aligné sur un widget :

exec(somewidget.mapToGlobal(QPoint(0, 0)));

ou en réaction à un QMouseEvent *e :

exec(e->globalPosition().toPoint());

Lorsque vous positionnez un menu avec exec() ou popup(), n'oubliez pas que vous ne pouvez pas vous fier à la position actuelle du menu size(). Pour des raisons de performance, le menu n'adapte sa taille qu'en cas de nécessité. Par conséquent, dans de nombreux cas, la taille avant et après le spectacle est différente. Utilisez plutôt sizeHint() qui calcule la taille appropriée en fonction du contenu actuel du menu.

Voir également popup() et QWidget::mapToGlobal().

[static] QAction *QMenu::exec(const QList<QAction *> &actions, const QPoint &pos, QAction *at = nullptr, QWidget *parent = nullptr)

Exécute un menu de manière synchrone.

Les actions du menu sont spécifiées par la liste actions. Le menu s'ouvre de sorte que l'action spécifiée, at, apparaisse à la position globale pos. Si at n'est pas spécifié, le menu apparaît à la position pos. parent est le widget parent du menu ; la spécification du parent fournit un contexte lorsque pos ne suffit pas à décider de l'emplacement du menu (par exemple, en cas de bureaux multiples ou lorsque le parent est incorporé dans QGraphicsView).

La fonction renvoie l'élément déclenché QAction dans le menu contextuel ou l'un de ses sous-menus, ou nullptr si aucun élément n'a été déclenché (normalement parce que l'utilisateur a appuyé sur Esc).

Cela équivaut à :

QMenu menu;
QAction *at = actions[0]; // Assumes actions is not empty
for (QAction *a : std::as_const(actions))
    menu.addAction(a);
menu.exec(pos, at);

Voir aussi popup() et QWidget::mapToGlobal().

[override virtual protected] bool QMenu::focusNextPrevChild(bool next)

Réimplémente : QWidget::focusNextPrevChild(bool next).

[override virtual protected] void QMenu::hideEvent(QHideEvent *)

Réimplémente : QWidget::hideEvent(QHideEvent *event).

void QMenu::hideTearOffMenu()

Cette fonction permet de cacher de force le menu arraché et de le faire disparaître du bureau de l'utilisateur.

Voir aussi showTearOffMenu(), isTearOffMenuVisible() et isTearOffEnabled().

[signal] void QMenu::hovered(QAction *action)

Ce signal est émis lorsqu'une action de menu est mise en évidence ; action est l'action qui a provoqué l'émission du signal.

Ce signal est souvent utilisé pour mettre à jour les informations d'état.

Voir également triggered() et QAction::hovered().

[virtual protected] void QMenu::initStyleOption(QStyleOptionMenuItem *option, const QAction *action) const

Initialiser option avec les valeurs de ce menu et les informations de action. Cette méthode est utile pour les sous-classes lorsqu'elles ont besoin d'un QStyleOptionMenuItem, mais qu'elles ne veulent pas remplir toutes les informations elles-mêmes.

Voir aussi QStyleOption::initFrom() et QMenuBar::initStyleOption().

QAction *QMenu::insertMenu(QAction *before, QMenu *menu)

Cette fonction de commodité insère menu avant l'action before et renvoie les menus menuAction().

Voir aussi QWidget::insertAction() et addMenu().

QAction *QMenu::insertSection(QAction *before, const QString &text)

Cette fonction de commodité crée une nouvelle action de titre, c'est-à-dire une action avec QAction::isSeparator() retournant true mais ayant également text hint. La fonction insère l'action nouvellement créée dans la liste des actions de ce menu avant l'action before et la renvoie.

Le rendu de l'indice dépend du style et de la plate-forme. Les styles de widgets peuvent utiliser les informations textuelles dans le rendu des sections, ou peuvent choisir de les ignorer et de rendre les sections comme de simples séparateurs.

QMenu prend possession de l'objet retourné QAction.

Voir aussi QWidget::insertAction() et addSection().

QAction *QMenu::insertSection(QAction *before, const QIcon &icon, const QString &text)

Cette fonction de commodité crée une nouvelle action de titre, c'est-à-dire une action avec QAction::isSeparator() retournant true mais ayant également des indices text et icon. La fonction insère l'action nouvellement créée dans la liste des actions de ce menu avant l'action before et la renvoie.

Le rendu des indices dépend du style et de la plate-forme. Les styles de widgets peuvent utiliser le texte et les informations sur les icônes dans le rendu des sections, ou peuvent choisir de les ignorer et de rendre les sections comme de simples séparateurs.

QMenu prend possession de l'objet retourné QAction.

Voir également QWidget::insertAction() et addSection().

QAction *QMenu::insertSeparator(QAction *before)

Cette fonction de commodité crée une nouvelle action de séparation, c'est-à-dire une action avec QAction::isSeparator() retournant true. La fonction insère l'action nouvellement créée dans la liste des actions de ce menu avant l'action before et la renvoie.

QMenu prend possession de l'action retournée QAction.

Voir aussi QWidget::insertAction() et addSeparator().

bool QMenu::isEmpty() const

Renvoie true si aucune action visible n'a été insérée dans le menu, false dans le cas contraire.

Voir aussi QWidget::actions().

bool QMenu::isTearOffMenuVisible() const

Lorsqu'un menu est arraché, un second menu est affiché afin de présenter le contenu du menu dans une nouvelle fenêtre. Lorsque le menu est dans ce mode et qu'il est visible, la fonction renvoie true; sinon, elle renvoie false.

Voir aussi showTearOffMenu(), hideTearOffMenu() et isTearOffEnabled().

[override virtual protected] void QMenu::keyPressEvent(QKeyEvent *e)

Réimplémente : QWidget::keyPressEvent(QKeyEvent *event).

[override virtual protected] void QMenu::leaveEvent(QEvent *)

Réimplémente : QWidget::leaveEvent(QEvent *event).

QAction *QMenu::menuAction() const

Renvoie l'action associée à ce menu.

[static] QMenu *QMenu::menuInAction(const QAction *action)

Renvoie le menu contenu dans action, ou nullptr si action ne contient pas de menu.

Dans les applications widgets, les actions qui contiennent des menus peuvent être utilisées pour créer des éléments de menu avec des sous-menus, ou insérées dans des barres d'outils pour créer des boutons avec des menus contextuels.

[override virtual protected] void QMenu::mouseMoveEvent(QMouseEvent *e)

Réimplémente : QWidget::mouseMoveEvent(QMouseEvent *event).

[override virtual protected] void QMenu::mousePressEvent(QMouseEvent *e)

Réimplémente : QWidget::mousePressEvent(QMouseEvent *event).

[override virtual protected] void QMenu::mouseReleaseEvent(QMouseEvent *e)

Réimplémente : QWidget::mouseReleaseEvent(QMouseEvent *event).

[override virtual protected] void QMenu::paintEvent(QPaintEvent *e)

Réimplémente : QWidget::paintEvent(QPaintEvent *event).

void QMenu::popup(const QPoint &p, QAction *atAction = nullptr)

Affiche le menu de manière à ce que l'action atAction se trouve à la position globale spécifiée p. Pour traduire les coordonnées locales d'un widget en coordonnées globales, utilisez QWidget::mapToGlobal().

Lorsque vous positionnez un menu avec exec() ou popup(), gardez à l'esprit que vous ne pouvez pas vous fier à la taille actuelle du menu size(). Pour des raisons de performance, le menu n'adapte sa taille que lorsque c'est nécessaire, de sorte que dans de nombreux cas, la taille avant et après l'affichage est différente. Utilisez plutôt sizeHint() qui calcule la taille appropriée en fonction du contenu actuel du menu.

Voir également QWidget::mapToGlobal() et exec().

void QMenu::setActiveAction(QAction *act)

Définit l'action actuellement en surbrillance à act.

Voir aussi activeAction().

void QMenu::setAsDockMenu()

Définir ce menu comme étant le menu du dock disponible en cliquant sur l'icône du dock de l'application. Disponible sur macOS uniquement.

void QMenu::setDefaultAction(QAction *act)

Cela définit l'action par défaut à act. L'action par défaut peut avoir un repère visuel, en fonction de l'état actuel de QStyle. Une action par défaut indique généralement ce qui se passera par défaut lorsqu'une chute se produira.

Voir également defaultAction().

void QMenu::showTearOffMenu(const QPoint &pos)

Cette fonction affichera de force le menu arraché et le fera apparaître sur le bureau de l'utilisateur à la position globale spécifiée pos.

Voir également hideTearOffMenu(), isTearOffMenuVisible() et isTearOffEnabled().

void QMenu::showTearOffMenu()

Cette fonction affiche de force le menu arraché et le fait apparaître sur le bureau de l'utilisateur sous le curseur de la souris.

Voir aussi hideTearOffMenu(), isTearOffMenuVisible(), et isTearOffEnabled().

[override virtual] QSize QMenu::sizeHint() const

Réimplémente une fonction d'accès à la propriété : QWidget::sizeHint.

[override virtual protected] void QMenu::timerEvent(QTimerEvent *e)

Réimplémente : QObject::timerEvent(QTimerEvent *event).

NSMenu *QMenu::toNSMenu()

Renvoie le NSMenu natif de ce menu. Disponible sur macOS uniquement.

[signal] void QMenu::triggered(QAction *action)

Ce signal est émis lorsqu'une action de ce menu est déclenchée.

action est l'action qui a provoqué l'émission du signal.

Normalement, vous connectez le signal triggered() de chaque action de menu à son propre emplacement personnalisé, mais il arrive que vous souhaitiez connecter plusieurs actions à un seul emplacement, par exemple lorsque vous avez un groupe d'actions étroitement liées, telles que "justifier à gauche", "centrer", "justifier à droite".

Voir aussi hovered() et QAction::triggered().

[override virtual protected] void QMenu::wheelEvent(QWheelEvent *e)

Réimplémente : QWidget::wheelEvent(QWheelEvent *event).