Added documentation
[mdictionary] / doc / html / xdxfplugin_8h_source.html
index a570c0a..e47c936 100644 (file)
@@ -69,85 +69,102 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;QDialog&gt;</span>
 <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QRegExp&gt;</span>
 <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;QTime&gt;</span>
-<a name="l00030"></a>00030 <span class="preprocessor">#include &quot;XdxfDictDialog.h&quot;</span>
-<a name="l00031"></a>00031 
-<a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classTranslationXdxf.html">TranslationXdxf</a>;
-<a name="l00033"></a>00033 
-<a name="l00034"></a><a class="code" href="classXdxfPlugin.html">00034</a> <span class="keyword">class </span><a class="code" href="classXdxfPlugin.html">XdxfPlugin</a> : <span class="keyword">public</span> <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>
-<a name="l00035"></a>00035 {
-<a name="l00036"></a>00036     Q_OBJECT
-<a name="l00037"></a>00037     Q_INTERFACES(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>)
-<a name="l00038"></a>00038 <span class="keyword">public</span>:
-<a name="l00039"></a>00039     <a class="code" href="classXdxfPlugin.html">XdxfPlugin</a>(QObject *parent=0);
-<a name="l00040"></a>00040 
-<a name="l00042"></a>00042     QString <a class="code" href="classXdxfPlugin.html#a512b66dd3e147cc86a2bc3e9418104fc" title="returns source language code iso 639-2">langFrom</a>() <span class="keyword">const</span>;
-<a name="l00043"></a>00043 
-<a name="l00045"></a>00045     QString <a class="code" href="classXdxfPlugin.html#a6969b031c270fd556fcecf0e423c0895" title="returns destination language code iso 639-2">langTo</a>() <span class="keyword">const</span>;
-<a name="l00046"></a>00046 
-<a name="l00048"></a>00048     QString <a class="code" href="classXdxfPlugin.html#a860f2e7375797c80ed4a7eb8bdf1831b" title="returns dictionary name (like &amp;quot;old english&amp;quot; or so)">name</a>() <span class="keyword">const</span>;
-<a name="l00049"></a>00049 
-<a name="l00051"></a>00051     QString <a class="code" href="classXdxfPlugin.html#a1ef22204eed844d74f90b7222a122c5d" title="returns dictionary type (xdxf, google translate, etc)">type</a>() <span class="keyword">const</span>;
-<a name="l00052"></a>00052 
-<a name="l00054"></a>00054     QString <a class="code" href="classXdxfPlugin.html#ab3af2811d200d1901629e5fba8e64eb7" title="returns information about dictionary in html (name, authors, etc)">infoNote</a>() <span class="keyword">const</span>;
-<a name="l00055"></a>00055 
-<a name="l00059"></a>00059     <a class="code" href="classDictDialog.html" title="Interface for plugin dialog provider.">DictDialog</a>* <a class="code" href="classXdxfPlugin.html#ac6cbb0ef522b93927de69e5bfe3f7600" title="returns DictDialog object that creates dialogs for adding new dictionary and change...">dictDialog</a>();
-<a name="l00060"></a>00060 
-<a name="l00061"></a>00061 
-<a name="l00063"></a>00063     <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>* <a class="code" href="classXdxfPlugin.html#a1c1fabf4653655f4f654e0ea31c14539" title="returns 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>;
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;QSqlQuery&gt;</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;QSqlDatabase&gt;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;QSqlError&gt;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &quot;XdxfDictDialog.h&quot;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &quot;XdxfCachingDialog.h&quot;</span>
+<a name="l00035"></a>00035 
+<a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="classTranslationXdxf.html">TranslationXdxf</a>;
+<a name="l00037"></a>00037 
+<a name="l00038"></a><a class="code" href="classXdxfPlugin.html">00038</a> <span class="keyword">class </span><a class="code" href="classXdxfPlugin.html">XdxfPlugin</a> : <span class="keyword">public</span> <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>
+<a name="l00039"></a>00039 {
+<a name="l00040"></a>00040     Q_OBJECT
+<a name="l00041"></a>00041     Q_INTERFACES(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>)
+<a name="l00042"></a>00042 <span class="keyword">public</span>:
+<a name="l00043"></a>00043     <a class="code" href="classXdxfPlugin.html">XdxfPlugin</a>(QObject *parent=0);
+<a name="l00044"></a>00044 
+<a name="l00046"></a>00046     QString <a class="code" href="classXdxfPlugin.html#a512b66dd3e147cc86a2bc3e9418104fc" title="returns source language code iso 639-2">langFrom</a>() <span class="keyword">const</span>;
+<a name="l00047"></a>00047 
+<a name="l00049"></a>00049     QString <a class="code" href="classXdxfPlugin.html#a6969b031c270fd556fcecf0e423c0895" title="returns destination language code iso 639-2">langTo</a>() <span class="keyword">const</span>;
+<a name="l00050"></a>00050 
+<a name="l00052"></a>00052     QString <a class="code" href="classXdxfPlugin.html#a860f2e7375797c80ed4a7eb8bdf1831b" title="returns dictionary name (like &amp;quot;old english&amp;quot; or so)">name</a>() <span class="keyword">const</span>;
+<a name="l00053"></a>00053 
+<a name="l00055"></a>00055     QString <a class="code" href="classXdxfPlugin.html#a1ef22204eed844d74f90b7222a122c5d" title="returns dictionary type (xdxf, google translate, etc)">type</a>() <span class="keyword">const</span>;
+<a name="l00056"></a>00056 
+<a name="l00058"></a>00058     QString <a class="code" href="classXdxfPlugin.html#ab3af2811d200d1901629e5fba8e64eb7" title="returns information about dictionary in html (name, authors, etc)">infoNote</a>() <span class="keyword">const</span>;
+<a name="l00059"></a>00059 
+<a name="l00063"></a>00063     <a class="code" href="classDictDialog.html" title="Interface for plugin dialog provider.">DictDialog</a>* <a class="code" href="classXdxfPlugin.html#ac6cbb0ef522b93927de69e5bfe3f7600" title="returns DictDialog object that creates dialogs for adding new dictionary and change...">dictDialog</a>();
 <a name="l00064"></a>00064 
-<a name="l00066"></a>00066     <span class="keywordtype">bool</span> <a class="code" href="classXdxfPlugin.html#a0a57cddf8db03190a2a49492cc7f43f4" title="returns whether plugin can start searching">isAvailable</a>() <span class="keyword">const</span>;
-<a name="l00067"></a>00067 
-<a name="l00069"></a>00069     QString <a class="code" href="classXdxfPlugin.html#a3439332c8624e64456c0b7b62c99bf42" title="returns a description of a word given by a QString">search</a>(QString key);
-<a name="l00070"></a>00070 
-<a name="l00072"></a>00072     uint <a class="code" href="classXdxfPlugin.html#a5e83f29b2eff00598470bb4b82961973" title="returns a unique hash for a dictionary">hash</a>() <span class="keyword">const</span>;
-<a name="l00073"></a>00073 
-<a name="l00075"></a>00075     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a74b5d40e3fa217a10c6ba790a9433086" title="set unique value (unique for every dictionary not plugin)">setHash</a>(uint);
-<a name="l00076"></a>00076 
-<a name="l00078"></a>00078     <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>* <a class="code" href="classXdxfPlugin.html#a115e0b340b8f9a5099b8f2a4f755dbfc" title="returns current plugin settings">settings</a>();
-<a name="l00079"></a>00079 
-<a name="l00081"></a>00081     <span class="keywordtype">long</span> <a class="code" href="classXdxfPlugin.html#aa52537c4bc22c3ea10ba53a716e9f8b0" title="returns words count in dictionary">wordsCount</a>();
-<a name="l00082"></a>00082 
-<a name="l00084"></a>00084     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a35802d08aadf5a070a7497008099ea47" title="Sets new settings.">setSettings</a>(<a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>*);
-<a name="l00085"></a>00085 
-<a name="l00087"></a>00087     <span class="keyword">virtual</span> QIcon <a class="code" href="classXdxfPlugin.html#a01afa359e9ea2f40935349e7578c8b3b" title="returns plugin icon">icon</a>();
-<a name="l00088"></a>00088 
-<a name="l00089"></a>00089 <span class="keyword">public</span> Q_SLOTS:
-<a name="l00097"></a>00097     QList&lt;Translation*&gt; <a class="code" href="classXdxfPlugin.html#a538581955ba04d1316f1a8befab4d561" title="performs search in dictionary">searchWordList</a>(QString word, <span class="keywordtype">int</span> limit=0);
-<a name="l00098"></a>00098 
-<a name="l00100"></a>00100     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a93d9ca6bbd8cc5b5cbda418f6499025b" title="stop current operation">stop</a>();
-<a name="l00101"></a>00101 
+<a name="l00065"></a>00065 
+<a name="l00067"></a>00067     <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>* <a class="code" href="classXdxfPlugin.html#a1c1fabf4653655f4f654e0ea31c14539" title="returns 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="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>*) <span class="keyword">const</span>;
+<a name="l00068"></a>00068 
+<a name="l00070"></a>00070     <span class="keywordtype">bool</span> <a class="code" href="classXdxfPlugin.html#a0a57cddf8db03190a2a49492cc7f43f4" title="returns whether plugin can start searching">isAvailable</a>() <span class="keyword">const</span>;
+<a name="l00071"></a>00071 
+<a name="l00073"></a>00073     QString <a class="code" href="classXdxfPlugin.html#a3439332c8624e64456c0b7b62c99bf42" title="returns a description of a word given by a QString">search</a>(QString key);
+<a name="l00074"></a>00074 
+<a name="l00076"></a>00076     uint <a class="code" href="classXdxfPlugin.html#a5e83f29b2eff00598470bb4b82961973" title="returns a unique hash for a dictionary">hash</a>() <span class="keyword">const</span>;
+<a name="l00077"></a>00077 
+<a name="l00079"></a>00079     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a74b5d40e3fa217a10c6ba790a9433086" title="set unique value (unique for every dictionary not plugin)">setHash</a>(uint);
+<a name="l00080"></a>00080 
+<a name="l00082"></a>00082     <a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>* <a class="code" href="classXdxfPlugin.html#a115e0b340b8f9a5099b8f2a4f755dbfc" title="returns current plugin settings">settings</a>();
+<a name="l00083"></a>00083 
+<a name="l00085"></a>00085     <span class="keywordtype">long</span> <a class="code" href="classXdxfPlugin.html#aa52537c4bc22c3ea10ba53a716e9f8b0" title="returns words count in dictionary">wordsCount</a>();
+<a name="l00086"></a>00086 
+<a name="l00088"></a>00088     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a35802d08aadf5a070a7497008099ea47" title="Sets new settings.">setSettings</a>(<a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>*);
+<a name="l00089"></a>00089 
+<a name="l00091"></a>00091     <span class="keyword">virtual</span> QIcon* <a class="code" href="classXdxfPlugin.html#a7de7c4707ae4cd34f39c8f305c7cf348" title="returns plugin icon">icon</a>();
+<a name="l00092"></a>00092 
+<a name="l00093"></a>00093 <span class="keyword">public</span> Q_SLOTS:
+<a name="l00101"></a>00101     QList&lt;Translation*&gt; <a class="code" href="classXdxfPlugin.html#a538581955ba04d1316f1a8befab4d561" title="performs search in dictionary">searchWordList</a>(QString word, <span class="keywordtype">int</span> limit=0);
 <a name="l00102"></a>00102 
-<a name="l00103"></a>00103 <span class="keyword">protected</span>:
-<a name="l00104"></a>00104     QString removeAccents(QString);
+<a name="l00104"></a>00104     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a93d9ca6bbd8cc5b5cbda418f6499025b" title="stop current operation">stop</a>();
 <a name="l00105"></a>00105 
-<a name="l00106"></a>00106 <span class="keyword">private</span>:
-<a name="l00110"></a>00110     <span class="keywordtype">bool</span> isCached();
+<a name="l00106"></a>00106 Q_SIGNALS:
+<a name="l00109"></a>00109     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a7f3d10e661ecd0180a0e7f27c4254033">updateCachingProgress</a>(<span class="keywordtype">int</span>, <span class="keywordtype">int</span>);
+<a name="l00110"></a>00110 
 <a name="l00111"></a>00111 
-<a name="l00113"></a>00113     <span class="keywordtype">void</span> setPath(QString);
+<a name="l00112"></a>00112 <span class="keyword">protected</span>:
+<a name="l00113"></a>00113     QString removeAccents(QString);
 <a name="l00114"></a>00114 
-<a name="l00116"></a>00116     QString _langFrom;
-<a name="l00118"></a>00118     QString _langTo;
-<a name="l00120"></a>00120     QString _name;
-<a name="l00122"></a>00122     QString _type;
-<a name="l00124"></a>00124     QString _infoNote;
-<a name="l00125"></a>00125     QDialog *_loadDialog;
-<a name="l00126"></a>00126     QDialog *_settingsDialog;
-<a name="l00128"></a>00128     QString path;
-<a name="l00129"></a>00129     uint _hash;
-<a name="l00130"></a>00130     QIcon _icon;
-<a name="l00131"></a>00131 
-<a name="l00133"></a>00133     <span class="keywordtype">long</span> _wordsCount;
-<a name="l00134"></a>00134 
-<a name="l00136"></a>00136     <span class="keywordtype">void</span> getDictionaryInfo();
-<a name="l00137"></a>00137 
-<a name="l00138"></a>00138     <span class="keyword">volatile</span> <span class="keywordtype">bool</span> stopped;
-<a name="l00139"></a>00139     <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a> *_settings;
-<a name="l00140"></a>00140     <a class="code" href="classXdxfDictDialog.html" title="Implementation of DictDialog interface for xdxf plugin.">XdxfDictDialog</a>* _dictDialog;
-<a name="l00141"></a>00141 };
-<a name="l00142"></a>00142 
-<a name="l00143"></a>00143 <span class="preprocessor">#endif // XDXFPLUGIN_H</span>
-<a name="l00144"></a>00144 <span class="preprocessor"></span>
-<a name="l00145"></a>00145 
+<a name="l00115"></a>00115 <span class="keyword">private</span>:
+<a name="l00119"></a>00119     <span class="keywordtype">bool</span> isCached();
+<a name="l00120"></a>00120 
+<a name="l00122"></a>00122     <span class="keywordtype">void</span> setPath(QString);
+<a name="l00123"></a>00123 
+<a name="l00124"></a>00124     QList&lt;Translation*&gt; searchWordListCache(QString word, <span class="keywordtype">int</span> limit=0);
+<a name="l00125"></a>00125     QList&lt;Translation*&gt; searchWordListFile(QString word, <span class="keywordtype">int</span> limit=0);
+<a name="l00126"></a>00126     QString searchFile(QString key);
+<a name="l00127"></a>00127     QString searchCache(QString key);
+<a name="l00128"></a>00128     <span class="keywordtype">int</span> countWords();
+<a name="l00129"></a>00129     <span class="keywordtype">bool</span> makeCache(QString dir);
+<a name="l00130"></a>00130 
+<a name="l00132"></a>00132     QString _langFrom;
+<a name="l00134"></a>00134     QString _langTo;
+<a name="l00136"></a>00136     QString _name;
+<a name="l00138"></a>00138     QString _type;
+<a name="l00140"></a>00140     QString _infoNote;
+<a name="l00141"></a>00141     QDialog *_loadDialog;
+<a name="l00142"></a>00142     QDialog *_settingsDialog;
+<a name="l00144"></a>00144     QString path;
+<a name="l00145"></a>00145     uint _hash;
+<a name="l00146"></a>00146     QIcon _icon;
+<a name="l00147"></a>00147     QSqlDatabase db;
+<a name="l00148"></a>00148     QString db_name;
+<a name="l00149"></a>00149 
+<a name="l00151"></a>00151     <span class="keywordtype">long</span> _wordsCount;
+<a name="l00152"></a>00152 
+<a name="l00154"></a>00154     <span class="keywordtype">void</span> getDictionaryInfo();
+<a name="l00155"></a>00155 
+<a name="l00156"></a>00156     <span class="keyword">volatile</span> <span class="keywordtype">bool</span> stopped;
+<a name="l00157"></a>00157     <a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a> *_settings;
+<a name="l00158"></a>00158     <a class="code" href="classXdxfDictDialog.html" title="Implementation of DictDialog interface for xdxf plugin.">XdxfDictDialog</a>* _dictDialog;
+<a name="l00159"></a>00159     <a class="code" href="classXdxfCachingDialog.html">XdxfCachingDialog</a>* cachingDialog;
+<a name="l00160"></a>00160 };
+<a name="l00161"></a>00161 
+<a name="l00162"></a>00162 <span class="preprocessor">#endif // XDXFPLUGIN_H</span>
+<a name="l00163"></a>00163 <span class="preprocessor"></span>
+<a name="l00164"></a>00164 
 </pre></div></div>
 <!--- window showing the filter options -->
 <div id="MSearchSelectWindow"
@@ -163,7 +180,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>