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: backbone.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"/>
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><a href="annotated.html"><span>Classes</span></a></li>
22 <li class="current"><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="files.html"><span>File List</span></a></li>
43 <h1>backbone.h</h1><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 <http://www.gnu.org/licenses/>.</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="l00021"></a>00021
64 <a name="l00022"></a>00022 <span class="comment">// Created by Bartosz Szatkowski</span>
65 <a name="l00023"></a>00023
66 <a name="l00024"></a>00024 <span class="preprocessor">#ifndef BACKBONE_H</span>
67 <a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define BACKBONE_H</span>
68 <a name="l00026"></a>00026 <span class="preprocessor"></span>
69 <a name="l00027"></a>00027 <span class="preprocessor">#include <QObject></span>
70 <a name="l00028"></a>00028 <span class="preprocessor">#include <QList></span>
71 <a name="l00029"></a>00029 <span class="preprocessor">#include <QHash></span>
72 <a name="l00030"></a>00030 <span class="preprocessor">#include <QPluginLoader></span>
73 <a name="l00031"></a>00031 <span class="preprocessor">#include <QFuture></span>
74 <a name="l00032"></a>00032 <span class="preprocessor">#include <QtConcurrentRun></span>
75 <a name="l00033"></a>00033 <span class="preprocessor">#include <QTimer></span>
76 <a name="l00034"></a>00034 <span class="preprocessor">#include <QTime></span>
77 <a name="l00035"></a>00035 <span class="preprocessor">#include <QDir></span>
78 <a name="l00036"></a>00036 <span class="preprocessor">#include <QSettings></span>
79 <a name="l00037"></a>00037 <span class="preprocessor">#include "../../includes/CommonDictInterface.h"</span>
80 <a name="l00038"></a>00038 <span class="preprocessor">#include "../../includes/settings.h"</span>
81 <a name="l00039"></a>00039 <span class="preprocessor">#include "../../includes/translation.h"</span>
82 <a name="l00040"></a>00040 <span class="preprocessor">#include "../../includes/History.h"</span>
83 <a name="l00041"></a>00041
84 <a name="l00042"></a>00042
85 <a name="l00053"></a><a class="code" href="classBackbone.html">00053</a> <span class="keyword">class </span><a class="code" href="classBackbone.html" title="Inner part of dictionary - glues together GUI and plugins.">Backbone</a> : <span class="keyword">public</span> QObject
86 <a name="l00054"></a>00054 {
87 <a name="l00055"></a>00055 Q_OBJECT
88 <a name="l00056"></a>00056
89 <a name="l00057"></a>00057 <span class="keyword">public</span>:
90 <a name="l00060"></a>00060 <a class="code" href="classBackbone.html#a68059c8a2598fbbba42c29a332b2472f">Backbone</a>(QString pluginPath=<span class="stringliteral">""</span>, QString configPath=<span class="stringliteral">""</span>,
91 <a name="l00061"></a>00061 <span class="keywordtype">bool</span> dry = 0, QObject *parent = 0);
92 <a name="l00062"></a>00062 ~<a class="code" href="classBackbone.html" title="Inner part of dictionary - glues together GUI and plugins.">Backbone</a>();
93 <a name="l00063"></a>00063 <a class="code" href="classBackbone.html#a68059c8a2598fbbba42c29a332b2472f">Backbone</a>(<span class="keyword">const</span> <a class="code" href="classBackbone.html" title="Inner part of dictionary - glues together GUI and plugins.">Backbone</a>& b);
94 <a name="l00064"></a>00064
95 <a name="l00066"></a>00066 QHash<CommonDictInterface*, bool> <a class="code" href="classBackbone.html#a4b027f51bb4cc3803f6be85bc25d6a4b">getDictionaries</a>();
96 <a name="l00067"></a>00067
97 <a name="l00069"></a>00069 QList<CommonDictInterface*> <a class="code" href="classBackbone.html#a2fdfa0cf73fda5304635b61455b48db9">getPlugins</a>();
98 <a name="l00070"></a>00070
99 <a name="l00072"></a>00072 <a class="code" href="classHistory.html">History</a>* <a class="code" href="classBackbone.html#ac91e19871d56331ce0d744b8ea936e00">history</a>();
100 <a name="l00073"></a>00073
101 <a name="l00075"></a>00075 QMultiHash<QString, Translation*> <a class="code" href="classBackbone.html#adeaabfee86975f65b8e728b8582caa35">result</a>();
102 <a name="l00076"></a>00076
103 <a name="l00078"></a>00078 <span class="keywordtype">int</span> <a class="code" href="classBackbone.html#addad48903943006b6a4661169f80ee5a">searchLimit</a>() <span class="keyword">const</span>;
104 <a name="l00079"></a>00079
105 <a name="l00081"></a>00081 <span class="keywordtype">int</span> <a class="code" href="classBackbone.html#ad0ddecf22c51867e984cb4e6a745d67c">activeSearches</a>() <span class="keyword">const</span>;
106 <a name="l00082"></a>00082
107 <a name="l00083"></a>00083
108 <a name="l00084"></a>00084
109 <a name="l00086"></a>00086 QStringList <a class="code" href="classBackbone.html#a56df9bdfbe82998011f95ecb3c5bd7db">htmls</a>();
110 <a name="l00087"></a>00087
111 <a name="l00088"></a>00088
112 <a name="l00089"></a>00089 <span class="keyword">public</span> Q_SLOTS:
113 <a name="l00091"></a>00091 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a1ede318bd5d226a8fa566f13452fb07d" title="stops all current searches">stopSearching</a>();
114 <a name="l00092"></a>00092
115 <a name="l00096"></a>00096 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a3b1f2cf8de594cbd18bef4ca854337e2" title="search for a word translation">search</a>(QString word);
116 <a name="l00097"></a>00097
117 <a name="l00101"></a>00101 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#ac23b486119652095d956413a6e68afec" title="sets active dictionaries (searches are performed only in active dicts">selectedDictionaries</a>(QList<CommonDictInterface* >);
118 <a name="l00102"></a>00102
119 <a name="l00107"></a>00107 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#aaf91c7fe4e12d7007ca761dc89c14c8a" title="adds new dictionary and activate it">addDictionary</a>(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>* dict, <span class="keywordtype">bool</span> active = 1);
120 <a name="l00108"></a>00108
121 <a name="l00109"></a>00109
122 <a name="l00111"></a>00111 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#aa61afbf8ef2e05c0c2a9634fbdccad19" title="stops all current activity - emiting signal">quit</a>();
123 <a name="l00112"></a>00112
124 <a name="l00113"></a>00113
125 <a name="l00117"></a>00117 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a61b78f5ee989400a2b2d7630b8145bb8" title="Fired with given interval during searches - checking if translation is ready.">translationReady</a>();
126 <a name="l00118"></a>00118
127 <a name="l00122"></a>00122 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a0be266198b2ae39efcce38aabb984d61" title="Fired with given interval during html searches - checking if html is ready.">htmlTranslationReady</a>();
128 <a name="l00123"></a>00123
129 <a name="l00127"></a>00127 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a056fc494ed689f253d83fc2366c07931" title="Removes given dictionary.">removeDictionary</a>(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>* dict);
130 <a name="l00128"></a>00128
131 <a name="l00130"></a>00130 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a3ed4ea8df862807b83dfdec36e4c7ea8" title="saves plugins new state/configuration after each change">dictUpdated</a>();
132 <a name="l00131"></a>00131
133 <a name="l00135"></a>00135 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a67dbca9402d40e4678f879ff8da3866e" title="Performs search for final translation (html/xml) form.">searchHtml</a>(QList<Translation*>);
134 <a name="l00136"></a>00136
135 <a name="l00137"></a>00137 <span class="comment">// TODO addToBookmark(Translation*);</span>
136 <a name="l00138"></a>00138 <span class="comment">// TODO removeFromBookmark(Translation*);</span>
137 <a name="l00139"></a>00139
138 <a name="l00140"></a>00140 Q_SIGNALS:
139 <a name="l00143"></a>00143 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#afef04921ba89c424eb882cc14153de39" title="emmited when backbone is ready to close - after getting stop signal it should kill...">closeOk</a>();
140 <a name="l00144"></a>00144
141 <a name="l00146"></a>00146 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#ae50cec4f0c49149a46e913b31bcef92c" title="emitted when there are search result ready to fetch">ready</a>();
142 <a name="l00147"></a>00147
143 <a name="l00149"></a>00149 <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a7e218d1df6d69ddf3ddbc5c3d2ba9453" title="emitted when html result is ready to fetch">htmlReady</a>();
144 <a name="l00150"></a>00150
145 <a name="l00151"></a>00151
146 <a name="l00152"></a>00152
147 <a name="l00153"></a>00153 <span class="keyword">private</span>:
148 <a name="l00154"></a>00154 QHash<CommonDictInterface*, bool> _dicts;
149 <a name="l00155"></a>00155 QList<CommonDictInterface*> _plugins;
150 <a name="l00156"></a>00156 QList<QFuture<QList<Translation*> > > _innerResult;
151 <a name="l00157"></a>00157 QList<QFuture<QString> > _innerHtmlResult;
152 <a name="l00158"></a>00158 QMultiHash<QString, Translation*> _result;
153 <a name="l00159"></a>00159 QStringList _htmlResult;
154 <a name="l00160"></a>00160 QTimer _timerSearch, _timerHtmlSearch;
155 <a name="l00161"></a>00161 QTime _time;
156 <a name="l00162"></a>00162 QString _pluginPath, _defaultPluginPath;
157 <a name="l00163"></a>00163 QString _configPath;
158 <a name="l00164"></a>00164 QString _defaultConfigPath;
159 <a name="l00165"></a>00165 <span class="keywordtype">int</span> _searchLimit, _defaultSearchLimit;
160 <a name="l00166"></a>00166 <span class="keywordtype">int</span> _activeSearchNum;
161 <a name="l00167"></a>00167 <span class="keywordtype">int</span> _interval; <span class="comment">//Search fetching timer.timeout interval in msec</span>
162 <a name="l00168"></a>00168 <span class="keywordtype">int</span> _historyLen, _defaultHistoryLen;
163 <a name="l00169"></a>00169 <span class="keywordtype">bool</span> dryRun;
164 <a name="l00170"></a>00170
165 <a name="l00171"></a>00171 <span class="keywordtype">void</span> init();
166 <a name="l00172"></a>00172 QStringList getFilesFromDir(QString dir, QStringList nameFilter);
167 <a name="l00173"></a>00173 <span class="keywordtype">void</span> loadPlugins(); <span class="comment">//< locate and load plugins</span>
168 <a name="l00174"></a>00174 <span class="keywordtype">void</span> loadPrefs(QString fileName);
169 <a name="l00175"></a>00175 <span class="keywordtype">void</span> loadDicts(QString fileName, <span class="keywordtype">bool</span> _default=<span class="keyword">false</span>);
170 <a name="l00176"></a>00176 <span class="keywordtype">void</span> saveState(QSettings*, <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>*, <span class="keywordtype">bool</span>, uint);
171 <a name="l00177"></a>00177 <span class="keywordtype">void</span> addInternalDictionary(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>*, <span class="keywordtype">bool</span>);
172 <a name="l00178"></a>00178 <span class="keywordtype">void</span> savePrefs(QSettings*);
173 <a name="l00179"></a>00179 <span class="keywordtype">void</span> saveDefaultPrefs(QSettings*);
174 <a name="l00180"></a>00180 <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>* plugin(QString type); <span class="comment">//< search for given type plugin</span>
175 <a name="l00181"></a>00181
176 <a name="l00182"></a>00182 <a class="code" href="classHistory.html">History</a>* _history;
177 <a name="l00183"></a>00183
178 <a name="l00184"></a>00184 };
179 <a name="l00185"></a>00185
180 <a name="l00186"></a>00186 <span class="preprocessor">#endif // BACKBONE_H</span>
182 <!--- window showing the filter options -->
183 <div id="MSearchSelectWindow"
184 onmouseover="return searchBox.OnSearchSelectShow()"
185 onmouseout="return searchBox.OnSearchSelectHide()"
186 onkeydown="return searchBox.OnSearchSelectKey(event)">
187 <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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a></div>
189 <!-- iframe showing the search results (closed by default) -->
190 <div id="MSearchResultsWindow">
191 <iframe src="" frameborder="0"
192 name="MSearchResults" id="MSearchResults">
196 <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 12 14:34:59 2010 for mDictionary by
197 <a href="http://www.doxygen.org/index.html">
198 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
projects / mdictionary / blob