wxApp

wxApp クラスはアプリケーション自身を表しています。 このクラスを使うと、以下のようなことができます:
The wxApp class represents the application itself. It is used to:
アプリケーションクラスのインスタンスの作り方を wxWindows に通知するために、 アプリケーションの実装ファイル内で IMPLEMENT_APP(appClass) マクロを 使用するべきです。
You should use the macro IMPLEMENT_APP(appClass) in your application implementation file to tell wxWindows how to create an instance of your application class.
他のファイルから wxGetApp 関数 (アプリケーションオブジェクトのリファレンスを返す関数) が 見えてほしいなら、ヘッダファイル内で DECLARE_APP(appClass) を使用してください。
Use DECLARE_APP(appClass) in a header file if you want the wxGetApp function (which returns a reference to your application object) to be visible to other files.

継承元
Derived from

wxEvtHandler
wxObject

インクルードファイル
Include files

<wx/app.h>

参照
See also

wxApp overview

メンバ
Members


wxApp::wxApp

void wxApp()
コンストラクタ。 wxApp オブジェクトの定義と一緒に暗黙のうちに呼ばれます。
Constructor. Called implicitly with a definition of a wxApp object.

wxApp::~wxApp

void ~wxApp()
デストラクタ。 wxApp オブジェクトをスタック上に作成していればプログラム終了時に暗黙のうちに呼ばれます。
Destructor. Will be called implicitly on program exit if the wxApp object is created on the stack.

wxApp::argc

int argc
(環境固有の処理の後の) コマンドライン引数の数。
Number of command line arguments (after environment-specific processing).

wxApp::argv

char ** argv
(環境固有の処理の後の) コマンドライン引数。
Command line arguments (after environment-specific processing).

wxApp::CreateLogTarget

virtual wxLog* CreateLogTarget()
エラーログを使用するアプリケーションのために wxLog クラスを作成します。 デフォルトでは新しい wxLogGui クラスを返します。
Creates a wxLog class for the application to use for logging errors. The default implementation returns a new wxLogGui class.

参照
See also

wxLog

wxApp::Dispatch

void Dispatch()
ウィンドウシステムのイベントキューに次のイベントを送ります。
Dispatches the next event in the windowing system event queue.
この関数を使って、次のようにイベントループをプログラミングすることができます。
This can be used for programming event loops, e.g.
  while (app.Pending())
    Dispatch();

参照
See also

wxApp::Pending

wxApp::FilterEvent

int FilterEvent(wxEvent& event)
この関数はイベントを処理する前に呼ばれるため、 アプリケーションが一部のイベントを前もって処理できるようになります。 この関数で -1 を返した場合、イベントは通常通り処理されます。 そうでない場合、 TRUEFALSE の いずれかを返さなければなりません。 このとき、 (戻り値が TRUE の場合) イベントはすでに処理された、 もしくは (FALSE の場合) イベントをまったく処理しないと見なし、 イベントの処理を直ちに停止します。
This function is called before processing any event and allows the application to preempt the processing of some events. If this method returns -1 the event is processed normally, otherwise either TRUE or FALSE should be returned and the event processing stops immediately considering that the event had been already processed (for the former return value) or that it is not going to be processed at all (for the latter one).

wxApp::GetAppName

wxString GetAppName() const
アプリケーションの名前を返します。
Returns the application name.

注釈
Remarks

wxApp::OnInit を呼ぶ前に wxWindows によって妥当なデフォルト値が設定されますが、アプリケーションは自由にリセットできます。
wxWindows sets this to a reasonable default before calling wxApp::OnInit, but the application can reset it at will.

wxApp::GetAuto3D

bool GetAuto3D() const
3D コントロールモードなら TRUE を、そうでなければ FALSE を返します。
Returns TRUE if 3D control mode is on, FALSE otherwise.

参照
See also

wxApp::SetAuto3D

wxApp::GetClassName

wxString GetClassName() const
アプリケーションのクラス名を取得します。 クラス名は、プラットフォーム固有の方法でアプリケーションを参照するために使用されます。
Gets the class name of the application. The class name may be used in a platform specific manner to refer to the application.

参照
See also

wxApp::SetClassName

wxApp::GetExitOnFrameDelete

bool GetExitOnFrameDelete() const
トップレベルウィンドウが削除されたときにアプリケーションを終了するなら TRUE を、 そうでなければ FALSE を返します。
Returns TRUE if the application will exit when the top-level window is deleted, FALSE otherwise.

参照
See also

wxApp::SetExitOnFrameDelete,
wxApp shutdown overview

wxApp::GetTopWindow

virtual wxWindow * GetTopWindow() const
トップウィンドウのポインタを返します。
Returns a pointer to the top window.

注釈
Remarks

wxApp::SetTopWindow を使用して トップウィンドウを設定したのでなければ、 最初に見つかったトップレベルウィンドウ (フレームかダイアログ) を返します。
If the top window hasn't been set using wxApp::SetTopWindow, this function will find the first top-level window (frame or dialog) and return that.

参照
See also

SetTopWindow

wxApp::GetUseBestVisual

bool GetUseBestVisual() const
異なる外観をサポートしているシステムで、ベストな外観を使用していれば TRUE を、 そうでなければ FALSE を返します。
Returns TRUE if the application will use the best visual on systems that support different visuals, FALSE otherwise.

参照
See also

SetUseBestVisual

wxApp::GetVendorName

wxString GetVendorName() const
アプリケーションのベンダの名前を返します。
Returns the application's vendor name.

wxApp::ExitMainLoop

void ExitMainLoop()
メインメッセージ (イベント) ループを明示的に終了する場合にこの関数を呼んでください。 通常、トップウィンドウを削除すればメインループ (とアプリケーション) は終了するはずです。
Call this to explicitly exit the main message (event) loop. You should normally exit the main loop (and the application) by deleting the top window.

wxApp::Initialized

bool Initialized()
アプリケーションが初期化されていれば (例えば wxApp::OnInitが成功した場合に) TRUE を返します。 この関数はエラーメッセージを処理するときに、今のプログラムの状態で どの出力方法が最適か決めるのに役立ちます (いくつかのウィンドウシステムではメインループに入る前にダイアログをポップアップすることを 好まないようです)。
Returns TRUE if the application has been initialized (i.e. if wxApp::OnInit has returned successfully). This can be useful for error message routines to determine which method of output is best for the current state of the program (some windowing systems may not like dialogs to pop up before the main loop has been entered).

wxApp::MainLoop

int MainLoop()
アプリケーションを作成するときに wxWindows によって呼ばれます。 自作の (環境に依存する) メインループを提供したい場合はこの関数をオーバーライドしてください。
Called by wxWindows on creation of the application. Override this if you wish to provide your own (environment-dependent) main loop.

戻り値
Return value

X では 0 を、 Windows では WM_QUIT メッセージの wParam を返します。
Returns 0 under X, and the wParam of the WM_QUIT message under Windows.

wxApp::OnAssert

void OnAssert(const wxChar *file, int line, const wxChar *cond, const wxChar *msg)
この関数は assert が失敗したときに呼ばれます。 例えば wxASSERT マクロが FALSE と評価されたときです。 この関数はデバッグモードのとき (__WXDEBUG__が定義されているとき) のみ呼ばれ、 リリースコードではまったく残りません。
This function is called when an assert failure occurs, i.e. the condition specified in wxASSERT macro evaluated to FALSE. It is only called in debug mode (when __WXDEBUG__ is defined) as asserts are not left in the release code at all.
基底クラスではデフォルトの assert 失敗ダイアログを表示し、 ユーザーにプログラムを停止するか、続行するか、 これ以降のアサートを無視するかを尋ねます。
The base class version show the default assert failure dialog box proposing to the user to stop the program, continue or ignore all subsequent asserts.

引数
Parameters

file
assert が起こったソースファイルの名前
the name of the source file where the assert occured
line
assert が起こった行番号
the line number in this file where the assert occured
cond
文字列形式の assert 失敗条件。
the condition of the failed assert in string form
msg
wxASSERT_MSG または wxFAIL_MSG の引数に 指定されたメッセージ。 wxASSERTwxFAIL が使用された場合、 NULL になります。
the message specified as argument to wxASSERT_MSG or wxFAIL_MSG, will be NULL if just wxASSERT or wxFAIL was used

wxApp::OnExit

int OnExit()
この関数はアプリケーションの終了時にする必要のある処理を行うための関数です。 OnExit はすべてのウィンドウやコントロールが破壊された後、 wxWindows が後片付けを行う前に呼ばれます。
Provide this member function for any processing which needs to be done as the application is about to exit. OnExit is called after destroying all application windows and controls, but before wxWindows cleanup.

wxApp::OnCmdLineError

bool OnCmdLineError(wxCmdLineParser& parser)
コマンドラインのパースに失敗した (例えば、不正なコマンドラインオプションが指定された) ときに 呼ばれます。 デフォルトではプログラムの使用法を表示して終了します。
Called when command line parsing fails (i.e. an incorrect command line option was specified by the user). The default behaviour is to show the program usage text and abort the program.
通常通り実行を続ける場合は TRUE を、 OnInit から FALSE を 返してプログラムを終了する場合は FALSE を返してください。
Return TRUE to continue normal execution or FALSE to return FALSE from OnInit thus terminating the program.

参照
See also

OnInitCmdLine

wxApp::OnCmdLineHelp

bool OnCmdLineHelp(wxCmdLineParser& parser)
コマンドラインにヘルプオプション (--help) が指定されたときに呼ばれます。 デフォルトではプログラムの使用法を表示して終了します。
Called when the help option (--help) was specified on the command line. The default behaviour is to show the program usage text and abort the program.
通常通り実行を続ける場合は TRUE を、 OnInit から FALSE を 返してプログラムを終了する場合は FALSE を返してください。
Return TRUE to continue normal execution or FALSE to return FALSE from OnInit thus terminating the program.

参照
See also

OnInitCmdLine

wxApp::OnCmdLineParsed

bool OnCmdLineParsed(wxCmdLineParser& parser)
コマンドラインのパースに成功した後に呼ばれます。 この関数をオーバーライドするとコマンドラインに指定された引数の値をテストすることができます。
Called after the command line had been successfully parsed. You may override this method to test for the values of the various parameters which could be set from the command line.
通常のコマンドラインオプションの処理を続けるなら、 基底クラスのこの関数を必ず呼んでください。
Don't forget to call the base class version unless you want to suppress processing of the standard command line options.
通常通り実行を続ける場合は TRUE を、 OnInit から FALSE を 返してプログラムを終了する場合は FALSE を返してください。
Return TRUE to continue normal execution or FALSE to return FALSE from OnInit thus terminating the program.

参照
See also

OnInitCmdLine

wxApp::OnFatalException

void OnFatalException()
この関数は致命的なエラーが発生したときに呼ばれます: 例えば、 Win32 なら unhandled exeption、 Unix なら fatal signal が発生したときです。 しかし、デフォルトではこの関数は呼ばれません: この関数を有効にするには、明示的に wxHandleFatalExceptions を 呼ばなければなりません。
This function may be called if something fatal happens: an unhandled exception under Win32 or a a fatal signal under Unix, for example. However, this will not happen by default: you have to explicitly call wxHandleFatalExceptions to enable this.
一般的に、この関数はユーザーにメッセージを表示するだけにすべきです。 保存していないデータを保存しようとしても、うまくいくかは未保証で、 実際にはうまくいかないでしょう。
Generally speaking, this function should only show a message to the user and return. You may attempt to save unsaved data but this is not guaranteed to work and, in fact, probably won't.

参照
See also

wxHandleFatalExcetions

wxApp::OnInit

bool OnInit()
この関数はアプリケーションが提供する必要があります。 通常はメインウィンドウを作成し、任意で wxApp::SetTopWindow を呼びます。
This must be provided by the application, and will usually create the application's main window, optionally calling wxApp::SetTopWindow.
wxWindows を使ってコマンドライン処理を行いたい場合は、 継承先の OnInit() から基底クラスの OnInit() を 呼ばなければならないことに注意してください。
Notice that if you want to to use the command line processing provided by wxWindows you have to call the base class version in the derived class OnInit().
処理を続けるなら TRUE を、アプリケーションを終了するなら FALSE を返してください。
Return TRUE to continue processing, FALSE to exit the application.

wxApp::OnInitCmdLine

void OnInitCmdLine(wxCmdLineParser& parser)
OnInitから呼ばれ、 パーサをコマンドラインオプションで初期化します。 基底クラスではわずかな標準オプションしかサポートしていません。
Called from OnInit and may be used to initialize the parser with the command line options for this application. The base class versions adds support for a few standard options only.

wxApp::OnQueryEndSession

void OnQueryEndSession(wxCloseEvent& event)
この関数は OS か GUI セッションが終了しようとしているときに呼ばれるイベントハンドラです。 一般的に、未保存の文書はここで保存しようとします。
This is an event handler function called when the operating system or GUI session is about to close down. Typically, an application will try to save unsaved documents at this point.
wxCloseEvent::CanVeto が TRUE を返した場合、 wxCloseEvent::Veto を 呼ぶことでシャットダウンを拒否することができます。 文書の保存プロンプトを表示し、ユーザーが保存をキャンセルした後に シャットダウンを拒否してもいいでしょう。
If wxCloseEvent::CanVeto returns TRUE, the application is allowed to veto the shutdown by calling wxCloseEvent::Veto. The application might veto the shutdown after prompting for documents to be saved, and the user has cancelled the save.
query end session イベントを処理するには EVT_QUERY_END_SESSION マクロを使用してください。
Use the EVT_QUERY_END_SESSION event table macro to handle query end session events.
wxCloseEvent::GetForce を使用して ウィンドウの削除が強制されているかチェックするべきです。 これが TRUE の場合、 wxWindow::Destroy を使用して ウィンドウを削除してください。 そうでなければ、ウィンドウを削除するかどうかはプログラマ次第です。
You should check whether the application is forcing the deletion of the window using wxCloseEvent::GetForce. If this is TRUE, destroy the window using wxWindow::Destroy. If not, it is up to you whether you respond by destroying the window.
デフォルトではトップレベルウィンドウの wxWindow::Close を呼びます。 Close が FALSE を返した場合、シャットダウンを拒否します。 多くのアプリケーションではこれで十分です。
The default handler calls wxWindow::Close on the top-level window, and vetoes the shutdown if Close returns FALSE. This will be sufficient for many applications.

注釈
Remarks

X では 'save session' イベントで OnQueryEndSession が呼ばれます。
Under X, OnQueryEndSession is called in response to the 'save session' event.
Windows では WM_QUERYENDSESSION メッセージで OnQueryEndSession が呼ばれます。
Under Windows, OnQueryEndSession is called in response to the WM_QUERYENDSESSION message.

参照
See also

wxWindow::Close, wxCloseEvent

wxApp::ProcessMessage

bool ProcessMessage(WXMSG * msg)
メッセージを処理する Windows のみの関数です。 この関数はメインメッセージループから呼ばれ、 ウィンドウがそのメッセージを処理しようとするかをチェックします。 この関数はメッセージが処理されるなら TRUE を、そうでなければ FALSE を返します。 wxWindows を独自のメッセージループを持つ別のクラスライブラリと使う場合、 wxWindows がメッセージを受け取れるようにこの関数が呼ばれていることを確認してください。 例えば、 MFC と共存できるように PreTranslateMessage 関数をオーバーライドしてください。
Windows-only function for processing a message. This function is called from the main message loop, checking for windows that may wish to process it. The function returns TRUE if the message was processed, FALSE otherwise. If you use wxWindows with another class library with its own message loop, you should make sure that this function is called to allow wxWindows to receive messages. For example, to allow co-existence with the Microsoft Foundation Classes, override the PreTranslateMessage function:
// wxWindows のメッセージループと互換性を持たせる
// Provide wxWindows message loop compatibility
BOOL CTheApp::PreTranslateMessage(MSG *msg)
{
  if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
    return TRUE;
  else
    return CWinApp::PreTranslateMessage(msg);
}

wxApp::Pending

bool Pending()
ウィンドウシステムのイベントキューに処理されていないイベントがあれば TRUE を返します。
Returns TRUE if unprocessed events are in the window system event queue.

参照
See also

wxApp::Dispatch

wxApp::SendIdleEvents

bool SendIdleEvents()
すべてのトップレベルウィンドウにアイドルイベントを送ります。
Sends idle events to all top-level windows.
bool SendIdleEvents(wxWindow* win)
指定したウィンドウとその子ウィンドウにアイドルイベントを送ります。
Sends idle events to a window and its children.

注釈
Remarks

この関数はアイドルイベントを処理するため、トップレベルウィンドウとその子ウィンドウを調べます。 OnIdle 処理を要求するウィンドウがあれば TRUE を返します。
These functions poll the top-level windows, and their children, for idle event processing. If TRUE is returned, more OnIdle processing is requested by one or more window.

参照
See also

wxIdleEvent

wxApp::SetAppName

void SetAppName(const wxString& name)
アプリケーションの名前をセットします。 この名前はダイアログで (例えばドキュメント/ビューフレームワークが) 使用するかもしれません。 デフォルトの名前は wxWindows によってセットされます。
Sets the name of the application. The name may be used in dialogs (for example by the document/view framework). A default name is set by wxWindows.

参照
See also

wxApp::GetAppName

wxApp::SetAuto3D

void SetAuto3D(const bool auto3D)
自動的に 3D コントロールにするかどうかを切り替えます。
Switches automatic 3D controls on or off.

引数
Parameters

auto3D
TRUE の場合、コントロールやダイアログがオーバーライドされていなければ、 コントロールはすべて 3D で作成されます。 デフォルトでは TRUE です。
If TRUE, all controls will be created with 3D appearances unless overridden for a control or dialog. The default is TRUE

注釈
Remarks

Windows でのみ、この関数は効果があります。
This has an effect on Windows only.

参照
See also

wxApp::GetAuto3D

wxApp::SetClassName

void SetClassName(const wxString& name)
アプリケーションのクラス名をセットします。 クラス名は、プラットフォーム固有の方法でアプリケーションを参照するために使用されます。
Sets the class name of the application. This may be used in a platform specific manner to refer to the application.

参照
See also

wxApp::GetClassName

wxApp::SetExitOnFrameDelete

void SetExitOnFrameDelete(bool flag)
トップレベルのフレームが削除されたときにアプリケーションを終了するか選択できます。
Allows the programmer to specify whether the application will exit when the top-level frame is deleted.

引数
Parameters

flag
TRUE (デフォルト) なら、トップレベルのフレームが削除されたときにアプリケーションを終了します。 FALSE なら、アプリケーションは動作し続けます。
If TRUE (the default), the application will exit when the top-level frame is deleted. If FALSE, the application will continue to run.

参照
See also

wxApp::GetExitOnFrameDelete,
wxApp shutdown overview

wxApp::SetTopWindow

void SetTopWindow(wxWindow* window)
'トップ' ウィンドウをセットします。 wxWindows にメインウィンドウを通知するために wxApp::OnInit の中から呼ぶことができます。 自分でトップウィンドウを設定する必要はありません; (例えば) 親ウィンドウを持たないダイアログが特定のウィンドウを トップウィンドウとすることができるため、この関数は便利というだけです。 アプリケーションがトップウィンドウをひとつも指定しない場合、 必要に応じて wxWindows はトップレベルウィンドウのリスト内の最初のフレームかダイアログを使用します。
Sets the 'top' window. You can call this from within wxApp::OnInit to let wxWindows know which is the main window. You don't have to set the top window; it is only a convenience so that (for example) certain dialogs without parents can use a specific window as the top window. If no top window is specified by the application, wxWindows just uses the first frame or dialog in its top-level window list, when it needs to use the top window.

引数
Parameters

window
新しいトップウィンドウ。
The new top window.

参照
See also

wxApp::GetTopWindow, wxApp::OnInit

wxApp::SetVendorName

void SetVendorName(const wxString& name)
アプリケーションのベンダの名前をセットします。 この名前はレジストリアクセスに使われます。 デフォルトの名前は wxWindows によってセットされます。
Sets the name of application's vendor. The name will be used in registry access. A default name is set by wxWindows.

参照
See also

wxApp::GetVendorName

wxApp::SetUseBestVisual

void SetUseBestVisual(bool flag)
同じディスプレイで複数の外観をサポートしているシステム上でベストな外観を使用するか指定できます。 一般的に、これは Solaris と IRIX のことです。 これらの OS ではデフォルトの外観はたった 8bit なのに対し、 特定のアプリケーションは TrueColor モードで実行されることを前提としています。
Allows the programmer to specify whether the application will use the best visual on systems that support several visual on the same display. This is typically the case under Solaris and IRIX, where the default visual is only 8-bit whereas certain applications are supposed to run in TrueColour mode.
この関数は wxApp のコンストラクタ内で呼ばなければならず、 あとで呼んでも効果がないことに注意してください。
Note that this function has to be called in the constructor of the wxApp instance and won't have any effect when called later on.
現在、この関数は GTK でのみ有効です。
This function currently only has effect under GTK.

引数
Parameters

flag
TRUE ならベストな外観を使用します。
If TRUE, the app will use the best visual.

wxApp::Yield

bool Yield(bool onlyIfNeeded = FALSE)
ウィンドウシステムで未処理のメッセージを処理します。 例えば、時間のかかる処理がテキストウィンドウに書き込むときにこの関数が役に立ちます。 たまに yield を行わないとテキストウィンドウは適切に更新されず、 Windows 3.1 のような協調的なマルチタスクのシステムでは他のプロセスが応答できないでしょう。
Yields control to pending messages in the windowing system. This can be useful, for example, when a time-consuming process writes to a text window. Without an occasional yield, the text window will not be updated properly, and on systems with cooperative multitasking, such as Windows 3.1 other processes will not respond.
しかし、使用には注意が必要です。 なぜなら、 yield によって今の作業と同時にできない操作を行えるようになるかもしれないためです。 処理中はメニューを無効にしておくことで、コードの不要な再実行を避けることができます: より良い関数の ::wxSafeYield を参照してください。
Caution should be exercised, however, since yielding may allow the user to perform actions which are not compatible with the current task. Disabling menu items or whole menus during processing can avoid unwanted reentrance of code: see ::wxSafeYield for a better function.
Yield() はメッセージログを消去しないことに注意してください。 Yeild() を呼ぶのは普通はすばやくスクリーンを更新するためであり、 メッセージボックスが表示されるのは望ましくないので、これは意図的なものです。 ログメッセージをすぐに (または次のアイドルループ中に) 消去したい場合は wxLog::FlushActive を呼んでください。
Note that Yield() will not flush the message logs. This is intentional as calling Yield() is usually done to quickly update the screen and popping up a message box dialog may be undesirable. If you do wish to flush the log messages immediately (otherwise it will be done during the next idle loop iteration), call wxLog::FlushActive.
通常、再帰的に Yield() を呼ぶのは間違いであり、デバッグビルドでそのような状況が見つかると assert は失敗します。 しかし、 onlyIfNeededTRUE であれば、 代わりにこの関数が FALSE を返します。
Calling Yield() recursively is normally an error and an assert failure is raised in debug build if such situation is detected. However if the the onlyIfNeeded parameter is TRUE, the method will just silently return FALSE instead.