class_q_bt_single_device_selector_u_i.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>QBluetoothZero: QBtSingleDeviceSelectorUI Class Reference</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  8. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="resize.js"></script>
  11. <script type="text/javascript" src="navtree.js"></script>
  12. <script type="text/javascript">
  13. $(document).ready(initResizable);
  14. </script>
  15. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  16. <script type="text/javascript" src="search/search.js"></script>
  17. <script type="text/javascript">
  18. $(document).ready(function() { searchBox.OnSelectItem(0); });
  19. </script>
  20. </head>
  21. <body>
  22. <div id="top"><!-- do not remove this div! -->
  23. <div id="titlearea">
  24. <table cellspacing="0" cellpadding="0">
  25. <tbody>
  26. <tr style="height: 56px;">
  27. <td id="projectlogo"><img alt="Logo" src="projecticonBlue.png"/></td>
  28. <td style="padding-left: 0.5em;">
  29. <div id="projectname">QBluetoothZero
  30. &#160;<span id="projectnumber">2.0</span>
  31. </div>
  32. </td>
  33. </tr>
  34. </tbody>
  35. </table>
  36. </div>
  37. <!-- Generated by Doxygen 1.7.5.1 -->
  38. <script type="text/javascript">
  39. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  40. </script>
  41. <div id="navrow1" class="tabs">
  42. <ul class="tablist">
  43. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  44. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  45. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  46. <li><a href="files.html"><span>Files</span></a></li>
  47. <li>
  48. <div id="MSearchBox" class="MSearchBoxInactive">
  49. <span class="left">
  50. <img id="MSearchSelect" src="search/mag_sel.png"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. alt=""/>
  54. <input type="text" id="MSearchField" value="Search" accesskey="S"
  55. onfocus="searchBox.OnSearchFieldFocus(true)"
  56. onblur="searchBox.OnSearchFieldFocus(false)"
  57. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  58. </span><span class="right">
  59. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  60. </span>
  61. </div>
  62. </li>
  63. </ul>
  64. </div>
  65. <div id="navrow2" class="tabs2">
  66. <ul class="tablist">
  67. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  68. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  69. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  70. </ul>
  71. </div>
  72. </div>
  73. <div id="side-nav" class="ui-resizable side-nav-resizable">
  74. <div id="nav-tree">
  75. <div id="nav-tree-contents">
  76. </div>
  77. </div>
  78. <div id="splitbar" style="-moz-user-select:none;"
  79. class="ui-resizable-handle">
  80. </div>
  81. </div>
  82. <script type="text/javascript">
  83. initNavTree('class_q_bt_single_device_selector_u_i.html','');
  84. </script>
  85. <div id="doc-content">
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#pub-slots">Public Slots</a> &#124;
  89. <a href="#signals">Signals</a> &#124;
  90. <a href="#pub-methods">Public Member Functions</a> &#124;
  91. <a href="#friends">Friends</a> </div>
  92. <div class="headertitle">
  93. <div class="title">QBtSingleDeviceSelectorUI Class Reference</div> </div>
  94. </div>
  95. <div class="contents">
  96. <!-- doxytag: class="QBtSingleDeviceSelectorUI" -->
  97. <p><code>#include &lt;<a class="el" href="_q_bt_single_device_selector_u_i_8h_source.html">QBtSingleDeviceSelectorUI.h</a>&gt;</code></p>
  98. <p><a href="class_q_bt_single_device_selector_u_i-members.html">List of all members.</a></p>
  99. <table class="memberdecls">
  100. <tr><td colspan="2"><h2><a name="pub-slots"></a>
  101. Public Slots</h2></td></tr>
  102. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_single_device_selector_u_i.html#a7c466f5e5b44161ccf30027a5bd4a0c7">show</a> ()</td></tr>
  103. <tr><td colspan="2"><h2><a name="signals"></a>
  104. Signals</h2></td></tr>
  105. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_single_device_selector_u_i.html#a5bf354bf9c82920abf69bc8f69b72104">discoveryCompleted</a> (const <a class="el" href="class_q_bt_device.html">QBtDevice</a> &amp;selectedDevice)</td></tr>
  106. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_single_device_selector_u_i.html#ae9cb7b92731cc571b1ad4330695cf4e4">discoveryStarted</a> ()</td></tr>
  107. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_single_device_selector_u_i.html#a31a172c67ee5d45f8def53ae0d13ba31">userCanceled</a> ()</td></tr>
  108. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  109. Public Member Functions</h2></td></tr>
  110. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_single_device_selector_u_i.html#ab6f354c44ecb47df42d6f9910ecbf1ce">QBtSingleDeviceSelectorUI</a> (QWidget *parent=0)</td></tr>
  111. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_single_device_selector_u_i.html#a24f0fd51c31519d142043270e1f597b3">~QBtSingleDeviceSelectorUI</a> ()</td></tr>
  112. <tr><td colspan="2"><h2><a name="friends"></a>
  113. Friends</h2></td></tr>
  114. <tr><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_single_device_selector_u_i.html#a42600067fb7c352bdaa0b58aa1885795">QBtSingleDeviceSelectorUIPrivate</a></td></tr>
  115. </table>
  116. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  117. <div class="textblock"><p>This class provides UI for searching remote bluetooth devices, displaying them and selecting one device.</p>
  118. <p>When a device is selected, the UI is closed and the device instance is returned through <a class="el" href="class_q_bt_single_device_selector_u_i.html#a5bf354bf9c82920abf69bc8f69b72104">discoveryCompleted()</a> signal. (NOTE: when closed it is not destroyed, just hiden)</p>
  119. <p>To use, create an instance of the class and call <a class="el" href="class_q_bt_single_device_selector_u_i.html#a7c466f5e5b44161ccf30027a5bd4a0c7">show()</a>. When shown, discovery starts as well.</p>
  120. <p>To get the selected remote device, the <a class="el" href="class_q_bt_single_device_selector_u_i.html#a5bf354bf9c82920abf69bc8f69b72104">discoveryCompleted()</a> signal must be handled. </p>
  121. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  122. <a class="anchor" id="ab6f354c44ecb47df42d6f9910ecbf1ce"></a><!-- doxytag: member="QBtSingleDeviceSelectorUI::QBtSingleDeviceSelectorUI" ref="ab6f354c44ecb47df42d6f9910ecbf1ce" args="(QWidget *parent=0)" -->
  123. <div class="memitem">
  124. <div class="memproto">
  125. <table class="memname">
  126. <tr>
  127. <td class="memname">QBtSingleDeviceSelectorUI::QBtSingleDeviceSelectorUI </td>
  128. <td>(</td>
  129. <td class="paramtype">QWidget *&#160;</td>
  130. <td class="paramname"><em>parent</em> = <code>0</code></td><td>)</td>
  131. <td></td>
  132. </tr>
  133. </table>
  134. </div>
  135. <div class="memdoc">
  136. <p>If parent == 0, the list will be showed as an independent widget on the screen, thus it's not necessary for the client application to have a GUI interface.</p>
  137. <p>For Symbian, it uses the native bluetooth search dialog. In this case, the "parent" parameter has no effect. </p>
  138. </div>
  139. </div>
  140. <a class="anchor" id="a24f0fd51c31519d142043270e1f597b3"></a><!-- doxytag: member="QBtSingleDeviceSelectorUI::~QBtSingleDeviceSelectorUI" ref="a24f0fd51c31519d142043270e1f597b3" args="()" -->
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">QBtSingleDeviceSelectorUI::~QBtSingleDeviceSelectorUI </td>
  146. <td>(</td>
  147. <td class="paramname"></td><td>)</td>
  148. <td></td>
  149. </tr>
  150. </table>
  151. </div>
  152. <div class="memdoc">
  153. <p>Destructor. </p>
  154. </div>
  155. </div>
  156. <hr/><h2>Member Function Documentation</h2>
  157. <a class="anchor" id="a5bf354bf9c82920abf69bc8f69b72104"></a><!-- doxytag: member="QBtSingleDeviceSelectorUI::discoveryCompleted" ref="a5bf354bf9c82920abf69bc8f69b72104" args="(const QBtDevice &amp;selectedDevice)" -->
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">void QBtSingleDeviceSelectorUI::discoveryCompleted </td>
  163. <td>(</td>
  164. <td class="paramtype">const <a class="el" href="class_q_bt_device.html">QBtDevice</a> &amp;&#160;</td>
  165. <td class="paramname"><em>selectedDevice</em></td><td>)</td>
  166. <td><code> [signal]</code></td>
  167. </tr>
  168. </table>
  169. </div>
  170. <div class="memdoc">
  171. <p>Emitted after device discovery stops and user selects the desired device. </p>
  172. </div>
  173. </div>
  174. <a class="anchor" id="ae9cb7b92731cc571b1ad4330695cf4e4"></a><!-- doxytag: member="QBtSingleDeviceSelectorUI::discoveryStarted" ref="ae9cb7b92731cc571b1ad4330695cf4e4" args="()" -->
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">void QBtSingleDeviceSelectorUI::discoveryStarted </td>
  180. <td>(</td>
  181. <td class="paramname"></td><td>)</td>
  182. <td><code> [signal]</code></td>
  183. </tr>
  184. </table>
  185. </div>
  186. <div class="memdoc">
  187. <p>Emitted after calling <a class="el" href="class_q_bt_single_device_selector_u_i.html#a7c466f5e5b44161ccf30027a5bd4a0c7">show()</a> if and only if the device discovery starts successfully </p>
  188. </div>
  189. </div>
  190. <a class="anchor" id="a7c466f5e5b44161ccf30027a5bd4a0c7"></a><!-- doxytag: member="QBtSingleDeviceSelectorUI::show" ref="a7c466f5e5b44161ccf30027a5bd4a0c7" args="()" -->
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="memname">
  194. <tr>
  195. <td class="memname">void QBtSingleDeviceSelectorUI::show </td>
  196. <td>(</td>
  197. <td class="paramname"></td><td>)</td>
  198. <td><code> [slot]</code></td>
  199. </tr>
  200. </table>
  201. </div>
  202. <div class="memdoc">
  203. <p>On show, the device discovery starts. </p>
  204. </div>
  205. </div>
  206. <a class="anchor" id="a31a172c67ee5d45f8def53ae0d13ba31"></a><!-- doxytag: member="QBtSingleDeviceSelectorUI::userCanceled" ref="a31a172c67ee5d45f8def53ae0d13ba31" args="()" -->
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">void QBtSingleDeviceSelectorUI::userCanceled </td>
  212. <td>(</td>
  213. <td class="paramname"></td><td>)</td>
  214. <td><code> [signal]</code></td>
  215. </tr>
  216. </table>
  217. </div>
  218. <div class="memdoc">
  219. <p>Emitted when the user closes the UI without choosing any device. </p>
  220. </div>
  221. </div>
  222. <hr/><h2>Friends And Related Function Documentation</h2>
  223. <a class="anchor" id="a42600067fb7c352bdaa0b58aa1885795"></a><!-- doxytag: member="QBtSingleDeviceSelectorUI::QBtSingleDeviceSelectorUIPrivate" ref="a42600067fb7c352bdaa0b58aa1885795" args="" -->
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">friend class QBtSingleDeviceSelectorUIPrivate<code> [friend]</code></td>
  229. </tr>
  230. </table>
  231. </div>
  232. <div class="memdoc">
  233. </div>
  234. </div>
  235. <hr/>The documentation for this class was generated from the following file:<ul>
  236. <li><a class="el" href="_q_bt_single_device_selector_u_i_8h_source.html">QBtSingleDeviceSelectorUI.h</a></li>
  237. </ul>
  238. </div>
  239. </div>
  240. <div id="nav-path" class="navpath">
  241. <ul>
  242. <li class="navelem"><a class="el" href="class_q_bt_single_device_selector_u_i.html">QBtSingleDeviceSelectorUI</a> </li>
  243. <!-- window showing the filter options -->
  244. <div id="MSearchSelectWindow"
  245. onmouseover="return searchBox.OnSearchSelectShow()"
  246. onmouseout="return searchBox.OnSearchSelectHide()"
  247. onkeydown="return searchBox.OnSearchSelectKey(event)">
  248. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Defines</a></div>
  249. <!-- iframe showing the search results (closed by default) -->
  250. <div id="MSearchResultsWindow">
  251. <iframe src="javascript:void(0)" frameborder="0"
  252. name="MSearchResults" id="MSearchResults">
  253. </iframe>
  254. </div>
  255. <li class="footer">Generated on Wed Jan 4 2012 21:05:39 for QBluetoothZero by
  256. <a href="http://www.doxygen.org/index.html">
  257. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
  258. </ul>
  259. </div>
  260. </body>
  261. </html>