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