documented GetResourcesDir() and GetLocalizedResourcesDir() (somehow forgot to commit before, sorry)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@38383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2006-03-27 13:48:18 +00:00
parent 8c94336825
commit f3b0f8ad21

View File

@ -121,12 +121,49 @@ This is the same as \helpref{GetDataDir()}{wxstandardpathsgetdatadir} except
under Unix where it returns \texttt{/etc/\textit{appname}}.
\membersection{wxStandardPaths::GetLocalizedResourcesDir}\label{wxstandardpathsgetlocalizedresourcesdir}
\func{wxString}{GetLocalizedResourcesDir}{\param{const wxChar *lang}, \param{ResourceCat }{category = ResourceCat\_None}}
Return the localized resources directory containing the resource files of the
specified category for the given language.
In general this is just the same as \arg{lang} subdirectory of
\helpref{GetResourcesDir()}{wxstandardpathsgetresourcesdir} (or
\texttt{\arg{lang}.lproj} under Mac OS X) but is something quite
different for message catalog category under Unix where it returns the standard
\texttt{\textit{prefix}/share/locale/\arg{lang}/LC\_MESSAGES} directory.
\membersection{wxStandardPaths::GetPluginsDir}\label{wxstandardpathsgetpluginsdir}
\func{wxString}{GetPluginsDir}{\void}
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
\end{itemize}
\wxheading{See also}
\helpref{wxDynamicLibrary}{wxdynamiclibrary}
\membersection{wxStandardPaths::GetResourcesDir}\label{wxstandardpathsgetresourcesdir}
\func{wxString}{GetResourcesDir}{\void}
Return the directory where the application resource files are located. The
resources are the auxiliary data files needed for the application to run and
include, for example, image and sound files it might use.
This function is the same as \helpref{GetDataDir}{wxstandardpathsgetdatadir} for
all platforms except Mac OS X.
Example return values:
\begin{itemize}
\item Unix: \texttt{\textit{prefix}/lib/\textit{appname}}
@ -136,7 +173,7 @@ Example return values:
\wxheading{See also}
\helpref{wxDynamicLibrary}{wxdynamiclibrary}
\helpref{GetLocalizedResourcesDir}{wxstandardpathsgetlocalizedresourcesdir}
\membersection{wxStandardPaths::GetUserConfigDir}\label{wxstandardpathsgetuserconfigdir}