1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name:        fileconf.tex
3%% Purpose:     wxFileConfig documentation
4%% Author:      Vadim Zeitlin
5%% Modified by:
6%% Created:     2004-10-04
7%% RCS-ID:      $Id: fileconf.tex 32309 2005-02-22 15:09:56Z ABX $
8%% Copyright:   (c) 2004 Vadim Zeitlin
9%% License:     wxWindows license
10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12\section{\class{wxFileConfig}}\label{wxfileconfig}
13
14wxFileConfig implements \helpref{wxConfigBase}{wxconfigbase} interface for
15storing and retrieving configuration information using plain text files. The
16files have a simple format reminiscent of Windows INI files with lines of the
17form \texttt{key = value} defining the keys and lines of special form
18\texttt{$[$group$]$} indicating the start of each group.
19
20This class is used by default for wxConfig on Unix platforms but may also be
21used explicitly if you want to use files and not the registry even under
22Windows.
23
24\wxheading{Derived from}
25
26\helpref{wxConfigBase}{wxconfigbase}
27
28\wxheading{Include files}
29
30<wx/fileconf.h>
31
32
33\helponly{\insertatlevel{2}{\wxheading{Members}}}
34
35\membersection{wxFileConfig::wxFileConfig}\label{wxfileconfigctor}
36
37\func{}{wxFileConfig}{\param{wxInputStream\& }{is}, \param{wxMBConv\& }{conv = wxConvUTF8}}
38
39Read the config data from the specified stream instead of the associated file,
40as usual.
41
42\wxheading{See also}
43
44\helpref{Save}{wxfileconfigsave}
45
46
47\membersection{wxFileConfig::Save}\label{wxfileconfigsave}
48
49\func{bool}{Save}{\param{wxOutputStream\& }{os}, \param{wxMBConv\& }{conv = wxConvUTF8}}
50
51Saves all config data to the given stream, returns \true if data was saved
52successfully or \false on error.
53
54Note the interaction of this function with the internal ``dirty flag'': the
55data is saved unconditionally, i.e. even if the object is not dirty. However
56after saving it successfully, the dirty flag is reset so no changes will be
57written back to the file this object is associated with until you change its
58contents again.
59
60\wxheading{See also}
61
62\helpref{Flush}{wxconfigbaseflush}
63
64
65\membersection{wxFileConfig::SetUmask}\label{wxfileconfigsetumask}
66
67\func{void}{SetUmask}{\param{int }{mode}}
68
69Allows to set the mode to be used for the config file creation. For example, to
70create a config file which is not readable by other users (useful if it stores
71some sensitive information, such as passwords), you could use 
72{\tt SetUmask(0077)}.
73
74This function doesn't do anything on non-Unix platforms.
75
76\wxheading{See also}
77
78\helpref{wxCHANGE\_UMASK}{wxchangeumask}
79
80
81
82