// Name: apptrait.h
// Purpose: interface of wxAppTraits
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
implementation of the wxAppTraits interface.
@library{wxbase}
- @category{appmanagement}
+ @category{cfg}
@see @ref overview_app, wxApp
*/
*/
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.
*/
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();