vcs.maemo.org Git - mdictionary/blob - doc/html/classBackbone.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 Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
  22       <li><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="annotated.html"><span>Class&nbsp;List</span></a></li>
  41       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  42       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  43     </ul>
  44   </div>
  45 </div>
  46 <div class="contents">
  47 <h1>Backbone Class Reference</h1><!-- doxytag: class="Backbone" -->
  48 <p>/file backbone.cpp
  49 <a href="#_details">More...</a></p>
  50
  51 <p><code>#include &lt;<a class="el" href="backbone_8h_source.html">backbone.h</a>&gt;</code></p>
  52
  53 <p><a href="classBackbone-members.html">List of all members.</a></p>
  54 <table border="0" cellpadding="0" cellspacing="0">
  55 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
  56 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ede318bd5d226a8fa566f13452fb07d"></a><!-- doxytag: member="Backbone::stopSearching" ref="a1ede318bd5d226a8fa566f13452fb07d" args="()" -->
  57 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a1ede318bd5d226a8fa566f13452fb07d">stopSearching</a> ()</td></tr>
  58 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stops all current searches and emiting searchCanceled signal <br/></td></tr>
  59 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a3b1f2cf8de594cbd18bef4ca854337e2">search</a> (QString word)</td></tr>
  60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">search for a word translation  <a href="#a3b1f2cf8de594cbd18bef4ca854337e2"></a><br/></td></tr>
  61 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#ac23b486119652095d956413a6e68afec">selectedDictionaries</a> (QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt;)</td></tr>
  62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets active dictionaries (searches are performed only in active dicts  <a href="#ac23b486119652095d956413a6e68afec"></a><br/></td></tr>
  63 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#aaf91c7fe4e12d7007ca761dc89c14c8a">addDictionary</a> (<a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *dict, bool active=1)</td></tr>
  64 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">adds new dictionary and activate it  <a href="#aaf91c7fe4e12d7007ca761dc89c14c8a"></a><br/></td></tr>
  65 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#aa61afbf8ef2e05c0c2a9634fbdccad19">quit</a> ()</td></tr>
  66 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stops all current activity - emiting signal  <a href="#aa61afbf8ef2e05c0c2a9634fbdccad19"></a><br/></td></tr>
  67 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61b78f5ee989400a2b2d7630b8145bb8"></a><!-- doxytag: member="Backbone::translationReady" ref="a61b78f5ee989400a2b2d7630b8145bb8" args="()" -->
  68 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a61b78f5ee989400a2b2d7630b8145bb8">translationReady</a> ()</td></tr>
  69 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fired with given interval during searches - checking if translation is ready. <br/></td></tr>
  70 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0be266198b2ae39efcce38aabb984d61"></a><!-- doxytag: member="Backbone::htmlTranslationReady" ref="a0be266198b2ae39efcce38aabb984d61" args="()" -->
  71 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a0be266198b2ae39efcce38aabb984d61">htmlTranslationReady</a> ()</td></tr>
  72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fired with given interval during html searches - checking if html is ready. <br/></td></tr>
  73 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a056fc494ed689f253d83fc2366c07931">removeDictionary</a> (<a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *dict)</td></tr>
  74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes given dictionary.  <a href="#a056fc494ed689f253d83fc2366c07931"></a><br/></td></tr>
  75 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ed4ea8df862807b83dfdec36e4c7ea8"></a><!-- doxytag: member="Backbone::dictUpdated" ref="a3ed4ea8df862807b83dfdec36e4c7ea8" args="()" -->
  76 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a3ed4ea8df862807b83dfdec36e4c7ea8">dictUpdated</a> ()</td></tr>
  77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">saves plugins new state/configuration after each change <br/></td></tr>
  78 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a67dbca9402d40e4678f879ff8da3866e">searchHtml</a> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;)</td></tr>
  79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Performs search for final translation (html/xml) form.  <a href="#a67dbca9402d40e4678f879ff8da3866e"></a><br/></td></tr>
  80 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a3519db3c2884e8d47fdaf4938edc18c3">addBookmark</a> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt; translations)</td></tr>
  81 <tr><td class="mdescLeft">&nbsp;</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>
  82 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a2333e15516ba1276fa334703bfe53bdd">removeBookmark</a> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt; translations)</td></tr>
  83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove bookmarks to given translatios.  <a href="#a2333e15516ba1276fa334703bfe53bdd"></a><br/></td></tr>
  84 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48818731460db4cdac3a197a7819d0d2"></a><!-- doxytag: member="Backbone::removeAllBookmark" ref="a48818731460db4cdac3a197a7819d0d2" args="()" -->
  85 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a48818731460db4cdac3a197a7819d0d2">removeAllBookmark</a> ()</td></tr>
  86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove all bookmarks. <br/></td></tr>
  87 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a2307b5520b76d5751edef237ef6bbe85">fetchBookmarks</a> ()</td></tr>
  88 <tr><td class="mdescLeft">&nbsp;</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>
  89 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</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>
  90 <tr><td class="mdescLeft">&nbsp;</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>
  91 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a2e2bd187c830e7fd5ad330dc0409f7f0">settings</a> ()</td></tr>
  92 <tr><td colspan="2"><h2>Signals</h2></td></tr>
  93 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afef04921ba89c424eb882cc14153de39"></a><!-- doxytag: member="Backbone::closeOk" ref="afef04921ba89c424eb882cc14153de39" args="()" -->
  94 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#afef04921ba89c424eb882cc14153de39">closeOk</a> ()</td></tr>
  95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emmited when backbone is ready to close - after getting stop signal it should kill all threads and so on <br/></td></tr>
  96 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae50cec4f0c49149a46e913b31bcef92c"></a><!-- doxytag: member="Backbone::ready" ref="ae50cec4f0c49149a46e913b31bcef92c" args="()" -->
  97 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#ae50cec4f0c49149a46e913b31bcef92c">ready</a> ()</td></tr>
  98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emitted when there are search result ready to fetch <br/></td></tr>
  99 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e218d1df6d69ddf3ddbc5c3d2ba9453"></a><!-- doxytag: member="Backbone::htmlReady" ref="a7e218d1df6d69ddf3ddbc5c3d2ba9453" args="()" -->
 100 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a7e218d1df6d69ddf3ddbc5c3d2ba9453">htmlReady</a> ()</td></tr>
 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emitted when html result is ready to fetch <br/></td></tr>
 102 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3e0f4046a2eada57e5b2bcb82d70dcd"></a><!-- doxytag: member="Backbone::searchCanceled" ref="af3e0f4046a2eada57e5b2bcb82d70dcd" args="()" -->
 103 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#af3e0f4046a2eada57e5b2bcb82d70dcd">searchCanceled</a> ()</td></tr>
 104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">throwed when searches are stopped <br/></td></tr>
 105 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbd6443bc5fff4ecc415b8735c46a95d"></a><!-- doxytag: member="Backbone::bookmarksReady" ref="adbd6443bc5fff4ecc415b8735c46a95d" args="()" -->
 106 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#adbd6443bc5fff4ecc415b8735c46a95d">bookmarksReady</a> ()</td></tr>
 107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emmited when bookmark list is ready to fetch <br/></td></tr>
 108 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
 109 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a68059c8a2598fbbba42c29a332b2472f">Backbone</a> (QString pluginPath=&quot;&quot;, QString configPath=&quot;&quot;, bool dry=0, QObject *parent=0)</td></tr>
 110 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6edbf4e5819dbc551ab54dad66f474f2"></a><!-- doxytag: member="Backbone::Backbone" ref="a6edbf4e5819dbc551ab54dad66f474f2" args="(const Backbone &amp;b)" -->
 111 &nbsp;</td><td class="memItemRight" valign="bottom"><b>Backbone</b> (const <a class="el" href="classBackbone.html">Backbone</a> &amp;b)</td></tr>
 112 <tr><td class="memItemLeft" align="right" valign="top">QHash&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> <br class="typebreak"/>
 113 *, bool &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a4b027f51bb4cc3803f6be85bc25d6a4b">getDictionaries</a> ()</td></tr>
 114 <tr><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a2fdfa0cf73fda5304635b61455b48db9">getPlugins</a> ()</td></tr>
 115 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classHistory.html">History</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#ac91e19871d56331ce0d744b8ea936e00">history</a> ()</td></tr>
 116 <tr><td class="memItemLeft" align="right" valign="top">QMultiHash&lt; QString, <br class="typebreak"/>
 117 <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#adeaabfee86975f65b8e728b8582caa35">result</a> ()</td></tr>
 118 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#addad48903943006b6a4661169f80ee5a">searchLimit</a> () const </td></tr>
 119 <tr><td class="memItemLeft" align="right" valign="top">QStringList&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a56df9bdfbe82998011f95ecb3c5bd7db">htmls</a> ()</td></tr>
 120 </table>
 121 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 122 <p>/file backbone.cpp </p>
 123 <p>Backbone/core main header</p>
 124 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBackbone.html" title="/file backbone.cpp">Backbone</a></dd></dl>
 125 <dl class="author"><dt><b>Author:</b></dt><dd>Bartosz Szatkowski &lt;<a href="mailto:bulislaw@linux.com">bulislaw@linux.com</a>&gt;</dd></dl>
 126 <p>Inner part of dictionary - glues together GUI and plugins, also kind of GoF facade (for GUI) cover few classes</p>
 127 <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>
 128 <dd>
 129 <a class="el" href="classHistory.html">History</a></dd></dl>
 130 <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>
 131 <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>
 132 <p><a class="el" href="classBackbone.html" title="/file backbone.cpp">Backbone</a> also manage bookmarks and history: providing interface to gui</p>
 133 <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) -&gt; configs are kind of tricky because mDictionary is delivered with two simple dicts -&gt; 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>
 134 <p>Other modules may set some internal backbone behaviour via </p>
 135 <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>
 136 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
 137 <a class="anchor" id="a68059c8a2598fbbba42c29a332b2472f"></a><!-- doxytag: member="Backbone::Backbone" ref="a68059c8a2598fbbba42c29a332b2472f" args="(QString pluginPath=&quot;&quot;, QString configPath=&quot;&quot;, bool dry=0, QObject *parent=0)" -->
 138 <div class="memitem">
 139 <div class="memproto">
 140       <table class="memname">
 141         <tr>
 142           <td class="memname">Backbone::Backbone </td>
 143           <td>(</td>
 144           <td class="paramtype">QString&nbsp;</td>
 145           <td class="paramname"> <em>pluginPath</em> = <code>&quot;&quot;</code>, </td>
 146         </tr>
 147         <tr>
 148           <td class="paramkey"></td>
 149           <td></td>
 150           <td class="paramtype">QString&nbsp;</td>
 151           <td class="paramname"> <em>configPath</em> = <code>&quot;&quot;</code>, </td>
 152         </tr>
 153         <tr>
 154           <td class="paramkey"></td>
 155           <td></td>
 156           <td class="paramtype">bool&nbsp;</td>
 157           <td class="paramname"> <em>dry</em> = <code>0</code>, </td>
 158         </tr>
 159         <tr>
 160           <td class="paramkey"></td>
 161           <td></td>
 162           <td class="paramtype">QObject *&nbsp;</td>
 163           <td class="paramname"> <em>parent</em> = <code>0</code></td><td>&nbsp;</td>
 164         </tr>
 165         <tr>
 166           <td></td>
 167           <td>)</td>
 168           <td></td><td></td><td></td>
 169         </tr>
 170       </table>
 171 </div>
 172 <div class="memdoc">
 173 <dl><dt><b>Parameters:</b></dt><dd>
 174   <table border="0" cellspacing="2" cellpadding="0">
 175     <tr><td valign="top"></td><td valign="top"><em>pluginPath</em>&nbsp;</td><td>path to plugins (leave blank for default) </td></tr>
 176     <tr><td valign="top"></td><td valign="top"><em>configPath</em>&nbsp;</td><td>path to folder with configuration files </td></tr>
 177   </table>
 178   </dd>
 179 </dl>
 180
 181 </div>
 182 </div>
 183 <hr/><h2>Member Function Documentation</h2>
 184 <a class="anchor" id="a3519db3c2884e8d47fdaf4938edc18c3"></a><!-- doxytag: member="Backbone::addBookmark" ref="a3519db3c2884e8d47fdaf4938edc18c3" args="(QList&lt; Translation * &gt; translations)" -->
 185 <div class="memitem">
 186 <div class="memproto">
 187       <table class="memname">
 188         <tr>
 189           <td class="memname">void Backbone::addBookmark </td>
 190           <td>(</td>
 191           <td class="paramtype">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td>
 192           <td class="paramname"> <em>translations</em></td>
 193           <td>&nbsp;)&nbsp;</td>
 194           <td><code> [inline, slot]</code></td>
 195         </tr>
 196       </table>
 197 </div>
 198 <div class="memdoc">
 199
 200 <p>add bookmarks to given translations (translation object is fetched and added to bookmarks data base (key and translation stored in db) </p>
 201 <dl><dt><b>Parameters:</b></dt><dd>
 202   <table border="0" cellspacing="2" cellpadding="0">
 203     <tr><td valign="top"></td><td valign="top"><em>translation</em>&nbsp;</td><td>translation object to be stored in db </td></tr>
 204   </table>
 205   </dd>
 206 </dl>
 207
 208 </div>
 209 </div>
 210 <a class="anchor" id="aaf91c7fe4e12d7007ca761dc89c14c8a"></a><!-- doxytag: member="Backbone::addDictionary" ref="aaf91c7fe4e12d7007ca761dc89c14c8a" args="(CommonDictInterface *dict, bool active=1)" -->
 211 <div class="memitem">
 212 <div class="memproto">
 213       <table class="memname">
 214         <tr>
 215           <td class="memname">void Backbone::addDictionary </td>
 216           <td>(</td>
 217           <td class="paramtype"><a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *&nbsp;</td>
 218           <td class="paramname"> <em>dict</em>, </td>
 219         </tr>
 220         <tr>
 221           <td class="paramkey"></td>
 222           <td></td>
 223           <td class="paramtype">bool&nbsp;</td>
 224           <td class="paramname"> <em>active</em> = <code>1</code></td><td>&nbsp;</td>
 225         </tr>
 226         <tr>
 227           <td></td>
 228           <td>)</td>
 229           <td></td><td></td><td><code> [slot]</code></td>
 230         </tr>
 231       </table>
 232 </div>
 233 <div class="memdoc">
 234
 235 <p>adds new dictionary and activate it </p>
 236 <dl><dt><b>Parameters:</b></dt><dd>
 237   <table border="0" cellspacing="2" cellpadding="0">
 238     <tr><td valign="top"></td><td valign="top"><em>dict</em>&nbsp;</td><td>dictionary to be added </td></tr>
 239     <tr><td valign="top"></td><td valign="top"><em>active</em>&nbsp;</td><td>decides whether searches are perfomed in given dictionaries </td></tr>
 240   </table>
 241   </dd>
 242 </dl>
 243
 244 </div>
 245 </div>
 246 <a class="anchor" id="a2307b5520b76d5751edef237ef6bbe85"></a><!-- doxytag: member="Backbone::fetchBookmarks" ref="a2307b5520b76d5751edef237ef6bbe85" args="()" -->
 247 <div class="memitem">
 248 <div class="memproto">
 249       <table class="memname">
 250         <tr>
 251           <td class="memname">void Backbone::fetchBookmarks </td>
 252           <td>(</td>
 253           <td class="paramname"></td>
 254           <td>&nbsp;)&nbsp;</td>
 255           <td><code> [inline, slot]</code></td>
 256         </tr>
 257       </table>
 258 </div>
 259 <div class="memdoc">
 260
 261 <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>
 262 <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>
 263
 264 </div>
 265 </div>
 266 <a class="anchor" id="a4b027f51bb4cc3803f6be85bc25d6a4b"></a><!-- doxytag: member="Backbone::getDictionaries" ref="a4b027f51bb4cc3803f6be85bc25d6a4b" args="()" -->
 267 <div class="memitem">
 268 <div class="memproto">
 269       <table class="memname">
 270         <tr>
 271           <td class="memname">QHash&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *, bool &gt; Backbone::getDictionaries </td>
 272           <td>(</td>
 273           <td class="paramname"></td>
 274           <td>&nbsp;)&nbsp;</td>
 275           <td></td>
 276         </tr>
 277       </table>
 278 </div>
 279 <div class="memdoc">
 280 <dl class="return"><dt><b>Returns:</b></dt><dd>all loadded dictionaries with activity state flag </dd></dl>
 281
 282 </div>
 283 </div>
 284 <a class="anchor" id="a2fdfa0cf73fda5304635b61455b48db9"></a><!-- doxytag: member="Backbone::getPlugins" ref="a2fdfa0cf73fda5304635b61455b48db9" args="()" -->
 285 <div class="memitem">
 286 <div class="memproto">
 287       <table class="memname">
 288         <tr>
 289           <td class="memname">QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt; Backbone::getPlugins </td>
 290           <td>(</td>
 291           <td class="paramname"></td>
 292           <td>&nbsp;)&nbsp;</td>
 293           <td></td>
 294         </tr>
 295       </table>
 296 </div>
 297 <div class="memdoc">
 298 <dl class="return"><dt><b>Returns:</b></dt><dd>all loadded plugins </dd></dl>
 299
 300 </div>
 301 </div>
 302 <a class="anchor" id="ac91e19871d56331ce0d744b8ea936e00"></a><!-- doxytag: member="Backbone::history" ref="ac91e19871d56331ce0d744b8ea936e00" args="()" -->
 303 <div class="memitem">
 304 <div class="memproto">
 305       <table class="memname">
 306         <tr>
 307           <td class="memname"><a class="el" href="classHistory.html">History</a> * Backbone::history </td>
 308           <td>(</td>
 309           <td class="paramname"></td>
 310           <td>&nbsp;)&nbsp;</td>
 311           <td></td>
 312         </tr>
 313       </table>
 314 </div>
 315 <div class="memdoc">
 316 <dl class="return"><dt><b>Returns:</b></dt><dd>history of performed searches </dd></dl>
 317
 318 </div>
 319 </div>
 320 <a class="anchor" id="a56df9bdfbe82998011f95ecb3c5bd7db"></a><!-- doxytag: member="Backbone::htmls" ref="a56df9bdfbe82998011f95ecb3c5bd7db" args="()" -->
 321 <div class="memitem">
 322 <div class="memproto">
 323       <table class="memname">
 324         <tr>
 325           <td class="memname">QStringList Backbone::htmls </td>
 326           <td>(</td>
 327           <td class="paramname"></td>
 328           <td>&nbsp;)&nbsp;</td>
 329           <td></td>
 330         </tr>
 331       </table>
 332 </div>
 333 <div class="memdoc">
 334 <dl class="return"><dt><b>Returns:</b></dt><dd>final translation (after searching for html) </dd></dl>
 335
 336 </div>
 337 </div>
 338 <a class="anchor" id="aa61afbf8ef2e05c0c2a9634fbdccad19"></a><!-- doxytag: member="Backbone::quit" ref="aa61afbf8ef2e05c0c2a9634fbdccad19" args="()" -->
 339 <div class="memitem">
 340 <div class="memproto">
 341       <table class="memname">
 342         <tr>
 343           <td class="memname">void Backbone::quit </td>
 344           <td>(</td>
 345           <td class="paramname"></td>
 346           <td>&nbsp;)&nbsp;</td>
 347           <td><code> [slot]</code></td>
 348         </tr>
 349       </table>
 350 </div>
 351 <div class="memdoc">
 352
 353 <p>stops all current activity - emiting signal </p>
 354 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBackbone.html#afef04921ba89c424eb882cc14153de39" title="emmited when backbone is ready to close - after getting stop signal it should kill...">closeOk</a> </dd></dl>
 355
 356 </div>
 357 </div>
 358 <a class="anchor" id="a2333e15516ba1276fa334703bfe53bdd"></a><!-- doxytag: member="Backbone::removeBookmark" ref="a2333e15516ba1276fa334703bfe53bdd" args="(QList&lt; Translation * &gt; translations)" -->
 359 <div class="memitem">
 360 <div class="memproto">
 361       <table class="memname">
 362         <tr>
 363           <td class="memname">void Backbone::removeBookmark </td>
 364           <td>(</td>
 365           <td class="paramtype">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td>
 366           <td class="paramname"> <em>translations</em></td>
 367           <td>&nbsp;)&nbsp;</td>
 368           <td><code> [inline, slot]</code></td>
 369         </tr>
 370       </table>
 371 </div>
 372 <div class="memdoc">
 373
 374 <p>Remove bookmarks to given translatios. </p>
 375 <dl><dt><b>Parameters:</b></dt><dd>
 376   <table border="0" cellspacing="2" cellpadding="0">
 377     <tr><td valign="top"></td><td valign="top"><em>translation</em>&nbsp;</td><td>remove bookmark to this translation </td></tr>
 378   </table>
 379   </dd>
 380 </dl>
 381
 382 </div>
 383 </div>
 384 <a class="anchor" id="a056fc494ed689f253d83fc2366c07931"></a><!-- doxytag: member="Backbone::removeDictionary" ref="a056fc494ed689f253d83fc2366c07931" args="(CommonDictInterface *dict)" -->
 385 <div class="memitem">
 386 <div class="memproto">
 387       <table class="memname">
 388         <tr>
 389           <td class="memname">void Backbone::removeDictionary </td>
 390           <td>(</td>
 391           <td class="paramtype"><a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *&nbsp;</td>
 392           <td class="paramname"> <em>dict</em></td>
 393           <td>&nbsp;)&nbsp;</td>
 394           <td><code> [slot]</code></td>
 395         </tr>
 396       </table>
 397 </div>
 398 <div class="memdoc">
 399
 400 <p>Removes given dictionary. </p>
 401 <dl><dt><b>Parameters:</b></dt><dd>
 402   <table border="0" cellspacing="2" cellpadding="0">
 403     <tr><td valign="top"></td><td valign="top"><em>dict</em>&nbsp;</td><td>dictionary to be deleted </td></tr>
 404   </table>
 405   </dd>
 406 </dl>
 407
 408 </div>
 409 </div>
 410 <a class="anchor" id="adeaabfee86975f65b8e728b8582caa35"></a><!-- doxytag: member="Backbone::result" ref="adeaabfee86975f65b8e728b8582caa35" args="()" -->
 411 <div class="memitem">
 412 <div class="memproto">
 413       <table class="memname">
 414         <tr>
 415           <td class="memname">QMultiHash&lt; QString, <a class="el" href="classTranslation.html">Translation</a> * &gt; Backbone::result </td>
 416           <td>(</td>
 417           <td class="paramname"></td>
 418           <td>&nbsp;)&nbsp;</td>
 419           <td></td>
 420         </tr>
 421       </table>
 422 </div>
 423 <div class="memdoc">
 424 <dl class="return"><dt><b>Returns:</b></dt><dd>return search fesult </dd></dl>
 425
 426 </div>
 427 </div>
 428 <a class="anchor" id="a3b1f2cf8de594cbd18bef4ca854337e2"></a><!-- doxytag: member="Backbone::search" ref="a3b1f2cf8de594cbd18bef4ca854337e2" args="(QString word)" -->
 429 <div class="memitem">
 430 <div class="memproto">
 431       <table class="memname">
 432         <tr>
 433           <td class="memname">void Backbone::search </td>
 434           <td>(</td>
 435           <td class="paramtype">QString&nbsp;</td>
 436           <td class="paramname"> <em>word</em></td>
 437           <td>&nbsp;)&nbsp;</td>
 438           <td><code> [slot]</code></td>
 439         </tr>
 440       </table>
 441 </div>
 442 <div class="memdoc">
 443
 444 <p>search for a word translation </p>
 445 <dl><dt><b>Parameters:</b></dt><dd>
 446   <table border="0" cellspacing="2" cellpadding="0">
 447     <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>to be translated </td></tr>
 448   </table>
 449   </dd>
 450 </dl>
 451
 452 </div>
 453 </div>
 454 <a class="anchor" id="a67dbca9402d40e4678f879ff8da3866e"></a><!-- doxytag: member="Backbone::searchHtml" ref="a67dbca9402d40e4678f879ff8da3866e" args="(QList&lt; Translation * &gt;)" -->
 455 <div class="memitem">
 456 <div class="memproto">
 457       <table class="memname">
 458         <tr>
 459           <td class="memname">void Backbone::searchHtml </td>
 460           <td>(</td>
 461           <td class="paramtype">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td>
 462           <td class="paramname"> <em>translations</em></td>
 463           <td>&nbsp;)&nbsp;</td>
 464           <td><code> [slot]</code></td>
 465         </tr>
 466       </table>
 467 </div>
 468 <div class="memdoc">
 469
 470 <p>Performs search for final translation (html/xml) form. </p>
 471 <dl><dt><b>Parameters:</b></dt><dd>
 472   <table border="0" cellspacing="2" cellpadding="0">
 473     <tr><td valign="top"></td><td valign="top"><em>list</em>&nbsp;</td><td>of Translation* to be searched for </td></tr>
 474   </table>
 475   </dd>
 476 </dl>
 477
 478 </div>
 479 </div>
 480 <a class="anchor" id="addad48903943006b6a4661169f80ee5a"></a><!-- doxytag: member="Backbone::searchLimit" ref="addad48903943006b6a4661169f80ee5a" args="() const " -->
 481 <div class="memitem">
 482 <div class="memproto">
 483       <table class="memname">
 484         <tr>
 485           <td class="memname">int Backbone::searchLimit </td>
 486           <td>(</td>
 487           <td class="paramname"></td>
 488           <td>&nbsp;)&nbsp;</td>
 489           <td> const</td>
 490         </tr>
 491       </table>
 492 </div>
 493 <div class="memdoc">
 494 <dl class="return"><dt><b>Returns:</b></dt><dd>maximum number of word that plugin could find </dd></dl>
 495
 496 </div>
 497 </div>
 498 <a class="anchor" id="ac23b486119652095d956413a6e68afec"></a><!-- doxytag: member="Backbone::selectedDictionaries" ref="ac23b486119652095d956413a6e68afec" args="(QList&lt; CommonDictInterface * &gt;)" -->
 499 <div class="memitem">
 500 <div class="memproto">
 501       <table class="memname">
 502         <tr>
 503           <td class="memname">void Backbone::selectedDictionaries </td>
 504           <td>(</td>
 505           <td class="paramtype">QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt;&nbsp;</td>
 506           <td class="paramname"> <em>activeDicts</em></td>
 507           <td>&nbsp;)&nbsp;</td>
 508           <td><code> [slot]</code></td>
 509         </tr>
 510       </table>
 511 </div>
 512 <div class="memdoc">
 513
 514 <p>sets active dictionaries (searches are performed only in active dicts </p>
 515 <dl><dt><b>Parameters:</b></dt><dd>
 516   <table border="0" cellspacing="2" cellpadding="0">
 517     <tr><td valign="top"></td><td valign="top"><em>List</em>&nbsp;</td><td>of dictionaris to be activated </td></tr>
 518   </table>
 519   </dd>
 520 </dl>
 521
 522 </div>
 523 </div>
 524 <a class="anchor" id="aa7147125301d2d2da004cb6d30b8630d"></a><!-- doxytag: member="Backbone::setSettings" ref="aa7147125301d2d2da004cb6d30b8630d" args="(Settings *settings)" -->
 525 <div class="memitem">
 526 <div class="memproto">
 527       <table class="memname">
 528         <tr>
 529           <td class="memname">void Backbone::setSettings </td>
 530           <td>(</td>
 531           <td class="paramtype"><a class="el" href="classSettings.html">Settings</a> *&nbsp;</td>
 532           <td class="paramname"> <em>settings</em></td>
 533           <td>&nbsp;)&nbsp;</td>
 534           <td><code> [slot]</code></td>
 535         </tr>
 536       </table>
 537 </div>
 538 <div class="memdoc">
 539
 540 <p>Sets settings for backbone: history_size, search_limit, searching backends (search_bookmarks, search_dictionaries). </p>
 541 <dl><dt><b>Parameters:</b></dt><dd>
 542   <table border="0" cellspacing="2" cellpadding="0">
 543     <tr><td valign="top"></td><td valign="top"><em>settings</em>&nbsp;</td><td>settings object with opitons set </td></tr>
 544   </table>
 545   </dd>
 546 </dl>
 547
 548 </div>
 549 </div>
 550 <a class="anchor" id="a2e2bd187c830e7fd5ad330dc0409f7f0"></a><!-- doxytag: member="Backbone::settings" ref="a2e2bd187c830e7fd5ad330dc0409f7f0" args="()" -->
 551 <div class="memitem">
 552 <div class="memproto">
 553       <table class="memname">
 554         <tr>
 555           <td class="memname"><a class="el" href="classSettings.html">Settings</a> * Backbone::settings </td>
 556           <td>(</td>
 557           <td class="paramname"></td>
 558           <td>&nbsp;)&nbsp;</td>
 559           <td><code> [slot]</code></td>
 560         </tr>
 561       </table>
 562 </div>
 563 <div class="memdoc">
 564 <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>
 565
 566 </div>
 567 </div>
 568 <hr/>The documentation for this class was generated from the following files:<ul>
 569 <li><a class="el" href="backbone_8h_source.html">backbone.h</a></li>
 570 <li>backbone.cpp</li>
 571 <li>moc_backbone.cpp</li>
 572 <li>build-desktop/moc_backbone.cpp</li>
 573 </ul>
 574 </div>
 575 <!--- window showing the filter options -->
 576 <div id="MSearchSelectWindow"
 577      onmouseover="return searchBox.OnSearchSelectShow()"
 578      onmouseout="return searchBox.OnSearchSelectHide()"
 579      onkeydown="return searchBox.OnSearchSelectKey(event)">
 580 <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>
 581
 582 <!-- iframe showing the search results (closed by default) -->
 583 <div id="MSearchResultsWindow">
 584 <iframe src="" frameborder="0"
 585         name="MSearchResults" id="MSearchResults">
 586 </iframe>
 587 </div>
 588
 589 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by&nbsp;
 590 <a href="http://www.doxygen.org/index.html">
 591 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 592 </body>
 593 </html>