766398b47047875bb7c2ee68d51f1402065436d8
[mdictionary] / doc / html / GUIInterface_8h_source.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.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
22       <li class="current"><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="files.html"><span>File&nbsp;List</span></a></li>
41     </ul>
42   </div>
43 <h1>GUIInterface.h</h1><a href="GUIInterface_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*******************************************************************************</span>
44 <a name="l00002"></a>00002 <span class="comment"></span>
45 <a name="l00003"></a>00003 <span class="comment">    This file is part of mDictionary.</span>
46 <a name="l00004"></a>00004 <span class="comment"></span>
47 <a name="l00005"></a>00005 <span class="comment">    mDictionary is free software: you can redistribute it and/or modify</span>
48 <a name="l00006"></a>00006 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
49 <a name="l00007"></a>00007 <span class="comment">    the Free Software Foundation, either version 3 of the License, or</span>
50 <a name="l00008"></a>00008 <span class="comment">    (at your option) any later version.</span>
51 <a name="l00009"></a>00009 <span class="comment"></span>
52 <a name="l00010"></a>00010 <span class="comment">    mDictionary is distributed in the hope that it will be useful,</span>
53 <a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
54 <a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
55 <a name="l00013"></a>00013 <span class="comment">    GNU General Public License for more details.</span>
56 <a name="l00014"></a>00014 <span class="comment"></span>
57 <a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU General Public License</span>
58 <a name="l00016"></a>00016 <span class="comment">    along with mDictionary.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
59 <a name="l00017"></a>00017 <span class="comment"></span>
60 <a name="l00018"></a>00018 <span class="comment">    Copyright 2010 Comarch S.A.</span>
61 <a name="l00019"></a>00019 <span class="comment"></span>
62 <a name="l00020"></a>00020 <span class="comment">*******************************************************************************/</span>
63 <a name="l00024"></a>00024 
64 <a name="l00025"></a>00025 
65 <a name="l00026"></a>00026 
66 <a name="l00027"></a>00027 <span class="preprocessor">#ifndef GUIINTERFACE_H</span>
67 <a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define GUIINTERFACE_H</span>
68 <a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#include &lt;QMainWindow&gt;</span>
69 <a name="l00030"></a>00030 <span class="preprocessor">#include &lt;QMultiHash&gt;</span>
70 <a name="l00031"></a>00031 
71 <a name="l00032"></a>00032 <span class="preprocessor">#include &quot;translation.h&quot;</span>
72 <a name="l00033"></a>00033 <span class="preprocessor">#include &quot;CommonDictInterface.h&quot;</span>
73 <a name="l00034"></a>00034 
74 <a name="l00036"></a>00036 
75 <a name="l00039"></a><a class="code" href="classGUIInterface.html">00039</a> <span class="keyword">class </span><a class="code" href="classGUIInterface.html" title="Interface for different GUIs.">GUIInterface</a> : <span class="keyword">public</span> QMainWindow {
76 <a name="l00040"></a>00040     Q_OBJECT
77 <a name="l00041"></a>00041 
78 <a name="l00042"></a>00042 <span class="keyword">public</span>:
79 <a name="l00043"></a>00043     <a class="code" href="classGUIInterface.html" title="Interface for different GUIs.">GUIInterface</a>(QWidget *parent = 0) :QMainWindow(parent) {}
80 <a name="l00044"></a>00044 
81 <a name="l00045"></a>00045     <span class="keyword">virtual</span> ~<a class="code" href="classGUIInterface.html" title="Interface for different GUIs.">GUIInterface</a>() {}
82 <a name="l00046"></a>00046 
83 <a name="l00049"></a>00049 
84 <a name="l00053"></a>00053     <span class="keyword">virtual</span> QHash&lt;CommonDictInterface*, bool&gt; <a class="code" href="classGUIInterface.html#a65f5532b1d404c41f22e6408138bd87a">getDictionaries</a>() = 0;
85 <a name="l00054"></a>00054 
86 <a name="l00055"></a>00055 
87 <a name="l00057"></a>00057 
88 <a name="l00060"></a>00060     <span class="keyword">virtual</span> QList&lt;CommonDictInterface*&gt; <a class="code" href="classGUIInterface.html#a232872064056fdcfa752b314d9e34bfa" title="Returns all loaded plugins.">getPlugins</a>() = 0;
89 <a name="l00061"></a>00061 
90 <a name="l00063"></a>00063 
91 <a name="l00070"></a>00070     <span class="keywordtype">bool</span> <a class="code" href="classGUIInterface.html#a83f7716f43447730aeda078cc202d48b" title="Indicates if GUI is in exact search mode.">exactSearch</a>();
92 <a name="l00071"></a>00071 
93 <a name="l00073"></a>00073 
94 <a name="l00074"></a>00074     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a4d9a8b5392fdbcec9a0b8663eba3c571" title="Sets GUI exact search mode.">setExactSearch</a>(<span class="keywordtype">bool</span> exactSearch);
95 <a name="l00075"></a>00075 
96 <a name="l00076"></a>00076 
97 <a name="l00077"></a>00077 <span class="keyword">public</span> Q_SLOTS:
98 <a name="l00079"></a>00079 
99 <a name="l00084"></a>00084     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a39d3969fbadaea6da410a93dc3bebdd7" title="Search in exact mode for given word.">searchExact</a>(QString word) = 0;
100 <a name="l00085"></a>00085 
101 <a name="l00087"></a>00087 
102 <a name="l00094"></a>00094     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a4081962fcbd7e8063bb87fcc444b6124" title="Adds to history key words from given translations.">addToHistory</a>(QList&lt;Translation*&gt;) = 0;
103 <a name="l00095"></a>00095 
104 <a name="l00097"></a>00097     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#aa7a21fe2438ac72d9bc7843733ee2e3b" title="Shows history dialog.">showHistory</a>() = 0;
105 <a name="l00098"></a>00098 
106 <a name="l00100"></a>00100 
107 <a name="l00105"></a>00105     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a9b9d53a56b052cf4c7d5e5bc158b8036" title="Shows translation of next word in history.">historyNext</a>() = 0;
108 <a name="l00106"></a>00106 
109 <a name="l00108"></a>00108 
110 <a name="l00113"></a>00113     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a47243e01c2d2e3887ee3fef656f84475" title="Shows translation of previous word in history.">historyPrev</a>() = 0;
111 <a name="l00114"></a>00114 
112 <a name="l00116"></a>00116 
113 <a name="l00125"></a>00125     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a0387f70e18b390cf1e229cbeb27a61c8" title="Gets word list from backbone and prepares received list to display.">wordListReady</a>() = 0;
114 <a name="l00126"></a>00126 
115 <a name="l00128"></a>00128     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#abd81fe53691de8c942be152a099bd21b" title="Gets translation strings from backbone and emit signal to display them.">translationsReady</a>() = 0;
116 <a name="l00129"></a>00129 
117 <a name="l00130"></a>00130 Q_SIGNALS:
118 <a name="l00133"></a>00133     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a66c9b1a0743e55a456831b91d4674d86">quit</a>();
119 <a name="l00134"></a>00134 
120 <a name="l00136"></a>00136 
121 <a name="l00138"></a>00138     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#af1012152ba1c3683c19bb5de68cc34ec" title="Emited when user want to search for list of words matching given word.">searchWordList</a>(QString word);
122 <a name="l00139"></a>00139 
123 <a name="l00141"></a>00141 
124 <a name="l00145"></a>00145     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a9855cd24df15d961ec062f0c6b80a263" title="Emited when user wants to see translation of words.">searchTranslations</a>(QList&lt;Translation*&gt;);
125 <a name="l00146"></a>00146 
126 <a name="l00149"></a>00149     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a2af4fcfe33ffab1cb2de6972b2eb66b8">setBusy</a>();
127 <a name="l00150"></a>00150 
128 <a name="l00152"></a>00152     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a605a50fb08e4149cbe26c00189227a88" title="Emited when searching ends, will enable GUI components.">setIdle</a>();
129 <a name="l00153"></a>00153 
130 <a name="l00155"></a>00155     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#aee6a89f4fd62e09d552af5522121a036" title="Emited when user want to break search.">stopSearching</a>();
131 <a name="l00156"></a>00156 
132 <a name="l00159"></a>00159 
133 <a name="l00162"></a>00162     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#acaa643ecd68519b1b66f76cb5eaabe4e">showWordList</a>(QHash&lt;QString, QList&lt;Translation*&gt; &gt;);
134 <a name="l00163"></a>00163 
135 <a name="l00166"></a>00166 
136 <a name="l00169"></a>00169     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a10454da99d774b68a38f1f0c374c4c51">showTranslation</a>(QStringList);
137 <a name="l00170"></a>00170 
138 <a name="l00172"></a>00172 
139 <a name="l00174"></a>00174     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a39f9eea230008cb063d5aeac0158e13a" title="Emited when user wants to add new dictionary.">addNewDictionary</a>(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>*);
140 <a name="l00175"></a>00175 
141 <a name="l00177"></a>00177 
142 <a name="l00179"></a>00179     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a4bcc5403e1c18a67e5378de713bd6c66" title="Emited when user wants to remove dictionary.">removeDictionary</a>(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>*);
143 <a name="l00180"></a>00180 
144 <a name="l00182"></a>00182 
145 <a name="l00184"></a>00184     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a46465786e5e8b629b51b5dd2e5c51181" title="Emited when user changes dictionaries active/inactive states.">selectedDictionaries</a>(QList&lt;CommonDictInterface* &gt;);
146 <a name="l00185"></a>00185 };
147 <a name="l00186"></a>00186 
148 <a name="l00187"></a>00187 <span class="preprocessor">#endif // GUIINTERFACE_H</span>
149 </pre></div></div>
150 <!--- window showing the filter options -->
151 <div id="MSearchSelectWindow"
152      onmouseover="return searchBox.OnSearchSelectShow()"
153      onmouseout="return searchBox.OnSearchSelectHide()"
154      onkeydown="return searchBox.OnSearchSelectKey(event)">
155 <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>
156
157 <!-- iframe showing the search results (closed by default) -->
158 <div id="MSearchResultsWindow">
159 <iframe src="" frameborder="0" 
160         name="MSearchResults" id="MSearchResults">
161 </iframe>
162 </div>
163
164 <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 12 14:34:59 2010 for mDictionary by&nbsp;
165 <a href="http://www.doxygen.org/index.html">
166 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
167 </body>
168 </html>