Added documentation
[mdictionary] / doc / html / classGUIInterface.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: GUIInterface 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>GUIInterface Class Reference</h1><!-- doxytag: class="GUIInterface" -->
48 <p>Interface for different GUIs.  
49 <a href="#_details">More...</a></p>
50
51 <p><code>#include &lt;<a class="el" href="GUIInterface_8h_source.html">GUIInterface.h</a>&gt;</code></p>
52 <div class="dynheader">
53 Inheritance diagram for GUIInterface:</div>
54 <div class="dynsection">
55  <div class="center">
56   <img src="classGUIInterface.png" usemap="#GUIInterface_map" alt=""/>
57   <map id="GUIInterface_map" name="GUIInterface_map">
58 <area href="classMainWindow.html" alt="MainWindow" shape="rect" coords="0,56,84,80"/>
59 </map>
60  </div>
61 </div>
62
63 <p><a href="classGUIInterface-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 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a39d3969fbadaea6da410a93dc3bebdd7">searchExact</a> (QString word)=0</td></tr>
67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Search in exact mode for given word.  <a href="#a39d3969fbadaea6da410a93dc3bebdd7"></a><br/></td></tr>
68 <tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a4081962fcbd7e8063bb87fcc444b6124">addToHistory</a> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;)=0</td></tr>
69 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds to history key words from given translations.  <a href="#a4081962fcbd7e8063bb87fcc444b6124"></a><br/></td></tr>
70 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7a21fe2438ac72d9bc7843733ee2e3b"></a><!-- doxytag: member="GUIInterface::showHistory" ref="aa7a21fe2438ac72d9bc7843733ee2e3b" args="()=0" -->
71 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#aa7a21fe2438ac72d9bc7843733ee2e3b">showHistory</a> ()=0</td></tr>
72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shows history dialog. <br/></td></tr>
73 <tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a9b9d53a56b052cf4c7d5e5bc158b8036">historyNext</a> ()=0</td></tr>
74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shows translation of next word in history.  <a href="#a9b9d53a56b052cf4c7d5e5bc158b8036"></a><br/></td></tr>
75 <tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a47243e01c2d2e3887ee3fef656f84475">historyPrev</a> ()=0</td></tr>
76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shows translation of previous word in history.  <a href="#a47243e01c2d2e3887ee3fef656f84475"></a><br/></td></tr>
77 <tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a0387f70e18b390cf1e229cbeb27a61c8">wordListReady</a> ()=0</td></tr>
78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets word list from backbone and prepares received list to display.  <a href="#a0387f70e18b390cf1e229cbeb27a61c8"></a><br/></td></tr>
79 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd81fe53691de8c942be152a099bd21b"></a><!-- doxytag: member="GUIInterface::translationsReady" ref="abd81fe53691de8c942be152a099bd21b" args="()=0" -->
80 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#abd81fe53691de8c942be152a099bd21b">translationsReady</a> ()=0</td></tr>
81 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets translation strings from backbone and emit signal to display them. <br/></td></tr>
82 <tr><td colspan="2"><h2>Signals</h2></td></tr>
83 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a66c9b1a0743e55a456831b91d4674d86">quit</a> ()</td></tr>
84 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#af1012152ba1c3683c19bb5de68cc34ec">searchWordList</a> (QString word)</td></tr>
85 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Emited when user want to search for list of words matching given word.  <a href="#af1012152ba1c3683c19bb5de68cc34ec"></a><br/></td></tr>
86 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a9855cd24df15d961ec062f0c6b80a263">searchTranslations</a> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;)</td></tr>
87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Emited when user wants to see translation of words.  <a href="#a9855cd24df15d961ec062f0c6b80a263"></a><br/></td></tr>
88 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a2af4fcfe33ffab1cb2de6972b2eb66b8">setBusy</a> ()</td></tr>
89 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a605a50fb08e4149cbe26c00189227a88"></a><!-- doxytag: member="GUIInterface::setIdle" ref="a605a50fb08e4149cbe26c00189227a88" args="()" -->
90 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a605a50fb08e4149cbe26c00189227a88">setIdle</a> ()</td></tr>
91 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Emited when searching ends, will enable GUI components. <br/></td></tr>
92 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee6a89f4fd62e09d552af5522121a036"></a><!-- doxytag: member="GUIInterface::stopSearching" ref="aee6a89f4fd62e09d552af5522121a036" args="()" -->
93 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#aee6a89f4fd62e09d552af5522121a036">stopSearching</a> ()</td></tr>
94 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Emited when user want to break search. <br/></td></tr>
95 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#acaa643ecd68519b1b66f76cb5eaabe4e">showWordList</a> (QHash&lt; QString, QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt; &gt;)</td></tr>
96 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a10454da99d774b68a38f1f0c374c4c51">showTranslation</a> (QStringList)</td></tr>
97 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a39f9eea230008cb063d5aeac0158e13a">addNewDictionary</a> (<a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *)</td></tr>
98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Emited when user wants to add new dictionary.  <a href="#a39f9eea230008cb063d5aeac0158e13a"></a><br/></td></tr>
99 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a4bcc5403e1c18a67e5378de713bd6c66">removeDictionary</a> (<a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *)</td></tr>
100 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Emited when user wants to remove dictionary.  <a href="#a4bcc5403e1c18a67e5378de713bd6c66"></a><br/></td></tr>
101 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a46465786e5e8b629b51b5dd2e5c51181">selectedDictionaries</a> (QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt;)</td></tr>
102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Emited when user changes dictionaries active/inactive states.  <a href="#a46465786e5e8b629b51b5dd2e5c51181"></a><br/></td></tr>
103 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a18cd7940751b2993ab9cf36749206e"></a><!-- doxytag: member="GUIInterface::addToBookmarks" ref="a1a18cd7940751b2993ab9cf36749206e" args="(QList&lt; Translation * &gt;)" -->
104 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>addToBookmarks</b> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;)</td></tr>
105 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
106 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a840b9805dfc2a13ec9d71c9cf64fcde3"></a><!-- doxytag: member="GUIInterface::GUIInterface" ref="a840b9805dfc2a13ec9d71c9cf64fcde3" args="(QWidget *parent=0)" -->
107 &nbsp;</td><td class="memItemRight" valign="bottom"><b>GUIInterface</b> (QWidget *parent=0)</td></tr>
108 <tr><td class="memItemLeft" align="right" valign="top">virtual QHash<br class="typebreak"/>
109 &lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *, bool &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a65f5532b1d404c41f22e6408138bd87a">getDictionaries</a> ()=0</td></tr>
110 <tr><td class="memItemLeft" align="right" valign="top">virtual QList<br class="typebreak"/>
111 &lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a232872064056fdcfa752b314d9e34bfa">getPlugins</a> ()=0</td></tr>
112 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns all loaded plugins.  <a href="#a232872064056fdcfa752b314d9e34bfa"></a><br/></td></tr>
113 <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a83f7716f43447730aeda078cc202d48b">exactSearch</a> ()</td></tr>
114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indicates if GUI is in exact search mode.  <a href="#a83f7716f43447730aeda078cc202d48b"></a><br/></td></tr>
115 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGUIInterface.html#a4d9a8b5392fdbcec9a0b8663eba3c571">setExactSearch</a> (bool exactSearch)</td></tr>
116 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets GUI exact search mode.  <a href="#a4d9a8b5392fdbcec9a0b8663eba3c571"></a><br/></td></tr>
117 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4575172e6a78aef865a143ca356cd3f7"></a><!-- doxytag: member="GUIInterface::settings" ref="a4575172e6a78aef865a143ca356cd3f7" args="()=0" -->
118 virtual <a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>settings</b> ()=0</td></tr>
119 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e1d089eddb19d43e2b5692ec7fb48f7"></a><!-- doxytag: member="GUIInterface::setSettings" ref="a8e1d089eddb19d43e2b5692ec7fb48f7" args="(Settings *)=0" -->
120 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setSettings</b> (<a class="el" href="classSettings.html">Settings</a> *)=0</td></tr>
121 </table>
122 <hr/><a name="_details"></a><h2>Detailed Description</h2>
123 <p>Interface for different GUIs. </p>
124 <p>Default base class for all GUIs is QMainWindow </p>
125 <hr/><h2>Member Function Documentation</h2>
126 <a class="anchor" id="a39f9eea230008cb063d5aeac0158e13a"></a><!-- doxytag: member="GUIInterface::addNewDictionary" ref="a39f9eea230008cb063d5aeac0158e13a" args="(CommonDictInterface *)" -->
127 <div class="memitem">
128 <div class="memproto">
129       <table class="memname">
130         <tr>
131           <td class="memname">void GUIInterface::addNewDictionary </td>
132           <td>(</td>
133           <td class="paramtype"><a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *&nbsp;</td>
134           <td class="paramname"> <em>_t1</em></td>
135           <td>&nbsp;)&nbsp;</td>
136           <td><code> [signal]</code></td>
137         </tr>
138       </table>
139 </div>
140 <div class="memdoc">
141
142 <p>Emited when user wants to add new dictionary. </p>
143 <dl><dt><b>Parameters:</b></dt><dd>
144   <table border="0" cellspacing="2" cellpadding="0">
145     <tr><td valign="top"></td><td valign="top"><em>new</em>&nbsp;</td><td>dictionary returned by specyfic plugin dialog </td></tr>
146   </table>
147   </dd>
148 </dl>
149
150 </div>
151 </div>
152 <a class="anchor" id="a4081962fcbd7e8063bb87fcc444b6124"></a><!-- doxytag: member="GUIInterface::addToHistory" ref="a4081962fcbd7e8063bb87fcc444b6124" args="(QList&lt; Translation * &gt;)=0" -->
153 <div class="memitem">
154 <div class="memproto">
155       <table class="memname">
156         <tr>
157           <td class="memname">virtual void GUIInterface::addToHistory </td>
158           <td>(</td>
159           <td class="paramtype">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td>
160           <td class="paramname"></td>
161           <td>&nbsp;)&nbsp;</td>
162           <td><code> [pure virtual, slot]</code></td>
163         </tr>
164       </table>
165 </div>
166 <div class="memdoc">
167
168 <p>Adds to history key words from given translations. </p>
169 <p>By default this slot is connected to signal searchTranslations, and passed translation list contains only translation with the same key, so only one word is added to history. </p>
170 <dl><dt><b>Parameters:</b></dt><dd>
171   <table border="0" cellspacing="2" cellpadding="0">
172     <tr><td valign="top"></td><td valign="top"><em>list</em>&nbsp;</td><td>of translations with key words </td></tr>
173   </table>
174   </dd>
175 </dl>
176 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classGUIInterface.html#a9855cd24df15d961ec062f0c6b80a263" title="Emited when user wants to see translation of words.">searchTranslations()</a>; </dd></dl>
177
178 <p>Implemented in <a class="el" href="classMainWindow.html#ab88154764298f46e81f942262170f4b9">MainWindow</a>.</p>
179
180 </div>
181 </div>
182 <a class="anchor" id="a83f7716f43447730aeda078cc202d48b"></a><!-- doxytag: member="GUIInterface::exactSearch" ref="a83f7716f43447730aeda078cc202d48b" args="()" -->
183 <div class="memitem">
184 <div class="memproto">
185       <table class="memname">
186         <tr>
187           <td class="memname">bool GUIInterface::exactSearch </td>
188           <td>(</td>
189           <td class="paramname"></td>
190           <td>&nbsp;)&nbsp;</td>
191           <td></td>
192         </tr>
193       </table>
194 </div>
195 <div class="memdoc">
196
197 <p>Indicates if GUI is in exact search mode. </p>
198 <p>When GUI is in exact search mode it search for word, and if find exacly matching translation it directly displays it, whithout displaying matching word list. This mode should be used for browsing search history and search words from application arguments. </p>
199 <dl class="return"><dt><b>Returns:</b></dt><dd>flag indicating if GUI is in exact search mode </dd></dl>
200
201 <p>Reimplemented in <a class="el" href="classMainWindow.html#a88a06565de22a608629bfa4a15ad5839">MainWindow</a>.</p>
202
203 </div>
204 </div>
205 <a class="anchor" id="a65f5532b1d404c41f22e6408138bd87a"></a><!-- doxytag: member="GUIInterface::getDictionaries" ref="a65f5532b1d404c41f22e6408138bd87a" args="()=0" -->
206 <div class="memitem">
207 <div class="memproto">
208       <table class="memname">
209         <tr>
210           <td class="memname">virtual QHash&lt;<a class="el" href="classCommonDictInterface.html">CommonDictInterface</a>*, bool&gt; GUIInterface::getDictionaries </td>
211           <td>(</td>
212           <td class="paramname"></td>
213           <td>&nbsp;)&nbsp;</td>
214           <td><code> [pure virtual]</code></td>
215         </tr>
216       </table>
217 </div>
218 <div class="memdoc">
219 <p>Returns all loaded dictionaries with infromation about that they are active/inactive</p>
220 <dl class="return"><dt><b>Returns:</b></dt><dd>Hash of pointers to dictionary and boolean flag indicating if dictionary is active </dd></dl>
221
222 <p>Implemented in <a class="el" href="classMainWindow.html#a0fd2d755ce951f3dfb535d555b957de7">MainWindow</a>.</p>
223
224 </div>
225 </div>
226 <a class="anchor" id="a232872064056fdcfa752b314d9e34bfa"></a><!-- doxytag: member="GUIInterface::getPlugins" ref="a232872064056fdcfa752b314d9e34bfa" args="()=0" -->
227 <div class="memitem">
228 <div class="memproto">
229       <table class="memname">
230         <tr>
231           <td class="memname">virtual QList&lt;<a class="el" href="classCommonDictInterface.html">CommonDictInterface</a>*&gt; GUIInterface::getPlugins </td>
232           <td>(</td>
233           <td class="paramname"></td>
234           <td>&nbsp;)&nbsp;</td>
235           <td><code> [pure virtual]</code></td>
236         </tr>
237       </table>
238 </div>
239 <div class="memdoc">
240
241 <p>Returns all loaded plugins. </p>
242 <dl class="return"><dt><b>Returns:</b></dt><dd>List of pointers to plugins </dd></dl>
243
244 <p>Implemented in <a class="el" href="classMainWindow.html#a021ff10f30db21337b54b3dfaae0e9a0">MainWindow</a>.</p>
245
246 </div>
247 </div>
248 <a class="anchor" id="a9b9d53a56b052cf4c7d5e5bc158b8036"></a><!-- doxytag: member="GUIInterface::historyNext" ref="a9b9d53a56b052cf4c7d5e5bc158b8036" args="()=0" -->
249 <div class="memitem">
250 <div class="memproto">
251       <table class="memname">
252         <tr>
253           <td class="memname">virtual void GUIInterface::historyNext </td>
254           <td>(</td>
255           <td class="paramname"></td>
256           <td>&nbsp;)&nbsp;</td>
257           <td><code> [pure virtual, slot]</code></td>
258         </tr>
259       </table>
260 </div>
261 <div class="memdoc">
262
263 <p>Shows translation of next word in history. </p>
264 <p>It will work only if there is available next word in history. <a class="el" href="classTranslation.html" title="/file translation.h">Translation</a> of word is searched with <a class="el" href="classGUIInterface.html#a39d3969fbadaea6da410a93dc3bebdd7" title="Search in exact mode for given word.">searchExact()</a> function </p>
265 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classGUIInterface.html#a39d3969fbadaea6da410a93dc3bebdd7" title="Search in exact mode for given word.">searchExact()</a> </dd></dl>
266
267 <p>Implemented in <a class="el" href="classMainWindow.html#aaac2ae9385150bf83eb6c1d73e745e3c">MainWindow</a>.</p>
268
269 </div>
270 </div>
271 <a class="anchor" id="a47243e01c2d2e3887ee3fef656f84475"></a><!-- doxytag: member="GUIInterface::historyPrev" ref="a47243e01c2d2e3887ee3fef656f84475" args="()=0" -->
272 <div class="memitem">
273 <div class="memproto">
274       <table class="memname">
275         <tr>
276           <td class="memname">virtual void GUIInterface::historyPrev </td>
277           <td>(</td>
278           <td class="paramname"></td>
279           <td>&nbsp;)&nbsp;</td>
280           <td><code> [pure virtual, slot]</code></td>
281         </tr>
282       </table>
283 </div>
284 <div class="memdoc">
285
286 <p>Shows translation of previous word in history. </p>
287 <p>It will work only if there is available previous word in history. <a class="el" href="classTranslation.html" title="/file translation.h">Translation</a> of word is searched with <a class="el" href="classGUIInterface.html#a39d3969fbadaea6da410a93dc3bebdd7" title="Search in exact mode for given word.">searchExact()</a> function </p>
288 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classGUIInterface.html#a39d3969fbadaea6da410a93dc3bebdd7" title="Search in exact mode for given word.">searchExact()</a> </dd></dl>
289
290 <p>Implemented in <a class="el" href="classMainWindow.html#ab3d88584e7391cedb791248dc7b13b78">MainWindow</a>.</p>
291
292 </div>
293 </div>
294 <a class="anchor" id="a66c9b1a0743e55a456831b91d4674d86"></a><!-- doxytag: member="GUIInterface::quit" ref="a66c9b1a0743e55a456831b91d4674d86" args="()" -->
295 <div class="memitem">
296 <div class="memproto">
297       <table class="memname">
298         <tr>
299           <td class="memname">void GUIInterface::quit </td>
300           <td>(</td>
301           <td class="paramname"></td>
302           <td>&nbsp;)&nbsp;</td>
303           <td><code> [signal]</code></td>
304         </tr>
305       </table>
306 </div>
307 <div class="memdoc">
308 <p>Should be emited when user wants to close application to stop all ongoing searches </p>
309
310 </div>
311 </div>
312 <a class="anchor" id="a4bcc5403e1c18a67e5378de713bd6c66"></a><!-- doxytag: member="GUIInterface::removeDictionary" ref="a4bcc5403e1c18a67e5378de713bd6c66" args="(CommonDictInterface *)" -->
313 <div class="memitem">
314 <div class="memproto">
315       <table class="memname">
316         <tr>
317           <td class="memname">void GUIInterface::removeDictionary </td>
318           <td>(</td>
319           <td class="paramtype"><a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *&nbsp;</td>
320           <td class="paramname"> <em>_t1</em></td>
321           <td>&nbsp;)&nbsp;</td>
322           <td><code> [signal]</code></td>
323         </tr>
324       </table>
325 </div>
326 <div class="memdoc">
327
328 <p>Emited when user wants to remove dictionary. </p>
329 <dl><dt><b>Parameters:</b></dt><dd>
330   <table border="0" cellspacing="2" cellpadding="0">
331     <tr><td valign="top"></td><td valign="top"><em>dictionary</em>&nbsp;</td><td>which will be removed </td></tr>
332   </table>
333   </dd>
334 </dl>
335
336 </div>
337 </div>
338 <a class="anchor" id="a39d3969fbadaea6da410a93dc3bebdd7"></a><!-- doxytag: member="GUIInterface::searchExact" ref="a39d3969fbadaea6da410a93dc3bebdd7" args="(QString word)=0" -->
339 <div class="memitem">
340 <div class="memproto">
341       <table class="memname">
342         <tr>
343           <td class="memname">virtual void GUIInterface::searchExact </td>
344           <td>(</td>
345           <td class="paramtype">QString&nbsp;</td>
346           <td class="paramname"> <em>word</em></td>
347           <td>&nbsp;)&nbsp;</td>
348           <td><code> [pure virtual, slot]</code></td>
349         </tr>
350       </table>
351 </div>
352 <div class="memdoc">
353
354 <p>Search in exact mode for given word. </p>
355 <p>GUI will be automaticaly set into exact search mode, and after search or break will be unset from exact search mode. </p>
356 <dl><dt><b>Parameters:</b></dt><dd>
357   <table border="0" cellspacing="2" cellpadding="0">
358     <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>which will be searched in dictionaries </td></tr>
359   </table>
360   </dd>
361 </dl>
362
363 <p>Implemented in <a class="el" href="classMainWindow.html#a16d0c7d46fc49bfa1cada597e349549a">MainWindow</a>.</p>
364
365 </div>
366 </div>
367 <a class="anchor" id="a9855cd24df15d961ec062f0c6b80a263"></a><!-- doxytag: member="GUIInterface::searchTranslations" ref="a9855cd24df15d961ec062f0c6b80a263" args="(QList&lt; Translation * &gt;)" -->
368 <div class="memitem">
369 <div class="memproto">
370       <table class="memname">
371         <tr>
372           <td class="memname">void GUIInterface::searchTranslations </td>
373           <td>(</td>
374           <td class="paramtype">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td>
375           <td class="paramname"> <em>_t1</em></td>
376           <td>&nbsp;)&nbsp;</td>
377           <td><code> [signal]</code></td>
378         </tr>
379       </table>
380 </div>
381 <div class="memdoc">
382
383 <p>Emited when user wants to see translation of words. </p>
384 <dl><dt><b>Parameters:</b></dt><dd>
385   <table border="0" cellspacing="2" cellpadding="0">
386     <tr><td valign="top"></td><td valign="top"><em>list</em>&nbsp;</td><td>of translations for given word which will be received in <a class="el" href="classGUIInterface.html#a0387f70e18b390cf1e229cbeb27a61c8" title="Gets word list from backbone and prepares received list to display.">wordListReady()</a> slot </td></tr>
387   </table>
388   </dd>
389 </dl>
390 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classGUIInterface.html#a0387f70e18b390cf1e229cbeb27a61c8" title="Gets word list from backbone and prepares received list to display.">wordListReady()</a> </dd></dl>
391
392 </div>
393 </div>
394 <a class="anchor" id="af1012152ba1c3683c19bb5de68cc34ec"></a><!-- doxytag: member="GUIInterface::searchWordList" ref="af1012152ba1c3683c19bb5de68cc34ec" args="(QString word)" -->
395 <div class="memitem">
396 <div class="memproto">
397       <table class="memname">
398         <tr>
399           <td class="memname">void GUIInterface::searchWordList </td>
400           <td>(</td>
401           <td class="paramtype">QString&nbsp;</td>
402           <td class="paramname"> <em>word</em></td>
403           <td>&nbsp;)&nbsp;</td>
404           <td><code> [signal]</code></td>
405         </tr>
406       </table>
407 </div>
408 <div class="memdoc">
409
410 <p>Emited when user want to search for list of words matching given word. </p>
411 <dl><dt><b>Parameters:</b></dt><dd>
412   <table border="0" cellspacing="2" cellpadding="0">
413     <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>word which will be matched, it can contains wildcards </td></tr>
414   </table>
415   </dd>
416 </dl>
417
418 </div>
419 </div>
420 <a class="anchor" id="a46465786e5e8b629b51b5dd2e5c51181"></a><!-- doxytag: member="GUIInterface::selectedDictionaries" ref="a46465786e5e8b629b51b5dd2e5c51181" args="(QList&lt; CommonDictInterface * &gt;)" -->
421 <div class="memitem">
422 <div class="memproto">
423       <table class="memname">
424         <tr>
425           <td class="memname">void GUIInterface::selectedDictionaries </td>
426           <td>(</td>
427           <td class="paramtype">QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt;&nbsp;</td>
428           <td class="paramname"> <em>_t1</em></td>
429           <td>&nbsp;)&nbsp;</td>
430           <td><code> [signal]</code></td>
431         </tr>
432       </table>
433 </div>
434 <div class="memdoc">
435
436 <p>Emited when user changes dictionaries active/inactive states. </p>
437 <dl><dt><b>Parameters:</b></dt><dd>
438   <table border="0" cellspacing="2" cellpadding="0">
439     <tr><td valign="top"></td><td valign="top"><em>list</em>&nbsp;</td><td>of only active dictionaries </td></tr>
440   </table>
441   </dd>
442 </dl>
443
444 </div>
445 </div>
446 <a class="anchor" id="a2af4fcfe33ffab1cb2de6972b2eb66b8"></a><!-- doxytag: member="GUIInterface::setBusy" ref="a2af4fcfe33ffab1cb2de6972b2eb66b8" args="()" -->
447 <div class="memitem">
448 <div class="memproto">
449       <table class="memname">
450         <tr>
451           <td class="memname">void GUIInterface::setBusy </td>
452           <td>(</td>
453           <td class="paramname"></td>
454           <td>&nbsp;)&nbsp;</td>
455           <td><code> [signal]</code></td>
456         </tr>
457       </table>
458 </div>
459 <div class="memdoc">
460 <p>Emited when starting search, will disable GUI components and shows progress bars </p>
461
462 </div>
463 </div>
464 <a class="anchor" id="a4d9a8b5392fdbcec9a0b8663eba3c571"></a><!-- doxytag: member="GUIInterface::setExactSearch" ref="a4d9a8b5392fdbcec9a0b8663eba3c571" args="(bool exactSearch)" -->
465 <div class="memitem">
466 <div class="memproto">
467       <table class="memname">
468         <tr>
469           <td class="memname">void GUIInterface::setExactSearch </td>
470           <td>(</td>
471           <td class="paramtype">bool&nbsp;</td>
472           <td class="paramname"> <em>exactSearch</em></td>
473           <td>&nbsp;)&nbsp;</td>
474           <td></td>
475         </tr>
476       </table>
477 </div>
478 <div class="memdoc">
479
480 <p>Sets GUI exact search mode. </p>
481 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classGUIInterface.html#a83f7716f43447730aeda078cc202d48b" title="Indicates if GUI is in exact search mode.">exactSearch()</a> </dd></dl>
482
483 <p>Reimplemented in <a class="el" href="classMainWindow.html#a78e044c5bd7446b0d2105f98573b9489">MainWindow</a>.</p>
484
485 </div>
486 </div>
487 <a class="anchor" id="a10454da99d774b68a38f1f0c374c4c51"></a><!-- doxytag: member="GUIInterface::showTranslation" ref="a10454da99d774b68a38f1f0c374c4c51" args="(QStringList)" -->
488 <div class="memitem">
489 <div class="memproto">
490       <table class="memname">
491         <tr>
492           <td class="memname">void GUIInterface::showTranslation </td>
493           <td>(</td>
494           <td class="paramtype">QStringList&nbsp;</td>
495           <td class="paramname"> <em>_t1</em></td>
496           <td>&nbsp;)&nbsp;</td>
497           <td><code> [signal]</code></td>
498         </tr>
499       </table>
500 </div>
501 <div class="memdoc">
502 <p>Emited after received translation strings in <a class="el" href="classGUIInterface.html#abd81fe53691de8c942be152a099bd21b" title="Gets translation strings from backbone and emit signal to display them.">translationsReady()</a> slot, will display translation of given word</p>
503 <dl><dt><b>Parameters:</b></dt><dd>
504   <table border="0" cellspacing="2" cellpadding="0">
505     <tr><td valign="top"></td><td valign="top"><em>list</em>&nbsp;</td><td>of translations from different dictionaries in dictionaries </td></tr>
506   </table>
507   </dd>
508 </dl>
509
510 </div>
511 </div>
512 <a class="anchor" id="acaa643ecd68519b1b66f76cb5eaabe4e"></a><!-- doxytag: member="GUIInterface::showWordList" ref="acaa643ecd68519b1b66f76cb5eaabe4e" args="(QHash&lt; QString, QList&lt; Translation * &gt; &gt;)" -->
513 <div class="memitem">
514 <div class="memproto">
515       <table class="memname">
516         <tr>
517           <td class="memname">void GUIInterface::showWordList </td>
518           <td>(</td>
519           <td class="paramtype">QHash&lt; QString, QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt; &gt;&nbsp;</td>
520           <td class="paramname"> <em>_t1</em></td>
521           <td>&nbsp;)&nbsp;</td>
522           <td><code> [signal]</code></td>
523         </tr>
524       </table>
525 </div>
526 <div class="memdoc">
527 <p>Emited after received word list in <a class="el" href="classGUIInterface.html#a0387f70e18b390cf1e229cbeb27a61c8" title="Gets word list from backbone and prepares received list to display.">wordListReady()</a> slot, will display list of matched words</p>
528 <dl><dt><b>Parameters:</b></dt><dd>
529   <table border="0" cellspacing="2" cellpadding="0">
530     <tr><td valign="top"></td><td valign="top"><em>hash</em>&nbsp;</td><td>of word and list of translation of this word found in dictionaries </td></tr>
531   </table>
532   </dd>
533 </dl>
534
535 </div>
536 </div>
537 <a class="anchor" id="a0387f70e18b390cf1e229cbeb27a61c8"></a><!-- doxytag: member="GUIInterface::wordListReady" ref="a0387f70e18b390cf1e229cbeb27a61c8" args="()=0" -->
538 <div class="memitem">
539 <div class="memproto">
540       <table class="memname">
541         <tr>
542           <td class="memname">virtual void GUIInterface::wordListReady </td>
543           <td>(</td>
544           <td class="paramname"></td>
545           <td>&nbsp;)&nbsp;</td>
546           <td><code> [pure virtual, slot]</code></td>
547         </tr>
548       </table>
549 </div>
550 <div class="memdoc">
551
552 <p>Gets word list from backbone and prepares received list to display. </p>
553 <p>Checks if received list is empty, in that case displays suitable information. If GUI is in exact search mode it will search for exact word in received list, and if word is found it will emit signal to display it's translation. Otherwise it will display list of matching words and show suitable information. </p>
554 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classGUIInterface.html#a83f7716f43447730aeda078cc202d48b" title="Indicates if GUI is in exact search mode.">exactSearch()</a> </dd>
555 <dd>
556 <a class="el" href="classGUIInterface.html#a10454da99d774b68a38f1f0c374c4c51">showTranslation()</a> </dd></dl>
557
558 <p>Implemented in <a class="el" href="classMainWindow.html#a9a56d2e699da84f9647984852cb6041b">MainWindow</a>.</p>
559
560 </div>
561 </div>
562 <hr/>The documentation for this class was generated from the following files:<ul>
563 <li><a class="el" href="GUIInterface_8h_source.html">GUIInterface.h</a></li>
564 <li>moc_GUIInterface.cpp</li>
565 </ul>
566 </div>
567 <!--- window showing the filter options -->
568 <div id="MSearchSelectWindow"
569      onmouseover="return searchBox.OnSearchSelectShow()"
570      onmouseout="return searchBox.OnSearchSelectHide()"
571      onkeydown="return searchBox.OnSearchSelectKey(event)">
572 <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>
573
574 <!-- iframe showing the search results (closed by default) -->
575 <div id="MSearchResultsWindow">
576 <iframe src="" frameborder="0" 
577         name="MSearchResults" id="MSearchResults">
578 </iframe>
579 </div>
580
581 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by&nbsp;
582 <a href="http://www.doxygen.org/index.html">
583 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
584 </body>
585 </html>