diff options
Diffstat (limited to 'docs/libnm/html/NMSettingBluetooth.html')
| -rw-r--r-- | docs/libnm/html/NMSettingBluetooth.html | 244 |
1 files changed, 244 insertions, 0 deletions
diff --git a/docs/libnm/html/NMSettingBluetooth.html b/docs/libnm/html/NMSettingBluetooth.html new file mode 100644 index 00000000..203c3911 --- /dev/null +++ b/docs/libnm/html/NMSettingBluetooth.html @@ -0,0 +1,244 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingBluetooth</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="libnm Reference Manual"> +<link rel="up" href="ch03.html" title="Connection and Setting API Reference"> +<link rel="prev" href="NMSettingAdsl.html" title="NMSettingAdsl"> +<link rel="next" href="NMSettingBond.html" title="NMSettingBond"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="NMSettingAdsl.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libnm Reference Manual</th> +<td><a accesskey="n" href="NMSettingBond.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingBluetooth.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingBluetooth.description" class="shortcut">Description</a> + | + <a href="#NMSettingBluetooth.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingBluetooth.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMSettingBluetooth"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMSettingBluetooth.top_of_page"></a>NMSettingBluetooth</span></h2> +<p>NMSettingBluetooth — Describes Bluetooth connection properties</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMSettingBluetooth.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-SETTING-NAME:CAPS" title="NM_SETTING_BLUETOOTH_SETTING_NAME">NM_SETTING_BLUETOOTH_SETTING_NAME</a> +#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-BDADDR:CAPS" title="NM_SETTING_BLUETOOTH_BDADDR">NM_SETTING_BLUETOOTH_BDADDR</a> +#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE:CAPS" title="NM_SETTING_BLUETOOTH_TYPE">NM_SETTING_BLUETOOTH_TYPE</a> +#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE-DUN:CAPS" title="NM_SETTING_BLUETOOTH_TYPE_DUN">NM_SETTING_BLUETOOTH_TYPE_DUN</a> +#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE-PANU:CAPS" title="NM_SETTING_BLUETOOTH_TYPE_PANU">NM_SETTING_BLUETOOTH_TYPE_PANU</a> +struct <a class="link" href="NMSettingBluetooth.html#NMSettingBluetooth-struct" title="struct NMSettingBluetooth">NMSettingBluetooth</a>; + <a class="link" href="NMSettingBluetooth.html#NMSettingBluetoothClass" title="NMSettingBluetoothClass">NMSettingBluetoothClass</a>; +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingBluetooth.html#nm-setting-bluetooth-new" title="nm_setting_bluetooth_new ()">nm_setting_bluetooth_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingBluetooth.html#nm-setting-bluetooth-get-bdaddr" title="nm_setting_bluetooth_get_bdaddr ()">nm_setting_bluetooth_get_bdaddr</a> (<em class="parameter"><code><a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingBluetooth.html#nm-setting-bluetooth-get-connection-type" title="nm_setting_bluetooth_get_connection_type ()">nm_setting_bluetooth_get_connection_type</a> + (<em class="parameter"><code><a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> *setting</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingBluetooth.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----<a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> + +----NMSettingBluetooth +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingBluetooth.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMSettingBluetooth.html#NMSettingBluetooth--bdaddr" title='The "bdaddr" property'>bdaddr</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="NMSettingBluetooth.html#NMSettingBluetooth--type" title='The "type" property'>type</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingBluetooth.description"></a><h2>Description</h2> +<p> +The <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes +properties necessary for connection to devices that provide network +connections via the Bluetooth Dial-Up Networking (DUN) and Network Access +Point (NAP) profiles. +</p> +</div> +<div class="refsect1"> +<a name="NMSettingBluetooth.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NM-SETTING-BLUETOOTH-SETTING-NAME:CAPS"></a><h3>NM_SETTING_BLUETOOTH_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_BLUETOOTH_SETTING_NAME "bluetooth" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-BLUETOOTH-BDADDR:CAPS"></a><h3>NM_SETTING_BLUETOOTH_BDADDR</h3> +<pre class="programlisting">#define NM_SETTING_BLUETOOTH_BDADDR "bdaddr" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-BLUETOOTH-TYPE:CAPS"></a><h3>NM_SETTING_BLUETOOTH_TYPE</h3> +<pre class="programlisting">#define NM_SETTING_BLUETOOTH_TYPE "type" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-BLUETOOTH-TYPE-DUN:CAPS"></a><h3>NM_SETTING_BLUETOOTH_TYPE_DUN</h3> +<pre class="programlisting">#define NM_SETTING_BLUETOOTH_TYPE_DUN "dun" +</pre> +<p> +Connection type describing a connection to devices that support the Bluetooth +DUN profile. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-BLUETOOTH-TYPE-PANU:CAPS"></a><h3>NM_SETTING_BLUETOOTH_TYPE_PANU</h3> +<pre class="programlisting">#define NM_SETTING_BLUETOOTH_TYPE_PANU "panu" +</pre> +<p> +Connection type describing a connection to devices that support the Bluetooth +NAP (Network Access Point) protocol, which accepts connections via PANU. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingBluetooth-struct"></a><h3>struct NMSettingBluetooth</h3> +<pre class="programlisting">struct NMSettingBluetooth;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingBluetoothClass"></a><h3>NMSettingBluetoothClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; +} NMSettingBluetoothClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bluetooth-new"></a><h3>nm_setting_bluetooth_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_bluetooth_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> object with default values. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the new empty <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bluetooth-get-bdaddr"></a><h3>nm_setting_bluetooth_get_bdaddr ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_bluetooth_get_bdaddr (<em class="parameter"><code><a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> *setting</code></em>);</pre> +<p> +Gets the Bluetooth address of the remote device which this setting +describes a connection to. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the Bluetooth address</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bluetooth-get-connection-type"></a><h3>nm_setting_bluetooth_get_connection_type ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_bluetooth_get_connection_type + (<em class="parameter"><code><a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> *setting</code></em>);</pre> +<p> +Returns the connection method for communicating with the remote device (i.e. +either DUN to a DUN-capable device or PANU to a NAP-capable device). +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the type, either <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE-PANU:CAPS" title="NM_SETTING_BLUETOOTH_TYPE_PANU"><code class="literal">NM_SETTING_BLUETOOTH_TYPE_PANU</code></a> or +<a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE-DUN:CAPS" title="NM_SETTING_BLUETOOTH_TYPE_DUN"><code class="literal">NM_SETTING_BLUETOOTH_TYPE_DUN</code></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="NMSettingBluetooth.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMSettingBluetooth--bdaddr"></a><h3>The <code class="literal">"bdaddr"</code> property</h3> +<pre class="programlisting"> "bdaddr" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +The Bluetooth address of the device. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingBluetooth--type"></a><h3>The <code class="literal">"type"</code> property</h3> +<pre class="programlisting"> "type" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +Either "dun" for Dial-Up Networking connections or "panu" for Personal +Area Networking connections to devices supporting the NAP profile. +</p> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html> \ No newline at end of file |