set eol-style

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

diff --git a/include/wx/apptrait.h b/include/wx/apptrait.h
index 6ef915d9b1fd02ceab3bacaee6b25ec11abd7076..322b047c8eab49ebf57c0111715022baedbf6292 100644 (file)
--- a/include/wx/apptrait.h
+++ b/include/wx/apptrait.h
@@ -13,50 +13,46 @@
 #define _WX_APPTRAIT_H_
 
 #include "wx/string.h"
 #define _WX_APPTRAIT_H_
 
 #include "wx/string.h"

+#include "wx/platinfo.h"

 
 

-class WXDLLIMPEXP_BASE wxObject;
-class WXDLLEXPORT wxAppTraits;
+class WXDLLIMPEXP_FWD_BASE wxArrayString;
+class WXDLLIMPEXP_FWD_BASE wxConfigBase;
+class WXDLLIMPEXP_FWD_BASE wxEventLoopBase;

 #if wxUSE_FONTMAP
 #if wxUSE_FONTMAP

-    class WXDLLEXPORT wxFontMapper;
+    class WXDLLIMPEXP_FWD_CORE wxFontMapper;

 #endif // wxUSE_FONTMAP
 #endif // wxUSE_FONTMAP

-class WXDLLIMPEXP_BASE wxLog;
-class WXDLLIMPEXP_BASE wxMessageOutput;
-class WXDLLEXPORT wxRendererNative;
-class WXDLLIMPEXP_BASE wxString;
+class WXDLLIMPEXP_FWD_BASE wxLog;
+class WXDLLIMPEXP_FWD_BASE wxMessageOutput;
+class WXDLLIMPEXP_FWD_BASE wxObject;
+class WXDLLIMPEXP_FWD_CORE wxRendererNative;
+class WXDLLIMPEXP_FWD_BASE wxStandardPathsBase;
+class WXDLLIMPEXP_FWD_BASE wxString;
+class WXDLLIMPEXP_FWD_BASE wxTimer;
+class WXDLLIMPEXP_FWD_BASE wxTimerImpl;

 
 class GSocketGUIFunctionsTable;
 
 
 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
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxAppTraits: this class defines various configurable aspects of wxApp
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_BASE wxStandardPathsBase;
-

 class WXDLLIMPEXP_BASE wxAppTraitsBase
 {
 public:
 class WXDLLIMPEXP_BASE wxAppTraitsBase
 {
 public:

-    // hooks for creating the global objects, may be overridden by the user
+    // needed since this class declares virtual members
+    virtual ~wxAppTraitsBase() { }
+
+    // hooks for working with the global objects, may be overridden by the user

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

+#if wxUSE_CONFIG
+    // create the default configuration object (base class version is
+    // implemented in config.cpp and creates wxRegConfig for wxMSW and
+    // wxFileConfig for all the other platforms)
+    virtual wxConfigBase *CreateConfig();
+#endif // wxUSE_CONFIG
+

 #if wxUSE_LOG
     // create the default log target
     virtual wxLog *CreateLogTarget() = 0;
 #if wxUSE_LOG
     // create the default log target
     virtual wxLog *CreateLogTarget() = 0;


@@ -79,9 +75,14 @@ public:
 
     // wxStandardPaths object is normally the same for wxBase and wxGUI
     // except in the case of wxMac and wxCocoa
 
     // wxStandardPaths object is normally the same for wxBase and wxGUI
     // except in the case of wxMac and wxCocoa

-#ifndef __WXPALMOS__

     virtual wxStandardPathsBase& GetStandardPaths();
     virtual wxStandardPathsBase& GetStandardPaths();

-#endif
+
+#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
     // ------------------------------------------------------------------------
 
     // functions abstracting differences between GUI and console modes
     // ------------------------------------------------------------------------


@@ -124,26 +125,61 @@ public:
     virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable() = 0;
 #endif
 
     virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable() = 0;
 #endif
 

+    // create a new, port specific, instance of the event loop used by wxApp
+    virtual wxEventLoopBase *CreateEventLoop() = 0;
+
+#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

 };
 
 // ----------------------------------------------------------------------------
 // include the platform-specific version of the class
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // include the platform-specific version of the class
 // ----------------------------------------------------------------------------
 

-// NB: test for __UNIX__ before __WXMAC__ as under Darwin we want to use the
-//     Unix code (and otherwise __UNIX__ wouldn't be defined)
+// NB:  test for __UNIX__ before __WXMAC__ as under Darwin we want to use the
+//      Unix code (and otherwise __UNIX__ wouldn't be defined)
+// ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port

 #if defined(__WXPALMOS__)
     #include "wx/palmos/apptbase.h"
 #if defined(__WXPALMOS__)
     #include "wx/palmos/apptbase.h"

-#elif defined(__WXMSW__)
+#elif defined(__WIN32__)

     #include "wx/msw/apptbase.h"
 #elif defined(__UNIX__) && !defined(__EMX__)
     #include "wx/unix/apptbase.h"
     #include "wx/msw/apptbase.h"
 #elif defined(__UNIX__) && !defined(__EMX__)
     #include "wx/unix/apptbase.h"


@@ -169,6 +205,10 @@ public:
 class WXDLLIMPEXP_BASE wxConsoleAppTraitsBase : public wxAppTraits
 {
 public:
 class WXDLLIMPEXP_BASE wxConsoleAppTraitsBase : public wxAppTraits
 {
 public:

+#if !wxUSE_CONSOLE_EVENTLOOP
+    virtual wxEventLoopBase *CreateEventLoop() { return NULL; }
+#endif // !wxUSE_CONSOLE_EVENTLOOP
+

 #if wxUSE_LOG
     virtual wxLog *CreateLogTarget();
 #endif // wxUSE_LOG
 #if wxUSE_LOG
     virtual wxLog *CreateLogTarget();
 #endif // wxUSE_LOG


@@ -188,6 +228,20 @@ public:
 
     virtual void ScheduleForDestroy(wxObject *object);
     virtual void RemoveFromPendingDelete(wxObject *object);
 
     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; }

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -218,6 +272,17 @@ public:
 
     virtual void ScheduleForDestroy(wxObject *object);
     virtual void RemoveFromPendingDelete(wxObject *object);
 
     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
 };
 
 #endif // wxUSE_GUI


@@ -226,27 +291,27 @@ public:
 // include the platform-specific version of the classes above
 // ----------------------------------------------------------------------------
 
 // include the platform-specific version of the classes above
 // ----------------------------------------------------------------------------
 

+// ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port

 #if defined(__WXPALMOS__)
     #include "wx/palmos/apptrait.h"
 #if defined(__WXPALMOS__)
     #include "wx/palmos/apptrait.h"

-#elif defined(__WXMSW__)
+#elif defined(__WIN32__)

     #include "wx/msw/apptrait.h"
     #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"
     #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
 #else

-    // at least, we need an implementation of GetToolkitInfo !

     #if wxUSE_GUI
         class wxGUIAppTraits : public wxGUIAppTraitsBase
         {
     #if wxUSE_GUI
         class wxGUIAppTraits : public wxGUIAppTraitsBase
         {

-            virtual wxToolkitInfo& GetToolkitInfo();

         };
     #endif // wxUSE_GUI
     class wxConsoleAppTraits: public wxConsoleAppTraitsBase
     {
         };
     #endif // wxUSE_GUI
     class wxConsoleAppTraits: public wxConsoleAppTraitsBase
     {

-        virtual wxToolkitInfo& GetToolkitInfo();

     };
 #endif // platform
 
     };
 #endif // platform