Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 2213

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csutil/win32/registrycfg.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/win32/registrycfg.h</h1><a href="registrycfg_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2003 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">              (C) 2003 by Frank Richter</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_CSSYS_WIN32_REGISTRYCFG_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSSYS_WIN32_REGISTRYCFG_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="iutil_2cfgfile_8h.html" title="Configuration file interface.">iutil/cfgfile.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="strhash_8h.html" title="String-to-ID hash table.">csutil/strhash.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">class </span>csWin32RegistryIterator;
<a name="l00034"></a>00034 
<a name="l00043"></a><a class="code" href="classcsWin32RegistryConfig.html">00043</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsWin32RegistryConfig.html" title="An iConfigFile, storing the settings in the Windows registry.">csWin32RegistryConfig</a> : 
<a name="l00044"></a>00044   <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;csWin32RegistryConfig, iConfigFile&gt;
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 <span class="keyword">private</span>:
<a name="l00047"></a><a class="code" href="classcsWin32RegistryConfig.html#2d7cd1dd491a4add6eb378c1b33139d1">00047</a>   <span class="keyword">friend</span> <span class="keyword">class </span>csWin32RegistryIterator;
<a name="l00048"></a>00048 
<a name="l00049"></a>00049   HKEY hKey;
<a name="l00050"></a>00050   HKEY hKeyParent;
<a name="l00051"></a>00051   <span class="keywordtype">char</span>* Prefix;
<a name="l00052"></a>00052   <span class="comment">// whether this key is opened w/ write access.</span>
<a name="l00053"></a>00053   <span class="keywordtype">bool</span> writeAccess;
<a name="l00054"></a>00054   <span class="keywordtype">char</span>* Key;
<a name="l00055"></a>00055 
<a name="l00056"></a>00056   <span class="keyword">typedef</span> <span class="keyword">struct </span>
<a name="l00057"></a>00057   {
<a name="l00058"></a>00058     <a class="code" href="classcsStringHash.html" title="A string-to-ID hash table.">csStringHash</a> strings;
<a name="l00059"></a>00059   } rcStatus;
<a name="l00060"></a>00060   <span class="keyword">mutable</span> rcStatus status;
<a name="l00061"></a>00061 
<a name="l00062"></a>00062   <a class="code" href="classcsArray.html" title="A templated array class.">csArray&lt;csWin32RegistryIterator*&gt;</a> iters;
<a name="l00063"></a>00063 
<a name="l00064"></a>00064   <span class="comment">// convert CS "x.y.z" keys to registry "x\y\z"</span>
<a name="l00065"></a>00065   <span class="keywordtype">void</span> ReplaceSeparators (<span class="keywordtype">char</span>* key) <span class="keyword">const</span>;
<a name="l00066"></a>00066 
<a name="l00067"></a>00067   <span class="keywordtype">bool</span> TryOpen (HKEY parent, HKEY&amp; regKey, DWORD access, <span class="keyword">const</span> <span class="keywordtype">char</span>* keyName, 
<a name="l00068"></a>00068     <span class="keywordtype">bool</span> create);
<a name="l00069"></a>00069 
<a name="l00070"></a>00070   <span class="comment">// convenience class, used to delete[] a buffer on function return</span>
<a name="l00071"></a>00071   <span class="keyword">struct </span>Block_O_Mem
<a name="l00072"></a>00072   {
<a name="l00073"></a>00073     BYTE* data;
<a name="l00074"></a>00074     <span class="keywordtype">size_t</span> size;
<a name="l00075"></a>00075     Block_O_Mem () : data(0), size(0) { }
<a name="l00076"></a>00076     <span class="keywordtype">void</span> Clear() { <span class="keyword">delete</span>[] data; }
<a name="l00077"></a>00077     <span class="keywordtype">void</span> SetSize (<span class="keywordtype">size_t</span> sz) { Clear(); size = sz; data = <span class="keyword">new</span> BYTE[sz]; }
<a name="l00078"></a>00078     ~Block_O_Mem() { Clear(); }
<a name="l00079"></a>00079   };
<a name="l00080"></a>00080   <span class="comment">// To shorten calls to RegSetValueEx()</span>
<a name="l00081"></a>00081   <span class="keywordtype">bool</span> InternalSetValue (<span class="keyword">const</span> <span class="keywordtype">char</span>* Key,
<a name="l00082"></a>00082     DWORD type, <span class="keyword">const</span> <span class="keywordtype">void</span>* data, <span class="keywordtype">size_t</span> datasize);
<a name="l00083"></a>00083   <span class="comment">// To shorten calls to RegQueryValueEx()</span>
<a name="l00084"></a>00084   <span class="keywordtype">bool</span> InternalGetValue (<span class="keyword">const</span> <span class="keywordtype">char</span>* Key,
<a name="l00085"></a>00085     DWORD&amp; type, Block_O_Mem&amp; data) <span class="keyword">const</span>;
<a name="l00086"></a>00086 
<a name="l00087"></a>00087   <span class="comment">/*</span>
<a name="l00088"></a>00088 <span class="comment">    Helper functions to convert the data from the registry to the </span>
<a name="l00089"></a>00089 <span class="comment">    requested format</span>
<a name="l00090"></a>00090 <span class="comment">  */</span>
<a name="l00091"></a>00091   <span class="keywordtype">int</span> RegToInt (DWORD type, Block_O_Mem&amp; data, <span class="keywordtype">int</span> Def) <span class="keyword">const</span>;
<a name="l00092"></a>00092   <span class="keywordtype">float</span> RegToFloat (DWORD type, Block_O_Mem&amp; data, <span class="keywordtype">float</span> Def) <span class="keyword">const</span>;
<a name="l00093"></a>00093   <span class="keyword">const</span> <span class="keywordtype">char</span>* RegToStr (DWORD type, Block_O_Mem&amp; data, <span class="keyword">const</span> <span class="keywordtype">char</span>* Def) <span class="keyword">const</span>;
<a name="l00094"></a>00094   <span class="keywordtype">bool</span> RegToBool (DWORD type, Block_O_Mem&amp; data, <span class="keywordtype">bool</span> Def) <span class="keyword">const</span>;
<a name="l00095"></a>00095 
<a name="l00096"></a>00096   <span class="comment">// Check whether we have registry write access.</span>
<a name="l00097"></a>00097   <span class="keywordtype">bool</span> WriteAccess();
<a name="l00098"></a>00098 <span class="keyword">public</span>:
<a name="l00099"></a>00099 
<a name="l00100"></a>00100   <a class="code" href="classcsWin32RegistryConfig.html" title="An iConfigFile, storing the settings in the Windows registry.">csWin32RegistryConfig</a> ();
<a name="l00101"></a>00101   <span class="keyword">virtual</span> ~<a class="code" href="classcsWin32RegistryConfig.html" title="An iConfigFile, storing the settings in the Windows registry.">csWin32RegistryConfig</a>();
<a name="l00102"></a>00102 
<a name="l00110"></a>00110   <span class="keywordtype">bool</span> Open (<span class="keyword">const</span> <span class="keywordtype">char</span>* Key, HKEY parent = HKEY_CURRENT_USER);
<a name="l00117"></a>00117   <span class="keywordtype">void</span> Close ();
<a name="l00118"></a>00118 
<a name="l00119"></a>00119   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetFileName () <span class="keyword">const</span>;
<a name="l00120"></a>00120   <span class="keyword">virtual</span> <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>* GetVFS () <span class="keyword">const</span>;
<a name="l00121"></a>00121   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetFileName (<span class="keyword">const</span> <span class="keywordtype">char</span>*, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>*);
<a name="l00122"></a>00122   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Load (<span class="keyword">const</span> <span class="keywordtype">char</span>* iFileName, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>* = 0, <span class="keywordtype">bool</span> Merge = <span class="keyword">false</span>,
<a name="l00123"></a>00123     <span class="keywordtype">bool</span> NewWins = <span class="keyword">true</span>);
<a name="l00124"></a>00124   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Save ();
<a name="l00125"></a>00125   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Save (<span class="keyword">const</span> <span class="keywordtype">char</span> *iFileName, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>* = 0);
<a name="l00126"></a>00126   
<a name="l00127"></a>00127   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Clear ();
<a name="l00128"></a>00128   
<a name="l00129"></a>00129   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iConfigIterator&gt;</a> Enumerate (<span class="keyword">const</span> <span class="keywordtype">char</span> *Subsection = 0);
<a name="l00130"></a>00130   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> KeyExists (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key) <span class="keyword">const</span>;
<a name="l00131"></a>00131   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SubsectionExists (<span class="keyword">const</span> <span class="keywordtype">char</span> *Subsection) <span class="keyword">const</span>;
<a name="l00132"></a>00132   
<a name="l00133"></a>00133   <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetInt (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">int</span> Def = 0) <span class="keyword">const</span>;
<a name="l00134"></a>00134   <span class="keyword">virtual</span> <span class="keywordtype">float</span> GetFloat (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">float</span> Def = 0.0) <span class="keyword">const</span>;
<a name="l00135"></a>00135   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetStr (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keyword">const</span> <span class="keywordtype">char</span> *Def = <span class="stringliteral">""</span>) <span class="keyword">const</span>;
<a name="l00136"></a>00136   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> GetBool (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">bool</span> Def = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00137"></a>00137   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetComment (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key) <span class="keyword">const</span>;
<a name="l00138"></a>00138 
<a name="l00139"></a>00139   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetStr (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keyword">const</span> <span class="keywordtype">char</span> *Val);
<a name="l00140"></a>00140   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetInt (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">int</span> Value);
<a name="l00141"></a>00141   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetFloat (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">float</span> Value);
<a name="l00142"></a>00142   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetBool (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">bool</span> Value);
<a name="l00143"></a>00143   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SetComment (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keyword">const</span> <span class="keywordtype">char</span> *Text);
<a name="l00144"></a>00144   <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeleteKey (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key);
<a name="l00145"></a>00145   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetEOFComment () <span class="keyword">const</span>;
<a name="l00146"></a>00146   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetEOFComment (<span class="keyword">const</span> <span class="keywordtype">char</span> *Text);
<a name="l00147"></a>00147 };
<a name="l00148"></a>00148 
<a name="l00149"></a>00149 <span class="preprocessor">#endif</span>
<a name="l00150"></a>00150 <span class="preprocessor"></span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional