<html>
<head>
<link rel="stylesheet" href="page.css" type="text/css">
<title>fox-toolkit.org - Documentation</title>
</head>
<body bgcolor=#ffffff link=#990033 vlink=#990033 alink=#990033 text=#000000>
<font face='verdana,sans-serif' size=2 >
<!---- TOPIC TITLE WITH LOGO--->
<table border=0 cellpadding= cellspacing=2 width=100% ><tr><td><a href='http://www.fox-toolkit.org/doc.html'><img src='../art/foxlogo_small.jpg' border=0></a></td><td width=100% valign=bottom><font face='verdana,sans-serif' size=2 ><b>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a>
<br><img src='../art/line.gif' width=100% height=1></b></font></td></tr></table>
<p>
<!--- TOPIC TITLE WITH LOGO --->
<!-- Generated by Doxygen 1.3.3 -->
<h1>FXSettings.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* S e t t i n g s C l a s s *</span>
00004 <span class="comment">* *</span>
00005 <span class="comment">*********************************************************************************</span>
00006 <span class="comment">* Copyright (C) 1998,2004 by Jeroen van der Zijp. All Rights Reserved. *</span>
00007 <span class="comment">*********************************************************************************</span>
00008 <span class="comment">* This library is free software; you can redistribute it and/or *</span>
00009 <span class="comment">* modify it under the terms of the GNU Lesser General Public *</span>
00010 <span class="comment">* License as published by the Free Software Foundation; either *</span>
00011 <span class="comment">* version 2.1 of the License, or (at your option) any later version. *</span>
00012 <span class="comment">* *</span>
00013 <span class="comment">* This library is distributed in the hope that it will be useful, *</span>
00014 <span class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
00015 <span class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span>
00016 <span class="comment">* Lesser General Public License for more details. *</span>
00017 <span class="comment">* *</span>
00018 <span class="comment">* You should have received a copy of the GNU Lesser General Public *</span>
00019 <span class="comment">* License along with this library; if not, write to the Free Software *</span>
00020 <span class="comment">* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *</span>
00021 <span class="comment">*********************************************************************************</span>
00022 <span class="comment">* $Id: FXSettings.h,v 1.21 2004/02/08 17:17:34 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXSETTINGS_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXSETTINGS_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXDICT_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXDict.h"</span>
00029 <span class="preprocessor">#endif</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>FX {
00032
00033
00034 <span class="keyword">class </span>FXStringDict;
00035
00036 <span class="comment"></span>
00037 <span class="comment">/**</span>
00038 <span class="comment">* FXSettings is a key-value database. This is normally used as</span>
00039 <span class="comment">* part of FXRegistry, but can also be used separately in application</span>
00040 <span class="comment">* that need to maintain a key-value database of their own.</span>
00041 <span class="comment">*/</span>
<a name="l00042"></a><a class="code" href="classFX_1_1FXSettings.html">00042</a> <span class="keyword">class </span>FXAPI FXSettings : <span class="keyword">public</span> <a class="code" href="classFX_1_1FXDict.html">FXDict</a> {
00043 FXDECLARE(FXSettings)
00044 <span class="keyword">protected</span>:
00045 FXbool modified; <span class="comment">// Changed settings</span>
00046 <span class="keyword">protected</span>:
00047 <span class="keyword">virtual</span> <span class="keywordtype">void</span> *createData(<span class="keyword">const</span> <span class="keywordtype">void</span>*);
00048 <span class="keyword">virtual</span> <span class="keywordtype">void</span> deleteData(<span class="keywordtype">void</span>*);
00049 FXbool parseValue(FXchar* value,<span class="keyword">const</span> FXchar* buffer);
00050 FXbool unparseValue(FXchar* buffer,<span class="keyword">const</span> FXchar* value);
00051 <a class="code" href="classFX_1_1FXStringDict.html">FXStringDict</a>* insert(<span class="keyword">const</span> FXchar* ky){ <span class="keywordflow">return</span> (<a class="code" href="classFX_1_1FXStringDict.html">FXStringDict</a>*)FXDict::insert(ky,NULL); }
00052 <a class="code" href="classFX_1_1FXStringDict.html">FXStringDict</a>* replace(<span class="keyword">const</span> FXchar* ky,<a class="code" href="classFX_1_1FXStringDict.html">FXStringDict</a>* section){ <span class="keywordflow">return</span> (<a class="code" href="classFX_1_1FXStringDict.html">FXStringDict</a>*)FXDict::replace(ky,section,TRUE); }
00053 <a class="code" href="classFX_1_1FXStringDict.html">FXStringDict</a>* remove(<span class="keyword">const</span> FXchar* ky){ <span class="keywordflow">return</span> (<a class="code" href="classFX_1_1FXStringDict.html">FXStringDict</a>*)FXDict::remove(ky); }
00054 <span class="keyword">private</span>:
00055 FXSettings(<span class="keyword">const</span> FXSettings&);
<a name="l00056"></a><a class="code" href="classFX_1_1FXSettings.html#a3">00056</a> FXSettings &operator=(<span class="keyword">const</span> FXSettings&);
00057 <span class="keyword">public</span>:
00058 <span class="comment"></span>
<a name="l00059"></a><a class="code" href="classFX_1_1FXSettings.html#a4">00059</a> <span class="comment"> /// Construct settings database.</span>
00060 <span class="comment"></span> FXSettings();
00061 <span class="comment"></span>
00062 <span class="comment"> /// Parse a file containing a settings database.</span>
00063 <span class="comment"></span> FXbool parseFile(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& filename,FXbool mark);
00064 <span class="comment"></span>
00065 <span class="comment"> /// Unparse settings database into given file.</span>
00066 <span class="comment"></span> FXbool unparseFile(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& filename);
00067 <span class="comment"></span>
00068 <span class="comment"> /// Obtain the string dictionary for the given section</span>
00069 <span class="comment"></span> <a class="code" href="classFX_1_1FXStringDict.html">FXStringDict</a>* data(FXuint pos)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (<a class="code" href="classFX_1_1FXStringDict.html">FXStringDict</a>*)FXDict::data(pos); }
00070 <span class="comment"></span>
00071 <span class="comment"> /// Find string dictionary for the given section</span>
00072 <span class="comment"></span> FXStringDict* find(<span class="keyword">const</span> FXchar *section)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (FXStringDict*)FXDict::find(section); }
00073 <span class="comment"></span>
00074 <span class="comment"> /// Read a formatted registry entry, using scanf-style format</span>
00075 <span class="comment"></span> FXint readFormatEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,<span class="keyword">const</span> FXchar *fmt,...) FX_SCANF(4,5) ;
00076 <span class="comment"></span>
00077 <span class="comment"> /// Read a string registry entry; if no value is found, the default value def is returned</span>
00078 <span class="comment"></span> <span class="keyword">const</span> FXchar *readStringEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,<span class="keyword">const</span> FXchar *def=NULL);
00079 <span class="comment"></span>
00080 <span class="comment"> /// Read a integer registry entry; if no value is found, the default value def is returned</span>
00081 <span class="comment"></span> FXint readIntEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,FXint def=0);
00082 <span class="comment"></span>
00083 <span class="comment"> /// Read a unsigned integer registry entry; if no value is found, the default value def is returned</span>
00084 <span class="comment"></span> FXuint readUnsignedEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,FXuint def=0);
00085 <span class="comment"></span>
00086 <span class="comment"> /// Read a double-precision floating point registry entry; if no value is found, the default value def is returned</span>
00087 <span class="comment"></span> FXdouble readRealEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,FXdouble def=0.0);
00088 <span class="comment"></span>
00089 <span class="comment"> /// Read a color value registry entry; if no value is found, the default value def is returned</span>
00090 <span class="comment"></span> FXColor readColorEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,FXColor def=0);
00091 <span class="comment"></span>
00092 <span class="comment"> /// Write a formatted registry entry, using printf-style format</span>
00093 <span class="comment"></span> FXint writeFormatEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,<span class="keyword">const</span> FXchar *fmt,...) FX_PRINTF(4,5) ;
00094 <span class="comment"></span>
00095 <span class="comment"> /// Write a string registry entry</span>
00096 <span class="comment"></span> FXbool writeStringEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,<span class="keyword">const</span> FXchar *val);
00097 <span class="comment"></span>
00098 <span class="comment"> /// Write a integer registry entry</span>
00099 <span class="comment"></span> FXbool writeIntEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,FXint val);
00100 <span class="comment"></span>
00101 <span class="comment"> /// Write a unsigned integer registry entry</span>
00102 <span class="comment"></span> FXbool writeUnsignedEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,FXuint val);
00103 <span class="comment"></span>
00104 <span class="comment"> /// Write a double-precision floating point registry entry</span>
00105 <span class="comment"></span> FXbool writeRealEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,FXdouble val);
00106 <span class="comment"></span>
00107 <span class="comment"> /// Write a color value entry</span>
00108 <span class="comment"></span> FXbool writeColorEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key,FXColor val);
00109 <span class="comment"></span>
00110 <span class="comment"> /// Delete a registry entry</span>
00111 <span class="comment"></span> FXbool deleteEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key);
00112 <span class="comment"></span>
<a name="l00113"></a><a class="code" href="classFX_1_1FXSettings.html#a22">00113</a> <span class="comment"> /// See if entry exists</span>
00114 <span class="comment"></span> FXbool existingEntry(<span class="keyword">const</span> FXchar *section,<span class="keyword">const</span> FXchar *key);
00115 <span class="comment"></span>
<a name="l00116"></a><a class="code" href="classFX_1_1FXSettings.html#a23">00116</a> <span class="comment"> /// Delete section</span>
00117 <span class="comment"></span> FXbool deleteSection(<span class="keyword">const</span> FXchar *section);
00118 <span class="comment"></span>
00119 <span class="comment"> /// See if section exists</span>
00120 <span class="comment"></span> FXbool existingSection(<span class="keyword">const</span> FXchar *section);
00121 <span class="comment"></span>
00122 <span class="comment"> /// Clear all sections</span>
00123 <span class="comment"></span> FXbool clear();
00124 <span class="comment"></span>
00125 <span class="comment"> /// Mark as changed</span>
00126 <span class="comment"></span> <span class="keywordtype">void</span> setModified(FXbool mdfy=TRUE){ modified=mdfy; }
00127 <span class="comment"></span>
00128 <span class="comment"> /// Is it modified</span>
00129 <span class="comment"></span> FXbool isModified()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> modified; }
00130 <span class="comment"></span>
00131 <span class="comment"> /// Cleanup</span>
00132 <span class="comment"></span> <span class="keyword">virtual</span> ~FXSettings();
00133 };
00134
00135 }
00136
00137 <span class="preprocessor">#endif</span>
</pre></div></font>
<!--- COPYRIGHT -->
<p>
<table width=100% cellpadding=0 cellspacing=0><tr><td width=100% valign=top id=HEADLINE align=right>
<img src='../art/line.gif' width=100% height=1><font size=-1>
Copyright © 1997-2004 Jeroen van der Zijp</font>
</td></tr></table>
</p>
<!--- COPYRIGHT -->
</body>
</html>
