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