Added documentation

[mdictionary] / doc / html / GUIInterface_8h_source.html

diff --git a/doc/html/GUIInterface_8h_source.html b/doc/html/GUIInterface_8h_source.html
index 766398b..a0d8cd1 100644 (file)
--- a/doc/html/GUIInterface_8h_source.html
+++ b/doc/html/GUIInterface_8h_source.html
@@ -71,81 +71,89 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 <a name="l00032"></a>00032 <span class="preprocessor">#include &quot;translation.h&quot;</span>
 <a name="l00033"></a>00033 <span class="preprocessor">#include &quot;CommonDictInterface.h&quot;</span>
 <a name="l00034"></a>00034 
+<a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>;
 <a name="l00036"></a>00036 
-<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 {
-<a name="l00040"></a>00040     Q_OBJECT
-<a name="l00041"></a>00041 
-<a name="l00042"></a>00042 <span class="keyword">public</span>:
-<a name="l00043"></a>00043     <a class="code" href="classGUIInterface.html" title="Interface for different GUIs.">GUIInterface</a>(QWidget *parent = 0) :QMainWindow(parent) {}
-<a name="l00044"></a>00044 
-<a name="l00045"></a>00045     <span class="keyword">virtual</span> ~<a class="code" href="classGUIInterface.html" title="Interface for different GUIs.">GUIInterface</a>() {}
+<a name="l00038"></a>00038 
+<a name="l00041"></a><a class="code" href="classGUIInterface.html">00041</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 {
+<a name="l00042"></a>00042     Q_OBJECT
+<a name="l00043"></a>00043 
+<a name="l00044"></a>00044 <span class="keyword">public</span>:
+<a name="l00045"></a>00045     <a class="code" href="classGUIInterface.html" title="Interface for different GUIs.">GUIInterface</a>(QWidget *parent = 0) :QMainWindow(parent) {}
 <a name="l00046"></a>00046 
-<a name="l00049"></a>00049 
-<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;
-<a name="l00054"></a>00054 
-<a name="l00055"></a>00055 
+<a name="l00047"></a>00047     <span class="keyword">virtual</span> ~<a class="code" href="classGUIInterface.html" title="Interface for different GUIs.">GUIInterface</a>() {}
+<a name="l00048"></a>00048 
+<a name="l00051"></a>00051 
+<a name="l00055"></a>00055     <span class="keyword">virtual</span> QHash&lt;CommonDictInterface*, bool&gt; <a class="code" href="classGUIInterface.html#a65f5532b1d404c41f22e6408138bd87a">getDictionaries</a>() = 0;
+<a name="l00056"></a>00056 
 <a name="l00057"></a>00057 
-<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;
-<a name="l00061"></a>00061 
+<a name="l00059"></a>00059 
+<a name="l00062"></a>00062     <span class="keyword">virtual</span> QList&lt;CommonDictInterface*&gt; <a class="code" href="classGUIInterface.html#a232872064056fdcfa752b314d9e34bfa" title="Returns all loaded plugins.">getPlugins</a>() = 0;
 <a name="l00063"></a>00063 
-<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>();
-<a name="l00071"></a>00071 
+<a name="l00065"></a>00065 
+<a name="l00072"></a>00072     <span class="keywordtype">bool</span> <a class="code" href="classGUIInterface.html#a83f7716f43447730aeda078cc202d48b" title="Indicates if GUI is in exact search mode.">exactSearch</a>();
 <a name="l00073"></a>00073 
-<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);
 <a name="l00075"></a>00075 
-<a name="l00076"></a>00076 
-<a name="l00077"></a>00077 <span class="keyword">public</span> Q_SLOTS:
+<a name="l00076"></a>00076     <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);
+<a name="l00077"></a>00077 
+<a name="l00078"></a>00078     <span class="keyword">virtual</span> <a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>* settings() = 0;
 <a name="l00079"></a>00079 
-<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;
+<a name="l00080"></a>00080     <span class="keyword">virtual</span> <span class="keywordtype">void</span> setSettings(<a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>*) = 0;
+<a name="l00081"></a>00081 
+<a name="l00082"></a>00082 
+<a name="l00083"></a>00083 <span class="keyword">public</span> Q_SLOTS:
 <a name="l00085"></a>00085 
-<a name="l00087"></a>00087 
-<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;
-<a name="l00095"></a>00095 
-<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;
-<a name="l00098"></a>00098 
-<a name="l00100"></a>00100 
-<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;
+<a name="l00090"></a>00090     <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;
+<a name="l00091"></a>00091 
+<a name="l00093"></a>00093 
+<a name="l00100"></a>00100     <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;
+<a name="l00101"></a>00101 
+<a name="l00103"></a>00103     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#aa7a21fe2438ac72d9bc7843733ee2e3b" title="Shows history dialog.">showHistory</a>() = 0;
+<a name="l00104"></a>00104 
 <a name="l00106"></a>00106 
-<a name="l00108"></a>00108 
-<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;
+<a name="l00111"></a>00111     <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;
+<a name="l00112"></a>00112 
 <a name="l00114"></a>00114 
-<a name="l00116"></a>00116 
-<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;
-<a name="l00126"></a>00126 
-<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;
-<a name="l00129"></a>00129 
-<a name="l00130"></a>00130 Q_SIGNALS:
-<a name="l00133"></a>00133     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a66c9b1a0743e55a456831b91d4674d86">quit</a>();
-<a name="l00134"></a>00134 
-<a name="l00136"></a>00136 
-<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);
-<a name="l00139"></a>00139 
-<a name="l00141"></a>00141 
-<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;);
-<a name="l00146"></a>00146 
-<a name="l00149"></a>00149     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a2af4fcfe33ffab1cb2de6972b2eb66b8">setBusy</a>();
-<a name="l00150"></a>00150 
-<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>();
-<a name="l00153"></a>00153 
-<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>();
+<a name="l00119"></a>00119     <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;
+<a name="l00120"></a>00120 
+<a name="l00122"></a>00122 
+<a name="l00131"></a>00131     <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;
+<a name="l00132"></a>00132 
+<a name="l00134"></a>00134     <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;
+<a name="l00135"></a>00135 
+<a name="l00136"></a>00136 Q_SIGNALS:
+<a name="l00139"></a>00139     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a66c9b1a0743e55a456831b91d4674d86">quit</a>();
+<a name="l00140"></a>00140 
+<a name="l00142"></a>00142 
+<a name="l00144"></a>00144     <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);
+<a name="l00145"></a>00145 
+<a name="l00147"></a>00147 
+<a name="l00151"></a>00151     <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;);
+<a name="l00152"></a>00152 
+<a name="l00155"></a>00155     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a2af4fcfe33ffab1cb2de6972b2eb66b8">setBusy</a>();
 <a name="l00156"></a>00156 
+<a name="l00158"></a>00158     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a605a50fb08e4149cbe26c00189227a88" title="Emited when searching ends, will enable GUI components.">setIdle</a>();
 <a name="l00159"></a>00159 
-<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;);
-<a name="l00163"></a>00163 
-<a name="l00166"></a>00166 
-<a name="l00169"></a>00169     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a10454da99d774b68a38f1f0c374c4c51">showTranslation</a>(QStringList);
-<a name="l00170"></a>00170 
+<a name="l00161"></a>00161     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#aee6a89f4fd62e09d552af5522121a036" title="Emited when user want to break search.">stopSearching</a>();
+<a name="l00162"></a>00162 
+<a name="l00165"></a>00165 
+<a name="l00168"></a>00168     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#acaa643ecd68519b1b66f76cb5eaabe4e">showWordList</a>(QHash&lt;QString, QList&lt;Translation*&gt; &gt;);
+<a name="l00169"></a>00169 
 <a name="l00172"></a>00172 
-<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>*);
-<a name="l00175"></a>00175 
-<a name="l00177"></a>00177 
-<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>*);
-<a name="l00180"></a>00180 
-<a name="l00182"></a>00182 
-<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;);
-<a name="l00185"></a>00185 };
+<a name="l00175"></a>00175     <span class="keywordtype">void</span> <a class="code" href="classGUIInterface.html#a10454da99d774b68a38f1f0c374c4c51">showTranslation</a>(QStringList);
+<a name="l00176"></a>00176 
+<a name="l00178"></a>00178 
+<a name="l00180"></a>00180     <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>*);
+<a name="l00181"></a>00181 
+<a name="l00183"></a>00183 
+<a name="l00185"></a>00185     <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>*);
 <a name="l00186"></a>00186 
-<a name="l00187"></a>00187 <span class="preprocessor">#endif // GUIINTERFACE_H</span>
+<a name="l00188"></a>00188 
+<a name="l00190"></a>00190     <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;);
+<a name="l00191"></a>00191 
+<a name="l00192"></a>00192     <span class="keywordtype">void</span> addToBookmarks(QList&lt;Translation*&gt;);
+<a name="l00193"></a>00193 };
+<a name="l00194"></a>00194 
+<a name="l00195"></a>00195 <span class="preprocessor">#endif // GUIINTERFACE_H</span>
 </pre></div></div>
 <!--- window showing the filter options -->
 <div id="MSearchSelectWindow"
@@ -161,7 +169,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </iframe>
 </div>
 
-<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 12 14:34:59 2010 for mDictionary by&nbsp;
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 </body>