Qt Widgetsでメッセージボックスにキーイベントフィルターを使用する方法

Qt WidgetsにおけるQMessageBox::keyPressEvent()の解説

QMessageBox::keyPressEvent()は、Qt Widgetsフレームワークで提供されるQMessageBoxクラスの仮想関数です。この関数は、メッセージボックスが表示されているときにユーザーがキーを押した際に呼び出され、押されたキーに対応する処理を実行することができます。

機能

QMessageBox::keyPressEvent()は以下の機能を提供します。

• 押されたキーの取得
• 押されたキーに対応する処理の実行
• メッセージボックスの閉じ処理

#include <QtWidgets/QMessageBox>

void onKeyPressed(QKeyEvent* event) {
  switch (event->key()) {
    case Qt::Key_Enter:
    case Qt::Key_Return:
      QMessageBox::StandardButton button = QMessageBox::sender()->standardButton(QMessageBox::Yes);
      QMessageBox::clicked(button);
      break;
    case Qt::Key_Escape:
      QMessageBox::sender()->close();
      break;
  }
}

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

  QMessageBox msgBox;
  msgBox.setText("メッセージボックスのサンプルです。");
  msgBox.setStandardButtons(QMessageBox::Yes | QMessageBox::No);
  msgBox.connect(&msgBox, &QMessageBox::keyPressEvent, onKeyPressed);
  msgBox.show();

  return app.exec();
}

解説

上記のサンプルコードでは、QMessageBox::keyPressEvent()を使用して、以下の処理を実現しています。

• EnterキーまたはReturnキーが押された場合は、Yesボタンがクリックされたとみなして、メッセージボックスを閉じます。
• Escキーが押された場合は、メッセージボックスを閉じます。

QMessageBox::keyPressEvent()を使用して、メッセージボックスに独自の機能を追加することができます。例えば、特定のキーを押すと、メッセージボックスの内容を変更したり、別のウィジェットを開いたりすることができます。

補足

• 上記のサンプルコードはQt 5.15.2で動作確認しています。
• Qt Widgets以外にも、Qt Quickなど他のQtフレームワークでも同様の機能を提供しています。

QMessageBox::keyPressEvent() のサンプルコード

void onKeyPressed(QKeyEvent* event) {
  if (event->key() == Qt::Key_Escape) {
    QMessageBox::sender()->close();
  }
}

メッセージボックスの内容を変更する

void onKeyPressed(QKeyEvent* event) {
  if (event->key() == Qt::Key_Up) {
    // メッセージボックスの内容を上へスクロール
  } else if (event->key() == Qt::Key_Down) {
    // メッセージボックスの内容を下へスクロール
  }
}

別のウィジェットを開く

void onKeyPressed(QKeyEvent* event) {
  if (event->key() == Qt::Key_F1) {
    // 別のウィジェットを開く
  }
}

独自の機能を追加する

void onKeyPressed(QKeyEvent* event) {
  if (event->key() == Qt::Key_A) {
    // 独自の機能を実行
  } else if (event->key() == Qt::Key_B) {
    // 独自の機能を実行
  }
}

キーイベントを処理する

void onKeyPressed(QKeyEvent* event) {
  // キーイベントを処理
}

QMessageBox::keyPressEvent() 以外の方法

QKeyEventFilter クラスを使用すると、ウィジェットに送信されるすべてのキーイベントを処理することができます。

class MyKeyEventFilter : public QKeyEventFilter {
  public:
    bool eventFilter(QObject* object, QEvent* event) override {
      if (event->type() == QEvent::KeyPress) {
        // キーイベントを処理
      }
      return false;
    }
};

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

  MyKeyEventFilter filter;
  qApp->installEventFilter(&filter);

  QMessageBox msgBox;
  msgBox.setText("メッセージボックスのサンプルです。");
  msgBox.setStandardButtons(QMessageBox::Yes | QMessageBox::No);
  msgBox.show();

  return app.exec();
}

QShortcut クラスを使用すると、特定のキーの組み合わせに処理を割り当てることができます。

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

  QMessageBox msgBox;
  msgBox.setText("メッセージボックスのサンプルです。");
  msgBox.setStandardButtons(QMessageBox::Yes | QMessageBox::No);

  // EnterキーまたはReturnキーでメッセージボックスを閉じる
  QShortcut* shortcut = new QShortcut(Qt::Key_Enter | Qt::Key_Return, &msgBox, SLOT(close()));

  msgBox.show();

  return app.exec();
}

QObject::event() メソッドをオーバーライドして、キーイベントを処理することができます。

class MyMessageBox : public QMessageBox {
  public:
    bool event(QEvent* event) override {
      if (event->type() == QEvent::KeyPress) {
        // キーイベントを処理
      }
      return QMessageBox::event(event);
    }
};

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

  MyMessageBox msgBox;
  msgBox.setText("メッセージボックスのサンプルです。");
  msgBox.setStandardButtons(QMessageBox::Yes | QMessageBox::No);
  msgBox.show();

  return app.exec();
}