Added documentation
[mdictionary] / doc / html / Bookmarks_8h_source.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: Bookmarks.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
22       <li class="current"><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="files.html"><span>File&nbsp;List</span></a></li>
41     </ul>
42   </div>
43 <h1>Bookmarks.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*******************************************************************************</span>
44 <a name="l00002"></a>00002 <span class="comment"></span>
45 <a name="l00003"></a>00003 <span class="comment">    This file is part of mDictionary.</span>
46 <a name="l00004"></a>00004 <span class="comment"></span>
47 <a name="l00005"></a>00005 <span class="comment">    mDictionary is free software: you can redistribute it and/or modify</span>
48 <a name="l00006"></a>00006 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
49 <a name="l00007"></a>00007 <span class="comment">    the Free Software Foundation, either version 3 of the License, or</span>
50 <a name="l00008"></a>00008 <span class="comment">    (at your option) any later version.</span>
51 <a name="l00009"></a>00009 <span class="comment"></span>
52 <a name="l00010"></a>00010 <span class="comment">    mDictionary is distributed in the hope that it will be useful,</span>
53 <a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
54 <a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
55 <a name="l00013"></a>00013 <span class="comment">    GNU General Public License for more details.</span>
56 <a name="l00014"></a>00014 <span class="comment"></span>
57 <a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU General Public License</span>
58 <a name="l00016"></a>00016 <span class="comment">    along with mDictionary.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
59 <a name="l00017"></a>00017 <span class="comment"></span>
60 <a name="l00018"></a>00018 <span class="comment">    Copyright 2010 Comarch S.A.</span>
61 <a name="l00019"></a>00019 <span class="comment"></span>
62 <a name="l00020"></a>00020 <span class="comment">*******************************************************************************/</span>
63 <a name="l00021"></a>00021 
64 <a name="l00030"></a>00030 <span class="preprocessor">#ifndef BOOKMARKS_H</span>
65 <a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define BOOKMARKS_H</span>
66 <a name="l00032"></a>00032 <span class="preprocessor"></span>
67 <a name="l00033"></a>00033 <span class="preprocessor">#include &lt;QtSql&gt;</span>
68 <a name="l00034"></a>00034 <span class="preprocessor">#include &lt;QString&gt;</span>
69 <a name="l00035"></a>00035 <span class="preprocessor">#include &lt;QVariant&gt;</span>
70 <a name="l00036"></a>00036 <span class="preprocessor">#include &lt;QStringList&gt;</span>
71 <a name="l00037"></a>00037 <span class="preprocessor">#include &lt;QList&gt;</span>
72 <a name="l00038"></a>00038 <span class="preprocessor">#include &lt;QSqlQuery&gt;</span>
73 <a name="l00039"></a>00039 <span class="preprocessor">#include &lt;QSqlDatabase&gt;</span>
74 <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;QSqlError&gt;</span>
75 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;QDir&gt;</span>
76 <a name="l00042"></a>00042 <span class="preprocessor">#include &lt;QDebug&gt;</span>
77 <a name="l00043"></a>00043 <span class="preprocessor">#include &quot;../../includes/settings.h&quot;</span>
78 <a name="l00044"></a>00044 <span class="preprocessor">#include &quot;../../includes/translation.h&quot;</span>
79 <a name="l00045"></a>00045 <span class="keyword">class </span><a class="code" href="classBookmarkTranslation.html" title="/file BookmarkTranslation.h">BookmarkTranslation</a>;
80 <a name="l00046"></a>00046 
81 <a name="l00047"></a>00047 
82 <a name="l00055"></a><a class="code" href="classBookmarks.html">00055</a> <span class="keyword">class </span><a class="code" href="classBookmarks.html" title="Bookmarks are way to store words that You think You will need to search for often...">Bookmarks</a>
83 <a name="l00056"></a>00056 {
84 <a name="l00057"></a>00057 <span class="keyword">public</span>:
85 <a name="l00058"></a>00058     <a class="code" href="classBookmarks.html" title="Bookmarks are way to store words that You think You will need to search for often...">Bookmarks</a>();
86 <a name="l00059"></a>00059 
87 <a name="l00063"></a>00063     <span class="keywordtype">void</span> <a class="code" href="classBookmarks.html#a9683f8d17fe512b8db231c65e50a0849" title="Adds new word and translation to bookmarks.">add</a>(<a class="code" href="classTranslation.html" title="/file translation.h">Translation</a>* translation);
88 <a name="l00064"></a>00064 
89 <a name="l00068"></a>00068     <span class="keywordtype">void</span> <span class="keyword">remove</span>(<a class="code" href="classTranslation.html" title="/file translation.h">Translation</a>* translation);
90 <a name="l00069"></a>00069 
91 <a name="l00073"></a>00073     QList&lt;Translation*&gt; <a class="code" href="classBookmarks.html#a3c4e248e8d2f669d6f9095d84db78dda">list</a>();
92 <a name="l00074"></a>00074 
93 <a name="l00079"></a>00079     QList&lt;Translation*&gt; <a class="code" href="classBookmarks.html#ae77e1a6e54a1a100f31b91cf419875be" title="search in bookmarks for given word (wildcards may apply &amp;#39;*&amp;#39; and &amp;#39;?&amp;#39;)...">searchWordList</a>(QString word);
94 <a name="l00080"></a>00080 
95 <a name="l00086"></a>00086     QStringList <a class="code" href="classBookmarks.html#af8860f39cc06e8848d2f0eca07573148" title="Search for final translation of given word.">search</a>(QString word, QString dbname);
96 <a name="l00087"></a>00087 
97 <a name="l00088"></a>00088 
98 <a name="l00090"></a>00090     <span class="keywordtype">void</span> <a class="code" href="classBookmarks.html#ae92c866a7711e2e10c6ad42ae2ced0ad" title="clars bookmarks database">clear</a>();
99 <a name="l00091"></a>00091 
100 <a name="l00092"></a>00092 
101 <a name="l00096"></a>00096     <span class="keywordtype">bool</span> <a class="code" href="classBookmarks.html#aea5612609b4a4ac0e56de73dcb38625e">inBookmarks</a>(QString word);
102 <a name="l00097"></a>00097 
103 <a name="l00098"></a>00098 <span class="keyword">private</span>:
104 <a name="l00099"></a>00099     QString dbName;
105 <a name="l00100"></a>00100 
106 <a name="l00101"></a>00101     <span class="keywordtype">bool</span> checkAndCreateDb();
107 <a name="l00102"></a>00102     QString removeAccents(QString);
108 <a name="l00103"></a>00103     QSqlDatabase getDbCnx(QString dbName);
109 <a name="l00104"></a>00104 
110 <a name="l00105"></a>00105 };
111 <a name="l00106"></a>00106 
112 <a name="l00107"></a>00107 <span class="preprocessor">#endif // BOOKMARKS_H</span>
113 </pre></div></div>
114 <!--- window showing the filter options -->
115 <div id="MSearchSelectWindow"
116      onmouseover="return searchBox.OnSearchSelectShow()"
117      onmouseout="return searchBox.OnSearchSelectHide()"
118      onkeydown="return searchBox.OnSearchSelectKey(event)">
119 <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>
120
121 <!-- iframe showing the search results (closed by default) -->
122 <div id="MSearchResultsWindow">
123 <iframe src="" frameborder="0" 
124         name="MSearchResults" id="MSearchResults">
125 </iframe>
126 </div>
127
128 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by&nbsp;
129 <a href="http://www.doxygen.org/index.html">
130 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
131 </body>
132 </html>