]>
git.saurik.com Git - wxWidgets.git/blob - interface/wx/app.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxApp
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 This class is essential for writing console-only or hybrid apps without
14 having to define wxUSE_GUI=0.
19 @category{appmanagement}
21 @see @ref overview_app
23 class wxAppConsole
: public wxEvtHandler
27 Creates the wxAppTraits object when GetTraits() needs it for the first time.
31 virtual wxAppTraits
* CreateTraits();
38 virtual ~wxAppConsole();
41 Dispatches the next event in the windowing system event queue.
42 Blocks until an event appears if there are none currently
43 (use Pending() if this is not wanted).
45 This can be used for programming event loops, e.g.
52 @return @false if the event loop should stop and @true otherwise.
56 virtual bool Dispatch();
59 Call this to explicitly exit the main message (event) loop.
60 You should normally exit the main loop (and the application) by deleting
63 virtual void ExitMainLoop();
66 This function is called before processing any event and allows the application
67 to preempt the processing of some events.
69 If this method returns -1 the event is processed normally, otherwise either
70 @true or @false should be returned and the event processing stops immediately
71 considering that the event had been already processed (for the former return
72 value) or that it is not going to be processed at all (for the latter one).
74 virtual int FilterEvent(wxEvent
& event
);
77 Returns the user-readable application name.
79 The difference between this string and the one returned by GetAppName() is that
80 this one is meant to be shown to the user and so should be used for the window
81 titles, page headers and so on while the other one should be only used internally,
82 e.g. for the file names or configuration file keys.
83 By default, returns the same string as GetAppName().
87 wxString
GetAppDisplayName() const;
90 Returns the application name.
92 @remarks wxWidgets sets this to a reasonable default before calling
93 OnInit(), but the application can reset it at will.
95 @see GetAppDisplayName()
97 wxString
GetAppName() const;
100 Gets the class name of the application. The class name may be used in a
101 platform specific manner to refer to the application.
105 wxString
GetClassName() const;
108 Returns the one and only global application object.
109 Usually ::wxTheApp is usead instead.
113 static wxAppConsole
* GetInstance();
116 Returns a pointer to the wxAppTraits object for the application.
117 If you want to customize the wxAppTraits object, you must override the
118 CreateTraits() function.
120 wxAppTraits
* GetTraits();
123 Returns the user-readable vendor name. The difference between this string
124 and the one returned by GetVendorName() is that this one is meant to be shown
125 to the user and so should be used for the window titles, page headers and so on
126 while the other one should be only used internally, e.g. for the file names or
127 configuration file keys.
129 By default, returns the same string as GetVendorName().
133 const wxString
& GetVendorDisplayName() const;
136 Returns the application's vendor name.
138 const wxString
& GetVendorName() const;
141 This function simply invokes the given method @a func of the specified
142 event handler @a handler with the @a event as parameter. It exists solely
143 to allow to catch the C++ exceptions which could be thrown by all event
144 handlers in the application in one place: if you want to do this, override
145 this function in your wxApp-derived class and add try/catch clause(s) to it.
147 virtual void HandleEvent(wxEvtHandler
* handler
,
148 wxEventFunction func
,
149 wxEvent
& event
) const;
152 Returns @true if the main event loop is currently running, i.e. if the
153 application is inside OnRun().
155 This can be useful to test whether events can be dispatched. For example,
156 if this function returns @false, non-blocking sockets cannot be used because
157 the events from them would never be processed.
159 static bool IsMainLoopRunning();
162 Called in response of an "open-application" Apple event.
163 Override this to create a new document in your app.
167 virtual void MacNewFile();
170 Called in response of an "open-document" Apple event.
172 You need to override this method in order to open a document file after the
173 user double clicked on it or if the document file was dropped on either the
174 running application or the application icon in Finder.
178 virtual void MacOpenFile(const wxString
& fileName
);
181 Called in response of a "get-url" Apple event.
185 virtual void MacOpenURL(const wxString
& url
);
188 Called in response of a "print-document" Apple event.
192 virtual void MacPrintFile(const wxString
& fileName
);
195 Called in response of a "reopen-application" Apple event.
199 virtual void MacReopenApp();
202 Called by wxWidgets on creation of the application. Override this if you wish
203 to provide your own (environment-dependent) main loop.
205 @return 0 under X, and the wParam of the WM_QUIT message under Windows.
207 virtual int MainLoop();
210 This function is called when an assert failure occurs, i.e. the condition
211 specified in wxASSERT() macro evaluated to @false.
213 It is only called in debug mode (when @c __WXDEBUG__ is defined) as
214 asserts are not left in the release code at all.
215 The base class version shows the default assert failure dialog box proposing to
216 the user to stop the program, continue or ignore all subsequent asserts.
219 the name of the source file where the assert occurred
221 the line number in this file where the assert occurred
223 the name of the function where the assert occurred, may be
224 empty if the compiler doesn't support C99 __FUNCTION__
226 the condition of the failed assert in text form
228 the message specified as argument to wxASSERT_MSG or wxFAIL_MSG, will
229 be @NULL if just wxASSERT or wxFAIL was used
231 virtual void OnAssertFailure(const wxChar
*file
,
238 Called when command line parsing fails (i.e. an incorrect command line option
239 was specified by the user). The default behaviour is to show the program usage
240 text and abort the program.
242 Return @true to continue normal execution or @false to return
243 @false from OnInit() thus terminating the program.
247 virtual bool OnCmdLineError(wxCmdLineParser
& parser
);
250 Called when the help option (@c --help) was specified on the command line.
251 The default behaviour is to show the program usage text and abort the program.
253 Return @true to continue normal execution or @false to return
254 @false from OnInit() thus terminating the program.
258 virtual bool OnCmdLineHelp(wxCmdLineParser
& parser
);
261 Called after the command line had been successfully parsed. You may override
262 this method to test for the values of the various parameters which could be
263 set from the command line.
265 Don't forget to call the base class version unless you want to suppress
266 processing of the standard command line options.
267 Return @true to continue normal execution or @false to return @false from
268 OnInit() thus terminating the program.
272 virtual bool OnCmdLineParsed(wxCmdLineParser
& parser
);
275 This function is called if an unhandled exception occurs inside the main
276 application event loop. It can return @true to ignore the exception and to
277 continue running the loop or @false to exit the loop and terminate the
278 program. In the latter case it can also use C++ @c throw keyword to
279 rethrow the current exception.
281 The default behaviour of this function is the latter in all ports except under
282 Windows where a dialog is shown to the user which allows him to choose between
283 the different options. You may override this function in your class to do
284 something more appropriate.
286 Finally note that if the exception is rethrown from here, it can be caught in
287 OnUnhandledException().
289 virtual bool OnExceptionInMainLoop();
292 Override this member function for any processing which needs to be
293 done as the application is about to exit. OnExit is called after
294 destroying all application windows and controls, but before
295 wxWidgets cleanup. Note that it is not called at all if
298 The return value of this function is currently ignored, return the same
299 value as returned by the base class method if you override it.
301 virtual int OnExit();
304 This function may be called if something fatal happens: an unhandled
305 exception under Win32 or a a fatal signal under Unix, for example. However,
306 this will not happen by default: you have to explicitly call
307 wxHandleFatalExceptions() to enable this.
309 Generally speaking, this function should only show a message to the user and
310 return. You may attempt to save unsaved data but this is not guaranteed to
311 work and, in fact, probably won't.
313 @see wxHandleFatalExceptions()
315 virtual void OnFatalException();
318 This must be provided by the application, and will usually create the
319 application's main window, optionally calling SetTopWindow().
321 You may use OnExit() to clean up anything initialized here, provided
322 that the function returns @true.
324 Notice that if you want to to use the command line processing provided by
325 wxWidgets you have to call the base class version in the derived class
328 Return @true to continue processing, @false to exit the application
331 virtual bool OnInit();
334 Called from OnInit() and may be used to initialize the parser with the
335 command line options for this application. The base class versions adds
336 support for a few standard options only.
338 virtual void OnInitCmdLine(wxCmdLineParser
& parser
);
341 This virtual function is where the execution of a program written in wxWidgets
342 starts. The default implementation just enters the main loop and starts
343 handling the events until it terminates, either because ExitMainLoop() has
344 been explicitly called or because the last frame has been deleted and
345 GetExitOnFrameDelete() flag is @true (this is the default).
347 The return value of this function becomes the exit code of the program, so it
348 should return 0 in case of successful termination.
353 This function is called when an unhandled C++ exception occurs inside
354 OnRun() (the exceptions which occur during the program startup and shutdown
355 might not be caught at all). Notice that by now the main event loop has been
356 terminated and the program will exit, if you want to prevent this from happening
357 (i.e. continue running after catching an exception) you need to override
358 OnExceptionInMainLoop().
360 The default implementation shows information about the exception in debug build
361 but does nothing in the release build.
363 virtual void OnUnhandledException();
366 Returns @true if unprocessed events are in the window system event queue.
370 virtual bool Pending();
373 Set the application name to be used in the user-visible places such as window
374 titles. See GetAppDisplayName() for more about the differences between the
375 display name and name.
377 void SetAppDisplayName(const wxString
& name
);
380 Sets the name of the application. This name should be used for file names,
381 configuration file entries and other internal strings. For the user-visible
382 strings, such as the window titles, the application display name set by
383 SetAppDisplayName() is used instead.
385 By default the application name is set to the name of its executable file.
389 void SetAppName(const wxString
& name
);
392 Sets the class name of the application. This may be used in a platform specific
393 manner to refer to the application.
397 void SetClassName(const wxString
& name
);
400 Allows external code to modify global ::wxTheApp, but you should really
401 know what you're doing if you call it.
404 Replacement for the global application object.
408 static void SetInstance(wxAppConsole
* app
);
411 Set the vendor name to be used in the user-visible places.
412 See GetVendorDisplayName() for more about the differences between the
413 display name and name.
415 void SetVendorDisplayName(const wxString
& name
);
418 Sets the name of application's vendor. The name will be used
419 in registry access. A default name is set by wxWidgets.
423 void SetVendorName(const wxString
& name
);
426 Yields control to pending messages in the windowing system.
428 This can be useful, for example, when a time-consuming process writes to a
429 text window. Without an occasional yield, the text window will not be updated
430 properly, and on systems with cooperative multitasking, such as Windows 3.1
431 other processes will not respond.
433 Caution should be exercised, however, since yielding may allow the
434 user to perform actions which are not compatible with the current task.
435 Disabling menu items or whole menus during processing can avoid unwanted
436 reentrance of code: see ::wxSafeYield for a better function.
438 Note that Yield() will not flush the message logs. This is intentional as
439 calling Yield() is usually done to quickly update the screen and popping up
440 a message box dialog may be undesirable. If you do wish to flush the log
441 messages immediately (otherwise it will be done during the next idle loop
442 iteration), call wxLog::FlushActive.
444 Calling Yield() recursively is normally an error and an assert failure is
445 raised in debug build if such situation is detected. However if the
446 @a onlyIfNeeded parameter is @true, the method will just silently
447 return @false instead.
449 virtual bool Yield(bool onlyIfNeeded
= false);
452 Number of command line arguments (after environment-specific processing).
457 Command line arguments (after environment-specific processing).
459 Under Windows and Linux/Unix, you should parse the command line
460 arguments and check for files to be opened when starting your
461 application. Under OS X, you need to override MacOpenFile()
462 since command line arguments are used differently there.
464 You may use the wxCmdLineParser to parse command line arguments.
475 The wxApp class represents the application itself. It is used to:
477 @li set and get application-wide properties;
478 @li implement the windowing system message or event loop;
479 @li initiate application processing via wxApp::OnInit;
480 @li allow default processing of events not handled by other
481 objects in the application.
483 You should use the macro IMPLEMENT_APP(appClass) in your application
484 implementation file to tell wxWidgets how to create an instance of your
487 Use DECLARE_APP(appClass) in a header file if you want the wxGetApp function
488 (which returns a reference to your application object) to be visible to other
492 @category{appmanagement}
494 @see @ref overview_app
496 class wxApp
: public wxAppConsole
500 Constructor. Called implicitly with a definition of a wxApp object.
505 Destructor. Will be called implicitly on program exit if the wxApp
506 object is created on the stack.
511 Returns @true if the application will exit when the top-level frame is deleted.
513 @see SetExitOnFrameDelete()
515 bool GetExitOnFrameDelete() const;
518 Returns @true if the application will use the best visual on systems that support
519 different visuals, @false otherwise.
521 @see SetUseBestVisual()
523 bool GetUseBestVisual() const;
526 Returns a pointer to the top window.
528 @remarks If the top window hasn't been set using SetTopWindow(),
529 this function will find the first top-level window
530 (frame or dialog) and return that.
534 virtual wxWindow
* GetTopWindow() const;
537 Returns @true if the application is active, i.e. if one of its windows is
538 currently in the foreground.
540 If this function returns @false and you need to attract users attention to
541 the application, you may use wxTopLevelWindow::RequestUserAttention to do it.
543 virtual bool IsActive() const;
546 Windows-only function for processing a message. This function is called
547 from the main message loop, checking for windows that may wish to process it.
549 The function returns @true if the message was processed, @false otherwise.
550 If you use wxWidgets with another class library with its own message loop,
551 you should make sure that this function is called to allow wxWidgets to
552 receive messages. For example, to allow co-existence with the Microsoft
553 Foundation Classes, override the PreTranslateMessage function:
556 // Provide wxWidgets message loop compatibility
557 BOOL CTheApp::PreTranslateMessage(MSG *msg)
559 if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
562 return CWinApp::PreTranslateMessage(msg);
568 bool ProcessMessage(WXMSG
* msg
);
571 Sends idle events to a window and its children.
572 Please note that this function is internal to wxWidgets and shouldn't be used
575 @remarks These functions poll the top-level windows, and their children,
576 for idle event processing. If @true is returned, more OnIdle
577 processing is requested by one or more window.
581 virtual bool SendIdleEvents(wxWindow
* win
, wxIdleEvent
& event
);
584 Allows the programmer to specify whether the application will exit when the
585 top-level frame is deleted.
588 If @true (the default), the application will exit when the top-level frame
589 is deleted. If @false, the application will continue to run.
591 @see GetExitOnFrameDelete(), @ref overview_app_shutdown
593 void SetExitOnFrameDelete(bool flag
);
596 Allows external code to modify global ::wxTheApp, but you should really
597 know what you're doing if you call it.
600 Replacement for the global application object.
604 static void SetInstance(wxAppConsole
* app
);
607 Allows runtime switching of the UI environment theme.
609 Currently implemented for wxGTK2-only.
610 Return @true if theme was successfully changed.
613 The name of the new theme or an absolute path to a gtkrc-theme-file
615 virtual bool SetNativeTheme(const wxString
& theme
);
618 Sets the 'top' window. You can call this from within OnInit() to let wxWidgets
619 know which is the main window. You don't have to set the top window;
620 it is only a convenience so that (for example) certain dialogs without parents
621 can use a specific window as the top window. If no top window is specified by the
622 application, wxWidgets just uses the first frame or dialog in its top-level window
623 list, when it needs to use the top window.
628 @see GetTopWindow(), OnInit()
630 void SetTopWindow(wxWindow
* window
);
633 Allows the programmer to specify whether the application will use the best
634 visual on systems that support several visual on the same display. This is typically
635 the case under Solaris and IRIX, where the default visual is only 8-bit whereas
636 certain applications are supposed to run in TrueColour mode.
638 Note that this function has to be called in the constructor of the wxApp
639 instance and won't have any effect when called later on.
640 This function currently only has effect under GTK.
643 If @true, the app will use the best visual.
644 @param forceTrueColour
645 If @true then the application will try to force using a TrueColour
646 visual and abort the app if none is found.
648 void SetUseBestVisual(bool flag
, bool forceTrueColour
= false);
653 // ============================================================================
654 // Global functions/macros
655 // ============================================================================
658 /** @ingroup group_funcmacro_rtti */
662 This is used in headers to create a forward declaration of the wxGetApp()
663 function implemented by IMPLEMENT_APP().
665 It creates the declaration <tt>className& wxGetApp()</tt>.
675 #define DECLARE_APP( className )
678 This is used in the application class implementation file to make the
679 application class known to wxWidgets for dynamic construction.
691 #define IMPLEMENT_APP( className )
698 The global pointer to the singleton wxApp object.
700 @see wxApp::GetInstance()
706 /** @ingroup group_funcmacro_appinitterm */
710 This function doesn't exist in wxWidgets but it is created by using the
711 IMPLEMENT_APP() macro.
713 Thus, before using it anywhere but in the same module where this macro is
714 used, you must make it available using DECLARE_APP().
716 The advantage of using this function compared to directly using the global
717 ::wxTheApp pointer is that the latter is of type wxApp* and so wouldn't
718 allow you to access the functions specific to your application class but
719 not present in wxApp while wxGetApp() returns the object of the right type.
723 wxAppDerivedClass
& wxGetApp();
726 If @a doIt is @true, the fatal exceptions (also known as general protection
727 faults under Windows or segmentation violations in the Unix world) will be
728 caught and passed to wxApp::OnFatalException.
730 By default, i.e. before this function is called, they will be handled in
731 the normal way which usually just means that the application will be
732 terminated. Calling wxHandleFatalExceptions() with @a doIt equal to @false
733 will restore this default behaviour.
735 Notice that this function is only available if @c wxUSE_ON_FATAL_EXCEPTION
736 is 1 and under Windows platform this requires a compiler with support for
737 SEH (structured exception handling) which currently means only Microsoft
738 Visual C++ or a recent Borland C++ version.
742 bool wxHandleFatalExceptions(bool doIt
= true);
745 This function is used in wxBase only and only if you don't create
746 wxApp object at all. In this case you must call it from your
747 @c main() function before calling any other wxWidgets functions.
749 If the function returns @false the initialization could not be performed,
750 in this case the library cannot be used and wxUninitialize() shouldn't be
753 This function may be called several times but wxUninitialize() must be
754 called for each successful call to this function.
761 This function is for use in console (wxBase) programs only. It must be called
762 once for each previous successful call to wxInitialize().
766 void wxUninitialize();
769 This function wakes up the (internal and platform dependent) idle system,
770 i.e. it will force the system to send an idle event even if the system
771 currently @e is idle and thus would not send any idle event until after
772 some other event would get sent. This is also useful for sending events
773 between two threads and is used by the corresponding functions
774 wxPostEvent() and wxEvtHandler::AddPendingEvent().
784 This function is kept only for backwards compatibility. Please use
785 the wxApp::Yield method instead in any new code.
792 This function is similar to wxYield, except that it disables the user input to
793 all program windows before calling wxYield and re-enables it again
794 afterwards. If @a win is not @NULL, this window will remain enabled,
795 allowing the implementation of some limited user interaction.
796 Returns the result of the call to ::wxYield.
800 bool wxSafeYield(wxWindow
* win
= NULL
, bool onlyIfNeeded
= false);
803 This function initializes wxWidgets in a platform-dependent way. Use this if you
804 are not using the default wxWidgets entry code (e.g. main or WinMain).
806 For example, you can initialize wxWidgets from an Microsoft Foundation Classes
807 (MFC) application using this function.
809 @note This overload of wxEntry is available under all platforms.
815 int wxEntry(int& argc
, wxChar
** argv
);
818 See wxEntry(int&,wxChar**) for more info about this function.
820 Notice that under Windows CE platform, and only there, the type of @a pCmdLine
821 is @c wchar_t *, otherwise it is @c char *, even in Unicode build.
823 @remarks To clean up wxWidgets, call wxApp::OnExit followed by the static
824 function wxApp::CleanUp. For example, if exiting from an MFC application
825 that also uses wxWidgets:
827 int CTheApp::ExitInstance()
829 // OnExit isn't called by CleanUp so must be called explicitly.
833 return CWinApp::ExitInstance();
839 int wxEntry(HINSTANCE hInstance
,
840 HINSTANCE hPrevInstance
= NULL
,
841 char* pCmdLine
= NULL
,
842 int nCmdShow
= SW_SHOWNORMAL
);
848 /** @ingroup group_funcmacro_procctrl */
852 Exits application after calling wxApp::OnExit.
854 Should only be used in an emergency: normally the top-level frame
855 should be deleted (after deleting all other frames) to terminate the
856 application. See wxCloseEvent and wxApp.