X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b36d022a0da5fab493c46175e00f8d29cbad0f01..c2651b0a5c407ceb1693a865ee19d3d57e147c97:/docs/latex/wx/stdpaths.tex?ds=sidebyside diff --git a/docs/latex/wx/stdpaths.tex b/docs/latex/wx/stdpaths.tex index 8f44a53aa4..148dad7129 100644 --- a/docs/latex/wx/stdpaths.tex +++ b/docs/latex/wx/stdpaths.tex @@ -6,13 +6,13 @@ %% Created: 2004-10-17 %% RCS-ID: $Id$ %% Copyright: (c) 2004 Vadim Zeitlin -%% License: wxWidgets license +%% License: wxWindows license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxStandardPaths}}\label{wxstandardpaths} wxStandardPaths returns the standard locations in the file system and should be -used by the programs to find their data files in a portable way. +used by applications to find their data files in a portable way. Please note that this is not a real class because object of this type are never created but more a namespace containing the class methods which are all static, @@ -49,7 +49,7 @@ No base class \wxheading{Include files} - + \latexignore{\rtfignore{\wxheading{Members}}} @@ -83,7 +83,7 @@ data files. Example return values: \begin{itemize} \item Unix: \texttt{\textit{prefix}/share/\textit{appname}} - \item Windows: \texttt{C:$\backslash$Program Files$\backslash$\textit{appname}} + \item Windows: the directory where the executable file is located \item Mac: \texttt{\textit{appname}.app/Contents/SharedSupport} bundle subdirectory \end{itemize} @@ -142,9 +142,9 @@ Example return values: Return the directory for the user config files: \begin{itemize} - \item Unix: \texttt{\verb|~|} (the home directory) - \item Windows: \texttt{C:$\backslash$Documents and Settings$\backslash$\textit{username}} - \item Mac: \texttt{\verb|~|/Library/Preferences} + \item Unix: \tt{~} (the home directory) + \item Windows: \tt{C:$\backslash$Documents and Settings$\backslash$\textit{username}} + \item Mac: \tt{~/Library/Preferences} \end{itemize} Only use this method if you have a single configuration file to put in this @@ -158,9 +158,9 @@ more appropriate. Return the directory for the user-dependent application data files: \begin{itemize} - \item Unix: \texttt{\verb|~|/.\textit{appname}} - \item Windows: \texttt{C:$\backslash$Documents and Settings$\backslash$\textit{username}$\backslash$Application Data$\backslash$\textit{appname}} - \item Mac: \texttt{\verb|~|/Library/Application Support/\textit{appname}} + \item Unix: \tt{~/.\textit{appname}} + \item Windows: \tt{C:$\backslash$Documents and Settings$\backslash$\textit{username}$\backslash$Application Data$\backslash$\textit{appname}} + \item Mac: \tt{~/Library/Application Support/\textit{appname}} \end{itemize} @@ -180,7 +180,7 @@ all platforms except Windows where it returns \func{static void}{SetInstallPrefix}{\param{const wxString\& }{prefix}} -\textbf{Note: } This function is only available under Unix. +\textbf{Note:} This function is only available under Unix. Lets wxStandardPaths know about the real program installation prefix on a Unix system. By default, the value returned by