Changed repo structure
[mdictionary] / doc / html / classCommonDictInterface.html
diff --git a/doc/html/classCommonDictInterface.html b/doc/html/classCommonDictInterface.html
deleted file mode 100644 (file)
index f147776..0000000
+++ /dev/null
@@ -1,208 +0,0 @@
-<!-- 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: CommonDictInterface Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
-      <li><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="annotated.html"><span>Class&nbsp;List</span></a></li>
-      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
-      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
-    </ul>
-  </div>
-</div>
-<div class="contents">
-<h1>CommonDictInterface Class Reference</h1><!-- doxytag: class="CommonDictInterface" -->
-<p>Interface for dict engines plugins.  
-<a href="#_details">More...</a></p>
-
-<p><code>#include &lt;<a class="el" href="CommonDictInterface_8h_source.html">CommonDictInterface.h</a>&gt;</code></p>
-<div class="dynheader">
-Inheritance diagram for CommonDictInterface:</div>
-<div class="dynsection">
- <div class="center">
-  <img src="classCommonDictInterface.png" usemap="#CommonDictInterface_map" alt=""/>
-  <map id="CommonDictInterface_map" name="CommonDictInterface_map">
-<area href="classXdxfPlugin.html" alt="XdxfPlugin" shape="rect" coords="0,56,132,80"/>
-</map>
- </div>
-</div>
-
-<p><a href="classCommonDictInterface-members.html">List of all members.</a></p>
-<table border="0" cellpadding="0" cellspacing="0">
-<tr><td colspan="2"><h2>Public Slots</h2></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a27594c22d4df398e98af85b40b7407cb">searchWordList</a> (QString word, int limit=0)=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">performs search in dictionary  <a href="#a27594c22d4df398e98af85b40b7407cb"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a017f37eed4270d37cd5df36e546aacc6"></a><!-- doxytag: member="CommonDictInterface::stop" ref="a017f37eed4270d37cd5df36e546aacc6" args="()=0" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a017f37eed4270d37cd5df36e546aacc6">stop</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stops current operation <br/></td></tr>
-<tr><td colspan="2"><h2>Signals</h2></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abeb1426ae67ac8bc43002756b0cc9308"></a><!-- doxytag: member="CommonDictInterface::loaded" ref="abeb1426ae67ac8bc43002756b0cc9308" args="(CommonDictInterface *)" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#abeb1426ae67ac8bc43002756b0cc9308">loaded</a> (<a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *)</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emited after dictionary is ready to use afer being loaded <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb500dfe5e18f544a01d5fa5352c3d36"></a><!-- doxytag: member="CommonDictInterface::settingsChanged" ref="aeb500dfe5e18f544a01d5fa5352c3d36" args="()" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#aeb500dfe5e18f544a01d5fa5352c3d36">settingsChanged</a> ()</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emited after change dictionary settings <br/></td></tr>
-<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c769e72d6832629d73c987ee9bb5840"></a><!-- doxytag: member="CommonDictInterface::CommonDictInterface" ref="a8c769e72d6832629d73c987ee9bb5840" args="(QObject *parent=0)" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><b>CommonDictInterface</b> (QObject *parent=0)</td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f8b41dbaa0a5bdcb500c048ca501246"></a><!-- doxytag: member="CommonDictInterface::langFrom" ref="a7f8b41dbaa0a5bdcb500c048ca501246" args="() const =0" -->
-virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a7f8b41dbaa0a5bdcb500c048ca501246">langFrom</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns source language code iso 639-2 <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ca51f27e6f4fc159a733849d2434707"></a><!-- doxytag: member="CommonDictInterface::langTo" ref="a9ca51f27e6f4fc159a733849d2434707" args="() const =0" -->
-virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a9ca51f27e6f4fc159a733849d2434707">langTo</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns destination language code iso 639-2 <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4ee01f92feb9cacb38cb3f326e7944a"></a><!-- doxytag: member="CommonDictInterface::name" ref="ab4ee01f92feb9cacb38cb3f326e7944a" args="() const =0" -->
-virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#ab4ee01f92feb9cacb38cb3f326e7944a">name</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns dictionary name (like "old english" or so <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8739606ccb6314b40861f42bf45643d"></a><!-- doxytag: member="CommonDictInterface::type" ref="af8739606ccb6314b40861f42bf45643d" args="() const =0" -->
-virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#af8739606ccb6314b40861f42bf45643d">type</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns dictionary type (xdxf, google translate, etc) <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedd525079e04426d5cad9f6b9e117191"></a><!-- doxytag: member="CommonDictInterface::infoNote" ref="aedd525079e04426d5cad9f6b9e117191" args="() const =0" -->
-virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#aedd525079e04426d5cad9f6b9e117191">infoNote</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns information about dictionary in html (name, authors, etc) <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbbe216cdb93e0324cf4a6946e8e7af1"></a><!-- doxytag: member="CommonDictInterface::dictDialog" ref="adbbe216cdb93e0324cf4a6946e8e7af1" args="()=0" -->
-virtual <a class="el" href="classDictDialog.html">DictDialog</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#adbbe216cdb93e0324cf4a6946e8e7af1">dictDialog</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns <a class="el" href="classDictDialog.html" title="Interface for plugin dialog provider.">DictDialog</a> object that creates dialogs for adding new dictionary and change plugin settings <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a319be492dd57d6e2828da2424cb57bb0"></a><!-- doxytag: member="CommonDictInterface::getNew" ref="a319be492dd57d6e2828da2424cb57bb0" args="(const Settings *) const =0" -->
-virtual <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a319be492dd57d6e2828da2424cb57bb0">getNew</a> (const <a class="el" href="classSettings.html">Settings</a> *) const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns new, clean copy of plugin with setting set as in Settings* <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72115c2e4a6c6e57d8adfbc240a2e942"></a><!-- doxytag: member="CommonDictInterface::isAvailable" ref="a72115c2e4a6c6e57d8adfbc240a2e942" args="() const =0" -->
-virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a72115c2e4a6c6e57d8adfbc240a2e942">isAvailable</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns whether plugin can start searching <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af40b38d2c1eafd7f5dd70d29e8333f81"></a><!-- doxytag: member="CommonDictInterface::search" ref="af40b38d2c1eafd7f5dd70d29e8333f81" args="(QString key)=0" -->
-virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#af40b38d2c1eafd7f5dd70d29e8333f81">search</a> (QString key)=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the actual translation of a word given in key <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual uint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a0b58ce9f287e73155b3b4c43e81ae65a">hash</a> () const =0</td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ccd6318ae40727de5e66a92cf2fc95e"></a><!-- doxytag: member="CommonDictInterface::setHash" ref="a3ccd6318ae40727de5e66a92cf2fc95e" args="(uint)=0" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a3ccd6318ae40727de5e66a92cf2fc95e">setHash</a> (uint)=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets unique value (unique for every dictionary not plugin) <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a20fee14fa5255a1e34e213c93afbe7"></a><!-- doxytag: member="CommonDictInterface::settings" ref="a7a20fee14fa5255a1e34e213c93afbe7" args="()=0" -->
-virtual <a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a7a20fee14fa5255a1e34e213c93afbe7">settings</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns current plugin settings <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb5213c49053122f9d8c6d0c1d2c222d"></a><!-- doxytag: member="CommonDictInterface::icon" ref="afb5213c49053122f9d8c6d0c1d2c222d" args="()=0" -->
-virtual QIcon *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#afb5213c49053122f9d8c6d0c1d2c222d">icon</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns plugin icon <br/></td></tr>
-</table>
-<hr/><a name="_details"></a><h2>Detailed Description</h2>
-<p>Interface for dict engines plugins. </p>
-<hr/><h2>Member Function Documentation</h2>
-<a class="anchor" id="a0b58ce9f287e73155b3b4c43e81ae65a"></a><!-- doxytag: member="CommonDictInterface::hash" ref="a0b58ce9f287e73155b3b4c43e81ae65a" args="() const =0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual uint CommonDictInterface::hash </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td> const<code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<dl class="return"><dt><b>Returns:</b></dt><dd>unique value (unique for every dictionary not plugin </dd></dl>
-
-<p>Implemented in <a class="el" href="classXdxfPlugin.html#a5e83f29b2eff00598470bb4b82961973">XdxfPlugin</a>.</p>
-
-</div>
-</div>
-<a class="anchor" id="a27594c22d4df398e98af85b40b7407cb"></a><!-- doxytag: member="CommonDictInterface::searchWordList" ref="a27594c22d4df398e98af85b40b7407cb" args="(QString word, int limit=0)=0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual QList&lt;<a class="el" href="classTranslation.html">Translation</a>*&gt; CommonDictInterface::searchWordList </td>
-          <td>(</td>
-          <td class="paramtype">QString&nbsp;</td>
-          <td class="paramname"> <em>word</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">int&nbsp;</td>
-          <td class="paramname"> <em>limit</em> = <code>0</code></td><td>&nbsp;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td><td><code> [pure virtual, slot]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-
-<p>performs search in dictionary </p>
-<dl><dt><b>Parameters:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>word to search in dictionary </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>limit</em>&nbsp;</td><td>limit on number of results, if limit=0 all matching words are returned</td></tr>
-  </table>
-  </dd>
-</dl>
-<p>After finishing search it have to emit </p>
-<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>:finalTranslation finalTranslation </dd></dl>
-
-<p>Implemented in <a class="el" href="classXdxfPlugin.html#a538581955ba04d1316f1a8befab4d561">XdxfPlugin</a>.</p>
-
-</div>
-</div>
-<hr/>The documentation for this class was generated from the following files:<ul>
-<li><a class="el" href="CommonDictInterface_8h_source.html">CommonDictInterface.h</a></li>
-<li>base/moc_CommonDictInterface.cpp</li>
-<li>base-build-desktop/moc_CommonDictInterface.cpp</li>
-<li>plugins/xdxf/src/moc_CommonDictInterface.cpp</li>
-<li>plugins/xdxf/tests/moc_CommonDictInterface.cpp</li>
-</ul>
-</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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><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 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>
-</html>