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 class 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() : m_appDisplayName
;
136 void SetAppDisplayName(const wxString
& name
) { m_appDisplayName
= name
; }
138 // set/get the app class name
139 wxString
GetClassName() const { return m_className
; }
140 void SetClassName(const wxString
& name
) { m_className
= name
; }
142 // set/get the vendor name
143 const wxString
& GetVendorName() const { return m_vendorName
; }
144 void SetVendorName(const wxString
& name
) { m_vendorName
= name
; }
146 // set/get the vendor display name: the display name is shown
147 // in titles/reports/dialogs to the user, while the vendor name
148 // is used in some areas such as wxConfig, wxStandardPaths, etc
149 const wxString
& GetVendorDisplayName() const
151 return m_vendorDisplayName
.empty() ? GetVendorName()
152 : m_vendorDisplayName
;
154 void SetVendorDisplayName(const wxString
& name
)
156 m_vendorDisplayName
= name
;
160 // cmd line parsing stuff
161 // ----------------------
163 // all of these methods may be overridden in the derived class to
164 // customize the command line parsing (by default only a few standard
165 // options are handled)
167 // you also need to call wxApp::OnInit() from YourApp::OnInit() for all
170 #if wxUSE_CMDLINE_PARSER
171 // this one is called from OnInit() to add all supported options
172 // to the given parser (don't forget to call the base class version if you
174 virtual void OnInitCmdLine(wxCmdLineParser
& parser
);
176 // called after successfully parsing the command line, return true
177 // to continue and false to exit (don't forget to call the base class
178 // version if you override it!)
179 virtual bool OnCmdLineParsed(wxCmdLineParser
& parser
);
181 // called if "--help" option was specified, return true to continue
183 virtual bool OnCmdLineHelp(wxCmdLineParser
& parser
);
185 // called if incorrect command line options were given, return
186 // false to abort and true to continue
187 virtual bool OnCmdLineError(wxCmdLineParser
& parser
);
188 #endif // wxUSE_CMDLINE_PARSER
191 // miscellaneous customization functions
192 // -------------------------------------
194 // create the app traits object to which we delegate for everything which
195 // either should be configurable by the user (then he can change the
196 // default behaviour simply by overriding CreateTraits() and returning his
197 // own traits object) or which is GUI/console dependent as then wxAppTraits
198 // allows us to abstract the differences behind the common facade
199 wxAppTraits
*GetTraits();
202 // event processing functions
203 // --------------------------
205 // this method allows to filter all the events processed by the program, so
206 // you should try to return quickly from it to avoid slowing down the
207 // program to the crawl
209 // return value should be -1 to continue with the normal event processing,
210 // or TRUE or FALSE to stop further processing and pretend that the event
211 // had been already processed or won't be processed at all, respectively
212 virtual int FilterEvent(wxEvent
& event
);
215 // call the specified handler on the given object with the given event
217 // this method only exists to allow catching the exceptions thrown by any
218 // event handler, it would lead to an extra (useless) virtual function call
219 // if the exceptions were not used, so it doesn't even exist in that case
220 virtual void HandleEvent(wxEvtHandler
*handler
,
221 wxEventFunction func
,
222 wxEvent
& event
) const;
224 // Called when an unhandled C++ exception occurs inside OnRun(): note that
225 // the main event loop has already terminated by now and the program will
226 // exit, if you need to really handle the exceptions you need to override
227 // OnExceptionInMainLoop()
228 virtual void OnUnhandledException();
229 #endif // wxUSE_EXCEPTIONS
231 // event processing functions
232 // --------------------------
234 // return true if we're running event loop, i.e. if the events can
235 // (already) be dispatched
236 static bool IsMainLoopRunning();
238 // process all events in the wxPendingEvents list -- it is necessary to
239 // call this function to process posted events. This happens during each
240 // event loop iteration in GUI mode but if there is no main loop, it may be
241 // also called directly.
242 virtual void ProcessPendingEvents();
244 // check if there are pending events on global pending event list
245 bool HasPendingEvents() const;
247 // doesn't do anything in this class, just a hook for GUI wxApp
248 virtual bool Yield(bool WXUNUSED(onlyIfNeeded
) = false) { return true; }
250 // make sure that idle events are sent again
251 virtual void WakeUpIdle();
253 // execute the main GUI loop, the function returns when the loop ends
254 virtual int MainLoop();
256 // exit the main GUI loop during the next iteration (i.e. it does not
257 // stop the program immediately!)
258 virtual void ExitMainLoop();
260 // returns true if there are unprocessed events in the event queue
261 virtual bool Pending();
263 // process the first event in the event queue (blocks until an event
264 // appears if there are none currently, use Pending() if this is not
265 // wanted), returns false if the event loop should stop and true
267 virtual bool Dispatch();
269 // this virtual function is called when the application
270 // becomes idle and normally just sends wxIdleEvent to all interested
273 // it should return true if more idle events are needed, false if not
274 virtual bool ProcessIdle();
277 // Function called if an uncaught exception is caught inside the main
278 // event loop: it may return true to continue running the event loop or
279 // false to stop it (in the latter case it may rethrow the exception as
281 virtual bool OnExceptionInMainLoop();
282 #endif // wxUSE_EXCEPTIONS
288 // this function is called when an assert failure occurs, the base class
289 // version does the normal processing (i.e. shows the usual assert failure
292 // the arguments are the location of the failed assert (func may be empty
293 // if the compiler doesn't support C99 __FUNCTION__), the text of the
294 // assert itself and the user-specified message
295 virtual void OnAssertFailure(const wxChar
*file
,
301 // old version of the function without func parameter, for compatibility
302 // only, override OnAssertFailure() in the new code
303 virtual void OnAssert(const wxChar
*file
,
307 #endif // __WXDEBUG__
309 // check that the wxBuildOptions object (constructed in the application
310 // itself, usually the one from IMPLEMENT_APP() macro) matches the build
311 // options of the library and abort if it doesn't
312 static bool CheckBuildOptions(const char *optionsSignature
,
313 const char *componentName
);
315 // implementation only from now on
316 // -------------------------------
318 // helpers for dynamic wxApp construction
319 static void SetInitializerFunction(wxAppInitializerFunction fn
)
320 { ms_appInitFn
= fn
; }
321 static wxAppInitializerFunction
GetInitializerFunction()
322 { return ms_appInitFn
; }
324 // accessors for ms_appInstance field (external code might wish to modify
325 // it, this is why we provide a setter here as well, but you should really
326 // know what you're doing if you call it), wxTheApp is usually used instead
328 static wxAppConsole
*GetInstance() { return ms_appInstance
; }
329 static void SetInstance(wxAppConsole
*app
) { ms_appInstance
= app
; }
332 // command line arguments (public for backwards compatibility)
335 // this object is implicitly convertible to either "char**" (traditional
336 // type of argv parameter of main()) or to "wchar_t **" (for compatibility
337 // with Unicode build in previous wx versions and because the command line
340 wxCmdLineArgsArray argv
;
346 // the function which creates the traits object when GetTraits() needs it
347 // for the first time
348 virtual wxAppTraits
*CreateTraits();
351 // function used for dynamic wxApp creation
352 static wxAppInitializerFunction ms_appInitFn
;
354 // the one and only global application object
355 static wxAppConsole
*ms_appInstance
;
357 // create main loop from AppTraits or return NULL if
358 // there is no main loop implementation
359 wxEventLoopBase
*CreateMainLoop();
361 // application info (must be set from the user code)
362 wxString m_vendorName
, // vendor name ("acme")
363 m_vendorDisplayName
, // vendor display name (e.g. "ACME Inc")
364 m_appName
, // app name ("myapp")
365 m_appDisplayName
, // app display name ("My Application")
366 m_className
; // class name
368 // the class defining the application behaviour, NULL initially and created
369 // by GetTraits() when first needed
370 wxAppTraits
*m_traits
;
372 // the main event loop of the application (may be NULL if the loop hasn't
373 // been started yet or has already terminated)
374 wxEventLoopBase
*m_mainLoop
;
376 // the application object is a singleton anyhow, there is no sense in
378 DECLARE_NO_COPY_CLASS(wxAppConsoleBase
)
381 #if defined(__UNIX__)
382 #include "wx/unix/app.h"
384 // this has to be a class and not a typedef as we forward declare it
385 class wxAppConsole
: public wxAppConsoleBase
{ };
388 // ----------------------------------------------------------------------------
389 // wxAppBase: the common part of wxApp implementations for all platforms
390 // ----------------------------------------------------------------------------
394 class WXDLLIMPEXP_CORE wxAppBase
: public wxAppConsole
398 virtual ~wxAppBase();
400 // the virtual functions which may/must be overridden in the derived class
401 // -----------------------------------------------------------------------
403 // very first initialization function
405 // Override: very rarely
406 virtual bool Initialize(int& argc
, wxChar
**argv
);
408 // a platform-dependent version of OnInit(): the code here is likely to
409 // depend on the toolkit. default version does nothing.
412 virtual bool OnInitGui();
414 // called to start program execution - the default version just enters
415 // the main GUI loop in which events are received and processed until
416 // the last window is not deleted (if GetExitOnFrameDelete) or
417 // ExitMainLoop() is called. In console mode programs, the execution
418 // of the program really starts here
420 // Override: rarely in GUI applications, always in console ones.
423 // a matching function for OnInit()
424 virtual int OnExit();
426 // very last clean up function
428 // Override: very rarely
429 virtual void CleanUp();
432 // the worker functions - usually not used directly by the user code
433 // -----------------------------------------------------------------
437 // process all currently pending events right now
439 // it is an error to call Yield() recursively unless the value of
440 // onlyIfNeeded is true
442 // WARNING: this function is dangerous as it can lead to unexpected
443 // reentrancies (i.e. when called from an event handler it
444 // may result in calling the same event handler again), use
445 // with _extreme_ care or, better, don't use at all!
446 virtual bool Yield(bool onlyIfNeeded
= false) = 0;
448 // this virtual function is called in the GUI mode when the application
449 // becomes idle and normally just sends wxIdleEvent to all interested
452 // it should return true if more idle events are needed, false if not
453 virtual bool ProcessIdle();
455 // Send idle event to window and all subwindows
456 // Returns true if more idle time is requested.
457 virtual bool SendIdleEvents(wxWindow
* win
, wxIdleEvent
& event
);
460 // top level window functions
461 // --------------------------
463 // return true if our app has focus
464 virtual bool IsActive() const { return m_isActive
; }
466 // set the "main" top level window
467 void SetTopWindow(wxWindow
*win
) { m_topWindow
= win
; }
469 // return the "main" top level window (if it hadn't been set previously
470 // with SetTopWindow(), will return just some top level window and, if
471 // there are none, will return NULL)
472 virtual wxWindow
*GetTopWindow() const;
474 // control the exit behaviour: by default, the program will exit the
475 // main loop (and so, usually, terminate) when the last top-level
476 // program window is deleted. Beware that if you disable this behaviour
477 // (with SetExitOnFrameDelete(false)), you'll have to call
478 // ExitMainLoop() explicitly from somewhere.
479 void SetExitOnFrameDelete(bool flag
)
480 { m_exitOnFrameDelete
= flag
? Yes
: No
; }
481 bool GetExitOnFrameDelete() const
482 { return m_exitOnFrameDelete
== Yes
; }
485 // display mode, visual, printing mode, ...
486 // ------------------------------------------------------------------------
488 // Get display mode that is used use. This is only used in framebuffer
489 // wxWin ports (such as wxMGL or wxDFB).
490 virtual wxVideoMode
GetDisplayMode() const;
491 // Set display mode to use. This is only used in framebuffer wxWin
492 // ports (such as wxMGL or wxDFB). This method should be called from
494 virtual bool SetDisplayMode(const wxVideoMode
& WXUNUSED(info
)) { return true; }
496 // set use of best visual flag (see below)
497 void SetUseBestVisual( bool flag
, bool forceTrueColour
= false )
498 { m_useBestVisual
= flag
; m_forceTrueColour
= forceTrueColour
; }
499 bool GetUseBestVisual() const { return m_useBestVisual
; }
501 // set/get printing mode: see wxPRINT_XXX constants.
503 // default behaviour is the normal one for Unix: always use PostScript
505 virtual void SetPrintMode(int WXUNUSED(mode
)) { }
506 int GetPrintMode() const { return wxPRINT_POSTSCRIPT
; }
508 // Return the layout direction for the current locale or wxLayout_Default
510 virtual wxLayoutDirection
GetLayoutDirection() const;
512 // Change the theme used by the application, return true on success.
513 virtual bool SetNativeTheme(const wxString
& WXUNUSED(theme
)) { return false; }
516 // command line parsing (GUI-specific)
517 // ------------------------------------------------------------------------
519 #if wxUSE_CMDLINE_PARSER
520 virtual bool OnCmdLineParsed(wxCmdLineParser
& parser
);
521 virtual void OnInitCmdLine(wxCmdLineParser
& parser
);
524 // miscellaneous other stuff
525 // ------------------------------------------------------------------------
527 // called by toolkit-specific code to set the app status: active (we have
528 // focus) or not and also the last window which had focus before we were
530 virtual void SetActive(bool isActive
, wxWindow
*lastFocus
);
532 #if WXWIN_COMPATIBILITY_2_6
533 // OBSOLETE: don't use, always returns true
535 // returns true if the program is successfully initialized
536 wxDEPRECATED( bool Initialized() );
537 #endif // WXWIN_COMPATIBILITY_2_6
540 // delete all objects in wxPendingDelete list
541 void DeletePendingObjects();
543 // override base class method to use GUI traits
544 virtual wxAppTraits
*CreateTraits();
547 // the main top level window (may be NULL)
548 wxWindow
*m_topWindow
;
550 // if Yes, exit the main loop when the last top level window is deleted, if
551 // No don't do it and if Later -- only do it once we reach our OnRun()
553 // the explanation for using this strange scheme is given in appcmn.cpp
559 } m_exitOnFrameDelete
;
561 // true if the app wants to use the best visual on systems where
562 // more than one are available (Sun, SGI, XFree86 4.0 ?)
563 bool m_useBestVisual
;
564 // force TrueColour just in case "best" isn't TrueColour
565 bool m_forceTrueColour
;
567 // does any of our windows have focus?
571 DECLARE_NO_COPY_CLASS(wxAppBase
)
574 #if WXWIN_COMPATIBILITY_2_6
575 inline bool wxAppBase::Initialized() { return true; }
576 #endif // WXWIN_COMPATIBILITY_2_6
578 // ----------------------------------------------------------------------------
579 // now include the declaration of the real class
580 // ----------------------------------------------------------------------------
582 #if defined(__WXPALMOS__)
583 #include "wx/palmos/app.h"
584 #elif defined(__WXMSW__)
585 #include "wx/msw/app.h"
586 #elif defined(__WXMOTIF__)
587 #include "wx/motif/app.h"
588 #elif defined(__WXMGL__)
589 #include "wx/mgl/app.h"
590 #elif defined(__WXDFB__)
591 #include "wx/dfb/app.h"
592 #elif defined(__WXGTK20__)
593 #include "wx/gtk/app.h"
594 #elif defined(__WXGTK__)
595 #include "wx/gtk1/app.h"
596 #elif defined(__WXX11__)
597 #include "wx/x11/app.h"
598 #elif defined(__WXMAC__)
599 #include "wx/mac/app.h"
600 #elif defined(__WXCOCOA__)
601 #include "wx/cocoa/app.h"
602 #elif defined(__WXPM__)
603 #include "wx/os2/app.h"
608 // wxApp is defined in core and we cannot define another one in wxBase,
609 // so use the preprocessor to allow using wxApp in console programs too
610 #define wxApp wxAppConsole
614 // ----------------------------------------------------------------------------
616 // ----------------------------------------------------------------------------
618 // for compatibility, we define this macro to access the global application
619 // object of type wxApp
621 // note that instead of using of wxTheApp in application code you should
622 // consider using DECLARE_APP() after which you may call wxGetApp() which will
623 // return the object of the correct type (i.e. MyApp and not wxApp)
625 // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
626 // console mode it does nothing at all
627 #define wxTheApp wx_static_cast(wxApp*, wxApp::GetInstance())
629 // ----------------------------------------------------------------------------
631 // ----------------------------------------------------------------------------
633 // event loop related functions only work in GUI programs
634 // ------------------------------------------------------
636 // Force an exit from main loop
637 extern void WXDLLIMPEXP_BASE
wxExit();
639 // avoid redeclaring this function here if it had been already declated by
640 // wx/utils.h, this results in warnings from g++ with -Wredundant-decls
641 #ifndef wx_YIELD_DECLARED
642 #define wx_YIELD_DECLARED
644 // Yield to other apps/messages
645 extern bool WXDLLIMPEXP_BASE
wxYield();
647 #endif // wx_YIELD_DECLARED
649 // Yield to other apps/messages
650 extern void WXDLLIMPEXP_BASE
wxWakeUpIdle();
652 // ----------------------------------------------------------------------------
653 // macros for dynamic creation of the application object
654 // ----------------------------------------------------------------------------
656 // Having a global instance of this class allows wxApp to be aware of the app
657 // creator function. wxApp can then call this function to create a new app
658 // object. Convoluted, but necessary.
660 class WXDLLIMPEXP_BASE wxAppInitializer
663 wxAppInitializer(wxAppInitializerFunction fn
)
664 { wxApp::SetInitializerFunction(fn
); }
667 // the code below defines a IMPLEMENT_WXWIN_MAIN macro which you can use if
668 // your compiler really, really wants main() to be in your main program (e.g.
669 // hello.cpp). Now IMPLEMENT_APP should add this code if required.
671 #define IMPLEMENT_WXWIN_MAIN_CONSOLE \
672 int main(int argc, char **argv) { return wxEntry(argc, argv); }
674 // port-specific header could have defined it already in some special way
675 #ifndef IMPLEMENT_WXWIN_MAIN
676 #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE
677 #endif // defined(IMPLEMENT_WXWIN_MAIN)
679 #ifdef __WXUNIVERSAL__
680 #include "wx/univ/theme.h"
682 #ifdef wxUNIV_DEFAULT_THEME
683 #define IMPLEMENT_WX_THEME_SUPPORT \
684 WX_USE_THEME(wxUNIV_DEFAULT_THEME);
686 #define IMPLEMENT_WX_THEME_SUPPORT
689 #define IMPLEMENT_WX_THEME_SUPPORT
692 // Use this macro if you want to define your own main() or WinMain() function
693 // and call wxEntry() from there.
694 #define IMPLEMENT_APP_NO_MAIN(appname) \
695 wxAppConsole *wxCreateApp() \
697 wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE, \
699 return new appname; \
702 wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
703 DECLARE_APP(appname) \
704 appname& wxGetApp() { return *wx_static_cast(appname*, wxApp::GetInstance()); }
706 // Same as IMPLEMENT_APP() normally but doesn't include themes support in
707 // wxUniversal builds
708 #define IMPLEMENT_APP_NO_THEMES(appname) \
709 IMPLEMENT_APP_NO_MAIN(appname) \
712 // Use this macro exactly once, the argument is the name of the wxApp-derived
713 // class which is the class of your application.
714 #define IMPLEMENT_APP(appname) \
715 IMPLEMENT_APP_NO_THEMES(appname) \
716 IMPLEMENT_WX_THEME_SUPPORT
718 // Same as IMPLEMENT_APP(), but for console applications.
719 #define IMPLEMENT_APP_CONSOLE(appname) \
720 IMPLEMENT_APP_NO_MAIN(appname) \
721 IMPLEMENT_WXWIN_MAIN_CONSOLE
723 // this macro can be used multiple times and just allows you to use wxGetApp()
725 #define DECLARE_APP(appname) extern appname& wxGetApp();
728 // declare the stuff defined by IMPLEMENT_APP() macro, it's not really needed
729 // anywhere else but at the very least it suppresses icc warnings about
730 // defining extern symbols without prior declaration, and it shouldn't do any
732 extern wxAppConsole
*wxCreateApp();
733 extern wxAppInitializer wxTheAppInitializer
;
735 #endif // _WX_APP_H_BASE_