Qt GUIプログラミング：QAction::MenuRole（列挙型）をマスターしてmacOSメニューを自由自在に操る

QAction::MenuRoleは、Qt GUIアプリケーションのメニュー構造を制御するための列挙型です。macOS上で動作するアプリケーションにおいて、アクションをアプリケーションメニューに自動的に配置するために使用されます。

列挙型の構成

QAction::MenuRoleは以下の定数で構成されています。

TextHeuristicRole
アクションのテキストに基づいてメニューに配置します。
ApplicationSpecificRole
アプリケーション固有のメニューアイテムを処理します。
QuitRole
"Quit"メニューアイテムを処理します。
PreferencesRole
"Preferences"メニューアイテムを処理します。
AboutRole
"About"メニューアイテムを処理します。
AboutQtRole
"About Qt"メニューアイテムを処理します。
NoRole
アクションを特定のメニューに配置しません。

使用方法

QAction::MenuRoleを使用するには、以下の手順に従います。

QActionオブジェクトを作成します。
QAction::setMenuRole()メソッドを使用して、アクションにMenuRole値を設定します。
アクションをメニューに追加します。

例

QAction *action = new QAction("About", this);
action->setMenuRole(QAction::AboutRole);
menuBar()->addAction(action);

このコードは、"About"というテキストを持つアクションを作成し、それをアプリケーションメニューの"About"メニューアイテムに配置します。

ApplicationSpecificRoleを使用する場合は、アクションのテキストを独自に定義する必要があります。
アクションのテキストが"About Qt"、"About"、"Preferences"、"Quit"などの標準的なテキストではない場合は、TextHeuristicRoleを使用する必要があります。
QAction::MenuRoleは、macOS上で動作するアプリケーションのみで使用できます。

Mac, 4.8.5: QAction in main menu not obeying AboutRole menu role [Solved]

例1: 標準的なメニューアイテム

この例では、"About"、"Preferences"、"Quit"という標準的なテキストを持つアクションを作成し、それぞれ対応するメニューアイテムに配置します。

#include <QApplication>
#include <QMenuBar>
#include <QMenu>
#include <QAction>

int main(int argc, char *argv[]) {
  QApplication app(argc, argv);

  QMenuBar *menuBar = new QMenuBar;

  QMenu *fileMenu = new QMenu("&File");
  fileMenu->addAction(QAction("&About", &app, QAction::AboutRole));
  fileMenu->addAction(QAction("&Preferences", &app, QAction::PreferencesRole));
  fileMenu->addAction(QAction("&Quit", &app, QAction::QuitRole));
  menuBar->addMenu(fileMenu);

  app.exec();

  return 0;
}

例2: アプリケーション固有のメニューアイテム

この例では、"ApplicationSpecificRole" を使って、アプリケーション固有のメニューアイテムを作成します。

#include <QApplication>
#include <QMenuBar>
#include <QMenu>
#include <QAction>

int main(int argc, char *argv[]) {
  QApplication app(argc, argv);

  QMenuBar *menuBar = new QMenuBar;

  QMenu *fileMenu = new QMenu("&File");
  fileMenu->addAction(QAction("&About", &app, QAction::AboutRole));
  fileMenu->addAction(QAction("&Preferences", &app, QAction::PreferencesRole));
  fileMenu->addAction(QAction("&Quit", &app, QAction::QuitRole));
  menuBar->addMenu(fileMenu);

  QMenu *toolsMenu = new QMenu("&Tools");
  toolsMenu->addAction(QAction("&Application Specific", &app, QAction::ApplicationSpecificRole));
  menuBar->addMenu(toolsMenu);

  app.exec();

  return 0;
}

各アクションは、QAction::MenuRole を使って、対応するメニューアイテムに配置されます。
"Tools"メニューには、"Application Specific"というアプリケーション固有のメニューアイテムが配置されます。
"File"メニューには、"About"、"Preferences"、"Quit"という標準的なメニューアイテムが配置されます。
メニューバーには、"File"と"Tools"という2つのメニューが配置されます。
メインウィンドウには、メニューバーが配置されます。
上記のコードは、Qt GUIアプリケーションのメインウィンドウを作成します。

ApplicationSpecificRole を使用する場合は、アクションのテキストを独自に定義する必要があります。
アクションのテキストが標準的なテキストではない場合は、TextHeuristicRole を使用する必要があります。
QAction::MenuRole は、macOS上で動作するアプリケーションのみで使用できます。
上記のコードはあくまで一例であり、実際のアプリケーションでは必要に応じて変更する必要があります。

Mac, 4.8.5: QAction in main menu not obeying AboutRole menu role [Solved]

代替方法

QAction::MenuRole の代替方法としては、以下の2つの方法が考えられます。

QAction::setIcon() と QAction::setText() を使用する

QAction::setIcon() と QAction::setText() を使用して、アクションのアイコンとテキストを設定することで、メニュー構造を制御することができます。

QAction *action = new QAction(QIcon(":/icons/about.png"), "&About", this);
menuBar()->addAction(action);

このコードは、"about.png" アイコンと"&About" テキストを持つアクションを作成し、それをメニューバーに追加します。

QMenuBar::addMenu() と QMenu::addAction() を使用する

QMenuBar::addMenu() と QMenu::addAction() を使用して、メニューとアクションを直接追加することで、メニュー構造を制御することができます。

QMenu *fileMenu = new QMenu("&File");
fileMenu->addAction(QAction("&About", this));
fileMenu->addAction(QAction("&Preferences", this));
fileMenu->addAction(QAction("&Quit", this));
menuBar()->addMenu(fileMenu);

このコードは、"File" というメニューを作成し、"About"、"Preferences"、"Quit" というアクションを追加します。

どちらの方法を選択するべきか

どちらの方法を選択するべきかは、状況によって異なります。

シンプルなメニュー構造を作成したい場合は、QMenuBar::addMenu() と QMenu::addAction() を使用する方が適しています。
アクションのアイコンとテキストを個別に設定したい場合は、QAction::setIcon() と QAction::setText() を使用する方が適しています。

上記以外にも、QAction::setShortcut() や QAction::setStatusTip() などのメソッドを使用して、アクションの外観や動作を制御することで、メニュー構造をある程度制御することができます。

代替方法を使用しても、QAction::MenuRole と同じ機能を完全に再現できない場合があります。
代替方法を使用する場合は、既存のコードを更新する必要があります。
QAction::MenuRole は、Qt 6.2 以降では非推奨であり、将来のバージョンで削除される予定です。