update for bakefile 0.2.6

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

diff --git a/interface/wx/apptrait.h b/interface/wx/apptrait.h
index 7da10c02b965e21095364a4cc2de40a6515063d0..57c2b6d58603bdda7a73fda43373a232ef2e803a 100644 (file)
--- a/interface/wx/apptrait.h
+++ b/interface/wx/apptrait.h
@@ -8,7 +8,6 @@
 
 /**
     @class wxAppTraits
 
 /**
     @class wxAppTraits

-    @wxheader{apptrait.h}

 
     The wxAppTraits class defines various configurable aspects of a wxApp.
     You can access it using wxApp::GetTraits() function and you can create your
 
     The wxAppTraits class defines various configurable aspects of a wxApp.
     You can access it using wxApp::GetTraits() function and you can create your


@@ -24,7 +23,7 @@
     implementation of the wxAppTraits interface.
 
     @library{wxbase}
     implementation of the wxAppTraits interface.
 
     @library{wxbase}

-    @category{appmanagement}
+    @category{cfg}

 
     @see @ref overview_app, wxApp
 */
 
     @see @ref overview_app, wxApp
 */


@@ -41,6 +40,17 @@ public:
     */
     virtual wxConfigBase* CreateConfig();
 
     */
     virtual wxConfigBase* CreateConfig();
 

+    /**
+        Used by wxWidgets to create the main event loop used by wxApp::OnRun().
+
+        The default implementation of this method in wxGUIAppTraits returns the
+        usual platform-specific GUI event loop. The version in wxConsoleAppTraits
+        returns a console-specific event loop which can be used to handle timer
+        and socket events in console programs under Unix and MSW or @NULL under
+        the other platforms where console event loops are not supported yet.
+     */
+    virtual wxEventLoopBase *CreateEventLoop() = 0;
+

     /**
         Creates the global font mapper object used for encodings/charset mapping.
     */
     /**
         Creates the global font mapper object used for encodings/charset mapping.
     */


@@ -83,12 +93,11 @@ public:
         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...
+        @note
+        The returned reference is to a @c wxStandardPathsBase class but you
+        can consider it to be equivalent to wxStandardPaths (which is documented).

     */
     */

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

 
     /**
         Returns the wxWidgets port ID used by the running program and eventually
 
     /**
         Returns the wxWidgets port ID used by the running program and eventually