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() { }
120 // function called if an uncaught exception is caught inside the main
121 // event loop: it may return true to continue running the event loop or
122 // false to stop it (in the latter case it may rethrow the exception as
124 virtual bool OnExceptionInMainLoop();
126 // Called when an unhandled C++ exception occurs inside OnRun(): note that
127 // the exception type is lost by now, so if you really want to handle the
128 // exception you should override OnRun() and put a try/catch around
129 // MainLoop() call there
130 virtual void OnUnhandledException() { }
131 #endif // wxUSE_EXCEPTIONS
133 // Called from wxExit() function, should terminate the application a.s.a.p.
137 // application info: name, description, vendor
138 // -------------------------------------------
140 // NB: all these should be set by the application itself, there are no
141 // reasonable default except for the application name which is taken to
144 // set/get the application name
145 wxString
GetAppName() const
147 return m_appName
.empty() ? m_className
: m_appName
;
149 void SetAppName(const wxString
& name
) { m_appName
= name
; }
151 // set/get the app class name
152 wxString
GetClassName() const { return m_className
; }
153 void SetClassName(const wxString
& name
) { m_className
= name
; }
155 // set/get the vendor name
156 const wxString
& GetVendorName() const { return m_vendorName
; }
157 void SetVendorName(const wxString
& name
) { m_vendorName
= 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 façade
199 wxAppTraits
*GetTraits();
201 // the functions below shouldn't be used now that we have wxAppTraits
202 #if WXWIN_COMPATIBILITY_2_4
205 // override this function to create default log target of arbitrary
206 // user-defined class (default implementation creates a wxLogGui
207 // object) -- this log object is used by default by all wxLogXXX()
209 virtual wxLog
*CreateLogTarget();
212 // similar to CreateLogTarget() but for the global wxMessageOutput
214 virtual wxMessageOutput
*CreateMessageOutput();
216 #endif // WXWIN_COMPATIBILITY_2_4
219 // event processing functions
220 // --------------------------
222 // this method allows to filter all the events processed by the program, so
223 // you should try to return quickly from it to avoid slowing down the
224 // program to the crawl
226 // return value should be -1 to continue with the normal event processing,
227 // or TRUE or FALSE to stop further processing and pretend that the event
228 // had been already processed or won't be processed at all, respectively
229 virtual int FilterEvent(wxEvent
& event
);
232 // call the specified handler on the given object with the given event
234 // this method only exists to allow catching the exceptions thrown by any
235 // event handler, it would lead to an extra (useless) virtual function call
236 // if the exceptions were not used, so it doesn't even exist in that case
237 virtual void HandleEvent(wxEvtHandler
*handler
,
238 wxEventFunction func
,
239 wxEvent
& event
) const;
240 #endif // wxUSE_EXCEPTIONS
242 // process all events in the wxPendingEvents list -- it is necessary to
243 // call this function to process posted events. This happens during each
244 // event loop iteration in GUI mode but if there is no main loop, it may be
245 // also called directly.
246 virtual void ProcessPendingEvents();
248 // doesn't do anything in this class, just a hook for GUI wxApp
249 virtual bool Yield(bool WXUNUSED(onlyIfNeeded
) = false) { return true; }
251 // make sure that idle events are sent again
252 virtual void WakeUpIdle() { }
258 // this function is called when an assert failure occurs, the base class
259 // version does the normal processing (i.e. shows the usual assert failure
262 // the arguments are the place where the assert occured, the text of the
263 // assert itself and the user-specified message
265 virtual void OnAssert(const wxChar
*file
,
269 #endif // __WXDEBUG__
271 // check that the wxBuildOptions object (constructed in the application
272 // itself, usually the one from IMPLEMENT_APP() macro) matches the build
273 // options of the library and abort if it doesn't
274 static bool CheckBuildOptions(const char *optionsSignature
,
275 const char *componentName
);
276 #if WXWIN_COMPATIBILITY_2_4
277 static bool CheckBuildOptions(const wxBuildOptions
& buildOptions
)
279 return CheckBuildOptions(buildOptions
.m_signature
, "your program");
283 // implementation only from now on
284 // -------------------------------
286 // helpers for dynamic wxApp construction
287 static void SetInitializerFunction(wxAppInitializerFunction fn
)
288 { ms_appInitFn
= fn
; }
289 static wxAppInitializerFunction
GetInitializerFunction()
290 { return ms_appInitFn
; }
292 // accessors for ms_appInstance field (external code might wish to modify
293 // it, this is why we provide a setter here as well, but you should really
294 // know what you're doing if you call it), wxTheApp is usually used instead
296 static wxAppConsole
*GetInstance() { return ms_appInstance
; }
297 static void SetInstance(wxAppConsole
*app
) { ms_appInstance
= app
; }
300 // command line arguments (public for backwards compatibility)
305 // the function which creates the traits object when GetTraits() needs it
306 // for the first time
307 virtual wxAppTraits
*CreateTraits();
310 // function used for dynamic wxApp creation
311 static wxAppInitializerFunction ms_appInitFn
;
313 // the one and only global application object
314 static wxAppConsole
*ms_appInstance
;
317 // application info (must be set from the user code)
318 wxString m_vendorName
, // vendor name (ACME Inc)
319 m_appName
, // app name
320 m_className
; // class name
322 // the class defining the application behaviour, NULL initially and created
323 // by GetTraits() when first needed
324 wxAppTraits
*m_traits
;
327 // the application object is a singleton anyhow, there is no sense in
329 DECLARE_NO_COPY_CLASS(wxAppConsole
)
332 // ----------------------------------------------------------------------------
333 // wxAppBase: the common part of wxApp implementations for all platforms
334 // ----------------------------------------------------------------------------
338 class WXDLLIMPEXP_CORE wxAppBase
: public wxAppConsole
342 virtual ~wxAppBase();
344 // the virtual functions which may/must be overridden in the derived class
345 // -----------------------------------------------------------------------
347 // very first initialization function
349 // Override: very rarely
350 virtual bool Initialize(int& argc
, wxChar
**argv
);
352 // a platform-dependent version of OnInit(): the code here is likely to
353 // depend on the toolkit. default version does nothing.
356 virtual bool OnInitGui();
358 // called to start program execution - the default version just enters
359 // the main GUI loop in which events are received and processed until
360 // the last window is not deleted (if GetExitOnFrameDelete) or
361 // ExitMainLoop() is called. In console mode programs, the execution
362 // of the program really starts here
364 // Override: rarely in GUI applications, always in console ones.
367 // a matching function for OnInit()
368 virtual int OnExit();
370 // very last clean up function
372 // Override: very rarely
373 virtual void CleanUp();
376 // the worker functions - usually not used directly by the user code
377 // -----------------------------------------------------------------
379 // return true if we're running main loop, i.e. if the events can
380 // (already) be dispatched
381 bool IsMainLoopRunning() const
383 #if wxUSE_EVTLOOP_IN_APP
384 return m_mainLoop
!= NULL
;
390 // execute the main GUI loop, the function returns when the loop ends
391 virtual int MainLoop();
393 // exit the main loop thus terminating the application
396 // exit the main GUI loop during the next iteration (i.e. it does not
397 // stop the program immediately!)
398 virtual void ExitMainLoop();
400 // returns true if there are unprocessed events in the event queue
401 virtual bool Pending();
403 // process the first event in the event queue (blocks until an event
404 // appears if there are none currently, use Pending() if this is not
405 // wanted), returns false if the event loop should stop and true
407 virtual bool Dispatch();
409 // process all currently pending events right now
411 // it is an error to call Yield() recursively unless the value of
412 // onlyIfNeeded is true
414 // WARNING: this function is dangerous as it can lead to unexpected
415 // reentrancies (i.e. when called from an event handler it
416 // may result in calling the same event handler again), use
417 // with _extreme_ care or, better, don't use at all!
418 virtual bool Yield(bool onlyIfNeeded
= false) = 0;
420 // this virtual function is called in the GUI mode when the application
421 // becomes idle and normally just sends wxIdleEvent to all interested
424 // it should return true if more idle events are needed, false if not
425 virtual bool ProcessIdle();
427 // Send idle event to window and all subwindows
428 // Returns true if more idle time is requested.
429 virtual bool SendIdleEvents(wxWindow
* win
, wxIdleEvent
& event
);
431 // Perform standard OnIdle behaviour: call from port's OnIdle
432 void OnIdle(wxIdleEvent
& event
);
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; }
514 // delete all objects in wxPendingDelete list
515 void DeletePendingObjects();
517 // override base class method to use GUI traits
518 virtual wxAppTraits
*CreateTraits();
521 #if wxUSE_EVTLOOP_IN_APP
522 // the main event loop of the application (may be NULL if the loop hasn't
523 // been started yet or has already terminated)
524 wxEventLoop
*m_mainLoop
;
525 #endif // wxUSE_EVTLOOP_IN_APP
527 // the main top level window (may be NULL)
528 wxWindow
*m_topWindow
;
530 // if Yes, exit the main loop when the last top level window is deleted, if
531 // No don't do it and if Later -- only do it once we reach our OnRun()
533 // the explanation for using this strange scheme is given in appcmn.cpp
539 } m_exitOnFrameDelete
;
541 // true if the apps whats to use the best visual on systems where
542 // more than one are available (Sun, SGI, XFree86 4.0 ?)
543 bool m_useBestVisual
;
545 // does any of our windows has focus?
549 DECLARE_NO_COPY_CLASS(wxAppBase
)
554 // ----------------------------------------------------------------------------
555 // now include the declaration of the real class
556 // ----------------------------------------------------------------------------
559 #if defined(__WXMSW__)
560 #include "wx/msw/app.h"
561 #elif defined(__WXMOTIF__)
562 #include "wx/motif/app.h"
563 #elif defined(__WXMGL__)
564 #include "wx/mgl/app.h"
565 #elif defined(__WXGTK__)
566 #include "wx/gtk/app.h"
567 #elif defined(__WXX11__)
568 #include "wx/x11/app.h"
569 #elif defined(__WXMAC__)
570 #include "wx/mac/app.h"
571 #elif defined(__WXCOCOA__)
572 #include "wx/cocoa/app.h"
573 #elif defined(__WXPM__)
574 #include "wx/os2/app.h"
577 // allow using just wxApp (instead of wxAppConsole) in console programs
578 typedef wxAppConsole wxApp
;
581 // ----------------------------------------------------------------------------
583 // ----------------------------------------------------------------------------
585 // for compatibility, we define this macro to access the global application
586 // object of type wxApp
588 // note that instead of using of wxTheApp in application code you should
589 // consider using DECLARE_APP() after which you may call wxGetApp() which will
590 // return the object of the correct type (i.e. MyApp and not wxApp)
592 // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
593 // console mode it does nothing at all
594 #define wxTheApp ((wxApp *)wxApp::GetInstance())
596 // ----------------------------------------------------------------------------
598 // ----------------------------------------------------------------------------
600 // event loop related functions only work in GUI programs
601 // ------------------------------------------------------
603 // Force an exit from main loop
604 extern void WXDLLIMPEXP_BASE
wxExit();
606 // Yield to other apps/messages
607 extern bool WXDLLIMPEXP_BASE
wxYield();
609 // Yield to other apps/messages
610 extern void WXDLLIMPEXP_BASE
wxWakeUpIdle();
612 // ----------------------------------------------------------------------------
613 // macros for dynamic creation of the application object
614 // ----------------------------------------------------------------------------
616 // Having a global instance of this class allows wxApp to be aware of the app
617 // creator function. wxApp can then call this function to create a new app
618 // object. Convoluted, but necessary.
620 class WXDLLIMPEXP_BASE wxAppInitializer
623 wxAppInitializer(wxAppInitializerFunction fn
)
624 { wxApp
::SetInitializerFunction(fn
); }
627 // the code below defines a IMPLEMENT_WXWIN_MAIN macro which you can use if
628 // your compiler really, really wants main() to be in your main program (e.g.
629 // hello.cpp). Now IMPLEMENT_APP should add this code if required.
631 #define IMPLEMENT_WXWIN_MAIN_CONSOLE \
632 int main(int argc, char **argv) { return wxEntry(argc, argv); }
634 // port-specific header could have defined it already in some special wau
635 #ifndef IMPLEMENT_WXWIN_MAIN
636 #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE
637 #endif // defined(IMPLEMENT_WXWIN_MAIN)
639 #ifdef __WXUNIVERSAL__
640 #include "wx/univ/theme.h"
642 #define IMPLEMENT_WX_THEME_SUPPORT \
643 WX_USE_THEME(win32); \
646 #define IMPLEMENT_WX_THEME_SUPPORT
649 // Use this macro if you want to define your own main() or WinMain() function
650 // and call wxEntry() from there.
651 #define IMPLEMENT_APP_NO_MAIN(appname) \
652 wxAppConsole *wxCreateApp() \
654 wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE, \
656 return new appname; \
659 wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
660 appname& wxGetApp() { return *(appname *)wxTheApp; }
662 // Same as IMPLEMENT_APP() normally but doesn't include themes support in
663 // wxUniversal builds
664 #define IMPLEMENT_APP_NO_THEMES(appname) \
665 IMPLEMENT_APP_NO_MAIN(appname) \
668 // Use this macro exactly once, the argument is the name of the wxApp-derived
669 // class which is the class of your application.
670 #define IMPLEMENT_APP(appname) \
671 IMPLEMENT_APP_NO_THEMES(appname) \
672 IMPLEMENT_WX_THEME_SUPPORT
674 // Same as IMPLEMENT_APP(), but for console applications.
675 #define IMPLEMENT_APP_CONSOLE(appname) \
676 IMPLEMENT_APP_NO_MAIN(appname) \
677 IMPLEMENT_WXWIN_MAIN_CONSOLE
679 // this macro can be used multiple times and just allows you to use wxGetApp()
681 #define DECLARE_APP(appname) extern appname& wxGetApp();
683 #endif // _WX_APP_H_BASE_