+// ----------------------------------------------------------------------------
+// the common part of wxApp implementations for all platforms
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxAppBase : public wxEvtHandler
+{
+public:
+ wxAppBase();
+ virtual ~wxAppBase();
+
+ // the virtual functions which may/must be overridden in the derived class
+ // -----------------------------------------------------------------------
+
+ // called during the program initialization, returning FALSE from here
+ // prevents the program from continuing - it's a good place to create
+ // the top level program window and return TRUE.
+ //
+ // Override: always in GUI application, rarely in console ones.
+ virtual bool OnInit();
+
+#if wxUSE_GUI
+ // a platform-dependent version of OnInit(): the code here is likely to
+ // depend on the toolkit. default version does nothing.
+ //
+ // Override: rarely.
+ virtual bool OnInitGui();
+#endif // wxUSE_GUI
+
+ // called to start program execution - the default version just enters
+ // the main GUI loop in which events are received and processed until
+ // the last window is not deleted (if GetExitOnFrameDelete) or
+ // ExitMainLoop() is called. In console mode programs, the execution
+ // of the program really starts here
+ //
+ // Override: rarely in GUI applications, always in console ones.
+#if wxUSE_GUI
+ virtual int OnRun() { return MainLoop(); };
+#else // !GUI
+ virtual int OnRun() = 0;
+#endif // wxUSE_GUI
+
+ // called after the main loop termination. This is a good place for
+ // cleaning up (it may be too late in dtor) and is also useful if you
+ // want to return some non-default exit code - this is just the return
+ // value of this method.
+ //
+ // Override: often.
+ virtual int OnExit();
+
+ // called when a fatal exception occurs, this function should take care
+ // not to do anything which might provoke a nested exception! It may be
+ // overridden if you wish to react somehow in non-default way (core
+ // dump under Unix, application crash under Windows) to fatal program
+ // errors, however extreme care should be taken if you don't want this
+ // function to crash.
+ //
+ // Override: rarely.
+ virtual void OnFatalException() { }
+
+ // the worker functions - usually not used directly by the user code
+ // -----------------------------------------------------------------
+
+#if wxUSE_GUI
+ // execute the main GUI loop, the function returns when the loop ends
+ virtual int MainLoop() = 0;
+
+ // exit the main GUI loop during the next iteration (i.e. it does not
+ // stop the program immediately!)
+ virtual void ExitMainLoop() = 0;
+
+ // returns TRUE if the program is initialized
+ virtual bool Initialized() = 0;
+
+ // returns TRUE if there are unprocessed events in the event queue
+ virtual bool Pending() = 0;
+
+ // process the first event in the event queue (blocks until an event
+ // apperas if there are none currently)
+ virtual void Dispatch() = 0;
+
+ // process all currently pending events right now
+ //
+ // it is an error to call Yield() recursively unless the value of
+ // onlyIfNeeded is TRUE
+ //
+ // WARNING: this function is dangerous as it can lead to unexpected
+ // reentrancies (i.e. when called from an event handler it
+ // may result in calling the same event handler again), use
+ // with _extreme_ care or, better, don't use at all!
+ virtual bool Yield(bool onlyIfNeeded = FALSE) = 0;
+#endif // wxUSE_GUI
+
+ // application info: name, description, vendor
+ // -------------------------------------------
+
+ // NB: all these should be set by the application itself, there are no
+ // reasonable default except for the application name which is taken to
+ // be argv[0]
+
+ // set/get the application name
+ wxString GetAppName() const
+ {
+ if ( !m_appName )
+ return m_className;
+ else
+ return m_appName;
+ }
+ void SetAppName(const wxString& name) { m_appName = name; }
+
+ // set/get the app class name
+ wxString GetClassName() const { return m_className; }
+ void SetClassName(const wxString& name) { m_className = name; }
+
+ // set/get the vendor name
+ const wxString& GetVendorName() const { return m_vendorName; }
+ void SetVendorName(const wxString& name) { m_vendorName = name; }
+
+#if wxUSE_GUI
+ // top level window functions
+ // --------------------------
+
+ // return TRUE if our app has focus
+ virtual bool IsActive() const { return m_isActive; }
+
+ // set the "main" top level window
+ void SetTopWindow(wxWindow *win) { m_topWindow = win; }
+
+ // return the "main" top level window (if it hadn't been set previously
+ // with SetTopWindow(), will return just some top level window and, if
+ // there are none, will return NULL)
+ virtual wxWindow *GetTopWindow() const
+ {
+ if (m_topWindow)
+ return m_topWindow;
+ else if (wxTopLevelWindows.GetCount() > 0)
+ return wxTopLevelWindows.GetFirst()->GetData();
+ else
+ return (wxWindow *)NULL;
+ }
+
+ // control the exit behaviour: by default, the program will exit the
+ // main loop (and so, usually, terminate) when the last top-level
+ // program window is deleted. Beware that if you disabel this (with
+ // SetExitOnFrameDelete(FALSE)), you'll have to call ExitMainLoop()
+ // explicitly from somewhere.
+ void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag; }
+ bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
+
+#endif // wxUSE_GUI
+
+ // cmd line parsing stuff
+ // ----------------------
+
+ // all of these methods may be overridden in the derived class to
+ // customize the command line parsing (by default only a few standard
+ // options are handled)
+ //
+ // you also need to call wxApp::OnInit() from YourApp::OnInit() for all
+ // this to work
+
+#if wxUSE_CMDLINE_PARSER
+ // this one is called from OnInit() to add all supported options
+ // to the given parser
+ virtual void OnInitCmdLine(wxCmdLineParser& parser);
+
+ // called after successfully parsing the command line, return TRUE
+ // to continue and FALSE to exit
+ virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
+
+ // called if "--help" option was specified, return TRUE to continue
+ // and FALSE to exit
+ virtual bool OnCmdLineHelp(wxCmdLineParser& parser);
+
+ // called if incorrect command line options were given, return
+ // FALSE to abort and TRUE to continue
+ virtual bool OnCmdLineError(wxCmdLineParser& parser);
+#endif // wxUSE_CMDLINE_PARSER
+
+ // miscellaneous customization functions
+ // -------------------------------------
+
+#if wxUSE_LOG
+ // override this function to create default log target of arbitrary
+ // user-defined class (default implementation creates a wxLogGui
+ // object) - this log object is used by default by all wxLogXXX()
+ // functions.
+ virtual wxLog *CreateLogTarget()
+ #if wxUSE_GUI && wxUSE_LOGGUI && !defined(__WXMICROWIN__)
+ { return new wxLogGui; }
+ #else // !GUI
+ { return new wxLogStderr; }
+ #endif // wxUSE_GUI
+#endif // wxUSE_LOG
+
+#if wxUSE_GUI
+ // get the standard icon used by wxWin dialogs - this allows the user
+ // to customize the standard dialogs. The 'which' parameter is one of
+ // wxICON_XXX values
+ virtual wxIcon GetStdIcon(int which) const = 0;
+
+ // Get display mode that is used use. This is only used in framebuffer wxWin ports
+ // (such as wxMGL).
+ virtual wxDisplayModeInfo GetDisplayMode() const { return wxDisplayModeInfo(); }
+ // Set display mode to use. This is only used in framebuffer wxWin ports
+ // (such as wxMGL). This method should be called from wxApp:OnInitGui
+ virtual bool SetDisplayMode(const wxDisplayModeInfo& WXUNUSED(info)) { return TRUE; }
+
+ // set use of best visual flag (see below)
+ void SetUseBestVisual( bool flag ) { m_useBestVisual = flag; }
+ bool GetUseBestVisual() const { return m_useBestVisual; }
+
+ // set/get printing mode: see wxPRINT_XXX constants.
+ //
+ // default behaviour is the normal one for Unix: always use PostScript
+ // printing.
+ virtual void SetPrintMode(int WXUNUSED(mode)) { }
+ int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
projects / wxWidgets.git / blobdiff