]> git.saurik.com Git - wxWidgets.git/blob - include/wx/app.h
Lots of work to set PangoFontDescription as the
[wxWidgets.git] / include / wx / app.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/app.h
3 // Purpose: wxAppBase class and macros used for declaration of wxApp
4 // derived class in the user code
5 // Author: Julian Smart
6 // Modified by:
7 // Created: 01/02/97
8 // RCS-ID: $Id$
9 // Copyright: (c) Julian Smart and Markus Holzem
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
12
13 #ifndef _WX_APP_H_BASE_
14 #define _WX_APP_H_BASE_
15
16 #ifdef __GNUG__
17 #pragma interface "appbase.h"
18 #endif
19
20 // ----------------------------------------------------------------------------
21 // typedefs
22 // ----------------------------------------------------------------------------
23
24 #if (defined(__WXMSW__) && !defined(__WXMICROWIN__)) || defined (__WXPM__)
25 class WXDLLEXPORT wxApp;
26 typedef wxApp* (*wxAppInitializerFunction)();
27 #else
28 // returning wxApp* won't work with gcc
29 #include "wx/object.h"
30
31 typedef wxObject* (*wxAppInitializerFunction)();
32 #endif
33
34 class WXDLLEXPORT wxCmdLineParser;
35
36 // ----------------------------------------------------------------------------
37 // headers we have to include here
38 // ----------------------------------------------------------------------------
39
40 #include "wx/event.h" // for the base class
41
42 #if wxUSE_GUI
43 #include "wx/window.h" // for wxTopLevelWindows
44 #endif // wxUSE_GUI
45
46 #if wxUSE_LOG
47 #include "wx/log.h"
48 #endif
49
50 #if WXWIN_COMPATIBILITY_2_2
51 #include "wx/icon.h"
52 #endif
53
54 #include "wx/build.h"
55
56 // ----------------------------------------------------------------------------
57 // constants
58 // ----------------------------------------------------------------------------
59
60 static const int wxPRINT_WINDOWS = 1;
61 static const int wxPRINT_POSTSCRIPT = 2;
62
63 // ----------------------------------------------------------------------------
64 // support for framebuffer ports
65 // ----------------------------------------------------------------------------
66
67 #if wxUSE_GUI
68 // VS: Fullscreen/framebuffer application needs to choose display mode prior
69 // to wxWindows initialization. This class holds information about display
70 // mode. It is used by wxApp::Set/GetDisplayMode.
71 class WXDLLEXPORT wxDisplayModeInfo
72 {
73 public:
74 wxDisplayModeInfo() : m_ok(FALSE) {}
75 wxDisplayModeInfo(unsigned width, unsigned height, unsigned depth)
76 : m_width(width), m_height(height), m_depth(depth), m_ok(TRUE) {}
77
78 unsigned GetWidth() const { return m_width; }
79 unsigned GetHeight() const { return m_height; }
80 unsigned GetDepth() const { return m_depth; }
81 bool IsOk() const { return m_ok; }
82
83 private:
84 unsigned m_width, m_height, m_depth;
85 bool m_ok;
86 };
87 #endif
88
89 // ----------------------------------------------------------------------------
90 // the common part of wxApp implementations for all platforms
91 // ----------------------------------------------------------------------------
92
93 class WXDLLEXPORT wxAppBase : public wxEvtHandler
94 {
95 DECLARE_NO_COPY_CLASS(wxAppBase)
96
97 public:
98 wxAppBase();
99 virtual ~wxAppBase();
100
101 // the virtual functions which may/must be overridden in the derived class
102 // -----------------------------------------------------------------------
103
104 // called during the program initialization, returning FALSE from here
105 // prevents the program from continuing - it's a good place to create
106 // the top level program window and return TRUE.
107 //
108 // Override: always in GUI application, rarely in console ones.
109 virtual bool OnInit();
110
111 // initializes wxMessageOutput; other responsibilities
112 // may be added later
113 virtual void DoInit();
114
115 #if wxUSE_GUI
116 // a platform-dependent version of OnInit(): the code here is likely to
117 // depend on the toolkit. default version does nothing.
118 //
119 // Override: rarely.
120 virtual bool OnInitGui();
121 #endif // wxUSE_GUI
122
123 // called to start program execution - the default version just enters
124 // the main GUI loop in which events are received and processed until
125 // the last window is not deleted (if GetExitOnFrameDelete) or
126 // ExitMainLoop() is called. In console mode programs, the execution
127 // of the program really starts here
128 //
129 // Override: rarely in GUI applications, always in console ones.
130 #if wxUSE_GUI
131 virtual int OnRun() { return MainLoop(); };
132 #else // !GUI
133 virtual int OnRun() = 0;
134 #endif // wxUSE_GUI
135
136 // called after the main loop termination. This is a good place for
137 // cleaning up (it may be too late in dtor) and is also useful if you
138 // want to return some non-default exit code - this is just the return
139 // value of this method.
140 //
141 // Override: often.
142 virtual int OnExit();
143
144 // called when a fatal exception occurs, this function should take care
145 // not to do anything which might provoke a nested exception! It may be
146 // overridden if you wish to react somehow in non-default way (core
147 // dump under Unix, application crash under Windows) to fatal program
148 // errors, however extreme care should be taken if you don't want this
149 // function to crash.
150 //
151 // Override: rarely.
152 virtual void OnFatalException() { }
153
154 virtual bool ProcessIdle() = 0;
155
156 // the worker functions - usually not used directly by the user code
157 // -----------------------------------------------------------------
158
159 #if wxUSE_GUI
160 // execute the main GUI loop, the function returns when the loop ends
161 virtual int MainLoop() = 0;
162
163 // exit the main GUI loop during the next iteration (i.e. it does not
164 // stop the program immediately!)
165 virtual void ExitMainLoop() = 0;
166
167 // returns TRUE if the program is initialized
168 virtual bool Initialized() = 0;
169
170 // returns TRUE if there are unprocessed events in the event queue
171 virtual bool Pending() = 0;
172
173 // process the first event in the event queue (blocks until an event
174 // apperas if there are none currently)
175 virtual void Dispatch() = 0;
176
177 // process all currently pending events right now
178 //
179 // it is an error to call Yield() recursively unless the value of
180 // onlyIfNeeded is TRUE
181 //
182 // WARNING: this function is dangerous as it can lead to unexpected
183 // reentrancies (i.e. when called from an event handler it
184 // may result in calling the same event handler again), use
185 // with _extreme_ care or, better, don't use at all!
186 virtual bool Yield(bool onlyIfNeeded = FALSE) = 0;
187 #endif // wxUSE_GUI
188
189 // application info: name, description, vendor
190 // -------------------------------------------
191
192 // NB: all these should be set by the application itself, there are no
193 // reasonable default except for the application name which is taken to
194 // be argv[0]
195
196 // set/get the application name
197 wxString GetAppName() const
198 {
199 if ( !m_appName )
200 return m_className;
201 else
202 return m_appName;
203 }
204 void SetAppName(const wxString& name) { m_appName = name; }
205
206 // set/get the app class name
207 wxString GetClassName() const { return m_className; }
208 void SetClassName(const wxString& name) { m_className = name; }
209
210 // set/get the vendor name
211 const wxString& GetVendorName() const { return m_vendorName; }
212 void SetVendorName(const wxString& name) { m_vendorName = name; }
213
214 #if wxUSE_GUI
215 // top level window functions
216 // --------------------------
217
218 // return TRUE if our app has focus
219 virtual bool IsActive() const { return m_isActive; }
220
221 // set the "main" top level window
222 void SetTopWindow(wxWindow *win) { m_topWindow = win; }
223
224 // return the "main" top level window (if it hadn't been set previously
225 // with SetTopWindow(), will return just some top level window and, if
226 // there are none, will return NULL)
227 virtual wxWindow *GetTopWindow() const
228 {
229 if (m_topWindow)
230 return m_topWindow;
231 else if (wxTopLevelWindows.GetCount() > 0)
232 return wxTopLevelWindows.GetFirst()->GetData();
233 else
234 return (wxWindow *)NULL;
235 }
236
237 // control the exit behaviour: by default, the program will exit the
238 // main loop (and so, usually, terminate) when the last top-level
239 // program window is deleted. Beware that if you disabel this (with
240 // SetExitOnFrameDelete(FALSE)), you'll have to call ExitMainLoop()
241 // explicitly from somewhere.
242 void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag; }
243 bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
244
245 #endif // wxUSE_GUI
246
247 // cmd line parsing stuff
248 // ----------------------
249
250 // all of these methods may be overridden in the derived class to
251 // customize the command line parsing (by default only a few standard
252 // options are handled)
253 //
254 // you also need to call wxApp::OnInit() from YourApp::OnInit() for all
255 // this to work
256
257 #if wxUSE_CMDLINE_PARSER
258 // this one is called from OnInit() to add all supported options
259 // to the given parser
260 virtual void OnInitCmdLine(wxCmdLineParser& parser);
261
262 // called after successfully parsing the command line, return TRUE
263 // to continue and FALSE to exit
264 virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
265
266 // called if "--help" option was specified, return TRUE to continue
267 // and FALSE to exit
268 virtual bool OnCmdLineHelp(wxCmdLineParser& parser);
269
270 // called if incorrect command line options were given, return
271 // FALSE to abort and TRUE to continue
272 virtual bool OnCmdLineError(wxCmdLineParser& parser);
273 #endif // wxUSE_CMDLINE_PARSER
274
275 // miscellaneous customization functions
276 // -------------------------------------
277
278 #if wxUSE_LOG
279 // override this function to create default log target of arbitrary
280 // user-defined class (default implementation creates a wxLogGui
281 // object) - this log object is used by default by all wxLogXXX()
282 // functions.
283 virtual wxLog *CreateLogTarget()
284 #if wxUSE_GUI && wxUSE_LOGGUI && !defined(__WXMICROWIN__)
285 { return new wxLogGui; }
286 #else // !GUI
287 { return new wxLogStderr; }
288 #endif // wxUSE_GUI
289 #endif // wxUSE_LOG
290
291 #if wxUSE_GUI
292
293 #if WXWIN_COMPATIBILITY_2_2
294 // get the standard icon used by wxWin dialogs - this allows the user
295 // to customize the standard dialogs. The 'which' parameter is one of
296 // wxICON_XXX values
297 virtual wxIcon GetStdIcon(int WXUNUSED(which)) const { return wxNullIcon; }
298 #endif
299
300 // Get display mode that is used use. This is only used in framebuffer wxWin ports
301 // (such as wxMGL).
302 virtual wxDisplayModeInfo GetDisplayMode() const { return wxDisplayModeInfo(); }
303 // Set display mode to use. This is only used in framebuffer wxWin ports
304 // (such as wxMGL). This method should be called from wxApp:OnInitGui
305 virtual bool SetDisplayMode(const wxDisplayModeInfo& WXUNUSED(info)) { return TRUE; }
306
307 // set use of best visual flag (see below)
308 void SetUseBestVisual( bool flag ) { m_useBestVisual = flag; }
309 bool GetUseBestVisual() const { return m_useBestVisual; }
310
311 // set/get printing mode: see wxPRINT_XXX constants.
312 //
313 // default behaviour is the normal one for Unix: always use PostScript
314 // printing.
315 virtual void SetPrintMode(int WXUNUSED(mode)) { }
316 int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
317
318 // called by toolkit-specific code to set the app status: active (we have
319 // focus) or not and also the last window which had focus before we were
320 // deactivated
321 virtual void SetActive(bool isActive, wxWindow *lastFocus);
322 #endif // wxUSE_GUI
323
324 // this method allows to filter all the events processed by the program, so
325 // you should try to return quickly from it to avoid slowing down the
326 // program to the crawl
327 //
328 // return value should be -1 to continue with the normal event processing,
329 // or TRUE or FALSE to stop further processing and pretend that the event
330 // had been already processed or won't be processed at all, respectively
331 virtual int FilterEvent(wxEvent& event);
332
333 // debugging support
334 // -----------------
335
336 // this function is called when an assert failure occurs, the base class
337 // version does the normal processing (i.e. shows the usual assert failure
338 // dialog box)
339 //
340 // the arguments are the place where the assert occured, the text of the
341 // assert itself and the user-specified message
342 #ifdef __WXDEBUG__
343 virtual void OnAssert(const wxChar *file,
344 int line,
345 const wxChar *cond,
346 const wxChar *msg);
347 #endif // __WXDEBUG__
348
349 // check that the wxBuildOptions object (constructed in the application
350 // itself, usually the one from IMPLEMENT_APP() macro) matches the build
351 // options of the library and abort if it doesn't
352 static bool CheckBuildOptions(const wxBuildOptions& buildOptions);
353
354 // deprecated functions, please updae your code to not use them!
355 // -------------------------------------------------------------
356
357 #if WXWIN_COMPATIBILITY_2_2
358 // used by obsolete wxDebugMsg only
359 void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; }
360 bool GetWantDebugOutput() const { return m_wantDebugOutput; }
361
362 // TRUE if the application wants to get debug output
363 bool m_wantDebugOutput;
364 #endif // WXWIN_COMPATIBILITY_2_2
365
366 // implementation only from now on
367 // -------------------------------
368
369 // helpers for dynamic wxApp construction
370 static void SetInitializerFunction(wxAppInitializerFunction fn)
371 { m_appInitFn = fn; }
372 static wxAppInitializerFunction GetInitializerFunction()
373 { return m_appInitFn; }
374
375 // process all events in the wxPendingEvents list
376 virtual void ProcessPendingEvents();
377
378 // access to the command line arguments
379 int argc;
380 wxChar **argv;
381
382 protected:
383 // function used for dynamic wxApp creation
384 static wxAppInitializerFunction m_appInitFn;
385
386 // application info (must be set from the user code)
387 wxString m_vendorName, // vendor name (ACME Inc)
388 m_appName, // app name
389 m_className; // class name
390
391 #if wxUSE_GUI
392 // the main top level window - may be NULL
393 wxWindow *m_topWindow;
394
395 // if TRUE, exit the main loop when the last top level window is deleted
396 bool m_exitOnFrameDelete;
397
398 // TRUE if the apps whats to use the best visual on systems where
399 // more than one are available (Sun, SGI, XFree86 4.0 ?)
400 bool m_useBestVisual;
401
402 // does any of our windows has focus?
403 bool m_isActive;
404 #endif // wxUSE_GUI
405 };
406
407 // ----------------------------------------------------------------------------
408 // now include the declaration of the real class
409 // ----------------------------------------------------------------------------
410
411 #if wxUSE_GUI
412 #if defined(__WXMSW__)
413 #include "wx/msw/app.h"
414 #elif defined(__WXMOTIF__)
415 #include "wx/motif/app.h"
416 #elif defined(__WXMGL__)
417 #include "wx/mgl/app.h"
418 #elif defined(__WXGTK__)
419 #include "wx/gtk/app.h"
420 #elif defined(__WXX11__)
421 #include "wx/x11/app.h"
422 #elif defined(__WXMAC__)
423 #include "wx/mac/app.h"
424 #elif defined(__WXPM__)
425 #include "wx/os2/app.h"
426 #elif defined(__WXSTUBS__)
427 #include "wx/stubs/app.h"
428 #endif
429 #else // !GUI
430 // can't use typedef because wxApp forward declared as a class
431 class WXDLLEXPORT wxApp : public wxAppBase
432 {
433 };
434 #endif // GUI/!GUI
435
436 // ----------------------------------------------------------------------------
437 // the global data
438 // ----------------------------------------------------------------------------
439
440 // the one and only application object - use of wxTheApp in application code
441 // is discouraged, consider using DECLARE_APP() after which you may call
442 // wxGetApp() which will return the object of the correct type (i.e. MyApp and
443 // not wxApp)
444 WXDLLEXPORT_DATA(extern wxApp*) wxTheApp;
445
446 // ----------------------------------------------------------------------------
447 // global functions
448 // ----------------------------------------------------------------------------
449
450 // event loop related functions only work in GUI programs
451 // ------------------------------------------------------
452
453 // Force an exit from main loop
454 extern void WXDLLEXPORT wxExit();
455
456 // Yield to other apps/messages
457 extern bool WXDLLEXPORT wxYield();
458
459 // Yield to other apps/messages
460 extern void WXDLLEXPORT wxWakeUpIdle();
461
462 // Post a message to the given eventhandler which will be processed during the
463 // next event loop iteration
464 inline void wxPostEvent(wxEvtHandler *dest, wxEvent& event)
465 {
466 wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
467
468 #if wxUSE_GUI
469 dest->AddPendingEvent(event);
470 #else
471 dest->ProcessEvent(event);
472 #endif // wxUSE_GUI
473 }
474
475 // console applications may avoid using DECLARE_APP and IMPLEMENT_APP macros
476 // and call these functions instead at the program startup and termination
477 // -------------------------------------------------------------------------
478
479 #if !wxUSE_GUI
480
481 // initialize the library (may be called as many times as needed, but each
482 // call to wxInitialize() must be matched by wxUninitialize())
483 extern bool WXDLLEXPORT wxInitialize();
484
485 // clean up - the library can't be used any more after the last call to
486 // wxUninitialize()
487 extern void WXDLLEXPORT wxUninitialize();
488
489 // create an object of this class on stack to initialize/cleanup thel ibrary
490 // automatically
491 class WXDLLEXPORT wxInitializer
492 {
493 public:
494 // initialize the library
495 wxInitializer() { m_ok = wxInitialize(); }
496
497 // has the initialization been successful? (explicit test)
498 bool IsOk() const { return m_ok; }
499
500 // has the initialization been successful? (implicit test)
501 operator bool() const { return m_ok; }
502
503 // dtor only does clean up if we initialized the library properly
504 ~wxInitializer() { if ( m_ok ) wxUninitialize(); }
505
506 private:
507 bool m_ok;
508 };
509
510 #endif // !wxUSE_GUI
511
512 // ----------------------------------------------------------------------------
513 // macros for dynamic creation of the application object
514 // ----------------------------------------------------------------------------
515
516 // Having a global instance of this class allows wxApp to be aware of the app
517 // creator function. wxApp can then call this function to create a new app
518 // object. Convoluted, but necessary.
519
520 class WXDLLEXPORT wxAppInitializer
521 {
522 public:
523 wxAppInitializer(wxAppInitializerFunction fn)
524 { wxApp::SetInitializerFunction(fn); }
525 };
526
527 // Here's a macro you can use if your compiler really, really wants main() to
528 // be in your main program (e.g. hello.cpp). Now IMPLEMENT_APP should add this
529 // code if required.
530
531 #if !wxUSE_GUI || defined(__WXMOTIF__) || defined(__WXGTK__) || defined(__WXPM__) || defined(__WXMGL__)
532 #define IMPLEMENT_WXWIN_MAIN \
533 extern int wxEntry( int argc, char *argv[] ); \
534 int main(int argc, char *argv[]) { return wxEntry(argc, argv); }
535 #elif defined(__WXMAC__) && defined(__UNIX__)
536 // wxMac seems to have a specific wxEntry prototype
537 #define IMPLEMENT_WXWIN_MAIN \
538 extern int wxEntry( int argc, char *argv[], bool enterLoop = 1 ); \
539 int main(int argc, char *argv[]) { return wxEntry(argc, argv); }
540 #elif defined(__WXMSW__) && defined(WXUSINGDLL)
541 // NT defines APIENTRY, 3.x not
542 #if !defined(WXAPIENTRY)
543 #define WXAPIENTRY WXFAR wxSTDCALL
544 #endif
545
546 #include <windows.h>
547 #include "wx/msw/winundef.h"
548
549 #define IMPLEMENT_WXWIN_MAIN \
550 extern "C" int WXAPIENTRY WinMain(HINSTANCE hInstance,\
551 HINSTANCE hPrevInstance,\
552 LPSTR m_lpCmdLine, int nCmdShow)\
553 {\
554 return wxEntry((WXHINSTANCE) hInstance,\
555 (WXHINSTANCE) hPrevInstance,\
556 m_lpCmdLine, nCmdShow);\
557 }
558 #else
559 #define IMPLEMENT_WXWIN_MAIN
560 #endif
561
562 #ifdef __WXUNIVERSAL__
563 #include "wx/univ/theme.h"
564
565 #define IMPLEMENT_WX_THEME_SUPPORT \
566 WX_USE_THEME(win32); \
567 WX_USE_THEME(gtk);
568 #else
569 #define IMPLEMENT_WX_THEME_SUPPORT
570 #endif
571
572 // Use this macro if you want to define your own main() or WinMain() function
573 // and call wxEntry() from there.
574 #define IMPLEMENT_APP_NO_MAIN(appname) \
575 wxApp *wxCreateApp() \
576 { \
577 wxApp::CheckBuildOptions(wxBuildOptions()); \
578 return new appname; \
579 } \
580 wxAppInitializer wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
581 appname& wxGetApp() { return *(appname *)wxTheApp; }
582
583 // Same as IMPLEMENT_APP() normally but doesn't include themes support in
584 // wxUniversal builds
585 #define IMPLEMENT_APP_NO_THEMES(appname) \
586 IMPLEMENT_APP_NO_MAIN(appname) \
587 IMPLEMENT_WXWIN_MAIN
588
589 // Use this macro exactly once, the argument is the name of the wxApp-derived
590 // class which is the class of your application.
591 #define IMPLEMENT_APP(appname) \
592 IMPLEMENT_APP_NO_THEMES(appname) \
593 IMPLEMENT_WX_THEME_SUPPORT
594
595 // this macro can be used multiple times and just allows you to use wxGetApp()
596 // function
597 #define DECLARE_APP(appname) extern appname& wxGetApp();
598
599 #endif
600 // _WX_APP_H_BASE_