]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/apptrait.h
Add a comment about covariant returns
[wxWidgets.git] / include / wx / apptrait.h
index 8cd8cd47973ca1a95d3884ac5e5722cfc7240fb5..10e4d6b8dc6127def449538b3095893042c09585 100644 (file)
@@ -5,39 +5,57 @@
 // 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_
 
-class WXDLLEXPORT wxObject;
+#include "wx/string.h"
+
+class WXDLLIMPEXP_BASE wxObject;
 class WXDLLEXPORT wxAppTraits;
 #if wxUSE_FONTMAP
     class WXDLLEXPORT wxFontMapper;
 #endif // wxUSE_FONTMAP
-class WXDLLEXPORT wxLog;
-class WXDLLEXPORT wxMessageOutput;
+class WXDLLIMPEXP_BASE wxLog;
+class WXDLLIMPEXP_BASE wxMessageOutput;
+class WXDLLEXPORT wxRendererNative;
+class WXDLLIMPEXP_BASE wxString;
+
+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
 // ----------------------------------------------------------------------------
 
-#if wxUSE_BASE
+class WXDLLIMPEXP_BASE wxStandardPathsBase;
+
 class WXDLLIMPEXP_BASE wxAppTraitsBase
-#else
-class WXDLLIMPEXP_CORE wxAppTraitsBase
-#endif
 {
 public:
-    // wxAppTraits is an ABC, but we also provide 2 standard implementations of
-    // it, one for the console apps and the other for the GUI ones
-    static wxAppTraits *CreateConsole();
-#if wxUSE_GUI
-    static wxAppTraits *CreateGUI();
-#endif // wxUSE_GUI
-
+    // needed since this class declares virtual members
+    virtual ~wxAppTraitsBase() { }
 
     // hooks for creating the global objects, may be overridden by the user
     // ------------------------------------------------------------------------
@@ -55,6 +73,18 @@ public:
     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;
+
+#if wxUSE_STDPATHS
+    // wxStandardPaths object is normally the same for wxBase and wxGUI
+    // except in the case of wxMac and wxCocoa
+    virtual wxStandardPathsBase& GetStandardPaths();
+#endif // wxUSE_STDPATHS
 
     // functions abstracting differences between GUI and console modes
     // ------------------------------------------------------------------------
@@ -87,28 +117,46 @@ public:
     // wxBase
     virtual void RemoveFromPendingDelete(wxObject *object) = 0;
 
+#if wxUSE_SOCKETS
+    // return table of GUI callbacks for GSocket code or NULL in wxBase. This
+    // is needed because networking classes are in their own library and so
+    // they can't directly call GUI functions (the same net library can be
+    // used in both GUI and base apps). To complicate it further, GUI library
+    // ("wxCore") doesn't depend on networking library and so only a functions
+    // table can be passed around
+    virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable() = 0;
+#endif
 
-    // other miscellaneous helpers
-    // ---------------------------
 
-    // 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;
+    // 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;
 };
 
 // ----------------------------------------------------------------------------
 // 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)
+#if defined(__WXPALMOS__)
+    #include "wx/palmos/apptbase.h"
+#elif defined(__WXMSW__)
     #include "wx/msw/apptbase.h"
-#elif defined(__UNIX__)
+#elif defined(__UNIX__) && !defined(__EMX__)
     #include "wx/unix/apptbase.h"
+#elif defined(__WXMAC__)
+    #include "wx/mac/apptbase.h"
+#elif defined(__OS2__)
+    #include "wx/os2/apptbase.h"
 #else // no platform-specific methods to add to wxAppTraits
-    typedef 
     // wxAppTraits must be a class because it was forward declared as class
-    class WXDLLEXPORT wxAppTraits : public wxAppTraitsBase
+    class WXDLLIMPEXP_BASE wxAppTraits : public wxAppTraitsBase
     {
     };
 #endif // platform
@@ -131,6 +179,10 @@ public:
 #if wxUSE_FONTMAP
     virtual wxFontMapper *CreateFontMapper();
 #endif // wxUSE_FONTMAP
+    virtual wxRendererNative *CreateRenderer();
+#if wxUSE_SOCKETS
+    virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable();
+#endif
 
 #ifdef __WXDEBUG__
     virtual bool ShowAssertDialog(const wxString& msg);
@@ -157,6 +209,10 @@ public:
 #if wxUSE_FONTMAP
     virtual wxFontMapper *CreateFontMapper();
 #endif // wxUSE_FONTMAP
+    virtual wxRendererNative *CreateRenderer();
+#if wxUSE_SOCKETS
+    virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable();
+#endif
 
 #ifdef __WXDEBUG__
     virtual bool ShowAssertDialog(const wxString& msg);
@@ -173,15 +229,28 @@ public:
 // include the platform-specific version of the classes above
 // ----------------------------------------------------------------------------
 
-#if defined(__WXMSW__)
+#if defined(__WXPALMOS__)
+    #include "wx/palmos/apptrait.h"
+#elif defined(__WXMSW__)
     #include "wx/msw/apptrait.h"
-#elif defined(__UNIX__)
+#elif defined(__UNIX__) && !defined(__EMX__)
     #include "wx/unix/apptrait.h"
-#else // no platform-specific methods to add to wxAppTraits
+#elif defined(__WXMAC__)
+    #include "wx/mac/apptrait.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/apptrait.h"
+#else
+    // at least, we need an implementation of GetToolkitInfo !
     #if wxUSE_GUI
-        typedef wxGUIAppTraitsBase wxGUIAppTraits;
+        class wxGUIAppTraits : public wxGUIAppTraitsBase
+        {
+            virtual wxToolkitInfo& GetToolkitInfo();
+        };
     #endif // wxUSE_GUI
-    typedef wxConsoleAppTraitsBase wxConsoleAppTraits;
+    class wxConsoleAppTraits: public wxConsoleAppTraitsBase
+    {
+        virtual wxToolkitInfo& GetToolkitInfo();
+    };
 #endif // platform
 
 #endif // _WX_APPTRAIT_H_