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>Inner part of dictionary - glues together GUI and plugins.
  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 <br/></td></tr>
  59 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b1f2cf8de594cbd18bef4ca854337e2"></a><!-- doxytag: member="Backbone::search" ref="a3b1f2cf8de594cbd18bef4ca854337e2" args="(QString word)" -->
  60 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a3b1f2cf8de594cbd18bef4ca854337e2">search</a> (QString word)</td></tr>
  61 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">search for a word translation <br/></td></tr>
  62 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac23b486119652095d956413a6e68afec"></a><!-- doxytag: member="Backbone::selectedDictionaries" ref="ac23b486119652095d956413a6e68afec" args="(QList&lt; CommonDictInterface * &gt;)" -->
  63 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>
  64 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets active dictionaries <br/></td></tr>
  65 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1f9ed9ee7f8b9e869092f2f9cd8cd3f"></a><!-- doxytag: member="Backbone::addDictionary" ref="af1f9ed9ee7f8b9e869092f2f9cd8cd3f" args="(CommonDictInterface *dict)" -->
  66 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#af1f9ed9ee7f8b9e869092f2f9cd8cd3f">addDictionary</a> (<a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *dict)</td></tr>
  67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">adds new dictionary <br/></td></tr>
  68 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa61afbf8ef2e05c0c2a9634fbdccad19"></a><!-- doxytag: member="Backbone::quit" ref="aa61afbf8ef2e05c0c2a9634fbdccad19" args="()" -->
  69 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#aa61afbf8ef2e05c0c2a9634fbdccad19">quit</a> ()</td></tr>
  70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stops all current activity and kill plugins - be ready to exit <br/></td></tr>
  71 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99fb5d8cdf33e7fdca74e9415d615150"></a><!-- doxytag: member="Backbone::translation" ref="a99fb5d8cdf33e7fdca74e9415d615150" args="(QList&lt; Translation * &gt;)" -->
  72 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a99fb5d8cdf33e7fdca74e9415d615150">translation</a> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;)</td></tr>
  73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fired when dictionary call finalTranslation(..) with translation ready. <br/></td></tr>
  74 <tr><td colspan="2"><h2>Signals</h2></td></tr>
  75 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#afef04921ba89c424eb882cc14153de39">closeOk</a> ()</td></tr>
  76 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae50cec4f0c49149a46e913b31bcef92c"></a><!-- doxytag: member="Backbone::ready" ref="ae50cec4f0c49149a46e913b31bcef92c" args="()" -->
  77 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#ae50cec4f0c49149a46e913b31bcef92c">ready</a> ()</td></tr>
  78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emitted when there are search result ready to fetch <br/></td></tr>
  79 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  80 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a738dad7741d990f8f51a1ffbbc4610c4"></a><!-- doxytag: member="Backbone::Backbone" ref="a738dad7741d990f8f51a1ffbbc4610c4" args="(QObject *parent=0)" -->
  81 &nbsp;</td><td class="memItemRight" valign="bottom"><b>Backbone</b> (QObject *parent=0)</td></tr>
  82 <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)" -->
  83 &nbsp;</td><td class="memItemRight" valign="bottom"><b>Backbone</b> (const <a class="el" href="classBackbone.html">Backbone</a> &amp;b)</td></tr>
  84 <tr><td class="memItemLeft" align="right" valign="top">QHash&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> <br class="typebreak"/>
  85 *, bool &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a4b027f51bb4cc3803f6be85bc25d6a4b">getDictionaries</a> ()</td></tr>
  86 <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>
  87 <tr><td class="memItemLeft" align="right" valign="top">QList&lt; QString &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#aad6c6a42de0c933f056354a5c6528f85">getHistory</a> ()</td></tr>
  88 <tr><td class="memItemLeft" align="right" valign="top">QMultiHash&lt; QString, <br class="typebreak"/>
  89 <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>
  90 <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>
  91 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#ad0ddecf22c51867e984cb4e6a745d67c">activeSearches</a> () const </td></tr>
  92 </table>
  93 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  94 <p>Inner part of dictionary - glues together GUI and plugins. </p>
  95 <hr/><h2>Member Function Documentation</h2>
  96 <a class="anchor" id="ad0ddecf22c51867e984cb4e6a745d67c"></a><!-- doxytag: member="Backbone::activeSearches" ref="ad0ddecf22c51867e984cb4e6a745d67c" args="() const " -->
  97 <div class="memitem">
  98 <div class="memproto">
  99       <table class="memname">
 100         <tr>
 101           <td class="memname">int Backbone::activeSearches </td>
 102           <td>(</td>
 103           <td class="paramname"></td>
 104           <td>&nbsp;)&nbsp;</td>
 105           <td> const</td>
 106         </tr>
 107       </table>
 108 </div>
 109 <div class="memdoc">
 110 <dl class="return"><dt><b>Returns:</b></dt><dd>number of active searches </dd></dl>
 111
 112 </div>
 113 </div>
 114 <a class="anchor" id="afef04921ba89c424eb882cc14153de39"></a><!-- doxytag: member="Backbone::closeOk" ref="afef04921ba89c424eb882cc14153de39" args="()" -->
 115 <div class="memitem">
 116 <div class="memproto">
 117       <table class="memname">
 118         <tr>
 119           <td class="memname">void Backbone::closeOk </td>
 120           <td>(</td>
 121           <td class="paramname"></td>
 122           <td>&nbsp;)&nbsp;</td>
 123           <td><code> [signal]</code></td>
 124         </tr>
 125       </table>
 126 </div>
 127 <div class="memdoc">
 128 <p>emmited when backbone is ready to close - after getting stop signal it should kill all threads and so on </p>
 129
 130 </div>
 131 </div>
 132 <a class="anchor" id="a4b027f51bb4cc3803f6be85bc25d6a4b"></a><!-- doxytag: member="Backbone::getDictionaries" ref="a4b027f51bb4cc3803f6be85bc25d6a4b" args="()" -->
 133 <div class="memitem">
 134 <div class="memproto">
 135       <table class="memname">
 136         <tr>
 137           <td class="memname">QHash&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *, bool &gt; Backbone::getDictionaries </td>
 138           <td>(</td>
 139           <td class="paramname"></td>
 140           <td>&nbsp;)&nbsp;</td>
 141           <td></td>
 142         </tr>
 143       </table>
 144 </div>
 145 <div class="memdoc">
 146 <dl class="return"><dt><b>Returns:</b></dt><dd>all loadded dictionaries with activity state flag </dd></dl>
 147
 148 </div>
 149 </div>
 150 <a class="anchor" id="aad6c6a42de0c933f056354a5c6528f85"></a><!-- doxytag: member="Backbone::getHistory" ref="aad6c6a42de0c933f056354a5c6528f85" args="()" -->
 151 <div class="memitem">
 152 <div class="memproto">
 153       <table class="memname">
 154         <tr>
 155           <td class="memname">QList&lt; QString &gt; Backbone::getHistory </td>
 156           <td>(</td>
 157           <td class="paramname"></td>
 158           <td>&nbsp;)&nbsp;</td>
 159           <td></td>
 160         </tr>
 161       </table>
 162 </div>
 163 <div class="memdoc">
 164 <dl class="return"><dt><b>Returns:</b></dt><dd>history of performed searches </dd></dl>
 165
 166 </div>
 167 </div>
 168 <a class="anchor" id="a2fdfa0cf73fda5304635b61455b48db9"></a><!-- doxytag: member="Backbone::getPlugins" ref="a2fdfa0cf73fda5304635b61455b48db9" args="()" -->
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname">QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt; Backbone::getPlugins </td>
 174           <td>(</td>
 175           <td class="paramname"></td>
 176           <td>&nbsp;)&nbsp;</td>
 177           <td></td>
 178         </tr>
 179       </table>
 180 </div>
 181 <div class="memdoc">
 182 <dl class="return"><dt><b>Returns:</b></dt><dd>all loadded plugins </dd></dl>
 183
 184 </div>
 185 </div>
 186 <a class="anchor" id="adeaabfee86975f65b8e728b8582caa35"></a><!-- doxytag: member="Backbone::result" ref="adeaabfee86975f65b8e728b8582caa35" args="()" -->
 187 <div class="memitem">
 188 <div class="memproto">
 189       <table class="memname">
 190         <tr>
 191           <td class="memname">QMultiHash&lt; QString, <a class="el" href="classTranslation.html">Translation</a> * &gt; Backbone::result </td>
 192           <td>(</td>
 193           <td class="paramname"></td>
 194           <td>&nbsp;)&nbsp;</td>
 195           <td></td>
 196         </tr>
 197       </table>
 198 </div>
 199 <div class="memdoc">
 200 <dl class="return"><dt><b>Returns:</b></dt><dd>return search fesult </dd></dl>
 201
 202 </div>
 203 </div>
 204 <a class="anchor" id="addad48903943006b6a4661169f80ee5a"></a><!-- doxytag: member="Backbone::searchLimit" ref="addad48903943006b6a4661169f80ee5a" args="() const " -->
 205 <div class="memitem">
 206 <div class="memproto">
 207       <table class="memname">
 208         <tr>
 209           <td class="memname">int Backbone::searchLimit </td>
 210           <td>(</td>
 211           <td class="paramname"></td>
 212           <td>&nbsp;)&nbsp;</td>
 213           <td> const</td>
 214         </tr>
 215       </table>
 216 </div>
 217 <div class="memdoc">
 218 <dl class="return"><dt><b>Returns:</b></dt><dd>maximum number of word that plugin could find </dd></dl>
 219
 220 </div>
 221 </div>
 222 <hr/>The documentation for this class was generated from the following files:<ul>
 223 <li><a class="el" href="backbone_8h_source.html">backbone.h</a></li>
 224 <li>backbone.cpp</li>
 225 <li>moc_backbone.cpp</li>
 226 </ul>
 227 </div>
 228 <!--- window showing the filter options -->
 229 <div id="MSearchSelectWindow"
 230      onmouseover="return searchBox.OnSearchSelectShow()"
 231      onmouseout="return searchBox.OnSearchSelectHide()"
 232      onkeydown="return searchBox.OnSearchSelectKey(event)">
 233 <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>Functions</a></div>
 234
 235 <!-- iframe showing the search results (closed by default) -->
 236 <div id="MSearchResultsWindow">
 237 <iframe src="" frameborder="0"
 238         name="MSearchResults" id="MSearchResults">
 239 </iframe>
 240 </div>
 241
 242 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 4 12:02:54 2010 for mDictionary by&nbsp;
 243 <a href="http://www.doxygen.org/index.html">
 244 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 245 </body>
 246 </html>