]> git.saurik.com Git - wxWidgets.git/blame - include/wx/app.h
build fix for wxGTK/Univ build (#9706)
[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
96b2cbe8
VZ
201 // this function provides safer access to traits object than
202 // wxTheApp->GetTraits() during startup or termination when the global
203 // application object itself may be unavailable
204 //
205 // of course, it still returns NULL in this case and the caller must check
206 // for it
207 static wxAppTraits *GetTraitsIfExists();
75acb532 208
e2478fde
VZ
209 // event processing functions
210 // --------------------------
094637f6 211
9154d8cf
VZ
212 // this method allows to filter all the events processed by the program, so
213 // you should try to return quickly from it to avoid slowing down the
214 // program to the crawl
215 //
216 // return value should be -1 to continue with the normal event processing,
217 // or TRUE or FALSE to stop further processing and pretend that the event
218 // had been already processed or won't be processed at all, respectively
219 virtual int FilterEvent(wxEvent& event);
220
883117d1
VZ
221#if wxUSE_EXCEPTIONS
222 // call the specified handler on the given object with the given event
223 //
224 // this method only exists to allow catching the exceptions thrown by any
225 // event handler, it would lead to an extra (useless) virtual function call
226 // if the exceptions were not used, so it doesn't even exist in that case
227 virtual void HandleEvent(wxEvtHandler *handler,
228 wxEventFunction func,
229 wxEvent& event) const;
2dc62891
VZ
230
231 // Called when an unhandled C++ exception occurs inside OnRun(): note that
1663c655
VZ
232 // the main event loop has already terminated by now and the program will
233 // exit, if you need to really handle the exceptions you need to override
234 // OnExceptionInMainLoop()
235 virtual void OnUnhandledException();
883117d1
VZ
236#endif // wxUSE_EXCEPTIONS
237
b46b1d59
VZ
238 // event processing functions
239 // --------------------------
240
241 // return true if we're running event loop, i.e. if the events can
242 // (already) be dispatched
e0954e72 243 static bool IsMainLoopRunning();
b46b1d59 244
e2478fde
VZ
245 // process all events in the wxPendingEvents list -- it is necessary to
246 // call this function to process posted events. This happens during each
247 // event loop iteration in GUI mode but if there is no main loop, it may be
248 // also called directly.
249 virtual void ProcessPendingEvents();
250
b46b1d59
VZ
251 // check if there are pending events on global pending event list
252 bool HasPendingEvents() const;
253
e2478fde
VZ
254 // doesn't do anything in this class, just a hook for GUI wxApp
255 virtual bool Yield(bool WXUNUSED(onlyIfNeeded) = false) { return true; }
256
257 // make sure that idle events are sent again
b46b1d59
VZ
258 virtual void WakeUpIdle();
259
260 // execute the main GUI loop, the function returns when the loop ends
261 virtual int MainLoop();
262
263 // exit the main GUI loop during the next iteration (i.e. it does not
264 // stop the program immediately!)
265 virtual void ExitMainLoop();
266
267 // returns true if there are unprocessed events in the event queue
268 virtual bool Pending();
e2478fde 269
b46b1d59
VZ
270 // process the first event in the event queue (blocks until an event
271 // appears if there are none currently, use Pending() if this is not
272 // wanted), returns false if the event loop should stop and true
273 // otherwise
274 virtual bool Dispatch();
9b0db452 275
b46b1d59
VZ
276 // this virtual function is called when the application
277 // becomes idle and normally just sends wxIdleEvent to all interested
278 // parties
279 //
280 // it should return true if more idle events are needed, false if not
281 virtual bool ProcessIdle();
282
283#if wxUSE_EXCEPTIONS
284 // Function called if an uncaught exception is caught inside the main
285 // event loop: it may return true to continue running the event loop or
286 // false to stop it (in the latter case it may rethrow the exception as
287 // well)
288 virtual bool OnExceptionInMainLoop();
289#endif // wxUSE_EXCEPTIONS
e2478fde 290
a5f1fd3e
VZ
291 // debugging support
292 // -----------------
293
3ec4a23f 294#ifdef __WXDEBUG__
a5f1fd3e
VZ
295 // this function is called when an assert failure occurs, the base class
296 // version does the normal processing (i.e. shows the usual assert failure
297 // dialog box)
aad65f13 298 //
3ec4a23f
VZ
299 // the arguments are the location of the failed assert (func may be empty
300 // if the compiler doesn't support C99 __FUNCTION__), the text of the
aad65f13 301 // assert itself and the user-specified message
3ec4a23f
VZ
302 virtual void OnAssertFailure(const wxChar *file,
303 int line,
304 const wxChar *func,
305 const wxChar *cond,
306 const wxChar *msg);
307
308 // old version of the function without func parameter, for compatibility
309 // only, override OnAssertFailure() in the new code
aad65f13
VZ
310 virtual void OnAssert(const wxChar *file,
311 int line,
312 const wxChar *cond,
313 const wxChar *msg);
a5f1fd3e 314#endif // __WXDEBUG__
8030d606 315
090a6d7a
VZ
316 // check that the wxBuildOptions object (constructed in the application
317 // itself, usually the one from IMPLEMENT_APP() macro) matches the build
318 // options of the library and abort if it doesn't
2a7c7605
VS
319 static bool CheckBuildOptions(const char *optionsSignature,
320 const char *componentName);
73deed44 321
094637f6
VZ
322 // implementation only from now on
323 // -------------------------------
324
325 // helpers for dynamic wxApp construction
326 static void SetInitializerFunction(wxAppInitializerFunction fn)
e2478fde 327 { ms_appInitFn = fn; }
094637f6 328 static wxAppInitializerFunction GetInitializerFunction()
e2478fde 329 { return ms_appInitFn; }
094637f6 330
a80e5f9e
VZ
331 // accessors for ms_appInstance field (external code might wish to modify
332 // it, this is why we provide a setter here as well, but you should really
333 // know what you're doing if you call it), wxTheApp is usually used instead
334 // of GetInstance()
335 static wxAppConsole *GetInstance() { return ms_appInstance; }
336 static void SetInstance(wxAppConsole *app) { ms_appInstance = app; }
337
72cdf4c9 338
e2478fde 339 // command line arguments (public for backwards compatibility)
541ea80f
VZ
340 int argc;
341
342 // this object is implicitly convertible to either "char**" (traditional
343 // type of argv parameter of main()) or to "wchar_t **" (for compatibility
344 // with Unicode build in previous wx versions and because the command line
345 // can, in pr
346#if wxUSE_UNICODE
347 wxCmdLineArgsArray argv;
348#else
349 char **argv;
350#endif
094637f6 351
094637f6 352protected:
e2478fde
VZ
353 // the function which creates the traits object when GetTraits() needs it
354 // for the first time
355 virtual wxAppTraits *CreateTraits();
356
357
094637f6 358 // function used for dynamic wxApp creation
e2478fde 359 static wxAppInitializerFunction ms_appInitFn;
094637f6 360
a80e5f9e
VZ
361 // the one and only global application object
362 static wxAppConsole *ms_appInstance;
363
b46b1d59
VZ
364 // create main loop from AppTraits or return NULL if
365 // there is no main loop implementation
2ddff00c 366 wxEventLoopBase *CreateMainLoop();
7cafd224 367
094637f6 368 // application info (must be set from the user code)
180b5b48
VZ
369 wxString m_vendorName, // vendor name ("acme")
370 m_vendorDisplayName, // vendor display name (e.g. "ACME Inc")
9cf3d218
VZ
371 m_appName, // app name ("myapp")
372 m_appDisplayName, // app display name ("My Application")
373 m_className; // class name
a69be60b 374
e2478fde
VZ
375 // the class defining the application behaviour, NULL initially and created
376 // by GetTraits() when first needed
377 wxAppTraits *m_traits;
378
b46b1d59
VZ
379 // the main event loop of the application (may be NULL if the loop hasn't
380 // been started yet or has already terminated)
2ddff00c 381 wxEventLoopBase *m_mainLoop;
e2478fde
VZ
382
383 // the application object is a singleton anyhow, there is no sense in
384 // copying it
e0954e72 385 DECLARE_NO_COPY_CLASS(wxAppConsoleBase)
e2478fde
VZ
386};
387
e0954e72
VZ
388#if defined(__UNIX__)
389 #include "wx/unix/app.h"
390#else
4c2a8d89
VZ
391 // this has to be a class and not a typedef as we forward declare it
392 class wxAppConsole : public wxAppConsoleBase { };
e0954e72
VZ
393#endif
394
e2478fde
VZ
395// ----------------------------------------------------------------------------
396// wxAppBase: the common part of wxApp implementations for all platforms
397// ----------------------------------------------------------------------------
398
1e6feb95 399#if wxUSE_GUI
e2478fde 400
bddd7a8d 401class WXDLLIMPEXP_CORE wxAppBase : public wxAppConsole
e2478fde
VZ
402{
403public:
404 wxAppBase();
405 virtual ~wxAppBase();
406
407 // the virtual functions which may/must be overridden in the derived class
408 // -----------------------------------------------------------------------
409
94826170
VZ
410 // very first initialization function
411 //
412 // Override: very rarely
05e2b077 413 virtual bool Initialize(int& argc, wxChar **argv);
94826170 414
e2478fde
VZ
415 // a platform-dependent version of OnInit(): the code here is likely to
416 // depend on the toolkit. default version does nothing.
417 //
418 // Override: rarely.
419 virtual bool OnInitGui();
420
421 // called to start program execution - the default version just enters
422 // the main GUI loop in which events are received and processed until
423 // the last window is not deleted (if GetExitOnFrameDelete) or
424 // ExitMainLoop() is called. In console mode programs, the execution
425 // of the program really starts here
426 //
427 // Override: rarely in GUI applications, always in console ones.
428 virtual int OnRun();
429
b913d3ed
VZ
430 // a matching function for OnInit()
431 virtual int OnExit();
432
94826170
VZ
433 // very last clean up function
434 //
435 // Override: very rarely
436 virtual void CleanUp();
e2478fde
VZ
437
438
439 // the worker functions - usually not used directly by the user code
440 // -----------------------------------------------------------------
441
e2478fde 442
e2478fde
VZ
443
444 // process all currently pending events right now
445 //
446 // it is an error to call Yield() recursively unless the value of
4629016d 447 // onlyIfNeeded is true
e2478fde
VZ
448 //
449 // WARNING: this function is dangerous as it can lead to unexpected
450 // reentrancies (i.e. when called from an event handler it
451 // may result in calling the same event handler again), use
452 // with _extreme_ care or, better, don't use at all!
4629016d 453 virtual bool Yield(bool onlyIfNeeded = false) = 0;
e2478fde
VZ
454
455 // this virtual function is called in the GUI mode when the application
456 // becomes idle and normally just sends wxIdleEvent to all interested
457 // parties
458 //
4629016d 459 // it should return true if more idle events are needed, false if not
1bf77ee5 460 virtual bool ProcessIdle();
e39af974 461
e39af974 462 // Send idle event to window and all subwindows
4629016d 463 // Returns true if more idle time is requested.
5109ae5d 464 virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
e2478fde 465
2dc62891 466
e2478fde
VZ
467 // top level window functions
468 // --------------------------
469
4629016d 470 // return true if our app has focus
e2478fde
VZ
471 virtual bool IsActive() const { return m_isActive; }
472
473 // set the "main" top level window
474 void SetTopWindow(wxWindow *win) { m_topWindow = win; }
475
476 // return the "main" top level window (if it hadn't been set previously
477 // with SetTopWindow(), will return just some top level window and, if
478 // there are none, will return NULL)
5ff14574 479 virtual wxWindow *GetTopWindow() const;
e2478fde
VZ
480
481 // control the exit behaviour: by default, the program will exit the
482 // main loop (and so, usually, terminate) when the last top-level
483 // program window is deleted. Beware that if you disable this behaviour
4629016d 484 // (with SetExitOnFrameDelete(false)), you'll have to call
e2478fde
VZ
485 // ExitMainLoop() explicitly from somewhere.
486 void SetExitOnFrameDelete(bool flag)
487 { m_exitOnFrameDelete = flag ? Yes : No; }
488 bool GetExitOnFrameDelete() const
489 { return m_exitOnFrameDelete == Yes; }
490
491
492 // display mode, visual, printing mode, ...
493 // ------------------------------------------------------------------------
494
495 // Get display mode that is used use. This is only used in framebuffer
b3c86150 496 // wxWin ports (such as wxMGL or wxDFB).
5ff14574 497 virtual wxVideoMode GetDisplayMode() const;
e2478fde 498 // Set display mode to use. This is only used in framebuffer wxWin
b3c86150 499 // ports (such as wxMGL or wxDFB). This method should be called from
e2478fde 500 // wxApp::OnInitGui
4629016d 501 virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
e2478fde
VZ
502
503 // set use of best visual flag (see below)
9cf3d218 504 void SetUseBestVisual( bool flag, bool forceTrueColour = false )
515a31bf 505 { m_useBestVisual = flag; m_forceTrueColour = forceTrueColour; }
e2478fde
VZ
506 bool GetUseBestVisual() const { return m_useBestVisual; }
507
508 // set/get printing mode: see wxPRINT_XXX constants.
509 //
510 // default behaviour is the normal one for Unix: always use PostScript
511 // printing.
512 virtual void SetPrintMode(int WXUNUSED(mode)) { }
513 int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
514
475a93b7
VZ
515 // Return the layout direction for the current locale or wxLayout_Default
516 // if it's unknown
517 virtual wxLayoutDirection GetLayoutDirection() const;
518
c50c6fb2
VZ
519 // Change the theme used by the application, return true on success.
520 virtual bool SetNativeTheme(const wxString& WXUNUSED(theme)) { return false; }
521
e2478fde 522
b913d3ed
VZ
523 // command line parsing (GUI-specific)
524 // ------------------------------------------------------------------------
525
8030d606 526#if wxUSE_CMDLINE_PARSER
b913d3ed
VZ
527 virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
528 virtual void OnInitCmdLine(wxCmdLineParser& parser);
8030d606 529#endif
b913d3ed 530
e2478fde
VZ
531 // miscellaneous other stuff
532 // ------------------------------------------------------------------------
533
534 // called by toolkit-specific code to set the app status: active (we have
535 // focus) or not and also the last window which had focus before we were
536 // deactivated
537 virtual void SetActive(bool isActive, wxWindow *lastFocus);
538
40ff126a 539#if WXWIN_COMPATIBILITY_2_6
dd435a79
VZ
540 // OBSOLETE: don't use, always returns true
541 //
542 // returns true if the program is successfully initialized
40ff126a
WS
543 wxDEPRECATED( bool Initialized() );
544#endif // WXWIN_COMPATIBILITY_2_6
dd435a79 545
e2478fde 546protected:
94826170
VZ
547 // delete all objects in wxPendingDelete list
548 void DeletePendingObjects();
549
e2478fde
VZ
550 // override base class method to use GUI traits
551 virtual wxAppTraits *CreateTraits();
552
553
554 // the main top level window (may be NULL)
1e6feb95
VZ
555 wxWindow *m_topWindow;
556
1cbee0b4
VZ
557 // if Yes, exit the main loop when the last top level window is deleted, if
558 // No don't do it and if Later -- only do it once we reach our OnRun()
559 //
560 // the explanation for using this strange scheme is given in appcmn.cpp
561 enum
562 {
563 Later = -1,
564 No,
565 Yes
566 } m_exitOnFrameDelete;
1e6feb95 567
90e572f1 568 // true if the app wants to use the best visual on systems where
8480b297
RR
569 // more than one are available (Sun, SGI, XFree86 4.0 ?)
570 bool m_useBestVisual;
515a31bf
RR
571 // force TrueColour just in case "best" isn't TrueColour
572 bool m_forceTrueColour;
094637f6 573
90e572f1 574 // does any of our windows have focus?
1e6feb95 575 bool m_isActive;
e2478fde
VZ
576
577
578 DECLARE_NO_COPY_CLASS(wxAppBase)
094637f6
VZ
579};
580
40ff126a
WS
581#if WXWIN_COMPATIBILITY_2_6
582 inline bool wxAppBase::Initialized() { return true; }
583#endif // WXWIN_COMPATIBILITY_2_6
584
094637f6
VZ
585// ----------------------------------------------------------------------------
586// now include the declaration of the real class
587// ----------------------------------------------------------------------------
588
e0954e72
VZ
589#if defined(__WXPALMOS__)
590 #include "wx/palmos/app.h"
591#elif defined(__WXMSW__)
592 #include "wx/msw/app.h"
593#elif defined(__WXMOTIF__)
594 #include "wx/motif/app.h"
595#elif defined(__WXMGL__)
596 #include "wx/mgl/app.h"
597#elif defined(__WXDFB__)
598 #include "wx/dfb/app.h"
599#elif defined(__WXGTK20__)
600 #include "wx/gtk/app.h"
601#elif defined(__WXGTK__)
602 #include "wx/gtk1/app.h"
603#elif defined(__WXX11__)
604 #include "wx/x11/app.h"
605#elif defined(__WXMAC__)
ef0e9220 606 #include "wx/osx/app.h"
e0954e72
VZ
607#elif defined(__WXCOCOA__)
608 #include "wx/cocoa/app.h"
609#elif defined(__WXPM__)
610 #include "wx/os2/app.h"
611#endif
612
e90c1d2a 613#else // !GUI
e0954e72
VZ
614
615// wxApp is defined in core and we cannot define another one in wxBase,
616// so use the preprocessor to allow using wxApp in console programs too
617#define wxApp wxAppConsole
618
e90c1d2a 619#endif // GUI/!GUI
c801d85f 620
094637f6 621// ----------------------------------------------------------------------------
ee31c392
VZ
622// the global data
623// ----------------------------------------------------------------------------
624
7cafd224
VZ
625// for compatibility, we define this macro to access the global application
626// object of type wxApp
627//
628// note that instead of using of wxTheApp in application code you should
629// consider using DECLARE_APP() after which you may call wxGetApp() which will
630// return the object of the correct type (i.e. MyApp and not wxApp)
631//
632// the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
633// console mode it does nothing at all
5ff14574 634#define wxTheApp wx_static_cast(wxApp*, wxApp::GetInstance())
ee31c392
VZ
635
636// ----------------------------------------------------------------------------
637// global functions
638// ----------------------------------------------------------------------------
639
e90c1d2a
VZ
640// event loop related functions only work in GUI programs
641// ------------------------------------------------------
642
ee31c392 643// Force an exit from main loop
bddd7a8d 644extern void WXDLLIMPEXP_BASE wxExit();
ee31c392 645
a131b460
VZ
646// avoid redeclaring this function here if it had been already declated by
647// wx/utils.h, this results in warnings from g++ with -Wredundant-decls
648#ifndef wx_YIELD_DECLARED
649#define wx_YIELD_DECLARED
650
ee31c392 651// Yield to other apps/messages
bddd7a8d 652extern bool WXDLLIMPEXP_BASE wxYield();
e90c1d2a 653
a131b460
VZ
654#endif // wx_YIELD_DECLARED
655
bf9e3e73 656// Yield to other apps/messages
bddd7a8d 657extern void WXDLLIMPEXP_BASE wxWakeUpIdle();
bf9e3e73 658
ee31c392 659// ----------------------------------------------------------------------------
094637f6
VZ
660// macros for dynamic creation of the application object
661// ----------------------------------------------------------------------------
662
663// Having a global instance of this class allows wxApp to be aware of the app
664// creator function. wxApp can then call this function to create a new app
665// object. Convoluted, but necessary.
c801d85f 666
bddd7a8d 667class WXDLLIMPEXP_BASE wxAppInitializer
c801d85f
KB
668{
669public:
094637f6
VZ
670 wxAppInitializer(wxAppInitializerFunction fn)
671 { wxApp::SetInitializerFunction(fn); }
c801d85f
KB
672};
673
956495ca
VZ
674// the code below defines a IMPLEMENT_WXWIN_MAIN macro which you can use if
675// your compiler really, really wants main() to be in your main program (e.g.
676// hello.cpp). Now IMPLEMENT_APP should add this code if required.
26a87b69 677
80b2db4e
VS
678#define IMPLEMENT_WXWIN_MAIN_CONSOLE \
679 int main(int argc, char **argv) { return wxEntry(argc, argv); }
680
90e572f1 681// port-specific header could have defined it already in some special way
956495ca 682#ifndef IMPLEMENT_WXWIN_MAIN
7738c2e5 683 #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE
956495ca 684#endif // defined(IMPLEMENT_WXWIN_MAIN)
26a87b69 685
24e78d27
VZ
686#ifdef __WXUNIVERSAL__
687 #include "wx/univ/theme.h"
688
ee92941a
VS
689 #ifdef wxUNIV_DEFAULT_THEME
690 #define IMPLEMENT_WX_THEME_SUPPORT \
691 WX_USE_THEME(wxUNIV_DEFAULT_THEME);
692 #else
693 #define IMPLEMENT_WX_THEME_SUPPORT
694 #endif
24e78d27
VZ
695#else
696 #define IMPLEMENT_WX_THEME_SUPPORT
697#endif
c801d85f 698
c661ecca
RR
699// Use this macro if you want to define your own main() or WinMain() function
700// and call wxEntry() from there.
94826170 701#define IMPLEMENT_APP_NO_MAIN(appname) \
e8e1149b 702 wxAppConsole *wxCreateApp() \
94826170 703 { \
2a7c7605 704 wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE, \
82c75aea 705 "your program"); \
94826170
VZ
706 return new appname; \
707 } \
708 wxAppInitializer \
709 wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
17a1ebd1 710 DECLARE_APP(appname) \
5ff14574 711 appname& wxGetApp() { return *wx_static_cast(appname*, wxApp::GetInstance()); }
c661ecca 712
24e78d27
VZ
713// Same as IMPLEMENT_APP() normally but doesn't include themes support in
714// wxUniversal builds
715#define IMPLEMENT_APP_NO_THEMES(appname) \
716 IMPLEMENT_APP_NO_MAIN(appname) \
717 IMPLEMENT_WXWIN_MAIN
718
719// Use this macro exactly once, the argument is the name of the wxApp-derived
720// class which is the class of your application.
721#define IMPLEMENT_APP(appname) \
722 IMPLEMENT_APP_NO_THEMES(appname) \
723 IMPLEMENT_WX_THEME_SUPPORT
724
80b2db4e
VS
725// Same as IMPLEMENT_APP(), but for console applications.
726#define IMPLEMENT_APP_CONSOLE(appname) \
727 IMPLEMENT_APP_NO_MAIN(appname) \
728 IMPLEMENT_WXWIN_MAIN_CONSOLE
729
24e78d27
VZ
730// this macro can be used multiple times and just allows you to use wxGetApp()
731// function
094637f6 732#define DECLARE_APP(appname) extern appname& wxGetApp();
c801d85f 733
17a1ebd1
VZ
734
735// declare the stuff defined by IMPLEMENT_APP() macro, it's not really needed
736// anywhere else but at the very least it suppresses icc warnings about
737// defining extern symbols without prior declaration, and it shouldn't do any
738// harm
739extern wxAppConsole *wxCreateApp();
740extern wxAppInitializer wxTheAppInitializer;
741
94826170 742#endif // _WX_APP_H_BASE_