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