]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/apptrait.h
remove warnings of intentionally unreachable code
[wxWidgets.git] / include / wx / apptrait.h
index ef7686fd46eb18a3e764b815c256f33c91fa87ad..ac132956f791ddab29e867e2abacef3e338654b7 100644 (file)
@@ -13,7 +13,9 @@
 #define _WX_APPTRAIT_H_
 
 #include "wx/string.h"
+#include "wx/platinfo.h"
 
+class WXDLLIMPEXP_BASE wxArrayString;
 class WXDLLIMPEXP_BASE wxObject;
 class WXDLLEXPORT wxAppTraits;
 #if wxUSE_FONTMAP
@@ -23,27 +25,11 @@ class WXDLLIMPEXP_BASE wxLog;
 class WXDLLIMPEXP_BASE wxMessageOutput;
 class WXDLLEXPORT wxRendererNative;
 class WXDLLIMPEXP_BASE wxString;
+class WXDLLIMPEXP_BASE wxTimer;
+class WXDLLIMPEXP_BASE wxTimerImpl;
 
 class GSocketGUIFunctionsTable;
 
-// ----------------------------------------------------------------------------
-// toolkit information
-// ----------------------------------------------------------------------------
-
-// Information about the toolkit that the app is running under (e.g. wxMSW):
-struct WXDLLIMPEXP_BASE wxToolkitInfo
-{
-    // Short name of the toolkit (e.g. "msw" or "mswuniv"); empty for console:
-    wxString shortName;
-    // Descriptive name of the toolkit, human readable (e.g. "wxMSW" or
-    // "wxMSW/Universal"); "wxBase" for console apps:
-    wxString name;
-    // Version of the underlying toolkit or of the OS for console apps:
-    int versionMajor, versionMinor;
-    // OS mnenomics, e.g. wxGTK or wxMSW:
-    int os;
-};
-
 
 // ----------------------------------------------------------------------------
 // wxAppTraits: this class defines various configurable aspects of wxApp
@@ -57,7 +43,7 @@ public:
     // needed since this class declares virtual members
     virtual ~wxAppTraitsBase() { }
 
-    // hooks for creating the global objects, may be overridden by the user
+    // hooks for working with the global objects, may be overridden by the user
     // ------------------------------------------------------------------------
 
 #if wxUSE_LOG
@@ -86,6 +72,13 @@ public:
     virtual wxStandardPathsBase& GetStandardPaths();
 #endif // wxUSE_STDPATHS
 
+#if wxUSE_INTL
+    // called during wxApp initialization to set the locale to correspond to
+    // the user default (i.e. system locale under Windows, LC_ALL under Unix)
+    virtual void SetLocale();
+#endif // wxUSE_INTL
+
+
     // functions abstracting differences between GUI and console modes
     // ------------------------------------------------------------------------
 
@@ -127,15 +120,46 @@ public:
     virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable() = 0;
 #endif
 
+#if wxUSE_TIMER
+    // return platform and toolkit dependent wxTimer implementation
+    virtual wxTimerImpl *CreateTimerImpl(wxTimer *timer) = 0;
+#endif
+
+    // functions returning port-specific information
+    // ------------------------------------------------------------------------
+
+    // return information about the (native) toolkit currently used and its
+    // runtime (not compile-time) version.
+    // returns wxPORT_BASE for console applications and one of the remaining
+    // wxPORT_* values for GUI applications.
+    virtual wxPortId GetToolkitVersion(int *majVer, int *minVer) const = 0;
+
+    // return true if the port is using wxUniversal for the GUI, false if not
+    virtual bool IsUsingUniversalWidgets() const = 0;
+
+    // return the name of the Desktop Environment such as
+    // "KDE" or "GNOME". May return an empty string.
+    virtual wxString GetDesktopEnvironment() const = 0;
+
+    // returns a short string to identify the block of the standard command
+    // line options parsed automatically by current port: if this string is
+    // empty, there are no such options, otherwise the function also fills
+    // passed arrays with the names and the descriptions of those options.
+    virtual wxString GetStandardCmdLineOptions(wxArrayString& names,
+                                               wxArrayString& desc) const
+    {
+        wxUnusedVar(names);
+        wxUnusedVar(desc);
+
+        return wxEmptyString;
+    }
+
 
-    // return information about what toolkit is running; we need for two things
-    // that are both contained in wxBase:
-    //  - wxGetOsVersion() behaves differently in GUI and non-GUI builds under
-    //    Unix: in the former case it returns the information about the toolkit
-    //    and in the latter -- about the OS, so we need to virtualize it
-    //  - wxDynamicLibrary::CanonicalizePluginName() must embed toolkit
-    //    signature in DLL name
-    virtual wxToolkitInfo& GetToolkitInfo() = 0;
+protected:
+#if wxUSE_STACKWALKER && defined( __WXDEBUG__ )
+    // utility function: returns the stack frame as a plain wxString
+    virtual wxString GetAssertStackTrace();
+#endif
 };
 
 // ----------------------------------------------------------------------------
@@ -192,6 +216,20 @@ public:
 
     virtual void ScheduleForDestroy(wxObject *object);
     virtual void RemoveFromPendingDelete(wxObject *object);
+
+    // the GetToolkitVersion for console application is always the same
+    virtual wxPortId GetToolkitVersion(int *verMaj, int *verMin) const
+    {
+        // no toolkits (wxBase is for console applications without GUI support)
+        // NB: zero means "no toolkit", -1 means "not initialized yet"
+        //     so we must use zero here!
+        if (verMaj) *verMaj = 0;
+        if (verMin) *verMin = 0;
+        return wxPORT_BASE;
+    }
+
+    virtual bool IsUsingUniversalWidgets() const { return false; }
+    virtual wxString GetDesktopEnvironment() const { return wxEmptyString; }
 };
 
 // ----------------------------------------------------------------------------
@@ -222,6 +260,17 @@ public:
 
     virtual void ScheduleForDestroy(wxObject *object);
     virtual void RemoveFromPendingDelete(wxObject *object);
+
+    virtual bool IsUsingUniversalWidgets() const
+    {
+    #ifdef __WXUNIVERSAL__
+        return true;
+    #else
+        return false;
+    #endif
+    }
+
+    virtual wxString GetDesktopEnvironment() const { return wxEmptyString; }
 };
 
 #endif // wxUSE_GUI
@@ -235,23 +284,22 @@ public:
     #include "wx/palmos/apptrait.h"
 #elif defined(__WIN32__)
     #include "wx/msw/apptrait.h"
-#elif defined(__UNIX__) && !defined(__EMX__)
+#elif defined(__OS2__)
+    #include "wx/os2/apptrait.h"
+#elif defined(__UNIX__)
     #include "wx/unix/apptrait.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/apptrait.h"
-#elif defined(__WXPM__)
-    #include "wx/os2/apptrait.h"
+#elif defined(__DOS__)
+    #include "wx/msdos/apptrait.h"
 #else
-    // at least, we need an implementation of GetToolkitInfo !
     #if wxUSE_GUI
         class wxGUIAppTraits : public wxGUIAppTraitsBase
         {
-            virtual wxToolkitInfo& GetToolkitInfo();
         };
     #endif // wxUSE_GUI
     class wxConsoleAppTraits: public wxConsoleAppTraitsBase
     {
-        virtual wxToolkitInfo& GetToolkitInfo();
     };
 #endif // platform