Added documentation
[mdictionary] / doc / html / settings_8h_source.html
index f25b89a..7275885 100644 (file)
@@ -61,44 +61,42 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 <a name="l00019"></a>00019 <span class="comment"></span>
 <a name="l00020"></a>00020 <span class="comment">*******************************************************************************/</span>
 <a name="l00021"></a>00021 
-<a name="l00022"></a>00022 <span class="comment">//Created by Bartosz Szatkowski</span>
-<a name="l00023"></a>00023 
-<a name="l00024"></a>00024 <span class="preprocessor">#ifndef SETTINGS_H</span>
-<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define SETTINGS_H</span>
-<a name="l00026"></a>00026 <span class="preprocessor"></span>
-<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;QString&gt;</span>
-<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QHash&gt;</span>
-<a name="l00029"></a>00029 <span class="preprocessor">#include &quot;CommonDictInterface.h&quot;</span>
-<a name="l00030"></a>00030 
-<a name="l00031"></a>00031 <span class="keyword">class </span><a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>;
-<a name="l00032"></a>00032 
-<a name="l00034"></a><a class="code" href="classSettings.html">00034</a> <span class="keyword">class </span><a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a> {
-<a name="l00035"></a>00035   <span class="keyword">public</span>:
-<a name="l00036"></a>00036     <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>(){}
-<a name="l00037"></a>00037     <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>(<span class="keyword">const</span> <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>* <span class="keyword">set</span>) {
-<a name="l00038"></a>00038         _settings = QHash&lt;QString, QString&gt;(<span class="keyword">set</span>-&gt;_settings);
-<a name="l00039"></a>00039     }
-<a name="l00040"></a>00040 
-<a name="l00044"></a><a class="code" href="classSettings.html#ad20672a43255a3bec46b1bc085f2f6eb">00044</a>     QString <a class="code" href="classSettings.html#ad20672a43255a3bec46b1bc085f2f6eb">value</a>(<span class="keyword">const</span> QString key)<span class="keyword"> const </span>{
-<a name="l00045"></a>00045         <span class="keywordflow">if</span>(!_settings.contains(key)) {
-<a name="l00046"></a>00046             <span class="keywordflow">return</span> QString();
-<a name="l00047"></a>00047         }
-<a name="l00048"></a>00048         <span class="keywordflow">return</span> _settings[key];
-<a name="l00049"></a>00049     }
-<a name="l00050"></a>00050 
-<a name="l00052"></a><a class="code" href="classSettings.html#ab7388c1a9a18e3afd79de5393ca9803a">00052</a>     <span class="keywordtype">void</span> <a class="code" href="classSettings.html#ab7388c1a9a18e3afd79de5393ca9803a" title="sets key to value">setValue</a>(<span class="keyword">const</span> QString key, <span class="keyword">const</span> QString <a class="code" href="classSettings.html#ad20672a43255a3bec46b1bc085f2f6eb">value</a>) {
-<a name="l00053"></a>00053         _settings.insert(key, value);
-<a name="l00054"></a>00054     }
-<a name="l00055"></a>00055 
-<a name="l00056"></a>00056     QList&lt;QString&gt; keys()<span class="keyword"> const </span>{
-<a name="l00057"></a>00057         <span class="keywordflow">return</span> _settings.keys();
-<a name="l00058"></a>00058     }
-<a name="l00059"></a>00059 
-<a name="l00060"></a>00060 <span class="keyword">private</span>:
-<a name="l00061"></a>00061     QHash&lt;QString, QString&gt; _settings;
-<a name="l00062"></a>00062 };
+<a name="l00028"></a>00028 <span class="preprocessor">#ifndef SETTINGS_H</span>
+<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define SETTINGS_H</span>
+<a name="l00030"></a>00030 <span class="preprocessor"></span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;QString&gt;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;QHash&gt;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &quot;CommonDictInterface.h&quot;</span>
+<a name="l00034"></a>00034 
+<a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>;
+<a name="l00036"></a>00036 
+<a name="l00042"></a><a class="code" href="classSettings.html">00042</a> <span class="keyword">class </span><a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a> {
+<a name="l00043"></a>00043   <span class="keyword">public</span>:
+<a name="l00044"></a>00044     <a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>(){}
+<a name="l00045"></a>00045     <a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>(<span class="keyword">const</span> <a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>* <span class="keyword">set</span>) {
+<a name="l00046"></a>00046         _settings = QHash&lt;QString, QString&gt;(<span class="keyword">set</span>-&gt;_settings);
+<a name="l00047"></a>00047     }
+<a name="l00048"></a>00048 
+<a name="l00052"></a><a class="code" href="classSettings.html#ad20672a43255a3bec46b1bc085f2f6eb">00052</a>     QString <a class="code" href="classSettings.html#ad20672a43255a3bec46b1bc085f2f6eb">value</a>(<span class="keyword">const</span> QString key)<span class="keyword"> const </span>{
+<a name="l00053"></a>00053         <span class="keywordflow">if</span>(!_settings.contains(key)) {
+<a name="l00054"></a>00054             <span class="keywordflow">return</span> QString();
+<a name="l00055"></a>00055         }
+<a name="l00056"></a>00056         <span class="keywordflow">return</span> _settings[key];
+<a name="l00057"></a>00057     }
+<a name="l00058"></a>00058 
+<a name="l00060"></a><a class="code" href="classSettings.html#ab7388c1a9a18e3afd79de5393ca9803a">00060</a>     <span class="keywordtype">void</span> <a class="code" href="classSettings.html#ab7388c1a9a18e3afd79de5393ca9803a" title="sets key to value">setValue</a>(<span class="keyword">const</span> QString key, <span class="keyword">const</span> QString <a class="code" href="classSettings.html#ad20672a43255a3bec46b1bc085f2f6eb">value</a>) {
+<a name="l00061"></a>00061         _settings.insert(key, value);
+<a name="l00062"></a>00062     }
 <a name="l00063"></a>00063 
-<a name="l00064"></a>00064 <span class="preprocessor">#endif // SETTINGS_H</span>
+<a name="l00064"></a>00064     QList&lt;QString&gt; keys()<span class="keyword"> const </span>{
+<a name="l00065"></a>00065         <span class="keywordflow">return</span> _settings.keys();
+<a name="l00066"></a>00066     }
+<a name="l00067"></a>00067 
+<a name="l00068"></a>00068 <span class="keyword">private</span>:
+<a name="l00069"></a>00069     QHash&lt;QString, QString&gt; _settings;
+<a name="l00070"></a>00070 };
+<a name="l00071"></a>00071 
+<a name="l00072"></a>00072 <span class="preprocessor">#endif // SETTINGS_H</span>
 </pre></div></div>
 <!--- window showing the filter options -->
 <div id="MSearchSelectWindow"
@@ -114,7 +112,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </iframe>
 </div>
 
-<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 12 14:34:59 2010 for mDictionary by&nbsp;
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 </body>