fix the signature of the documented functions and document some (relatively) new...

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

diff --git a/include/wx/apptrait.h b/include/wx/apptrait.h
index c2ad503e726caf3df087aeec8b0abe5389c10b4c..73110bbcc1ca6098301c7a05a59e5a4bf10243f2 100644 (file)
--- a/include/wx/apptrait.h
+++ b/include/wx/apptrait.h
@@ -15,25 +15,28 @@
 #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
-    class WXDLLEXPORT wxFontMapper;
+    class WXDLLIMPEXP_FWD_CORE wxFontMapper;
 #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 GSocketManager;
 
 
 // ----------------------------------------------------------------------------
 // wxAppTraits: this class defines various configurable aspects of wxApp
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_BASE wxStandardPathsBase;
-
 class WXDLLIMPEXP_BASE wxAppTraitsBase
 {
 public:
@@ -43,6 +46,13 @@ public:
     // 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;
@@ -63,11 +73,9 @@ public:
     // 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
 
 #if wxUSE_INTL
     // called during wxApp initialization to set the locale to correspond to
@@ -108,15 +116,23 @@ public:
     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;
+    // return socket manager: this is usually different for console and GUI
+    // applications (although some ports use the same implementation for both)
+    virtual GSocketManager *GetSocketManager() = 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
 
+#if wxUSE_THREADS
+    virtual void MutexGuiEnter();
+    virtual void MutexGuiLeave();
+#endif
 
     // functions returning port-specific information
     // ------------------------------------------------------------------------
@@ -132,7 +148,21 @@ public:
 
     // return the name of the Desktop Environment such as
     // "KDE" or "GNOME". May return an empty string.
-    virtual wxString GetDesktopEnvironment() const { return wxEmptyString; }
+    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;
+    }
+
 
 protected:
 #if wxUSE_STACKWALKER && defined( __WXDEBUG__ )
@@ -154,8 +184,6 @@ protected:
     #include "wx/msw/apptbase.h"
 #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
@@ -176,6 +204,10 @@ protected:
 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
@@ -184,9 +216,6 @@ public:
     virtual wxFontMapper *CreateFontMapper();
 #endif // wxUSE_FONTMAP
     virtual wxRendererNative *CreateRenderer();
-#if wxUSE_SOCKETS
-    virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable();
-#endif
 
 #ifdef __WXDEBUG__
     virtual bool ShowAssertDialog(const wxString& msg);
@@ -208,6 +237,7 @@ public:
     }
 
     virtual bool IsUsingUniversalWidgets() const { return false; }
+    virtual wxString GetDesktopEnvironment() const { return wxEmptyString; }
 };
 
 // ----------------------------------------------------------------------------
@@ -227,9 +257,6 @@ public:
     virtual wxFontMapper *CreateFontMapper();
 #endif // wxUSE_FONTMAP
     virtual wxRendererNative *CreateRenderer();
-#if wxUSE_SOCKETS
-    virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable();
-#endif
 
 #ifdef __WXDEBUG__
     virtual bool ShowAssertDialog(const wxString& msg);
@@ -247,6 +274,8 @@ public:
         return false;
     #endif
     }
+
+    virtual wxString GetDesktopEnvironment() const { return wxEmptyString; }
 };
 
 #endif // wxUSE_GUI
@@ -264,8 +293,6 @@ public:
     #include "wx/os2/apptrait.h"
 #elif defined(__UNIX__)
     #include "wx/unix/apptrait.h"
-#elif defined(__WXMAC__)
-    #include "wx/mac/apptrait.h"
 #elif defined(__DOS__)
     #include "wx/msdos/apptrait.h"
 #else