diff options
Diffstat (limited to 'docs/libnm/html/NMDeviceModem.html')
| -rw-r--r-- | docs/libnm/html/NMDeviceModem.html | 293 |
1 files changed, 155 insertions, 138 deletions
diff --git a/docs/libnm/html/NMDeviceModem.html b/docs/libnm/html/NMDeviceModem.html index 12e5d37d..49cd12df 100644 --- a/docs/libnm/html/NMDeviceModem.html +++ b/docs/libnm/html/NMDeviceModem.html @@ -2,36 +2,28 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMDeviceModem</title> +<title>libnm Reference Manual: NMDeviceModem</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="ch04.html" title="Device and Runtime Configuration API Reference"> <link rel="prev" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"> <link rel="next" href="NMDeviceOlpcMesh.html" title="NMDeviceOlpcMesh"> -<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.21 (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="NMDeviceInfiniband.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch04.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="NMDeviceOlpcMesh.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#NMDeviceModem.synopsis" class="shortcut">Top</a> - | - <a href="#NMDeviceModem.description" class="shortcut">Description</a> - | - <a href="#NMDeviceModem.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMDeviceModem.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#NMDeviceModem.properties" class="shortcut">Properties</a> -</td></tr> -</table> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#NMDeviceModem.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMDeviceModem.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMDeviceModem.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="NMDeviceInfiniband.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="NMDeviceOlpcMesh.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="NMDeviceModem"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -39,40 +31,82 @@ <h2><span class="refentrytitle"><a name="NMDeviceModem.top_of_page"></a>NMDeviceModem</span></h2> <p>NMDeviceModem</p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> -<a name="NMDeviceModem.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis">#define <a class="link" href="NMDeviceModem.html#NM-DEVICE-MODEM-MODEM-CAPABILITIES:CAPS" title="NM_DEVICE_MODEM_MODEM_CAPABILITIES">NM_DEVICE_MODEM_MODEM_CAPABILITIES</a> -#define <a class="link" href="NMDeviceModem.html#NM-DEVICE-MODEM-CURRENT-CAPABILITIES:CAPS" title="NM_DEVICE_MODEM_CURRENT_CAPABILITIES">NM_DEVICE_MODEM_CURRENT_CAPABILITIES</a> -struct <a class="link" href="NMDeviceModem.html#NMDeviceModem-struct" title="struct NMDeviceModem">NMDeviceModem</a>; - <a class="link" href="NMDeviceModem.html#NMDeviceModemClass" title="NMDeviceModemClass">NMDeviceModemClass</a>; -<a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities"><span class="returnvalue">NMDeviceModemCapabilities</span></a> <a class="link" href="NMDeviceModem.html#nm-device-modem-get-modem-capabilities" title="nm_device_modem_get_modem_capabilities ()">nm_device_modem_get_modem_capabilities</a> - (<em class="parameter"><code><a class="link" href="NMDeviceModem.html" title="NMDeviceModem"><span class="type">NMDeviceModem</span></a> *self</code></em>); -<a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities"><span class="returnvalue">NMDeviceModemCapabilities</span></a> <a class="link" href="NMDeviceModem.html#nm-device-modem-get-current-capabilities" title="nm_device_modem_get_current_capabilities ()">nm_device_modem_get_current_capabilities</a> - (<em class="parameter"><code><a class="link" href="NMDeviceModem.html" title="NMDeviceModem"><span class="type">NMDeviceModem</span></a> *self</code></em>); -</pre> +<div class="refsect1"> +<a name="NMDeviceModem.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities" title="enum NMDeviceModemCapabilities"><span class="returnvalue">NMDeviceModemCapabilities</span></a> +</td> +<td class="function_name"> +<a class="link" href="NMDeviceModem.html#nm-device-modem-get-modem-capabilities" title="nm_device_modem_get_modem_capabilities ()">nm_device_modem_get_modem_capabilities</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities" title="enum NMDeviceModemCapabilities"><span class="returnvalue">NMDeviceModemCapabilities</span></a> +</td> +<td class="function_name"> +<a class="link" href="NMDeviceModem.html#nm-device-modem-get-current-capabilities" title="nm_device_modem_get_current_capabilities ()">nm_device_modem_get_current_capabilities</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMDeviceModem.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="NMObject.html" title="NMObject">NMObject</a> - +----<a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> - +----NMDeviceModem -</pre> +<a name="NMDeviceModem.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities" title="enum NMDeviceModemCapabilities"><span class="type">NMDeviceModemCapabilities</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceModem.html#NMDeviceModem--current-capabilities" title="The “current-capabilities” property">current-capabilities</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities" title="enum NMDeviceModemCapabilities"><span class="type">NMDeviceModemCapabilities</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceModem.html#NMDeviceModem--modem-capabilities" title="The “modem-capabilities” property">modem-capabilities</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMDeviceModem.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -NMDeviceModem implements - <a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.</p> +<a name="NMDeviceModem.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMDeviceModem.html#NM-DEVICE-MODEM-MODEM-CAPABILITIES:CAPS" title="NM_DEVICE_MODEM_MODEM_CAPABILITIES">NM_DEVICE_MODEM_MODEM_CAPABILITIES</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMDeviceModem.html#NM-DEVICE-MODEM-CURRENT-CAPABILITIES:CAPS" title="NM_DEVICE_MODEM_CURRENT_CAPABILITIES">NM_DEVICE_MODEM_CURRENT_CAPABILITIES</a></td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMDeviceModem.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMDeviceModem.html#NMDeviceModem--current-capabilities" title='The "current-capabilities" property'>current-capabilities</a>" <a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities"><span class="type">NMDeviceModemCapabilities</span></a> : Read - "<a class="link" href="NMDeviceModem.html#NMDeviceModem--modem-capabilities" title='The "modem-capabilities" property'>modem-capabilities</a>" <a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities"><span class="type">NMDeviceModemCapabilities</span></a> : Read +<a name="NMDeviceModem.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> + <span class="lineart">╰──</span> <a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> + <span class="lineart">╰──</span> NMDeviceModem </pre> </div> <div class="refsect1"> @@ -81,122 +115,105 @@ NMDeviceModem implements </p> </div> <div class="refsect1"> -<a name="NMDeviceModem.details"></a><h2>Details</h2> +<a name="NMDeviceModem.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="NM-DEVICE-MODEM-MODEM-CAPABILITIES:CAPS"></a><h3>NM_DEVICE_MODEM_MODEM_CAPABILITIES</h3> -<pre class="programlisting">#define NM_DEVICE_MODEM_MODEM_CAPABILITIES "modem-capabilities" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-DEVICE-MODEM-CURRENT-CAPABILITIES:CAPS"></a><h3>NM_DEVICE_MODEM_CURRENT_CAPABILITIES</h3> -<pre class="programlisting">#define NM_DEVICE_MODEM_CURRENT_CAPABILITIES "current-capabilities" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMDeviceModem-struct"></a><h3>struct NMDeviceModem</h3> -<pre class="programlisting">struct NMDeviceModem;</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMDeviceModemClass"></a><h3>NMDeviceModemClass</h3> -<pre class="programlisting">typedef struct { - NMDeviceClass parent; -} NMDeviceModemClass; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="nm-device-modem-get-modem-capabilities"></a><h3>nm_device_modem_get_modem_capabilities ()</h3> -<pre class="programlisting"><a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities"><span class="returnvalue">NMDeviceModemCapabilities</span></a> nm_device_modem_get_modem_capabilities - (<em class="parameter"><code><a class="link" href="NMDeviceModem.html" title="NMDeviceModem"><span class="type">NMDeviceModem</span></a> *self</code></em>);</pre> -<p> -Returns a bitfield of the generic access technology families the modem +<a name="nm-device-modem-get-modem-capabilities"></a><h3>nm_device_modem_get_modem_capabilities ()</h3> +<pre class="programlisting"><a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities" title="enum NMDeviceModemCapabilities"><span class="returnvalue">NMDeviceModemCapabilities</span></a> +nm_device_modem_get_modem_capabilities + (<em class="parameter"><code><a class="link" href="NMDeviceModem.html" title="NMDeviceModem"><span class="type">NMDeviceModem</span></a> *self</code></em>);</pre> +<p>Returns a bitfield of the generic access technology families the modem supports. Not all capabilities are available concurrently however; some -may require a firmware reload or reinitialization. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +may require a firmware reload or reinitialization.</p> +<div class="refsect3"> +<a name="id-1.5.10.8.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> -<td>a <a class="link" href="NMDeviceModem.html" title="NMDeviceModem"><span class="type">NMDeviceModem</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the generic access technology families the modem supports</td> -</tr> -</tbody> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMDeviceModem.html" title="NMDeviceModem"><span class="type">NMDeviceModem</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.5.10.8.2.6"></a><h4>Returns</h4> +<p> the generic access technology families the modem supports</p> +<p></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="nm-device-modem-get-current-capabilities"></a><h3>nm_device_modem_get_current_capabilities ()</h3> -<pre class="programlisting"><a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities"><span class="returnvalue">NMDeviceModemCapabilities</span></a> nm_device_modem_get_current_capabilities - (<em class="parameter"><code><a class="link" href="NMDeviceModem.html" title="NMDeviceModem"><span class="type">NMDeviceModem</span></a> *self</code></em>);</pre> -<p> -Returns a bitfield of the generic access technology families the modem +<a name="nm-device-modem-get-current-capabilities"></a><h3>nm_device_modem_get_current_capabilities ()</h3> +<pre class="programlisting"><a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities" title="enum NMDeviceModemCapabilities"><span class="returnvalue">NMDeviceModemCapabilities</span></a> +nm_device_modem_get_current_capabilities + (<em class="parameter"><code><a class="link" href="NMDeviceModem.html" title="NMDeviceModem"><span class="type">NMDeviceModem</span></a> *self</code></em>);</pre> +<p>Returns a bitfield of the generic access technology families the modem supports without a firmware reload or reinitialization. This value -represents the network types the modem can immediately connect to. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +represents the network types the modem can immediately connect to.</p> +<div class="refsect3"> +<a name="id-1.5.10.8.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> -<td>a <a class="link" href="NMDeviceModem.html" title="NMDeviceModem"><span class="type">NMDeviceModem</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the generic access technology families the modem supports without -a firmware reload or other reinitialization</td> -</tr> -</tbody> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMDeviceModem.html" title="NMDeviceModem"><span class="type">NMDeviceModem</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.5.10.8.3.6"></a><h4>Returns</h4> +<p> the generic access technology families the modem supports without +a firmware reload or other reinitialization</p> +<p></p> +</div> +</div> </div> <div class="refsect1"> -<a name="NMDeviceModem.property-details"></a><h2>Property Details</h2> +<a name="NMDeviceModem.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> -<a name="NMDeviceModem--current-capabilities"></a><h3>The <code class="literal">"current-capabilities"</code> property</h3> -<pre class="programlisting"> "current-capabilities" <a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities"><span class="type">NMDeviceModemCapabilities</span></a> : Read</pre> +<a name="NM-DEVICE-MODEM-MODEM-CAPABILITIES:CAPS"></a><h3>NM_DEVICE_MODEM_MODEM_CAPABILITIES</h3> +<pre class="programlisting">#define NM_DEVICE_MODEM_MODEM_CAPABILITIES "modem-capabilities" +</pre> <p> -The generic family of access technologies the modem currently supports -without a firmware reload or reinitialization. </p> </div> <hr> <div class="refsect2"> -<a name="NMDeviceModem--modem-capabilities"></a><h3>The <code class="literal">"modem-capabilities"</code> property</h3> -<pre class="programlisting"> "modem-capabilities" <a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities"><span class="type">NMDeviceModemCapabilities</span></a> : Read</pre> +<a name="NM-DEVICE-MODEM-CURRENT-CAPABILITIES:CAPS"></a><h3>NM_DEVICE_MODEM_CURRENT_CAPABILITIES</h3> +<pre class="programlisting">#define NM_DEVICE_MODEM_CURRENT_CAPABILITIES "current-capabilities" +</pre> <p> -The generic family of access technologies the modem supports. Not all -capabilities are available at the same time however; some modems require -a firmware reload or other reinitialization to switch between eg -CDMA/EVDO and GSM/UMTS. </p> </div> </div> +<div class="refsect1"> +<a name="NMDeviceModem.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMDeviceModem--current-capabilities"></a><h3>The <code class="literal">“current-capabilities”</code> property</h3> +<pre class="programlisting"> “current-capabilities” <a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities" title="enum NMDeviceModemCapabilities"><span class="type">NMDeviceModemCapabilities</span></a></pre> +<p></p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceModem--modem-capabilities"></a><h3>The <code class="literal">“modem-capabilities”</code> property</h3> +<pre class="programlisting"> “modem-capabilities” <a class="link" href="libnm-nm-dbus-interface.html#NMDeviceModemCapabilities" title="enum NMDeviceModemCapabilities"><span class="type">NMDeviceModemCapabilities</span></a></pre> +<p></p> +<p>Flags: Read</p> +</div> +</div> </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.19</div> + Generated by GTK-Doc V1.21</div> </body> </html> \ No newline at end of file |