]> git.saurik.com Git - wxWidgets.git/blame - include/wx/app.h
Fixed wxRichTextCtrl base class
[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;
d48b06bd 35 class WXDLLIMPEXP_FWD_CORE wxWindow;
fb761cd5 36#endif
1bf77ee5 37
53c9228e
VZ
38// ----------------------------------------------------------------------------
39// typedefs
40// ----------------------------------------------------------------------------
41
42// the type of the function used to create a wxApp object on program start up
e8e1149b 43typedef wxAppConsole* (*wxAppInitializerFunction)();
53c9228e 44
094637f6
VZ
45// ----------------------------------------------------------------------------
46// constants
47// ----------------------------------------------------------------------------
48
e2478fde
VZ
49enum
50{
51 wxPRINT_WINDOWS = 1,
52 wxPRINT_POSTSCRIPT = 2
53};
094637f6
VZ
54
55// ----------------------------------------------------------------------------
e0954e72 56// wxAppConsoleBase: wxApp for non-GUI applications
094637f6
VZ
57// ----------------------------------------------------------------------------
58
e0954e72 59class WXDLLIMPEXP_BASE wxAppConsoleBase : public wxEvtHandler
094637f6
VZ
60{
61public:
e2478fde 62 // ctor and dtor
e0954e72
VZ
63 wxAppConsoleBase();
64 virtual ~wxAppConsoleBase();
e2478fde 65
1e6feb95 66
094637f6
VZ
67 // the virtual functions which may/must be overridden in the derived class
68 // -----------------------------------------------------------------------
bf188f1a 69
94826170
VZ
70 // This is the very first function called for a newly created wxApp object,
71 // it is used by the library to do the global initialization. If, for some
72 // reason, you must override it (instead of just overriding OnInit(), as
73 // usual, for app-specific initializations), do not forget to call the base
74 // class version!
05e2b077 75 virtual bool Initialize(int& argc, wxChar **argv);
94826170 76
7fbc89bb
DE
77 // This gives wxCocoa a chance to call OnInit() with a memory pool in place
78 virtual bool CallOnInit() { return OnInit(); }
79
e2478fde
VZ
80 // Called before OnRun(), this is a good place to do initialization -- if
81 // anything fails, return false from here to prevent the program from
82 // continuing. The command line is normally parsed here, call the base
83 // class OnInit() to do it.
bf188f1a 84 virtual bool OnInit();
094637f6 85
e2478fde
VZ
86 // This is the replacement for the normal main(): all program work should
87 // be done here. When OnRun() returns, the programs starts shutting down.
b46b1d59 88 virtual int OnRun();
094637f6 89
ec38d07d
FM
90 // This is called by wxEventLoopBase::SetActive(): you should put the code
91 // which needs an active event loop here.
92 // Note that this function is called whenever an event loop is activated;
93 // you may want to use wxEventLoopBase::IsMain() to perform initialization
94 // specific for the app's main event loop.
95 virtual void OnEventLoopEnter(wxEventLoopBase* WXUNUSED(loop)) {}
96
e2478fde
VZ
97 // This is only called if OnInit() returned true so it's a good place to do
98 // any cleanup matching the initializations done there.
7beba2fc 99 virtual int OnExit();
094637f6 100
ec38d07d
FM
101 // This is called by wxEventLoopBase::OnExit() for each event loop which
102 // is exited.
103 virtual void OnEventLoopExit(wxEventLoopBase* WXUNUSED(loop)) {}
104
94826170
VZ
105 // This is the very last function called on wxApp object before it is
106 // destroyed. If you override it (instead of overriding OnExit() as usual)
107 // do not forget to call the base class version!
108 virtual void CleanUp();
109
e2478fde
VZ
110 // Called when a fatal exception occurs, this function should take care not
111 // to do anything which might provoke a nested exception! It may be
112 // overridden if you wish to react somehow in non-default way (core dump
113 // under Unix, application crash under Windows) to fatal program errors,
114 // however extreme care should be taken if you don't want this function to
115 // crash.
094637f6
VZ
116 virtual void OnFatalException() { }
117
e2478fde
VZ
118 // Called from wxExit() function, should terminate the application a.s.a.p.
119 virtual void Exit();
b137e493 120
094637f6
VZ
121
122 // application info: name, description, vendor
123 // -------------------------------------------
124
125 // NB: all these should be set by the application itself, there are no
126 // reasonable default except for the application name which is taken to
127 // be argv[0]
128
129 // set/get the application name
130 wxString GetAppName() const
131 {
e2478fde 132 return m_appName.empty() ? m_className : m_appName;
094637f6
VZ
133 }
134 void SetAppName(const wxString& name) { m_appName = name; }
135
9cf3d218
VZ
136 // set/get the application display name: the display name is the name
137 // shown to the user in titles, reports, etc while the app name is
138 // used for paths, config, and other places the user doesn't see
139 //
140 // so the app name could be myapp while display name could be "My App"
141 wxString GetAppDisplayName() const
142 {
328fafa1
VZ
143 return m_appDisplayName.empty() ? GetAppName().Capitalize()
144 : m_appDisplayName;
9cf3d218 145 }
328fafa1 146
9cf3d218
VZ
147 void SetAppDisplayName(const wxString& name) { m_appDisplayName = name; }
148
094637f6
VZ
149 // set/get the app class name
150 wxString GetClassName() const { return m_className; }
151 void SetClassName(const wxString& name) { m_className = name; }
152
153 // set/get the vendor name
154 const wxString& GetVendorName() const { return m_vendorName; }
155 void SetVendorName(const wxString& name) { m_vendorName = name; }
156
180b5b48
VZ
157 // set/get the vendor display name: the display name is shown
158 // in titles/reports/dialogs to the user, while the vendor name
159 // is used in some areas such as wxConfig, wxStandardPaths, etc
160 const wxString& GetVendorDisplayName() const
161 {
162 return m_vendorDisplayName.empty() ? GetVendorName()
163 : m_vendorDisplayName;
164 }
165 void SetVendorDisplayName(const wxString& name)
166 {
167 m_vendorDisplayName = name;
168 }
169
e90c1d2a 170
bf188f1a
VZ
171 // cmd line parsing stuff
172 // ----------------------
173
174 // all of these methods may be overridden in the derived class to
175 // customize the command line parsing (by default only a few standard
176 // options are handled)
177 //
178 // you also need to call wxApp::OnInit() from YourApp::OnInit() for all
179 // this to work
180
181#if wxUSE_CMDLINE_PARSER
182 // this one is called from OnInit() to add all supported options
b913d3ed
VZ
183 // to the given parser (don't forget to call the base class version if you
184 // override it!)
bf188f1a
VZ
185 virtual void OnInitCmdLine(wxCmdLineParser& parser);
186
4629016d
WS
187 // called after successfully parsing the command line, return true
188 // to continue and false to exit (don't forget to call the base class
b913d3ed 189 // version if you override it!)
bf188f1a
VZ
190 virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
191
4629016d
WS
192 // called if "--help" option was specified, return true to continue
193 // and false to exit
bf188f1a
VZ
194 virtual bool OnCmdLineHelp(wxCmdLineParser& parser);
195
196 // called if incorrect command line options were given, return
4629016d 197 // false to abort and true to continue
bf188f1a
VZ
198 virtual bool OnCmdLineError(wxCmdLineParser& parser);
199#endif // wxUSE_CMDLINE_PARSER
200
e2478fde 201
094637f6
VZ
202 // miscellaneous customization functions
203 // -------------------------------------
204
e2478fde
VZ
205 // create the app traits object to which we delegate for everything which
206 // either should be configurable by the user (then he can change the
207 // default behaviour simply by overriding CreateTraits() and returning his
208 // own traits object) or which is GUI/console dependent as then wxAppTraits
9d55bfef 209 // allows us to abstract the differences behind the common facade
e2478fde
VZ
210 wxAppTraits *GetTraits();
211
96b2cbe8
VZ
212 // this function provides safer access to traits object than
213 // wxTheApp->GetTraits() during startup or termination when the global
214 // application object itself may be unavailable
215 //
216 // of course, it still returns NULL in this case and the caller must check
217 // for it
218 static wxAppTraits *GetTraitsIfExists();
75acb532 219
ec38d07d
FM
220 // returns the main event loop instance, i.e. the event loop which is started
221 // by OnRun() and which dispatches all events sent from the native toolkit
222 // to the application (except when new event loops are temporarily set-up).
223 // The returned value maybe NULL. Put initialization code which needs a
224 // non-NULL main event loop into OnEventLoopEnter().
225 wxEventLoopBase* GetMainLoop() const
226 { return m_mainLoop; }
227
228
e2478fde
VZ
229 // event processing functions
230 // --------------------------
094637f6 231
9154d8cf
VZ
232 // this method allows to filter all the events processed by the program, so
233 // you should try to return quickly from it to avoid slowing down the
234 // program to the crawl
235 //
236 // return value should be -1 to continue with the normal event processing,
237 // or TRUE or FALSE to stop further processing and pretend that the event
238 // had been already processed or won't be processed at all, respectively
239 virtual int FilterEvent(wxEvent& event);
240
dde19c21
FM
241 // return true if we're running event loop, i.e. if the events can
242 // (already) be dispatched
243 static bool IsMainLoopRunning();
244
883117d1 245#if wxUSE_EXCEPTIONS
3c778901
VZ
246 // execute the functor to handle the given event
247 //
248 // this is a generalization of HandleEvent() below and the base class
249 // implementation of CallEventHandler() still calls HandleEvent() for
250 // compatibility for functors which are just wxEventFunctions (i.e. methods
251 // of wxEvtHandler)
252 virtual void CallEventHandler(wxEvtHandler *handler,
253 wxEventFunctor& functor,
254 wxEvent& event) const;
255
883117d1
VZ
256 // call the specified handler on the given object with the given event
257 //
258 // this method only exists to allow catching the exceptions thrown by any
259 // event handler, it would lead to an extra (useless) virtual function call
260 // if the exceptions were not used, so it doesn't even exist in that case
261 virtual void HandleEvent(wxEvtHandler *handler,
262 wxEventFunction func,
263 wxEvent& event) const;
2dc62891
VZ
264
265 // Called when an unhandled C++ exception occurs inside OnRun(): note that
1663c655
VZ
266 // the main event loop has already terminated by now and the program will
267 // exit, if you need to really handle the exceptions you need to override
268 // OnExceptionInMainLoop()
269 virtual void OnUnhandledException();
dde19c21
FM
270
271 // Function called if an uncaught exception is caught inside the main
272 // event loop: it may return true to continue running the event loop or
273 // false to stop it (in the latter case it may rethrow the exception as
274 // well)
275 virtual bool OnExceptionInMainLoop();
276
883117d1
VZ
277#endif // wxUSE_EXCEPTIONS
278
b46b1d59 279
dde19c21
FM
280 // wxEventLoop redirections
281 // ------------------------
b46b1d59 282
d48b06bd 283 virtual void SuspendProcessingOfPendingEvents();
d48b06bd 284 virtual void ResumeProcessingOfPendingEvents();
e2478fde 285 virtual void ProcessPendingEvents();
b46b1d59
VZ
286 bool HasPendingEvents() const;
287
dde19c21
FM
288 virtual bool Pending();
289 virtual bool Dispatch();
b46b1d59 290
b46b1d59 291 virtual int MainLoop();
b46b1d59
VZ
292 virtual void ExitMainLoop();
293
dde19c21 294 bool Yield(bool onlyIfNeeded = false);
e2478fde 295
dde19c21 296 virtual void WakeUpIdle();
b46b1d59
VZ
297 virtual bool ProcessIdle();
298
d48b06bd 299
a5f1fd3e
VZ
300 // debugging support
301 // -----------------
302
3ec4a23f 303#ifdef __WXDEBUG__
a5f1fd3e
VZ
304 // this function is called when an assert failure occurs, the base class
305 // version does the normal processing (i.e. shows the usual assert failure
306 // dialog box)
aad65f13 307 //
3ec4a23f
VZ
308 // the arguments are the location of the failed assert (func may be empty
309 // if the compiler doesn't support C99 __FUNCTION__), the text of the
aad65f13 310 // assert itself and the user-specified message
3ec4a23f
VZ
311 virtual void OnAssertFailure(const wxChar *file,
312 int line,
313 const wxChar *func,
314 const wxChar *cond,
315 const wxChar *msg);
316
317 // old version of the function without func parameter, for compatibility
318 // only, override OnAssertFailure() in the new code
aad65f13
VZ
319 virtual void OnAssert(const wxChar *file,
320 int line,
321 const wxChar *cond,
322 const wxChar *msg);
a5f1fd3e 323#endif // __WXDEBUG__
8030d606 324
090a6d7a
VZ
325 // check that the wxBuildOptions object (constructed in the application
326 // itself, usually the one from IMPLEMENT_APP() macro) matches the build
327 // options of the library and abort if it doesn't
2a7c7605
VS
328 static bool CheckBuildOptions(const char *optionsSignature,
329 const char *componentName);
73deed44 330
094637f6
VZ
331 // implementation only from now on
332 // -------------------------------
333
334 // helpers for dynamic wxApp construction
335 static void SetInitializerFunction(wxAppInitializerFunction fn)
e2478fde 336 { ms_appInitFn = fn; }
094637f6 337 static wxAppInitializerFunction GetInitializerFunction()
e2478fde 338 { return ms_appInitFn; }
094637f6 339
a80e5f9e
VZ
340 // accessors for ms_appInstance field (external code might wish to modify
341 // it, this is why we provide a setter here as well, but you should really
342 // know what you're doing if you call it), wxTheApp is usually used instead
343 // of GetInstance()
344 static wxAppConsole *GetInstance() { return ms_appInstance; }
345 static void SetInstance(wxAppConsole *app) { ms_appInstance = app; }
346
72cdf4c9 347
e2478fde 348 // command line arguments (public for backwards compatibility)
541ea80f
VZ
349 int argc;
350
351 // this object is implicitly convertible to either "char**" (traditional
352 // type of argv parameter of main()) or to "wchar_t **" (for compatibility
353 // with Unicode build in previous wx versions and because the command line
354 // can, in pr
355#if wxUSE_UNICODE
356 wxCmdLineArgsArray argv;
357#else
358 char **argv;
359#endif
094637f6 360
094637f6 361protected:
e2478fde
VZ
362 // the function which creates the traits object when GetTraits() needs it
363 // for the first time
364 virtual wxAppTraits *CreateTraits();
365
094637f6 366 // function used for dynamic wxApp creation
e2478fde 367 static wxAppInitializerFunction ms_appInitFn;
094637f6 368
a80e5f9e
VZ
369 // the one and only global application object
370 static wxAppConsole *ms_appInstance;
371
b46b1d59
VZ
372 // create main loop from AppTraits or return NULL if
373 // there is no main loop implementation
2ddff00c 374 wxEventLoopBase *CreateMainLoop();
7cafd224 375
094637f6 376 // application info (must be set from the user code)
180b5b48
VZ
377 wxString m_vendorName, // vendor name ("acme")
378 m_vendorDisplayName, // vendor display name (e.g. "ACME Inc")
9cf3d218
VZ
379 m_appName, // app name ("myapp")
380 m_appDisplayName, // app display name ("My Application")
381 m_className; // class name
a69be60b 382
e2478fde
VZ
383 // the class defining the application behaviour, NULL initially and created
384 // by GetTraits() when first needed
385 wxAppTraits *m_traits;
386
b46b1d59
VZ
387 // the main event loop of the application (may be NULL if the loop hasn't
388 // been started yet or has already terminated)
2ddff00c 389 wxEventLoopBase *m_mainLoop;
e2478fde 390
e799e8d7 391 friend class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
d48b06bd 392
e2478fde
VZ
393 // the application object is a singleton anyhow, there is no sense in
394 // copying it
c0c133e1 395 wxDECLARE_NO_COPY_CLASS(wxAppConsoleBase);
e2478fde
VZ
396};
397
e0954e72
VZ
398#if defined(__UNIX__)
399 #include "wx/unix/app.h"
400#else
4c2a8d89
VZ
401 // this has to be a class and not a typedef as we forward declare it
402 class wxAppConsole : public wxAppConsoleBase { };
e0954e72
VZ
403#endif
404
e2478fde
VZ
405// ----------------------------------------------------------------------------
406// wxAppBase: the common part of wxApp implementations for all platforms
407// ----------------------------------------------------------------------------
408
1e6feb95 409#if wxUSE_GUI
e2478fde 410
bddd7a8d 411class WXDLLIMPEXP_CORE wxAppBase : public wxAppConsole
e2478fde
VZ
412{
413public:
414 wxAppBase();
415 virtual ~wxAppBase();
416
417 // the virtual functions which may/must be overridden in the derived class
418 // -----------------------------------------------------------------------
419
94826170
VZ
420 // very first initialization function
421 //
422 // Override: very rarely
05e2b077 423 virtual bool Initialize(int& argc, wxChar **argv);
94826170 424
e2478fde
VZ
425 // a platform-dependent version of OnInit(): the code here is likely to
426 // depend on the toolkit. default version does nothing.
427 //
428 // Override: rarely.
429 virtual bool OnInitGui();
430
431 // called to start program execution - the default version just enters
432 // the main GUI loop in which events are received and processed until
433 // the last window is not deleted (if GetExitOnFrameDelete) or
434 // ExitMainLoop() is called. In console mode programs, the execution
435 // of the program really starts here
436 //
437 // Override: rarely in GUI applications, always in console ones.
438 virtual int OnRun();
439
b913d3ed
VZ
440 // a matching function for OnInit()
441 virtual int OnExit();
442
94826170
VZ
443 // very last clean up function
444 //
445 // Override: very rarely
446 virtual void CleanUp();
e2478fde
VZ
447
448
449 // the worker functions - usually not used directly by the user code
450 // -----------------------------------------------------------------
451
d48b06bd
FM
452 // safer alternatives to Yield(), using wxWindowDisabler
453 virtual bool SafeYield(wxWindow *win, bool onlyIfNeeded);
454 virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess);
e2478fde
VZ
455
456 // this virtual function is called in the GUI mode when the application
457 // becomes idle and normally just sends wxIdleEvent to all interested
458 // parties
459 //
4629016d 460 // it should return true if more idle events are needed, false if not
1bf77ee5 461 virtual bool ProcessIdle();
e39af974 462
e39af974 463 // Send idle event to window and all subwindows
4629016d 464 // Returns true if more idle time is requested.
5109ae5d 465 virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
e2478fde 466
2dc62891 467
e2478fde
VZ
468 // top level window functions
469 // --------------------------
470
4629016d 471 // return true if our app has focus
e2478fde
VZ
472 virtual bool IsActive() const { return m_isActive; }
473
474 // set the "main" top level window
475 void SetTopWindow(wxWindow *win) { m_topWindow = win; }
476
477 // return the "main" top level window (if it hadn't been set previously
478 // with SetTopWindow(), will return just some top level window and, if
479 // there are none, will return NULL)
5ff14574 480 virtual wxWindow *GetTopWindow() const;
e2478fde
VZ
481
482 // control the exit behaviour: by default, the program will exit the
483 // main loop (and so, usually, terminate) when the last top-level
484 // program window is deleted. Beware that if you disable this behaviour
4629016d 485 // (with SetExitOnFrameDelete(false)), you'll have to call
e2478fde
VZ
486 // ExitMainLoop() explicitly from somewhere.
487 void SetExitOnFrameDelete(bool flag)
488 { m_exitOnFrameDelete = flag ? Yes : No; }
489 bool GetExitOnFrameDelete() const
490 { return m_exitOnFrameDelete == Yes; }
491
492
493 // display mode, visual, printing mode, ...
494 // ------------------------------------------------------------------------
495
496 // Get display mode that is used use. This is only used in framebuffer
b3c86150 497 // wxWin ports (such as wxMGL or wxDFB).
5ff14574 498 virtual wxVideoMode GetDisplayMode() const;
e2478fde 499 // Set display mode to use. This is only used in framebuffer wxWin
b3c86150 500 // ports (such as wxMGL or wxDFB). This method should be called from
e2478fde 501 // wxApp::OnInitGui
4629016d 502 virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
e2478fde
VZ
503
504 // set use of best visual flag (see below)
9cf3d218 505 void SetUseBestVisual( bool flag, bool forceTrueColour = false )
515a31bf 506 { m_useBestVisual = flag; m_forceTrueColour = forceTrueColour; }
e2478fde
VZ
507 bool GetUseBestVisual() const { return m_useBestVisual; }
508
509 // set/get printing mode: see wxPRINT_XXX constants.
510 //
511 // default behaviour is the normal one for Unix: always use PostScript
512 // printing.
513 virtual void SetPrintMode(int WXUNUSED(mode)) { }
514 int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
515
475a93b7
VZ
516 // Return the layout direction for the current locale or wxLayout_Default
517 // if it's unknown
518 virtual wxLayoutDirection GetLayoutDirection() const;
519
c50c6fb2
VZ
520 // Change the theme used by the application, return true on success.
521 virtual bool SetNativeTheme(const wxString& WXUNUSED(theme)) { return false; }
522
e2478fde 523
b913d3ed
VZ
524 // command line parsing (GUI-specific)
525 // ------------------------------------------------------------------------
526
8030d606 527#if wxUSE_CMDLINE_PARSER
b913d3ed
VZ
528 virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
529 virtual void OnInitCmdLine(wxCmdLineParser& parser);
8030d606 530#endif
b913d3ed 531
e2478fde
VZ
532 // miscellaneous other stuff
533 // ------------------------------------------------------------------------
534
535 // called by toolkit-specific code to set the app status: active (we have
536 // focus) or not and also the last window which had focus before we were
537 // deactivated
538 virtual void SetActive(bool isActive, wxWindow *lastFocus);
539
40ff126a 540#if WXWIN_COMPATIBILITY_2_6
dd435a79
VZ
541 // OBSOLETE: don't use, always returns true
542 //
543 // returns true if the program is successfully initialized
40ff126a
WS
544 wxDEPRECATED( bool Initialized() );
545#endif // WXWIN_COMPATIBILITY_2_6
dd435a79 546
e2478fde 547protected:
94826170
VZ
548 // delete all objects in wxPendingDelete list
549 void DeletePendingObjects();
550
e2478fde
VZ
551 // override base class method to use GUI traits
552 virtual wxAppTraits *CreateTraits();
553
554
555 // the main top level window (may be NULL)
1e6feb95
VZ
556 wxWindow *m_topWindow;
557
1cbee0b4
VZ
558 // if Yes, exit the main loop when the last top level window is deleted, if
559 // No don't do it and if Later -- only do it once we reach our OnRun()
560 //
561 // the explanation for using this strange scheme is given in appcmn.cpp
562 enum
563 {
564 Later = -1,
565 No,
566 Yes
567 } m_exitOnFrameDelete;
1e6feb95 568
90e572f1 569 // true if the app wants to use the best visual on systems where
8480b297
RR
570 // more than one are available (Sun, SGI, XFree86 4.0 ?)
571 bool m_useBestVisual;
515a31bf
RR
572 // force TrueColour just in case "best" isn't TrueColour
573 bool m_forceTrueColour;
094637f6 574
90e572f1 575 // does any of our windows have focus?
1e6feb95 576 bool m_isActive;
e2478fde 577
c0c133e1 578 wxDECLARE_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
5c33522f 634#define wxTheApp 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
38281826 644WXDLLIMPEXP_BASE void wxExit();
ee31c392 645
d48b06bd 646// avoid redeclaring this function here if it had been already declared by
a131b460
VZ
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
38281826 652WXDLLIMPEXP_CORE bool wxYield();
e90c1d2a 653
a131b460
VZ
654#endif // wx_YIELD_DECLARED
655
bf9e3e73 656// Yield to other apps/messages
38281826 657WXDLLIMPEXP_BASE void 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) \
5c33522f 711 appname& wxGetApp() { return *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_