git.maemo.org Git - mdictionary/blob - doc/html/classCommonDictInterface.html

   1 <!-- This comment will put IE 6, 7 and 8 in quirks mode -->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <title>mDictionary: CommonDictInterface Class Reference</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <link href="search/search.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javaScript" src="search/search.js"></script>
  10 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  11 </head>
  12 <body onload='searchBox.OnSelectItem(0);'>
  13 <!-- Generated by Doxygen 1.6.3 -->
  14 <script type="text/javascript"><!--
  15 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  16 --></script>
  17 <div class="navigation" id="top">
  18   <div class="tabs">
  19     <ul>
  20       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  21       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  22       <li><a href="files.html"><span>Files</span></a></li>
  23       <li>
  24         <div id="MSearchBox" class="MSearchBoxInactive">
  25         <img id="MSearchSelect" src="search/search.png"
  26              onmouseover="return searchBox.OnSearchSelectShow()"
  27              onmouseout="return searchBox.OnSearchSelectHide()"
  28              alt=""/>
  29         <input type="text" id="MSearchField" value="Search" accesskey="S"
  30              onfocus="searchBox.OnSearchFieldFocus(true)"
  31              onblur="searchBox.OnSearchFieldFocus(false)"
  32              onkeyup="searchBox.OnSearchFieldChange(event)"/>
  33         <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  34         </div>
  35       </li>
  36     </ul>
  37   </div>
  38   <div class="tabs">
  39     <ul>
  40       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  41       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  42       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  43     </ul>
  44   </div>
  45 </div>
  46 <div class="contents">
  47 <h1>CommonDictInterface Class Reference</h1><!-- doxytag: class="CommonDictInterface" -->
  48 <p>Interface for dict engines plugins.
  49 <a href="#_details">More...</a></p>
  50
  51 <p><code>#include &lt;<a class="el" href="CommonDictInterface_8h_source.html">CommonDictInterface.h</a>&gt;</code></p>
  52 <div class="dynheader">
  53 Inheritance diagram for CommonDictInterface:</div>
  54 <div class="dynsection">
  55  <div class="center">
  56   <img src="classCommonDictInterface.png" usemap="#CommonDictInterface_map" alt=""/>
  57   <map id="CommonDictInterface_map" name="CommonDictInterface_map">
  58 <area href="classXdxfPlugin.html" alt="XdxfPlugin" shape="rect" coords="0,56,132,80"/>
  59 </map>
  60  </div>
  61 </div>
  62
  63 <p><a href="classCommonDictInterface-members.html">List of all members.</a></p>
  64 <table border="0" cellpadding="0" cellspacing="0">
  65 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
  66 <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>
  67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">performs search in dictionary  <a href="#a27594c22d4df398e98af85b40b7407cb"></a><br/></td></tr>
  68 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a017f37eed4270d37cd5df36e546aacc6"></a><!-- doxytag: member="CommonDictInterface::stop" ref="a017f37eed4270d37cd5df36e546aacc6" args="()=0" -->
  69 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a017f37eed4270d37cd5df36e546aacc6">stop</a> ()=0</td></tr>
  70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stops current operation <br/></td></tr>
  71 <tr><td colspan="2"><h2>Signals</h2></td></tr>
  72 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abeb1426ae67ac8bc43002756b0cc9308"></a><!-- doxytag: member="CommonDictInterface::loaded" ref="abeb1426ae67ac8bc43002756b0cc9308" args="(CommonDictInterface *)" -->
  73 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>
  74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emited after dictionary is ready to use afer being loaded <br/></td></tr>
  75 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb500dfe5e18f544a01d5fa5352c3d36"></a><!-- doxytag: member="CommonDictInterface::settingsChanged" ref="aeb500dfe5e18f544a01d5fa5352c3d36" args="()" -->
  76 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#aeb500dfe5e18f544a01d5fa5352c3d36">settingsChanged</a> ()</td></tr>
  77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emited after change dictionary settings <br/></td></tr>
  78 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  79 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c769e72d6832629d73c987ee9bb5840"></a><!-- doxytag: member="CommonDictInterface::CommonDictInterface" ref="a8c769e72d6832629d73c987ee9bb5840" args="(QObject *parent=0)" -->
  80 &nbsp;</td><td class="memItemRight" valign="bottom"><b>CommonDictInterface</b> (QObject *parent=0)</td></tr>
  81 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f8b41dbaa0a5bdcb500c048ca501246"></a><!-- doxytag: member="CommonDictInterface::langFrom" ref="a7f8b41dbaa0a5bdcb500c048ca501246" args="() const =0" -->
  82 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a7f8b41dbaa0a5bdcb500c048ca501246">langFrom</a> () const =0</td></tr>
  83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns source language code iso 639-2 <br/></td></tr>
  84 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ca51f27e6f4fc159a733849d2434707"></a><!-- doxytag: member="CommonDictInterface::langTo" ref="a9ca51f27e6f4fc159a733849d2434707" args="() const =0" -->
  85 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a9ca51f27e6f4fc159a733849d2434707">langTo</a> () const =0</td></tr>
  86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns destination language code iso 639-2 <br/></td></tr>
  87 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4ee01f92feb9cacb38cb3f326e7944a"></a><!-- doxytag: member="CommonDictInterface::name" ref="ab4ee01f92feb9cacb38cb3f326e7944a" args="() const =0" -->
  88 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#ab4ee01f92feb9cacb38cb3f326e7944a">name</a> () const =0</td></tr>
  89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns dictionary name (like "old english" or so <br/></td></tr>
  90 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8739606ccb6314b40861f42bf45643d"></a><!-- doxytag: member="CommonDictInterface::type" ref="af8739606ccb6314b40861f42bf45643d" args="() const =0" -->
  91 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#af8739606ccb6314b40861f42bf45643d">type</a> () const =0</td></tr>
  92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns dictionary type (xdxf, google translate, etc) <br/></td></tr>
  93 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedd525079e04426d5cad9f6b9e117191"></a><!-- doxytag: member="CommonDictInterface::infoNote" ref="aedd525079e04426d5cad9f6b9e117191" args="() const =0" -->
  94 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#aedd525079e04426d5cad9f6b9e117191">infoNote</a> () const =0</td></tr>
  95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns information about dictionary in html (name, authors, etc) <br/></td></tr>
  96 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbbe216cdb93e0324cf4a6946e8e7af1"></a><!-- doxytag: member="CommonDictInterface::dictDialog" ref="adbbe216cdb93e0324cf4a6946e8e7af1" args="()=0" -->
  97 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>
  98 <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>
  99 <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" -->
 100 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>
 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns new, clean copy of plugin with setting set as in Settings* <br/></td></tr>
 102 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72115c2e4a6c6e57d8adfbc240a2e942"></a><!-- doxytag: member="CommonDictInterface::isAvailable" ref="a72115c2e4a6c6e57d8adfbc240a2e942" args="() const =0" -->
 103 virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a72115c2e4a6c6e57d8adfbc240a2e942">isAvailable</a> () const =0</td></tr>
 104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns whether plugin can start searching <br/></td></tr>
 105 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af40b38d2c1eafd7f5dd70d29e8333f81"></a><!-- doxytag: member="CommonDictInterface::search" ref="af40b38d2c1eafd7f5dd70d29e8333f81" args="(QString key)=0" -->
 106 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#af40b38d2c1eafd7f5dd70d29e8333f81">search</a> (QString key)=0</td></tr>
 107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the actual translation of a word given in key <br/></td></tr>
 108 <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>
 109 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ccd6318ae40727de5e66a92cf2fc95e"></a><!-- doxytag: member="CommonDictInterface::setHash" ref="a3ccd6318ae40727de5e66a92cf2fc95e" args="(uint)=0" -->
 110 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a3ccd6318ae40727de5e66a92cf2fc95e">setHash</a> (uint)=0</td></tr>
 111 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets unique value (unique for every dictionary not plugin) <br/></td></tr>
 112 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a20fee14fa5255a1e34e213c93afbe7"></a><!-- doxytag: member="CommonDictInterface::settings" ref="a7a20fee14fa5255a1e34e213c93afbe7" args="()=0" -->
 113 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>
 114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns current plugin settings <br/></td></tr>
 115 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac29057a9001f4acf6fcd6eec883cea62"></a><!-- doxytag: member="CommonDictInterface::icon" ref="ac29057a9001f4acf6fcd6eec883cea62" args="()=0" -->
 116 virtual QIcon&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#ac29057a9001f4acf6fcd6eec883cea62">icon</a> ()=0</td></tr>
 117 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns plugin icon <br/></td></tr>
 118 </table>
 119 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 120 <p>Interface for dict engines plugins. </p>
 121 <hr/><h2>Member Function Documentation</h2>
 122 <a class="anchor" id="a0b58ce9f287e73155b3b4c43e81ae65a"></a><!-- doxytag: member="CommonDictInterface::hash" ref="a0b58ce9f287e73155b3b4c43e81ae65a" args="() const =0" -->
 123 <div class="memitem">
 124 <div class="memproto">
 125       <table class="memname">
 126         <tr>
 127           <td class="memname">virtual uint CommonDictInterface::hash </td>
 128           <td>(</td>
 129           <td class="paramname"></td>
 130           <td>&nbsp;)&nbsp;</td>
 131           <td> const<code> [pure virtual]</code></td>
 132         </tr>
 133       </table>
 134 </div>
 135 <div class="memdoc">
 136 <dl class="return"><dt><b>Returns:</b></dt><dd>unique value (unique for every dictionary not plugin </dd></dl>
 137
 138 <p>Implemented in <a class="el" href="classXdxfPlugin.html#a5e83f29b2eff00598470bb4b82961973">XdxfPlugin</a>.</p>
 139
 140 </div>
 141 </div>
 142 <a class="anchor" id="a27594c22d4df398e98af85b40b7407cb"></a><!-- doxytag: member="CommonDictInterface::searchWordList" ref="a27594c22d4df398e98af85b40b7407cb" args="(QString word, int limit=0)=0" -->
 143 <div class="memitem">
 144 <div class="memproto">
 145       <table class="memname">
 146         <tr>
 147           <td class="memname">virtual QList&lt;<a class="el" href="classTranslation.html">Translation</a>*&gt; CommonDictInterface::searchWordList </td>
 148           <td>(</td>
 149           <td class="paramtype">QString&nbsp;</td>
 150           <td class="paramname"> <em>word</em>, </td>
 151         </tr>
 152         <tr>
 153           <td class="paramkey"></td>
 154           <td></td>
 155           <td class="paramtype">int&nbsp;</td>
 156           <td class="paramname"> <em>limit</em> = <code>0</code></td><td>&nbsp;</td>
 157         </tr>
 158         <tr>
 159           <td></td>
 160           <td>)</td>
 161           <td></td><td></td><td><code> [pure virtual, slot]</code></td>
 162         </tr>
 163       </table>
 164 </div>
 165 <div class="memdoc">
 166
 167 <p>performs search in dictionary </p>
 168 <dl><dt><b>Parameters:</b></dt><dd>
 169   <table border="0" cellspacing="2" cellpadding="0">
 170     <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>word to search in dictionary </td></tr>
 171     <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>
 172   </table>
 173   </dd>
 174 </dl>
 175 <p>After finishing search it have to emit </p>
 176 <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>
 177
 178 <p>Implemented in <a class="el" href="classXdxfPlugin.html#a538581955ba04d1316f1a8befab4d561">XdxfPlugin</a>.</p>
 179
 180 </div>
 181 </div>
 182 <hr/>The documentation for this class was generated from the following files:<ul>
 183 <li><a class="el" href="CommonDictInterface_8h_source.html">CommonDictInterface.h</a></li>
 184 <li>moc_CommonDictInterface.cpp</li>
 185 </ul>
 186 </div>
 187 <!--- window showing the filter options -->
 188 <div id="MSearchSelectWindow"
 189      onmouseover="return searchBox.OnSearchSelectShow()"
 190      onmouseout="return searchBox.OnSearchSelectHide()"
 191      onkeydown="return searchBox.OnSearchSelectKey(event)">
 192 <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>
 193
 194 <!-- iframe showing the search results (closed by default) -->
 195 <div id="MSearchResultsWindow">
 196 <iframe src="" frameborder="0"
 197         name="MSearchResults" id="MSearchResults">
 198 </iframe>
 199 </div>
 200
 201 <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 12 14:34:59 2010 for mDictionary by&nbsp;
 202 <a href="http://www.doxygen.org/index.html">
 203 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 204 </body>
 205 </html>