Added documentation
[mdictionary] / doc / html / classWordListWidget.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: WordListWidget 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>WordListWidget Class Reference</h1><!-- doxytag: class="WordListWidget" -->
48 <p>Displays list of words found in dictionaries.  
49 <a href="#_details">More...</a></p>
50
51 <p><code>#include &lt;<a class="el" href="WordListWidget_8h_source.html">WordListWidget.h</a>&gt;</code></p>
52
53 <p><a href="classWordListWidget-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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWordListWidget.html#ae4ac47bc19b239de121fd72455215479">showSearchResults</a> (QHash&lt; QString, QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt; &gt;)</td></tr>
57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shows search results.  <a href="#ae4ac47bc19b239de121fd72455215479"></a><br/></td></tr>
58 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84984352531dfc2489f662f3cf30d9bd"></a><!-- doxytag: member="WordListWidget::lockList" ref="a84984352531dfc2489f662f3cf30d9bd" args="()" -->
59 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWordListWidget.html#a84984352531dfc2489f662f3cf30d9bd">lockList</a> ()</td></tr>
60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lock words list, while backbone is doing somethig in background. <br/></td></tr>
61 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c08e4e72879ae1015566474f88fde81"></a><!-- doxytag: member="WordListWidget::unlockList" ref="a9c08e4e72879ae1015566474f88fde81" args="()" -->
62 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWordListWidget.html#a9c08e4e72879ae1015566474f88fde81">unlockList</a> ()</td></tr>
63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unlocks words list. <br/></td></tr>
64 <tr><td colspan="2"><h2>Signals</h2></td></tr>
65 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWordListWidget.html#a8bd328a9229e63b99769041aa0dd3e06">showTranslation</a> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;)</td></tr>
66 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60a458e4bdaa3b918603efd5748d0a17"></a><!-- doxytag: member="WordListWidget::addBookmark" ref="a60a458e4bdaa3b918603efd5748d0a17" args="(QList&lt; Translation * &gt;)" -->
67 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWordListWidget.html#a60a458e4bdaa3b918603efd5748d0a17">addBookmark</a> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;)</td></tr>
68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request to add selected word to bookmarks. <br/></td></tr>
69 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ef184b35ebf94babb882405c80cb2c8"></a><!-- doxytag: member="WordListWidget::removeBookmark" ref="a7ef184b35ebf94babb882405c80cb2c8" args="(QList&lt; Translation * &gt;)" -->
70 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWordListWidget.html#a7ef184b35ebf94babb882405c80cb2c8">removeBookmark</a> (QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;)</td></tr>
71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request to remove selected word from bookmarks. <br/></td></tr>
72 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
73 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f84179019ee766bdb8c46f111da95ce"></a><!-- doxytag: member="WordListWidget::WordListWidget" ref="a5f84179019ee766bdb8c46f111da95ce" args="(QWidget *parent=0)" -->
74 &nbsp;</td><td class="memItemRight" valign="bottom"><b>WordListWidget</b> (QWidget *parent=0)</td></tr>
75 <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
76 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6550ace51b030ad657cc4d11a22e003f"></a><!-- doxytag: member="WordListWidget::mouseReleaseEvent" ref="a6550ace51b030ad657cc4d11a22e003f" args="(QMouseEvent *event)" -->
77 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>mouseReleaseEvent</b> (QMouseEvent *event)</td></tr>
78 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5d4dc1b72daeca1c03ac9b0498efc7a"></a><!-- doxytag: member="WordListWidget::resizeEvent" ref="af5d4dc1b72daeca1c03ac9b0498efc7a" args="(QResizeEvent *event)" -->
79 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>resizeEvent</b> (QResizeEvent *event)</td></tr>
80 </table>
81 <hr/><a name="_details"></a><h2>Detailed Description</h2>
82 <p>Displays list of words found in dictionaries. </p>
83 <p>It allow user to select word to see it's translation or to mark it as "star" </p>
84 <hr/><h2>Member Function Documentation</h2>
85 <a class="anchor" id="ae4ac47bc19b239de121fd72455215479"></a><!-- doxytag: member="WordListWidget::showSearchResults" ref="ae4ac47bc19b239de121fd72455215479" args="(QHash&lt; QString, QList&lt; Translation * &gt; &gt;)" -->
86 <div class="memitem">
87 <div class="memproto">
88       <table class="memname">
89         <tr>
90           <td class="memname">void WordListWidget::showSearchResults </td>
91           <td>(</td>
92           <td class="paramtype">QHash&lt; QString, QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt; &gt;&nbsp;</td>
93           <td class="paramname"> <em>result</em></td>
94           <td>&nbsp;)&nbsp;</td>
95           <td><code> [slot]</code></td>
96         </tr>
97       </table>
98 </div>
99 <div class="memdoc">
100
101 <p>Shows search results. </p>
102 <dl><dt><b>Parameters:</b></dt><dd>
103   <table border="0" cellspacing="2" cellpadding="0">
104     <tr><td valign="top"></td><td valign="top"><em>hash</em>&nbsp;</td><td>of found words and it's translations objects </td></tr>
105   </table>
106   </dd>
107 </dl>
108
109 </div>
110 </div>
111 <a class="anchor" id="a8bd328a9229e63b99769041aa0dd3e06"></a><!-- doxytag: member="WordListWidget::showTranslation" ref="a8bd328a9229e63b99769041aa0dd3e06" args="(QList&lt; Translation * &gt;)" -->
112 <div class="memitem">
113 <div class="memproto">
114       <table class="memname">
115         <tr>
116           <td class="memname">void WordListWidget::showTranslation </td>
117           <td>(</td>
118           <td class="paramtype">QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td>
119           <td class="paramname"> <em>_t1</em></td>
120           <td>&nbsp;)&nbsp;</td>
121           <td><code> [signal]</code></td>
122         </tr>
123       </table>
124 </div>
125 <div class="memdoc">
126 <p>Request to show translation which is described by passed translations objects </p>
127
128 </div>
129 </div>
130 <hr/>The documentation for this class was generated from the following files:<ul>
131 <li><a class="el" href="WordListWidget_8h_source.html">WordListWidget.h</a></li>
132 <li>WordListWidget.cpp</li>
133 <li>moc_WordListWidget.cpp</li>
134 </ul>
135 </div>
136 <!--- window showing the filter options -->
137 <div id="MSearchSelectWindow"
138      onmouseover="return searchBox.OnSearchSelectShow()"
139      onmouseout="return searchBox.OnSearchSelectHide()"
140      onkeydown="return searchBox.OnSearchSelectKey(event)">
141 <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>
142
143 <!-- iframe showing the search results (closed by default) -->
144 <div id="MSearchResultsWindow">
145 <iframe src="" frameborder="0" 
146         name="MSearchResults" id="MSearchResults">
147 </iframe>
148 </div>
149
150 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by&nbsp;
151 <a href="http://www.doxygen.org/index.html">
152 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
153 </body>
154 </html>