Added generated documentation
[mdictionary] / doc / html / classBackbone.html
diff --git a/doc/html/classBackbone.html b/doc/html/classBackbone.html
new file mode 100644 (file)
index 0000000..70daeab
--- /dev/null
@@ -0,0 +1,246 @@
+<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>mDictionary: Backbone Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javaScript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body onload='searchBox.OnSelectItem(0);'>
+<!-- Generated by Doxygen 1.6.3 -->
+<script type="text/javascript"><!--
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+--></script>
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+      <li>
+        <div id="MSearchBox" class="MSearchBoxInactive">
+        <img id="MSearchSelect" src="search/search.png"
+             onmouseover="return searchBox.OnSearchSelectShow()"
+             onmouseout="return searchBox.OnSearchSelectHide()"
+             alt=""/>
+        <input type="text" id="MSearchField" value="Search" accesskey="S"
+             onfocus="searchBox.OnSearchFieldFocus(true)" 
+             onblur="searchBox.OnSearchFieldFocus(false)" 
+             onkeyup="searchBox.OnSearchFieldChange(event)"/>
+        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+        </div>
+      </li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>Backbone Class Reference</h1><!-- doxytag: class="Backbone" -->
+<p>Inner part of dictionary - glues together GUI and plugins.  
+<a href="#_details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="backbone_8h_source.html">backbone.h</a>&gt;</code></p>
+
+<p><a href="classBackbone-members.html">List of all members.</a></p>
+<table border="0" cellpadding="0" cellspacing="0">
+<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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a1ede318bd5d226a8fa566f13452fb07d">stopSearching</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stops all current searches <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b1f2cf8de594cbd18bef4ca854337e2"></a><!-- doxytag: member="Backbone::search" ref="a3b1f2cf8de594cbd18bef4ca854337e2" args="(QString word)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a3b1f2cf8de594cbd18bef4ca854337e2">search</a> (QString word)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">search for a word translation <br/></td></tr>
+<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;)" -->
+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>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets active dictionaries <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1f9ed9ee7f8b9e869092f2f9cd8cd3f"></a><!-- doxytag: member="Backbone::addDictionary" ref="af1f9ed9ee7f8b9e869092f2f9cd8cd3f" args="(CommonDictInterface *dict)" -->
+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>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">adds new dictionary <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa61afbf8ef2e05c0c2a9634fbdccad19"></a><!-- doxytag: member="Backbone::quit" ref="aa61afbf8ef2e05c0c2a9634fbdccad19" args="()" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#aa61afbf8ef2e05c0c2a9634fbdccad19">quit</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stops all current activity and kill plugins - be ready to exit <br/></td></tr>
+<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;)" -->
+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>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fired when dictionary call finalTranslation(..) with translation ready. <br/></td></tr>
+<tr><td colspan="2"><h2>Signals</h2></td></tr>
+<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>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae50cec4f0c49149a46e913b31bcef92c"></a><!-- doxytag: member="Backbone::ready" ref="ae50cec4f0c49149a46e913b31bcef92c" args="()" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#ae50cec4f0c49149a46e913b31bcef92c">ready</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emitted when there are search result 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"><a class="anchor" id="a738dad7741d990f8f51a1ffbbc4610c4"></a><!-- doxytag: member="Backbone::Backbone" ref="a738dad7741d990f8f51a1ffbbc4610c4" args="(QObject *parent=0)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>Backbone</b> (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 &amp;b)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>Backbone</b> (const <a class="el" href="classBackbone.html">Backbone</a> &amp;b)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">QHash&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> <br class="typebreak"/>
+*, bool &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBackbone.html#a4b027f51bb4cc3803f6be85bc25d6a4b">getDictionaries</a> ()</td></tr>
+<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>
+<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>
+<tr><td class="memItemLeft" align="right" valign="top">QMultiHash&lt; QString, <br class="typebreak"/>
+<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>
+<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>
+<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>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Inner part of dictionary - glues together GUI and plugins. </p>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="ad0ddecf22c51867e984cb4e6a745d67c"></a><!-- doxytag: member="Backbone::activeSearches" ref="ad0ddecf22c51867e984cb4e6a745d67c" args="() const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int Backbone::activeSearches </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const</td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<dl class="return"><dt><b>Returns:</b></dt><dd>number of active searches </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="afef04921ba89c424eb882cc14153de39"></a><!-- doxytag: member="Backbone::closeOk" ref="afef04921ba89c424eb882cc14153de39" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void Backbone::closeOk </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [signal]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>emmited when backbone is ready to close - after getting stop signal it should kill all threads and so on </p>
+
+</div>
+</div>
+<a class="anchor" id="a4b027f51bb4cc3803f6be85bc25d6a4b"></a><!-- doxytag: member="Backbone::getDictionaries" ref="a4b027f51bb4cc3803f6be85bc25d6a4b" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">QHash&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *, bool &gt; Backbone::getDictionaries </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<dl class="return"><dt><b>Returns:</b></dt><dd>all loadded dictionaries with activity state flag </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="aad6c6a42de0c933f056354a5c6528f85"></a><!-- doxytag: member="Backbone::getHistory" ref="aad6c6a42de0c933f056354a5c6528f85" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">QList&lt; QString &gt; Backbone::getHistory </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<dl class="return"><dt><b>Returns:</b></dt><dd>history of performed searches </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a2fdfa0cf73fda5304635b61455b48db9"></a><!-- doxytag: member="Backbone::getPlugins" ref="a2fdfa0cf73fda5304635b61455b48db9" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt; Backbone::getPlugins </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<dl class="return"><dt><b>Returns:</b></dt><dd>all loadded plugins </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="adeaabfee86975f65b8e728b8582caa35"></a><!-- doxytag: member="Backbone::result" ref="adeaabfee86975f65b8e728b8582caa35" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">QMultiHash&lt; QString, <a class="el" href="classTranslation.html">Translation</a> * &gt; Backbone::result </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<dl class="return"><dt><b>Returns:</b></dt><dd>return search fesult </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="addad48903943006b6a4661169f80ee5a"></a><!-- doxytag: member="Backbone::searchLimit" ref="addad48903943006b6a4661169f80ee5a" args="() const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int Backbone::searchLimit </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const</td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<dl class="return"><dt><b>Returns:</b></dt><dd>maximum number of word that plugin could find </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>
+</ul>
+</div>
+<!--- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+<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>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 4 12:02:54 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>
+</html>