QGuiApplication Class

メンバ関数ドキュメント

QGuiApplication::QGuiApplication(int &argc, char **argv)

ウィンドウシステムを初期化し、argc のコマンドライン引数argv でアプリケーションオブジェクトを構築します。

グローバルポインタqApp は、このアプリケーションオブジェクトを指します。作成するアプリケーション・オブジェクトは1つだけです。

このアプリケーション・オブジェクトは、paint devices （ピク スマップ、ビットマップなどを含む）の前に構築されなければなりません。

サポートされているコマンドラインオプション

すべての Qt プログラムは自動的にコマンドラインオプションをサポートし、Qt とウィンドウシステムとのインタラクションを変更することができます。オプションのいくつかは環境変数からもアクセス可能で、アプリケーションがGUIサブプロセスや他のアプリケーションを起動できる場合は、環境変数を使用するのが望ましい方法です（環境変数は子プロセスに継承されます）。迷った場合は、環境変数を使用してください。

現在サポートされているオプションは以下の通りです：

• -platform platformName[ Qt Platform Abstraction(QPA) プラグインを指定します。

  環境変数QT_QPA_PLATFORM を上書きします。

• -platformpluginpath path：プラットフォームプラグインへのパスを指定します。

  QT_QPA_PLATFORM_PLUGIN_PATH 環境変数を上書きします。

• -platformtheme platformTheme, プラットフォームテーマを指定する。

  QT_QPA_PLATFORMTHEME 環境変数を上書きする。

• -plugin plugin, ロードする追加プラグインを指定する。引数は複数回指定できる。

  環境変数QT_QPA_GENERIC_PLUGINS のプラグインと連結される。

• -qmljsdebugger=を指定すると、QML/JSデバッガを指定したポートで起動します。値はport:1234 [,block]の形式でなければなりません。blockはオプションで、デバッガが接続するまでアプリケーションを待たせます。
• -qwindowgeometry geometryはメインウィンドウのジオメトリをX11-syntaxで指定します。例えば-qwindowgeometry 100x100+50+50
• -qwindowiconデフォルトのウィンドウ・アイコンを設定します。
• -qwindowtitle最初のウィンドウのタイトルを設定します。
• -reverseアプリケーションのレイアウト方向をQt::RightToLeft に設定します。 このオプションはデバッグを支援するためのもので、実稼働環境では使用しないでください。デフォルト値は、ユーザーのロケールから自動的に検出されます（QLocale::textDirection()も参照してください）。
• -session session：以前のセッションからアプリケーションを復元します。

X11では、以下の標準コマンド行オプションが使用できます：

• -display hostname:screen_number：X11での表示を切り替えます。

  環境変数DISPLAY を上書きします。

• -geometry geometry、 と同じ。-qwindowgeometry

プラットフォーム固有の引数

-platform オプションには、プラットフォーム固有の引数を指定できます。プラットフォーム・プラグイン名の後にカンマ区切りで指定します。例えば、-platform windows:dialogs=xp,fontengine=freetype 。

-platform windows ：

• altgrQt 5.12 以降）、いくつかのキーボードにあるAltGr キーをQt::GroupSwitchModifier として検出します。
• darkmode=[0|1|2] Windows 10 1903 (Qt 5.15以降)で導入されたアプリケーションのダークモードの有効化に対するQtの反応を制御します。

  値 0 はダークモードのサポートを無効にします。

  値を 1 にすると、アプリケーションのダークモードがアクティブになり、ハイコントラストテーマが使用されていない場合、Qt はウィンドウのボーダーを黒に切り替えます。これは、独自のテーマ設定を行うアプリケーションを想定しています。

  値 2 を指定すると、さらに Windows Vista スタイルが無効になり、ダーク モードで簡略化されたパレットを使用する Windows スタイルに切り替わります。これは現在実験的なもので、ダーク モードに適切に適応する新しいスタイルの導入が待たれます。

  ダークモードのサポートを無効にするには、値を 0 または 1 に設定します。

• dialogs=[xp|none] xp は XP スタイルのネイティブダイアログを使用し、 はそれを無効にします。none
• fontengine=freetypeFreeTypeフォントエンジンを使用しています。
• fontengine=gdiQt 6.8 以降）、レガシーな GDI ベースのフォントデータベースを使用し、デフォルトでは GDI フォントエンジンを使用します。
• menus=[native|none]Qt 6.8以降）。

  ネイティブメニューは Win32 API を使用して実装されており、QMenu ベースのメニューよりもシンプルです。例えば、ウィジェットを配置したり、フォントのようなプロパティを変更したり、ホバーシグナルを提供しません。主に Qt Quick 向けです。デフォルトでは、アプリケーションがQApplication のインスタンスでない場合や、Qt Quick Controls 2 アプリケーション（Qt 5.10 以降）で使用されます。

• nocolorfonts DirectWrite Color フォントをオフにする（Qt 5.8 以降）。
• nodirectwrite DirectWrite フォントをオフにする（Qt 5.8 以降）。これは暗黙的に GDI フォントエンジンも選択します。
• nomousefromtouch オペレーティングシステムによってタッチイベントから合成されたマウスイベントを無視します。
• nowmpointer Pointer Input Messages 処理をレガシーなマウス処理に切り替える (Qt 5.12 以降)。
• reverse Right-to-left モードを有効にしました (実験的)。右から左のロケールでは、ウィンドウのタイトルバーがそれに応じて表示されます(Qt 5.13以降)。
• tabletabsoluterange=<value> WinTab タブレットのマウスモード検出の値を設定します(Legacy、Qt 5.3 以降)。

以下のパラメータは、-platform cocoa （macOS）で使用できます：

• fontengine=freetypeFreeType フォントエンジンを使用します。

組み込み Linux プラットフォームで利用可能なプラットフォーム固有の引数の詳細については、Qt for Embedded Linux を参照してください。

arguments() およびQGuiApplication::platformNameも参照してください 。

[virtual noexcept] QGuiApplication::~QGuiApplication()

アプリケーションを破棄します。

[static] QWindowList QGuiApplication::allWindows()

アプリケーション内のすべてのウィンドウのリストを返します。

ウィンドウがない場合、リストは空になります。

topLevelWindows()も参照して ください。

[static] Qt::ApplicationState QGuiApplication::applicationState()

アプリケーションの現在の状態を返します。

アプリケーションの状態の変化に反応して、CPU負荷の高いタスクの停止/再開、リソースの解放/ロード、アプリケーション・データの保存/復元などのアクションを実行できます。

[signal] void QGuiApplication::applicationStateChanged(Qt::ApplicationState state)

このシグナルは、アプリケーションのstate が変更されたときに発行されます。

applicationState()も参照してください 。

[static] void QGuiApplication::changeOverrideCursor(const QCursor &cursor)

現在アクティブなアプリケーション・オーバーライド・カーソルをcursor に変更します。

setOverrideCursor() が呼び出されなかった場合、この関数は何の効果も持ちません。

setOverrideCursor()、overrideCursor()、restoreOverrideCursor()、およびQWidget::setCursor() も参照して ください。

[static] QClipboard *QGuiApplication::clipboard()

クリップボードと対話するためのオブジェクトを返します。

[signal] void QGuiApplication::commitDataRequest(QSessionManager &manager)

このシグナルはセッション管理を扱います。このシグナルは、QSessionManager がアプリケーションにすべてのデータをコミットさせたいときに発せられます。

通常これは、ユーザーから許可を得た後、開いているファイルをすべて保存することを意味します。さらに、ユーザーがシャットダウンをキャンセルできる手段を提供したい場合もあります。

このシグナル内でアプリケーションを終了させるべきではありません。その代わりに、セッション・マネージャが、コンテキストに応じて、終了後にこの処理を行うかどうかを指定します。

isSessionRestored()、sessionId()、saveStateRequest()、Session Managementも参照してください 。

[static] bool QGuiApplication::desktopSettingsAware()

Qt がシステム標準の色やフォントなどを使用するように設定されている場合はtrue を返し、そうでない場合はfalse を返します。デフォルトはtrue です。

setDesktopSettingsAware()も参照してください 。

qreal QGuiApplication::devicePixelRatio() const

システムで最も高いスクリーンデバイスのピクセル比率を返します。これは、物理ピクセルとデバイス非依存ピクセルの比率である。

この関数は、対象とするウィンドウがわからない場合にのみ使用する。ターゲット・ウィンドウがわかっている場合は、代わりにQWindow::devicePixelRatio() を使用する。

QWindow::devicePixelRatio()も参照 。

[override virtual protected] bool QGuiApplication::event(QEvent *e)

再インプリメント：QCoreApplication::event(QEvent *e)。

[static] int QGuiApplication::exec()

メイン・イベント・ループに入り、exit() が呼び出されるまで待機し、exit() に設定された値（quit() を経由してexit() が呼び出された場合は 0）を返します。

イベント処理を開始するには、この関数を呼び出す必要がある。メイン・イベント・ループはウィンドウ・システムからイベントを受け取り、アプリケーション・ウィジェットにディスパッチします。

一般的に、exec()を呼び出す前にユーザーとのインタラクションを行うことはできません。

例えば、保留中のイベントがないときに特別な関数を実行するなど、アプリケーションにアイドル処理を実行させるには、0nsのタイムアウトを持つQChronoTimer 。より高度なアイドル処理スキームは、processEvents （）を使用することで実現できる。

クリーンアップ・コードは、アプリケーションのmain() 関数に入れるのではなく、aboutToQuit() シグナルに接続することを推奨します。プラットフォームによっては、QApplication::exec()コールが返らないことがあるからである。

quitOnLastWindowClosed 、quit （）、exit （）、processEvents （）、QCoreApplication::exec （）も参照の こと。

[static] QObject *QGuiApplication::focusObject()

現在アクティブなウィンドウで、キーイベントなどのフォーカスに関連付けられたイベントの最終受信者となるQObject を返す。

[signal] void QGuiApplication::focusObjectChanged(QObject *focusObject)

このシグナルは、フォーカスに関連付けられたイベントの最終受信者が変更されたときに発せられます。focusObject が新しい受信者となります。

focusObject()も参照 。

[static] QWindow *QGuiApplication::focusWindow()

キー・イベントなど、フォーカスに関連付けられたイベントを受信するQWindow を返します。

QWindow::requestActivate()も参照して ください。

[signal] void QGuiApplication::focusWindowChanged(QWindow *focusWindow)

focusWindow が新しいフォーカスウィンドウです。

focusWindow()も参照して ください。

[static] QFont QGuiApplication::font()

デフォルトのアプリケーション・フォントを返します。

setFont()も参照 。

[signal] void QGuiApplication::fontDatabaseChanged()

このシグナルは、使用可能なフォントが変更されたときに発せられます。

これは、アプリケーション・フォントが追加または削除されたときや、システム・フォントが変更されたときに発生します。

QFontDatabase::addApplicationFont()、QFontDatabase::addApplicationFontFromData()、QFontDatabase::removeAllApplicationFonts()、QFontDatabase::removeApplicationFont() も参照 。

[static] Qt::HighDpiScaleFactorRoundingPolicy QGuiApplication::highDpiScaleFactorRoundingPolicy()

highDPI scale factor rounding policy を返します。

setHighDpiScaleFactorRoundingPolicy() も参照 。

[static] QInputMethod *QGuiApplication::inputMethod()

input メソッドを返します。

input メソッドは、仮想キーボードの状態と位置に関するプロパティを返します。また、現在フォーカスされている入力要素の位置に関する情報も提供します。

QInputMethodも参照して ください。

[static] bool QGuiApplication::isLeftToRight()

アプリケーションのレイアウト方向がQt::LeftToRight の場合はtrue を返し、そうでない場合はfalse を返します。

layoutDirection() およびisRightToLeft() も参照 。

[static] bool QGuiApplication::isRightToLeft()

アプリケーションのレイアウト方向がQt::RightToLeft の場合はtrue を返し、それ以外の場合はfalse を返します。

layoutDirection() およびisLeftToRight() も参照 。

bool QGuiApplication::isSavingSession() const

アプリケーションが現在セッションを保存している場合はtrue を返し、そうでない場合はfalse を返す。

これは、commitDataRequest() とsaveStateRequest() が発行されたときだけでなく、その後セッション管理によってウィンドウが閉じられたときにもtrue となります。

sessionId()、commitDataRequest()、saveStateRequest()も参照 。

bool QGuiApplication::isSessionRestored() const

アプリケーションが以前のセッションから復元された場合はtrue を返し、そうでない場合はfalse を返す。

sessionId()、commitDataRequest()、saveStateRequest() も参照 。

[static] Qt::KeyboardModifiers QGuiApplication::keyboardModifiers()

キーボードの修飾キーの現在の状態を返します。キーボードの状態を自発的に変更するイベント（QEvent::KeyPress およびQEvent::KeyRelease イベント）がイベント・キューから空になると、現在の状態が同期的に更新されます。

これは、呼び出し時に入力デバイスに保持されている実際のキーではなく、上記のイベントの1つで最後に報告された修飾子を反映している可能性があることに注意すべきである。キーが保持されていない場合、Qt::NoModifier が返される。

mouseButtons() およびqueryKeyboardModifiers()も参照のこと 。

[signal] void QGuiApplication::lastWindowClosed()

このシグナルは、最後に表示されたプライマリウィンドウ（つまり、一時的な親を持たない トップレベルウィンドウ）が閉じられたときに、exec()から発せられる。

デフォルトでは、このシグナルが発せられた後、QGuiApplication は終了する。この機能をオフにするには、quitOnLastWindowClosed をfalse に設定する。

QWindow::close()、QWindow::isTopLevel()、QWindow::transientParent()も参照してください 。

[static] QWindow *QGuiApplication::modalWindow()

最近表示されたモーダルウィンドウを返します。モーダルウィンドウが表示されていない場合、この関数は0を返します。

モーダルウィンドウとは、modality プロパティがQt::WindowModal またはQt::ApplicationModal に設定されているウィンドウのことである。 ユーザーがプログラムの他の部分を続行する前に、モーダルウィンドウを閉じなければならない。

モーダルウィンドウはスタックで構成されます。この関数は、スタックの一番上にあるモーダルウィンドウを返します。

Qt::WindowModality およびQWindow::setModality()も参照してください 。

[static] Qt::MouseButtons QGuiApplication::mouseButtons()

マウスボタンの現在の状態を返します。現在の状態は、マウスの状態を自発的に変更するイベント (QEvent::MouseButtonPress とQEvent::MouseButtonRelease イベント) のイベントキューが空になると、同期的に更新されます。

これは、呼び出し時に入力デバイスに保持されている実際のボタンではなく、上記のイベントのいずれかで最後に報告されたマウスのボタンを反映する可能性があることに注意すべきである。マウスボタンが保持されていない場合は、Qt::NoButton が返される。

keyboardModifiers()も参照のこと 。

template <typename QNativeInterface> QNativeInterface *QGuiApplication::nativeInterface() const

アプリケーションの指定された型のネイティブ・インターフェースを返す。

この関数は、QNativeInterface 名前空間で定義されているQGuiApplication のプラットフォーム固有の機能へのアクセスを提供します：

要求されたインタフェースが利用できない場合、nullptr が返されます。

[override virtual] bool QGuiApplication::notify(QObject *object, QEvent *event)

再実装：QCoreApplication::notify(QObject *receiver, QEvent *event)。

[static] QCursor *QGuiApplication::overrideCursor()

アクティブなアプリケーション・オーバーライド・カーソルを返します。

アプリケーション・カーソルが定義されていない（内部カーソル・スタックが空）場合、この関数はnullptr を返します。

setOverrideCursor() およびrestoreOverrideCursor()も参照してください 。

[static] QPalette QGuiApplication::palette()

現在のアプリケーション・パレットを返します。

明示的に設定されていないロールは、システムのプラットフォーム・テーマを反映します。

setPalette()も参照 。

[static] Qt::KeyboardModifiers QGuiApplication::queryKeyboardModifiers()

キーボードの修飾キーの状態を問い合わせて返します。keyboardModifiers とは異なり、このメソッドはメソッド呼び出し時に入力デバイスに保持されている実際のキーを返す。

キー押下イベントがこのプロセスで受信されているかどうかに依存しないので、たとえばウィンドウを移動しているときに修飾子をチェックすることができます。ほとんどの場合、keyboardModifiers() を使用することに注意してください。 () には、現在処理中のイベントを受信したときの修飾子の状態が格納されているため、より高速で正確です。

keyboardModifiers()も参照 。

[static] void QGuiApplication::restoreOverrideCursor()

最後のsetOverrideCursor() を取り消します。

setOverrideCursor() が2回呼び出された場合、 restoreOverrideCursor() を呼び出すと、最初に設定されたカーソルが有効になります。この関数を2回目に呼び出すと、元のウィジェットのカーソルが復元されます。

setOverrideCursor() およびoverrideCursor()も参照してください 。

[signal] void QGuiApplication::saveStateRequest(QSessionManager &manager)

このシグナルはセッション管理を扱います。このシグナルは、session manager 、アプリケーションが将来のセッションのために状態を保持したいときに呼び出されます。

例えば、テキストエディタは、編集バッファの現在の内容、カーソルの位置、および現在の編集セッションの他の側面を含む一時ファイルを作成します。

このシグナルの中でアプリケーションを終了させるべきではありません。その代わりに、セッション・マネージャはコンテキストに応じて、この処理を後で行うかもしれませんし、行わないかもしれません。さらに、ほとんどのセッションマネージャーは、アプリケーションの起動直後に保存された状態を要求する可能性が非常に高いです。これによってセッションマネージャはアプリケーションの再起動のポリシーを知ることができます。

isSessionRestored()、sessionId()、commitDataRequest()、およびセッション管理も参照のこと 。

[signal] void QGuiApplication::screenAdded(QScreen *screen)

このシグナルは、新しい画面screen がシステムに追加されるたびに発行される。

screens()、primaryScreen 、およびscreenRemoved() も参照 。

[static] QScreen *QGuiApplication::screenAt(const QPoint &point)

point の画面、または画面外の場合はnullptr の画面を返す。

point は、仮想兄弟の各セットの virtualGeometry() との関係である。点が複数の仮想兄弟集合にマップされる場合、最初にマッチしたものが返される。既知の画面の仮想デスクトップの兄弟のみ（例えば、アプリケーション・ウィンドウQWidget::windowHandle()->screen() の画面の兄弟）を検索したい場合は、QScreen::virtualSiblingAt() を使用します。

[signal] void QGuiApplication::screenRemoved(QScreen *screen)

このシグナルは、screen がシステムから削除されるたびに発せられます。このシグナルは、Qtがプライマリ画面にウィンドウを移動する前に、画面上のウィンドウを管理する機会を提供します。

screens(),screenAdded(),QObject::destroyed(),QWindow::setScreen()も参照してください 。

[static] QList<QScreen *> QGuiApplication::screens()

アプリケーションが接続しているウィンドウシステムに関連付けられたすべてのスクリーンのリストを返します。

QString QGuiApplication::sessionId() const

現在のセッションの識別子を返します。

アプリケーションが以前のセッションから復元された場合、この識別子はその以前のセッションと同じです。セッション識別子は、異なるアプリケーションでも、同じアプリケーションの異なるインスタンスでも、一意であることが保証されています。

isSessionRestored()、sessionKey()、commitDataRequest()、saveStateRequest()も参照 。

QString QGuiApplication::sessionKey() const

現在のセッションのセッション・キーを返します。

以前のセッションからアプリケーションが復元された場合、このキーは以前のセッションが終了したときと同じです。

セッション・キーは、セッションが保存されるたびに変更されます。シャットダウン処理がキャンセルされると、再度シャットダウンするときに別のセッション・キーが使用されます。

isSessionRestored()、sessionId()、commitDataRequest()、saveStateRequest()も参照してください 。

[slot, since 6.5] void QGuiApplication::setBadgeNumber(qint64 number)

アプリケーションのバッジをnumber に設定する。

未読メッセージの数などをユーザにフィードバックするのに便利です。

バッジは、macOS の Dock、iOS のホーム画面アイコン、Windows と Linux のタスクバーにあるアプリケーションのアイコンに重ねて表示されます。

数がプラットフォームでサポートされている範囲外の場合、数はサポートされている範囲にクランプされます。数値がバッジに収まらない場合、数値は視覚的に消去されることがあります。

数値を 0 に設定すると、バッジは消去されます。

この関数は Qt 6.5 で導入されました。

applicationNameも参照してください 。

[static] void QGuiApplication::setDesktopSettingsAware(bool on)

Qt がシステム標準の色やフォントなどを使用するかどうかを設定します（on ）。 デフォルトでは、これはtrue です。

この関数は、次のようにQGuiApplication オブジェクトを作成する前に呼び出す必要があります：

int main(int argc, char *argv[])
{
    QApplication::setDesktopSettingsAware(false);
    QApplication app(argc, argv);
    // ...
    return app.exec();
}

desktopSettingsAware()も参照 。

[static] void QGuiApplication::setFont(const QFont &font)

デフォルトのアプリケーション・フォントをfont に変更します。

font()も参照して ください。

[static] void QGuiApplication::setHighDpiScaleFactorRoundingPolicy(Qt::HighDpiScaleFactorRoundingPolicy policy)

アプリケーションの高 DPI スケールファクタ丸めポリシーを設定します。policy は、非整数のスケールファクター（Windows 150%など）をどのように扱うかを決定します。

2つの主要なオプションは、小数のスケールファクターを整数に丸めるかどうかです。スケールファクターをそのままにしておくと、ユーザーインターフェイスのサイズはOSの設定と正確に一致しますが、Windowsスタイルなどでは描画エラーが発生する可能性があります。

丸めたい場合は、次にどのタイプの丸めを行うかを決定します。数学的に正しい四捨五入はサポートされていますが、視覚的に最良の結果が得られるとは限りません：1.5倍を1倍（"small UI"）としてレンダリングするか、2倍（"large UI"）としてレンダリングするかを考えてください。すべてのオプションの完全なリストについては、Qt::HighDpiScaleFactorRoundingPolicy enumを参照してください。

この関数は、アプリケーション・オブジェクトを作成する前に呼び出す必要があります。QGuiApplication::highDpiScaleFactorRoundingPolicy() アクセサが設定されていれば、その環境が反映されます。

デフォルト値はQt::HighDpiScaleFactorRoundingPolicy::PassThrough です。

highDpiScaleFactorRoundingPolicy()も参照してください 。

[static] void QGuiApplication::setOverrideCursor(const QCursor &cursor)

アプリケーション・オーバーライド・カーソルをcursor に設定します。

アプリケーション・オーバーライド・カーソルは、時間のかかる操作中など、アプリケーションが特別な状態にあることをユーザに示すためのものです。

このカーソルは、restoreOverrideCursor() または別の setOverrideCursor() が呼び出されるまで、アプリケーションのすべてのウィジェットに表示されます。

setOverrideCursor()はカーソルをスタックにプッシュし、restoreOverrideCursor()はアクティブなカーソルをスタックからポップします。changeOverrideCursor() は、現在アクティブなアプリケーション・オーバーライド・カーソルを変更します。

すべての setOverrideCursor() の後には、対応するrestoreOverrideCursor() が続く必要があります。

例を示します：

QGuiApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
calculateHugeMandelbrot();              // lunch time...
QGuiApplication::restoreOverrideCursor();

overrideCursor()、restoreOverrideCursor()、changeOverrideCursor()、QWidget::setCursor()も参照してください 。

[static] void QGuiApplication::setPalette(const QPalette &pal)

アプリケーション・パレットをpal に変更する。

このパレットのカラー・ロールは、システムのプラットフォーム・テーマと組み合わされ、アプリケーションの最終的なパレットとなる。

palette()も参照 。

[static] QStyleHints *QGuiApplication::styleHints()

アプリケーションのスタイルヒントを返します。

スタイル ヒントは、ダブルクリック間隔、全幅選択など、プラットフォームに依存するプロパティのセットをカプセル化します。

このヒントを使用することで、基盤となるプラットフォームとより緊密に統合することができます。

QStyleHintsも参照してください 。

[static] void QGuiApplication::sync()

Qt の状態を Window Systems の状態と同期させるために使用できる関数です。

この関数は、まずQCoreApplication::processEvents() を呼び出して Qts イベントを空にし、次にプラットフォームプラグインをウィンドウシステムと同期させ、最後にQCoreApplication::processEvents() を再度呼び出して Qts イベントを配信します；

この関数は時間がかかるため、使用は推奨されません。

[static] QWindow *QGuiApplication::topLevelAt(const QPoint &pos)

もしあれば、与えられた位置pos にあるトップレベルウィンドウを返す。

[static] QWindowList QGuiApplication::topLevelWindows()

アプリケーション内のトップレベル・ウィンドウのリストを返します。

allWindows()も参照のこと 。