use an enum to make it easier to document the values

[wxWidgets.git] / interface / apptrait.h

diff --git a/interface/apptrait.h b/interface/apptrait.h
index cca9c9859bc421bcafbe3bbcfd9a6deb8011b739..7da10c02b965e21095364a4cc2de40a6515063d0 100644 (file)
--- a/interface/apptrait.h
+++ b/interface/apptrait.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        apptrait.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        apptrait.h

-// Purpose:     documentation for wxAppTraits class
+// Purpose:     interface of wxAppTraits

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -10,61 +10,64 @@
     @class wxAppTraits
     @wxheader{apptrait.h}
 
     @class wxAppTraits
     @wxheader{apptrait.h}
 

-    The @b wxAppTraits class defines various configurable aspects of a wxApp.
-    You can access it using wxApp::GetTraits function and you can
-    create your own wxAppTraits overriding the
-    wxApp::CreateTraits function.
+    The wxAppTraits class defines various configurable aspects of a wxApp.
+    You can access it using wxApp::GetTraits() function and you can create your
+    own wxAppTraits overriding the wxApp::CreateTraits() function.

 
 

-    By default, wxWidgets creates a @c wxConsoleAppTraits object for console
-    applications
-    (i.e. those applications linked against wxBase library only - see the
-    @ref overview_librarieslist "Libraries list" page) and a @c wxGUIAppTraits
-    object for GUI
+    Note that wxAppTraits is an abstract class since it contains many
+    pure virtual functions.
+    In fact, by default, wxWidgets creates a @c wxConsoleAppTraits object for
+    console applications (i.e. those applications linked against wxBase library
+    only - see the @ref page_libs page) and a @c wxGUIAppTraits object for GUI

     applications.
     applications.

+    Both these classes are derived by wxAppTraits and represent concrete
+    implementation of the wxAppTraits interface.

 
     @library{wxbase}
 
     @library{wxbase}

-    @category{FIXME}
+    @category{appmanagement}

 
 

-    @seealso
-    @ref overview_wxappoverview "wxApp overview", wxApp
+    @see @ref overview_app, wxApp

 */
 class wxAppTraits
 {
 public:
     /**
         Called by wxWidgets to create the default configuration object for the
 */
 class wxAppTraits
 {
 public:
     /**
         Called by wxWidgets to create the default configuration object for the

-        application. The default version creates a registry-based
-        wxRegConfig class under MSW and
-        wxFileConfig under all other platforms. The
-        wxApp wxApp::GetAppName and
-        wxApp::GetVendorName methods are used to determine the
-        registry key or file name.
+        application. The default version creates a registry-based wxRegConfig
+        class under MSW and wxFileConfig under all other platforms.
+
+        The wxApp::GetAppName and wxApp::GetVendorName methods are used to
+        determine the registry key or file name.

     */
     virtual wxConfigBase* CreateConfig();
 
     /**
         Creates the global font mapper object used for encodings/charset mapping.
     */
     */
     virtual wxConfigBase* CreateConfig();
 
     /**
         Creates the global font mapper object used for encodings/charset mapping.
     */

-    virtual wxFontMapper* CreateFontMapper();
+    virtual wxFontMapper* CreateFontMapper() = 0;

 
     /**
 
     /**

-        Creates the default log target for the application.
+        Creates a wxLog class for the application to use for logging errors.
+        The default implementation returns a new wxLogGui class.
+
+        @see wxLog

     */
     */

-    virtual wxLog* CreateLogTarget();
+    virtual wxLog* CreateLogTarget() = 0;

 
     /**
         Creates the global object used for printing out messages.
     */
 
     /**
         Creates the global object used for printing out messages.
     */

-    virtual wxMessageOutput* CreateMessageOutput();
+    virtual wxMessageOutput* CreateMessageOutput() = 0;

 
     /**
 
     /**

-        Returns 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 mode only and always returns @NULL in console.
-        NOTE: returned pointer will be deleted by the caller.
+        Returns 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 mode only and always returns @NULL
+        in console.
+
+        @note the returned pointer needs to be deleted by the caller.

     */
     */

-    virtual wxRendererNative* CreateRenderer();
+    virtual wxRendererNative* CreateRenderer() = 0;

 
     /**
         This method returns the name of the desktop environment currently
 
     /**
         This method returns the name of the desktop environment currently


@@ -73,44 +76,50 @@ public:
         to figure out, which desktop environment is running. The method
         returns an empty string otherwise and on all other platforms.
     */
         to figure out, which desktop environment is running. The method
         returns an empty string otherwise and on all other platforms.
     */

-    virtual wxString GetDesktopEnvironment() const;
+    virtual wxString GetDesktopEnvironment() const = 0;

 
     /**
         Returns the wxStandardPaths object for the application.
 
     /**
         Returns the wxStandardPaths object for the application.

-        It's normally the same for wxBase and wxGUI except in the case of wxMac and
-        wxCocoa.
+        It's normally the same for wxBase and wxGUI except in the case of wxMac
+        and wxCocoa.
+
+        @todo the real function returns a reference to wxStandardPathsBase;
+              user looking at these docs will write code:
+                    wxStandardPaths &ref = ...->GetStandardPaths();
+              which won't compile...

     */
     */

-    virtual wxStandardPaths GetStandardPaths();
+    virtual wxStandardPaths& GetStandardPaths();

 
     /**
         Returns the wxWidgets port ID used by the running program and eventually
         fills the given pointers with the values of the major and minor digits
         of the native toolkit currently used.
 
     /**
         Returns the wxWidgets port ID used by the running program and eventually
         fills the given pointers with the values of the major and minor digits
         of the native toolkit currently used.

+

         The version numbers returned are thus detected at run-time and not compile-time
         (except when this is not possible e.g. wxMotif).
         The version numbers returned are thus detected at run-time and not compile-time
         (except when this is not possible e.g. wxMotif).

+

         E.g. if your program is using wxGTK port this function will return wxPORT_GTK
         E.g. if your program is using wxGTK port this function will return wxPORT_GTK

-        and
-        put in given pointers the versions of the GTK library in use.
+        and put in given pointers the versions of the GTK library in use.

         See wxPlatformInfo for more details.
     */
         See wxPlatformInfo for more details.
     */

-    virtual wxPortId GetToolkitVersion(int* major = NULL,
-                                       int* minor = NULL);
+    virtual wxPortId GetToolkitVersion(int* major = NULL, int* minor = NULL) const = 0;

 
     /**
         Returns @true if @c fprintf(stderr) goes somewhere, @false otherwise.
     */
 
     /**
         Returns @true if @c fprintf(stderr) goes somewhere, @false otherwise.
     */

-    virtual bool HasStderr();
+    virtual bool HasStderr() = 0;

 
     /**
 
     /**

-        Returns @true if the library was built as wxUniversal. Always returns
-        @false for wxBase-only apps.
+        Returns @true if the library was built as wxUniversal.
+        Always returns @false for wxBase-only apps.

     */
     */

-    bool IsUsingUniversalWidgets() const;
+    virtual bool IsUsingUniversalWidgets() const = 0;

 
     /**
         Shows the assert dialog with the specified message in GUI mode or just prints
         the string to stderr in console mode.
         Returns @true to suppress subsequent asserts, @false to continue as before.
     */
 
     /**
         Shows the assert dialog with the specified message in GUI mode or just prints
         the string to stderr in console mode.
         Returns @true to suppress subsequent asserts, @false to continue as before.
     */

-    virtual bool ShowAssertDialog(const wxString& msg);
+    virtual bool ShowAssertDialog(const wxString& msg) = 0;

 };
 };

+