Documented new menu label functions

[wxWidgets.git] / docs / latex / wx / apptraits.tex

diff --git a/docs/latex/wx/apptraits.tex b/docs/latex/wx/apptraits.tex
index 6c8074cf6609cb4f135317c5090a8b99d9d90f4b..78cdac60f3db38d108c620e5a26bbf65f0a99cff 100644 (file)
--- a/docs/latex/wx/apptraits.tex
+++ b/docs/latex/wx/apptraits.tex
@@ -29,6 +29,10 @@ None
 
 <wx/apptrait.h>
 
 
 <wx/apptrait.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxApp overview}{wxappoverview}, \helpref{wxApp}{wxapp}
 \wxheading{See also}
 
 \helpref{wxApp overview}{wxappoverview}, \helpref{wxApp}{wxapp}


@@ -36,47 +40,60 @@ None
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 

-\membersection{wxAppTraits::GetPlatformInfo}\label{wxapptraitsgetplatforminfo}
+\membersection{wxAppTraits::CreateConfig}\label{wxapptraitscreateconfig}

 
 

-\func{virtual wxPlatformInfo \&}{GetPlatformInfo}{\void}
+\func{virtual wxConfigBase *}{CreateConfig}{\void}

 
 

-Returns information about which platform is the program running on.
-See \helpref{wxPlatformInfo}{wxplatforminfo} for more details.
+Called by wxWidgets to create the default configuration object for the
+application. The default version creates a registry-based 
+\helpref{wxRegConfig}{wxconfigbase} class under MSW and 
+\helpref{wxFileConfig}{wxfileconfig} under all other platforms. The 
+\helpref{wxApp}{wxapp} \helpref{GetAppName()}{wxappgetappname} and 
+\helpref{GetVendorName()}{wxappgetvendorname} methods are used to determine the
+registry key or file name.

 
 
 
 

-\membersection{wxAppTraits::GetToolkitVersion}\label{wxapptraitsgettoolkitversion}
+\membersection{wxAppTraits::CreateFontMapper}\label{wxapptraitscreatefontmapper}

 
 

-\func{virtual wxPortId}{GetToolkitVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
+\func{virtual wxFontMapper *}{CreateFontMapper}{\void}

 
 

-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.
+Creates the global font mapper object used for encodings/charset mapping.

 
 

-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.

 
 

-See \helpref{wxPlatformInfo}{wxplatforminfo} for more details.

 
 

+\membersection{wxAppTraits::CreateLogTarget}\label{wxapptraitscreatelogtarget}

 
 

+\func{virtual wxLog *}{CreateLogTarget}{\void}

 
 

-\membersection{wxAppTraits::HasStderr}\label{wxapptraitshasstderr}
+Creates the default log target for the application.

 
 

-\func{virtual bool}{HasStderr}{\void}

 
 

-Returns \true if {\tt fprintf(stderr)} goes somewhere, \false otherwise.
+\membersection{wxAppTraits::CreateMessageOutput}\label{wxapptraitscreatemessageoutput}

 
 

+\func{virtual wxMessageOutput *}{CreateMessageOutput}{\void}

 
 

+Creates the global object used for printing out messages.

 
 

-\membersection{wxAppTraits::ShowAssertDialog}\label{wxapptraitsshowassertdialog}

 
 

-\func{virtual bool}{ShowAssertDialog}{\param{const wxString \&}{ msg}}
+\membersection{wxAppTraits::CreateRenderer}\label{wxapptraitscreaterenderer}

 
 

-Shows the assert dialog with the specified message in GUI mode or just prints
-the string to stderr in console mode.
+\func{virtual wxRendererNative *}{CreateRenderer}{\void}

 
 

-Returns \true to suppress subsequent asserts, \false to continue as before.
+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.
+
+\membersection{wxAppTraits::GetDesktopEnvironment}\label{wxapptraitsgetdesktopenvironment}

 
 

+\constfunc{virtual wxString}{GetDesktopEnvironment}{\void}

 
 

+This method returns the name of the desktop environment currently
+running in a Unix desktop. Currently only "KDE" or "GNOME" are
+supported and the code uses the X11 session protocol vendor name
+to figure out, which desktop environment is running. The method
+returns an empty string otherwise and on all other platforms.

 
 \membersection{wxAppTraits::GetStandardPaths}\label{wxapptraitsgetstandardpaths}
 
 
 \membersection{wxAppTraits::GetStandardPaths}\label{wxapptraitsgetstandardpaths}
 


@@ -85,40 +102,43 @@ Returns \true to suppress subsequent asserts, \false to continue as before.
 Returns the wxStandardPaths object for the application.
 It's normally the same for wxBase and wxGUI except in the case of wxMac and wxCocoa.
 
 Returns the wxStandardPaths object for the application.
 It's normally the same for wxBase and wxGUI except in the case of wxMac and wxCocoa.
 

+\membersection{wxAppTraits::GetToolkitVersion}\label{wxapptraitsgettoolkitversion}

 
 

+\func{virtual wxPortId}{GetToolkitVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}

 
 

-\membersection{wxAppTraits::CreateRenderer}\label{wxapptraitscreaterenderer}
-
-\func{virtual wxRendererNative *}{CreateRenderer}{\void}
-
-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 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.

 
 

-\membersection{wxAppTraits::CreateLogTarget}\label{wxapptraitscreatelogtarget}
+See \helpref{wxPlatformInfo}{wxplatforminfo} for more details.

 
 

-\func{virtual wxLog *}{CreateLogTarget}{\void}

 
 

-Creates the default log target for the application.
+\membersection{wxAppTraits::HasStderr}\label{wxapptraitshasstderr}

 
 

+\func{virtual bool}{HasStderr}{\void}

 
 

+Returns \true if {\tt fprintf(stderr)} goes somewhere, \false otherwise.

 
 

-\membersection{wxAppTraits::CreateMessageOutput}\label{wxapptraitscreatemessageoutput}

 
 

-\func{virtual wxMessageOutput *}{CreateMessageOutput}{\void}
+\membersection{wxAppTraits::IsUsingUniversalWidgets}\label{wxapptraitsisusinguniversalwidgets}

 
 

-Creates the global object used for printing out messages.
+\constfunc{bool}{IsUsingUniversalWidgets}{\void}

 
 

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

 
 
 
 

-\membersection{wxAppTraits::CreateFontMapper}\label{wxapptraitscreatefontmapper}
+\membersection{wxAppTraits::ShowAssertDialog}\label{wxapptraitsshowassertdialog}

 
 

-\func{virtual wxFontMapper *}{CreateFontMapper}{\void}
+\func{virtual bool}{ShowAssertDialog}{\param{const wxString \&}{ msg}}

 
 

-Creates the global font mapper object used for encodings/charset mapping.
+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.