X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..9e9574fe45b176ee74bba8fad7574cf9906145d1:/interface/wx/apptrait.h diff --git a/interface/wx/apptrait.h b/interface/wx/apptrait.h index 7da10c02b9..d4f8ff10d3 100644 --- a/interface/wx/apptrait.h +++ b/interface/wx/apptrait.h @@ -2,13 +2,11 @@ // Name: apptrait.h // Purpose: interface of wxAppTraits // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @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 @@ -24,7 +22,7 @@ implementation of the wxAppTraits interface. @library{wxbase} - @category{appmanagement} + @category{cfg} @see @ref overview_app, wxApp */ @@ -41,6 +39,17 @@ public: */ 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. */ @@ -83,10 +92,9 @@ public: 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();