document LoadObject() (patch 1873045)

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

diff --git a/docs/latex/wx/fileconf.tex b/docs/latex/wx/fileconf.tex
index f914d1f156af8dbcee01deac4aa4e9385a47f14d..9351ab41c7bacab3b98e4ab049e339b98d634e10 100644 (file)
--- a/docs/latex/wx/fileconf.tex
+++ b/docs/latex/wx/fileconf.tex
@@ -6,7 +6,7 @@
 %% Created:     2004-10-04
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2004 Vadim Zeitlin
-%% License:     wxWidgets license
+%% License:     wxWindows license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFileConfig}}\label{wxfileconfig}
@@ -23,18 +23,23 @@ Windows.
 
 \wxheading{Derived from}
 
-\helpref{wxConfigBase}{wxconfigbase}
+\helpref{wxConfigBase}{wxconfigbase}\\
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
 <wx/fileconf.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 
 \helponly{\insertatlevel{2}{\wxheading{Members}}}
 
-\membersection{wxFileConfig::wxFileConfig}{wxfileconfigctorstream}
+\membersection{wxFileConfig::wxFileConfig}\label{wxfileconfigctor}
 
-\func{}{wxFileConfig}{\param{wxInputStream\& }{is}, \param{wxMBConv\& }{conv = wxConvUTF8}}
+\func{}{wxFileConfig}{\param{wxInputStream\& }{is}, \param{const wxMBConv\& }{conv = wxConvAuto()}}
 
 Read the config data from the specified stream instead of the associated file,
 as usual.
@@ -44,9 +49,35 @@ as usual.
 \helpref{Save}{wxfileconfigsave}
 
 
-\membersection{wxFileConfig::Save}{wxfileconfigsave}
+\membersection{wxFileName::GetGlobalFile}\label{wxfilenamegetglobalfile}
+
+\func{static wxFileName}{GetGlobalFile}{\param{const wxString\& }{basename}}
+
+Return the full path to the file which would be used by wxFileConfig as global,
+system-wide, file if it were constructed with \arg{basename} as ``global
+filename'' parameter in the constructor. Notice that this function cannot be
+used if \arg{basename} is already a full path name.
+
+
+\membersection{wxFileName::GetLocalFile}\label{wxfilenamegetlocalfile}
+
+\func{static wxFileName}{GetLocalFile}{\param{const wxString\& }{basename}, \param{int }{style = $0$}}
+
+Return the full path to the file which would be used by wxFileConfig as local,
+user-specific, file if it were constructed with \arg{basename} as ``local
+filename'' parameter in the constructor.
+
+\arg{style} has the same meaning as in \helpref{constructor}{wxconfigbasector} 
+and can contain any combination of styles but only wxCONFIG\_USE\_SUBDIR bit is
+examined by this function.
+
+Notice that this function cannot be used if \arg{basename} is already a full
+path name.
+
+
+\membersection{wxFileConfig::Save}\label{wxfileconfigsave}
 
-\func{bool}{Save}{\param{wxOutputStream\& }{os}, \param{wxMBConv\& }{conv = wxConvUTF8}}
+\func{bool}{Save}{\param{wxOutputStream\& }{os}, \param{const wxMBConv\& }{conv = wxConvAuto()}}
 
 Saves all config data to the given stream, returns \true if data was saved
 successfully or \false on error.