/[pcsx2_0.9.7]/trunk/3rdparty/wxWidgets/include/wx/msw/iniconf.h
ViewVC logotype

Contents of /trunk/3rdparty/wxWidgets/include/wx/msw/iniconf.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 10 - (show annotations) (download)
Mon Sep 6 11:40:06 2010 UTC (9 years, 5 months ago) by william
File MIME type: text/plain
File size: 4294 byte(s)
exported r3113 from ./upstream/trunk
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: include/wx/msw/iniconf.h
3 // Purpose: INI-file based wxConfigBase implementation
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 27.07.98
7 // RCS-ID: $Id: iniconf.h 28931 2004-08-27 18:59:37Z ABX $
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _INICONF_H
13 #define _INICONF_H
14
15 // ----------------------------------------------------------------------------
16 // wxIniConfig is a wxConfig implementation which uses MS Windows INI files to
17 // store the data. Because INI files don't really support arbitrary nesting of
18 // groups, we do the following:
19 // (1) in win.ini file we store all entries in the [vendor] section and
20 // the value group1/group2/key is mapped to the value group1_group2_key
21 // in this section, i.e. all path separators are replaced with underscore
22 // (2) in appname.ini file we map group1/group2/group3/key to the entry
23 // group2_group3_key in [group1]
24 //
25 // Of course, it might lead to indesirable results if '_' is also used in key
26 // names (i.e. group/key is the same as group_key) and also GetPath() result
27 // may be not what you would expect it to be.
28 //
29 // Another limitation: the keys and section names are never case-sensitive
30 // which might differ from wxFileConfig it it was compiled with
31 // wxCONFIG_CASE_SENSITIVE option.
32 // ----------------------------------------------------------------------------
33
34 // for this class, "local" file is the file appname.ini and the global file
35 // is the [vendor] subsection of win.ini (default for "vendor" is to be the
36 // same as appname). The file name (strAppName parameter) may, in fact,
37 // contain the full path to the file. If it doesn't, the file is searched for
38 // in the Windows directory.
39 class WXDLLEXPORT wxIniConfig : public wxConfigBase
40 {
41 public:
42 // ctor & dtor
43 // if strAppName doesn't contain the extension and is not an absolute path,
44 // ".ini" is appended to it. if strVendor is empty, it's taken to be the
45 // same as strAppName.
46 wxIniConfig(const wxString& strAppName = wxEmptyString, const wxString& strVendor = wxEmptyString,
47 const wxString& localFilename = wxEmptyString, const wxString& globalFilename = wxEmptyString, long style = wxCONFIG_USE_LOCAL_FILE);
48 virtual ~wxIniConfig();
49
50 // implement inherited pure virtual functions
51 virtual void SetPath(const wxString& strPath);
52 virtual const wxString& GetPath() const;
53
54 virtual bool GetFirstGroup(wxString& str, long& lIndex) const;
55 virtual bool GetNextGroup (wxString& str, long& lIndex) const;
56 virtual bool GetFirstEntry(wxString& str, long& lIndex) const;
57 virtual bool GetNextEntry (wxString& str, long& lIndex) const;
58
59 virtual size_t GetNumberOfEntries(bool bRecursive = false) const;
60 virtual size_t GetNumberOfGroups(bool bRecursive = false) const;
61
62 virtual bool HasGroup(const wxString& strName) const;
63 virtual bool HasEntry(const wxString& strName) const;
64
65 // return true if the current group is empty
66 bool IsEmpty() const;
67
68 virtual bool Flush(bool bCurrentOnly = false);
69
70 virtual bool RenameEntry(const wxString& oldName, const wxString& newName);
71 virtual bool RenameGroup(const wxString& oldName, const wxString& newName);
72
73 virtual bool DeleteEntry(const wxString& Key, bool bGroupIfEmptyAlso = true);
74 virtual bool DeleteGroup(const wxString& szKey);
75 virtual bool DeleteAll();
76
77 protected:
78 // read/write
79 bool DoReadString(const wxString& key, wxString *pStr) const;
80 bool DoReadLong(const wxString& key, long *plResult) const;
81
82 bool DoWriteString(const wxString& key, const wxString& szValue);
83 bool DoWriteLong(const wxString& key, long lValue);
84
85 private:
86 // helpers
87 wxString GetPrivateKeyName(const wxString& szKey) const;
88 wxString GetKeyName(const wxString& szKey) const;
89
90 wxString m_strLocalFilename; // name of the private INI file
91 wxString m_strGroup, // current group in appname.ini file
92 m_strPath; // the rest of the path (no trailing '_'!)
93 };
94
95 #endif //_INICONF_H

  ViewVC Help
Powered by ViewVC 1.1.22