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
23 #include "wx/window.h" // for wxTopLevelWindows
25 #include "wx/vidmode.h"
29 #include "wx/init.h" // we must declare wxEntry()
31 class WXDLLIMPEXP_BASE wxAppConsole
;
32 class WXDLLIMPEXP_BASE wxAppTraits
;
33 class WXDLLIMPEXP_BASE wxCmdLineParser
;
34 class WXDLLIMPEXP_BASE wxLog
;
35 class WXDLLIMPEXP_BASE wxMessageOutput
;
37 // wxUSE_EVTLOOP_IN_APP is a temporary hack needed until all ports are updated
38 // to use wxEventLoop, otherwise we get linking errors on wxMac, it's going to
41 #define wxUSE_EVTLOOP_IN_APP 0
43 #define wxUSE_EVTLOOP_IN_APP 1
44 class WXDLLEXPORT wxEventLoop
;
47 // ----------------------------------------------------------------------------
49 // ----------------------------------------------------------------------------
51 // the type of the function used to create a wxApp object on program start up
52 typedef wxAppConsole
* (*wxAppInitializerFunction
)();
54 // ----------------------------------------------------------------------------
56 // ----------------------------------------------------------------------------
61 wxPRINT_POSTSCRIPT
= 2
64 // ----------------------------------------------------------------------------
65 // wxAppConsole: wxApp for non-GUI applications
66 // ----------------------------------------------------------------------------
68 class WXDLLIMPEXP_BASE wxAppConsole
: public wxEvtHandler
73 virtual ~wxAppConsole();
76 // the virtual functions which may/must be overridden in the derived class
77 // -----------------------------------------------------------------------
79 // This is the very first function called for a newly created wxApp object,
80 // it is used by the library to do the global initialization. If, for some
81 // reason, you must override it (instead of just overriding OnInit(), as
82 // usual, for app-specific initializations), do not forget to call the base
84 virtual bool Initialize(int& argc
, wxChar
**argv
);
86 // This gives wxCocoa a chance to call OnInit() with a memory pool in place
87 virtual bool CallOnInit() { return OnInit(); }
89 // Called before OnRun(), this is a good place to do initialization -- if
90 // anything fails, return false from here to prevent the program from
91 // continuing. The command line is normally parsed here, call the base
92 // class OnInit() to do it.
93 virtual bool OnInit();
95 // this is here only temporary hopefully (FIXME)
96 virtual bool OnInitGui() { return true; }
98 // This is the replacement for the normal main(): all program work should
99 // be done here. When OnRun() returns, the programs starts shutting down.
100 virtual int OnRun() = 0;
102 // This is only called if OnInit() returned true so it's a good place to do
103 // any cleanup matching the initializations done there.
104 virtual int OnExit();
106 // This is the very last function called on wxApp object before it is
107 // destroyed. If you override it (instead of overriding OnExit() as usual)
108 // do not forget to call the base class version!
109 virtual void CleanUp();
111 // Called when a fatal exception occurs, this function should take care not
112 // to do anything which might provoke a nested exception! It may be
113 // overridden if you wish to react somehow in non-default way (core dump
114 // under Unix, application crash under Windows) to fatal program errors,
115 // however extreme care should be taken if you don't want this function to
117 virtual void OnFatalException() { }
119 // Called from wxExit() function, should terminate the application a.s.a.p.
123 // application info: name, description, vendor
124 // -------------------------------------------
126 // NB: all these should be set by the application itself, there are no
127 // reasonable default except for the application name which is taken to
130 // set/get the application name
131 wxString
GetAppName() const
133 return m_appName
.empty() ? m_className
: m_appName
;
135 void SetAppName(const wxString
& name
) { m_appName
= name
; }
137 // set/get the app class name
138 wxString
GetClassName() const { return m_className
; }
139 void SetClassName(const wxString
& name
) { m_className
= name
; }
141 // set/get the vendor name
142 const wxString
& GetVendorName() const { return m_vendorName
; }
143 void SetVendorName(const wxString
& name
) { m_vendorName
= name
; }
146 // cmd line parsing stuff
147 // ----------------------
149 // all of these methods may be overridden in the derived class to
150 // customize the command line parsing (by default only a few standard
151 // options are handled)
153 // you also need to call wxApp::OnInit() from YourApp::OnInit() for all
156 #if wxUSE_CMDLINE_PARSER
157 // this one is called from OnInit() to add all supported options
158 // to the given parser (don't forget to call the base class version if you
160 virtual void OnInitCmdLine(wxCmdLineParser
& parser
);
162 // called after successfully parsing the command line, return true
163 // to continue and false to exit (don't forget to call the base class
164 // version if you override it!)
165 virtual bool OnCmdLineParsed(wxCmdLineParser
& parser
);
167 // called if "--help" option was specified, return true to continue
169 virtual bool OnCmdLineHelp(wxCmdLineParser
& parser
);
171 // called if incorrect command line options were given, return
172 // false to abort and true to continue
173 virtual bool OnCmdLineError(wxCmdLineParser
& parser
);
174 #endif // wxUSE_CMDLINE_PARSER
177 // miscellaneous customization functions
178 // -------------------------------------
180 // create the app traits object to which we delegate for everything which
181 // either should be configurable by the user (then he can change the
182 // default behaviour simply by overriding CreateTraits() and returning his
183 // own traits object) or which is GUI/console dependent as then wxAppTraits
184 // allows us to abstract the differences behind the common façade
185 wxAppTraits
*GetTraits();
187 // the functions below shouldn't be used now that we have wxAppTraits
188 #if WXWIN_COMPATIBILITY_2_4
191 // override this function to create default log target of arbitrary
192 // user-defined class (default implementation creates a wxLogGui
193 // object) -- this log object is used by default by all wxLogXXX()
195 wxDEPRECATED( virtual wxLog
*CreateLogTarget() );
198 // similar to CreateLogTarget() but for the global wxMessageOutput
200 wxDEPRECATED( virtual wxMessageOutput
*CreateMessageOutput() );
202 #endif // WXWIN_COMPATIBILITY_2_4
205 // event processing functions
206 // --------------------------
208 // this method allows to filter all the events processed by the program, so
209 // you should try to return quickly from it to avoid slowing down the
210 // program to the crawl
212 // return value should be -1 to continue with the normal event processing,
213 // or TRUE or FALSE to stop further processing and pretend that the event
214 // had been already processed or won't be processed at all, respectively
215 virtual int FilterEvent(wxEvent
& event
);
218 // call the specified handler on the given object with the given event
220 // this method only exists to allow catching the exceptions thrown by any
221 // event handler, it would lead to an extra (useless) virtual function call
222 // if the exceptions were not used, so it doesn't even exist in that case
223 virtual void HandleEvent(wxEvtHandler
*handler
,
224 wxEventFunction func
,
225 wxEvent
& event
) const;
227 // Called when an unhandled C++ exception occurs inside OnRun(): note that
228 // the exception type is lost by now, so if you really want to handle the
229 // exception you should override OnRun() and put a try/catch around
230 // MainLoop() call there or use OnExceptionInMainLoop()
231 virtual void OnUnhandledException() { }
232 #endif // wxUSE_EXCEPTIONS
234 // process all events in the wxPendingEvents list -- it is necessary to
235 // call this function to process posted events. This happens during each
236 // event loop iteration in GUI mode but if there is no main loop, it may be
237 // also called directly.
238 virtual void ProcessPendingEvents();
240 // doesn't do anything in this class, just a hook for GUI wxApp
241 virtual bool Yield(bool WXUNUSED(onlyIfNeeded
) = false) { return true; }
243 // make sure that idle events are sent again
244 virtual void WakeUpIdle() { }
246 // this is just a convenience: by providing its implementation here we
247 // avoid #ifdefs in the code using it
248 static bool IsMainLoopRunning() { return false; }
254 // this function is called when an assert failure occurs, the base class
255 // version does the normal processing (i.e. shows the usual assert failure
258 // the arguments are the place where the assert occurred, the text of the
259 // assert itself and the user-specified message
261 virtual void OnAssert(const wxChar
*file
,
265 #endif // __WXDEBUG__
267 // check that the wxBuildOptions object (constructed in the application
268 // itself, usually the one from IMPLEMENT_APP() macro) matches the build
269 // options of the library and abort if it doesn't
270 static bool CheckBuildOptions(const char *optionsSignature
,
271 const char *componentName
);
272 #if WXWIN_COMPATIBILITY_2_4
273 wxDEPRECATED( static bool CheckBuildOptions(const wxBuildOptions
& buildOptions
) );
276 // implementation only from now on
277 // -------------------------------
279 // helpers for dynamic wxApp construction
280 static void SetInitializerFunction(wxAppInitializerFunction fn
)
281 { ms_appInitFn
= fn
; }
282 static wxAppInitializerFunction
GetInitializerFunction()
283 { return ms_appInitFn
; }
285 // accessors for ms_appInstance field (external code might wish to modify
286 // it, this is why we provide a setter here as well, but you should really
287 // know what you're doing if you call it), wxTheApp is usually used instead
289 static wxAppConsole
*GetInstance() { return ms_appInstance
; }
290 static void SetInstance(wxAppConsole
*app
) { ms_appInstance
= app
; }
293 // command line arguments (public for backwards compatibility)
298 // the function which creates the traits object when GetTraits() needs it
299 // for the first time
300 virtual wxAppTraits
*CreateTraits();
303 // function used for dynamic wxApp creation
304 static wxAppInitializerFunction ms_appInitFn
;
306 // the one and only global application object
307 static wxAppConsole
*ms_appInstance
;
310 // application info (must be set from the user code)
311 wxString m_vendorName
, // vendor name (ACME Inc)
312 m_appName
, // app name
313 m_className
; // class name
315 // the class defining the application behaviour, NULL initially and created
316 // by GetTraits() when first needed
317 wxAppTraits
*m_traits
;
320 // the application object is a singleton anyhow, there is no sense in
322 DECLARE_NO_COPY_CLASS(wxAppConsole
)
325 // ----------------------------------------------------------------------------
326 // wxAppBase: the common part of wxApp implementations for all platforms
327 // ----------------------------------------------------------------------------
331 class WXDLLIMPEXP_CORE wxAppBase
: public wxAppConsole
335 virtual ~wxAppBase();
337 // the virtual functions which may/must be overridden in the derived class
338 // -----------------------------------------------------------------------
340 // very first initialization function
342 // Override: very rarely
343 virtual bool Initialize(int& argc
, wxChar
**argv
);
345 // a platform-dependent version of OnInit(): the code here is likely to
346 // depend on the toolkit. default version does nothing.
349 virtual bool OnInitGui();
351 // called to start program execution - the default version just enters
352 // the main GUI loop in which events are received and processed until
353 // the last window is not deleted (if GetExitOnFrameDelete) or
354 // ExitMainLoop() is called. In console mode programs, the execution
355 // of the program really starts here
357 // Override: rarely in GUI applications, always in console ones.
360 // a matching function for OnInit()
361 virtual int OnExit();
363 // very last clean up function
365 // Override: very rarely
366 virtual void CleanUp();
369 // the worker functions - usually not used directly by the user code
370 // -----------------------------------------------------------------
372 // return true if we're running main loop, i.e. if the events can
373 // (already) be dispatched
374 static bool IsMainLoopRunning()
376 #if wxUSE_EVTLOOP_IN_APP
377 wxAppBase
*app
= wx_static_cast(wxAppBase
*, GetInstance());
378 return app
&& app
->m_mainLoop
!= NULL
;
384 // execute the main GUI loop, the function returns when the loop ends
385 virtual int MainLoop();
387 // exit the main loop thus terminating the application
390 // exit the main GUI loop during the next iteration (i.e. it does not
391 // stop the program immediately!)
392 virtual void ExitMainLoop();
394 // returns true if there are unprocessed events in the event queue
395 virtual bool Pending();
397 // process the first event in the event queue (blocks until an event
398 // appears if there are none currently, use Pending() if this is not
399 // wanted), returns false if the event loop should stop and true
401 virtual bool Dispatch();
403 // process all currently pending events right now
405 // it is an error to call Yield() recursively unless the value of
406 // onlyIfNeeded is true
408 // WARNING: this function is dangerous as it can lead to unexpected
409 // reentrancies (i.e. when called from an event handler it
410 // may result in calling the same event handler again), use
411 // with _extreme_ care or, better, don't use at all!
412 virtual bool Yield(bool onlyIfNeeded
= false) = 0;
414 // this virtual function is called in the GUI mode when the application
415 // becomes idle and normally just sends wxIdleEvent to all interested
418 // it should return true if more idle events are needed, false if not
419 virtual bool ProcessIdle();
421 // Send idle event to window and all subwindows
422 // Returns true if more idle time is requested.
423 virtual bool SendIdleEvents(wxWindow
* win
, wxIdleEvent
& event
);
427 // Function called if an uncaught exception is caught inside the main
428 // event loop: it may return true to continue running the event loop or
429 // false to stop it (in the latter case it may rethrow the exception as
431 virtual bool OnExceptionInMainLoop();
432 #endif // wxUSE_EXCEPTIONS
435 // top level window functions
436 // --------------------------
438 // return true if our app has focus
439 virtual bool IsActive() const { return m_isActive
; }
441 // set the "main" top level window
442 void SetTopWindow(wxWindow
*win
) { m_topWindow
= win
; }
444 // return the "main" top level window (if it hadn't been set previously
445 // with SetTopWindow(), will return just some top level window and, if
446 // there are none, will return NULL)
447 virtual wxWindow
*GetTopWindow() const
451 else if (wxTopLevelWindows
.GetCount() > 0)
452 return wxTopLevelWindows
.GetFirst()->GetData();
454 return (wxWindow
*)NULL
;
457 // control the exit behaviour: by default, the program will exit the
458 // main loop (and so, usually, terminate) when the last top-level
459 // program window is deleted. Beware that if you disable this behaviour
460 // (with SetExitOnFrameDelete(false)), you'll have to call
461 // ExitMainLoop() explicitly from somewhere.
462 void SetExitOnFrameDelete(bool flag
)
463 { m_exitOnFrameDelete
= flag ? Yes
: No
; }
464 bool GetExitOnFrameDelete() const
465 { return m_exitOnFrameDelete
== Yes
; }
468 // display mode, visual, printing mode, ...
469 // ------------------------------------------------------------------------
471 // Get display mode that is used use. This is only used in framebuffer
472 // wxWin ports (such as wxMGL).
473 virtual wxVideoMode
GetDisplayMode() const { return wxVideoMode(); }
474 // Set display mode to use. This is only used in framebuffer wxWin
475 // ports (such as wxMGL). This method should be called from
477 virtual bool SetDisplayMode(const wxVideoMode
& WXUNUSED(info
)) { return true; }
479 // set use of best visual flag (see below)
480 void SetUseBestVisual( bool flag
) { m_useBestVisual
= flag
; }
481 bool GetUseBestVisual() const { return m_useBestVisual
; }
483 // set/get printing mode: see wxPRINT_XXX constants.
485 // default behaviour is the normal one for Unix: always use PostScript
487 virtual void SetPrintMode(int WXUNUSED(mode
)) { }
488 int GetPrintMode() const { return wxPRINT_POSTSCRIPT
; }
491 // command line parsing (GUI-specific)
492 // ------------------------------------------------------------------------
494 #if wxUSE_CMDLINE_PARSER
495 virtual bool OnCmdLineParsed(wxCmdLineParser
& parser
);
496 virtual void OnInitCmdLine(wxCmdLineParser
& parser
);
499 // miscellaneous other stuff
500 // ------------------------------------------------------------------------
502 // called by toolkit-specific code to set the app status: active (we have
503 // focus) or not and also the last window which had focus before we were
505 virtual void SetActive(bool isActive
, wxWindow
*lastFocus
);
507 // OBSOLETE: don't use, always returns true
509 // returns true if the program is successfully initialized
510 bool Initialized() { return true; }
512 // perform standard OnIdle behaviour, ensure that this is always called
513 void OnIdle(wxIdleEvent
& event
);
517 // delete all objects in wxPendingDelete list
518 void DeletePendingObjects();
520 // override base class method to use GUI traits
521 virtual wxAppTraits
*CreateTraits();
524 #if wxUSE_EVTLOOP_IN_APP
525 // the main event loop of the application (may be NULL if the loop hasn't
526 // been started yet or has already terminated)
527 wxEventLoop
*m_mainLoop
;
528 #endif // wxUSE_EVTLOOP_IN_APP
530 // the main top level window (may be NULL)
531 wxWindow
*m_topWindow
;
533 // if Yes, exit the main loop when the last top level window is deleted, if
534 // No don't do it and if Later -- only do it once we reach our OnRun()
536 // the explanation for using this strange scheme is given in appcmn.cpp
542 } m_exitOnFrameDelete
;
544 // true if the app wants to use the best visual on systems where
545 // more than one are available (Sun, SGI, XFree86 4.0 ?)
546 bool m_useBestVisual
;
548 // does any of our windows have focus?
552 DECLARE_NO_COPY_CLASS(wxAppBase
)
557 // ----------------------------------------------------------------------------
558 // now include the declaration of the real class
559 // ----------------------------------------------------------------------------
562 #if defined(__WXPALMOS__)
563 #include "wx/palmos/app.h"
564 #elif defined(__WXMSW__)
565 #include "wx/msw/app.h"
566 #elif defined(__WXMOTIF__)
567 #include "wx/motif/app.h"
568 #elif defined(__WXMGL__)
569 #include "wx/mgl/app.h"
570 #elif defined(__WXGTK__)
571 #include "wx/gtk/app.h"
572 #elif defined(__WXX11__)
573 #include "wx/x11/app.h"
574 #elif defined(__WXMAC__)
575 #include "wx/mac/app.h"
576 #elif defined(__WXCOCOA__)
577 #include "wx/cocoa/app.h"
578 #elif defined(__WXPM__)
579 #include "wx/os2/app.h"
582 // allow using just wxApp (instead of wxAppConsole) in console programs
583 typedef wxAppConsole wxApp
;
586 // ----------------------------------------------------------------------------
588 // ----------------------------------------------------------------------------
590 // for compatibility, we define this macro to access the global application
591 // object of type wxApp
593 // note that instead of using of wxTheApp in application code you should
594 // consider using DECLARE_APP() after which you may call wxGetApp() which will
595 // return the object of the correct type (i.e. MyApp and not wxApp)
597 // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
598 // console mode it does nothing at all
599 #define wxTheApp ((wxApp *)wxApp::GetInstance())
601 // ----------------------------------------------------------------------------
603 // ----------------------------------------------------------------------------
605 // event loop related functions only work in GUI programs
606 // ------------------------------------------------------
608 // Force an exit from main loop
609 extern void WXDLLIMPEXP_BASE
wxExit();
611 // Yield to other apps/messages
612 extern bool WXDLLIMPEXP_BASE
wxYield();
614 // Yield to other apps/messages
615 extern void WXDLLIMPEXP_BASE
wxWakeUpIdle();
617 // ----------------------------------------------------------------------------
618 // macros for dynamic creation of the application object
619 // ----------------------------------------------------------------------------
621 // Having a global instance of this class allows wxApp to be aware of the app
622 // creator function. wxApp can then call this function to create a new app
623 // object. Convoluted, but necessary.
625 class WXDLLIMPEXP_BASE wxAppInitializer
628 wxAppInitializer(wxAppInitializerFunction fn
)
629 { wxApp
::SetInitializerFunction(fn
); }
632 // the code below defines a IMPLEMENT_WXWIN_MAIN macro which you can use if
633 // your compiler really, really wants main() to be in your main program (e.g.
634 // hello.cpp). Now IMPLEMENT_APP should add this code if required.
636 #define IMPLEMENT_WXWIN_MAIN_CONSOLE \
637 int main(int argc, char **argv) { return wxEntry(argc, argv); }
639 // port-specific header could have defined it already in some special way
640 #ifndef IMPLEMENT_WXWIN_MAIN
641 #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE
642 #endif // defined(IMPLEMENT_WXWIN_MAIN)
644 #ifdef __WXUNIVERSAL__
645 #include "wx/univ/theme.h"
647 #define IMPLEMENT_WX_THEME_SUPPORT \
648 WX_USE_THEME(win32); \
651 #define IMPLEMENT_WX_THEME_SUPPORT
654 // Use this macro if you want to define your own main() or WinMain() function
655 // and call wxEntry() from there.
656 #define IMPLEMENT_APP_NO_MAIN(appname) \
657 wxAppConsole *wxCreateApp() \
659 wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE, \
661 return new appname; \
664 wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
665 DECLARE_APP(appname) \
666 appname& wxGetApp() { return *(appname *)wxTheApp; }
668 // Same as IMPLEMENT_APP() normally but doesn't include themes support in
669 // wxUniversal builds
670 #define IMPLEMENT_APP_NO_THEMES(appname) \
671 IMPLEMENT_APP_NO_MAIN(appname) \
674 // Use this macro exactly once, the argument is the name of the wxApp-derived
675 // class which is the class of your application.
676 #define IMPLEMENT_APP(appname) \
677 IMPLEMENT_APP_NO_THEMES(appname) \
678 IMPLEMENT_WX_THEME_SUPPORT
680 // Same as IMPLEMENT_APP(), but for console applications.
681 #define IMPLEMENT_APP_CONSOLE(appname) \
682 IMPLEMENT_APP_NO_MAIN(appname) \
683 IMPLEMENT_WXWIN_MAIN_CONSOLE
685 // this macro can be used multiple times and just allows you to use wxGetApp()
687 #define DECLARE_APP(appname) extern appname& wxGetApp();
690 // declare the stuff defined by IMPLEMENT_APP() macro, it's not really needed
691 // anywhere else but at the very least it suppresses icc warnings about
692 // defining extern symbols without prior declaration, and it shouldn't do any
694 extern wxAppConsole
*wxCreateApp();
695 extern wxAppInitializer wxTheAppInitializer
;
697 #endif // _WX_APP_H_BASE_