</div>
<div class="contents">
<h1>Backbone Class Reference</h1><!-- doxytag: class="Backbone" -->
-<p>Inner part of dictionary - glues together GUI and plugins.
+<p>/file backbone.cpp
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="backbone_8h_source.html">backbone.h</a>></code></p>
<tr><td colspan="2"><h2>Public Slots</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ede318bd5d226a8fa566f13452fb07d"></a><!-- doxytag: member="Backbone::stopSearching" ref="a1ede318bd5d226a8fa566f13452fb07d" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a1ede318bd5d226a8fa566f13452fb07d">stopSearching</a> ()</td></tr>
-<tr><td class="mdescLeft"> </td><td class="mdescRight">stops all current searches <br/></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">stops all current searches and emiting searchCanceled signal <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a3b1f2cf8de594cbd18bef4ca854337e2">search</a> (QString word)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">search for a word translation <a href="#a3b1f2cf8de594cbd18bef4ca854337e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#ac23b486119652095d956413a6e68afec">selectedDictionaries</a> (QList< <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * >)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">saves plugins new state/configuration after each change <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a67dbca9402d40e4678f879ff8da3866e">searchHtml</a> (QList< <a class="el" href="classTranslation.html">Translation</a> * >)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Performs search for final translation (html/xml) form. <a href="#a67dbca9402d40e4678f879ff8da3866e"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a3519db3c2884e8d47fdaf4938edc18c3">addBookmark</a> (QList< <a class="el" href="classTranslation.html">Translation</a> * > translations)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">add bookmarks to given translations (translation object is fetched and added to bookmarks data base (key and translation stored in db) <a href="#a3519db3c2884e8d47fdaf4938edc18c3"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a2333e15516ba1276fa334703bfe53bdd">removeBookmark</a> (QList< <a class="el" href="classTranslation.html">Translation</a> * > translations)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove bookmarks to given translatios. <a href="#a2333e15516ba1276fa334703bfe53bdd"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48818731460db4cdac3a197a7819d0d2"></a><!-- doxytag: member="Backbone::removeAllBookmark" ref="a48818731460db4cdac3a197a7819d0d2" args="()" -->
+void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a48818731460db4cdac3a197a7819d0d2">removeAllBookmark</a> ()</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all bookmarks. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a2307b5520b76d5751edef237ef6bbe85">fetchBookmarks</a> ()</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Searching for list of bookmarks may take some time, so i moved it to new thread (to avoid gui blocking), futher its consistent with ordinary searching for list of word (. <a href="#a2307b5520b76d5751edef237ef6bbe85"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#aa7147125301d2d2da004cb6d30b8630d">setSettings</a> (<a class="el" href="classSettings.html">Settings</a> *settings)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets settings for backbone: history_size, search_limit, searching backends (search_bookmarks, search_dictionaries). <a href="#aa7147125301d2d2da004cb6d30b8630d"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSettings.html">Settings</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a2e2bd187c830e7fd5ad330dc0409f7f0">settings</a> ()</td></tr>
<tr><td colspan="2"><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afef04921ba89c424eb882cc14153de39"></a><!-- doxytag: member="Backbone::closeOk" ref="afef04921ba89c424eb882cc14153de39" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#afef04921ba89c424eb882cc14153de39">closeOk</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e218d1df6d69ddf3ddbc5c3d2ba9453"></a><!-- doxytag: member="Backbone::htmlReady" ref="a7e218d1df6d69ddf3ddbc5c3d2ba9453" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a7e218d1df6d69ddf3ddbc5c3d2ba9453">htmlReady</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">emitted when html result is ready to fetch <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3e0f4046a2eada57e5b2bcb82d70dcd"></a><!-- doxytag: member="Backbone::searchCanceled" ref="af3e0f4046a2eada57e5b2bcb82d70dcd" args="()" -->
+void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#af3e0f4046a2eada57e5b2bcb82d70dcd">searchCanceled</a> ()</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">throwed when searches are stopped <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbd6443bc5fff4ecc415b8735c46a95d"></a><!-- doxytag: member="Backbone::bookmarksReady" ref="adbd6443bc5fff4ecc415b8735c46a95d" args="()" -->
+void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#adbd6443bc5fff4ecc415b8735c46a95d">bookmarksReady</a> ()</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">emmited when bookmark list is ready to fetch <br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a68059c8a2598fbbba42c29a332b2472f">Backbone</a> (QString pluginPath="", QString configPath="", bool dry=0, QObject *parent=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6edbf4e5819dbc551ab54dad66f474f2"></a><!-- doxytag: member="Backbone::Backbone" ref="a6edbf4e5819dbc551ab54dad66f474f2" args="(const Backbone &b)" -->
<tr><td class="memItemLeft" align="right" valign="top">QMultiHash< QString, <br class="typebreak"/>
<a class="el" href="classTranslation.html">Translation</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#adeaabfee86975f65b8e728b8582caa35">result</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#addad48903943006b6a4661169f80ee5a">searchLimit</a> () const </td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#ad0ddecf22c51867e984cb4e6a745d67c">activeSearches</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a56df9bdfbe82998011f95ecb3c5bd7db">htmls</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
-<p>Inner part of dictionary - glues together GUI and plugins. </p>
-<p><a class="el" href="classBackbone.html" title="Inner part of dictionary - glues together GUI and plugins.">Backbone</a> is responsible for managing plugins and dictionaries, starting new searches and threads, merging search results from multiple dictionaries.</p>
-<p>Each plugin may live in multiple instances - each with its own dictionary, backbone must provide way to create them at start (with specific <a class="el" href="classSettings.html" title="Plugin specific configuration.">Settings</a>) and distinguich each ditionary. </p>
+<p>/file backbone.cpp </p>
+<p>Backbone/core main header</p>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBackbone.html" title="/file backbone.cpp">Backbone</a></dd></dl>
+<dl class="author"><dt><b>Author:</b></dt><dd>Bartosz Szatkowski <<a href="mailto:bulislaw@linux.com">bulislaw@linux.com</a>></dd></dl>
+<p>Inner part of dictionary - glues together GUI and plugins, also kind of GoF facade (for GUI) cover few classes</p>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBookmarks.html" title="Bookmarks are way to store words that You think You will need to search for often...">Bookmarks</a> </dd>
+<dd>
+<a class="el" href="classHistory.html">History</a></dd></dl>
+<p><a class="el" href="classBackbone.html" title="/file backbone.cpp">Backbone</a> is responsible for managing plugins and dictionaries, starting new searches and threads, merging search results from multiple dictionaries.</p>
+<p>Each plugin may live in multiple instances - each with its own dictionary, backbone must provide way to create them at start (with specific <a class="el" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>) and distinguich each ditionary.</p>
+<p><a class="el" href="classBackbone.html" title="/file backbone.cpp">Backbone</a> also manage bookmarks and history: providing interface to gui</p>
+<p><a class="el" href="classBackbone.html" title="/file backbone.cpp">Backbone</a> is also responsible for saving and spawning session via configs file (stored in ~/.mdictionary) -> configs are kind of tricky because mDictionary is delivered with two simple dicts -> its necessary to separate default configs from user configs (updating/reinstaling app results in overwriten default config file), moreover config file there is general mdictionary configuration (aparto from dictionaries and plugin ones).</p>
+<p>Other modules may set some internal backbone behaviour via </p>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBackbone.html#aa7147125301d2d2da004cb6d30b8630d" title="Sets settings for backbone: history_size, search_limit, searching backends (search_bookmarks...">setSettings()</a>: <a class="el" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a> object with option given: history_size - int, size of stored searches search_limit - int, how many different word may each dictionary returns search_dictionaries - true/false, whether <a class="el" href="classBackbone.html#a3b1f2cf8de594cbd18bef4ca854337e2" title="search for a word translation">search</a> in dictionaries search_bookmarks - true/false, whether <a class="el" href="classBackbone.html#a3b1f2cf8de594cbd18bef4ca854337e2" title="search for a word translation">search</a> in bookmarks </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a68059c8a2598fbbba42c29a332b2472f"></a><!-- doxytag: member="Backbone::Backbone" ref="a68059c8a2598fbbba42c29a332b2472f" args="(QString pluginPath="", QString configPath="", bool dry=0, QObject *parent=0)" -->
<div class="memitem">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
-<a class="anchor" id="ad0ddecf22c51867e984cb4e6a745d67c"></a><!-- doxytag: member="Backbone::activeSearches" ref="ad0ddecf22c51867e984cb4e6a745d67c" args="() const " -->
+<a class="anchor" id="a3519db3c2884e8d47fdaf4938edc18c3"></a><!-- doxytag: member="Backbone::addBookmark" ref="a3519db3c2884e8d47fdaf4938edc18c3" args="(QList< Translation * > translations)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">int Backbone::activeSearches </td>
+ <td class="memname">void Backbone::addBookmark </td>
<td>(</td>
- <td class="paramname"></td>
+ <td class="paramtype">QList< <a class="el" href="classTranslation.html">Translation</a> * > </td>
+ <td class="paramname"> <em>translations</em></td>
<td> ) </td>
- <td> const</td>
+ <td><code> [inline, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
-<dl class="return"><dt><b>Returns:</b></dt><dd>number of active searches </dd></dl>
+
+<p>add bookmarks to given translations (translation object is fetched and added to bookmarks data base (key and translation stored in db) </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>translation</em> </td><td>translation object to be stored in db </td></tr>
+ </table>
+ </dd>
+</dl>
</div>
</div>
</div>
</div>
+<a class="anchor" id="a2307b5520b76d5751edef237ef6bbe85"></a><!-- doxytag: member="Backbone::fetchBookmarks" ref="a2307b5520b76d5751edef237ef6bbe85" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Backbone::fetchBookmarks </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td> ) </td>
+ <td><code> [inline, slot]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Searching for list of bookmarks may take some time, so i moved it to new thread (to avoid gui blocking), futher its consistent with ordinary searching for list of word (. </p>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBackbone.html#a3b1f2cf8de594cbd18bef4ca854337e2" title="search for a word translation">search</a>) </dd></dl>
+
+</div>
+</div>
<a class="anchor" id="a4b027f51bb4cc3803f6be85bc25d6a4b"></a><!-- doxytag: member="Backbone::getDictionaries" ref="a4b027f51bb4cc3803f6be85bc25d6a4b" args="()" -->
<div class="memitem">
<div class="memproto">
</div>
</div>
+<a class="anchor" id="a2333e15516ba1276fa334703bfe53bdd"></a><!-- doxytag: member="Backbone::removeBookmark" ref="a2333e15516ba1276fa334703bfe53bdd" args="(QList< Translation * > translations)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Backbone::removeBookmark </td>
+ <td>(</td>
+ <td class="paramtype">QList< <a class="el" href="classTranslation.html">Translation</a> * > </td>
+ <td class="paramname"> <em>translations</em></td>
+ <td> ) </td>
+ <td><code> [inline, slot]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Remove bookmarks to given translatios. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>translation</em> </td><td>remove bookmark to this translation </td></tr>
+ </table>
+ </dd>
+</dl>
+
+</div>
+</div>
<a class="anchor" id="a056fc494ed689f253d83fc2366c07931"></a><!-- doxytag: member="Backbone::removeDictionary" ref="a056fc494ed689f253d83fc2366c07931" args="(CommonDictInterface *dict)" -->
<div class="memitem">
<div class="memproto">
</div>
</div>
+<a class="anchor" id="aa7147125301d2d2da004cb6d30b8630d"></a><!-- doxytag: member="Backbone::setSettings" ref="aa7147125301d2d2da004cb6d30b8630d" args="(Settings *settings)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Backbone::setSettings </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="classSettings.html">Settings</a> * </td>
+ <td class="paramname"> <em>settings</em></td>
+ <td> ) </td>
+ <td><code> [slot]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Sets settings for backbone: history_size, search_limit, searching backends (search_bookmarks, search_dictionaries). </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>settings object with opitons set </td></tr>
+ </table>
+ </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="a2e2bd187c830e7fd5ad330dc0409f7f0"></a><!-- doxytag: member="Backbone::settings" ref="a2e2bd187c830e7fd5ad330dc0409f7f0" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classSettings.html">Settings</a> * Backbone::settings </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td> ) </td>
+ <td><code> [slot]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<dl class="return"><dt><b>Returns:</b></dt><dd>coresponding settings object with history_size, search_limit, searching backends (search_bookmarks, search_dictionaries) </dd></dl>
+
+</div>
+</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="backbone_8h_source.html">backbone.h</a></li>
<li>backbone.cpp</li>
+<li>moc_backbone.cpp</li>
+<li>build-desktop/moc_backbone.cpp</li>
</ul>
</div>
<!--- window showing the filter options -->
</iframe>
</div>
-<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 12 14:34:59 2010 for mDictionary by
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
projects / mdictionary / blobdiff