Added doxygen config file and first documentation
[mdictionary] / 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="functions.html"><span>Class&nbsp;Members</span></a></li>
42     </ul>
43   </div>
44 </div>
45 <div class="contents">
46 <h1>SearchBarWidget Class Reference</h1><!-- doxytag: class="SearchBarWidget" -->
47 <p>Displays search bar.  
48 <a href="#_details">More...</a></p>
49
50 <p><code>#include &lt;<a class="el" href="SearchBarWidget_8h_source.html">SearchBarWidget.h</a>&gt;</code></p>
51
52 <p><a href="classSearchBarWidget-members.html">List of all members.</a></p>
53 <table border="0" cellpadding="0" cellspacing="0">
54 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
55 <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>
56 <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>
57 <tr><td colspan="2"><h2>Signals</h2></td></tr>
58 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72e7ffc17c918cc8839f892d0161521b"></a><!-- doxytag: member="SearchBarWidget::searchForTranslations" ref="a72e7ffc17c918cc8839f892d0161521b" args="(QString)" -->
59 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a72e7ffc17c918cc8839f892d0161521b">searchForTranslations</a> (QString)</td></tr>
60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Requests to search for translation of word passed as parameter. <br/></td></tr>
61 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a126dc7f997386fce833d879f643a077b"></a><!-- doxytag: member="SearchBarWidget::stopSearching" ref="a126dc7f997386fce833d879f643a077b" args="()" -->
62 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a126dc7f997386fce833d879f643a077b">stopSearching</a> ()</td></tr>
63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request to stop all active searchings. <br/></td></tr>
64 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
65 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a797e54c56b9a819fe97dcd9875d513c6"></a><!-- doxytag: member="SearchBarWidget::SearchBarWidget" ref="a797e54c56b9a819fe97dcd9875d513c6" args="(QWidget *parent=0)" -->
66 &nbsp;</td><td class="memItemRight" valign="bottom"><b>SearchBarWidget</b> (QWidget *parent=0)</td></tr>
67 <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchBarWidget.html#a23605776418ae474a358b66f210e7726">isSearching</a> ()</td></tr>
68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns searching status.  <a href="#a23605776418ae474a358b66f210e7726"></a><br/></td></tr>
69 </table>
70 <hr/><a name="_details"></a><h2>Detailed Description</h2>
71 <p>Displays search bar. </p>
72 <p>Contains line edit field to input word which user would to find, and buttons to browse search history. </p>
73 <hr/><h2>Member Function Documentation</h2>
74 <a class="anchor" id="a23605776418ae474a358b66f210e7726"></a><!-- doxytag: member="SearchBarWidget::isSearching" ref="a23605776418ae474a358b66f210e7726" args="()" -->
75 <div class="memitem">
76 <div class="memproto">
77       <table class="memname">
78         <tr>
79           <td class="memname">bool SearchBarWidget::isSearching </td>
80           <td>(</td>
81           <td class="paramname"></td>
82           <td>&nbsp;)&nbsp;</td>
83           <td></td>
84         </tr>
85       </table>
86 </div>
87 <div class="memdoc">
88
89 <p>Returns searching status. </p>
90 <p>If backbone is still searching returns true </p>
91
92 </div>
93 </div>
94 <a class="anchor" id="ae1e2875f18de4bf78addf805a3ae896a"></a><!-- doxytag: member="SearchBarWidget::setEnabled" ref="ae1e2875f18de4bf78addf805a3ae896a" args="(bool)" -->
95 <div class="memitem">
96 <div class="memproto">
97       <table class="memname">
98         <tr>
99           <td class="memname">void SearchBarWidget::setEnabled </td>
100           <td>(</td>
101           <td class="paramtype">bool&nbsp;</td>
102           <td class="paramname"> <em>enabled</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>Enable or disable search word line edit and history buttons. </p>
111 <p>While searching it disables only history button and line edit. Search/Stop button is always enabled </p>
112
113 </div>
114 </div>
115 <hr/>The documentation for this class was generated from the following files:<ul>
116 <li><a class="el" href="SearchBarWidget_8h_source.html">SearchBarWidget.h</a></li>
117 <li>SearchBarWidget.cpp</li>
118 </ul>
119 </div>
120 <!--- window showing the filter options -->
121 <div id="MSearchSelectWindow"
122      onmouseover="return searchBox.OnSearchSelectShow()"
123      onmouseout="return searchBox.OnSearchSelectHide()"
124      onkeydown="return searchBox.OnSearchSelectKey(event)">
125 <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>Functions</a></div>
126
127 <!-- iframe showing the search results (closed by default) -->
128 <div id="MSearchResultsWindow">
129 <iframe src="" frameborder="0" 
130         name="MSearchResults" id="MSearchResults">
131 </iframe>
132 </div>
133
134 <hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Aug 3 12:24:19 2010 for mDictionary by&nbsp;
135 <a href="http://www.doxygen.org/index.html">
136 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
137 </body>
138 </html>