QWhatsThis Class
QWhatsThisクラスは、ウィジェットの簡単な説明を提供します。詳細...
Header: | #include <QWhatsThis> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS Widgets) target_link_libraries(mytarget PRIVATE Qt6::Widgets) |
qmake: | QT += widgets |
- 継承メンバを含む全メンバのリスト
- QWhatsThis はHelp System の一部です。
静的パブリックメンバー
QAction * | createAction(QObject *parent = nullptr) |
void | enterWhatsThisMode() |
void | hideText() |
bool | inWhatsThisMode() |
void | leaveWhatsThisMode() |
void | showText(const QPoint &pos, const QString &text, QWidget *w = nullptr) |
詳細説明
"What's This? "ヘルプは、アプリケーションのオンラインヘルプシステムの一部であり、特定のウィジェットの機能と使用方法に関する情報をユーザに提供します。"What's This? "ヘルプのテキストは、一般的にtooltips より長く詳細ですが、一般的に個別のヘルプウィンドウで提供される情報よりも少ないです。
QWhatsThisは、ユーザが "What's This? "と質問したときにポップアップ表示される説明テキストを含む単一のウィンドウを提供します。ユーザーが質問するデフォルトの方法は、関連するウィジェットにフォーカスを移動し、Shift+F1を押すことです。ヘルプテキストはすぐに表示され、ユーザーが何か他の操作をするとすぐに消えます。(Shift+F1のショートカットがある場合、このメカニズムは動作しないことに注意してください)。いくつかのダイアログでは、"What's This? "モードに入るためにユーザーがクリックできる"? "ボタンを提供しています。また、"What's This? "モードに切り替えるメニューオプションやツールバーボタンを提供することも可能です。
ウィジェットやアクションに "What's This? "テキストを追加するには、QWidget::setWhatsThis() またはQAction::setWhatsThis() を呼び出すだけです。
テキストには、リッチテキストまたはプレーンテキストを指定できます。リッチテキスト形式の文字列を指定すると、デフォルトのスタイルシートを使用してレンダリングされ、表示されるテキストに画像を埋め込むことができます。できるだけ高速に表示するために、デフォルトのスタイルシートは、テキストがプレーンテキストとして表示できるかどうかを判断する簡単な方法を使用しています。詳しくはQt::mightBeRichText() を参照してください。
newAct = new QAction(tr("&New"), this); newAct->setShortcut(tr("Ctrl+N")); newAct->setStatusTip(tr("Create a new file")); newAct->setWhatsThis(tr("Click this option to create a new file."));
What'sThis? "モードに入る別の方法は、createAction ()を呼び出し、返されたQAction をメニューまたはツールバーに追加することです。このコンテキストヘルプアクション(下の図では、矢印とクエスチョンマークのアイコンのボタン)を呼び出すことで、ユーザーは「What's This」モードに切り替わります。ウィジェットをクリックすると、適切なヘルプテキストが表示されます。このモードは、ヘルプが表示されるか、ユーザーがEscを押すと解除されます。
プログラムにより、enterWhatsThisMode ()で "What's This? "モードに入り、inWhatsThisMode ()でモードを確認し、leaveWhatsThisMode ()で通常モードに戻ることができる。
ウィジェットの "What's This? "動作を手動で制御したい場合は、Qt::WA_CustomWhatsThis を参照してください。
QEvent::WhatsThis 型のQHelpEvent を使用して、ウィジェットの異なる領域に異なるヘルプテキストを表示することもできます。ウィジェットのQWidget::event() 関数で help イベントをインターセプトし、QHelpEvent::pos() で指定された位置に表示したいテキストでQWhatsThis::showText() を呼び出します。テキストがリッチテキストで、ユーザがリンクをクリックした場合、ウィジェットはリンクの参照をQWhatsThisClickedEvent::href()としてQWhatsThisClickedEvent 。QWhatsThisClickedEvent が処理された場合(すなわち、QWidget::event() が真を返した場合)、ヘルプ・ウィンドウは表示されたままになります。明示的に非表示にするには、QWhatsThis::hideText() を呼び出します。
QToolTipも参照のこと 。
メンバ関数 ドキュメント
[static]
QAction *QWhatsThis::createAction(QObject *parent = nullptr)
指定されたparent を持つ、"What's This? "コンテキストヘルプを呼び出すために使用される、レディメイドのQAction を返します。
返されたQAction は、ユーザが "What's This? "モードに入るための便利な方法を提供します。
[static]
void QWhatsThis::enterWhatsThisMode()
この関数は、ユーザーインターフェースを "What's This? "モードに切り替えます。ユーザー・インターフェースは、ユーザーによって(例えば、クリックしたり、Escを押したりすることによって)、またはプログラムによって、leaveWhatsThisMode ()を呼び出すことによって、通常のモードに戻すことができる。
What's This? "モードに入ると、Qt::EnterWhatsThisMode タイプのQEvent がすべてのトップレベル ウィジェットに送信されます。
inWhatsThisMode() およびleaveWhatsThisMode()も参照してください 。
[static]
void QWhatsThis::hideText()
What's This? "ウィンドウが表示されている場合、これを破棄します。
showText()も参照 。
[static]
bool QWhatsThis::inWhatsThisMode()
ユーザ・インタフェースが "What's This? "モードの場合はtrue
を返し、そうでない場合はfalse
を返す。
enterWhatsThisMode()も参照 。
[static]
void QWhatsThis::leaveWhatsThisMode()
ユーザ・インタフェースが "What's This? "モードの場合、この関数は通常モードに戻る。
そうでない場合は何もしません。"What's This? "モードを抜けるとき、Qt::LeaveWhatsThisMode タイプのQEvent がすべてのトップレベル ウィジェットに送られます。
enterWhatsThisMode() およびinWhatsThisMode()も参照してください 。
[static]
void QWhatsThis::showText(const QPoint &pos, const QString &text, QWidget *w = nullptr)
グローバル位置pos に、"What's This?" ウィンドウとしてtext を表示します。オプションのウィジェット引数、w は、マルチヘッドシステムで適切な画面を決定するために使用される。
hideText()も参照してください 。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。