X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/afdf936cbcea4eb3370cd4a1b913c5b2e77e3c27..d3f00f59938d4801a95afa1cd638b8f15c481ee3:/docs/latex/wx/apptraits.tex?ds=sidebyside diff --git a/docs/latex/wx/apptraits.tex b/docs/latex/wx/apptraits.tex index f50a1c01d3..78cdac60f3 100644 --- a/docs/latex/wx/apptraits.tex +++ b/docs/latex/wx/apptraits.tex @@ -29,6 +29,10 @@ None +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxApp overview}{wxappoverview}, \helpref{wxApp}{wxapp} @@ -36,40 +40,39 @@ None \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxAppTraits::GetToolkitInfo}\label{wxapptraitsgettoolkitinfo} - -\func{virtual wxToolkitInfo \&}{GetToolkitInfo}{\void} - -Returns information about which toolkit is running. See \helpref{wxToolkitInfo}{wxtoolkitinfo} -for more details. +\membersection{wxAppTraits::CreateConfig}\label{wxapptraitscreateconfig} +\func{virtual wxConfigBase *}{CreateConfig}{\void} -\membersection{wxAppTraits::HasStderr}\label{wxapptraitshasstderr} - -\func{virtual bool}{HasStderr}{\void} +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. -Returns \true if {\tt fprintf(stderr)} goes somewhere, \false otherwise. +\membersection{wxAppTraits::CreateFontMapper}\label{wxapptraitscreatefontmapper} +\func{virtual wxFontMapper *}{CreateFontMapper}{\void} -\membersection{wxAppTraits::ShowAssertDialog}\label{wxapptraitsshowassertdialog} +Creates the global font mapper object used for encodings/charset mapping. -\func{virtual bool}{ShowAssertDialog}{\param{const wxString \&}{ msg}} -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. +\membersection{wxAppTraits::CreateLogTarget}\label{wxapptraitscreatelogtarget} +\func{virtual wxLog *}{CreateLogTarget}{\void} +Creates the default log target for the application. -\membersection{wxAppTraits::GetStandardPaths}\label{wxapptraitsgetstandardpaths} -\func{virtual wxStandardPaths \&}{GetStandardPaths}{\void} +\membersection{wxAppTraits::CreateMessageOutput}\label{wxapptraitscreatemessageoutput} -Returns the wxStandardPaths object for the application. -It's normally the same for wxBase and wxGUI except in the case of wxMac and wxCocoa. +\func{virtual wxMessageOutput *}{CreateMessageOutput}{\void} +Creates the global object used for printing out messages. \membersection{wxAppTraits::CreateRenderer}\label{wxapptraitscreaterenderer} @@ -82,28 +85,60 @@ 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} -\membersection{wxAppTraits::CreateLogTarget}\label{wxapptraitscreatelogtarget} +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. -\func{virtual wxLog *}{CreateLogTarget}{\void} +\membersection{wxAppTraits::GetStandardPaths}\label{wxapptraitsgetstandardpaths} -Creates the default log target for the application. +\func{virtual wxStandardPaths \&}{GetStandardPaths}{\void} +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} -\membersection{wxAppTraits::CreateMessageOutput}\label{wxapptraitscreatemessageoutput} +\func{virtual wxPortId}{GetToolkitVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}} -\func{virtual wxMessageOutput *}{CreateMessageOutput}{\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. +The version numbers returned are thus detected at run-time and not compile-time +(except when this is not possible e.g. wxMotif). -Creates the global object used for printing out messages. +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::CreateFontMapper}\label{wxapptraitscreatefontmapper} +\membersection{wxAppTraits::HasStderr}\label{wxapptraitshasstderr} -\func{virtual wxFontMapper *}{CreateFontMapper}{\void} +\func{virtual bool}{HasStderr}{\void} -Creates the global font mapper object used for encodings/charset mapping. +Returns \true if {\tt fprintf(stderr)} goes somewhere, \false otherwise. +\membersection{wxAppTraits::IsUsingUniversalWidgets}\label{wxapptraitsisusinguniversalwidgets} + +\constfunc{bool}{IsUsingUniversalWidgets}{\void} + +Returns \true if the library was built as wxUniversal. Always returns +\false for wxBase-only apps. + + +\membersection{wxAppTraits::ShowAssertDialog}\label{wxapptraitsshowassertdialog} + +\func{virtual bool}{ShowAssertDialog}{\param{const wxString \&}{ msg}} + +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. +