Merge branch 'master' of ssh://drop.maemo.org/git/mdictionary into xdxf
[mdictionary] / doc / html / xdxfplugin_8h_source.html
diff --git a/doc/html/xdxfplugin_8h_source.html b/doc/html/xdxfplugin_8h_source.html
new file mode 100644 (file)
index 0000000..2ed508b
--- /dev/null
@@ -0,0 +1,152 @@
+<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>mDictionary: xdxfplugin.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javaScript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body onload='searchBox.OnSelectItem(0);'>
+<!-- Generated by Doxygen 1.6.3 -->
+<script type="text/javascript"><!--
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+--></script>
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+      <li>
+        <div id="MSearchBox" class="MSearchBoxInactive">
+        <img id="MSearchSelect" src="search/search.png"
+             onmouseover="return searchBox.OnSearchSelectShow()"
+             onmouseout="return searchBox.OnSearchSelectHide()"
+             alt=""/>
+        <input type="text" id="MSearchField" value="Search" accesskey="S"
+             onfocus="searchBox.OnSearchFieldFocus(true)" 
+             onblur="searchBox.OnSearchFieldFocus(false)" 
+             onkeyup="searchBox.OnSearchFieldChange(event)"/>
+        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+        </div>
+      </li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    </ul>
+  </div>
+<h1>xdxfplugin.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*******************************************************************************</span>
+<a name="l00002"></a>00002 <span class="comment"></span>
+<a name="l00003"></a>00003 <span class="comment">    This file is part of mDictionary.</span>
+<a name="l00004"></a>00004 <span class="comment"></span>
+<a name="l00005"></a>00005 <span class="comment">    mDictionary is free software: you can redistribute it and/or modify</span>
+<a name="l00006"></a>00006 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
+<a name="l00007"></a>00007 <span class="comment">    the Free Software Foundation, either version 3 of the License, or</span>
+<a name="l00008"></a>00008 <span class="comment">    (at your option) any later version.</span>
+<a name="l00009"></a>00009 <span class="comment"></span>
+<a name="l00010"></a>00010 <span class="comment">    mDictionary 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</span>
+<a name="l00013"></a>00013 <span class="comment">    GNU 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 General Public License</span>
+<a name="l00016"></a>00016 <span class="comment">    along with mDictionary.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
+<a name="l00017"></a>00017 <span class="comment"></span>
+<a name="l00018"></a>00018 <span class="comment">    Copyright 2010 Comarch S.A.</span>
+<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="preprocessor">#ifndef XDXFPLUGIN_H</span>
+<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define XDXFPLUGIN_H</span>
+<a name="l00024"></a>00024 <span class="preprocessor"></span>
+<a name="l00025"></a>00025 <span class="preprocessor">#include &quot;../../../includes/CommonDictInterface.h&quot;</span>
+<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;QObject&gt;</span>
+<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="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="l00080"></a>00080 <span class="keyword">public</span> Q_SLOTS:
+<a name="l00088"></a>00088     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="l00089"></a>00089 
+<a name="l00091"></a>00091     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a93d9ca6bbd8cc5b5cbda418f6499025b" title="stop current operation">stop</a>();
+<a name="l00092"></a>00092 
+<a name="l00093"></a>00093 <span class="keyword">private</span>:
+<a name="l00094"></a>00094     <span class="keywordtype">bool</span> isCached();
+<a name="l00095"></a>00095     <span class="keywordtype">void</span> setPath(QString);
+<a name="l00096"></a>00096     QString _langFrom;
+<a name="l00097"></a>00097     QString _langTo;
+<a name="l00098"></a>00098     QString _name;
+<a name="l00099"></a>00099     QString _type;
+<a name="l00100"></a>00100     QString _infoNote;
+<a name="l00101"></a>00101     QDialog *_loadDialog;
+<a name="l00102"></a>00102     QDialog *_settingsDialog;
+<a name="l00103"></a>00103     QString path;
+<a name="l00104"></a>00104     uint _hash;
+<a name="l00105"></a>00105     <span class="keywordtype">bool</span> stopped;   <span class="comment">/*volatile*/</span>
+<a name="l00106"></a>00106     <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a> *_settings;
+<a name="l00107"></a>00107     <a class="code" href="classXdxfDictDialog.html" title="Implementation of DictDialog interface for xdxf plugin.">XdxfDictDialog</a>* _dictDialog;
+<a name="l00108"></a>00108 };
+<a name="l00109"></a>00109 
+<a name="l00110"></a>00110 <span class="preprocessor">#endif // XDXFPLUGIN_H</span>
+<a name="l00111"></a>00111 <span class="preprocessor"></span>
+<a name="l00112"></a>00112 
+</pre></div></div>
+<!--- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a></div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Aug 6 11:51:04 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>
+</html>