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">
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <title>mDictionary: SearchBarWidget 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"/>
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');
17 <div class="navigation" id="top">
20 <li><a href="index.html"><span>Main 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>
24 <div id="MSearchBox" class="MSearchBoxInactive">
25 <img id="MSearchSelect" src="search/search.png"
26 onmouseover="return searchBox.OnSearchSelectShow()"
27 onmouseout="return searchBox.OnSearchSelectHide()"
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>
40 <li><a href="annotated.html"><span>Class List</span></a></li>
41 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
42 <li><a href="functions.html"><span>Class Members</span></a></li>
46 <div class="contents">
47 <h1>SearchBarWidget Class Reference</h1><!-- doxytag: class="SearchBarWidget" -->
48 <p>Displays search bar.
49 <a href="#_details">More...</a></p>
51 <p><code>#include <<a class="el" href="SearchBarWidget_8h_source.html">SearchBarWidget.h</a>></code></p>
53 <p><a href="classSearchBarWidget-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#ae1e2875f18de4bf78addf805a3ae896a">setEnabled</a> (bool)</td></tr>
57 <tr><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable search word line edit and history buttons. <a href="#ae1e2875f18de4bf78addf805a3ae896a"></a><br/></td></tr>
58 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a3465a1a8d80d41f36df6f4b79db47521">setBusy</a> ()</td></tr>
59 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets search bar in busy state. <a href="#a3465a1a8d80d41f36df6f4b79db47521"></a><br/></td></tr>
60 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#aa23090a81d12eef86f4078d4f4c7a56e">setIdle</a> ()</td></tr>
61 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets search bar in idle state. <a href="#aa23090a81d12eef86f4078d4f4c7a56e"></a><br/></td></tr>
62 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#ab62c56cffe50613543e05ef58371cf31">search</a> (QString word)</td></tr>
63 <tr><td class="mdescLeft"> </td><td class="mdescRight">Search for given word. <a href="#ab62c56cffe50613543e05ef58371cf31"></a><br/></td></tr>
64 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a967b78d6ec64459d2e68eb3367af3da2">searchDelay</a> (QString word)</td></tr>
65 <tr><td class="mdescLeft"> </td><td class="mdescRight">Start to search for given word after 500 ms. <a href="#a967b78d6ec64459d2e68eb3367af3da2"></a><br/></td></tr>
66 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a753561409f73334ad2364bdbf7134eba"></a><!-- doxytag: member="SearchBarWidget::updateHistoryButtons" ref="a753561409f73334ad2364bdbf7134eba" args="(bool prev, bool next, bool list)" -->
67 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a753561409f73334ad2364bdbf7134eba">updateHistoryButtons</a> (bool prev, bool next, bool list)</td></tr>
68 <tr><td class="mdescLeft"> </td><td class="mdescRight">Updates state of history buttons. <br/></td></tr>
69 <tr><td colspan="2"><h2>Signals</h2></td></tr>
70 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a72e7ffc17c918cc8839f892d0161521b">searchForTranslations</a> (QString)</td></tr>
71 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a126dc7f997386fce833d879f643a077b"></a><!-- doxytag: member="SearchBarWidget::stopSearching" ref="a126dc7f997386fce833d879f643a077b" args="()" -->
72 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a126dc7f997386fce833d879f643a077b">stopSearching</a> ()</td></tr>
73 <tr><td class="mdescLeft"> </td><td class="mdescRight">Request to stop all active searchings. <br/></td></tr>
74 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78a45ebd4c4af1c3794bf1945bddc1c0"></a><!-- doxytag: member="SearchBarWidget::historyPrev" ref="a78a45ebd4c4af1c3794bf1945bddc1c0" args="()" -->
75 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a78a45ebd4c4af1c3794bf1945bddc1c0">historyPrev</a> ()</td></tr>
76 <tr><td class="mdescLeft"> </td><td class="mdescRight">Request to show previous translation in history. <br/></td></tr>
77 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7160d249f973fa021b3ed0034ee6d875"></a><!-- doxytag: member="SearchBarWidget::historyNext" ref="a7160d249f973fa021b3ed0034ee6d875" args="()" -->
78 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a7160d249f973fa021b3ed0034ee6d875">historyNext</a> ()</td></tr>
79 <tr><td class="mdescLeft"> </td><td class="mdescRight">Request to show next translation in history. <br/></td></tr>
80 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6008388c3ca95ea2c432ad7dffd8e544"></a><!-- doxytag: member="SearchBarWidget::historyShow" ref="a6008388c3ca95ea2c432ad7dffd8e544" args="()" -->
81 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a6008388c3ca95ea2c432ad7dffd8e544">historyShow</a> ()</td></tr>
82 <tr><td class="mdescLeft"> </td><td class="mdescRight">Request to show history list. <br/></td></tr>
83 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adaa0d9b2abbc4deec48164401316e752"></a><!-- doxytag: member="SearchBarWidget::refreshHistoryButtons" ref="adaa0d9b2abbc4deec48164401316e752" args="()" -->
84 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#adaa0d9b2abbc4deec48164401316e752">refreshHistoryButtons</a> ()</td></tr>
85 <tr><td class="mdescLeft"> </td><td class="mdescRight">Request to refresh state of history buttons. <br/></td></tr>
86 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
87 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a797e54c56b9a819fe97dcd9875d513c6"></a><!-- doxytag: member="SearchBarWidget::SearchBarWidget" ref="a797e54c56b9a819fe97dcd9875d513c6" args="(QWidget *parent=0)" -->
88 </td><td class="memItemRight" valign="bottom"><b>SearchBarWidget</b> (QWidget *parent=0)</td></tr>
90 <hr/><a name="_details"></a><h2>Detailed Description</h2>
91 <p>Displays search bar. </p>
92 <p>Contains line edit field to input word which user would like to find and buttons to start/stop search and browse search history. Line edit and history buttons are disabled when search is ongoing, only start/stop button stays active. When searching it also displays progress bar </p>
93 <hr/><h2>Member Function Documentation</h2>
94 <a class="anchor" id="ab62c56cffe50613543e05ef58371cf31"></a><!-- doxytag: member="SearchBarWidget::search" ref="ab62c56cffe50613543e05ef58371cf31" args="(QString word)" -->
96 <div class="memproto">
97 <table class="memname">
99 <td class="memname">void SearchBarWidget::search </td>
101 <td class="paramtype">QString </td>
102 <td class="paramname"> <em>word</em></td>
103 <td> ) </td>
104 <td><code> [slot]</code></td>
110 <p>Search for given word. </p>
111 <p>Sets word as text in search word line edit </p>
115 <a class="anchor" id="a967b78d6ec64459d2e68eb3367af3da2"></a><!-- doxytag: member="SearchBarWidget::searchDelay" ref="a967b78d6ec64459d2e68eb3367af3da2" args="(QString word)" -->
116 <div class="memitem">
117 <div class="memproto">
118 <table class="memname">
120 <td class="memname">void SearchBarWidget::searchDelay </td>
122 <td class="paramtype">QString </td>
123 <td class="paramname"> <em>word</em></td>
124 <td> ) </td>
125 <td><code> [slot]</code></td>
131 <p>Start to search for given word after 500 ms. </p>
132 <p>Sets word as text in search word line edit, and wait 500 ms to start search. If in meanwhile this slot is called again it will stop previous timers. </p>
136 <a class="anchor" id="a72e7ffc17c918cc8839f892d0161521b"></a><!-- doxytag: member="SearchBarWidget::searchForTranslations" ref="a72e7ffc17c918cc8839f892d0161521b" args="(QString)" -->
137 <div class="memitem">
138 <div class="memproto">
139 <table class="memname">
141 <td class="memname">void SearchBarWidget::searchForTranslations </td>
143 <td class="paramtype">QString </td>
144 <td class="paramname"> <em>_t1</em></td>
145 <td> ) </td>
146 <td><code> [signal]</code></td>
151 <p>Requests to search for list of matching words to word passed as parameter </p>
155 <a class="anchor" id="a3465a1a8d80d41f36df6f4b79db47521"></a><!-- doxytag: member="SearchBarWidget::setBusy" ref="a3465a1a8d80d41f36df6f4b79db47521" args="()" -->
156 <div class="memitem">
157 <div class="memproto">
158 <table class="memname">
160 <td class="memname">void SearchBarWidget::setBusy </td>
162 <td class="paramname"></td>
163 <td> ) </td>
164 <td><code> [slot]</code></td>
170 <p>Sets search bar in busy state. </p>
171 <p>Displays "busy" bar and disables search word text edit and history buttons </p>
175 <a class="anchor" id="ae1e2875f18de4bf78addf805a3ae896a"></a><!-- doxytag: member="SearchBarWidget::setEnabled" ref="ae1e2875f18de4bf78addf805a3ae896a" args="(bool)" -->
176 <div class="memitem">
177 <div class="memproto">
178 <table class="memname">
180 <td class="memname">void SearchBarWidget::setEnabled </td>
182 <td class="paramtype">bool </td>
183 <td class="paramname"> <em>enabled</em></td>
184 <td> ) </td>
185 <td><code> [slot]</code></td>
191 <p>Enable or disable search word line edit and history buttons. </p>
192 <p>While searching it disables only history button and line edit. Search/Stop button is always enabled </p>
196 <a class="anchor" id="aa23090a81d12eef86f4078d4f4c7a56e"></a><!-- doxytag: member="SearchBarWidget::setIdle" ref="aa23090a81d12eef86f4078d4f4c7a56e" args="()" -->
197 <div class="memitem">
198 <div class="memproto">
199 <table class="memname">
201 <td class="memname">void SearchBarWidget::setIdle </td>
203 <td class="paramname"></td>
204 <td> ) </td>
205 <td><code> [slot]</code></td>
211 <p>Sets search bar in idle state. </p>
212 <p>Hides "busy" bar and enables all widgets, refresh state of history buttons by emmiting refreshHistoryButtons signal </p>
216 <hr/>The documentation for this class was generated from the following files:<ul>
217 <li><a class="el" href="SearchBarWidget_8h_source.html">SearchBarWidget.h</a></li>
218 <li>SearchBarWidget.cpp</li>
219 <li>moc_SearchBarWidget.cpp</li>
220 <li>build-desktop/moc_SearchBarWidget.cpp</li>
223 <!--- window showing the filter options -->
224 <div id="MSearchSelectWindow"
225 onmouseover="return searchBox.OnSearchSelectShow()"
226 onmouseout="return searchBox.OnSearchSelectHide()"
227 onkeydown="return searchBox.OnSearchSelectKey(event)">
228 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a></div>
230 <!-- iframe showing the search results (closed by default) -->
231 <div id="MSearchResultsWindow">
232 <iframe src="" frameborder="0"
233 name="MSearchResults" id="MSearchResults">
237 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by
238 <a href="http://www.doxygen.org/index.html">
239 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>