Changed repo structure
[mdictionary] / doc / html / classBookmarks.html
diff --git a/doc/html/classBookmarks.html b/doc/html/classBookmarks.html
deleted file mode 100644 (file)
index e91d36c..0000000
+++ /dev/null
@@ -1,255 +0,0 @@
-<!-- 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: Bookmarks 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>Bookmarks Class Reference</h1><!-- doxytag: class="Bookmarks" -->
-<p><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> are way to store words that You think You will need to search for often.  
-<a href="#_details">More...</a></p>
-
-<p><code>#include &lt;<a class="el" href="Bookmarks_8h_source.html">Bookmarks.h</a>&gt;</code></p>
-
-<p><a href="classBookmarks-members.html">List of all members.</a></p>
-<table border="0" cellpadding="0" cellspacing="0">
-<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBookmarks.html#a9683f8d17fe512b8db231c65e50a0849">add</a> (<a class="el" href="classTranslation.html">Translation</a> *translation)</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds new word and translation to bookmarks.  <a href="#a9683f8d17fe512b8db231c65e50a0849"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBookmarks.html#a39e88874e5f250386e82340c954d71f8">remove</a> (<a class="el" href="classTranslation.html">Translation</a> *translation)</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes word and coresponding translation cache from bookmark list.  <a href="#a39e88874e5f250386e82340c954d71f8"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBookmarks.html#a3c4e248e8d2f669d6f9095d84db78dda">list</a> ()</td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBookmarks.html#ae77e1a6e54a1a100f31b91cf419875be">searchWordList</a> (QString word)</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">search in bookmarks for given word (wildcards may apply '*' and '?')  <a href="#ae77e1a6e54a1a100f31b91cf419875be"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">QStringList&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBookmarks.html#af8860f39cc06e8848d2f0eca07573148">search</a> (QString word, QString dbname)</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Search for final translation of given word.  <a href="#af8860f39cc06e8848d2f0eca07573148"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae92c866a7711e2e10c6ad42ae2ced0ad"></a><!-- doxytag: member="Bookmarks::clear" ref="ae92c866a7711e2e10c6ad42ae2ced0ad" args="()" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBookmarks.html#ae92c866a7711e2e10c6ad42ae2ced0ad">clear</a> ()</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">clars bookmarks database <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBookmarks.html#aea5612609b4a4ac0e56de73dcb38625e">inBookmarks</a> (QString word)</td></tr>
-</table>
-<hr/><a name="_details"></a><h2>Detailed Description</h2>
-<p><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> are way to store words that You think You will need to search for often. </p>
-<p>When You add bookmark (by clickin on "star" in words list) You adds it to special list with cached translations from all available dictionaries so You can search for them quickly even when You delete coresponding dict. </p>
-<hr/><h2>Member Function Documentation</h2>
-<a class="anchor" id="a9683f8d17fe512b8db231c65e50a0849"></a><!-- doxytag: member="Bookmarks::add" ref="a9683f8d17fe512b8db231c65e50a0849" args="(Translation *translation)" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void Bookmarks::add </td>
-          <td>(</td>
-          <td class="paramtype"><a class="el" href="classTranslation.html">Translation</a> *&nbsp;</td>
-          <td class="paramname"> <em>translation</em></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-
-<p>Adds new word and translation to bookmarks. </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>&nbsp;</td><td>new translation to be saved and cached as a bookmark </td></tr>
-  </table>
-  </dd>
-</dl>
-
-</div>
-</div>
-<a class="anchor" id="aea5612609b4a4ac0e56de73dcb38625e"></a><!-- doxytag: member="Bookmarks::inBookmarks" ref="aea5612609b4a4ac0e56de73dcb38625e" args="(QString word)" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">bool Bookmarks::inBookmarks </td>
-          <td>(</td>
-          <td class="paramtype">QString&nbsp;</td>
-          <td class="paramname"> <em>word</em></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<dl class="return"><dt><b>Returns:</b></dt><dd>true if given word is already in bookmarks </dd></dl>
-<dl><dt><b>Parameters:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>to check </td></tr>
-  </table>
-  </dd>
-</dl>
-
-</div>
-</div>
-<a class="anchor" id="a3c4e248e8d2f669d6f9095d84db78dda"></a><!-- doxytag: member="Bookmarks::list" ref="a3c4e248e8d2f669d6f9095d84db78dda" args="()" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt; Bookmarks::list </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 bookmarks (word and translation as a translation object as a list </dd></dl>
-
-</div>
-</div>
-<a class="anchor" id="a39e88874e5f250386e82340c954d71f8"></a><!-- doxytag: member="Bookmarks::remove" ref="a39e88874e5f250386e82340c954d71f8" args="(Translation *translation)" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void Bookmarks::remove </td>
-          <td>(</td>
-          <td class="paramtype"><a class="el" href="classTranslation.html">Translation</a> *&nbsp;</td>
-          <td class="paramname"> <em>translation</em></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-
-<p>Removes word and coresponding translation cache from bookmark list. </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>&nbsp;</td><td>translation to be removed </td></tr>
-  </table>
-  </dd>
-</dl>
-
-</div>
-</div>
-<a class="anchor" id="af8860f39cc06e8848d2f0eca07573148"></a><!-- doxytag: member="Bookmarks::search" ref="af8860f39cc06e8848d2f0eca07573148" args="(QString word, QString dbname)" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">QStringList Bookmarks::search </td>
-          <td>(</td>
-          <td class="paramtype">QString&nbsp;</td>
-          <td class="paramname"> <em>word</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">QString&nbsp;</td>
-          <td class="paramname"> <em>dbname</em></td><td>&nbsp;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td><td></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-
-<p>Search for final translation of given word. </p>
-<dl class="return"><dt><b>Returns:</b></dt><dd>word translation list in text format xml or html to be formated and displayed </dd></dl>
-<dl><dt><b>Parameters:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>word to search for </td></tr>
-  </table>
-  </dd>
-</dl>
-
-</div>
-</div>
-<a class="anchor" id="ae77e1a6e54a1a100f31b91cf419875be"></a><!-- doxytag: member="Bookmarks::searchWordList" ref="ae77e1a6e54a1a100f31b91cf419875be" args="(QString word)" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt; Bookmarks::searchWordList </td>
-          <td>(</td>
-          <td class="paramtype">QString&nbsp;</td>
-          <td class="paramname"> <em>word</em></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-
-<p>search in bookmarks for given word (wildcards may apply '*' and '?') </p>
-<dl><dt><b>Parameters:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>to search for </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="return"><dt><b>Returns:</b></dt><dd>list of matching <a class="el" href="classTranslation.html" title="/file translation.h">Translation</a> objects </dd></dl>
-
-</div>
-</div>
-<hr/>The documentation for this class was generated from the following files:<ul>
-<li><a class="el" href="Bookmarks_8h_source.html">Bookmarks.h</a></li>
-<li>Bookmarks.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><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 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>
-</html>