Merge branch 'master' of ssh://drop.maemo.org/git/mdictionary into xdxf

[mdictionary] / doc / html / classCommonDictInterface.html

diff --git a/doc/html/classCommonDictInterface.html b/doc/html/classCommonDictInterface.html
index 3030cc3..d5c74a2 100644 (file)
--- a/doc/html/classCommonDictInterface.html
+++ b/doc/html/classCommonDictInterface.html
@@ -49,23 +49,32 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 <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 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a23e1436f452272cf596e76957fe69796">search</a> (QString word, int limit)=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">performes search in dictionary  <a href="#a23e1436f452272cf596e76957fe69796"></a><br/></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#a3ca9313571e0ecab66ce7a7c5d356f4f">searchWordList</a> (QString word, int limit)=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">performs search in dictionary  <a href="#a3ca9313571e0ecab66ce7a7c5d356f4f"></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">stop 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="ae66cd415262fa4d3e9bd7bef776c197e"></a><!-- doxytag: member="CommonDictInterface::finalTranslation" ref="ae66cd415262fa4d3e9bd7bef776c197e" args="(QList&lt; Translation * &gt;)" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#ae66cd415262fa4d3e9bd7bef776c197e">finalTranslation</a> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;)</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emit list of finded Translations <br/></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 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>
@@ -81,17 +90,25 @@ virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el"
 <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">virtual QDialog *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a501cea622d6cb2344592bd06dcae0ac0">loadDialog</a> ()=0</td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4771687035b2c4cb02ee37532b621907"></a><!-- doxytag: member="CommonDictInterface::settingsDialog" ref="a4771687035b2c4cb02ee37532b621907" args="()=0" -->
-virtual QDialog *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a4771687035b2c4cb02ee37532b621907">settingsDialog</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return dialog with dictionary settings <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">return 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">set 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>
 </table>
 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 <p>Interface for dict engines plugins. </p>
@@ -112,32 +129,16 @@ virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" hr
 <div class="memdoc">
 <dl class="return"><dt><b>Returns:</b></dt><dd>unique value (unique for every dictionary not plugin </dd></dl>
 
-</div>
-</div>
-<a class="anchor" id="a501cea622d6cb2344592bd06dcae0ac0"></a><!-- doxytag: member="CommonDictInterface::loadDialog" ref="a501cea622d6cb2344592bd06dcae0ac0" args="()=0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual QDialog* CommonDictInterface::loadDialog </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td><code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>return dialog that creates new dictionary and fills necesary options QDialog should returns Setting* object after being showed </p>
+<p>Implemented in <a class="el" href="classXdxfPlugin.html#a5e83f29b2eff00598470bb4b82961973">XdxfPlugin</a>.</p>
 
 </div>
 </div>
-<a class="anchor" id="a23e1436f452272cf596e76957fe69796"></a><!-- doxytag: member="CommonDictInterface::search" ref="a23e1436f452272cf596e76957fe69796" args="(QString word, int limit)=0" -->
+<a class="anchor" id="a3ca9313571e0ecab66ce7a7c5d356f4f"></a><!-- doxytag: member="CommonDictInterface::searchWordList" ref="a3ca9313571e0ecab66ce7a7c5d356f4f" args="(QString word, int limit)=0" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">virtual void CommonDictInterface::search </td>
+          <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>
@@ -157,7 +158,7 @@ virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" hr
 </div>
 <div class="memdoc">
 
-<p>performes search in dictionary </p>
+<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>
@@ -166,13 +167,14 @@ virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" hr
   </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>:<a class="el" href="classCommonDictInterface.html#ae66cd415262fa4d3e9bd7bef776c197e" title="emit list of finded Translations">finalTranslation</a> <a class="el" href="classCommonDictInterface.html#ae66cd415262fa4d3e9bd7bef776c197e" title="emit list of finded Translations">finalTranslation</a> </dd></dl>
+<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>
+<hr/>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="CommonDictInterface_8h_source.html">CommonDictInterface.h</a></li>
-<li>moc_CommonDictInterface.cpp</li>
 </ul>
 </div>
 <!--- window showing the filter options -->
@@ -189,7 +191,7 @@ virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" hr
 </iframe>
 </div>
 
-<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 4 12:02:54 2010 for mDictionary by&nbsp;
+<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>