QMenu Class

メンバ関数のドキュメント

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

親としてparent を持つメニューを作成します。

ポップアップメニューは常に最上位のウィジェットですが、親オブジェクトが渡された場合、その親オブジェクトが破棄されると（他のQObject と同様に）、ポップアップメニューも削除されます。

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

title とparent を含むメニューを作成します。

ポップアップメニューは常に最上位のウィジェットですが、親ウィジェットが指定された場合、その親ウィジェットが破棄されると、ポップアップメニューも破棄されます（他のQObject と同様です）。

titleも参照してください 。

[virtual noexcept] QMenu::~QMenu()

メニューを削除します。

[signal] void QMenu::aboutToHide()

このシグナルは、メニューがユーザーから非表示になる直前に発せられます。

aboutToShow() およびhide()も参照してください 。

[signal] void QMenu::aboutToShow()

この信号は、ユーザーにメニューが表示される直前に発せられます。

aboutToHide() およびshow()も参照してください 。

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

pt にある項目を返します。そこに項目がない場合は、nullptr を返します。

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

QWidget::actionEvent(QActionEvent *event) を再実装します。

QRect QMenu::actionGeometry(QAction *act) const

アクション `act` のジオメトリを返します。

QAction *QMenu::activeAction() const

現在ハイライトされているアクションを返します。現在ハイライトされているアクションがない場合は、nullptr を返します。

setActiveAction()も参照してください 。

QAction *QMenu::addMenu(QMenu *menu)

この便利関数は、menu をこのメニューのサブメニューとして追加します。この関数は、menu のmenuAction()を返します。このメニューは、menu の所有権を取得しません。

QWidget::addAction() およびQMenu::menuAction()も参照してください 。

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

title を持つ新しいQMenu をメニューに追加します。このメニューが、そのメニューの所有権を引き継ぎます。新しいメニューを返します。

QWidget::addAction() およびQMenu::menuAction()も参照してください 。

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

icon およびtitle を含む新しい「QMenu 」をメニューに追加します。このメニューが元のメニューの所有権を引き継ぎます。新しいメニューを返します。

QWidget::addAction() およびQMenu::menuAction()も参照してください 。

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

この便利関数は、新しいセクションアクション、すなわちQAction::isSeparator()がtrueを返すだけでなく、text というヒントを持つアクションを作成し、その新しいアクションをこのメニューのアクション一覧に追加します。この関数は、新しく作成されたアクションを返します。

ヒントの表示方法は、スタイルやプラットフォームによって異なります。ウィジェットのスタイルによっては、セクションの表示にテキスト情報を活用することもあれば、それを無視してセクションを単純な区切り線のように表示することもあります。

QMenu 返された `QAction` の所有権を取得します。

QWidget::addAction()も参照してください 。

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

この便利関数は、新しいセクションアクション、すなわちQAction::isSeparator()がtrueを返すだけでなく、text およびicon のヒントを持つアクションを作成し、その新しいアクションをこのメニューのアクション一覧に追加します。この関数は、新しく作成されたアクションを返します。

ヒントの表示方法は、スタイルやプラットフォームによって異なります。ウィジェットのスタイルによっては、セクションの表示にテキストやアイコンの情報を使用することもあれば、それらを無視してセクションを単純な区切り線のように表示することもできます。

QMenu 返された `QAction` の所有権を取得します。

QWidget::addAction()も参照してください 。

QAction *QMenu::addSeparator()

この便利関数は、新しいセパレータアクション（つまり、QAction::isSeparator() が true を返すアクション）を作成し、その新しいアクションをこのメニューのアクション一覧に追加します。この関数は、新しく作成されたアクションを返します。

QMenu 返されたQAction の所有権を取得します。

QWidget::addAction()も参照してください 。

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

QWidget::changeEvent(QEvent *event) を再実装します。

void QMenu::clear()

メニューのすべてのアクションを削除します。そのメニューに属し、他のウィジェットには表示されていないアクションが削除されます。

removeAction()も参照してください 。

[protected] int QMenu::columnCount() const

メニューが画面に収まらない場合、収まるように自動的にレイアウトが調整されます。そのレイアウトがどのようなものになるかは、使用しているOSや環境によって異なります（たとえば、Windowsでは複数列のレイアウトが採用されます）。

この関数は、必要な列数を返します。

QAction *QMenu::defaultAction() const

現在のデフォルトのアクションを返します。

setDefaultAction()も参照してください 。

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

QWidget::enterEvent （QEnterEvent *event）を再実装します。

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

QWidget::event(QEvent *event) を再実装しています。

QAction *QMenu::exec()

このメニューを同期的に実行します。

これは `exec(pos())` と同等です。

これにより、ポップアップメニューまたはそのサブメニューのいずれかでトリガーされたQAction が返されます。アイテムがトリガーされなかった場合（通常はユーザーがEscキーを押した場合）は、nullptr が返されます。

ほとんどの場合、位置（例えば、現在のマウス位置など）を自分で指定したいでしょう：

exec(QCursor::pos());

あるいはウィジェットに揃える場合：

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

あるいは、QMouseEvent *e* への反応として：

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

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

このメニューを同期的に実行します。

メニューをポップアップ表示し、アクション `action ` が指定されたグローバル座標`p` の位置に配置されるようにします。ウィジェットのローカル座標をグローバル座標に変換するには、QWidget::mapToGlobal() を使用してください。

これは、ポップアップメニューまたはそのサブメニューのいずれかでトリガーされたQAction を返します。アイテムがトリガーされなかった場合（通常はユーザーがEscキーを押した場合）は、nullptr を返します。

なお、すべてのシグナルは通常通り発信されます。QAction をスロットに接続し、メニューのexec()を呼び出すと、シグナル・スロットの接続を介して、およびexec()の戻り値の両方を通じて結果を取得できます。

一般的な使用法として、メニューを現在のマウス位置に配置します：

exec(QCursor::pos());

あるいは、ウィジェットに合わせて配置する場合：

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

あるいは、QMouseEvent *e* への反応として：

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

exec() や `popup()` を使用してメニューを配置する際は、メニューの現在の `size()` の値に依存できない点に注意してください。パフォーマンス上の理由から、メニューは必要な場合にのみサイズを調整します。 そのため、多くの場合、表示前と表示後のサイズは異なります。代わりに、メニューの現在の内容に応じて適切なサイズを計算するsizeHint()を使用してください。

popup() およびQWidget::mapToGlobal()も参照してください 。

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

メニューを同期的に実行します。

メニューのアクションは、actions のリストによって指定されます。メニューは、指定されたアクションであるat がグローバル位置pos に表示されるようにポップアップ表示されます。at が指定されていない場合、メニューは位置pos に表示されます。parent はメニューの親ウィジェットです。pos だけではメニューの配置先を決定できない場合（例えば、複数のデスクトップがある場合や、親がQGraphicsView に埋め込まれている場合など）、親を指定することでコンテキストを提供します。

この関数は、ポップアップメニューまたはそのサブメニューのいずれかでトリガーされたQAction を返します。アイテムがトリガーされなかった場合（通常はユーザーがEscキーを押した場合）は、nullptr を返します。

これは以下と同等です：

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);

popup() およびQWidget::mapToGlobal()も参照してください 。

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

QWidget::focusNextPrevChild （bool next）を再実装します。

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

QWidget::hideEvent(QHideEvent *event) を再実装します。

void QMenu::hideTearOffMenu()

この関数は、切り離されたメニューを強制的に非表示にし、ユーザーのデスクトップから消去します。

showTearOffMenu()、isTearOffMenuVisible()、およびisTearOffEnabled()も参照してください 。

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

このシグナルは、メニューアクションがハイライトされたときに発せられます。action は、このシグナルの発火を引き起こしたアクションです。

多くの場合、これはステータス情報の更新に使用されます。

triggered() およびQAction::hovered()も参照してください 。

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

このメニューの値とaction の情報を使用して、option を初期化します。この方法は、サブクラスがQStyleOptionMenuItem を必要とするものの、すべての情報を自ら入力したくない場合に役立ちます。

QStyleOption::initFrom() およびQMenuBar::initStyleOption()も参照してください 。

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

この便利関数は、アクション `before ` の前に `menu ` を挿入し、メニュー `menuAction()` を返します。

QWidget::insertAction() およびaddMenu()も参照してください 。

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

この便利関数は、新しいタイトルアクション、すなわちQAction::isSeparator()がtrueを返すだけでなく、text というヒントを持つアクションを作成します。この関数は、新しく作成されたアクションを、このメニューのアクション一覧内のbefore アクションの前に挿入し、それを返します。

ヒントの表示方法は、スタイルやプラットフォームによって異なります。ウィジェットのスタイルによっては、セクションの表示にテキスト情報を活用することもあれば、それを無視してセクションを単純な区切り線のように表示することも可能です。

QMenu は、返された `QAction` の所有権を取得します。

QWidget::insertAction() およびaddSection()も参照してください 。

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

この便利関数は、新しいタイトルアクション、すなわちQAction::isSeparator()がtrueを返すだけでなく、text およびicon のヒントも持つアクションを作成します。この関数は、新しく作成されたアクションを、このメニューのアクション一覧内のbefore アクションの前に挿入し、それを返します。

ヒントの表示方法は、スタイルやプラットフォームによって異なります。ウィジェットのスタイルによっては、セクションの表示にテキストやアイコンの情報を使用することも、それらを無視してセクションを単純な区切り線のように表示することも可能です。

QMenu は、返された `QAction` の所有権を取得します。

QWidget::insertAction() およびaddSection()も参照してください 。

QAction *QMenu::insertSeparator(QAction *before)

この便利関数は、新しいセパレータアクション、すなわちQAction::isSeparator()がtrueを返すアクションを作成します。この関数は、新しく作成されたアクションを、このメニューのアクション一覧においてbefore アクションの前に挿入し、それを返します。

QMenu は、返された `QAction` の所有権を取得します。

QWidget::insertAction() およびaddSeparator()も参照してください 。

bool QMenu::isEmpty() const

メニューに表示されるアクションが挿入されていない場合は `true ` を返し、それ以外の場合は `false` を返します。

QWidget::actions()も参照してください 。

bool QMenu::isTearOffMenuVisible() const

メニューが切り取られた場合、メニューの内容を新しいウィンドウに表示するために、2つ目のメニューが表示されます。メニューがこのモードにあり、かつメニューが表示されている場合、true を返します。それ以外の場合はfalseを返します。

showTearOffMenu()、hideTearOffMenu()、およびisTearOffEnabled()も参照してください 。

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

QWidget::keyPressEvent(QKeyEvent *event) を再実装しています。

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

QWidget::leaveEvent(QEvent *event) を再実装します。

QAction *QMenu::menuAction() const

このメニューに関連付けられているアクションを返します。

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

action に含まれるメニューを返します。action にメニューが含まれていない場合は、nullptr を返します。

ウィジェットアプリケーションでは、メニューを含むアクションを使用して、サブメニューを持つメニュー項目を作成したり、ツールバーに挿入してポップアップメニュー付きのボタンを作成したりすることができます。

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

QWidget::mouseMoveEvent(QMouseEvent *event) を再実装します。

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

QWidget::mousePressEvent(QMouseEvent *event) を再実装します。

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

QWidget::mouseReleaseEvent(QMouseEvent *event) を再実装します。

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

QWidget::paintEvent(QPaintEvent *event) を再実装します。

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

アクション「atAction 」が指定されたグローバル位置「p 」に配置されるようにメニューを表示します。ウィジェットのローカル座標をグローバル座標に変換するには、QWidget::mapToGlobal() を使用してください。

exec() や popup() を使用してメニューを配置する際は、メニューの現在のsize() の値に依存できない点に注意してください。 パフォーマンス上の理由から、メニューは必要な場合にのみサイズを調整するため、多くの場合、表示前と表示後のサイズが異なります。代わりに、メニューの現在の内容に応じて適切なサイズを計算するsizeHint()を使用してください。

QWidget::mapToGlobal() およびexec()も参照してください 。

void QMenu::setActiveAction(QAction *act)

現在選択されているアクションを「act 」に設定します。

「activeAction()」も参照してください 。

void QMenu::setAsDockMenu()

このメニューを、アプリケーションのドックアイコンをOptionキーを押しながらクリックすると表示されるドックメニューに設定します。macOSでのみ利用可能です。

void QMenu::setDefaultAction(QAction *act)

これにより、デフォルトのアクションが「act 」に設定されます。デフォルトのアクションには、現在のQStyle に応じて視覚的な手がかりが表示される場合があります。デフォルトのアクションは通常、ドラッグ＆ドロップが行われた際にデフォルトで何が起こるかを示しています。

defaultAction()も参照してください 。

void QMenu::showTearOffMenu(const QPoint &pos)

この関数は、切り取られたメニューを強制的に表示し、指定されたグローバル位置 pos にユーザーのデスクトップ上に表示させます。

hideTearOffMenu()、isTearOffMenuVisible()、およびisTearOffEnabled()も参照してください 。

void QMenu::showTearOffMenu()

この関数は、切り離されたメニューを強制的に表示し、ユーザーのデスクトップ上のマウスカーソルの下に表示させます。

hideTearOffMenu()、isTearOffMenuVisible()、およびisTearOffEnabled()も参照してください 。

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

プロパティ「QWidget::sizeHint 」のアクセス関数を再実装します。

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

QObject::timerEvent(QTimerEvent *event) を再実装します。

NSMenu *QMenu::toNSMenu()

このメニューのネイティブ NSMenu を返します。macOS でのみ利用可能です。

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

このメニュー内のアクションが実行されると、この信号が出力されます。

action は、シグナルの発火を引き起こしたアクションです。

通常、各メニューアクションのtriggered() シグナルを、それぞれ独自のカスタムスロットに接続しますが、「左揃え」、「中央揃え」、「右揃え」など、密接に関連するアクションのグループがある場合など、複数のアクションを 1 つのスロットに接続したい場合もあるでしょう。

関連項目： hovered() およびQAction::triggered()。

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

QWidget::wheelEvent(QWheelEvent *event) を再実装します。