vcs.maemo.org Git - mdictionary/blob - doc/html/classXdxfPlugin.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: XdxfPlugin 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>XdxfPlugin Class Reference</h1><!-- doxytag: class="XdxfPlugin" --><!-- doxytag: inherits="CommonDictInterface" --><div class="dynheader">
  48 Inheritance diagram for XdxfPlugin:</div>
  49 <div class="dynsection">
  50  <div class="center">
  51   <img src="classXdxfPlugin.png" usemap="#XdxfPlugin_map" alt=""/>
  52   <map id="XdxfPlugin_map" name="XdxfPlugin_map">
  53 <area href="classCommonDictInterface.html" alt="CommonDictInterface" shape="rect" coords="0,0,132,24"/>
  54 </map>
  55  </div>
  56 </div>
  57
  58 <p><a href="classXdxfPlugin-members.html">List of all members.</a></p>
  59 <table border="0" cellpadding="0" cellspacing="0">
  60 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
  61 <tr><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a538581955ba04d1316f1a8befab4d561">searchWordList</a> (QString word, int limit=0)</td></tr>
  62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">performs search in dictionary  <a href="#a538581955ba04d1316f1a8befab4d561"></a><br/></td></tr>
  63 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93d9ca6bbd8cc5b5cbda418f6499025b"></a><!-- doxytag: member="XdxfPlugin::stop" ref="a93d9ca6bbd8cc5b5cbda418f6499025b" args="()" -->
  64 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a93d9ca6bbd8cc5b5cbda418f6499025b">stop</a> ()</td></tr>
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stop current operation <br/></td></tr>
  66 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  67 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cb6059f34448ba265aa57b3c995d2d6"></a><!-- doxytag: member="XdxfPlugin::XdxfPlugin" ref="a6cb6059f34448ba265aa57b3c995d2d6" args="(QObject *parent=0)" -->
  68 &nbsp;</td><td class="memItemRight" valign="bottom"><b>XdxfPlugin</b> (QObject *parent=0)</td></tr>
  69 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a512b66dd3e147cc86a2bc3e9418104fc"></a><!-- doxytag: member="XdxfPlugin::langFrom" ref="a512b66dd3e147cc86a2bc3e9418104fc" args="() const " -->
  70 QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a512b66dd3e147cc86a2bc3e9418104fc">langFrom</a> () const </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="a6969b031c270fd556fcecf0e423c0895"></a><!-- doxytag: member="XdxfPlugin::langTo" ref="a6969b031c270fd556fcecf0e423c0895" args="() const " -->
  73 QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a6969b031c270fd556fcecf0e423c0895">langTo</a> () const </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="a860f2e7375797c80ed4a7eb8bdf1831b"></a><!-- doxytag: member="XdxfPlugin::name" ref="a860f2e7375797c80ed4a7eb8bdf1831b" args="() const " -->
  76 QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a860f2e7375797c80ed4a7eb8bdf1831b">name</a> () const </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="a1ef22204eed844d74f90b7222a122c5d"></a><!-- doxytag: member="XdxfPlugin::type" ref="a1ef22204eed844d74f90b7222a122c5d" args="() const " -->
  79 QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a1ef22204eed844d74f90b7222a122c5d">type</a> () const </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="ab3af2811d200d1901629e5fba8e64eb7"></a><!-- doxytag: member="XdxfPlugin::infoNote" ref="ab3af2811d200d1901629e5fba8e64eb7" args="() const " -->
  82 QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#ab3af2811d200d1901629e5fba8e64eb7">infoNote</a> () const </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"><a class="anchor" id="ac6cbb0ef522b93927de69e5bfe3f7600"></a><!-- doxytag: member="XdxfPlugin::dictDialog" ref="ac6cbb0ef522b93927de69e5bfe3f7600" args="()" -->
  85 <a class="el" href="classDictDialog.html">DictDialog</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#ac6cbb0ef522b93927de69e5bfe3f7600">dictDialog</a> ()</td></tr>
  86 <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>
  87 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c1fabf4653655f4f654e0ea31c14539"></a><!-- doxytag: member="XdxfPlugin::getNew" ref="a1c1fabf4653655f4f654e0ea31c14539" args="(const Settings *) const " -->
  88 <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a1c1fabf4653655f4f654e0ea31c14539">getNew</a> (const <a class="el" href="classSettings.html">Settings</a> *) const </td></tr>
  89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns new, clean copy of plugin with setting set as in Settings* <br/></td></tr>
  90 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a57cddf8db03190a2a49492cc7f43f4"></a><!-- doxytag: member="XdxfPlugin::isAvailable" ref="a0a57cddf8db03190a2a49492cc7f43f4" args="() const " -->
  91 bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a0a57cddf8db03190a2a49492cc7f43f4">isAvailable</a> () const </td></tr>
  92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns whether plugin can start searching <br/></td></tr>
  93 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3439332c8624e64456c0b7b62c99bf42"></a><!-- doxytag: member="XdxfPlugin::search" ref="a3439332c8624e64456c0b7b62c99bf42" args="(QString key)" -->
  94 QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a3439332c8624e64456c0b7b62c99bf42">search</a> (QString key)</td></tr>
  95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns a description of a word given by a QString <br/></td></tr>
  96 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e83f29b2eff00598470bb4b82961973"></a><!-- doxytag: member="XdxfPlugin::hash" ref="a5e83f29b2eff00598470bb4b82961973" args="() const " -->
  97 uint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a5e83f29b2eff00598470bb4b82961973">hash</a> () const </td></tr>
  98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns a unique hash for a dictionary <br/></td></tr>
  99 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74b5d40e3fa217a10c6ba790a9433086"></a><!-- doxytag: member="XdxfPlugin::setHash" ref="a74b5d40e3fa217a10c6ba790a9433086" args="(uint)" -->
 100 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a74b5d40e3fa217a10c6ba790a9433086">setHash</a> (uint)</td></tr>
 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set unique value (unique for every dictionary not plugin) <br/></td></tr>
 102 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a115e0b340b8f9a5099b8f2a4f755dbfc"></a><!-- doxytag: member="XdxfPlugin::settings" ref="a115e0b340b8f9a5099b8f2a4f755dbfc" args="()" -->
 103 <a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXdxfPlugin.html#a115e0b340b8f9a5099b8f2a4f755dbfc">settings</a> ()</td></tr>
 104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns current plugin settings <br/></td></tr>
 105 </table>
 106 <hr/><h2>Member Function Documentation</h2>
 107 <a class="anchor" id="a538581955ba04d1316f1a8befab4d561"></a><!-- doxytag: member="XdxfPlugin::searchWordList" ref="a538581955ba04d1316f1a8befab4d561" args="(QString word, int limit=0)" -->
 108 <div class="memitem">
 109 <div class="memproto">
 110       <table class="memname">
 111         <tr>
 112           <td class="memname">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt; XdxfPlugin::searchWordList </td>
 113           <td>(</td>
 114           <td class="paramtype">QString&nbsp;</td>
 115           <td class="paramname"> <em>word</em>, </td>
 116         </tr>
 117         <tr>
 118           <td class="paramkey"></td>
 119           <td></td>
 120           <td class="paramtype">int&nbsp;</td>
 121           <td class="paramname"> <em>limit</em> = <code>0</code></td><td>&nbsp;</td>
 122         </tr>
 123         <tr>
 124           <td></td>
 125           <td>)</td>
 126           <td></td><td></td><td><code> [virtual, slot]</code></td>
 127         </tr>
 128       </table>
 129 </div>
 130 <div class="memdoc">
 131
 132 <p>performs search in dictionary </p>
 133 <dl><dt><b>Parameters:</b></dt><dd>
 134   <table border="0" cellspacing="2" cellpadding="0">
 135     <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>word to search in dictionary </td></tr>
 136     <tr><td valign="top"></td><td valign="top"><em>limit</em>&nbsp;</td><td>limit on number of results</td></tr>
 137   </table>
 138   </dd>
 139 </dl>
 140 <p>After finishing search it has to emit </p>
 141 <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>
 142
 143 <p>Implements <a class="el" href="classCommonDictInterface.html#a3ca9313571e0ecab66ce7a7c5d356f4f">CommonDictInterface</a>.</p>
 144
 145 </div>
 146 </div>
 147 <hr/>The documentation for this class was generated from the following files:<ul>
 148 <li><a class="el" href="xdxfplugin_8h_source.html">xdxfplugin.h</a></li>
 149 <li>xdxfplugin.cpp</li>
 150 </ul>
 151 </div>
 152 <!--- window showing the filter options -->
 153 <div id="MSearchSelectWindow"
 154      onmouseover="return searchBox.OnSearchSelectShow()"
 155      onmouseout="return searchBox.OnSearchSelectHide()"
 156      onkeydown="return searchBox.OnSearchSelectKey(event)">
 157 <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>
 158
 159 <!-- iframe showing the search results (closed by default) -->
 160 <div id="MSearchResultsWindow">
 161 <iframe src="" frameborder="0"
 162         name="MSearchResults" id="MSearchResults">
 163 </iframe>
 164 </div>
 165
 166 <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Aug 6 11:51:04 2010 for mDictionary by&nbsp;
 167 <a href="http://www.doxygen.org/index.html">
 168 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 169 </body>
 170 </html>