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