a570c0aab852fe38881ad7f1785057b60e1bc81f
[mdictionary] / doc / html / xdxfplugin_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: xdxfplugin.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>xdxfplugin.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="preprocessor">#ifndef XDXFPLUGIN_H</span>
65 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define XDXFPLUGIN_H</span>
66 <a name="l00024"></a>00024 <span class="preprocessor"></span>
67 <a name="l00025"></a>00025 <span class="preprocessor">#include &quot;../../../includes/CommonDictInterface.h&quot;</span>
68 <a name="l00026"></a>00026 <span class="preprocessor">#include &lt;QObject&gt;</span>
69 <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;QDialog&gt;</span>
70 <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QRegExp&gt;</span>
71 <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;QTime&gt;</span>
72 <a name="l00030"></a>00030 <span class="preprocessor">#include &quot;XdxfDictDialog.h&quot;</span>
73 <a name="l00031"></a>00031 
74 <a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classTranslationXdxf.html">TranslationXdxf</a>;
75 <a name="l00033"></a>00033 
76 <a name="l00034"></a><a class="code" href="classXdxfPlugin.html">00034</a> <span class="keyword">class </span><a class="code" href="classXdxfPlugin.html">XdxfPlugin</a> : <span class="keyword">public</span> <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>
77 <a name="l00035"></a>00035 {
78 <a name="l00036"></a>00036     Q_OBJECT
79 <a name="l00037"></a>00037     Q_INTERFACES(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>)
80 <a name="l00038"></a>00038 <span class="keyword">public</span>:
81 <a name="l00039"></a>00039     <a class="code" href="classXdxfPlugin.html">XdxfPlugin</a>(QObject *parent=0);
82 <a name="l00040"></a>00040 
83 <a name="l00042"></a>00042     QString <a class="code" href="classXdxfPlugin.html#a512b66dd3e147cc86a2bc3e9418104fc" title="returns source language code iso 639-2">langFrom</a>() <span class="keyword">const</span>;
84 <a name="l00043"></a>00043 
85 <a name="l00045"></a>00045     QString <a class="code" href="classXdxfPlugin.html#a6969b031c270fd556fcecf0e423c0895" title="returns destination language code iso 639-2">langTo</a>() <span class="keyword">const</span>;
86 <a name="l00046"></a>00046 
87 <a name="l00048"></a>00048     QString <a class="code" href="classXdxfPlugin.html#a860f2e7375797c80ed4a7eb8bdf1831b" title="returns dictionary name (like &amp;quot;old english&amp;quot; or so)">name</a>() <span class="keyword">const</span>;
88 <a name="l00049"></a>00049 
89 <a name="l00051"></a>00051     QString <a class="code" href="classXdxfPlugin.html#a1ef22204eed844d74f90b7222a122c5d" title="returns dictionary type (xdxf, google translate, etc)">type</a>() <span class="keyword">const</span>;
90 <a name="l00052"></a>00052 
91 <a name="l00054"></a>00054     QString <a class="code" href="classXdxfPlugin.html#ab3af2811d200d1901629e5fba8e64eb7" title="returns information about dictionary in html (name, authors, etc)">infoNote</a>() <span class="keyword">const</span>;
92 <a name="l00055"></a>00055 
93 <a name="l00059"></a>00059     <a class="code" href="classDictDialog.html" title="Interface for plugin dialog provider.">DictDialog</a>* <a class="code" href="classXdxfPlugin.html#ac6cbb0ef522b93927de69e5bfe3f7600" title="returns DictDialog object that creates dialogs for adding new dictionary and change...">dictDialog</a>();
94 <a name="l00060"></a>00060 
95 <a name="l00061"></a>00061 
96 <a name="l00063"></a>00063     <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>* <a class="code" href="classXdxfPlugin.html#a1c1fabf4653655f4f654e0ea31c14539" title="returns new, clean copy of plugin with setting set as in Settings*">getNew</a>(<span class="keyword">const</span> <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>*) <span class="keyword">const</span>;
97 <a name="l00064"></a>00064 
98 <a name="l00066"></a>00066     <span class="keywordtype">bool</span> <a class="code" href="classXdxfPlugin.html#a0a57cddf8db03190a2a49492cc7f43f4" title="returns whether plugin can start searching">isAvailable</a>() <span class="keyword">const</span>;
99 <a name="l00067"></a>00067 
100 <a name="l00069"></a>00069     QString <a class="code" href="classXdxfPlugin.html#a3439332c8624e64456c0b7b62c99bf42" title="returns a description of a word given by a QString">search</a>(QString key);
101 <a name="l00070"></a>00070 
102 <a name="l00072"></a>00072     uint <a class="code" href="classXdxfPlugin.html#a5e83f29b2eff00598470bb4b82961973" title="returns a unique hash for a dictionary">hash</a>() <span class="keyword">const</span>;
103 <a name="l00073"></a>00073 
104 <a name="l00075"></a>00075     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a74b5d40e3fa217a10c6ba790a9433086" title="set unique value (unique for every dictionary not plugin)">setHash</a>(uint);
105 <a name="l00076"></a>00076 
106 <a name="l00078"></a>00078     <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>* <a class="code" href="classXdxfPlugin.html#a115e0b340b8f9a5099b8f2a4f755dbfc" title="returns current plugin settings">settings</a>();
107 <a name="l00079"></a>00079 
108 <a name="l00081"></a>00081     <span class="keywordtype">long</span> <a class="code" href="classXdxfPlugin.html#aa52537c4bc22c3ea10ba53a716e9f8b0" title="returns words count in dictionary">wordsCount</a>();
109 <a name="l00082"></a>00082 
110 <a name="l00084"></a>00084     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a35802d08aadf5a070a7497008099ea47" title="Sets new settings.">setSettings</a>(<a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a>*);
111 <a name="l00085"></a>00085 
112 <a name="l00087"></a>00087     <span class="keyword">virtual</span> QIcon <a class="code" href="classXdxfPlugin.html#a01afa359e9ea2f40935349e7578c8b3b" title="returns plugin icon">icon</a>();
113 <a name="l00088"></a>00088 
114 <a name="l00089"></a>00089 <span class="keyword">public</span> Q_SLOTS:
115 <a name="l00097"></a>00097     QList&lt;Translation*&gt; <a class="code" href="classXdxfPlugin.html#a538581955ba04d1316f1a8befab4d561" title="performs search in dictionary">searchWordList</a>(QString word, <span class="keywordtype">int</span> limit=0);
116 <a name="l00098"></a>00098 
117 <a name="l00100"></a>00100     <span class="keywordtype">void</span> <a class="code" href="classXdxfPlugin.html#a93d9ca6bbd8cc5b5cbda418f6499025b" title="stop current operation">stop</a>();
118 <a name="l00101"></a>00101 
119 <a name="l00102"></a>00102 
120 <a name="l00103"></a>00103 <span class="keyword">protected</span>:
121 <a name="l00104"></a>00104     QString removeAccents(QString);
122 <a name="l00105"></a>00105 
123 <a name="l00106"></a>00106 <span class="keyword">private</span>:
124 <a name="l00110"></a>00110     <span class="keywordtype">bool</span> isCached();
125 <a name="l00111"></a>00111 
126 <a name="l00113"></a>00113     <span class="keywordtype">void</span> setPath(QString);
127 <a name="l00114"></a>00114 
128 <a name="l00116"></a>00116     QString _langFrom;
129 <a name="l00118"></a>00118     QString _langTo;
130 <a name="l00120"></a>00120     QString _name;
131 <a name="l00122"></a>00122     QString _type;
132 <a name="l00124"></a>00124     QString _infoNote;
133 <a name="l00125"></a>00125     QDialog *_loadDialog;
134 <a name="l00126"></a>00126     QDialog *_settingsDialog;
135 <a name="l00128"></a>00128     QString path;
136 <a name="l00129"></a>00129     uint _hash;
137 <a name="l00130"></a>00130     QIcon _icon;
138 <a name="l00131"></a>00131 
139 <a name="l00133"></a>00133     <span class="keywordtype">long</span> _wordsCount;
140 <a name="l00134"></a>00134 
141 <a name="l00136"></a>00136     <span class="keywordtype">void</span> getDictionaryInfo();
142 <a name="l00137"></a>00137 
143 <a name="l00138"></a>00138     <span class="keyword">volatile</span> <span class="keywordtype">bool</span> stopped;
144 <a name="l00139"></a>00139     <a class="code" href="classSettings.html" title="Plugin specific configuration.">Settings</a> *_settings;
145 <a name="l00140"></a>00140     <a class="code" href="classXdxfDictDialog.html" title="Implementation of DictDialog interface for xdxf plugin.">XdxfDictDialog</a>* _dictDialog;
146 <a name="l00141"></a>00141 };
147 <a name="l00142"></a>00142 
148 <a name="l00143"></a>00143 <span class="preprocessor">#endif // XDXFPLUGIN_H</span>
149 <a name="l00144"></a>00144 <span class="preprocessor"></span>
150 <a name="l00145"></a>00145 
151 </pre></div></div>
152 <!--- window showing the filter options -->
153 <div id="MSearchSelectWindow"
154      onmouseover="return searchBox.OnSearchSelectShow()"
155      onmouseout="return searchBox.OnSearchSelectHide()"
156      onkeydown="return searchBox.OnSearchSelectKey(event)">
157 <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>
158
159 <!-- iframe showing the search results (closed by default) -->
160 <div id="MSearchResultsWindow">
161 <iframe src="" frameborder="0" 
162         name="MSearchResults" id="MSearchResults">
163 </iframe>
164 </div>
165
166 <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 12 14:34:59 2010 for mDictionary by&nbsp;
167 <a href="http://www.doxygen.org/index.html">
168 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
169 </body>
170 </html>