revised other headers

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52463 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-12 22:18:27 +00:00
parent 5e4e03e9f9
commit 96d7cc9be3
3 changed files with 407 additions and 377 deletions

View File

@@ -11,33 +11,29 @@
@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.
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
applications (i.e. those applications linked against wxBase library only -
see the @ref page_libs page) and a @c wxGUIAppTraits object for GUI
applications.
@library{wxbase}
@category{FIXME}
@category{appmanagement}
@see @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
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();
@@ -57,11 +53,12 @@ public:
virtual wxMessageOutput* CreateMessageOutput();
/**
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();
@@ -76,8 +73,8 @@ public:
/**
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.
*/
virtual wxStandardPaths GetStandardPaths();
@@ -85,11 +82,12 @@ public:
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).
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.
*/
virtual wxPortId GetToolkitVersion(int* major = NULL,
@@ -101,8 +99,8 @@ public:
virtual bool HasStderr();
/**
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;