X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ac7ad70d4c6d7db2ab9e01a4662611f2a706b6fe..a75124d0da255513e83d2e62f963dd849829466b:/docs/latex/wx/stdpaths.tex diff --git a/docs/latex/wx/stdpaths.tex b/docs/latex/wx/stdpaths.tex index 62a2ab82ea..bd469503f2 100644 --- a/docs/latex/wx/stdpaths.tex +++ b/docs/latex/wx/stdpaths.tex @@ -47,6 +47,10 @@ No base class +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} @@ -154,7 +158,7 @@ under Unix where it returns \texttt{/etc/\textit{appname}}. \membersection{wxStandardPaths::GetLocalizedResourcesDir}\label{wxstandardpathsgetlocalizedresourcesdir} -\constfunc{wxString}{GetLocalizedResourcesDir}{\param{const wxChar*}{ lang}, \param{ResourceCat}{ category = ResourceCat\_None}} +\constfunc{wxString}{GetLocalizedResourcesDir}{\param{const wxString\&}{ lang}, \param{ResourceCat}{ category = ResourceCat\_None}} Return the localized resources directory containing the resource files of the specified category for the given language. @@ -176,9 +180,9 @@ Return the directory where the loadable modules (plugins) live. Example return values: \begin{itemize} - \item Unix: \texttt{\textit{prefix}/share/\textit{appname}} - \item Windows: the directory where the executable file is located - \item Mac: \texttt{\textit{appname}.app/Contents/Resources} bundle subdirectory + \item Unix: \texttt{\textit{prefix}/lib/\textit{appname}} + \item Windows: the directory of the executable file + \item Mac: \texttt{\textit{appname}.app/Contents/PlugIns} bundle subdirectory \end{itemize} \wxheading{See also} @@ -199,9 +203,9 @@ all platforms except Mac OS X. Example return values: \begin{itemize} - \item Unix: \texttt{\textit{prefix}/lib/\textit{appname}} - \item Windows: the directory of the executable file - \item Mac: \texttt{\textit{appname}.app/Contents/PlugIns} bundle subdirectory + \item Unix: \texttt{\textit{prefix}/share/\textit{appname}} + \item Windows: the directory where the executable file is located + \item Mac: \texttt{\textit{appname}.app/Contents/Resources} bundle subdirectory \end{itemize} \newsince{2.7.0} @@ -276,3 +280,24 @@ automatically, portable programs should call this function. Usually the prefix is set during program configuration if using GNU autotools and so it is enough to pass its value defined in \texttt{config.h} to this function. + +\membersection{wxStandardPaths::UseAppInfo}\label{wxstandardpathsuseappinfo} + +\func{void}{UseAppInfo}{\param{int }{info}} + +Controls what application information is used when constructing paths that +should be unique to this program, such as the application data directory, the +plugins directory on Unix, etc. + +Valid values for \arg{info} are \texttt{AppInfo\_None} and either one or +combination of \texttt{AppInfo\_AppName} and \texttt{AppInfo\_VendorName}. The +first one tells this class to not use neither application nor vendor name in +the paths. + +By default, only the application name is used under Unix systems but both +application and vendor names are used under Windows and Mac. + +\wxheading{See also} + +\helpref{wxApp::SetAppName}{wxappsetappname}, \helpref{wxApp::SetVendorName}{wxappsetvendorname} +