1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxAppBase class and macros used for declaration of wxApp
4 // derived class in the user code
5 // Author: Julian Smart
9 // Copyright: (c) Julian Smart
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
13 #ifndef _WX_APP_H_BASE_
14 #define _WX_APP_H_BASE_
16 // ----------------------------------------------------------------------------
17 // headers we have to include here
18 // ----------------------------------------------------------------------------
20 #include "wx/event.h" // for the base class
22 #include "wx/cmdargs.h" // for wxCmdLineArgsArray used by wxApp::argv
23 #include "wx/init.h" // we must declare wxEntry()
24 #include "wx/intl.h" // for wxLayoutDirection
26 class WXDLLIMPEXP_FWD_BASE wxAppConsole
;
27 class WXDLLIMPEXP_FWD_BASE wxAppTraits
;
28 class WXDLLIMPEXP_FWD_BASE wxCmdLineParser
;
29 class WXDLLIMPEXP_FWD_BASE wxEventLoopBase
;
30 class WXDLLIMPEXP_FWD_BASE wxLog
;
31 class WXDLLIMPEXP_FWD_BASE wxMessageOutput
;
34 struct WXDLLIMPEXP_FWD_CORE wxVideoMode
;
37 // ----------------------------------------------------------------------------
39 // ----------------------------------------------------------------------------
41 // the type of the function used to create a wxApp object on program start up
42 typedef wxAppConsole
* (*wxAppInitializerFunction
)();
44 // ----------------------------------------------------------------------------
46 // ----------------------------------------------------------------------------
51 wxPRINT_POSTSCRIPT
= 2
54 // ----------------------------------------------------------------------------
55 // wxAppConsoleBase: wxApp for non-GUI applications
56 // ----------------------------------------------------------------------------
58 class WXDLLIMPEXP_BASE wxAppConsoleBase
: public wxEvtHandler
63 virtual ~wxAppConsoleBase();
66 // the virtual functions which may/must be overridden in the derived class
67 // -----------------------------------------------------------------------
69 // This is the very first function called for a newly created wxApp object,
70 // it is used by the library to do the global initialization. If, for some
71 // reason, you must override it (instead of just overriding OnInit(), as
72 // usual, for app-specific initializations), do not forget to call the base
74 virtual bool Initialize(int& argc
, wxChar
**argv
);
76 // This gives wxCocoa a chance to call OnInit() with a memory pool in place
77 virtual bool CallOnInit() { return OnInit(); }
79 // Called before OnRun(), this is a good place to do initialization -- if
80 // anything fails, return false from here to prevent the program from
81 // continuing. The command line is normally parsed here, call the base
82 // class OnInit() to do it.
83 virtual bool OnInit();
85 // this is here only temporary hopefully (FIXME)
86 virtual bool OnInitGui() { return true; }
88 // This is the replacement for the normal main(): all program work should
89 // be done here. When OnRun() returns, the programs starts shutting down.
92 // This is only called if OnInit() returned true so it's a good place to do
93 // any cleanup matching the initializations done there.
96 // This is the very last function called on wxApp object before it is
97 // destroyed. If you override it (instead of overriding OnExit() as usual)
98 // do not forget to call the base class version!
99 virtual void CleanUp();
101 // Called when a fatal exception occurs, this function should take care not
102 // to do anything which might provoke a nested exception! It may be
103 // overridden if you wish to react somehow in non-default way (core dump
104 // under Unix, application crash under Windows) to fatal program errors,
105 // however extreme care should be taken if you don't want this function to
107 virtual void OnFatalException() { }
109 // Called from wxExit() function, should terminate the application a.s.a.p.
113 // application info: name, description, vendor
114 // -------------------------------------------
116 // NB: all these should be set by the application itself, there are no
117 // reasonable default except for the application name which is taken to
120 // set/get the application name
121 wxString
GetAppName() const
123 return m_appName
.empty() ? m_className
: m_appName
;
125 void SetAppName(const wxString
& name
) { m_appName
= name
; }
127 // set/get the application display name: the display name is the name
128 // shown to the user in titles, reports, etc while the app name is
129 // used for paths, config, and other places the user doesn't see
131 // so the app name could be myapp while display name could be "My App"
132 wxString
GetAppDisplayName() const
134 return m_appDisplayName
.empty() ? GetAppName().Capitalize()
138 void SetAppDisplayName(const wxString
& name
) { m_appDisplayName
= name
; }
140 // set/get the app class name
141 wxString
GetClassName() const { return m_className
; }
142 void SetClassName(const wxString
& name
) { m_className
= name
; }
144 // set/get the vendor name
145 const wxString
& GetVendorName() const { return m_vendorName
; }
146 void SetVendorName(const wxString
& name
) { m_vendorName
= name
; }
148 // set/get the vendor display name: the display name is shown
149 // in titles/reports/dialogs to the user, while the vendor name
150 // is used in some areas such as wxConfig, wxStandardPaths, etc
151 const wxString
& GetVendorDisplayName() const
153 return m_vendorDisplayName
.empty() ? GetVendorName()
154 : m_vendorDisplayName
;
156 void SetVendorDisplayName(const wxString
& name
)
158 m_vendorDisplayName
= name
;
162 // cmd line parsing stuff
163 // ----------------------
165 // all of these methods may be overridden in the derived class to
166 // customize the command line parsing (by default only a few standard
167 // options are handled)
169 // you also need to call wxApp::OnInit() from YourApp::OnInit() for all
172 #if wxUSE_CMDLINE_PARSER
173 // this one is called from OnInit() to add all supported options
174 // to the given parser (don't forget to call the base class version if you
176 virtual void OnInitCmdLine(wxCmdLineParser
& parser
);
178 // called after successfully parsing the command line, return true
179 // to continue and false to exit (don't forget to call the base class
180 // version if you override it!)
181 virtual bool OnCmdLineParsed(wxCmdLineParser
& parser
);
183 // called if "--help" option was specified, return true to continue
185 virtual bool OnCmdLineHelp(wxCmdLineParser
& parser
);
187 // called if incorrect command line options were given, return
188 // false to abort and true to continue
189 virtual bool OnCmdLineError(wxCmdLineParser
& parser
);
190 #endif // wxUSE_CMDLINE_PARSER
193 // miscellaneous customization functions
194 // -------------------------------------
196 // create the app traits object to which we delegate for everything which
197 // either should be configurable by the user (then he can change the
198 // default behaviour simply by overriding CreateTraits() and returning his
199 // own traits object) or which is GUI/console dependent as then wxAppTraits
200 // allows us to abstract the differences behind the common facade
201 wxAppTraits
*GetTraits();
203 // this function provides safer access to traits object than
204 // wxTheApp->GetTraits() during startup or termination when the global
205 // application object itself may be unavailable
207 // of course, it still returns NULL in this case and the caller must check
209 static wxAppTraits
*GetTraitsIfExists();
211 // event processing functions
212 // --------------------------
214 // this method allows to filter all the events processed by the program, so
215 // you should try to return quickly from it to avoid slowing down the
216 // program to the crawl
218 // return value should be -1 to continue with the normal event processing,
219 // or TRUE or FALSE to stop further processing and pretend that the event
220 // had been already processed or won't be processed at all, respectively
221 virtual int FilterEvent(wxEvent
& event
);
224 // call the specified handler on the given object with the given event
226 // this method only exists to allow catching the exceptions thrown by any
227 // event handler, it would lead to an extra (useless) virtual function call
228 // if the exceptions were not used, so it doesn't even exist in that case
229 virtual void HandleEvent(wxEvtHandler
*handler
,
230 wxEventFunction func
,
231 wxEvent
& event
) const;
233 // Called when an unhandled C++ exception occurs inside OnRun(): note that
234 // the main event loop has already terminated by now and the program will
235 // exit, if you need to really handle the exceptions you need to override
236 // OnExceptionInMainLoop()
237 virtual void OnUnhandledException();
238 #endif // wxUSE_EXCEPTIONS
240 // event processing functions
241 // --------------------------
243 // return true if we're running event loop, i.e. if the events can
244 // (already) be dispatched
245 static bool IsMainLoopRunning();
247 // process all events in the wxPendingEvents list -- it is necessary to
248 // call this function to process posted events. This happens during each
249 // event loop iteration in GUI mode but if there is no main loop, it may be
250 // also called directly.
251 virtual void ProcessPendingEvents();
253 // check if there are pending events on global pending event list
254 bool HasPendingEvents() const;
256 // doesn't do anything in this class, just a hook for GUI wxApp
257 virtual bool Yield(bool WXUNUSED(onlyIfNeeded
) = false) { return true; }
259 // make sure that idle events are sent again
260 virtual void WakeUpIdle();
262 // execute the main GUI loop, the function returns when the loop ends
263 virtual int MainLoop();
265 // exit the main GUI loop during the next iteration (i.e. it does not
266 // stop the program immediately!)
267 virtual void ExitMainLoop();
269 // returns true if there are unprocessed events in the event queue
270 virtual bool Pending();
272 // process the first event in the event queue (blocks until an event
273 // appears if there are none currently, use Pending() if this is not
274 // wanted), returns false if the event loop should stop and true
276 virtual bool Dispatch();
278 // this virtual function is called when the application
279 // becomes idle and normally just sends wxIdleEvent to all interested
282 // it should return true if more idle events are needed, false if not
283 virtual bool ProcessIdle();
286 // Function called if an uncaught exception is caught inside the main
287 // event loop: it may return true to continue running the event loop or
288 // false to stop it (in the latter case it may rethrow the exception as
290 virtual bool OnExceptionInMainLoop();
291 #endif // wxUSE_EXCEPTIONS
297 // this function is called when an assert failure occurs, the base class
298 // version does the normal processing (i.e. shows the usual assert failure
301 // the arguments are the location of the failed assert (func may be empty
302 // if the compiler doesn't support C99 __FUNCTION__), the text of the
303 // assert itself and the user-specified message
304 virtual void OnAssertFailure(const wxChar
*file
,
310 // old version of the function without func parameter, for compatibility
311 // only, override OnAssertFailure() in the new code
312 virtual void OnAssert(const wxChar
*file
,
316 #endif // __WXDEBUG__
318 // check that the wxBuildOptions object (constructed in the application
319 // itself, usually the one from IMPLEMENT_APP() macro) matches the build
320 // options of the library and abort if it doesn't
321 static bool CheckBuildOptions(const char *optionsSignature
,
322 const char *componentName
);
324 // implementation only from now on
325 // -------------------------------
327 // helpers for dynamic wxApp construction
328 static void SetInitializerFunction(wxAppInitializerFunction fn
)
329 { ms_appInitFn
= fn
; }
330 static wxAppInitializerFunction
GetInitializerFunction()
331 { return ms_appInitFn
; }
333 // accessors for ms_appInstance field (external code might wish to modify
334 // it, this is why we provide a setter here as well, but you should really
335 // know what you're doing if you call it), wxTheApp is usually used instead
337 static wxAppConsole
*GetInstance() { return ms_appInstance
; }
338 static void SetInstance(wxAppConsole
*app
) { ms_appInstance
= app
; }
341 // command line arguments (public for backwards compatibility)
344 // this object is implicitly convertible to either "char**" (traditional
345 // type of argv parameter of main()) or to "wchar_t **" (for compatibility
346 // with Unicode build in previous wx versions and because the command line
349 wxCmdLineArgsArray argv
;
355 // the function which creates the traits object when GetTraits() needs it
356 // for the first time
357 virtual wxAppTraits
*CreateTraits();
360 // function used for dynamic wxApp creation
361 static wxAppInitializerFunction ms_appInitFn
;
363 // the one and only global application object
364 static wxAppConsole
*ms_appInstance
;
366 // create main loop from AppTraits or return NULL if
367 // there is no main loop implementation
368 wxEventLoopBase
*CreateMainLoop();
370 // application info (must be set from the user code)
371 wxString m_vendorName
, // vendor name ("acme")
372 m_vendorDisplayName
, // vendor display name (e.g. "ACME Inc")
373 m_appName
, // app name ("myapp")
374 m_appDisplayName
, // app display name ("My Application")
375 m_className
; // class name
377 // the class defining the application behaviour, NULL initially and created
378 // by GetTraits() when first needed
379 wxAppTraits
*m_traits
;
381 // the main event loop of the application (may be NULL if the loop hasn't
382 // been started yet or has already terminated)
383 wxEventLoopBase
*m_mainLoop
;
385 // the application object is a singleton anyhow, there is no sense in
387 DECLARE_NO_COPY_CLASS(wxAppConsoleBase
)
390 #if defined(__UNIX__)
391 #include "wx/unix/app.h"
393 // this has to be a class and not a typedef as we forward declare it
394 class wxAppConsole
: public wxAppConsoleBase
{ };
397 // ----------------------------------------------------------------------------
398 // wxAppBase: the common part of wxApp implementations for all platforms
399 // ----------------------------------------------------------------------------
403 class WXDLLIMPEXP_CORE wxAppBase
: public wxAppConsole
407 virtual ~wxAppBase();
409 // the virtual functions which may/must be overridden in the derived class
410 // -----------------------------------------------------------------------
412 // very first initialization function
414 // Override: very rarely
415 virtual bool Initialize(int& argc
, wxChar
**argv
);
417 // a platform-dependent version of OnInit(): the code here is likely to
418 // depend on the toolkit. default version does nothing.
421 virtual bool OnInitGui();
423 // called to start program execution - the default version just enters
424 // the main GUI loop in which events are received and processed until
425 // the last window is not deleted (if GetExitOnFrameDelete) or
426 // ExitMainLoop() is called. In console mode programs, the execution
427 // of the program really starts here
429 // Override: rarely in GUI applications, always in console ones.
432 // a matching function for OnInit()
433 virtual int OnExit();
435 // very last clean up function
437 // Override: very rarely
438 virtual void CleanUp();
441 // the worker functions - usually not used directly by the user code
442 // -----------------------------------------------------------------
446 // process all currently pending events right now
448 // it is an error to call Yield() recursively unless the value of
449 // onlyIfNeeded is true
451 // WARNING: this function is dangerous as it can lead to unexpected
452 // reentrancies (i.e. when called from an event handler it
453 // may result in calling the same event handler again), use
454 // with _extreme_ care or, better, don't use at all!
455 virtual bool Yield(bool onlyIfNeeded
= false) = 0;
457 // this virtual function is called in the GUI mode when the application
458 // becomes idle and normally just sends wxIdleEvent to all interested
461 // it should return true if more idle events are needed, false if not
462 virtual bool ProcessIdle();
464 // Send idle event to window and all subwindows
465 // Returns true if more idle time is requested.
466 virtual bool SendIdleEvents(wxWindow
* win
, wxIdleEvent
& event
);
469 // top level window functions
470 // --------------------------
472 // return true if our app has focus
473 virtual bool IsActive() const { return m_isActive
; }
475 // set the "main" top level window
476 void SetTopWindow(wxWindow
*win
) { m_topWindow
= win
; }
478 // return the "main" top level window (if it hadn't been set previously
479 // with SetTopWindow(), will return just some top level window and, if
480 // there are none, will return NULL)
481 virtual wxWindow
*GetTopWindow() const;
483 // control the exit behaviour: by default, the program will exit the
484 // main loop (and so, usually, terminate) when the last top-level
485 // program window is deleted. Beware that if you disable this behaviour
486 // (with SetExitOnFrameDelete(false)), you'll have to call
487 // ExitMainLoop() explicitly from somewhere.
488 void SetExitOnFrameDelete(bool flag
)
489 { m_exitOnFrameDelete
= flag
? Yes
: No
; }
490 bool GetExitOnFrameDelete() const
491 { return m_exitOnFrameDelete
== Yes
; }
494 // display mode, visual, printing mode, ...
495 // ------------------------------------------------------------------------
497 // Get display mode that is used use. This is only used in framebuffer
498 // wxWin ports (such as wxMGL or wxDFB).
499 virtual wxVideoMode
GetDisplayMode() const;
500 // Set display mode to use. This is only used in framebuffer wxWin
501 // ports (such as wxMGL or wxDFB). This method should be called from
503 virtual bool SetDisplayMode(const wxVideoMode
& WXUNUSED(info
)) { return true; }
505 // set use of best visual flag (see below)
506 void SetUseBestVisual( bool flag
, bool forceTrueColour
= false )
507 { m_useBestVisual
= flag
; m_forceTrueColour
= forceTrueColour
; }
508 bool GetUseBestVisual() const { return m_useBestVisual
; }
510 // set/get printing mode: see wxPRINT_XXX constants.
512 // default behaviour is the normal one for Unix: always use PostScript
514 virtual void SetPrintMode(int WXUNUSED(mode
)) { }
515 int GetPrintMode() const { return wxPRINT_POSTSCRIPT
; }
517 // Return the layout direction for the current locale or wxLayout_Default
519 virtual wxLayoutDirection
GetLayoutDirection() const;
521 // Change the theme used by the application, return true on success.
522 virtual bool SetNativeTheme(const wxString
& WXUNUSED(theme
)) { return false; }
525 // command line parsing (GUI-specific)
526 // ------------------------------------------------------------------------
528 #if wxUSE_CMDLINE_PARSER
529 virtual bool OnCmdLineParsed(wxCmdLineParser
& parser
);
530 virtual void OnInitCmdLine(wxCmdLineParser
& parser
);
533 // miscellaneous other stuff
534 // ------------------------------------------------------------------------
536 // called by toolkit-specific code to set the app status: active (we have
537 // focus) or not and also the last window which had focus before we were
539 virtual void SetActive(bool isActive
, wxWindow
*lastFocus
);
541 #if WXWIN_COMPATIBILITY_2_6
542 // OBSOLETE: don't use, always returns true
544 // returns true if the program is successfully initialized
545 wxDEPRECATED( bool Initialized() );
546 #endif // WXWIN_COMPATIBILITY_2_6
549 // delete all objects in wxPendingDelete list
550 void DeletePendingObjects();
552 // override base class method to use GUI traits
553 virtual wxAppTraits
*CreateTraits();
556 // the main top level window (may be NULL)
557 wxWindow
*m_topWindow
;
559 // if Yes, exit the main loop when the last top level window is deleted, if
560 // No don't do it and if Later -- only do it once we reach our OnRun()
562 // the explanation for using this strange scheme is given in appcmn.cpp
568 } m_exitOnFrameDelete
;
570 // true if the app wants to use the best visual on systems where
571 // more than one are available (Sun, SGI, XFree86 4.0 ?)
572 bool m_useBestVisual
;
573 // force TrueColour just in case "best" isn't TrueColour
574 bool m_forceTrueColour
;
576 // does any of our windows have focus?
580 DECLARE_NO_COPY_CLASS(wxAppBase
)
583 #if WXWIN_COMPATIBILITY_2_6
584 inline bool wxAppBase::Initialized() { return true; }
585 #endif // WXWIN_COMPATIBILITY_2_6
587 // ----------------------------------------------------------------------------
588 // now include the declaration of the real class
589 // ----------------------------------------------------------------------------
591 #if defined(__WXPALMOS__)
592 #include "wx/palmos/app.h"
593 #elif defined(__WXMSW__)
594 #include "wx/msw/app.h"
595 #elif defined(__WXMOTIF__)
596 #include "wx/motif/app.h"
597 #elif defined(__WXMGL__)
598 #include "wx/mgl/app.h"
599 #elif defined(__WXDFB__)
600 #include "wx/dfb/app.h"
601 #elif defined(__WXGTK20__)
602 #include "wx/gtk/app.h"
603 #elif defined(__WXGTK__)
604 #include "wx/gtk1/app.h"
605 #elif defined(__WXX11__)
606 #include "wx/x11/app.h"
607 #elif defined(__WXMAC__)
608 #include "wx/osx/app.h"
609 #elif defined(__WXCOCOA__)
610 #include "wx/cocoa/app.h"
611 #elif defined(__WXPM__)
612 #include "wx/os2/app.h"
617 // wxApp is defined in core and we cannot define another one in wxBase,
618 // so use the preprocessor to allow using wxApp in console programs too
619 #define wxApp wxAppConsole
623 // ----------------------------------------------------------------------------
625 // ----------------------------------------------------------------------------
627 // for compatibility, we define this macro to access the global application
628 // object of type wxApp
630 // note that instead of using of wxTheApp in application code you should
631 // consider using DECLARE_APP() after which you may call wxGetApp() which will
632 // return the object of the correct type (i.e. MyApp and not wxApp)
634 // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
635 // console mode it does nothing at all
636 #define wxTheApp static_cast<wxApp*>(wxApp::GetInstance())
638 // ----------------------------------------------------------------------------
640 // ----------------------------------------------------------------------------
642 // event loop related functions only work in GUI programs
643 // ------------------------------------------------------
645 // Force an exit from main loop
646 extern void WXDLLIMPEXP_BASE
wxExit();
648 // avoid redeclaring this function here if it had been already declated by
649 // wx/utils.h, this results in warnings from g++ with -Wredundant-decls
650 #ifndef wx_YIELD_DECLARED
651 #define wx_YIELD_DECLARED
653 // Yield to other apps/messages
654 extern bool WXDLLIMPEXP_BASE
wxYield();
656 #endif // wx_YIELD_DECLARED
658 // Yield to other apps/messages
659 extern void WXDLLIMPEXP_BASE
wxWakeUpIdle();
661 // ----------------------------------------------------------------------------
662 // macros for dynamic creation of the application object
663 // ----------------------------------------------------------------------------
665 // Having a global instance of this class allows wxApp to be aware of the app
666 // creator function. wxApp can then call this function to create a new app
667 // object. Convoluted, but necessary.
669 class WXDLLIMPEXP_BASE wxAppInitializer
672 wxAppInitializer(wxAppInitializerFunction fn
)
673 { wxApp::SetInitializerFunction(fn
); }
676 // the code below defines a IMPLEMENT_WXWIN_MAIN macro which you can use if
677 // your compiler really, really wants main() to be in your main program (e.g.
678 // hello.cpp). Now IMPLEMENT_APP should add this code if required.
680 #define IMPLEMENT_WXWIN_MAIN_CONSOLE \
681 int main(int argc, char **argv) { return wxEntry(argc, argv); }
683 // port-specific header could have defined it already in some special way
684 #ifndef IMPLEMENT_WXWIN_MAIN
685 #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE
686 #endif // defined(IMPLEMENT_WXWIN_MAIN)
688 #ifdef __WXUNIVERSAL__
689 #include "wx/univ/theme.h"
691 #ifdef wxUNIV_DEFAULT_THEME
692 #define IMPLEMENT_WX_THEME_SUPPORT \
693 WX_USE_THEME(wxUNIV_DEFAULT_THEME);
695 #define IMPLEMENT_WX_THEME_SUPPORT
698 #define IMPLEMENT_WX_THEME_SUPPORT
701 // Use this macro if you want to define your own main() or WinMain() function
702 // and call wxEntry() from there.
703 #define IMPLEMENT_APP_NO_MAIN(appname) \
704 wxAppConsole *wxCreateApp() \
706 wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE, \
708 return new appname; \
711 wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
712 DECLARE_APP(appname) \
713 appname& wxGetApp() { return *static_cast<appname*>(wxApp::GetInstance()); }
715 // Same as IMPLEMENT_APP() normally but doesn't include themes support in
716 // wxUniversal builds
717 #define IMPLEMENT_APP_NO_THEMES(appname) \
718 IMPLEMENT_APP_NO_MAIN(appname) \
721 // Use this macro exactly once, the argument is the name of the wxApp-derived
722 // class which is the class of your application.
723 #define IMPLEMENT_APP(appname) \
724 IMPLEMENT_APP_NO_THEMES(appname) \
725 IMPLEMENT_WX_THEME_SUPPORT
727 // Same as IMPLEMENT_APP(), but for console applications.
728 #define IMPLEMENT_APP_CONSOLE(appname) \
729 IMPLEMENT_APP_NO_MAIN(appname) \
730 IMPLEMENT_WXWIN_MAIN_CONSOLE
732 // this macro can be used multiple times and just allows you to use wxGetApp()
734 #define DECLARE_APP(appname) extern appname& wxGetApp();
737 // declare the stuff defined by IMPLEMENT_APP() macro, it's not really needed
738 // anywhere else but at the very least it suppresses icc warnings about
739 // defining extern symbols without prior declaration, and it shouldn't do any
741 extern wxAppConsole
*wxCreateApp();
742 extern wxAppInitializer wxTheAppInitializer
;
744 #endif // _WX_APP_H_BASE_