git.maemo.org Git - mdictionary/blob - doc/html/classSearchBarWidget.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: 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"/>
  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>SearchBarWidget Class Reference</h1><!-- doxytag: class="SearchBarWidget" -->
  48 <p>Displays search bar.
  49 <a href="#_details">More...</a></p>
  50
  51 <p><code>#include &lt;<a class="el" href="SearchBarWidget_8h_source.html">SearchBarWidget.h</a>&gt;</code></p>
  52
  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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#ae1e2875f18de4bf78addf805a3ae896a">setEnabled</a> (bool)</td></tr>
  57 <tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a3465a1a8d80d41f36df6f4b79db47521">setBusy</a> ()</td></tr>
  59 <tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#aa23090a81d12eef86f4078d4f4c7a56e">setIdle</a> ()</td></tr>
  61 <tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#ab62c56cffe50613543e05ef58371cf31">search</a> (QString word)</td></tr>
  63 <tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a967b78d6ec64459d2e68eb3367af3da2">searchDelay</a> (QString word)</td></tr>
  65 <tr><td class="mdescLeft">&nbsp;</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&nbsp;</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">&nbsp;</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&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a126dc7f997386fce833d879f643a077b">stopSearching</a> ()</td></tr>
  73 <tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a78a45ebd4c4af1c3794bf1945bddc1c0">historyPrev</a> ()</td></tr>
  76 <tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a7160d249f973fa021b3ed0034ee6d875">historyNext</a> ()</td></tr>
  79 <tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a6008388c3ca95ea2c432ad7dffd8e544">historyShow</a> ()</td></tr>
  82 <tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#adaa0d9b2abbc4deec48164401316e752">refreshHistoryButtons</a> ()</td></tr>
  85 <tr><td class="mdescLeft">&nbsp;</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 &nbsp;</td><td class="memItemRight" valign="bottom"><b>SearchBarWidget</b> (QWidget *parent=0)</td></tr>
  89 </table>
  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)" -->
  95 <div class="memitem">
  96 <div class="memproto">
  97       <table class="memname">
  98         <tr>
  99           <td class="memname">void SearchBarWidget::search </td>
 100           <td>(</td>
 101           <td class="paramtype">QString&nbsp;</td>
 102           <td class="paramname"> <em>word</em></td>
 103           <td>&nbsp;)&nbsp;</td>
 104           <td><code> [slot]</code></td>
 105         </tr>
 106       </table>
 107 </div>
 108 <div class="memdoc">
 109
 110 <p>Search for given word. </p>
 111 <p>Sets word as text in search word line edit </p>
 112
 113 </div>
 114 </div>
 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">
 119         <tr>
 120           <td class="memname">void SearchBarWidget::searchDelay </td>
 121           <td>(</td>
 122           <td class="paramtype">QString&nbsp;</td>
 123           <td class="paramname"> <em>word</em></td>
 124           <td>&nbsp;)&nbsp;</td>
 125           <td><code> [slot]</code></td>
 126         </tr>
 127       </table>
 128 </div>
 129 <div class="memdoc">
 130
 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>
 133
 134 </div>
 135 </div>
 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">
 140         <tr>
 141           <td class="memname">void SearchBarWidget::searchForTranslations </td>
 142           <td>(</td>
 143           <td class="paramtype">QString&nbsp;</td>
 144           <td class="paramname"> <em>_t1</em></td>
 145           <td>&nbsp;)&nbsp;</td>
 146           <td><code> [signal]</code></td>
 147         </tr>
 148       </table>
 149 </div>
 150 <div class="memdoc">
 151 <p>Requests to search for list of matching words to word passed as parameter </p>
 152
 153 </div>
 154 </div>
 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">
 159         <tr>
 160           <td class="memname">void SearchBarWidget::setBusy </td>
 161           <td>(</td>
 162           <td class="paramname"></td>
 163           <td>&nbsp;)&nbsp;</td>
 164           <td><code> [slot]</code></td>
 165         </tr>
 166       </table>
 167 </div>
 168 <div class="memdoc">
 169
 170 <p>Sets search bar in busy state. </p>
 171 <p>Displays "busy" bar and disables search word text edit and history buttons </p>
 172
 173 </div>
 174 </div>
 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">
 179         <tr>
 180           <td class="memname">void SearchBarWidget::setEnabled </td>
 181           <td>(</td>
 182           <td class="paramtype">bool&nbsp;</td>
 183           <td class="paramname"> <em>enabled</em></td>
 184           <td>&nbsp;)&nbsp;</td>
 185           <td><code> [slot]</code></td>
 186         </tr>
 187       </table>
 188 </div>
 189 <div class="memdoc">
 190
 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>
 193
 194 </div>
 195 </div>
 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">
 200         <tr>
 201           <td class="memname">void SearchBarWidget::setIdle </td>
 202           <td>(</td>
 203           <td class="paramname"></td>
 204           <td>&nbsp;)&nbsp;</td>
 205           <td><code> [slot]</code></td>
 206         </tr>
 207       </table>
 208 </div>
 209 <div class="memdoc">
 210
 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>
 213
 214 </div>
 215 </div>
 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>
 221 </ul>
 222 </div>
 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">&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>
 229
 230 <!-- iframe showing the search results (closed by default) -->
 231 <div id="MSearchResultsWindow">
 232 <iframe src="" frameborder="0"
 233         name="MSearchResults" id="MSearchResults">
 234 </iframe>
 235 </div>
 236
 237 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by&nbsp;
 238 <a href="http://www.doxygen.org/index.html">
 239 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 240 </body>
 241 </html>