no changes, just update the copyright in the header

[wxWidgets.git] / include / wx / app.h

diff --git a/include/wx/app.h b/include/wx/app.h
index 03bbad845a41e9b29702aa733784fa3afb48abfb..2aa047d3a9784874079df472dfebd15485fbac59 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -19,6 +19,7 @@
 
 #include "wx/event.h"       // for the base class
 #include "wx/build.h"
 
 #include "wx/event.h"       // for the base class
 #include "wx/build.h"

+#include "wx/cmdargs.h"     // for wxCmdLineArgsArray used by wxApp::argv

 #include "wx/init.h"        // we must declare wxEntry()
 #include "wx/intl.h"        // for wxLayoutDirection
 
 #include "wx/init.h"        // we must declare wxEntry()
 #include "wx/intl.h"        // for wxLayoutDirection
 


@@ -31,6 +32,7 @@ class WXDLLIMPEXP_FWD_BASE wxMessageOutput;
 
 #if wxUSE_GUI
     struct WXDLLIMPEXP_FWD_CORE wxVideoMode;
 
 #if wxUSE_GUI
     struct WXDLLIMPEXP_FWD_CORE wxVideoMode;

+    class WXDLLIMPEXP_FWD_CORE wxWindow;

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -81,9 +83,6 @@ public:
     // class OnInit() to do it.
     virtual bool OnInit();
 
     // class OnInit() to do it.
     virtual bool OnInit();
 

-    // this is here only temporary hopefully (FIXME)
-    virtual bool OnInitGui() { return true; }
-

     // This is the replacement for the normal main(): all program work should
     // be done here. When OnRun() returns, the programs starts shutting down.
     virtual int OnRun();
     // This is the replacement for the normal main(): all program work should
     // be done here. When OnRun() returns, the programs starts shutting down.
     virtual int OnRun();


@@ -123,6 +122,19 @@ public:
     }
     void SetAppName(const wxString& name) { m_appName = name; }
 
     }
     void SetAppName(const wxString& name) { m_appName = name; }
 

+        // set/get the application display name: the display name is the name
+        // shown to the user in titles, reports, etc while the app name is
+        // used for paths, config, and other places the user doesn't see
+        //
+        // so the app name could be myapp while display name could be "My App"
+    wxString GetAppDisplayName() const
+    {
+        return m_appDisplayName.empty() ? GetAppName().Capitalize()
+                                        : m_appDisplayName;
+    }
+
+    void SetAppDisplayName(const wxString& name) { m_appDisplayName = name; }
+

         // set/get the app class name
     wxString GetClassName() const { return m_className; }
     void SetClassName(const wxString& name) { m_className = name; }
         // set/get the app class name
     wxString GetClassName() const { return m_className; }
     void SetClassName(const wxString& name) { m_className = name; }


@@ -131,6 +143,19 @@ public:
     const wxString& GetVendorName() const { return m_vendorName; }
     void SetVendorName(const wxString& name) { m_vendorName = name; }
 
     const wxString& GetVendorName() const { return m_vendorName; }
     void SetVendorName(const wxString& name) { m_vendorName = name; }
 

+        // set/get the vendor display name:  the display name is shown
+        // in titles/reports/dialogs to the user, while the vendor name
+        // is used in some areas such as wxConfig, wxStandardPaths, etc
+    const wxString& GetVendorDisplayName() const
+    {
+        return m_vendorDisplayName.empty() ? GetVendorName()
+                                           : m_vendorDisplayName;
+    }
+    void SetVendorDisplayName(const wxString& name)
+    {
+        m_vendorDisplayName = name;
+    }
+

 
     // cmd line parsing stuff
     // ----------------------
 
     // cmd line parsing stuff
     // ----------------------


@@ -170,9 +195,16 @@ public:
     // either should be configurable by the user (then he can change the
     // default behaviour simply by overriding CreateTraits() and returning his
     // own traits object) or which is GUI/console dependent as then wxAppTraits
     // either should be configurable by the user (then he can change the
     // default behaviour simply by overriding CreateTraits() and returning his
     // own traits object) or which is GUI/console dependent as then wxAppTraits

-    // allows us to abstract the differences behind the common fa�de
+    // allows us to abstract the differences behind the common facade

     wxAppTraits *GetTraits();
 
     wxAppTraits *GetTraits();
 

+    // this function provides safer access to traits object than
+    // wxTheApp->GetTraits() during startup or termination when the global
+    // application object itself may be unavailable
+    //
+    // of course, it still returns NULL in this case and the caller must check
+    // for it
+    static wxAppTraits *GetTraitsIfExists();

 
     // event processing functions
     // --------------------------
 
     // event processing functions
     // --------------------------


@@ -186,7 +218,21 @@ public:
     // had been already processed or won't be processed at all, respectively
     virtual int FilterEvent(wxEvent& event);
 
     // had been already processed or won't be processed at all, respectively
     virtual int FilterEvent(wxEvent& event);
 

+    // return true if we're running event loop, i.e. if the events can
+    // (already) be dispatched
+    static bool IsMainLoopRunning();
+

 #if wxUSE_EXCEPTIONS
 #if wxUSE_EXCEPTIONS

+    // execute the functor to handle the given event
+    //
+    // this is a generalization of HandleEvent() below and the base class
+    // implementation of CallEventHandler() still calls HandleEvent() for
+    // compatibility for functors which are just wxEventFunctions (i.e. methods
+    // of wxEvtHandler)
+    virtual void CallEventHandler(wxEvtHandler *handler,
+                                  wxEventFunctor& functor,
+                                  wxEvent& event) const;
+

     // call the specified handler on the given object with the given event
     //
     // this method only exists to allow catching the exceptions thrown by any
     // call the specified handler on the given object with the given event
     //
     // this method only exists to allow catching the exceptions thrown by any


@@ -201,60 +247,35 @@ public:
     // exit, if you need to really handle the exceptions you need to override
     // OnExceptionInMainLoop()
     virtual void OnUnhandledException();
     // exit, if you need to really handle the exceptions you need to override
     // OnExceptionInMainLoop()
     virtual void OnUnhandledException();

+
+    // Function called if an uncaught exception is caught inside the main
+    // event loop: it may return true to continue running the event loop or
+    // false to stop it (in the latter case it may rethrow the exception as
+    // well)
+    virtual bool OnExceptionInMainLoop();
+

 #endif // wxUSE_EXCEPTIONS
 
 #endif // wxUSE_EXCEPTIONS
 

-    // event processing functions
-    // --------------------------

 
 

-    // return true if we're running event loop, i.e. if the events can
-    // (already) be dispatched
-    static bool IsMainLoopRunning();
+    // wxEventLoop redirections
+    // ------------------------

 
 

-    // process all events in the wxPendingEvents list -- it is necessary to
-    // call this function to process posted events. This happens during each
-    // event loop iteration in GUI mode but if there is no main loop, it may be
-    // also called directly.
+    virtual void SuspendProcessingOfPendingEvents();
+    virtual void ResumeProcessingOfPendingEvents();

     virtual void ProcessPendingEvents();
     virtual void ProcessPendingEvents();

-
-    // check if there are pending events on global pending event list

     bool HasPendingEvents() const;
 
     bool HasPendingEvents() const;
 

-    // doesn't do anything in this class, just a hook for GUI wxApp
-    virtual bool Yield(bool WXUNUSED(onlyIfNeeded) = false) { return true; }
-
-    // make sure that idle events are sent again
-    virtual void WakeUpIdle();
+    virtual bool Pending();
+    virtual bool Dispatch();

 
 

-        // execute the main GUI loop, the function returns when the loop ends

     virtual int MainLoop();
     virtual int MainLoop();

-
-        // exit the main GUI loop during the next iteration (i.e. it does not
-        // stop the program immediately!)

     virtual void ExitMainLoop();
 
     virtual void ExitMainLoop();
 

-        // returns true if there are unprocessed events in the event queue
-    virtual bool Pending();
-
-        // process the first event in the event queue (blocks until an event
-        // appears if there are none currently, use Pending() if this is not
-        // wanted), returns false if the event loop should stop and true
-        // otherwise
-    virtual bool Dispatch();
+    bool Yield(bool onlyIfNeeded = false);

 
 

-        // this virtual function is called  when the application
-        // becomes idle and normally just sends wxIdleEvent to all interested
-        // parties
-        //
-        // it should return true if more idle events are needed, false if not
+    virtual void WakeUpIdle();

     virtual bool ProcessIdle();
 
     virtual bool ProcessIdle();
 

-#if wxUSE_EXCEPTIONS
-    // Function called if an uncaught exception is caught inside the main
-    // event loop: it may return true to continue running the event loop or
-    // false to stop it (in the latter case it may rethrow the exception as
-    // well)
-    virtual bool OnExceptionInMainLoop();
-#endif // wxUSE_EXCEPTIONS

 
     // debugging support
     // -----------------
 
     // debugging support
     // -----------------


@@ -305,15 +326,23 @@ public:
 
 
     // command line arguments (public for backwards compatibility)
 
 
     // command line arguments (public for backwards compatibility)

-    int      argc;
-    wxChar **argv;
+    int argc;
+
+    // this object is implicitly convertible to either "char**" (traditional
+    // type of argv parameter of main()) or to "wchar_t **" (for compatibility
+    // with Unicode build in previous wx versions and because the command line
+    // can, in pr
+#if wxUSE_UNICODE
+    wxCmdLineArgsArray argv;
+#else
+    char **argv;
+#endif

 
 protected:
     // the function which creates the traits object when GetTraits() needs it
     // for the first time
     virtual wxAppTraits *CreateTraits();
 
 
 protected:
     // the function which creates the traits object when GetTraits() needs it
     // for the first time
     virtual wxAppTraits *CreateTraits();
 

-

     // function used for dynamic wxApp creation
     static wxAppInitializerFunction ms_appInitFn;
 
     // function used for dynamic wxApp creation
     static wxAppInitializerFunction ms_appInitFn;
 


@@ -325,9 +354,11 @@ protected:
     wxEventLoopBase *CreateMainLoop();
 
     // application info (must be set from the user code)
     wxEventLoopBase *CreateMainLoop();
 
     // application info (must be set from the user code)

-    wxString m_vendorName,      // vendor name (ACME Inc)
-             m_appName,         // app name
-             m_className;       // class name
+    wxString m_vendorName,        // vendor name ("acme")
+             m_vendorDisplayName, // vendor display name (e.g. "ACME Inc")
+             m_appName,           // app name ("myapp")
+             m_appDisplayName,    // app display name ("My Application")
+             m_className;         // class name

 
     // the class defining the application behaviour, NULL initially and created
     // by GetTraits() when first needed
 
     // the class defining the application behaviour, NULL initially and created
     // by GetTraits() when first needed


@@ -337,9 +368,11 @@ protected:
     // been started yet or has already terminated)
     wxEventLoopBase *m_mainLoop;
 
     // been started yet or has already terminated)
     wxEventLoopBase *m_mainLoop;
 

+    friend class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
+

     // the application object is a singleton anyhow, there is no sense in
     // copying it
     // the application object is a singleton anyhow, there is no sense in
     // copying it

-    DECLARE_NO_COPY_CLASS(wxAppConsoleBase)
+    wxDECLARE_NO_COPY_CLASS(wxAppConsoleBase);

 };
 
 #if defined(__UNIX__)
 };
 
 #if defined(__UNIX__)


@@ -396,18 +429,9 @@ public:
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 

-
-
-        // 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;
+        // safer alternatives to Yield(), using wxWindowDisabler
+    virtual bool SafeYield(wxWindow *win, bool onlyIfNeeded);
+    virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess);

 
         // this virtual function is called in the GUI mode when the application
         // becomes idle and normally just sends wxIdleEvent to all interested
 
         // this virtual function is called in the GUI mode when the application
         // becomes idle and normally just sends wxIdleEvent to all interested


@@ -458,7 +482,7 @@ public:
     virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
 
         // set use of best visual flag (see below)
     virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
 
         // set use of best visual flag (see below)

-    void SetUseBestVisual( bool flag, bool forceTrueColour = false ) 
+    void SetUseBestVisual( bool flag, bool forceTrueColour = false )

         { m_useBestVisual = flag; m_forceTrueColour = forceTrueColour; }
     bool GetUseBestVisual() const { return m_useBestVisual; }
 
         { m_useBestVisual = flag; m_forceTrueColour = forceTrueColour; }
     bool GetUseBestVisual() const { return m_useBestVisual; }
 


@@ -473,6 +497,9 @@ public:
     // if it's unknown
     virtual wxLayoutDirection GetLayoutDirection() const;
 
     // if it's unknown
     virtual wxLayoutDirection GetLayoutDirection() const;
 

+    // Change the theme used by the application, return true on success.
+    virtual bool SetNativeTheme(const wxString& WXUNUSED(theme)) { return false; }
+

 
     // command line parsing (GUI-specific)
     // ------------------------------------------------------------------------
 
     // command line parsing (GUI-specific)
     // ------------------------------------------------------------------------


@@ -528,8 +555,7 @@ protected:
     // does any of our windows have focus?
     bool m_isActive;
 
     // does any of our windows have focus?
     bool m_isActive;
 

-
-    DECLARE_NO_COPY_CLASS(wxAppBase)
+    wxDECLARE_NO_COPY_CLASS(wxAppBase);

 };
 
 #if WXWIN_COMPATIBILITY_2_6
 };
 
 #if WXWIN_COMPATIBILITY_2_6


@@ -557,7 +583,7 @@ protected:
 #elif defined(__WXX11__)
     #include "wx/x11/app.h"
 #elif defined(__WXMAC__)
 #elif defined(__WXX11__)
     #include "wx/x11/app.h"
 #elif defined(__WXMAC__)

-    #include "wx/mac/app.h"
+    #include "wx/osx/app.h"

 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/app.h"
 #elif defined(__WXPM__)
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/app.h"
 #elif defined(__WXPM__)


@@ -585,7 +611,7 @@ protected:
 //
 // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
 // console mode it does nothing at all
 //
 // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
 // console mode it does nothing at all

-#define wxTheApp wx_static_cast(wxApp*, wxApp::GetInstance())
+#define wxTheApp static_cast<wxApp*>(wxApp::GetInstance())

 
 // ----------------------------------------------------------------------------
 // global functions
 
 // ----------------------------------------------------------------------------
 // global functions


@@ -595,13 +621,20 @@ protected:
 // ------------------------------------------------------
 
 // Force an exit from main loop
 // ------------------------------------------------------
 
 // Force an exit from main loop

-extern void WXDLLIMPEXP_BASE wxExit();
+WXDLLIMPEXP_BASE void wxExit();
+
+// avoid redeclaring this function here if it had been already declared by
+// wx/utils.h, this results in warnings from g++ with -Wredundant-decls
+#ifndef wx_YIELD_DECLARED
+#define wx_YIELD_DECLARED

 
 // Yield to other apps/messages
 
 // Yield to other apps/messages

-extern bool WXDLLIMPEXP_BASE wxYield();
+WXDLLIMPEXP_CORE bool wxYield();
+
+#endif // wx_YIELD_DECLARED

 
 // Yield to other apps/messages
 
 // Yield to other apps/messages

-extern void WXDLLIMPEXP_BASE wxWakeUpIdle();
+WXDLLIMPEXP_BASE void wxWakeUpIdle();

 
 // ----------------------------------------------------------------------------
 // macros for dynamic creation of the application object
 
 // ----------------------------------------------------------------------------
 // macros for dynamic creation of the application object


@@ -655,7 +688,7 @@ public:
     wxAppInitializer                                                        \
         wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp);        \
     DECLARE_APP(appname)                                                    \
     wxAppInitializer                                                        \
         wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp);        \
     DECLARE_APP(appname)                                                    \

-    appname& wxGetApp() { return *wx_static_cast(appname*, wxApp::GetInstance()); }
+    appname& wxGetApp() { return *static_cast<appname*>(wxApp::GetInstance()); }

 
 // Same as IMPLEMENT_APP() normally but doesn't include themes support in
 // wxUniversal builds
 
 // Same as IMPLEMENT_APP() normally but doesn't include themes support in
 // wxUniversal builds