vcs.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
  53 <p><a href="classCommonDictInterface-members.html">List of all members.</a></p>
  54 <table border="0" cellpadding="0" cellspacing="0">
  55 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
  56 <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>
  57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">performes search in dictionary  <a href="#a23e1436f452272cf596e76957fe69796"></a><br/></td></tr>
  58 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a017f37eed4270d37cd5df36e546aacc6"></a><!-- doxytag: member="CommonDictInterface::stop" ref="a017f37eed4270d37cd5df36e546aacc6" args="()=0" -->
  59 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a017f37eed4270d37cd5df36e546aacc6">stop</a> ()=0</td></tr>
  60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stop current operation <br/></td></tr>
  61 <tr><td colspan="2"><h2>Signals</h2></td></tr>
  62 <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;)" -->
  63 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>
  64 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emit list of finded Translations <br/></td></tr>
  65 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abeb1426ae67ac8bc43002756b0cc9308"></a><!-- doxytag: member="CommonDictInterface::loaded" ref="abeb1426ae67ac8bc43002756b0cc9308" args="(CommonDictInterface *)" -->
  66 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>
  67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emited after dictionary is ready to use afer being loaded <br/></td></tr>
  68 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  69 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f8b41dbaa0a5bdcb500c048ca501246"></a><!-- doxytag: member="CommonDictInterface::langFrom" ref="a7f8b41dbaa0a5bdcb500c048ca501246" args="() const =0" -->
  70 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a7f8b41dbaa0a5bdcb500c048ca501246">langFrom</a> () const =0</td></tr>
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns source language code iso 639-2 <br/></td></tr>
  72 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ca51f27e6f4fc159a733849d2434707"></a><!-- doxytag: member="CommonDictInterface::langTo" ref="a9ca51f27e6f4fc159a733849d2434707" args="() const =0" -->
  73 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a9ca51f27e6f4fc159a733849d2434707">langTo</a> () const =0</td></tr>
  74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns destination language code iso 639-2 <br/></td></tr>
  75 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4ee01f92feb9cacb38cb3f326e7944a"></a><!-- doxytag: member="CommonDictInterface::name" ref="ab4ee01f92feb9cacb38cb3f326e7944a" args="() const =0" -->
  76 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#ab4ee01f92feb9cacb38cb3f326e7944a">name</a> () const =0</td></tr>
  77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns dictionary name (like "old english" or so <br/></td></tr>
  78 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8739606ccb6314b40861f42bf45643d"></a><!-- doxytag: member="CommonDictInterface::type" ref="af8739606ccb6314b40861f42bf45643d" args="() const =0" -->
  79 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#af8739606ccb6314b40861f42bf45643d">type</a> () const =0</td></tr>
  80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns dictionary type (xdxf, google translate, etc) <br/></td></tr>
  81 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedd525079e04426d5cad9f6b9e117191"></a><!-- doxytag: member="CommonDictInterface::infoNote" ref="aedd525079e04426d5cad9f6b9e117191" args="() const =0" -->
  82 virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#aedd525079e04426d5cad9f6b9e117191">infoNote</a> () const =0</td></tr>
  83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns information about dictionary in html (name, authors, etc) <br/></td></tr>
  84 <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>
  85 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4771687035b2c4cb02ee37532b621907"></a><!-- doxytag: member="CommonDictInterface::settingsDialog" ref="a4771687035b2c4cb02ee37532b621907" args="()=0" -->
  86 virtual QDialog *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a4771687035b2c4cb02ee37532b621907">settingsDialog</a> ()=0</td></tr>
  87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return dialog with dictionary settings <br/></td></tr>
  88 <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" -->
  89 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>
  90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return new, clean copy of plugin with setting set as in Settings* <br/></td></tr>
  91 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72115c2e4a6c6e57d8adfbc240a2e942"></a><!-- doxytag: member="CommonDictInterface::isAvailable" ref="a72115c2e4a6c6e57d8adfbc240a2e942" args="() const =0" -->
  92 virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a72115c2e4a6c6e57d8adfbc240a2e942">isAvailable</a> () const =0</td></tr>
  93 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns whether plugin can start searching <br/></td></tr>
  94 <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>
  95 </table>
  96 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  97 <p>Interface for dict engines plugins. </p>
  98 <hr/><h2>Member Function Documentation</h2>
  99 <a class="anchor" id="a0b58ce9f287e73155b3b4c43e81ae65a"></a><!-- doxytag: member="CommonDictInterface::hash" ref="a0b58ce9f287e73155b3b4c43e81ae65a" args="() const =0" -->
 100 <div class="memitem">
 101 <div class="memproto">
 102       <table class="memname">
 103         <tr>
 104           <td class="memname">virtual uint CommonDictInterface::hash </td>
 105           <td>(</td>
 106           <td class="paramname"></td>
 107           <td>&nbsp;)&nbsp;</td>
 108           <td> const<code> [pure virtual]</code></td>
 109         </tr>
 110       </table>
 111 </div>
 112 <div class="memdoc">
 113 <dl class="return"><dt><b>Returns:</b></dt><dd>unique value (unique for every dictionary not plugin </dd></dl>
 114
 115 </div>
 116 </div>
 117 <a class="anchor" id="a501cea622d6cb2344592bd06dcae0ac0"></a><!-- doxytag: member="CommonDictInterface::loadDialog" ref="a501cea622d6cb2344592bd06dcae0ac0" args="()=0" -->
 118 <div class="memitem">
 119 <div class="memproto">
 120       <table class="memname">
 121         <tr>
 122           <td class="memname">virtual QDialog* CommonDictInterface::loadDialog </td>
 123           <td>(</td>
 124           <td class="paramname"></td>
 125           <td>&nbsp;)&nbsp;</td>
 126           <td><code> [pure virtual]</code></td>
 127         </tr>
 128       </table>
 129 </div>
 130 <div class="memdoc">
 131 <p>return dialog that creates new dictionary and fills necesary options QDialog should returns Setting* object after being showed </p>
 132
 133 </div>
 134 </div>
 135 <a class="anchor" id="a23e1436f452272cf596e76957fe69796"></a><!-- doxytag: member="CommonDictInterface::search" ref="a23e1436f452272cf596e76957fe69796" args="(QString word, int limit)=0" -->
 136 <div class="memitem">
 137 <div class="memproto">
 138       <table class="memname">
 139         <tr>
 140           <td class="memname">virtual void CommonDictInterface::search </td>
 141           <td>(</td>
 142           <td class="paramtype">QString&nbsp;</td>
 143           <td class="paramname"> <em>word</em>, </td>
 144         </tr>
 145         <tr>
 146           <td class="paramkey"></td>
 147           <td></td>
 148           <td class="paramtype">int&nbsp;</td>
 149           <td class="paramname"> <em>limit</em></td><td>&nbsp;</td>
 150         </tr>
 151         <tr>
 152           <td></td>
 153           <td>)</td>
 154           <td></td><td></td><td><code> [pure virtual, slot]</code></td>
 155         </tr>
 156       </table>
 157 </div>
 158 <div class="memdoc">
 159
 160 <p>performes search in dictionary </p>
 161 <dl><dt><b>Parameters:</b></dt><dd>
 162   <table border="0" cellspacing="2" cellpadding="0">
 163     <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>word to search in dictionary </td></tr>
 164     <tr><td valign="top"></td><td valign="top"><em>limit</em>&nbsp;</td><td>limit on number of results</td></tr>
 165   </table>
 166   </dd>
 167 </dl>
 168 <p>After finishing search it have to emit </p>
 169 <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>
 170
 171 </div>
 172 </div>
 173 <hr/>The documentation for this class was generated from the following files:<ul>
 174 <li><a class="el" href="CommonDictInterface_8h_source.html">CommonDictInterface.h</a></li>
 175 <li>moc_CommonDictInterface.cpp</li>
 176 </ul>
 177 </div>
 178 <!--- window showing the filter options -->
 179 <div id="MSearchSelectWindow"
 180      onmouseover="return searchBox.OnSearchSelectShow()"
 181      onmouseout="return searchBox.OnSearchSelectHide()"
 182      onkeydown="return searchBox.OnSearchSelectKey(event)">
 183 <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>
 184
 185 <!-- iframe showing the search results (closed by default) -->
 186 <div id="MSearchResultsWindow">
 187 <iframe src="" frameborder="0"
 188         name="MSearchResults" id="MSearchResults">
 189 </iframe>
 190 </div>
 191
 192 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 4 12:02:54 2010 for mDictionary by&nbsp;
 193 <a href="http://www.doxygen.org/index.html">
 194 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 195 </body>
 196 </html>