Added generated documentation
[mdictionary] / doc / html / CommonDictInterface_8h_source.html
index 14a8ef6..6fb6996 100644 (file)
@@ -62,42 +62,42 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 <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 <span class="preprocessor">#include &lt;QString&gt;</span>
-<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;QDialog&gt;</span>
-<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;QObject&gt;</span>
-<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;QList&gt;</span>
-<a name="l00027"></a>00027 <span class="preprocessor">#include &quot;CommonDictInterface.h&quot;</span>
-<a name="l00028"></a>00028 <span class="preprocessor">#include &quot;translation.h&quot;</span>
-<a name="l00029"></a>00029 <span class="preprocessor">#include &quot;settings.h&quot;</span>
-<a name="l00030"></a>00030 
-<a name="l00031"></a>00031 
-<a name="l00032"></a>00032 
-<a name="l00034"></a><a class="code" href="classCommonDictInterface.html">00034</a> <span class="keyword">class </span><a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a> : <span class="keyword">public</span> QObject {
-<a name="l00035"></a>00035   Q_OBJECT
-<a name="l00036"></a>00036   <span class="keyword">public</span>:
-<a name="l00037"></a>00037     <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>(<span class="keyword">const</span> QObject *parent = 0) = 0;
-<a name="l00038"></a>00038 
-<a name="l00040"></a>00040     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#a7f8b41dbaa0a5bdcb500c048ca501246" title="returns source language code iso 639-2">langFrom</a>() <span class="keyword">const</span> = 0; 
-<a name="l00041"></a>00041 
-<a name="l00043"></a>00043     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#a9ca51f27e6f4fc159a733849d2434707" title="returns destination language code iso 639-2">langTo</a>() <span class="keyword">const</span> = 0;
-<a name="l00044"></a>00044 
-<a name="l00046"></a>00046     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#ab4ee01f92feb9cacb38cb3f326e7944a" title="returns dictionary name (like &amp;quot;old english&amp;quot; or so">name</a>() <span class="keyword">const</span> = 0;
-<a name="l00047"></a>00047 
-<a name="l00049"></a>00049     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#af8739606ccb6314b40861f42bf45643d" title="returns dictionary type (xdxf, google translate, etc)">type</a>() <span class="keyword">const</span> = 0;        
-<a name="l00050"></a>00050 
-<a name="l00052"></a>00052     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#aedd525079e04426d5cad9f6b9e117191" title="returns information about dictionary in html (name, authors, etc)">infoNote</a>() <span class="keyword">const</span> = 0; 
-<a name="l00053"></a>00053 
-<a name="l00056"></a>00056     <span class="keyword">virtual</span> QDialog* <a class="code" href="classCommonDictInterface.html#a501cea622d6cb2344592bd06dcae0ac0">loadDialog</a>() = 0;  
-<a name="l00057"></a>00057 
-<a name="l00059"></a>00059     <span class="keyword">virtual</span> QDialog* <a class="code" href="classCommonDictInterface.html#a4771687035b2c4cb02ee37532b621907" title="return dialog with dictionary settings">settingsDialog</a>() = 0;
-<a name="l00060"></a>00060 
-<a name="l00062"></a>00062     <span class="keyword">virtual</span> <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>* <a class="code" href="classCommonDictInterface.html#a319be492dd57d6e2828da2424cb57bb0" title="return new, clean copy of plugin with setting set as in Settings*">getNew</a>(<span class="keyword">const</span> <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>*) <span class="keyword">const</span> = 0;
-<a name="l00063"></a>00063 
-<a name="l00065"></a>00065     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classCommonDictInterface.html#a72115c2e4a6c6e57d8adfbc240a2e942" title="returns whether plugin can start searching">isAvailable</a>() <span class="keyword">const</span> = 0;
-<a name="l00066"></a>00066 
-<a name="l00068"></a>00068     <span class="keyword">virtual</span> uint <a class="code" href="classCommonDictInterface.html#a0b58ce9f287e73155b3b4c43e81ae65a">hash</a>() <span class="keyword">const</span> = 0;
-<a name="l00069"></a>00069 
-<a name="l00070"></a>00070 
+<a name="l00023"></a>00023 
+<a name="l00024"></a>00024 
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef COMMONDICTINTERFACE_H</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define COMMONDICTINTERFACE_H</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QString&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;QDialog&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;QObject&gt;</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;QList&gt;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &quot;translation.h&quot;</span>
+<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>;
+<a name="l00034"></a>00034 
+<a name="l00035"></a>00035 
+<a name="l00036"></a>00036 
+<a name="l00038"></a><a class="code" href="classCommonDictInterface.html">00038</a> <span class="keyword">class </span><a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a> : <span class="keyword">public</span> QObject {
+<a name="l00039"></a>00039   Q_OBJECT
+<a name="l00040"></a>00040   <span class="keyword">public</span>:
+<a name="l00042"></a>00042     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#a7f8b41dbaa0a5bdcb500c048ca501246" title="returns source language code iso 639-2">langFrom</a>() <span class="keyword">const</span> = 0; 
+<a name="l00043"></a>00043 
+<a name="l00045"></a>00045     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#a9ca51f27e6f4fc159a733849d2434707" title="returns destination language code iso 639-2">langTo</a>() <span class="keyword">const</span> = 0;
+<a name="l00046"></a>00046 
+<a name="l00048"></a>00048     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#ab4ee01f92feb9cacb38cb3f326e7944a" title="returns dictionary name (like &amp;quot;old english&amp;quot; or so">name</a>() <span class="keyword">const</span> = 0;
+<a name="l00049"></a>00049 
+<a name="l00051"></a>00051     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#af8739606ccb6314b40861f42bf45643d" title="returns dictionary type (xdxf, google translate, etc)">type</a>() <span class="keyword">const</span> = 0;        
+<a name="l00052"></a>00052 
+<a name="l00054"></a>00054     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#aedd525079e04426d5cad9f6b9e117191" title="returns information about dictionary in html (name, authors, etc)">infoNote</a>() <span class="keyword">const</span> = 0; 
+<a name="l00055"></a>00055 
+<a name="l00058"></a>00058     <span class="keyword">virtual</span> QDialog* <a class="code" href="classCommonDictInterface.html#a501cea622d6cb2344592bd06dcae0ac0">loadDialog</a>() = 0;  
+<a name="l00059"></a>00059 
+<a name="l00061"></a>00061     <span class="keyword">virtual</span> QDialog* <a class="code" href="classCommonDictInterface.html#a4771687035b2c4cb02ee37532b621907" title="return dialog with dictionary settings">settingsDialog</a>() = 0;
+<a name="l00062"></a>00062 
+<a name="l00064"></a>00064     <span class="keyword">virtual</span> <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>* <a class="code" href="classCommonDictInterface.html#a319be492dd57d6e2828da2424cb57bb0" title="return new, clean copy of plugin with setting set as in Settings*">getNew</a>(<span class="keyword">const</span> <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>*) <span class="keyword">const</span> = 0;
+<a name="l00065"></a>00065 
+<a name="l00067"></a>00067     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classCommonDictInterface.html#a72115c2e4a6c6e57d8adfbc240a2e942" title="returns whether plugin can start searching">isAvailable</a>() <span class="keyword">const</span> = 0;
+<a name="l00068"></a>00068 
+<a name="l00070"></a>00070     <span class="keyword">virtual</span> uint <a class="code" href="classCommonDictInterface.html#a0b58ce9f287e73155b3b4c43e81ae65a">hash</a>() <span class="keyword">const</span> = 0;
 <a name="l00071"></a>00071 
 <a name="l00072"></a>00072  <span class="keyword">public</span> Q_SLOTS:
 <a name="l00081"></a>00081     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCommonDictInterface.html#a23e1436f452272cf596e76957fe69796" title="performes search in dictionary">search</a>(QString word, <span class="keywordtype">int</span> limit) = 0;                         
@@ -108,7 +108,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 <a name="l00088"></a>00088     <span class="keywordtype">void</span> <a class="code" href="classCommonDictInterface.html#ae66cd415262fa4d3e9bd7bef776c197e" title="emit list of finded Translations">finalTranslation</a>(QList&lt;Translation*&gt;);
 <a name="l00089"></a>00089 
 <a name="l00091"></a>00091     <span class="keywordtype">void</span> <a class="code" href="classCommonDictInterface.html#abeb1426ae67ac8bc43002756b0cc9308" title="emited after dictionary is ready to use afer being loaded">loaded</a>(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>*);
-<a name="l00092"></a>00092 }
+<a name="l00092"></a>00092 };
+<a name="l00093"></a>00093 
+<a name="l00094"></a>00094 Q_DECLARE_INTERFACE(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>, <span class="stringliteral">&quot;CommonDictInterface/0.1&quot;</span>);
+<a name="l00095"></a>00095 <span class="preprocessor">#endif</span>
 </pre></div></div>
 <!--- window showing the filter options -->
 <div id="MSearchSelectWindow"
@@ -124,7 +127,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </iframe>
 </div>
 
-<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Aug 3 12:24:19 2010 for mDictionary by&nbsp;
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 4 12:02:54 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>