latex/wx/app.tex

4 to:
15 file to tell wxWidgets how to create an instance of your application class.
18 a reference to your application object) to be visible to other files.
69 Creates a wxLog class for the application to use for logging errors. The default
111 Call this to explicitly exit the main message (event) loop.
121 to preempt the processing of some events. If this method returns $-1$ the event
125 going to be processed at all (for the latter one).
136 wxWidgets sets this to a reasonable default before
145 manner to refer to the application.
181 Returns a pointer to the top window.
198 Returns a pointer to the \helpref{wxAppTraits}{wxapptraits} object for the application.
199 If you want to customize the \helpref{wxAppTraits}{wxapptraits} object, you must override the
228 currently in the foreground. If this function returns \false and you need to
229 attract users attention to the application, you may use
231 to do it.
241 This can be useful to test whether the events can be dispatched. For example,
251 to provide your own (environment-dependent) main loop.
263 %%Provide this member function to know whether the application is being
274 %%This event handler function is called (under Windows only) to allow the window to intercept keyboard events
299 specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt false}.
303 The base class version shows the default assert failure dialog box proposing to
304 the user to stop the program, continue or ignore all subsequent asserts.
317 \docparam{msg}{the message specified as argument to
328 was specified by the user). The default behaviour is to show the program usage
331 Return {\tt true} to continue normal execution or {\tt false} to return
344 The default behaviour is to show the program usage text and abort the program.
346 Return {\tt true} to continue normal execution or {\tt false} to return
359 this method to test for the values of the various parameters which could be
362 Don't forget to call the base class version unless you want to suppress
365 Return {\tt true} to continue normal execution or {\tt false} to return
378 application event loop. It can return \true to ignore the exception and to
379 continue running the loop or \false to exit the loop and terminate the
380 program. In the latter case it can also use C++ \texttt{throw} keyword to
384 Windows where a dialog is shown to the user which allows him to choose between
385 the different options. You may override this function in your class to do
396 Override this member function for any processing which needs to be
397 done as the application is about to exit. OnExit is called after
412 this will not happen by default: you have to explicitly call
413 \helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions} to enable this.
415 Generally speaking, this function should only show a message to the user and
416 return. You may attempt to save unsaved data but this is not guaranteed to
429 %%Override this member function for any processing which needs to be done
431 %%since this forwards OnIdle events to windows and also performs garbage collection for
435 %%application have all been processed, wxWidgets sends an OnIdle event to the application object. wxApp::OnIdle itself
436 %%sends an OnIdle event to each application window, allowing windows to do idle processing such as updating
439 %%event to the application object. This will occur in a loop until either a user event is found to be
453 %%about to close down. The application has a chance to silently save information,
456 %%Use the EVT\_END\_SESSION event table macro to handle query end session events.
459 %%(forcing the application to close itself silently).
463 %%Under X, OnEndSession is called in response to the `die' event.
465 %%Under Windows, OnEndSession is called in response to the WM\_ENDSESSION message.
481 \helpref{OnExit}{wxapponexit} to clean up anything initialized here, provided
484 Notice that if you want to to use the command line processing provided by
485 wxWidgets you have to call the base class version in the derived class
488 Return \true to continue processing, \false to exit the application
496 Called from \helpref{OnInit}{wxapponinit} and may be used to initialize the
523 Note that the exception type is lost by now, so if you want to really handle
525 try/catch clause around the call to the base class version there.
534 may wish to process it. The function returns true if the message
537 function is called to allow wxWidgets to receive messages. For example,
538 to allow co-existence with the Microsoft Foundation Classes, override
568 Sends idle events to a window and its children.
570 Please note that this function is internal to wxWidgets and shouldn't be used
601 manner to refer to the application.
612 Allows the programmer to specify whether the application will exit when the
618 deleted. If false, the application will continue to run.}
630 Allows external code to modify global \texttt{wxTheApp}, but you should really
646 Sets the `top' window. You can call this from within \helpref{wxApp::OnInit}{wxapponinit} to
647 let wxWidgets know which is the main window. You don't have to set the top window;
651 needs to use the top window.
680 Allows the programmer to specify whether the application will use the best visual
683 applications are supposed to run in TrueColour mode.
685 If \arg{forceTrueColour} is true then the application will try to force
688 Note that this function has to be called in the constructor of the {\tt wxApp}
704 to allow to catch the C++ exceptions which could be thrown by all event
705 handlers in the application in one place: if you want to do this, override this
706 function in your wxApp-derived class and add try/catch clause(s) to it.
713 Yields control to pending messages in the windowing system. This can be useful, for example, when a
714 time-consuming process writes to a text window. Without an occasional
719 user to perform actions which are not compatible with the current task.
725 calling Yield() is usually done to quickly update the screen and popping up a
726 message box dialog may be undesirable. If you do wish to flush the log