← Back to branch summary

~timchen119/ubuntu/trusty/gnome-bluetooth/lp1035431

« back to all changes in this revision

Viewing changes to docs/reference/libgnome-bluetooth/xml/bluetooth-client.xml

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2011-02-27 15:45:22 UTC
  • mfrom: (1.3.2 upstream)
  • mto: (2.2.3 experimental) (1.5.1)
  • mto: This revision was merged to the branch mainline in revision 53.
  • Revision ID: james.westby@ubuntu.com-20110227154522-dnnoqasv5v3mv42a
Tags: upstream-2.91.5
Import upstream version 2.91.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libgnome-bluetooth/xml/bluetooth-client.xml
1
 
<refentry id="gnome-bluetooth-BluetoothClient">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="gnome-bluetooth-BluetoothClient.top_of_page">BluetoothClient</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>GNOME-BLUETOOTH Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>BluetoothClient</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="gnome-bluetooth-BluetoothClient.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
#define             <link linkend="BLUETOOTH-GET-CLIENT-CLASS--CAPS">BLUETOOTH_GET_CLIENT_CLASS</link>          (obj)
18
 
                    <link linkend="BluetoothClient">BluetoothClient</link>;
19
 
<link linkend="BluetoothClient">BluetoothClient</link> *   <link linkend="bluetooth-client-new">bluetooth_client_new</link>                (void);
20
 
<link linkend="GtkTreeModel">GtkTreeModel</link> *      <link linkend="bluetooth-client-get-model">bluetooth_client_get_model</link>          (<link linkend="BluetoothClient">BluetoothClient</link> *client);
21
 
<link linkend="GtkTreeModel">GtkTreeModel</link> *      <link linkend="bluetooth-client-get-filter-model">bluetooth_client_get_filter_model</link>   (<link linkend="BluetoothClient">BluetoothClient</link> *client,
22
 
                                                         <link linkend="GtkTreeModelFilterVisibleFunc">GtkTreeModelFilterVisibleFunc</link> func,
23
 
                                                         <link linkend="gpointer">gpointer</link> data,
24
 
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy);
25
 
<link linkend="GtkTreeModel">GtkTreeModel</link> *      <link linkend="bluetooth-client-get-adapter-model">bluetooth_client_get_adapter_model</link>  (<link linkend="BluetoothClient">BluetoothClient</link> *client);
26
 
<link linkend="GtkTreeModel">GtkTreeModel</link> *      <link linkend="bluetooth-client-get-device-model">bluetooth_client_get_device_model</link>   (<link linkend="BluetoothClient">BluetoothClient</link> *client,
27
 
                                                         <link linkend="DBusGProxy">DBusGProxy</link> *adapter);
28
 
<link linkend="GtkTreeModel">GtkTreeModel</link> *      <link linkend="bluetooth-client-get-device-filter-model">bluetooth_client_get_device_filter_model</link>
29
 
                                                        (<link linkend="BluetoothClient">BluetoothClient</link> *client,
30
 
                                                         <link linkend="DBusGProxy">DBusGProxy</link> *adapter,
31
 
                                                         <link linkend="GtkTreeModelFilterVisibleFunc">GtkTreeModelFilterVisibleFunc</link> func,
32
 
                                                         <link linkend="gpointer">gpointer</link> data,
33
 
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy);
34
 
const <link linkend="gchar">gchar</link> *       <link linkend="bluetooth-type-to-string">bluetooth_type_to_string</link>            (<link linkend="guint">guint</link> type);
35
 
<link linkend="gboolean">gboolean</link>            <link linkend="bluetooth-verify-address">bluetooth_verify_address</link>            (const <link linkend="char">char</link> *bdaddr);
36
 
const <link linkend="char">char</link> *        <link linkend="bluetooth-uuid-to-string">bluetooth_uuid_to_string</link>            (const <link linkend="char">char</link> *uuid);
37
 
</synopsis>
38
 
</refsynopsisdiv>
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
<refsect1 id="gnome-bluetooth-BluetoothClient.description" role="desc">
49
 
<title role="desc.title">Description</title>
50
 
<para>
51
 
</para>
52
 
</refsect1>
53
 
 
54
 
<refsect1 id="gnome-bluetooth-BluetoothClient.details" role="details">
55
 
<title role="details.title">Details</title>
56
 
<refsect2 id="BLUETOOTH-GET-CLIENT-CLASS--CAPS" role="macro">
57
 
<title>BLUETOOTH_GET_CLIENT_CLASS()</title>
58
 
<indexterm zone="BLUETOOTH-GET-CLIENT-CLASS--CAPS"><primary sortas="BLUETOOTH_GET_CLIENT_CLASS">BLUETOOTH_GET_CLIENT_CLASS</primary></indexterm><programlisting>#define             BLUETOOTH_GET_CLIENT_CLASS(obj)</programlisting>
59
 
<para>
60
 
</para><variablelist role="params">
61
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
62
 
<listitem><simpara>
63
 
</simpara></listitem></varlistentry>
64
 
</variablelist></refsect2>
65
 
<refsect2 id="BluetoothClient" role="struct">
66
 
<title>BluetoothClient</title>
67
 
<indexterm zone="BluetoothClient"><primary sortas="BluetoothClient">BluetoothClient</primary></indexterm><programlisting>typedef struct {
68
 
        GObject parent;
69
 
} BluetoothClient;
70
 
</programlisting>
71
 
<para>
72
 
</para></refsect2>
73
 
<refsect2 id="bluetooth-client-new" role="function">
74
 
<title>bluetooth_client_new ()</title>
75
 
<indexterm zone="bluetooth-client-new"><primary sortas="bluetooth_client_new">bluetooth_client_new</primary></indexterm><programlisting><link linkend="BluetoothClient">BluetoothClient</link> *   bluetooth_client_new                (void);</programlisting>
76
 
<para>
77
 
</para>
78
 
<para>
79
 
</para><variablelist role="params">
80
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a reference to the <link linkend="BluetoothClient"><type>BluetoothClient</type></link> singleton. Unref the object when done.
81
 
</simpara></listitem></varlistentry>
82
 
</variablelist></refsect2>
83
 
<refsect2 id="bluetooth-client-get-model" role="function">
84
 
<title>bluetooth_client_get_model ()</title>
85
 
<indexterm zone="bluetooth-client-get-model"><primary sortas="bluetooth_client_get_model">bluetooth_client_get_model</primary></indexterm><programlisting><link linkend="GtkTreeModel">GtkTreeModel</link> *      bluetooth_client_get_model          (<link linkend="BluetoothClient">BluetoothClient</link> *client);</programlisting>
86
 
<para>
87
 
</para>
88
 
<para>
89
 
</para><variablelist role="params">
90
 
<varlistentry><term><parameter>client</parameter>&#160;:</term>
91
 
<listitem><simpara> a <link linkend="BluetoothClient"><type>BluetoothClient</type></link> object
92
 
</simpara></listitem></varlistentry>
93
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an unfiltered <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link> representing the adapter and devices available on the system.
94
 
</simpara></listitem></varlistentry>
95
 
</variablelist></refsect2>
96
 
<refsect2 id="bluetooth-client-get-filter-model" role="function">
97
 
<title>bluetooth_client_get_filter_model ()</title>
98
 
<indexterm zone="bluetooth-client-get-filter-model"><primary sortas="bluetooth_client_get_filter_model">bluetooth_client_get_filter_model</primary></indexterm><programlisting><link linkend="GtkTreeModel">GtkTreeModel</link> *      bluetooth_client_get_filter_model   (<link linkend="BluetoothClient">BluetoothClient</link> *client,
99
 
                                                         <link linkend="GtkTreeModelFilterVisibleFunc">GtkTreeModelFilterVisibleFunc</link> func,
100
 
                                                         <link linkend="gpointer">gpointer</link> data,
101
 
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy);</programlisting>
102
 
<para>
103
 
</para>
104
 
<para>
105
 
</para><variablelist role="params">
106
 
<varlistentry><term><parameter>client</parameter>&#160;:</term>
107
 
<listitem><simpara> a <link linkend="BluetoothClient"><type>BluetoothClient</type></link> object
108
 
</simpara></listitem></varlistentry>
109
 
<varlistentry><term><parameter>func</parameter>&#160;:</term>
110
 
<listitem><simpara> a <link linkend="GtkTreeModelFilterVisibleFunc"><type>GtkTreeModelFilterVisibleFunc</type></link>
111
 
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
113
 
<listitem><simpara> user data to pass to <link linkend="gtk-tree-model-filter-set-visible-func"><function>gtk_tree_model_filter_set_visible_func()</function></link>
114
 
</simpara></listitem></varlistentry>
115
 
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
116
 
<listitem><simpara> a destroy function for <link linkend="gtk-tree-model-filter-set-visible-func"><function>gtk_tree_model_filter_set_visible_func()</function></link>
117
 
</simpara></listitem></varlistentry>
118
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link> of devices filtered using the <parameter>func</parameter>, <parameter>data</parameter> and <parameter>destroy</parameter> arguments to pass to <link linkend="gtk-tree-model-filter-set-visible-func"><function>gtk_tree_model_filter_set_visible_func()</function></link>.
119
 
</simpara></listitem></varlistentry>
120
 
</variablelist></refsect2>
121
 
<refsect2 id="bluetooth-client-get-adapter-model" role="function">
122
 
<title>bluetooth_client_get_adapter_model ()</title>
123
 
<indexterm zone="bluetooth-client-get-adapter-model"><primary sortas="bluetooth_client_get_adapter_model">bluetooth_client_get_adapter_model</primary></indexterm><programlisting><link linkend="GtkTreeModel">GtkTreeModel</link> *      bluetooth_client_get_adapter_model  (<link linkend="BluetoothClient">BluetoothClient</link> *client);</programlisting>
124
 
<para>
125
 
</para>
126
 
<para>
127
 
</para><variablelist role="params">
128
 
<varlistentry><term><parameter>client</parameter>&#160;:</term>
129
 
<listitem><simpara> a <link linkend="BluetoothClient"><type>BluetoothClient</type></link> object
130
 
</simpara></listitem></varlistentry>
131
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a filtered <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link> with only adapters present.
132
 
</simpara></listitem></varlistentry>
133
 
</variablelist></refsect2>
134
 
<refsect2 id="bluetooth-client-get-device-model" role="function">
135
 
<title>bluetooth_client_get_device_model ()</title>
136
 
<indexterm zone="bluetooth-client-get-device-model"><primary sortas="bluetooth_client_get_device_model">bluetooth_client_get_device_model</primary></indexterm><programlisting><link linkend="GtkTreeModel">GtkTreeModel</link> *      bluetooth_client_get_device_model   (<link linkend="BluetoothClient">BluetoothClient</link> *client,
137
 
                                                         <link linkend="DBusGProxy">DBusGProxy</link> *adapter);</programlisting>
138
 
<para>
139
 
</para>
140
 
<para>
141
 
</para><variablelist role="params">
142
 
<varlistentry><term><parameter>client</parameter>&#160;:</term>
143
 
<listitem><simpara> a <link linkend="BluetoothClient"><type>BluetoothClient</type></link> object
144
 
</simpara></listitem></varlistentry>
145
 
<varlistentry><term><parameter>adapter</parameter>&#160;:</term>
146
 
<listitem><simpara> a <link linkend="DBusGProxy"><type>DBusGProxy</type></link> of the adapter object, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to get the default adapter.
147
 
</simpara></listitem></varlistentry>
148
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a filtered <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link> 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 <link linkend="NULL--CAPS"><literal>NULL</literal></link> is passed.
149
 
</simpara></listitem></varlistentry>
150
 
</variablelist></refsect2>
151
 
<refsect2 id="bluetooth-client-get-device-filter-model" role="function">
152
 
<title>bluetooth_client_get_device_filter_model ()</title>
153
 
<indexterm zone="bluetooth-client-get-device-filter-model"><primary sortas="bluetooth_client_get_device_filter_model">bluetooth_client_get_device_filter_model</primary></indexterm><programlisting><link linkend="GtkTreeModel">GtkTreeModel</link> *      bluetooth_client_get_device_filter_model
154
 
                                                        (<link linkend="BluetoothClient">BluetoothClient</link> *client,
155
 
                                                         <link linkend="DBusGProxy">DBusGProxy</link> *adapter,
156
 
                                                         <link linkend="GtkTreeModelFilterVisibleFunc">GtkTreeModelFilterVisibleFunc</link> func,
157
 
                                                         <link linkend="gpointer">gpointer</link> data,
158
 
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy);</programlisting>
159
 
<para>
160
 
</para>
161
 
<para>
162
 
</para><variablelist role="params">
163
 
<varlistentry><term><parameter>client</parameter>&#160;:</term>
164
 
<listitem><simpara> a <link linkend="BluetoothClient"><type>BluetoothClient</type></link> object
165
 
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><parameter>adapter</parameter>&#160;:</term>
167
 
<listitem><simpara>
168
 
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><parameter>func</parameter>&#160;:</term>
170
 
<listitem><simpara> a <link linkend="GtkTreeModelFilterVisibleFunc"><type>GtkTreeModelFilterVisibleFunc</type></link>
171
 
</simpara></listitem></varlistentry>
172
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
173
 
<listitem><simpara> user data to pass to <link linkend="gtk-tree-model-filter-set-visible-func"><function>gtk_tree_model_filter_set_visible_func()</function></link>
174
 
</simpara></listitem></varlistentry>
175
 
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
176
 
<listitem><simpara> a destroy function for <link linkend="gtk-tree-model-filter-set-visible-func"><function>gtk_tree_model_filter_set_visible_func()</function></link>
177
 
</simpara></listitem></varlistentry>
178
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link> of adapters filtered using the <parameter>func</parameter>, <parameter>data</parameter> and <parameter>destroy</parameter> arguments to pass to <link linkend="gtk-tree-model-filter-set-visible-func"><function>gtk_tree_model_filter_set_visible_func()</function></link>.
179
 
</simpara></listitem></varlistentry>
180
 
</variablelist></refsect2>
181
 
<refsect2 id="bluetooth-type-to-string" role="function">
182
 
<title>bluetooth_type_to_string ()</title>
183
 
<indexterm zone="bluetooth-type-to-string"><primary sortas="bluetooth_type_to_string">bluetooth_type_to_string</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       bluetooth_type_to_string            (<link linkend="guint">guint</link> type);</programlisting>
184
 
<para>
185
 
</para>
186
 
<para>
187
 
</para><variablelist role="params">
188
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
189
 
<listitem><simpara> a <link linkend="BluetoothType"><type>BluetoothType</type></link>
190
 
</simpara></listitem></varlistentry>
191
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the string representation of the <parameter>type</parameter> passed. Do not free the return value.
192
 
</simpara></listitem></varlistentry>
193
 
</variablelist></refsect2>
194
 
<refsect2 id="bluetooth-verify-address" role="function">
195
 
<title>bluetooth_verify_address ()</title>
196
 
<indexterm zone="bluetooth-verify-address"><primary sortas="bluetooth_verify_address">bluetooth_verify_address</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bluetooth_verify_address            (const <link linkend="char">char</link> *bdaddr);</programlisting>
197
 
<para>
198
 
</para>
199
 
<para>
200
 
</para><variablelist role="params">
201
 
<varlistentry><term><parameter>bdaddr</parameter>&#160;:</term>
202
 
<listitem><simpara> a string representing a Bluetooth address
203
 
</simpara></listitem></varlistentry>
204
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Whether the string is a valid Bluetooth address. This does not contact the device in any way.
205
 
</simpara></listitem></varlistentry>
206
 
</variablelist></refsect2>
207
 
<refsect2 id="bluetooth-uuid-to-string" role="function">
208
 
<title>bluetooth_uuid_to_string ()</title>
209
 
<indexterm zone="bluetooth-uuid-to-string"><primary sortas="bluetooth_uuid_to_string">bluetooth_uuid_to_string</primary></indexterm><programlisting>const <link linkend="char">char</link> *        bluetooth_uuid_to_string            (const <link linkend="char">char</link> *uuid);</programlisting>
210
 
<para>
211
 
</para>
212
 
<para>
213
 
</para><variablelist role="params">
214
 
<varlistentry><term><parameter>uuid</parameter>&#160;:</term>
215
 
<listitem><simpara> a string representing a Bluetooth UUID
216
 
</simpara></listitem></varlistentry>
217
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a string representing a human-readable (but not usable for display to users) version of the <parameter>uuid</parameter>. Do not free the return value.
218
 
</simpara></listitem></varlistentry>
219
 
</variablelist></refsect2>
220
 
 
221
 
</refsect1>
222
 
 
223
 
 
224
 
 
225
 
 
226
 
</refentry>