Small usability improvements

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

diff --git a/include/wx/app.h b/include/wx/app.h
index 02e57755fa14e550c2f3f5b9dffdc345e2cd0b57..5de475c2a80e1fcb678cfded6abe156c907d1186 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -18,24 +18,19 @@
 // ----------------------------------------------------------------------------
 
 #include "wx/event.h"       // for the base class
 // ----------------------------------------------------------------------------
 
 #include "wx/event.h"       // for the base class

-
-#if wxUSE_GUI
-    #include "wx/window.h"  // for wxTopLevelWindows
-
-    #include "wx/vidmode.h"
-#endif // wxUSE_GUI
-

 #include "wx/build.h"
 #include "wx/init.h"        // we must declare wxEntry()
 #include "wx/build.h"
 #include "wx/init.h"        // we must declare wxEntry()

+#include "wx/intl.h"        // for wxLayoutDirection

 
 

-class WXDLLIMPEXP_BASE wxAppConsole;
-class WXDLLIMPEXP_BASE wxAppTraits;
-class WXDLLIMPEXP_BASE wxCmdLineParser;
-class WXDLLIMPEXP_BASE wxLog;
-class WXDLLIMPEXP_BASE wxMessageOutput;
+class WXDLLIMPEXP_FWD_BASE wxAppConsole;
+class WXDLLIMPEXP_FWD_BASE wxAppTraits;
+class WXDLLIMPEXP_FWD_BASE wxCmdLineParser;
+class WXDLLIMPEXP_FWD_BASE wxEventLoopBase;
+class WXDLLIMPEXP_FWD_BASE wxLog;
+class WXDLLIMPEXP_FWD_BASE wxMessageOutput;

 
 #if wxUSE_GUI
 
 #if wxUSE_GUI

-    class WXDLLEXPORT wxEventLoop;
+    struct WXDLLIMPEXP_FWD_CORE wxVideoMode;

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


@@ -56,15 +51,15 @@ enum
 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------

-// wxAppConsole: wxApp for non-GUI applications
+// wxAppConsoleBase: wxApp for non-GUI applications

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_BASE wxAppConsole : public wxEvtHandler
+class WXDLLIMPEXP_BASE wxAppConsoleBase : public wxEvtHandler

 {
 public:
     // ctor and dtor
 {
 public:
     // ctor and dtor

-    wxAppConsole();
-    virtual ~wxAppConsole();
+    wxAppConsoleBase();
+    virtual ~wxAppConsoleBase();

 
 
     // the virtual functions which may/must be overridden in the derived class
 
 
     // the virtual functions which may/must be overridden in the derived class


@@ -91,7 +86,7 @@ public:
 
     // This is the replacement for the normal main(): all program work should
     // be done here. When OnRun() returns, the programs starts shutting down.
 
     // 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() = 0;
+    virtual int OnRun();

 
     // This is only called if OnInit() returned true so it's a good place to do
     // any cleanup matching the initializations done there.
 
     // This is only called if OnInit() returned true so it's a good place to do
     // any cleanup matching the initializations done there.


@@ -128,6 +123,17 @@ 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() : 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; }


@@ -175,26 +181,9 @@ 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çade
+    // allows us to abstract the differences behind the common fa�de

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

-    // the functions below shouldn't be used now that we have wxAppTraits
-#if WXWIN_COMPATIBILITY_2_4
-
-#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.
-    wxDEPRECATED( virtual wxLog *CreateLogTarget() );
-#endif // wxUSE_LOG
-
-        // similar to CreateLogTarget() but for the global wxMessageOutput
-        // object
-    wxDEPRECATED( virtual wxMessageOutput *CreateMessageOutput() );
-
-#endif // WXWIN_COMPATIBILITY_2_4
-

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


@@ -219,28 +208,64 @@ public:
                              wxEvent& event) const;
 
     // Called when an unhandled C++ exception occurs inside OnRun(): note that
                              wxEvent& event) const;
 
     // Called when an unhandled C++ exception occurs inside OnRun(): note that

-    // the exception type is lost by now, so if you really want to handle the
-    // exception you should override OnRun() and put a try/catch around
-    // MainLoop() call there or use OnExceptionInMainLoop()
-    virtual void OnUnhandledException() { }
+    // the main event loop has already terminated by now and the program will
+    // exit, if you need to really handle the exceptions you need to override
+    // OnExceptionInMainLoop()
+    virtual void OnUnhandledException();

 #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();
+

     // 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 ProcessPendingEvents();
 
     // 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 ProcessPendingEvents();
 

+    // check if there are pending events on global pending event list
+    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
     // 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 void WakeUpIdle();
+
+        // execute the main GUI loop, the function returns when the loop ends
+    virtual int MainLoop();
+
+        // exit the main GUI loop during the next iteration (i.e. it does not
+        // stop the program immediately!)
+    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();

 
 

-    // this is just a convenience: by providing its implementation here we
-    // avoid #ifdefs in the code using it
-    static bool IsMainLoopRunning() { return 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 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
     // -----------------


@@ -272,9 +297,6 @@ public:
     // options of the library and abort if it doesn't
     static bool CheckBuildOptions(const char *optionsSignature,
                                   const char *componentName);
     // options of the library and abort if it doesn't
     static bool CheckBuildOptions(const char *optionsSignature,
                                   const char *componentName);

-#if WXWIN_COMPATIBILITY_2_4
-    wxDEPRECATED( static bool CheckBuildOptions(const wxBuildOptions& buildOptions) );
-#endif

 
     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------


@@ -309,22 +331,36 @@ protected:
     // the one and only global application object
     static wxAppConsole *ms_appInstance;
 
     // the one and only global application object
     static wxAppConsole *ms_appInstance;
 

+    // create main loop from AppTraits or return NULL if
+    // there is no main loop implementation
+    wxEventLoopBase *CreateMainLoop();

 
     // application info (must be set from the user code)
 
     // 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 (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
     wxAppTraits *m_traits;
 
 
     // the class defining the application behaviour, NULL initially and created
     // by GetTraits() when first needed
     wxAppTraits *m_traits;
 

+    // the main event loop of the application (may be NULL if the loop hasn't
+    // been started yet or has already terminated)
+    wxEventLoopBase *m_mainLoop;

 
     // 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(wxAppConsole)
+    DECLARE_NO_COPY_CLASS(wxAppConsoleBase)

 };
 
 };
 

+#if defined(__UNIX__)
+    #include "wx/unix/app.h"
+#else
+    // this has to be a class and not a typedef as we forward declare it
+    class wxAppConsole : public wxAppConsoleBase { };
+#endif
+

 // ----------------------------------------------------------------------------
 // wxAppBase: the common part of wxApp implementations for all platforms
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxAppBase: the common part of wxApp implementations for all platforms
 // ----------------------------------------------------------------------------


@@ -372,32 +408,7 @@ public:
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 

-        // return true if we're running main loop, i.e. if the events can
-        // (already) be dispatched
-    static bool IsMainLoopRunning()
-    {
-        wxAppBase *app = wx_static_cast(wxAppBase *, GetInstance());
-        return app && app->m_mainLoop != NULL;
-    }
-
-        // execute the main GUI loop, the function returns when the loop ends
-    virtual int MainLoop();
-
-        // exit the main loop thus terminating the application
-    virtual void Exit();
-
-        // exit the main GUI loop during the next iteration (i.e. it does not
-        // stop the program immediately!)
-    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();

 
         // process all currently pending events right now
         //
 
         // process all currently pending events right now
         //


@@ -422,15 +433,6 @@ public:
     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 
 
     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 
 

-#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
-
-

     // top level window functions
     // --------------------------
 
     // top level window functions
     // --------------------------
 


@@ -443,15 +445,7 @@ public:
         // 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)
         // 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;
-    }
+    virtual wxWindow *GetTopWindow() const;

 
         // control the exit behaviour: by default, the program will exit the
         // main loop (and so, usually, terminate) when the last top-level
 
         // control the exit behaviour: by default, the program will exit the
         // main loop (and so, usually, terminate) when the last top-level


@@ -468,15 +462,16 @@ public:
     // ------------------------------------------------------------------------
 
         // Get display mode that is used use. This is only used in framebuffer
     // ------------------------------------------------------------------------
 
         // Get display mode that is used use. This is only used in framebuffer

-        // wxWin ports (such as wxMGL).
-    virtual wxVideoMode GetDisplayMode() const { return wxVideoMode(); }
+        // wxWin ports (such as wxMGL or wxDFB).
+    virtual wxVideoMode GetDisplayMode() const;

         // Set display mode to use. This is only used in framebuffer wxWin
         // Set display mode to use. This is only used in framebuffer wxWin

-        // ports (such as wxMGL). This method should be called from
+        // ports (such as wxMGL or wxDFB). This method should be called from

         // wxApp::OnInitGui
     virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
 
         // set use of best visual flag (see below)
         // wxApp::OnInitGui
     virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
 
         // set use of best visual flag (see below)

-    void SetUseBestVisual( bool flag ) { m_useBestVisual = flag; }
+    void SetUseBestVisual( bool flag, bool forceTrueColour = false )
+        { m_useBestVisual = flag; m_forceTrueColour = forceTrueColour; }

     bool GetUseBestVisual() const { return m_useBestVisual; }
 
         // set/get printing mode: see wxPRINT_XXX constants.
     bool GetUseBestVisual() const { return m_useBestVisual; }
 
         // set/get printing mode: see wxPRINT_XXX constants.


@@ -486,6 +481,10 @@ public:
     virtual void SetPrintMode(int WXUNUSED(mode)) { }
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
 
     virtual void SetPrintMode(int WXUNUSED(mode)) { }
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
 

+    // Return the layout direction for the current locale or wxLayout_Default
+    // if it's unknown
+    virtual wxLayoutDirection GetLayoutDirection() const;
+

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


@@ -503,14 +502,12 @@ public:
     // deactivated
     virtual void SetActive(bool isActive, wxWindow *lastFocus);
 
     // deactivated
     virtual void SetActive(bool isActive, wxWindow *lastFocus);
 

+#if WXWIN_COMPATIBILITY_2_6

     // OBSOLETE: don't use, always returns true
     //
     // returns true if the program is successfully initialized
     // OBSOLETE: don't use, always returns true
     //
     // returns true if the program is successfully initialized

-    bool Initialized() { return true; }
-
-    // perform standard OnIdle behaviour, ensure that this is always called
-    void OnIdle(wxIdleEvent& event);
-
+    wxDEPRECATED( bool Initialized() );
+#endif // WXWIN_COMPATIBILITY_2_6

 
 protected:
     // delete all objects in wxPendingDelete list
 
 protected:
     // delete all objects in wxPendingDelete list


@@ -520,10 +517,6 @@ protected:
     virtual wxAppTraits *CreateTraits();
 
 
     virtual wxAppTraits *CreateTraits();
 
 

-    // the main event loop of the application (may be NULL if the loop hasn't
-    // been started yet or has already terminated)
-    wxEventLoop *m_mainLoop;
-

     // the main top level window (may be NULL)
     wxWindow *m_topWindow;
 
     // the main top level window (may be NULL)
     wxWindow *m_topWindow;
 


@@ -541,6 +534,8 @@ protected:
     // true if the app wants to use the best visual on systems where
     // more than one are available (Sun, SGI, XFree86 4.0 ?)
     bool m_useBestVisual;
     // true if the app wants to use the best visual on systems where
     // more than one are available (Sun, SGI, XFree86 4.0 ?)
     bool m_useBestVisual;

+    // force TrueColour just in case "best" isn't TrueColour
+    bool m_forceTrueColour;

 
     // does any of our windows have focus?
     bool m_isActive;
 
     // does any of our windows have focus?
     bool m_isActive;


@@ -549,37 +544,44 @@ protected:
     DECLARE_NO_COPY_CLASS(wxAppBase)
 };
 
     DECLARE_NO_COPY_CLASS(wxAppBase)
 };
 

-#endif // wxUSE_GUI
+#if WXWIN_COMPATIBILITY_2_6
+    inline bool wxAppBase::Initialized() { return true; }
+#endif // WXWIN_COMPATIBILITY_2_6

 
 // ----------------------------------------------------------------------------
 // now include the declaration of the real class
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // now include the declaration of the real class
 // ----------------------------------------------------------------------------
 

-#if wxUSE_GUI
-    #if defined(__WXPALMOS__)
-        #include "wx/palmos/app.h"
-    #elif defined(__WXMSW__)
-        #include "wx/msw/app.h"
-    #elif defined(__WXMOTIF__)
-        #include "wx/motif/app.h"
-    #elif defined(__WXMGL__)
-        #include "wx/mgl/app.h"
-    #elif defined(__WXGTK20__)
-        #include "wx/gtk/app.h"
-    #elif defined(__WXGTK__)
-        #include "wx/gtk1/app.h"
-    #elif defined(__WXX11__)
-        #include "wx/x11/app.h"
-    #elif defined(__WXMAC__)
-        #include "wx/mac/app.h"
-    #elif defined(__WXCOCOA__)
-        #include "wx/cocoa/app.h"
-    #elif defined(__WXPM__)
-        #include "wx/os2/app.h"
-    #endif
+#if defined(__WXPALMOS__)
+    #include "wx/palmos/app.h"
+#elif defined(__WXMSW__)
+    #include "wx/msw/app.h"
+#elif defined(__WXMOTIF__)
+    #include "wx/motif/app.h"
+#elif defined(__WXMGL__)
+    #include "wx/mgl/app.h"
+#elif defined(__WXDFB__)
+    #include "wx/dfb/app.h"
+#elif defined(__WXGTK20__)
+    #include "wx/gtk/app.h"
+#elif defined(__WXGTK__)
+    #include "wx/gtk1/app.h"
+#elif defined(__WXX11__)
+    #include "wx/x11/app.h"
+#elif defined(__WXMAC__)
+    #include "wx/mac/app.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/app.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/app.h"
+#endif
+

 #else // !GUI
 #else // !GUI

-    // allow using just wxApp (instead of wxAppConsole) in console programs
-    typedef wxAppConsole wxApp;
+
+// wxApp is defined in core and we cannot define another one in wxBase,
+// so use the preprocessor to allow using wxApp in console programs too
+#define wxApp wxAppConsole
+

 #endif // GUI/!GUI
 
 // ----------------------------------------------------------------------------
 #endif // GUI/!GUI
 
 // ----------------------------------------------------------------------------


@@ -595,7 +597,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 ((wxApp *)wxApp::GetInstance())
+#define wxTheApp wx_static_cast(wxApp*, wxApp::GetInstance())

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


@@ -643,9 +645,12 @@ public:
 #ifdef __WXUNIVERSAL__
     #include "wx/univ/theme.h"
 
 #ifdef __WXUNIVERSAL__
     #include "wx/univ/theme.h"
 

-    #define IMPLEMENT_WX_THEME_SUPPORT \
-        WX_USE_THEME(win32); \
-        WX_USE_THEME(gtk);
+    #ifdef wxUNIV_DEFAULT_THEME
+        #define IMPLEMENT_WX_THEME_SUPPORT \
+            WX_USE_THEME(wxUNIV_DEFAULT_THEME);
+    #else
+        #define IMPLEMENT_WX_THEME_SUPPORT
+    #endif

 #else
     #define IMPLEMENT_WX_THEME_SUPPORT
 #endif
 #else
     #define IMPLEMENT_WX_THEME_SUPPORT
 #endif


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

-    appname& wxGetApp() { return *(appname *)wxTheApp; }
+    appname& wxGetApp() { return *wx_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


@@ -694,4 +699,3 @@ extern wxAppConsole *wxCreateApp();
 extern wxAppInitializer wxTheAppInitializer;
 
 #endif // _WX_APP_H_BASE_
 extern wxAppInitializer wxTheAppInitializer;
 
 #endif // _WX_APP_H_BASE_

-