Added documentation
[mdictionary] / doc / html / MainWindow_8h_source.html
index 3c65443..6be736c 100644 (file)
@@ -66,98 +66,128 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 <a name="l00027"></a>00027 <span class="preprocessor"></span>
 <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QMainWindow&gt;</span>
 <a name="l00029"></a>00029 <span class="preprocessor">#include &quot;../../includes/GUIInterface.h&quot;</span>
-<a name="l00030"></a>00030 <span class="preprocessor">#include &quot;../backbone/backbone.h&quot;</span>
-<a name="l00031"></a>00031 <span class="preprocessor">#include &quot;<a class="code" href="TranslationWidget_8h.html" title="Implements translation widget.">TranslationWidget.h</a>&quot;</span>
-<a name="l00032"></a>00032 <span class="preprocessor">#include &quot;WordListWidget.h&quot;</span>
-<a name="l00033"></a>00033 <span class="preprocessor">#include &quot;<a class="code" href="SearchBarWidget_8h.html" title="Implements search bar.">SearchBarWidget.h</a>&quot;</span>
-<a name="l00034"></a>00034 <span class="preprocessor">#include &quot;<a class="code" href="MenuWidget_8h.html" title="Implements custom menu.">MenuWidget.h</a>&quot;</span>
-<a name="l00035"></a>00035 <span class="preprocessor">#include &quot;<a class="code" href="DictManagerWidget_8h.html" title="Dictionary management widget.">DictManagerWidget.h</a>&quot;</span>
-<a name="l00036"></a>00036 <span class="preprocessor">#include &quot;<a class="code" href="HistoryListDialog_8h.html" title="Implements history list dialog.">HistoryListDialog.h</a>&quot;</span>
-<a name="l00037"></a>00037 
-<a name="l00038"></a>00038 <span class="keyword">namespace </span>Ui {
-<a name="l00039"></a>00039     <span class="keyword">class </span><a class="code" href="classMainWindow.html" title="Implements interface for GUI.">MainWindow</a>;
-<a name="l00040"></a>00040 }
-<a name="l00041"></a>00041 
-<a name="l00043"></a>00043 
-<a name="l00050"></a><a class="code" href="classMainWindow.html">00050</a> <span class="keyword">class </span><a class="code" href="classMainWindow.html" title="Implements interface for GUI.">MainWindow</a> : <span class="keyword">public</span> <a class="code" href="classGUIInterface.html" title="Interface for different GUIs.">GUIInterface</a>
-<a name="l00051"></a>00051 {
-<a name="l00052"></a>00052     Q_OBJECT
-<a name="l00053"></a>00053 
-<a name="l00054"></a>00054 <span class="keyword">public</span>:
-<a name="l00056"></a>00056 
-<a name="l00061"></a>00061     <span class="keyword">explicit</span> <a class="code" href="classMainWindow.html#a4acc6192d273eb38e9082b4934202b81" title="Constructor.">MainWindow</a>(<a class="code" href="classBackbone.html" title="Inner part of dictionary - glues together GUI and plugins.">Backbone</a>* backbone, QWidget *parent = 0);
-<a name="l00062"></a>00062     ~<a class="code" href="classMainWindow.html" title="Implements interface for GUI.">MainWindow</a>();
-<a name="l00063"></a>00063 
-<a name="l00066"></a>00066 
-<a name="l00070"></a>00070     QHash&lt;CommonDictInterface*, bool&gt; <a class="code" href="classMainWindow.html#a0fd2d755ce951f3dfb535d555b957de7">getDictionaries</a>();
+<a name="l00030"></a>00030 <span class="preprocessor">#include &quot;../../includes/settings.h&quot;</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &quot;../backbone/backbone.h&quot;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &quot;<a class="code" href="TranslationWidget_8h.html" title="Implements translation widget.">TranslationWidget.h</a>&quot;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &quot;WordListWidget.h&quot;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &quot;<a class="code" href="SearchBarWidget_8h.html" title="Implements search bar.">SearchBarWidget.h</a>&quot;</span>
+<a name="l00035"></a>00035 <span class="preprocessor">#include &quot;<a class="code" href="MenuWidget_8h.html" title="Implements custom menu.">MenuWidget.h</a>&quot;</span>
+<a name="l00036"></a>00036 <span class="preprocessor">#include &quot;<a class="code" href="DictManagerWidget_8h.html" title="Dictionary management widget.">DictManagerWidget.h</a>&quot;</span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include &quot;SettingsWidget.h&quot;</span>
+<a name="l00038"></a>00038 <span class="preprocessor">#include &quot;<a class="code" href="HistoryListDialog_8h.html" title="Implements history list dialog.">HistoryListDialog.h</a>&quot;</span>
+<a name="l00039"></a>00039 <span class="preprocessor">#include &quot;BookmarksWidget.h&quot;</span>
+<a name="l00040"></a>00040 <span class="preprocessor">#include &quot;WelcomeScreenWidget.h&quot;</span>
+<a name="l00041"></a>00041 <span class="preprocessor">#include &quot;AboutWidget.h&quot;</span>
+<a name="l00042"></a>00042 
+<a name="l00043"></a>00043 <span class="keyword">namespace </span>Ui {
+<a name="l00044"></a>00044     <span class="keyword">class </span><a class="code" href="classMainWindow.html" title="Implements interface for GUI.">MainWindow</a>;
+<a name="l00045"></a>00045 }
+<a name="l00046"></a>00046 
+<a name="l00048"></a>00048 
+<a name="l00055"></a><a class="code" href="classMainWindow.html">00055</a> <span class="keyword">class </span><a class="code" href="classMainWindow.html" title="Implements interface for GUI.">MainWindow</a> : <span class="keyword">public</span> <a class="code" href="classGUIInterface.html" title="Interface for different GUIs.">GUIInterface</a>
+<a name="l00056"></a>00056 {
+<a name="l00057"></a>00057     Q_OBJECT
+<a name="l00058"></a>00058 
+<a name="l00059"></a>00059 <span class="keyword">public</span>:
+<a name="l00061"></a>00061 
+<a name="l00066"></a>00066     <span class="keyword">explicit</span> <a class="code" href="classMainWindow.html#a4acc6192d273eb38e9082b4934202b81" title="Constructor.">MainWindow</a>(<a class="code" href="classBackbone.html" title="/file backbone.cpp">Backbone</a>* backbone, QWidget *parent = 0);
+<a name="l00067"></a>00067     ~<a class="code" href="classMainWindow.html" title="Implements interface for GUI.">MainWindow</a>();
+<a name="l00068"></a>00068 
 <a name="l00071"></a>00071 
-<a name="l00073"></a>00073 
-<a name="l00076"></a>00076     QList&lt;CommonDictInterface*&gt; <a class="code" href="classMainWindow.html#a021ff10f30db21337b54b3dfaae0e9a0" title="Returns all loaded plugins.">getPlugins</a>();
-<a name="l00077"></a>00077 
-<a name="l00079"></a>00079 
-<a name="l00085"></a>00085     <span class="keywordtype">bool</span> <a class="code" href="classMainWindow.html#a88a06565de22a608629bfa4a15ad5839" title="Indicates if GUI is in exact search mode.">exactSearch</a>();
-<a name="l00086"></a>00086 
-<a name="l00088"></a>00088 
-<a name="l00095"></a>00095     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#a78e044c5bd7446b0d2105f98573b9489" title="Sets GUI exact search mode.">setExactSearch</a>(<span class="keywordtype">bool</span>);
-<a name="l00096"></a>00096 
-<a name="l00097"></a>00097 
-<a name="l00098"></a>00098  <span class="keyword">public</span> Q_SLOTS:
-<a name="l00100"></a>00100 
-<a name="l00105"></a>00105     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#a16d0c7d46fc49bfa1cada597e349549a" title="Search in exact mode for given word.">searchExact</a>(QString);
+<a name="l00075"></a>00075     QHash&lt;CommonDictInterface*, bool&gt; <a class="code" href="classMainWindow.html#a0fd2d755ce951f3dfb535d555b957de7">getDictionaries</a>();
+<a name="l00076"></a>00076 
+<a name="l00078"></a>00078 
+<a name="l00081"></a>00081     QList&lt;CommonDictInterface*&gt; <a class="code" href="classMainWindow.html#a021ff10f30db21337b54b3dfaae0e9a0" title="Returns all loaded plugins.">getPlugins</a>();
+<a name="l00082"></a>00082 
+<a name="l00084"></a>00084 
+<a name="l00090"></a>00090     <span class="keywordtype">bool</span> <a class="code" href="classMainWindow.html#a88a06565de22a608629bfa4a15ad5839" title="Indicates if GUI is in exact search mode.">exactSearch</a>();
+<a name="l00091"></a>00091 
+<a name="l00093"></a>00093 
+<a name="l00100"></a>00100     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#a78e044c5bd7446b0d2105f98573b9489" title="Sets GUI exact search mode.">setExactSearch</a>(<span class="keywordtype">bool</span>);
+<a name="l00101"></a>00101 
+<a name="l00102"></a>00102     <a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>* settings();
+<a name="l00103"></a>00103 
+<a name="l00104"></a>00104     <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>*);
+<a name="l00105"></a>00105 
 <a name="l00106"></a>00106 
-<a name="l00108"></a>00108 
-<a name="l00117"></a>00117     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#a9a56d2e699da84f9647984852cb6041b" title="Gets word list from backbone and prepares received list to display.">wordListReady</a>();
+<a name="l00107"></a>00107  <span class="keyword">public</span> Q_SLOTS:
+<a name="l00109"></a>00109 
+<a name="l00114"></a>00114     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#a16d0c7d46fc49bfa1cada597e349549a" title="Search in exact mode for given word.">searchExact</a>(QString);
+<a name="l00115"></a>00115 
+<a name="l00116"></a>00116 
 <a name="l00118"></a>00118 
-<a name="l00120"></a>00120     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#afea3664ab8d180bc705b552b7f745136" title="Gets translation strings from backbone and emit signal to display them.">translationsReady</a>();
-<a name="l00121"></a>00121 
-<a name="l00123"></a>00123 
-<a name="l00130"></a>00130     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#ab88154764298f46e81f942262170f4b9" title="Adds to history key words from given translations.">addToHistory</a>(QList&lt;Translation*&gt;);
+<a name="l00127"></a>00127     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#a9a56d2e699da84f9647984852cb6041b" title="Gets word list from backbone and prepares received list to display.">wordListReady</a>();
+<a name="l00128"></a>00128 
+<a name="l00130"></a>00130     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#afea3664ab8d180bc705b552b7f745136" title="Gets translation strings from backbone and emit signal to display them.">translationsReady</a>();
 <a name="l00131"></a>00131 
-<a name="l00133"></a>00133     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#a655d251389256b1e062513f6ff762543" title="Shows history dialog.">showHistory</a>();
-<a name="l00134"></a>00134 
-<a name="l00136"></a>00136 
-<a name="l00141"></a>00141     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#aaac2ae9385150bf83eb6c1d73e745e3c" title="Shows translation of next word in history.">historyNext</a>();
-<a name="l00142"></a>00142 
+<a name="l00133"></a>00133 
+<a name="l00140"></a>00140     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#ab88154764298f46e81f942262170f4b9" title="Adds to history key words from given translations.">addToHistory</a>(QList&lt;Translation*&gt;);
+<a name="l00141"></a>00141 
+<a name="l00143"></a>00143     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#a655d251389256b1e062513f6ff762543" title="Shows history dialog.">showHistory</a>();
 <a name="l00144"></a>00144 
-<a name="l00149"></a>00149     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#ab3d88584e7391cedb791248dc7b13b78" title="Shows translation of previous word in history.">historyPrev</a>();
-<a name="l00150"></a>00150 
-<a name="l00151"></a>00151 <span class="keyword">private</span> Q_SLOTS:
-<a name="l00154"></a>00154     <span class="keywordtype">void</span> setSearchString(QString);
-<a name="l00155"></a>00155 
-<a name="l00157"></a>00157     <span class="keywordtype">void</span> disableMenu();
-<a name="l00158"></a>00158 
-<a name="l00160"></a>00160     <span class="keywordtype">void</span> enableMenu();
-<a name="l00161"></a>00161 
-<a name="l00164"></a>00164     <span class="keywordtype">void</span> breakSearching();
+<a name="l00146"></a>00146 
+<a name="l00151"></a>00151     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#aaac2ae9385150bf83eb6c1d73e745e3c" title="Shows translation of next word in history.">historyNext</a>();
+<a name="l00152"></a>00152 
+<a name="l00154"></a>00154 
+<a name="l00159"></a>00159     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#ab3d88584e7391cedb791248dc7b13b78" title="Shows translation of previous word in history.">historyPrev</a>();
+<a name="l00160"></a>00160 
+<a name="l00161"></a>00161 <span class="keyword">private</span> Q_SLOTS:
+<a name="l00164"></a>00164     <span class="keywordtype">void</span> setSearchString(QString);
 <a name="l00165"></a>00165 
-<a name="l00166"></a>00166 
-<a name="l00167"></a>00167 <span class="keyword">protected</span>:
-<a name="l00171"></a>00171     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#a38edb88d43e844aca9d2e762c8706565" title="When user wants to close application, we first sends signal to stop all ongoing searches...">closeEvent</a>(QCloseEvent *);
-<a name="l00172"></a>00172 
-<a name="l00173"></a>00173 
-<a name="l00174"></a>00174 <span class="keyword">private</span>:
-<a name="l00175"></a>00175     <a class="code" href="classBackbone.html" title="Inner part of dictionary - glues together GUI and plugins.">Backbone</a>* backbone;
-<a name="l00176"></a>00176     Ui::MainWindow *ui;
-<a name="l00177"></a>00177 
+<a name="l00167"></a>00167     <span class="keywordtype">void</span> disableMenu();
+<a name="l00168"></a>00168 
+<a name="l00170"></a>00170     <span class="keywordtype">void</span> enableMenu();
+<a name="l00171"></a>00171 
+<a name="l00174"></a>00174     <span class="keywordtype">void</span> breakSearching();
+<a name="l00175"></a>00175 
+<a name="l00176"></a>00176 
+<a name="l00177"></a>00177     <span class="keywordtype">void</span> showAllBookmarks();
 <a name="l00178"></a>00178 
-<a name="l00179"></a>00179     <a class="code" href="classSearchBarWidget.html" title="Displays search bar.">SearchBarWidget</a>* searchBarWidget;
-<a name="l00180"></a>00180     <a class="code" href="classTranslationWidget.html" title="Displays translation of word found in dictionaries.">TranslationWidget</a>* translationWidget;
-<a name="l00181"></a>00181     <a class="code" href="classWordListWidget.html" title="Displays list of words found in dictionaries.">WordListWidget</a>* wordListWidget;
-<a name="l00182"></a>00182     <a class="code" href="classMenuWidget.html" title="Displays custom menu with tab widget containing all submenus.">MenuWidget</a>* menuWidget;
-<a name="l00183"></a>00183     <a class="code" href="classDictManagerWidget.html" title="Implements dictionaries management widget.">DictManagerWidget</a>* dictManagerWidget;
-<a name="l00184"></a>00184 
-<a name="l00185"></a>00185     <span class="keywordtype">bool</span> _exactSearch;
-<a name="l00186"></a>00186     QString searchString;
-<a name="l00187"></a>00187 
-<a name="l00188"></a>00188     <span class="keywordtype">void</span> connectBackbone();
-<a name="l00189"></a>00189     <span class="keywordtype">void</span> connectSearchBar();
-<a name="l00190"></a>00190     <span class="keywordtype">void</span> connectWordList();
-<a name="l00191"></a>00191     <span class="keywordtype">void</span> connectTranslationWidget();
-<a name="l00192"></a>00192     <span class="keywordtype">void</span> connectDictManager();
-<a name="l00193"></a>00193     <span class="keywordtype">void</span> connectMenu();
-<a name="l00194"></a>00194 };
-<a name="l00195"></a>00195 
-<a name="l00196"></a>00196 <span class="preprocessor">#endif // MAINWINDOW_H</span>
+<a name="l00179"></a>00179 
+<a name="l00180"></a>00180 <span class="keyword">protected</span>:
+<a name="l00184"></a>00184     <span class="keywordtype">void</span> <a class="code" href="classMainWindow.html#a38edb88d43e844aca9d2e762c8706565" title="When user wants to close application, we first sends signal to stop all ongoing searches...">closeEvent</a>(QCloseEvent *);
+<a name="l00185"></a>00185 
+<a name="l00186"></a>00186 
+<a name="l00187"></a>00187 <span class="keyword">private</span>:
+<a name="l00188"></a>00188     <a class="code" href="classBackbone.html" title="/file backbone.cpp">Backbone</a>* backbone;
+<a name="l00189"></a>00189     <a class="code" href="classUi_1_1MainWindow.html">Ui::MainWindow</a> *ui;
+<a name="l00190"></a>00190 
+<a name="l00191"></a>00191     <span class="keywordtype">void</span> initializeUI();
+<a name="l00192"></a>00192 
+<a name="l00193"></a>00193 
+<a name="l00194"></a>00194     <a class="code" href="classSearchBarWidget.html" title="Displays search bar.">SearchBarWidget</a>* searchBarWidget;
+<a name="l00195"></a>00195     QWidget* translationWidget;
+<a name="l00196"></a>00196     QWidget* wordListWidget;
+<a name="l00197"></a>00197     <a class="code" href="classMenuWidget.html" title="Displays custom menu with tab widget containing all submenus.">MenuWidget</a>* menuWidget;
+<a name="l00198"></a>00198     <a class="code" href="classDictManagerWidget.html" title="Implements dictionaries management widget.">DictManagerWidget</a>* dictManagerWidget;
+<a name="l00199"></a>00199     <a class="code" href="classSettingsWidget.html">SettingsWidget</a>* settingsWidget;
+<a name="l00200"></a>00200     <a class="code" href="classBookmarksWidget.html">BookmarksWidget</a>* bookmarksWidget;
+<a name="l00201"></a>00201     QWidget* welcomeScreenWidget;
+<a name="l00202"></a>00202     <a class="code" href="classAboutWidget.html">AboutWidget</a>* aboutWidget;
+<a name="l00203"></a>00203 
+<a name="l00204"></a>00204 <span class="preprocessor">    #ifndef Q_WS_MAEMO_5</span>
+<a name="l00205"></a>00205 <span class="preprocessor"></span>        QSplitter* splitter;
+<a name="l00206"></a>00206         QAction* dictionariesAction;
+<a name="l00207"></a>00207         QAction* bookmarksShowAllAction;
+<a name="l00208"></a>00208         QAction* bookmarksRemoveAllAction;
+<a name="l00209"></a>00209         QAction* settingsAction;
+<a name="l00210"></a>00210         QAction* aboutAction;
+<a name="l00211"></a>00211 <span class="preprocessor">    #endif</span>
+<a name="l00212"></a>00212 <span class="preprocessor"></span>
+<a name="l00213"></a>00213     <span class="keywordtype">bool</span> _exactSearch;
+<a name="l00214"></a>00214     QString searchString;
+<a name="l00215"></a>00215 
+<a name="l00216"></a>00216 
+<a name="l00217"></a>00217     <span class="keywordtype">void</span> connectBackbone();
+<a name="l00218"></a>00218     <span class="keywordtype">void</span> connectSearchBar();
+<a name="l00219"></a>00219     <span class="keywordtype">void</span> connectWordList();
+<a name="l00220"></a>00220     <span class="keywordtype">void</span> connectTranslationWidget();
+<a name="l00221"></a>00221     <span class="keywordtype">void</span> connectDictManager();
+<a name="l00222"></a>00222     <span class="keywordtype">void</span> connectMenu();
+<a name="l00223"></a>00223     <span class="keywordtype">void</span> connectBookmarksWidget();
+<a name="l00224"></a>00224 };
+<a name="l00225"></a>00225 
+<a name="l00226"></a>00226 <span class="preprocessor">#endif // MAINWINDOW_H</span>
 </pre></div></div>
 <!--- window showing the filter options -->
 <div id="MSearchSelectWindow"
@@ -173,7 +203,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>