Added generated documentation
[mdictionary] / doc / html / backbone_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: 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"/>
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>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 &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="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 &lt;QObject&gt;</span>
70 <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QList&gt;</span>
71 <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;QHash&gt;</span>
72 <a name="l00030"></a>00030 <span class="preprocessor">#include &lt;QPluginLoader&gt;</span>
73 <a name="l00031"></a>00031 <span class="preprocessor">#include &quot;../../includes/CommonDictInterface.h&quot;</span>
74 <a name="l00032"></a>00032 <span class="preprocessor">#include &quot;../../includes/settings.h&quot;</span>
75 <a name="l00033"></a>00033 <span class="preprocessor">#include &quot;../../includes/translation.h&quot;</span>
76 <a name="l00034"></a>00034 
77 <a name="l00035"></a>00035 
78 <a name="l00037"></a><a class="code" href="classBackbone.html">00037</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
79 <a name="l00038"></a>00038 {
80 <a name="l00039"></a>00039     Q_OBJECT
81 <a name="l00040"></a>00040 
82 <a name="l00041"></a>00041 <span class="keyword">public</span>:
83 <a name="l00042"></a>00042     <a class="code" href="classBackbone.html" title="Inner part of dictionary - glues together GUI and plugins.">Backbone</a>(QObject *parent = 0);
84 <a name="l00043"></a>00043     ~<a class="code" href="classBackbone.html" title="Inner part of dictionary - glues together GUI and plugins.">Backbone</a>();
85 <a name="l00044"></a>00044     <a class="code" href="classBackbone.html" title="Inner part of dictionary - glues together GUI and plugins.">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>&amp; b);
86 <a name="l00045"></a>00045 
87 <a name="l00047"></a>00047     QHash&lt;CommonDictInterface*, bool&gt; <a class="code" href="classBackbone.html#a4b027f51bb4cc3803f6be85bc25d6a4b">getDictionaries</a>();
88 <a name="l00048"></a>00048 
89 <a name="l00050"></a>00050     QList&lt;CommonDictInterface*&gt; <a class="code" href="classBackbone.html#a2fdfa0cf73fda5304635b61455b48db9">getPlugins</a>();
90 <a name="l00051"></a>00051 
91 <a name="l00053"></a>00053     QList&lt;QString&gt; <a class="code" href="classBackbone.html#aad6c6a42de0c933f056354a5c6528f85">getHistory</a>(); <span class="comment">//TODO implementation needed (in future)</span>
92 <a name="l00054"></a>00054 
93 <a name="l00056"></a>00056     QMultiHash&lt;QString, Translation*&gt; <a class="code" href="classBackbone.html#adeaabfee86975f65b8e728b8582caa35">result</a>();
94 <a name="l00057"></a>00057 
95 <a name="l00059"></a>00059     <span class="keywordtype">int</span> <a class="code" href="classBackbone.html#addad48903943006b6a4661169f80ee5a">searchLimit</a>() <span class="keyword">const</span>;
96 <a name="l00060"></a>00060 
97 <a name="l00062"></a>00062     <span class="keywordtype">int</span> <a class="code" href="classBackbone.html#ad0ddecf22c51867e984cb4e6a745d67c">activeSearches</a>() <span class="keyword">const</span>;
98 <a name="l00063"></a>00063 
99 <a name="l00064"></a>00064 <span class="keyword">public</span> Q_SLOTS:
100 <a name="l00066"></a>00066     <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a1ede318bd5d226a8fa566f13452fb07d" title="stops all current searches">stopSearching</a>();
101 <a name="l00067"></a>00067 
102 <a name="l00069"></a>00069     <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a3b1f2cf8de594cbd18bef4ca854337e2" title="search for a word translation">search</a>(QString word);
103 <a name="l00070"></a>00070 
104 <a name="l00072"></a>00072     <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#ac23b486119652095d956413a6e68afec" title="sets active dictionaries">selectedDictionaries</a>(QList&lt;CommonDictInterface* &gt;);
105 <a name="l00073"></a>00073 
106 <a name="l00075"></a>00075     <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#af1f9ed9ee7f8b9e869092f2f9cd8cd3f" title="adds new dictionary">addDictionary</a>(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>* dict);
107 <a name="l00076"></a>00076 
108 <a name="l00077"></a>00077 
109 <a name="l00079"></a>00079     <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#aa61afbf8ef2e05c0c2a9634fbdccad19" title="stops all current activity and kill plugins - be ready to exit">quit</a>();
110 <a name="l00080"></a>00080 
111 <a name="l00081"></a>00081 
112 <a name="l00083"></a>00083     <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#a99fb5d8cdf33e7fdca74e9415d615150" title="Fired when dictionary call finalTranslation(..) with translation ready.">translation</a>(QList&lt;Translation*&gt;);
113 <a name="l00084"></a>00084 
114 <a name="l00085"></a>00085     <span class="comment">// TODO void removeDictionary(CommonDictInterface* dict);</span>
115 <a name="l00086"></a>00086     <span class="comment">// TODO addToBookmark(Translation*);</span>
116 <a name="l00087"></a>00087     <span class="comment">// TODO removeFromBookmark(Translation*);</span>
117 <a name="l00088"></a>00088 
118 <a name="l00089"></a>00089 Q_SIGNALS:
119 <a name="l00092"></a>00092     <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#afef04921ba89c424eb882cc14153de39">closeOk</a>();
120 <a name="l00093"></a>00093 
121 <a name="l00095"></a>00095     <span class="keywordtype">void</span> <a class="code" href="classBackbone.html#ae50cec4f0c49149a46e913b31bcef92c" title="emitted when there are search result ready to fetch">ready</a>();
122 <a name="l00096"></a>00096 
123 <a name="l00097"></a>00097 
124 <a name="l00098"></a>00098 
125 <a name="l00099"></a>00099 <span class="keyword">private</span>:
126 <a name="l00100"></a>00100     <span class="keywordtype">void</span> loadPlugins(); <span class="comment">//&lt; locate and load plugins</span>
127 <a name="l00101"></a>00101     QHash&lt;CommonDictInterface*, bool&gt; dicts;
128 <a name="l00102"></a>00102     QList&lt;CommonDictInterface*&gt; plugins;
129 <a name="l00103"></a>00103     QMultiHash&lt;QString, Translation*&gt; _result;
130 <a name="l00104"></a>00104     <span class="keywordtype">int</span> searchLimitv;
131 <a name="l00105"></a>00105     <span class="keywordtype">int</span> activeSearchNum;
132 <a name="l00106"></a>00106 
133 <a name="l00107"></a>00107 };
134 <a name="l00108"></a>00108 
135 <a name="l00109"></a>00109 <span class="preprocessor">#endif // BACKBONE_H</span>
136 </pre></div></div>
137 <!--- window showing the filter options -->
138 <div id="MSearchSelectWindow"
139      onmouseover="return searchBox.OnSearchSelectShow()"
140      onmouseout="return searchBox.OnSearchSelectHide()"
141      onkeydown="return searchBox.OnSearchSelectKey(event)">
142 <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>
143
144 <!-- iframe showing the search results (closed by default) -->
145 <div id="MSearchResultsWindow">
146 <iframe src="" frameborder="0" 
147         name="MSearchResults" id="MSearchResults">
148 </iframe>
149 </div>
150
151 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 4 12:02:54 2010 for mDictionary by&nbsp;
152 <a href="http://www.doxygen.org/index.html">
153 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
154 </body>
155 </html>