Give GTK specific (but public) methods a Gtk prefix

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

diff --git a/include/wx/apptrait.h b/include/wx/apptrait.h
index e251e6e3ea73c5018f575fa363445f86877f7fd0..cbc3867147e08fa328421dd8f7400b07cacf1e29 100644 (file)
--- a/include/wx/apptrait.h
+++ b/include/wx/apptrait.h
@@ -5,20 +5,33 @@
 // Modified by:
 // Created:     19.06.2003
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     19.06.2003
 // RCS-ID:      $Id$

-// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
+// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_APPTRAIT_H_
 #define _WX_APPTRAIT_H_
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_APPTRAIT_H_
 #define _WX_APPTRAIT_H_
 

-class WXDLLEXPORT wxObject;
-class WXDLLEXPORT wxAppTraits;
+#include "wx/string.h"
+#include "wx/platinfo.h"
+
+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 WXDLLEXPORT wxLog;
-class WXDLLEXPORT wxMessageOutput;
+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 wxSocketManager;
+

 
 // ----------------------------------------------------------------------------
 // wxAppTraits: this class defines various configurable aspects of wxApp
 
 // ----------------------------------------------------------------------------
 // wxAppTraits: this class defines various configurable aspects of wxApp


@@ -27,9 +40,19 @@ class WXDLLEXPORT wxMessageOutput;
 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;


@@ -43,6 +66,23 @@ public:
     virtual wxFontMapper *CreateFontMapper() = 0;
 #endif // wxUSE_FONTMAP
 
     virtual wxFontMapper *CreateFontMapper() = 0;
 #endif // wxUSE_FONTMAP
 

+    // get the renderer to use for drawing the generic controls (return value
+    // may be NULL in which case the default renderer for the current platform
+    // is used); this is used in GUI only and always returns NULL in console
+    //
+    // NB: returned pointer will be deleted by the caller
+    virtual wxRendererNative *CreateRenderer() = 0;
+
+    // wxStandardPaths object is normally the same for wxBase and wxGUI
+    // except in the case of wxMac and wxCocoa
+    virtual wxStandardPathsBase& GetStandardPaths();
+
+#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
     // ------------------------------------------------------------------------


@@ -75,26 +115,93 @@ public:
     // wxBase
     virtual void RemoveFromPendingDelete(wxObject *object) = 0;
 
     // wxBase
     virtual void RemoveFromPendingDelete(wxObject *object) = 0;
 

+#if wxUSE_SOCKETS
+    // this function is used by wxNet library to set the default socket manager
+    // to use: doing it like this allows us to keep all socket-related code in
+    // wxNet instead of having to pull it in wxBase itself as we'd have to do
+    // if we really implemented wxSocketManager here
+    //
+    // we don't take ownership of this pointer, it should have a lifetime
+    // greater than that of any socket (e.g. be a pointer to a static object)
+    static void SetDefaultSocketManager(wxSocketManager *manager)
+    {
+        ms_manager = manager;
+    }
+
+    // return socket manager: this is usually different for console and GUI
+    // applications (although some ports use the same implementation for both)
+    virtual wxSocketManager *GetSocketManager() { return ms_manager; }
+#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
+
+#if wxUSE_THREADS
+    virtual void MutexGuiEnter();
+    virtual void MutexGuiLeave();
+#endif

 
 

-    // other miscellaneous helpers
-    // ---------------------------
+    // 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 = NULL, int *minVer = NULL) 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;
+    }

 
 

-    // 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
-    virtual int GetOSVersion(int *verMaj, int *verMin) = 0;
+
+protected:
+#if wxUSE_STACKWALKER && defined( __WXDEBUG__ )
+    // utility function: returns the stack frame as a plain wxString
+    virtual wxString GetAssertStackTrace();
+#endif
+
+private:
+    static wxSocketManager *ms_manager;

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

-#if defined(__WXMSW__)
+// 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"
+#elif defined(__WIN32__)

     #include "wx/msw/apptbase.h"
     #include "wx/msw/apptbase.h"

-#elif defined(__UNIX__)
+#elif defined(__UNIX__) && !defined(__EMX__)

     #include "wx/unix/apptbase.h"
     #include "wx/unix/apptbase.h"

+#elif defined(__OS2__)
+    #include "wx/os2/apptbase.h"

 #else // no platform-specific methods to add to wxAppTraits
 #else // no platform-specific methods to add to wxAppTraits

-    typedef 

     // wxAppTraits must be a class because it was forward declared as class
     class WXDLLIMPEXP_BASE wxAppTraits : public wxAppTraitsBase
     {
     // wxAppTraits must be a class because it was forward declared as class
     class WXDLLIMPEXP_BASE wxAppTraits : public wxAppTraitsBase
     {


@@ -112,6 +219,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


@@ -119,6 +230,7 @@ public:
 #if wxUSE_FONTMAP
     virtual wxFontMapper *CreateFontMapper();
 #endif // wxUSE_FONTMAP
 #if wxUSE_FONTMAP
     virtual wxFontMapper *CreateFontMapper();
 #endif // wxUSE_FONTMAP

+    virtual wxRendererNative *CreateRenderer();

 
 #ifdef __WXDEBUG__
     virtual bool ShowAssertDialog(const wxString& msg);
 
 #ifdef __WXDEBUG__
     virtual bool ShowAssertDialog(const wxString& msg);


@@ -127,6 +239,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 = NULL, int *verMin = NULL) 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; }

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


@@ -135,7 +261,7 @@ public:
 
 #if wxUSE_GUI
 
 
 #if wxUSE_GUI
 

-class WXDLLEXPORT wxGUIAppTraitsBase : public wxAppTraits
+class WXDLLIMPEXP_CORE wxGUIAppTraitsBase : public wxAppTraits

 {
 public:
 #if wxUSE_LOG
 {
 public:
 #if wxUSE_LOG


@@ -145,6 +271,7 @@ public:
 #if wxUSE_FONTMAP
     virtual wxFontMapper *CreateFontMapper();
 #endif // wxUSE_FONTMAP
 #if wxUSE_FONTMAP
     virtual wxFontMapper *CreateFontMapper();
 #endif // wxUSE_FONTMAP

+    virtual wxRendererNative *CreateRenderer();

 
 #ifdef __WXDEBUG__
     virtual bool ShowAssertDialog(const wxString& msg);
 
 #ifdef __WXDEBUG__
     virtual bool ShowAssertDialog(const wxString& msg);


@@ -153,6 +280,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


@@ -161,15 +299,26 @@ public:
 // include the platform-specific version of the classes above
 // ----------------------------------------------------------------------------
 
 // include the platform-specific version of the classes above
 // ----------------------------------------------------------------------------
 

-#if defined(__WXMSW__)
+// ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port
+#if defined(__WXPALMOS__)
+    #include "wx/palmos/apptrait.h"
+#elif defined(__WIN32__)

     #include "wx/msw/apptrait.h"
     #include "wx/msw/apptrait.h"

+#elif defined(__OS2__)
+    #include "wx/os2/apptrait.h"

 #elif defined(__UNIX__)
     #include "wx/unix/apptrait.h"
 #elif defined(__UNIX__)
     #include "wx/unix/apptrait.h"

-#else // no platform-specific methods to add to wxAppTraits
+#elif defined(__DOS__)
+    #include "wx/msdos/apptrait.h"
+#else

     #if wxUSE_GUI
     #if wxUSE_GUI

-        typedef wxGUIAppTraitsBase wxGUIAppTraits;
+        class wxGUIAppTraits : public wxGUIAppTraitsBase
+        {
+        };

     #endif // wxUSE_GUI
     #endif // wxUSE_GUI

-    typedef wxConsoleAppTraitsBase wxConsoleAppTraits;
+    class wxConsoleAppTraits: public wxConsoleAppTraitsBase
+    {
+    };

 #endif // platform
 
 #endif // _WX_APPTRAIT_H_
 #endif // platform
 
 #endif // _WX_APPTRAIT_H_