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