1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>BluetoothClient</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="gnome-bluetooth Reference Manual">
8
<link rel="up" href="ch01.html" title="API Reference">
9
<link rel="prev" href="BluetoothChooser.html" title="BluetoothChooser">
10
<link rel="next" href="BluetoothChooserButton.html" title="BluetoothChooserButton">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="ch01.html" title="API Reference">
14
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
15
<link rel="index" href="api-index-full.html" title="API Index">
17
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
18
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
20
<td><a accesskey="p" href="BluetoothChooser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
21
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
23
<th width="100%" align="center">gnome-bluetooth Reference Manual</th>
24
<td><a accesskey="n" href="BluetoothChooserButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
26
<tr><td colspan="5" class="shortcuts">
27
<a href="#gnome-bluetooth-BluetoothClient.synopsis" class="shortcut">Top</a>
29
<a href="#gnome-bluetooth-BluetoothClient.description" class="shortcut">Description</a>
32
<div class="refentry" title="BluetoothClient">
33
<a name="gnome-bluetooth-BluetoothClient"></a><div class="titlepage"></div>
34
<div class="refnamediv"><table width="100%"><tr>
36
<h2><span class="refentrytitle"><a name="gnome-bluetooth-BluetoothClient.top_of_page"></a>BluetoothClient</span></h2>
37
<p>BluetoothClient</p>
39
<td valign="top" align="right"></td>
41
<div class="refsynopsisdiv" title="Synopsis">
42
<a name="gnome-bluetooth-BluetoothClient.synopsis"></a><h2>Synopsis</h2>
43
<pre class="synopsis">
45
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BLUETOOTH-GET-CLIENT-CLASS--CAPS"
46
>BLUETOOTH_GET_CLIENT_CLASS</a> (obj)
48
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
51
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
52
>BluetoothClient</a> * <a
53
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#bluetooth-client-new"
54
>bluetooth_client_new</a> (void);
56
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
57
>GtkTreeModel</a> * <a
58
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#bluetooth-client-get-model"
59
>bluetooth_client_get_model</a> (<a
60
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
61
>BluetoothClient</a> *client);
63
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
64
>GtkTreeModel</a> * <a
65
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#bluetooth-client-get-filter-model"
66
>bluetooth_client_get_filter_model</a> (<a
67
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
68
>BluetoothClient</a> *client,
70
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#GtkTreeModelFilterVisibleFunc"
71
>GtkTreeModelFilterVisibleFunc</a> func,
73
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
76
href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"
77
>GDestroyNotify</a> destroy);
79
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
80
>GtkTreeModel</a> * <a
81
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#bluetooth-client-get-adapter-model"
82
>bluetooth_client_get_adapter_model</a> (<a
83
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
84
>BluetoothClient</a> *client);
86
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
87
>GtkTreeModel</a> * <a
88
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#bluetooth-client-get-device-model"
89
>bluetooth_client_get_device_model</a> (<a
90
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
91
>BluetoothClient</a> *client,
93
href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGProxy.html#DBusGProxy"
94
>DBusGProxy</a> *adapter);
96
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
97
>GtkTreeModel</a> * <a
98
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#bluetooth-client-get-device-filter-model"
99
>bluetooth_client_get_device_filter_model</a>
101
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
102
>BluetoothClient</a> *client,
104
href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGProxy.html#DBusGProxy"
105
>DBusGProxy</a> *adapter,
107
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#GtkTreeModelFilterVisibleFunc"
108
>GtkTreeModelFilterVisibleFunc</a> func,
110
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
113
href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"
114
>GDestroyNotify</a> destroy);
116
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
118
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#bluetooth-type-to-string"
119
>bluetooth_type_to_string</a> (<a
120
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
123
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
125
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#bluetooth-verify-address"
126
>bluetooth_verify_address</a> (const char *bdaddr);
128
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#bluetooth-uuid-to-string"
129
>bluetooth_uuid_to_string</a> (const char *uuid);
132
<div class="refsect1" title="Description">
133
<a name="gnome-bluetooth-BluetoothClient.description"></a><h2>Description</h2>
137
<div class="refsect1" title="Details">
138
<a name="gnome-bluetooth-BluetoothClient.details"></a><h2>Details</h2>
139
<div class="refsect2" title="BLUETOOTH_GET_CLIENT_CLASS()">
140
<a name="BLUETOOTH-GET-CLIENT-CLASS--CAPS"></a><h3>BLUETOOTH_GET_CLIENT_CLASS()</h3>
141
<pre class="programlisting">#define BLUETOOTH_GET_CLIENT_CLASS(obj)</pre>
144
<div class="variablelist"><table border="0">
145
<col align="left" valign="top">
147
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
154
<div class="refsect2" title="BluetoothClient">
155
<a name="BluetoothClient"></a><h3>BluetoothClient</h3>
156
<pre class="programlisting">typedef struct {
164
<div class="refsect2" title="bluetooth_client_new ()">
165
<a name="bluetooth-client-new"></a><h3>bluetooth_client_new ()</h3>
166
<pre class="programlisting"><a
167
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
168
>BluetoothClient</a> * bluetooth_client_new (void);</pre>
173
<div class="variablelist"><table border="0">
174
<col align="left" valign="top">
176
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
177
<td> a reference to the <a
178
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
179
><span class="type">BluetoothClient</span></a> singleton. Unref the object when done.
185
<div class="refsect2" title="bluetooth_client_get_model ()">
186
<a name="bluetooth-client-get-model"></a><h3>bluetooth_client_get_model ()</h3>
187
<pre class="programlisting"><a
188
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
189
>GtkTreeModel</a> * bluetooth_client_get_model (<a
190
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
191
>BluetoothClient</a> *client);</pre>
196
<div class="variablelist"><table border="0">
197
<col align="left" valign="top">
200
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
202
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
203
><span class="type">BluetoothClient</span></a> object
207
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
208
<td> an unfiltered <a
209
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
210
><span class="type">GtkTreeModel</span></a> representing the adapter and devices available on the system.
217
<div class="refsect2" title="bluetooth_client_get_filter_model ()">
218
<a name="bluetooth-client-get-filter-model"></a><h3>bluetooth_client_get_filter_model ()</h3>
219
<pre class="programlisting"><a
220
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
221
>GtkTreeModel</a> * bluetooth_client_get_filter_model (<a
222
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
223
>BluetoothClient</a> *client,
225
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#GtkTreeModelFilterVisibleFunc"
226
>GtkTreeModelFilterVisibleFunc</a> func,
228
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
231
href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"
232
>GDestroyNotify</a> destroy);</pre>
237
<div class="variablelist"><table border="0">
238
<col align="left" valign="top">
241
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
243
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
244
><span class="type">BluetoothClient</span></a> object
248
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
250
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#GtkTreeModelFilterVisibleFunc"
251
><span class="type">GtkTreeModelFilterVisibleFunc</span></a>
255
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
256
<td> user data to pass to <a
257
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#gtk-tree-model-filter-set-visible-func"
258
><code class="function">gtk_tree_model_filter_set_visible_func()</code></a>
262
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
263
<td> a destroy function for <a
264
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#gtk-tree-model-filter-set-visible-func"
265
><code class="function">gtk_tree_model_filter_set_visible_func()</code></a>
269
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
271
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
272
><span class="type">GtkTreeModel</span></a> of devices filtered using the <em class="parameter"><code>func</code></em>, <em class="parameter"><code>data</code></em> and <em class="parameter"><code>destroy</code></em> arguments to pass to <a
273
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#gtk-tree-model-filter-set-visible-func"
274
><code class="function">gtk_tree_model_filter_set_visible_func()</code></a>.
281
<div class="refsect2" title="bluetooth_client_get_adapter_model ()">
282
<a name="bluetooth-client-get-adapter-model"></a><h3>bluetooth_client_get_adapter_model ()</h3>
283
<pre class="programlisting"><a
284
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
285
>GtkTreeModel</a> * bluetooth_client_get_adapter_model (<a
286
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
287
>BluetoothClient</a> *client);</pre>
292
<div class="variablelist"><table border="0">
293
<col align="left" valign="top">
296
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
298
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
299
><span class="type">BluetoothClient</span></a> object
303
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
305
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
306
><span class="type">GtkTreeModel</span></a> with only adapters present.
313
<div class="refsect2" title="bluetooth_client_get_device_model ()">
314
<a name="bluetooth-client-get-device-model"></a><h3>bluetooth_client_get_device_model ()</h3>
315
<pre class="programlisting"><a
316
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
317
>GtkTreeModel</a> * bluetooth_client_get_device_model (<a
318
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
319
>BluetoothClient</a> *client,
321
href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGProxy.html#DBusGProxy"
322
>DBusGProxy</a> *adapter);</pre>
327
<div class="variablelist"><table border="0">
328
<col align="left" valign="top">
331
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
333
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
334
><span class="type">BluetoothClient</span></a> object
338
<td><p><span class="term"><em class="parameter"><code>adapter</code></em> :</span></p></td>
340
href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGProxy.html#DBusGProxy"
341
><span class="type">DBusGProxy</span></a> of the adapter object, or <a
342
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
343
><code class="literal">NULL</code></a> to get the default adapter.
347
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
349
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
350
><span class="type">GtkTreeModel</span></a> with only devices belonging to the selected adapter listed. Note that the model will follow a specific adapter, and will not follow the default-adapter when <a
351
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
352
><code class="literal">NULL</code></a> is passed.
359
<div class="refsect2" title="bluetooth_client_get_device_filter_model ()">
360
<a name="bluetooth-client-get-device-filter-model"></a><h3>bluetooth_client_get_device_filter_model ()</h3>
361
<pre class="programlisting"><a
362
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
363
>GtkTreeModel</a> * bluetooth_client_get_device_filter_model
365
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
366
>BluetoothClient</a> *client,
368
href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGProxy.html#DBusGProxy"
369
>DBusGProxy</a> *adapter,
371
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#GtkTreeModelFilterVisibleFunc"
372
>GtkTreeModelFilterVisibleFunc</a> func,
374
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
377
href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"
378
>GDestroyNotify</a> destroy);</pre>
383
<div class="variablelist"><table border="0">
384
<col align="left" valign="top">
387
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
389
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-BluetoothClient.html#BluetoothClient"
390
><span class="type">BluetoothClient</span></a> object
394
<td><p><span class="term"><em class="parameter"><code>adapter</code></em> :</span></p></td>
399
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
401
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#GtkTreeModelFilterVisibleFunc"
402
><span class="type">GtkTreeModelFilterVisibleFunc</span></a>
406
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
407
<td> user data to pass to <a
408
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#gtk-tree-model-filter-set-visible-func"
409
><code class="function">gtk_tree_model_filter_set_visible_func()</code></a>
413
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
414
<td> a destroy function for <a
415
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#gtk-tree-model-filter-set-visible-func"
416
><code class="function">gtk_tree_model_filter_set_visible_func()</code></a>
420
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
422
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
423
><span class="type">GtkTreeModel</span></a> of adapters filtered using the <em class="parameter"><code>func</code></em>, <em class="parameter"><code>data</code></em> and <em class="parameter"><code>destroy</code></em> arguments to pass to <a
424
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModelFilter.html#gtk-tree-model-filter-set-visible-func"
425
><code class="function">gtk_tree_model_filter_set_visible_func()</code></a>.
432
<div class="refsect2" title="bluetooth_type_to_string ()">
433
<a name="bluetooth-type-to-string"></a><h3>bluetooth_type_to_string ()</h3>
434
<pre class="programlisting">const <a
435
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
436
>gchar</a> * bluetooth_type_to_string (<a
437
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
438
>guint</a> type);</pre>
443
<div class="variablelist"><table border="0">
444
<col align="left" valign="top">
447
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
449
href="http://library.gnome.org/devel/gnome-bluetooth/unstable/gnome-bluetooth-bluetooth-enums.html#BluetoothType"
450
><span class="type">BluetoothType</span></a>
454
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
455
<td> the string representation of the <em class="parameter"><code>type</code></em> passed. Do not free the return value.
462
<div class="refsect2" title="bluetooth_verify_address ()">
463
<a name="bluetooth-verify-address"></a><h3>bluetooth_verify_address ()</h3>
464
<pre class="programlisting"><a
465
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
466
>gboolean</a> bluetooth_verify_address (const char *bdaddr);</pre>
471
<div class="variablelist"><table border="0">
472
<col align="left" valign="top">
475
<td><p><span class="term"><em class="parameter"><code>bdaddr</code></em> :</span></p></td>
476
<td> a string representing a Bluetooth address
480
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
481
<td> Whether the string is a valid Bluetooth address. This does not contact the device in any way.
488
<div class="refsect2" title="bluetooth_uuid_to_string ()">
489
<a name="bluetooth-uuid-to-string"></a><h3>bluetooth_uuid_to_string ()</h3>
490
<pre class="programlisting">const char * bluetooth_uuid_to_string (const char *uuid);</pre>
495
<div class="variablelist"><table border="0">
496
<col align="left" valign="top">
499
<td><p><span class="term"><em class="parameter"><code>uuid</code></em> :</span></p></td>
500
<td> a string representing a Bluetooth UUID
504
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
505
<td> a string representing a human-readable (but not usable for display to users) version of the <em class="parameter"><code>uuid</code></em>. Do not free the return value.
515
Generated by GTK-Doc V1.11</div>