Qt プログラミング：QHelpEvent クラスによるヘルプ情報表示

Qt GUI の QHelpEvent クラス

概要

• 役割: 特定のポイントに関するヘルプ情報をリクエスト
• 発生タイミング: ウィジェット上でマウスが動いたり、ヘルプキーが押されたり
• 処理方法: イベントハンドラでヘルプ情報を表示
• 関連クラス: QToolTip, QWhatsThis, QStatusTipEvent, QWhatsThisClickedEvent

メンバ関数

例

class MyWidget : public QWidget {
  public:
    MyWidget() {
      // ...
      setWhatsThis("このウィジェットは何か？");
    }

  protected:
    void helpEvent(QHelpEvent *event) override {
      if (event->type() == QEvent::WhatsThis) {
        // ヘルプテキストを表示
        QWhatsThis::showText(event->globalPos(), this->whatsThis());
      } else {
        // ツールチップを表示
        QToolTip::showText(event->globalPos(), "ツールチップテキスト");
      }
    }
};

補足

• QHelpEvent は QEvent クラスを継承している

QHelpEvent クラスのサンプルコード

ツールチップ表示

class MyWidget : public QWidget {
  public:
    MyWidget() {
      // ...
      setToolTip("このウィジェットは何か？");
    }

  protected:
    void helpEvent(QHelpEvent *event) override {
      if (event->type() == QEvent::ToolTip) {
        // ツールチップを表示
        QToolTip::showText(event->globalPos(), this->toolTip());
      }
    }
};

カスタム "ヘルプ" ウィジェット表示

class MyHelpWidget : public QWidget {
  public:
    MyHelpWidget() {
      // ...
      // ヘルプテキストを表示するラベル
      QLabel *label = new QLabel("ここにヘルプテキストを表示", this);
    }
};

class MyWidget : public QWidget {
  public:
    MyWidget() {
      // ...
      setWhatsThis("このウィジェットは何か？");
    }

  protected:
    void helpEvent(QHelpEvent *event) override {
      if (event->type() == QEvent::WhatsThis) {
        // カスタムヘルプウィジェットを表示
        MyHelpWidget *helpWidget = new MyHelpWidget();
        helpWidget->show();
        helpWidget->move(event->globalPos());
      }
    }
};

QWhatsThis クラスと連携

class MyWidget : public QWidget {
  public:
    MyWidget() {
      // ...
      setWhatsThis("このウィジェットは何か？");
    }

  protected:
    void helpEvent(QHelpEvent *event) override {
      if (event->type() == QEvent::WhatsThis) {
        // QWhatsThis クラスを使用してヘルプテキストを表示
        QWhatsThis::showText(event->globalPos(), this->whatsThis());
      }
    }
};

QStatusTipEvent クラスと連携

class MyWidget : public QWidget {
  public:
    MyWidget() {
      // ...
      setStatusTip("このウィジェットは何か？");
    }

  protected:
    void helpEvent(QHelpEvent *event) override {
      if (event->type() == QEvent::ToolTip) {
        // ステータスバーにツールチップを表示
        QStatusBar *statusBar = this->window()->statusBar();
        statusBar->showMessage(this->toolTip());
      }
    }
};

QHelpEvent クラスの代替方法

QToolTip クラスは、ウィジェットにマウスがホバーした時にツールチップを表示する機能を提供します。

class MyWidget : public QWidget {
  public:
    MyWidget() {
      // ...
      setToolTip("このウィジェットは何か？");
    }
};

QWhatsThis クラスは、ウィジェットに "ヘルプ" ボタンを追加し、ボタン押下時にヘルプテキストを表示する機能を提供します。

class MyWidget : public QWidget {
  public:
    MyWidget() {
      // ...
      setWhatsThis("このウィジェットは何か？");
    }
};

カスタムヘルプウィジェット

上記の方法以外にも、独自のヘルプウィジェットを作成して、ウィジェットヘルプ機能を実装することができます。

class MyHelpWidget : public QWidget {
  public:
    MyHelpWidget() {
      // ...
      // ヘルプテキストを表示するラベル
      QLabel *label = new QLabel("ここにヘルプテキストを表示", this);
    }
};

class MyWidget : public QWidget {
  public:
    MyWidget() {
      // ...
      // ヘルプボタン
      QPushButton *helpButton = new QPushButton("ヘルプ", this);
      connect(helpButton, &QPushButton::clicked, this, &MyWidget::showHelp);
    }

  private slots:
    void showHelp() {
      // カスタムヘルプウィジェットを表示
      MyHelpWidget *helpWidget = new MyHelpWidget();
      helpWidget->show();
    }
};

どの方法を選択するかは、アプリケーションの要件によって異なります。

• シンプルなツールチップを表示したい場合は、QToolTip クラスが最も簡単です。
• より詳細なヘルプ情報を提供したい場合は、QWhatsThis クラスまたはカスタムヘルプウィジェットを使用することができます。