]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/app.h
Add (currently unimplemented) missing wxRegion constructors for wxRegionGeneric.
[wxWidgets.git] / include / wx / app.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/app.h
3// Purpose: wxAppBase class and macros used for declaration of wxApp
4// derived class in the user code
5// Author: Julian Smart
6// Modified by:
7// Created: 01/02/97
8// RCS-ID: $Id$
9// Copyright: (c) Julian Smart
10// Licence: wxWindows licence
11/////////////////////////////////////////////////////////////////////////////
12
13#ifndef _WX_APP_H_BASE_
14#define _WX_APP_H_BASE_
15
16// ----------------------------------------------------------------------------
17// headers we have to include here
18// ----------------------------------------------------------------------------
19
20#include "wx/event.h" // for the base class
21#include "wx/build.h"
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
25
26class WXDLLIMPEXP_FWD_BASE wxAppConsole;
27class WXDLLIMPEXP_FWD_BASE wxAppTraits;
28class WXDLLIMPEXP_FWD_BASE wxCmdLineParser;
29class WXDLLIMPEXP_FWD_BASE wxEventLoopBase;
30class WXDLLIMPEXP_FWD_BASE wxLog;
31class WXDLLIMPEXP_FWD_BASE wxMessageOutput;
32
33#if wxUSE_GUI
34 struct WXDLLIMPEXP_FWD_CORE wxVideoMode;
35 class WXDLLIMPEXP_FWD_CORE wxWindow;
36#endif
37
38// ----------------------------------------------------------------------------
39// typedefs
40// ----------------------------------------------------------------------------
41
42// the type of the function used to create a wxApp object on program start up
43typedef wxAppConsole* (*wxAppInitializerFunction)();
44
45// ----------------------------------------------------------------------------
46// constants
47// ----------------------------------------------------------------------------
48
49enum
50{
51 wxPRINT_WINDOWS = 1,
52 wxPRINT_POSTSCRIPT = 2
53};
54
55// ----------------------------------------------------------------------------
56// wxAppConsoleBase: wxApp for non-GUI applications
57// ----------------------------------------------------------------------------
58
59class WXDLLIMPEXP_BASE wxAppConsoleBase : public wxEvtHandler
60{
61public:
62 // ctor and dtor
63 wxAppConsoleBase();
64 virtual ~wxAppConsoleBase();
65
66
67 // the virtual functions which may/must be overridden in the derived class
68 // -----------------------------------------------------------------------
69
70 // This is the very first function called for a newly created wxApp object,
71 // it is used by the library to do the global initialization. If, for some
72 // reason, you must override it (instead of just overriding OnInit(), as
73 // usual, for app-specific initializations), do not forget to call the base
74 // class version!
75 virtual bool Initialize(int& argc, wxChar **argv);
76
77 // This gives wxCocoa a chance to call OnInit() with a memory pool in place
78 virtual bool CallOnInit() { return OnInit(); }
79
80 // Called before OnRun(), this is a good place to do initialization -- if
81 // anything fails, return false from here to prevent the program from
82 // continuing. The command line is normally parsed here, call the base
83 // class OnInit() to do it.
84 virtual bool OnInit();
85
86 // this is here only temporary hopefully (FIXME)
87 virtual bool OnInitGui() { return true; }
88
89 // This is the replacement for the normal main(): all program work should
90 // be done here. When OnRun() returns, the programs starts shutting down.
91 virtual int OnRun();
92
93 // This is only called if OnInit() returned true so it's a good place to do
94 // any cleanup matching the initializations done there.
95 virtual int OnExit();
96
97 // This is the very last function called on wxApp object before it is
98 // destroyed. If you override it (instead of overriding OnExit() as usual)
99 // do not forget to call the base class version!
100 virtual void CleanUp();
101
102 // Called when a fatal exception occurs, this function should take care not
103 // to do anything which might provoke a nested exception! It may be
104 // overridden if you wish to react somehow in non-default way (core dump
105 // under Unix, application crash under Windows) to fatal program errors,
106 // however extreme care should be taken if you don't want this function to
107 // crash.
108 virtual void OnFatalException() { }
109
110 // Called from wxExit() function, should terminate the application a.s.a.p.
111 virtual void Exit();
112
113
114 // application info: name, description, vendor
115 // -------------------------------------------
116
117 // NB: all these should be set by the application itself, there are no
118 // reasonable default except for the application name which is taken to
119 // be argv[0]
120
121 // set/get the application name
122 wxString GetAppName() const
123 {
124 return m_appName.empty() ? m_className : m_appName;
125 }
126 void SetAppName(const wxString& name) { m_appName = name; }
127
128 // set/get the application display name: the display name is the name
129 // shown to the user in titles, reports, etc while the app name is
130 // used for paths, config, and other places the user doesn't see
131 //
132 // so the app name could be myapp while display name could be "My App"
133 wxString GetAppDisplayName() const
134 {
135 return m_appDisplayName.empty() ? GetAppName().Capitalize()
136 : m_appDisplayName;
137 }
138
139 void SetAppDisplayName(const wxString& name) { m_appDisplayName = name; }
140
141 // set/get the app class name
142 wxString GetClassName() const { return m_className; }
143 void SetClassName(const wxString& name) { m_className = name; }
144
145 // set/get the vendor name
146 const wxString& GetVendorName() const { return m_vendorName; }
147 void SetVendorName(const wxString& name) { m_vendorName = name; }
148
149 // set/get the vendor display name: the display name is shown
150 // in titles/reports/dialogs to the user, while the vendor name
151 // is used in some areas such as wxConfig, wxStandardPaths, etc
152 const wxString& GetVendorDisplayName() const
153 {
154 return m_vendorDisplayName.empty() ? GetVendorName()
155 : m_vendorDisplayName;
156 }
157 void SetVendorDisplayName(const wxString& name)
158 {
159 m_vendorDisplayName = name;
160 }
161
162
163 // cmd line parsing stuff
164 // ----------------------
165
166 // all of these methods may be overridden in the derived class to
167 // customize the command line parsing (by default only a few standard
168 // options are handled)
169 //
170 // you also need to call wxApp::OnInit() from YourApp::OnInit() for all
171 // this to work
172
173#if wxUSE_CMDLINE_PARSER
174 // this one is called from OnInit() to add all supported options
175 // to the given parser (don't forget to call the base class version if you
176 // override it!)
177 virtual void OnInitCmdLine(wxCmdLineParser& parser);
178
179 // called after successfully parsing the command line, return true
180 // to continue and false to exit (don't forget to call the base class
181 // version if you override it!)
182 virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
183
184 // called if "--help" option was specified, return true to continue
185 // and false to exit
186 virtual bool OnCmdLineHelp(wxCmdLineParser& parser);
187
188 // called if incorrect command line options were given, return
189 // false to abort and true to continue
190 virtual bool OnCmdLineError(wxCmdLineParser& parser);
191#endif // wxUSE_CMDLINE_PARSER
192
193
194 // miscellaneous customization functions
195 // -------------------------------------
196
197 // create the app traits object to which we delegate for everything which
198 // either should be configurable by the user (then he can change the
199 // default behaviour simply by overriding CreateTraits() and returning his
200 // own traits object) or which is GUI/console dependent as then wxAppTraits
201 // allows us to abstract the differences behind the common facade
202 wxAppTraits *GetTraits();
203
204 // this function provides safer access to traits object than
205 // wxTheApp->GetTraits() during startup or termination when the global
206 // application object itself may be unavailable
207 //
208 // of course, it still returns NULL in this case and the caller must check
209 // for it
210 static wxAppTraits *GetTraitsIfExists();
211
212 // event processing functions
213 // --------------------------
214
215 // this method allows to filter all the events processed by the program, so
216 // you should try to return quickly from it to avoid slowing down the
217 // program to the crawl
218 //
219 // return value should be -1 to continue with the normal event processing,
220 // or TRUE or FALSE to stop further processing and pretend that the event
221 // had been already processed or won't be processed at all, respectively
222 virtual int FilterEvent(wxEvent& event);
223
224#if wxUSE_EXCEPTIONS
225 // execute the functor to handle the given event
226 //
227 // this is a generalization of HandleEvent() below and the base class
228 // implementation of CallEventHandler() still calls HandleEvent() for
229 // compatibility for functors which are just wxEventFunctions (i.e. methods
230 // of wxEvtHandler)
231 virtual void CallEventHandler(wxEvtHandler *handler,
232 wxEventFunctor& functor,
233 wxEvent& event) const;
234
235 // call the specified handler on the given object with the given event
236 //
237 // this method only exists to allow catching the exceptions thrown by any
238 // event handler, it would lead to an extra (useless) virtual function call
239 // if the exceptions were not used, so it doesn't even exist in that case
240 virtual void HandleEvent(wxEvtHandler *handler,
241 wxEventFunction func,
242 wxEvent& event) const;
243
244 // Called when an unhandled C++ exception occurs inside OnRun(): note that
245 // the main event loop has already terminated by now and the program will
246 // exit, if you need to really handle the exceptions you need to override
247 // OnExceptionInMainLoop()
248 virtual void OnUnhandledException();
249#endif // wxUSE_EXCEPTIONS
250
251 // event processing functions
252 // --------------------------
253
254 // return true if we're running event loop, i.e. if the events can
255 // (already) be dispatched
256 static bool IsMainLoopRunning();
257
258 // temporary suspends processing of the pending events
259 virtual void SuspendProcessingOfPendingEvents();
260
261 // resume processing of the pending events previously stopped because of a
262 // call to SuspendProcessingOfPendingEvents()
263 virtual void ResumeProcessingOfPendingEvents();
264
265 // process all events in the wxHandlersWithPendingEvents list -- it is necessary
266 // to call this function to process posted events. This happens during each
267 // event loop iteration in GUI mode but if there is no main loop, it may be
268 // also called directly.
269 virtual void ProcessPendingEvents();
270
271 // check if there are pending events on global pending event list
272 bool HasPendingEvents() const;
273
274 // make sure that idle events are sent again
275 virtual void WakeUpIdle();
276
277 // execute the main GUI loop, the function returns when the loop ends
278 virtual int MainLoop();
279
280 // exit the main GUI loop during the next iteration (i.e. it does not
281 // stop the program immediately!)
282 virtual void ExitMainLoop();
283
284 // returns true if there are unprocessed events in the event queue
285 virtual bool Pending();
286
287 // process the first event in the event queue (blocks until an event
288 // appears if there are none currently, use Pending() if this is not
289 // wanted), returns false if the event loop should stop and true
290 // otherwise
291 virtual bool Dispatch();
292
293 // this virtual function is called when the application
294 // becomes idle and normally just sends wxIdleEvent to all interested
295 // parties
296 //
297 // it should return true if more idle events are needed, false if not
298 virtual bool ProcessIdle();
299
300#if wxUSE_EXCEPTIONS
301 // Function called if an uncaught exception is caught inside the main
302 // event loop: it may return true to continue running the event loop or
303 // false to stop it (in the latter case it may rethrow the exception as
304 // well)
305 virtual bool OnExceptionInMainLoop();
306#endif // wxUSE_EXCEPTIONS
307
308 // Yield-related hooks
309 // -------------------
310
311 // process all currently pending events right now
312 //
313 // it is an error to call Yield() recursively unless the value of
314 // onlyIfNeeded is true
315 //
316 // WARNING: this function is dangerous as it can lead to unexpected
317 // reentrancies (i.e. when called from an event handler it
318 // may result in calling the same event handler again), use
319 // with _extreme_ care or, better, don't use at all!
320 // NOTE: in wxConsoleBase it doesn't do anything, just a hook for GUI wxApp
321 bool Yield(bool onlyIfNeeded = false)
322 { return DoYield(onlyIfNeeded, wxEVT_CATEGORY_ALL); }
323 bool YieldFor(long eventsToProcess)
324 { return DoYield(true, eventsToProcess); }
325 virtual bool IsYielding() const
326 { return false; }
327 virtual bool IsEventAllowedInsideYield(wxEventCategory WXUNUSED(cat)) const
328 { return true; }
329 // no SafeYield hooks since it uses wxWindow which is not available when wxUSE_GUI=0
330
331
332 // debugging support
333 // -----------------
334
335#ifdef __WXDEBUG__
336 // this function is called when an assert failure occurs, the base class
337 // version does the normal processing (i.e. shows the usual assert failure
338 // dialog box)
339 //
340 // the arguments are the location of the failed assert (func may be empty
341 // if the compiler doesn't support C99 __FUNCTION__), the text of the
342 // assert itself and the user-specified message
343 virtual void OnAssertFailure(const wxChar *file,
344 int line,
345 const wxChar *func,
346 const wxChar *cond,
347 const wxChar *msg);
348
349 // old version of the function without func parameter, for compatibility
350 // only, override OnAssertFailure() in the new code
351 virtual void OnAssert(const wxChar *file,
352 int line,
353 const wxChar *cond,
354 const wxChar *msg);
355#endif // __WXDEBUG__
356
357 // check that the wxBuildOptions object (constructed in the application
358 // itself, usually the one from IMPLEMENT_APP() macro) matches the build
359 // options of the library and abort if it doesn't
360 static bool CheckBuildOptions(const char *optionsSignature,
361 const char *componentName);
362
363 // implementation only from now on
364 // -------------------------------
365
366 // helpers for dynamic wxApp construction
367 static void SetInitializerFunction(wxAppInitializerFunction fn)
368 { ms_appInitFn = fn; }
369 static wxAppInitializerFunction GetInitializerFunction()
370 { return ms_appInitFn; }
371
372 // accessors for ms_appInstance field (external code might wish to modify
373 // it, this is why we provide a setter here as well, but you should really
374 // know what you're doing if you call it), wxTheApp is usually used instead
375 // of GetInstance()
376 static wxAppConsole *GetInstance() { return ms_appInstance; }
377 static void SetInstance(wxAppConsole *app) { ms_appInstance = app; }
378
379
380 // command line arguments (public for backwards compatibility)
381 int argc;
382
383 // this object is implicitly convertible to either "char**" (traditional
384 // type of argv parameter of main()) or to "wchar_t **" (for compatibility
385 // with Unicode build in previous wx versions and because the command line
386 // can, in pr
387#if wxUSE_UNICODE
388 wxCmdLineArgsArray argv;
389#else
390 char **argv;
391#endif
392
393protected:
394 // the function which creates the traits object when GetTraits() needs it
395 // for the first time
396 virtual wxAppTraits *CreateTraits();
397
398 // the real yield function hook:
399 virtual bool DoYield(bool WXUNUSED(onlyIfNeeded), long WXUNUSED(eventsToProcess))
400 { return true; }
401
402 // function used for dynamic wxApp creation
403 static wxAppInitializerFunction ms_appInitFn;
404
405 // the one and only global application object
406 static wxAppConsole *ms_appInstance;
407
408 // create main loop from AppTraits or return NULL if
409 // there is no main loop implementation
410 wxEventLoopBase *CreateMainLoop();
411
412 // application info (must be set from the user code)
413 wxString m_vendorName, // vendor name ("acme")
414 m_vendorDisplayName, // vendor display name (e.g. "ACME Inc")
415 m_appName, // app name ("myapp")
416 m_appDisplayName, // app display name ("My Application")
417 m_className; // class name
418
419 // the class defining the application behaviour, NULL initially and created
420 // by GetTraits() when first needed
421 wxAppTraits *m_traits;
422
423 // the main event loop of the application (may be NULL if the loop hasn't
424 // been started yet or has already terminated)
425 wxEventLoopBase *m_mainLoop;
426
427 // the array of the handlers with pending events which needs to be processed
428 // inside ProcessPendingEvents()
429 // wxEvtHandlerArray m_handlersWithPendingEvents; FIXME: enable this and remove global lists
430
431 // helper array used by ProcessPendingEvents()
432 // wxEvtHandlerArray m_handlersWithPendingDelayedEvents; FIXME: enable this and remove global lists
433
434 friend class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
435
436 // the application object is a singleton anyhow, there is no sense in
437 // copying it
438 DECLARE_NO_COPY_CLASS(wxAppConsoleBase)
439};
440
441#if defined(__UNIX__)
442 #include "wx/unix/app.h"
443#else
444 // this has to be a class and not a typedef as we forward declare it
445 class wxAppConsole : public wxAppConsoleBase { };
446#endif
447
448// ----------------------------------------------------------------------------
449// wxAppBase: the common part of wxApp implementations for all platforms
450// ----------------------------------------------------------------------------
451
452#if wxUSE_GUI
453
454class WXDLLIMPEXP_CORE wxAppBase : public wxAppConsole
455{
456public:
457 wxAppBase();
458 virtual ~wxAppBase();
459
460 // the virtual functions which may/must be overridden in the derived class
461 // -----------------------------------------------------------------------
462
463 // very first initialization function
464 //
465 // Override: very rarely
466 virtual bool Initialize(int& argc, wxChar **argv);
467
468 // a platform-dependent version of OnInit(): the code here is likely to
469 // depend on the toolkit. default version does nothing.
470 //
471 // Override: rarely.
472 virtual bool OnInitGui();
473
474 // called to start program execution - the default version just enters
475 // the main GUI loop in which events are received and processed until
476 // the last window is not deleted (if GetExitOnFrameDelete) or
477 // ExitMainLoop() is called. In console mode programs, the execution
478 // of the program really starts here
479 //
480 // Override: rarely in GUI applications, always in console ones.
481 virtual int OnRun();
482
483 // a matching function for OnInit()
484 virtual int OnExit();
485
486 // very last clean up function
487 //
488 // Override: very rarely
489 virtual void CleanUp();
490
491
492 // the worker functions - usually not used directly by the user code
493 // -----------------------------------------------------------------
494
495 // safer alternatives to Yield(), using wxWindowDisabler
496 virtual bool SafeYield(wxWindow *win, bool onlyIfNeeded);
497 virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess);
498
499 // returns true if the main thread is inside a Yield() call
500 virtual bool IsYielding() const
501 { return m_isInsideYield; }
502
503 // returns true if events of the given event category should be immediately
504 // processed inside a wxApp::Yield() call or rather should be queued for
505 // later processing by the main event loop
506 virtual bool IsEventAllowedInsideYield(wxEventCategory cat) const;
507
508 // this virtual function is called in the GUI mode when the application
509 // becomes idle and normally just sends wxIdleEvent to all interested
510 // parties
511 //
512 // it should return true if more idle events are needed, false if not
513 virtual bool ProcessIdle();
514
515 // Send idle event to window and all subwindows
516 // Returns true if more idle time is requested.
517 virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
518
519
520 // top level window functions
521 // --------------------------
522
523 // return true if our app has focus
524 virtual bool IsActive() const { return m_isActive; }
525
526 // set the "main" top level window
527 void SetTopWindow(wxWindow *win) { m_topWindow = win; }
528
529 // return the "main" top level window (if it hadn't been set previously
530 // with SetTopWindow(), will return just some top level window and, if
531 // there are none, will return NULL)
532 virtual wxWindow *GetTopWindow() const;
533
534 // control the exit behaviour: by default, the program will exit the
535 // main loop (and so, usually, terminate) when the last top-level
536 // program window is deleted. Beware that if you disable this behaviour
537 // (with SetExitOnFrameDelete(false)), you'll have to call
538 // ExitMainLoop() explicitly from somewhere.
539 void SetExitOnFrameDelete(bool flag)
540 { m_exitOnFrameDelete = flag ? Yes : No; }
541 bool GetExitOnFrameDelete() const
542 { return m_exitOnFrameDelete == Yes; }
543
544
545 // display mode, visual, printing mode, ...
546 // ------------------------------------------------------------------------
547
548 // Get display mode that is used use. This is only used in framebuffer
549 // wxWin ports (such as wxMGL or wxDFB).
550 virtual wxVideoMode GetDisplayMode() const;
551 // Set display mode to use. This is only used in framebuffer wxWin
552 // ports (such as wxMGL or wxDFB). This method should be called from
553 // wxApp::OnInitGui
554 virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
555
556 // set use of best visual flag (see below)
557 void SetUseBestVisual( bool flag, bool forceTrueColour = false )
558 { m_useBestVisual = flag; m_forceTrueColour = forceTrueColour; }
559 bool GetUseBestVisual() const { return m_useBestVisual; }
560
561 // set/get printing mode: see wxPRINT_XXX constants.
562 //
563 // default behaviour is the normal one for Unix: always use PostScript
564 // printing.
565 virtual void SetPrintMode(int WXUNUSED(mode)) { }
566 int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
567
568 // Return the layout direction for the current locale or wxLayout_Default
569 // if it's unknown
570 virtual wxLayoutDirection GetLayoutDirection() const;
571
572 // Change the theme used by the application, return true on success.
573 virtual bool SetNativeTheme(const wxString& WXUNUSED(theme)) { return false; }
574
575
576 // command line parsing (GUI-specific)
577 // ------------------------------------------------------------------------
578
579#if wxUSE_CMDLINE_PARSER
580 virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
581 virtual void OnInitCmdLine(wxCmdLineParser& parser);
582#endif
583
584 // miscellaneous other stuff
585 // ------------------------------------------------------------------------
586
587 // called by toolkit-specific code to set the app status: active (we have
588 // focus) or not and also the last window which had focus before we were
589 // deactivated
590 virtual void SetActive(bool isActive, wxWindow *lastFocus);
591
592#if WXWIN_COMPATIBILITY_2_6
593 // OBSOLETE: don't use, always returns true
594 //
595 // returns true if the program is successfully initialized
596 wxDEPRECATED( bool Initialized() );
597#endif // WXWIN_COMPATIBILITY_2_6
598
599protected:
600 // delete all objects in wxPendingDelete list
601 void DeletePendingObjects();
602
603 // override base class method to use GUI traits
604 virtual wxAppTraits *CreateTraits();
605
606
607 // the main top level window (may be NULL)
608 wxWindow *m_topWindow;
609
610 // if Yes, exit the main loop when the last top level window is deleted, if
611 // No don't do it and if Later -- only do it once we reach our OnRun()
612 //
613 // the explanation for using this strange scheme is given in appcmn.cpp
614 enum
615 {
616 Later = -1,
617 No,
618 Yes
619 } m_exitOnFrameDelete;
620
621 // true if the app wants to use the best visual on systems where
622 // more than one are available (Sun, SGI, XFree86 4.0 ?)
623 bool m_useBestVisual;
624 // force TrueColour just in case "best" isn't TrueColour
625 bool m_forceTrueColour;
626
627 // does any of our windows have focus?
628 bool m_isActive;
629
630 // Yield() helpers:
631 bool m_isInsideYield;
632 long m_eventsToProcessInsideYield;
633
634 DECLARE_NO_COPY_CLASS(wxAppBase)
635};
636
637#if WXWIN_COMPATIBILITY_2_6
638 inline bool wxAppBase::Initialized() { return true; }
639#endif // WXWIN_COMPATIBILITY_2_6
640
641// ----------------------------------------------------------------------------
642// now include the declaration of the real class
643// ----------------------------------------------------------------------------
644
645#if defined(__WXPALMOS__)
646 #include "wx/palmos/app.h"
647#elif defined(__WXMSW__)
648 #include "wx/msw/app.h"
649#elif defined(__WXMOTIF__)
650 #include "wx/motif/app.h"
651#elif defined(__WXMGL__)
652 #include "wx/mgl/app.h"
653#elif defined(__WXDFB__)
654 #include "wx/dfb/app.h"
655#elif defined(__WXGTK20__)
656 #include "wx/gtk/app.h"
657#elif defined(__WXGTK__)
658 #include "wx/gtk1/app.h"
659#elif defined(__WXX11__)
660 #include "wx/x11/app.h"
661#elif defined(__WXMAC__)
662 #include "wx/osx/app.h"
663#elif defined(__WXCOCOA__)
664 #include "wx/cocoa/app.h"
665#elif defined(__WXPM__)
666 #include "wx/os2/app.h"
667#endif
668
669#else // !GUI
670
671// wxApp is defined in core and we cannot define another one in wxBase,
672// so use the preprocessor to allow using wxApp in console programs too
673#define wxApp wxAppConsole
674
675#endif // GUI/!GUI
676
677// ----------------------------------------------------------------------------
678// the global data
679// ----------------------------------------------------------------------------
680
681// for compatibility, we define this macro to access the global application
682// object of type wxApp
683//
684// note that instead of using of wxTheApp in application code you should
685// consider using DECLARE_APP() after which you may call wxGetApp() which will
686// return the object of the correct type (i.e. MyApp and not wxApp)
687//
688// the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
689// console mode it does nothing at all
690#define wxTheApp static_cast<wxApp*>(wxApp::GetInstance())
691
692// ----------------------------------------------------------------------------
693// global functions
694// ----------------------------------------------------------------------------
695
696// event loop related functions only work in GUI programs
697// ------------------------------------------------------
698
699// Force an exit from main loop
700WXDLLIMPEXP_BASE void wxExit();
701
702// avoid redeclaring this function here if it had been already declared by
703// wx/utils.h, this results in warnings from g++ with -Wredundant-decls
704#ifndef wx_YIELD_DECLARED
705#define wx_YIELD_DECLARED
706
707// Yield to other apps/messages
708WXDLLIMPEXP_CORE bool wxYield();
709
710#endif // wx_YIELD_DECLARED
711
712// Yield to other apps/messages
713WXDLLIMPEXP_BASE void wxWakeUpIdle();
714
715// ----------------------------------------------------------------------------
716// macros for dynamic creation of the application object
717// ----------------------------------------------------------------------------
718
719// Having a global instance of this class allows wxApp to be aware of the app
720// creator function. wxApp can then call this function to create a new app
721// object. Convoluted, but necessary.
722
723class WXDLLIMPEXP_BASE wxAppInitializer
724{
725public:
726 wxAppInitializer(wxAppInitializerFunction fn)
727 { wxApp::SetInitializerFunction(fn); }
728};
729
730// the code below defines a IMPLEMENT_WXWIN_MAIN macro which you can use if
731// your compiler really, really wants main() to be in your main program (e.g.
732// hello.cpp). Now IMPLEMENT_APP should add this code if required.
733
734#define IMPLEMENT_WXWIN_MAIN_CONSOLE \
735 int main(int argc, char **argv) { return wxEntry(argc, argv); }
736
737// port-specific header could have defined it already in some special way
738#ifndef IMPLEMENT_WXWIN_MAIN
739 #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE
740#endif // defined(IMPLEMENT_WXWIN_MAIN)
741
742#ifdef __WXUNIVERSAL__
743 #include "wx/univ/theme.h"
744
745 #ifdef wxUNIV_DEFAULT_THEME
746 #define IMPLEMENT_WX_THEME_SUPPORT \
747 WX_USE_THEME(wxUNIV_DEFAULT_THEME);
748 #else
749 #define IMPLEMENT_WX_THEME_SUPPORT
750 #endif
751#else
752 #define IMPLEMENT_WX_THEME_SUPPORT
753#endif
754
755// Use this macro if you want to define your own main() or WinMain() function
756// and call wxEntry() from there.
757#define IMPLEMENT_APP_NO_MAIN(appname) \
758 wxAppConsole *wxCreateApp() \
759 { \
760 wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE, \
761 "your program"); \
762 return new appname; \
763 } \
764 wxAppInitializer \
765 wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
766 DECLARE_APP(appname) \
767 appname& wxGetApp() { return *static_cast<appname*>(wxApp::GetInstance()); }
768
769// Same as IMPLEMENT_APP() normally but doesn't include themes support in
770// wxUniversal builds
771#define IMPLEMENT_APP_NO_THEMES(appname) \
772 IMPLEMENT_APP_NO_MAIN(appname) \
773 IMPLEMENT_WXWIN_MAIN
774
775// Use this macro exactly once, the argument is the name of the wxApp-derived
776// class which is the class of your application.
777#define IMPLEMENT_APP(appname) \
778 IMPLEMENT_APP_NO_THEMES(appname) \
779 IMPLEMENT_WX_THEME_SUPPORT
780
781// Same as IMPLEMENT_APP(), but for console applications.
782#define IMPLEMENT_APP_CONSOLE(appname) \
783 IMPLEMENT_APP_NO_MAIN(appname) \
784 IMPLEMENT_WXWIN_MAIN_CONSOLE
785
786// this macro can be used multiple times and just allows you to use wxGetApp()
787// function
788#define DECLARE_APP(appname) extern appname& wxGetApp();
789
790
791// declare the stuff defined by IMPLEMENT_APP() macro, it's not really needed
792// anywhere else but at the very least it suppresses icc warnings about
793// defining extern symbols without prior declaration, and it shouldn't do any
794// harm
795extern wxAppConsole *wxCreateApp();
796extern wxAppInitializer wxTheAppInitializer;
797
798#endif // _WX_APP_H_BASE_