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">
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"/>
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');
17 <div class="navigation" id="top">
20 <li><a href="index.html"><span>Main 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>
24 <div id="MSearchBox" class="MSearchBoxInactive">
25 <img id="MSearchSelect" src="search/search.png"
26 onmouseover="return searchBox.OnSearchSelectShow()"
27 onmouseout="return searchBox.OnSearchSelectHide()"
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>
40 <li><a href="annotated.html"><span>Class List</span></a></li>
41 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
42 <li><a href="functions.html"><span>Class Members</span></a></li>
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>
51 <p><code>#include <<a class="el" href="CommonDictInterface_8h_source.html">CommonDictInterface.h</a>></code></p>
52 <div class="dynheader">
53 Inheritance diagram for CommonDictInterface:</div>
54 <div class="dynsection">
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"/>
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< <a class="el" href="classTranslation.html">Translation</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a3ca9313571e0ecab66ce7a7c5d356f4f">searchWordList</a> (QString word, int limit)=0</td></tr>
67 <tr><td class="mdescLeft"> </td><td class="mdescRight">performs search in dictionary <a href="#a3ca9313571e0ecab66ce7a7c5d356f4f"></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a017f37eed4270d37cd5df36e546aacc6">stop</a> ()=0</td></tr>
70 <tr><td class="mdescLeft"> </td><td class="mdescRight">stop 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 </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"> </td><td class="mdescRight">emited after dictionary is ready to use afer being loaded <br/></td></tr>
75 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
76 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c769e72d6832629d73c987ee9bb5840"></a><!-- doxytag: member="CommonDictInterface::CommonDictInterface" ref="a8c769e72d6832629d73c987ee9bb5840" args="(QObject *parent=0)" -->
77 </td><td class="memItemRight" valign="bottom"><b>CommonDictInterface</b> (QObject *parent=0)</td></tr>
78 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f8b41dbaa0a5bdcb500c048ca501246"></a><!-- doxytag: member="CommonDictInterface::langFrom" ref="a7f8b41dbaa0a5bdcb500c048ca501246" args="() const =0" -->
79 virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a7f8b41dbaa0a5bdcb500c048ca501246">langFrom</a> () const =0</td></tr>
80 <tr><td class="mdescLeft"> </td><td class="mdescRight">returns source language code iso 639-2 <br/></td></tr>
81 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ca51f27e6f4fc159a733849d2434707"></a><!-- doxytag: member="CommonDictInterface::langTo" ref="a9ca51f27e6f4fc159a733849d2434707" args="() const =0" -->
82 virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a9ca51f27e6f4fc159a733849d2434707">langTo</a> () const =0</td></tr>
83 <tr><td class="mdescLeft"> </td><td class="mdescRight">returns destination language code iso 639-2 <br/></td></tr>
84 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4ee01f92feb9cacb38cb3f326e7944a"></a><!-- doxytag: member="CommonDictInterface::name" ref="ab4ee01f92feb9cacb38cb3f326e7944a" args="() const =0" -->
85 virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#ab4ee01f92feb9cacb38cb3f326e7944a">name</a> () const =0</td></tr>
86 <tr><td class="mdescLeft"> </td><td class="mdescRight">returns dictionary name (like "old english" or so <br/></td></tr>
87 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8739606ccb6314b40861f42bf45643d"></a><!-- doxytag: member="CommonDictInterface::type" ref="af8739606ccb6314b40861f42bf45643d" args="() const =0" -->
88 virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#af8739606ccb6314b40861f42bf45643d">type</a> () const =0</td></tr>
89 <tr><td class="mdescLeft"> </td><td class="mdescRight">returns dictionary type (xdxf, google translate, etc) <br/></td></tr>
90 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedd525079e04426d5cad9f6b9e117191"></a><!-- doxytag: member="CommonDictInterface::infoNote" ref="aedd525079e04426d5cad9f6b9e117191" args="() const =0" -->
91 virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#aedd525079e04426d5cad9f6b9e117191">infoNote</a> () const =0</td></tr>
92 <tr><td class="mdescLeft"> </td><td class="mdescRight">returns information about dictionary in html (name, authors, etc) <br/></td></tr>
93 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbbe216cdb93e0324cf4a6946e8e7af1"></a><!-- doxytag: member="CommonDictInterface::dictDialog" ref="adbbe216cdb93e0324cf4a6946e8e7af1" args="()=0" -->
94 virtual <a class="el" href="classDictDialog.html">DictDialog</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#adbbe216cdb93e0324cf4a6946e8e7af1">dictDialog</a> ()=0</td></tr>
95 <tr><td class="mdescLeft"> </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>
96 <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" -->
97 virtual <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * </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>
98 <tr><td class="mdescLeft"> </td><td class="mdescRight">return new, clean copy of plugin with setting set as in Settings* <br/></td></tr>
99 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72115c2e4a6c6e57d8adfbc240a2e942"></a><!-- doxytag: member="CommonDictInterface::isAvailable" ref="a72115c2e4a6c6e57d8adfbc240a2e942" args="() const =0" -->
100 virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a72115c2e4a6c6e57d8adfbc240a2e942">isAvailable</a> () const =0</td></tr>
101 <tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether plugin can start searching <br/></td></tr>
102 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af40b38d2c1eafd7f5dd70d29e8333f81"></a><!-- doxytag: member="CommonDictInterface::search" ref="af40b38d2c1eafd7f5dd70d29e8333f81" args="(QString key)=0" -->
103 virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#af40b38d2c1eafd7f5dd70d29e8333f81">search</a> (QString key)=0</td></tr>
104 <tr><td class="mdescLeft"> </td><td class="mdescRight">returns the actual translation of a word given in key <br/></td></tr>
105 <tr><td class="memItemLeft" align="right" valign="top">virtual uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a0b58ce9f287e73155b3b4c43e81ae65a">hash</a> () const =0</td></tr>
106 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ccd6318ae40727de5e66a92cf2fc95e"></a><!-- doxytag: member="CommonDictInterface::setHash" ref="a3ccd6318ae40727de5e66a92cf2fc95e" args="(uint)=0" -->
107 virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a3ccd6318ae40727de5e66a92cf2fc95e">setHash</a> (uint)=0</td></tr>
108 <tr><td class="mdescLeft"> </td><td class="mdescRight">set unique value (unique for every dictionary not plugin) <br/></td></tr>
109 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a20fee14fa5255a1e34e213c93afbe7"></a><!-- doxytag: member="CommonDictInterface::settings" ref="a7a20fee14fa5255a1e34e213c93afbe7" args="()=0" -->
110 virtual <a class="el" href="classSettings.html">Settings</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a7a20fee14fa5255a1e34e213c93afbe7">settings</a> ()=0</td></tr>
111 <tr><td class="mdescLeft"> </td><td class="mdescRight">returns current plugin settings <br/></td></tr>
113 <hr/><a name="_details"></a><h2>Detailed Description</h2>
114 <p>Interface for dict engines plugins. </p>
115 <hr/><h2>Member Function Documentation</h2>
116 <a class="anchor" id="a0b58ce9f287e73155b3b4c43e81ae65a"></a><!-- doxytag: member="CommonDictInterface::hash" ref="a0b58ce9f287e73155b3b4c43e81ae65a" args="() const =0" -->
117 <div class="memitem">
118 <div class="memproto">
119 <table class="memname">
121 <td class="memname">virtual uint CommonDictInterface::hash </td>
123 <td class="paramname"></td>
124 <td> ) </td>
125 <td> const<code> [pure virtual]</code></td>
130 <dl class="return"><dt><b>Returns:</b></dt><dd>unique value (unique for every dictionary not plugin </dd></dl>
132 <p>Implemented in <a class="el" href="classXdxfPlugin.html#a5e83f29b2eff00598470bb4b82961973">XdxfPlugin</a>.</p>
136 <a class="anchor" id="a3ca9313571e0ecab66ce7a7c5d356f4f"></a><!-- doxytag: member="CommonDictInterface::searchWordList" ref="a3ca9313571e0ecab66ce7a7c5d356f4f" args="(QString word, int limit)=0" -->
137 <div class="memitem">
138 <div class="memproto">
139 <table class="memname">
141 <td class="memname">virtual QList<<a class="el" href="classTranslation.html">Translation</a>*> CommonDictInterface::searchWordList </td>
143 <td class="paramtype">QString </td>
144 <td class="paramname"> <em>word</em>, </td>
147 <td class="paramkey"></td>
149 <td class="paramtype">int </td>
150 <td class="paramname"> <em>limit</em></td><td> </td>
155 <td></td><td></td><td><code> [pure virtual, slot]</code></td>
161 <p>performs search in dictionary </p>
162 <dl><dt><b>Parameters:</b></dt><dd>
163 <table border="0" cellspacing="2" cellpadding="0">
164 <tr><td valign="top"></td><td valign="top"><em>word</em> </td><td>word to search in dictionary </td></tr>
165 <tr><td valign="top"></td><td valign="top"><em>limit</em> </td><td>limit on number of results</td></tr>
169 <p>After finishing search it have to emit </p>
170 <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>
172 <p>Implemented in <a class="el" href="classXdxfPlugin.html#a538581955ba04d1316f1a8befab4d561">XdxfPlugin</a>.</p>
176 <hr/>The documentation for this class was generated from the following file:<ul>
177 <li><a class="el" href="CommonDictInterface_8h_source.html">CommonDictInterface.h</a></li>
180 <!--- window showing the filter options -->
181 <div id="MSearchSelectWindow"
182 onmouseover="return searchBox.OnSearchSelectShow()"
183 onmouseout="return searchBox.OnSearchSelectHide()"
184 onkeydown="return searchBox.OnSearchSelectKey(event)">
185 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a></div>
187 <!-- iframe showing the search results (closed by default) -->
188 <div id="MSearchResultsWindow">
189 <iframe src="" frameborder="0"
190 name="MSearchResults" id="MSearchResults">
194 <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Aug 6 11:51:04 2010 for mDictionary by
195 <a href="http://www.doxygen.org/index.html">
196 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>