diff options
Diffstat (limited to 'docs/libnm/html/NMObject.html')
| -rw-r--r-- | docs/libnm/html/NMObject.html | 246 |
1 files changed, 127 insertions, 119 deletions
diff --git a/docs/libnm/html/NMObject.html b/docs/libnm/html/NMObject.html index 84324d98..38da67a0 100644 --- a/docs/libnm/html/NMObject.html +++ b/docs/libnm/html/NMObject.html @@ -2,36 +2,28 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMObject</title> +<title>libnm Reference Manual: NMObject</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="ch02.html" title="Client Object API Reference"> <link rel="prev" href="NMSecretAgentOld.html" title="NMSecretAgentOld"> <link rel="next" href="libnm-nm-errors.html" title="nm-errors"> -<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="NMSecretAgentOld.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch02.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="libnm-nm-errors.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#NMObject.synopsis" class="shortcut">Top</a> - | - <a href="#NMObject.description" class="shortcut">Description</a> - | - <a href="#NMObject.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMObject.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#NMObject.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="#NMObject.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMObject.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMObject.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="NMSecretAgentOld.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libnm-nm-errors.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="NMObject"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -39,43 +31,83 @@ <h2><span class="refentrytitle"><a name="NMObject.top_of_page"></a>NMObject</span></h2> <p>NMObject</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="NMObject.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis">#define <a class="link" href="NMObject.html#NM-OBJECT-PATH:CAPS" title="NM_OBJECT_PATH">NM_OBJECT_PATH</a> -#define <a class="link" href="NMObject.html#NM-OBJECT-DBUS-CONNECTION:CAPS" title="NM_OBJECT_DBUS_CONNECTION">NM_OBJECT_DBUS_CONNECTION</a> -struct <a class="link" href="NMObject.html#NMObject-struct" title="struct NMObject">NMObject</a>; - <a class="link" href="NMObject.html#NMObjectClass" title="NMObjectClass">NMObjectClass</a>; -const <span class="returnvalue">char</span> * <a class="link" href="NMObject.html#nm-object-get-path" title="nm_object_get_path ()">nm_object_get_path</a> (<em class="parameter"><code><a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> *object</code></em>); -</pre> +<div class="refsect1"> +<a name="NMObject.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">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="NMObject.html#nm-object-get-path" title="nm_object_get_path ()">nm_object_get_path</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMObject.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> - +----NMObject - +----<a class="link" href="NMAccessPoint.html" title="NMAccessPoint">NMAccessPoint</a> - +----<a class="link" href="NMActiveConnection.html" title="NMActiveConnection">NMActiveConnection</a> - +----<a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> - +----<a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig">NMDhcpConfig</a> - +----<a class="link" href="NMIPConfig.html" title="NMIPConfig">NMIPConfig</a> - +----<a class="link" href="NMRemoteConnection.html" title="NMRemoteConnection">NMRemoteConnection</a> - +----<a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp">NMWimaxNsp</a> -</pre> +<a name="NMObject.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"> +<span class="type">GDBusConnection</span> *</td> +<td class="property_name"><a class="link" href="NMObject.html#NMObject--dbus-connection" title="The “dbus-connection” property">dbus-connection</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><span class="type">gboolean</span></td> +<td class="property_name"><a class="link" href="NMObject.html#NMObject--nm-running-internal" title="The “nm-running-internal” property">nm-running-internal</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">gchar</span> *</td> +<td class="property_name"><a class="link" href="NMObject.html#NMObject--path" title="The “path” property">path</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMObject.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -NMObject 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="NMObject.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="NMObject.html#NM-OBJECT-PATH:CAPS" title="NM_OBJECT_PATH">NM_OBJECT_PATH</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMObject.html#NM-OBJECT-DBUS-CONNECTION:CAPS" title="NM_OBJECT_DBUS_CONNECTION">NM_OBJECT_DBUS_CONNECTION</a></td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMObject.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMObject.html#NMObject--dbus-connection" title='The "dbus-connection" property'>dbus-connection</a>" <a href="http://library.gnome.org/devel/gio/unstable/GDBusConnection.html"><span class="type">GDBusConnection</span></a>* : Read / Write / Construct Only - "<a class="link" href="NMObject.html#NMObject--nm-running-internal" title='The "nm-running-internal" property'>nm-running-internal</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read - "<a class="link" href="NMObject.html#NMObject--path" title='The "path" property'>path</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only +<a name="NMObject.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> NMObject + <span class="lineart">├──</span> <a class="link" href="NMAccessPoint.html" title="NMAccessPoint">NMAccessPoint</a> + <span class="lineart">├──</span> <a class="link" href="NMActiveConnection.html" title="NMActiveConnection">NMActiveConnection</a> + <span class="lineart">├──</span> <a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> + <span class="lineart">├──</span> <a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig">NMDhcpConfig</a> + <span class="lineart">├──</span> <a class="link" href="NMIPConfig.html" title="NMIPConfig">NMIPConfig</a> + <span class="lineart">├──</span> <a class="link" href="NMRemoteConnection.html" title="NMRemoteConnection">NMRemoteConnection</a> + <span class="lineart">╰──</span> <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp">NMWimaxNsp</a> </pre> </div> <div class="refsect1"> @@ -84,7 +116,37 @@ NMObject implements </p> </div> <div class="refsect1"> -<a name="NMObject.details"></a><h2>Details</h2> +<a name="NMObject.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="nm-object-get-path"></a><h3>nm_object_get_path ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_object_get_path (<em class="parameter"><code><a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> *object</code></em>);</pre> +<p>Gets the DBus path of the <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a>.</p> +<div class="refsect3"> +<a name="id-1.3.4.8.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.4.8.2.6"></a><h4>Returns</h4> +<p> the object's path. This is the internal string used by the +device, and must not be modified.</p> +<p></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="NMObject.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="NM-OBJECT-PATH:CAPS"></a><h3>NM_OBJECT_PATH</h3> <pre class="programlisting">#define NM_OBJECT_PATH "path" @@ -100,89 +162,35 @@ NMObject implements <p> </p> </div> -<hr> -<div class="refsect2"> -<a name="NMObject-struct"></a><h3>struct NMObject</h3> -<pre class="programlisting">struct NMObject;</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMObjectClass"></a><h3>NMObjectClass</h3> -<pre class="programlisting">typedef struct { - GObjectClass parent; - - /* Methods */ - void (*init_dbus) (NMObject *object); - - /* The "object-creation-failed" method is PRIVATE for libnm and - * is not meant for any external usage. It indicates that an error - * occured during creation of an object. - */ - void (*object_creation_failed) (NMObject *master_object, - const char *failed_path); -} NMObjectClass; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="nm-object-get-path"></a><h3>nm_object_get_path ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_object_get_path (<em class="parameter"><code><a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> *object</code></em>);</pre> -<p> -Gets the DBus path of the <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a>. -</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>object</code></em> :</span></p></td> -<td>a <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the object's path. This is the internal string used by the -device, and must not be modified.</td> -</tr> -</tbody> -</table></div> -</div> </div> <div class="refsect1"> <a name="NMObject.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NMObject--dbus-connection"></a><h3>The <code class="literal">"dbus-connection"</code> property</h3> -<pre class="programlisting"> "dbus-connection" <a href="http://library.gnome.org/devel/gio/unstable/GDBusConnection.html"><span class="type">GDBusConnection</span></a>* : Read / Write / Construct Only</pre> -<p> -The <a href="http://library.gnome.org/devel/gio/unstable/GDBusConnection.html"><span class="type">GDBusConnection</span></a> of the object. -</p> +<a name="NMObject--dbus-connection"></a><h3>The <code class="literal">“dbus-connection”</code> property</h3> +<pre class="programlisting"> “dbus-connection” <span class="type">GDBusConnection</span> *</pre> +<p></p> +<p>Flags: Read / Write / Construct Only</p> </div> <hr> <div class="refsect2"> -<a name="NMObject--nm-running-internal"></a><h3>The <code class="literal">"nm-running-internal"</code> property</h3> -<pre class="programlisting"> "nm-running-internal" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre> +<a name="NMObject--nm-running-internal"></a><h3>The <code class="literal">“nm-running-internal”</code> property</h3> +<pre class="programlisting"> “nm-running-internal” <span class="type">gboolean</span></pre> <p></p> +<p>Flags: Read</p> <p>Default value: FALSE</p> </div> <hr> <div class="refsect2"> -<a name="NMObject--path"></a><h3>The <code class="literal">"path"</code> property</h3> -<pre class="programlisting"> "path" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre> -<p> -The D-Bus object path. -</p> +<a name="NMObject--path"></a><h3>The <code class="literal">“path”</code> property</h3> +<pre class="programlisting"> “path” <span class="type">gchar</span> *</pre> +<p></p> +<p>Flags: Read / Write / Construct Only</p> <p>Default value: NULL</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 |