【保存版】Qt GUIアプリケーション開発者のためのキーボードショートカット設定ガイド：QShortcut::setKeys() の詳細解説とサンプルコード

QShortcut::setKeys()は、Qt GUIアプリケーションでキーボードショートカットを設定するための重要なメソッドです。このメソッドを使用すると、特定のキーシーケンスが押されたときに実行されるアクションを指定できます。ショートカットキーは、ユーザーインターフェースをより直感的で効率的にするために役立ちます。

メソッドの構文

void QShortcut::setKeys(const QList<QKeySequence> &keys);

パラメータ

keys: ショートカットをトリガーするキーシーケンスのリスト

キーシーケンスの指定

QKeySequence クラスを使用して、キーシーケンスを指定します。QKeySequence コンストラクタには、さまざまな修飾キーとキーを組み合わせるためのオプションが含まれています。

例

次のコードは、Ctrl+Qキーの組み合わせが押されたときにclose()スロットを呼び出すショートカットを設定します。

QShortcut *shortcut = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q), this);
connect(shortcut, SIGNAL(activated()), this, SLOT(close()));

複数のキーシーケンス

QShortcut::setKeys() メソッドは、複数のキーシーケンスを受け取ることができます。これにより、複数の方法で同じアクションをトリガーできるようになります。

例

次のコードは、Ctrl+QキーまたはCtrl+Wキーの組み合わせが押されたときにclose()スロットを呼び出すショートカットを設定します。

QShortcut *shortcut = new QShortcut(QList<QKeySequence>() << QKeySequence(Qt::CTRL + Qt::Key_Q) << QKeySequence(Qt::CTRL + Qt::Key_W), this);
connect(shortcut, SIGNAL(activated()), this, SLOT(close()));

標準キー

QKeySequence::StandardKey 列挙型を使用して、標準のキーシーケンスを指定することもできます。

例

次のコードは、Escapeキーが押されたときにclose()スロットを呼び出すショートカットを設定します。

QShortcut *shortcut = new QShortcut(QKeySequence::StandardKey::Escape, this);
connect(shortcut, SIGNAL(activated()), this, SLOT(close()));

コンテキスト

ショートカットは、特定のコンテキストでのみアクティブに設定できます。コンテキストは、ショートカットがトリガーされるウィジェットの階層構造を定義します。

例

次のコードは、myWidget ウィジェット内でのみアクティブなショートカットを設定します。

QShortcut *shortcut = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q), myWidget);
connect(shortcut, SIGNAL(activated()), this, SLOT(close()));

例1: 基本的なショートカット

#include <QtWidgets/QApplication>
#include <QtWidgets/QMainWindow>

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

  QShortcut *shortcut = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q), &window);
  connect(shortcut, SIGNAL(activated()), &window, SLOT(close()));

  window.show();
  return app.exec();
}

例2: 複数のキーシーケンス

#include <QtWidgets/QApplication>
#include <QtWidgets/QMainWindow>

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

  QList<QKeySequence> keys;
  keys << QKeySequence(Qt::CTRL + Qt::Key_Q) << QKeySequence(Qt::CTRL + Qt::Key_W);
  QShortcut *shortcut = new QShortcut(keys, &window);
  connect(shortcut, SIGNAL(activated()), &window, SLOT(close()));

  window.show();
  return app.exec();
}

例3: 標準キー

#include <QtWidgets/QApplication>
#include <QtWidgets/QMainWindow>

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

  QShortcut *shortcut = new QShortcut(QKeySequence::StandardKey::Escape, &window);
  connect(shortcut, SIGNAL(activated()), &window, SLOT(close()));

  window.show();
  return app.exec();
}

例4: コンテキスト

#include <QtWidgets/QApplication>
#include <QtWidgets/QWidget>

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

  QShortcut *shortcut = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q), &widget);
  connect(shortcut, SIGNAL(activated()), &widget, SLOT(close()));

  widget.show();
  return app.exec();
}

これらの例は、QShortcut::setKeys() メソッドの基本的な使用方法を示しています。このメソッドを使用して、さまざまな種類のキーボードショートカットを作成できます。

コードを理解するには、Qt GUIプログラミングの基礎知識が必要です。
コードを実行する前に、Qtフレームワークがインストールされていることを確認してください。
上記のコード例は、Qt Creatorを使用してコンパイルして実行できます。

QAction クラス

QAction クラスは、メニュー項目、ツールバーボタン、キーボードショートカットなどに関連付けられるアクションを定義するために使用されます。QShortcut と同様に、QAction には setShortcut() メソッドがあり、キーボードショートカットを設定できます。

利点

ステータスヒントやツールチップを設定できる
アイコンやテキストラベルをアクションに関連付けられる
メニューやツールバーとの統合が容易

欠点

コード量が多くなる
QShortcut よりも複雑

例

#include <QtWidgets/QApplication>
#include <QtWidgets/QMainWindow>
#include <QtWidgets/QAction>

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

  QAction *action = new QAction(QIcon(":/close.png"), "&Close", &window);
  action->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q));
  connect(action, SIGNAL(triggered()), &window, SLOT(close()));

  window.menuBar()->addAction(action);
  window.show();
  return app.exec();
}

キーイベントハンドラ

キーイベントハンドラを使用して、特定のキーが押されたときにコードを実行することもできます。この方法は、シンプルなショートカットを設定する場合に役立ちます。

利点

コード量が少ない
シンプルで軽量

欠点

アイコンやテキストラベルを関連付けられない
メニューやツールバーとの統合が難しい

例

#include <QtWidgets/QApplication>
#include <QtWidgets/QMainWindow>

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

  window.installEventFilter(new MyEventFilter(&window));
  window.show();
  return app.exec();
}

class MyEventFilter : public QObject {
public:
  MyEventFilter(QMainWindow *window) : QObject(window) {}

  bool eventFilter(QObject *obj, QEvent *event) {
    if (event->type() == QEvent::KeyPress) {
      QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
      if (keyEvent->key() == Qt::Key_Q && keyEvent->modifiers() == Qt::ControlModifier) {
        window->close();
        return true;
      }
    }
    return QObject::eventFilter(obj, event);
  }
};

カスタムウィジェット

カスタムウィジェットを作成して、独自のキーボードショートカットロジックを実装することもできます。この方法は、複雑なショートカットを設定する場合や、標準のショートカットフレームワークでは実現できない機能が必要な場合に役立ちます。

利点

標準のショートカットフレームワークでは実現できない機能を実装できる
柔軟性が高い

欠点

複雑になる
開発に時間がかかる

例

#include <QtWidgets/QApplication>
#include <QtWidgets/QWidget>

class MyWidget : public QWidget {
public:
  MyWidget(QWidget *parent = nullptr) : QWidget(parent) {}

protected:
  void keyPressEvent(QKeyEvent *event) override {
    if (event->key() == Qt::Key_Q && event->modifiers() == Qt::ControlModifier) {
      close();
    }
  }
};

int main(int argc, char *argv[]) {
  QApplication app(argc, argv);
  MyWidget widget;
  widget.show();
  return app.exec();
}

QShortcut::setKeys() は、Qt GUI アプリケーションでキーボードショートカットを設定するための一般的な方法ですが、状況によっては代替方法の方が適している場合があります。上記で説明した代替方法はそれぞれ利点と欠点があるため、要件に合わせて最適な方法を選択する必要があります。

ショートカットキーの使用を明確に示すようにしてください。
ユーザーがショートカットキーを簡単に覚えられるようにしてください。
ショートカットキーの競合を避けるようにしてください。