1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxAppBase class and macros used for declaration of wxApp
4 // derived class in the user code
5 // Author: Julian Smart
9 // Copyright: (c) Julian Smart
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
13 #ifndef _WX_APP_H_BASE_
14 #define _WX_APP_H_BASE_
16 // ----------------------------------------------------------------------------
17 // headers we have to include here
18 // ----------------------------------------------------------------------------
20 #include "wx/event.h" // for the base class
23 #include "wx/window.h" // for wxTopLevelWindows
27 #include "wx/init.h" // we must declare wxEntry()
29 class WXDLLIMPEXP_BASE wxAppConsole
;
30 class WXDLLIMPEXP_BASE wxAppTraits
;
31 class WXDLLIMPEXP_BASE wxCmdLineParser
;
32 class WXDLLIMPEXP_BASE wxLog
;
33 class WXDLLIMPEXP_BASE wxMessageOutput
;
35 // ----------------------------------------------------------------------------
37 // ----------------------------------------------------------------------------
39 // the type of the function used to create a wxApp object on program start up
40 typedef wxAppConsole
* (*wxAppInitializerFunction
)();
42 // ----------------------------------------------------------------------------
44 // ----------------------------------------------------------------------------
49 wxPRINT_POSTSCRIPT
= 2
52 // ----------------------------------------------------------------------------
53 // support for framebuffer ports
54 // ----------------------------------------------------------------------------
57 // VS: Fullscreen/framebuffer application needs to choose display mode prior
58 // to wxWindows initialization. This class holds information about display
59 // mode. It is used by wxApp::Set/GetDisplayMode.
60 class WXDLLIMPEXP_CORE wxDisplayModeInfo
63 wxDisplayModeInfo() : m_ok(FALSE
) {}
64 wxDisplayModeInfo(unsigned width
, unsigned height
, unsigned depth
)
65 : m_width(width
), m_height(height
), m_depth(depth
), m_ok(TRUE
) {}
67 unsigned GetWidth() const { return m_width
; }
68 unsigned GetHeight() const { return m_height
; }
69 unsigned GetDepth() const { return m_depth
; }
70 bool IsOk() const { return m_ok
; }
73 unsigned m_width
, m_height
, m_depth
;
78 // ----------------------------------------------------------------------------
79 // wxAppConsole: wxApp for non-GUI applications
80 // ----------------------------------------------------------------------------
82 class WXDLLIMPEXP_BASE wxAppConsole
: public wxEvtHandler
87 virtual ~wxAppConsole();
90 // the virtual functions which may/must be overridden in the derived class
91 // -----------------------------------------------------------------------
93 // This is the very first function called for a newly created wxApp object,
94 // it is used by the library to do the global initialization. If, for some
95 // reason, you must override it (instead of just overriding OnInit(), as
96 // usual, for app-specific initializations), do not forget to call the base
98 virtual bool Initialize(int& argc
, wxChar
**argv
);
100 // This gives wxCocoa a chance to call OnInit() with a memory pool in place
101 virtual bool CallOnInit() { return OnInit(); }
103 // Called before OnRun(), this is a good place to do initialization -- if
104 // anything fails, return false from here to prevent the program from
105 // continuing. The command line is normally parsed here, call the base
106 // class OnInit() to do it.
107 virtual bool OnInit();
109 // this is here only temproary hopefully (FIXME)
110 virtual bool OnInitGui() { return true; }
112 // This is the replacement for the normal main(): all program work should
113 // be done here. When OnRun() returns, the programs starts shutting down.
114 virtual int OnRun() = 0;
116 // This is only called if OnInit() returned true so it's a good place to do
117 // any cleanup matching the initializations done there.
118 virtual int OnExit();
120 // This is the very last function called on wxApp object before it is
121 // destroyed. If you override it (instead of overriding OnExit() as usual)
122 // do not forget to call the base class version!
123 virtual void CleanUp();
125 // Called when a fatal exception occurs, this function should take care not
126 // to do anything which might provoke a nested exception! It may be
127 // overridden if you wish to react somehow in non-default way (core dump
128 // under Unix, application crash under Windows) to fatal program errors,
129 // however extreme care should be taken if you don't want this function to
131 virtual void OnFatalException() { }
133 // Called from wxExit() function, should terminate the application a.s.a.p.
137 // application info: name, description, vendor
138 // -------------------------------------------
140 // NB: all these should be set by the application itself, there are no
141 // reasonable default except for the application name which is taken to
144 // set/get the application name
145 wxString
GetAppName() const
147 return m_appName
.empty() ? m_className
: m_appName
;
149 void SetAppName(const wxString
& name
) { m_appName
= name
; }
151 // set/get the app class name
152 wxString
GetClassName() const { return m_className
; }
153 void SetClassName(const wxString
& name
) { m_className
= name
; }
155 // set/get the vendor name
156 const wxString
& GetVendorName() const { return m_vendorName
; }
157 void SetVendorName(const wxString
& name
) { m_vendorName
= name
; }
160 // cmd line parsing stuff
161 // ----------------------
163 // all of these methods may be overridden in the derived class to
164 // customize the command line parsing (by default only a few standard
165 // options are handled)
167 // you also need to call wxApp::OnInit() from YourApp::OnInit() for all
170 #if wxUSE_CMDLINE_PARSER
171 // this one is called from OnInit() to add all supported options
172 // to the given parser
173 virtual void OnInitCmdLine(wxCmdLineParser
& parser
);
175 // called after successfully parsing the command line, return TRUE
176 // to continue and FALSE to exit
177 virtual bool OnCmdLineParsed(wxCmdLineParser
& parser
);
179 // called if "--help" option was specified, return TRUE to continue
181 virtual bool OnCmdLineHelp(wxCmdLineParser
& parser
);
183 // called if incorrect command line options were given, return
184 // FALSE to abort and TRUE to continue
185 virtual bool OnCmdLineError(wxCmdLineParser
& parser
);
186 #endif // wxUSE_CMDLINE_PARSER
189 // miscellaneous customization functions
190 // -------------------------------------
192 // create the app traits object to which we delegate for everything which
193 // either should be configurable by the user (then he can change the
194 // default behaviour simply by overriding CreateTraits() and returning his
195 // own traits object) or which is GUI/console dependent as then wxAppTraits
196 // allows us to abstract the differences behind the common façade
197 wxAppTraits
*GetTraits();
199 // the functions below shouldn't be used now that we have wxAppTraits
200 #if WXWIN_COMPATIBILITY_2_4
203 // override this function to create default log target of arbitrary
204 // user-defined class (default implementation creates a wxLogGui
205 // object) -- this log object is used by default by all wxLogXXX()
207 virtual wxLog
*CreateLogTarget();
210 // similar to CreateLogTarget() but for the global wxMessageOutput
212 virtual wxMessageOutput
*CreateMessageOutput();
214 #endif // WXWIN_COMPATIBILITY_2_4
217 // event processing functions
218 // --------------------------
220 // this method allows to filter all the events processed by the program, so
221 // you should try to return quickly from it to avoid slowing down the
222 // program to the crawl
224 // return value should be -1 to continue with the normal event processing,
225 // or TRUE or FALSE to stop further processing and pretend that the event
226 // had been already processed or won't be processed at all, respectively
227 virtual int FilterEvent(wxEvent
& event
);
229 // process all events in the wxPendingEvents list -- it is necessary to
230 // call this function to process posted events. This happens during each
231 // event loop iteration in GUI mode but if there is no main loop, it may be
232 // also called directly.
233 virtual void ProcessPendingEvents();
235 // doesn't do anything in this class, just a hook for GUI wxApp
236 virtual bool Yield(bool WXUNUSED(onlyIfNeeded
) = false) { return true; }
238 // make sure that idle events are sent again
239 virtual void WakeUpIdle() { }
245 // this function is called when an assert failure occurs, the base class
246 // version does the normal processing (i.e. shows the usual assert failure
249 // the arguments are the place where the assert occured, the text of the
250 // assert itself and the user-specified message
252 virtual void OnAssert(const wxChar
*file
,
256 #endif // __WXDEBUG__
258 // check that the wxBuildOptions object (constructed in the application
259 // itself, usually the one from IMPLEMENT_APP() macro) matches the build
260 // options of the library and abort if it doesn't
261 static bool CheckBuildOptions(const wxBuildOptions
& buildOptions
);
264 // implementation only from now on
265 // -------------------------------
267 // helpers for dynamic wxApp construction
268 static void SetInitializerFunction(wxAppInitializerFunction fn
)
269 { ms_appInitFn
= fn
; }
270 static wxAppInitializerFunction
GetInitializerFunction()
271 { return ms_appInitFn
; }
274 // command line arguments (public for backwards compatibility)
278 // the one and only global application object (must be public for backwards
279 // compatibility as assigning to wxTheApp should work)
280 static wxAppConsole
*ms_appInstance
;
283 // the function which creates the traits object when GetTraits() needs it
284 // for the first time
285 virtual wxAppTraits
*CreateTraits();
288 // function used for dynamic wxApp creation
289 static wxAppInitializerFunction ms_appInitFn
;
292 // application info (must be set from the user code)
293 wxString m_vendorName
, // vendor name (ACME Inc)
294 m_appName
, // app name
295 m_className
; // class name
297 // the class defining the application behaviour, NULL initially and created
298 // by GetTraits() when first needed
299 wxAppTraits
*m_traits
;
302 // the application object is a singleton anyhow, there is no sense in
304 DECLARE_NO_COPY_CLASS(wxAppConsole
)
307 // ----------------------------------------------------------------------------
308 // wxAppBase: the common part of wxApp implementations for all platforms
309 // ----------------------------------------------------------------------------
313 class WXDLLIMPEXP_CORE wxAppBase
: public wxAppConsole
317 virtual ~wxAppBase();
319 // the virtual functions which may/must be overridden in the derived class
320 // -----------------------------------------------------------------------
322 // very first initialization function
324 // Override: very rarely
325 virtual bool Initialize(int& argc
, wxChar
**argv
);
327 // a platform-dependent version of OnInit(): the code here is likely to
328 // depend on the toolkit. default version does nothing.
331 virtual bool OnInitGui();
333 // called to start program execution - the default version just enters
334 // the main GUI loop in which events are received and processed until
335 // the last window is not deleted (if GetExitOnFrameDelete) or
336 // ExitMainLoop() is called. In console mode programs, the execution
337 // of the program really starts here
339 // Override: rarely in GUI applications, always in console ones.
342 // very last clean up function
344 // Override: very rarely
345 virtual void CleanUp();
348 // the worker functions - usually not used directly by the user code
349 // -----------------------------------------------------------------
351 // execute the main GUI loop, the function returns when the loop ends
352 virtual int MainLoop() = 0;
354 // exit the main loop thus terminating the application
357 // exit the main GUI loop during the next iteration (i.e. it does not
358 // stop the program immediately!)
359 virtual void ExitMainLoop() = 0;
361 // returns TRUE if the program is initialized
362 virtual bool Initialized() = 0;
364 // returns TRUE if there are unprocessed events in the event queue
365 virtual bool Pending() = 0;
367 // process the first event in the event queue (blocks until an event
368 // apperas if there are none currently)
369 virtual void Dispatch() = 0;
371 // process all currently pending events right now
373 // it is an error to call Yield() recursively unless the value of
374 // onlyIfNeeded is TRUE
376 // WARNING: this function is dangerous as it can lead to unexpected
377 // reentrancies (i.e. when called from an event handler it
378 // may result in calling the same event handler again), use
379 // with _extreme_ care or, better, don't use at all!
380 virtual bool Yield(bool onlyIfNeeded
= FALSE
) = 0;
382 // this virtual function is called in the GUI mode when the application
383 // becomes idle and normally just sends wxIdleEvent to all interested
386 // it should return TRUE if more idle events are needed, FALSE if not
387 virtual bool ProcessIdle() ;
389 // Send idle event to window and all subwindows
390 // Returns TRUE if more idle time is requested.
391 virtual bool SendIdleEvents(wxWindow
* win
, wxIdleEvent
& event
);
393 // Perform standard OnIdle behaviour: call from port's OnIdle
394 void OnIdle(wxIdleEvent
& event
);
397 // top level window functions
398 // --------------------------
400 // return TRUE if our app has focus
401 virtual bool IsActive() const { return m_isActive
; }
403 // set the "main" top level window
404 void SetTopWindow(wxWindow
*win
) { m_topWindow
= win
; }
406 // return the "main" top level window (if it hadn't been set previously
407 // with SetTopWindow(), will return just some top level window and, if
408 // there are none, will return NULL)
409 virtual wxWindow
*GetTopWindow() const
413 else if (wxTopLevelWindows
.GetCount() > 0)
414 return wxTopLevelWindows
.GetFirst()->GetData();
416 return (wxWindow
*)NULL
;
419 // control the exit behaviour: by default, the program will exit the
420 // main loop (and so, usually, terminate) when the last top-level
421 // program window is deleted. Beware that if you disable this behaviour
422 // (with SetExitOnFrameDelete(FALSE)), you'll have to call
423 // ExitMainLoop() explicitly from somewhere.
424 void SetExitOnFrameDelete(bool flag
)
425 { m_exitOnFrameDelete
= flag
? Yes
: No
; }
426 bool GetExitOnFrameDelete() const
427 { return m_exitOnFrameDelete
== Yes
; }
430 // display mode, visual, printing mode, ...
431 // ------------------------------------------------------------------------
433 // Get display mode that is used use. This is only used in framebuffer
434 // wxWin ports (such as wxMGL).
435 virtual wxDisplayModeInfo
GetDisplayMode() const { return wxDisplayModeInfo(); }
436 // Set display mode to use. This is only used in framebuffer wxWin
437 // ports (such as wxMGL). This method should be called from
439 virtual bool SetDisplayMode(const wxDisplayModeInfo
& WXUNUSED(info
)) { return TRUE
; }
441 // set use of best visual flag (see below)
442 void SetUseBestVisual( bool flag
) { m_useBestVisual
= flag
; }
443 bool GetUseBestVisual() const { return m_useBestVisual
; }
445 // set/get printing mode: see wxPRINT_XXX constants.
447 // default behaviour is the normal one for Unix: always use PostScript
449 virtual void SetPrintMode(int WXUNUSED(mode
)) { }
450 int GetPrintMode() const { return wxPRINT_POSTSCRIPT
; }
453 // miscellaneous other stuff
454 // ------------------------------------------------------------------------
456 // called by toolkit-specific code to set the app status: active (we have
457 // focus) or not and also the last window which had focus before we were
459 virtual void SetActive(bool isActive
, wxWindow
*lastFocus
);
463 // delete all objects in wxPendingDelete list
464 void DeletePendingObjects();
466 // override base class method to use GUI traits
467 virtual wxAppTraits
*CreateTraits();
470 // the main top level window (may be NULL)
471 wxWindow
*m_topWindow
;
473 // if Yes, exit the main loop when the last top level window is deleted, if
474 // No don't do it and if Later -- only do it once we reach our OnRun()
476 // the explanation for using this strange scheme is given in appcmn.cpp
482 } m_exitOnFrameDelete
;
484 // TRUE if the apps whats to use the best visual on systems where
485 // more than one are available (Sun, SGI, XFree86 4.0 ?)
486 bool m_useBestVisual
;
488 // does any of our windows has focus?
492 DECLARE_NO_COPY_CLASS(wxAppBase
)
497 // ----------------------------------------------------------------------------
498 // now include the declaration of the real class
499 // ----------------------------------------------------------------------------
502 #if defined(__WXMSW__)
503 #include "wx/msw/app.h"
504 #elif defined(__WXMOTIF__)
505 #include "wx/motif/app.h"
506 #elif defined(__WXMGL__)
507 #include "wx/mgl/app.h"
508 #elif defined(__WXGTK__)
509 #include "wx/gtk/app.h"
510 #elif defined(__WXX11__)
511 #include "wx/x11/app.h"
512 #elif defined(__WXMAC__)
513 #include "wx/mac/app.h"
514 #elif defined(__WXCOCOA__)
515 #include "wx/cocoa/app.h"
516 #elif defined(__WXPM__)
517 #include "wx/os2/app.h"
520 // allow using just wxApp (instead of wxAppConsole) in console programs
521 typedef wxAppConsole wxApp
;
524 // ----------------------------------------------------------------------------
526 // ----------------------------------------------------------------------------
528 // for compatibility, we define this macro to access the global application
529 // object of type wxApp
531 // note that instead of using of wxTheApp in application code you should
532 // consider using DECLARE_APP() after which you may call wxGetApp() which will
533 // return the object of the correct type (i.e. MyApp and not wxApp)
535 // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
536 // console mode it does nothing at all
537 #define wxTheApp ((wxApp *)wxApp::ms_appInstance)
539 // ----------------------------------------------------------------------------
541 // ----------------------------------------------------------------------------
543 // event loop related functions only work in GUI programs
544 // ------------------------------------------------------
546 // Force an exit from main loop
547 extern void WXDLLIMPEXP_BASE
wxExit();
549 // Yield to other apps/messages
550 extern bool WXDLLIMPEXP_BASE
wxYield();
552 // Yield to other apps/messages
553 extern void WXDLLIMPEXP_BASE
wxWakeUpIdle();
555 // ----------------------------------------------------------------------------
556 // macros for dynamic creation of the application object
557 // ----------------------------------------------------------------------------
559 // Having a global instance of this class allows wxApp to be aware of the app
560 // creator function. wxApp can then call this function to create a new app
561 // object. Convoluted, but necessary.
563 class WXDLLIMPEXP_BASE wxAppInitializer
566 wxAppInitializer(wxAppInitializerFunction fn
)
567 { wxApp::SetInitializerFunction(fn
); }
570 // Here's a macro you can use if your compiler really, really wants main() to
571 // be in your main program (e.g. hello.cpp). Now IMPLEMENT_APP should add this
574 #if !wxUSE_GUI || !defined(__WXMSW__)
575 #define IMPLEMENT_WXWIN_MAIN \
576 int main(int argc, char **argv) { return wxEntry(argc, argv); }
577 #elif defined(__WXMSW__) && defined(WXUSINGDLL)
578 // we need HINSTANCE declaration to define WinMain()
580 #include "wx/msw/winundef.h"
582 #define IMPLEMENT_WXWIN_MAIN \
583 extern int wxEntry(HINSTANCE hInstance, \
584 HINSTANCE hPrevInstance = NULL, \
585 char *pCmdLine = NULL, \
586 int nCmdShow = SW_NORMAL); \
587 extern "C" int WINAPI WinMain(HINSTANCE hInstance, \
588 HINSTANCE hPrevInstance, \
592 return wxEntry(hInstance, hPrevInstance, lpCmdLine, nCmdShow); \
595 #define IMPLEMENT_WXWIN_MAIN
598 #ifdef __WXUNIVERSAL__
599 #include "wx/univ/theme.h"
601 #define IMPLEMENT_WX_THEME_SUPPORT \
602 WX_USE_THEME(win32); \
605 #define IMPLEMENT_WX_THEME_SUPPORT
608 // Use this macro if you want to define your own main() or WinMain() function
609 // and call wxEntry() from there.
610 #define IMPLEMENT_APP_NO_MAIN(appname) \
611 wxAppConsole *wxCreateApp() \
613 wxAppConsole::CheckBuildOptions(wxBuildOptions()); \
614 return new appname; \
617 wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
618 appname& wxGetApp() { return *(appname *)wxTheApp; }
620 // Same as IMPLEMENT_APP() normally but doesn't include themes support in
621 // wxUniversal builds
622 #define IMPLEMENT_APP_NO_THEMES(appname) \
623 IMPLEMENT_APP_NO_MAIN(appname) \
626 // Use this macro exactly once, the argument is the name of the wxApp-derived
627 // class which is the class of your application.
628 #define IMPLEMENT_APP(appname) \
629 IMPLEMENT_APP_NO_THEMES(appname) \
630 IMPLEMENT_WX_THEME_SUPPORT
632 // this macro can be used multiple times and just allows you to use wxGetApp()
634 #define DECLARE_APP(appname) extern appname& wxGetApp();
636 #endif // _WX_APP_H_BASE_