diff options
Diffstat (limited to 'docs/libnm-glib/html/NMObject.html')
-rw-r--r-- | docs/libnm-glib/html/NMObject.html | 444 |
1 files changed, 224 insertions, 220 deletions
diff --git a/docs/libnm-glib/html/NMObject.html b/docs/libnm-glib/html/NMObject.html index 6d3c8a09e..99b05001e 100644 --- a/docs/libnm-glib/html/NMObject.html +++ b/docs/libnm-glib/html/NMObject.html @@ -2,29 +2,38 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm-glib Reference Manual: NMObject</title> +<title>NMObject</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-glib Reference Manual"> <link rel="up" href="ch02.html" title="libnm-glib API Reference"> <link rel="prev" href="NMDHCP6Config.html" title="NMDHCP6Config"> <link rel="next" href="NMRemoteConnection.html" title="NMRemoteConnection"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<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="10"><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><span id="nav_signals"> <span class="dim">|</span> - <a href="#NMObject.signals" class="shortcut">Signals</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="NMDHCP6Config.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="NMRemoteConnection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="NMDHCP6Config.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-glib Reference Manual</th> +<td><a accesskey="n" href="NMRemoteConnection.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> + | + <a href="#NMObject.signals" class="shortcut">Signals</a> +</td></tr> +</table> <div class="refentry"> <a name="NMObject"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -32,286 +41,281 @@ <h2><span class="refentrytitle"><a name="NMObject.top_of_page"></a>NMObject</span></h2> <p>NMObject</p> </td> -<td class="gallery_image" valign="top" align="right"></td> +<td valign="top" align="right"></td> </tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMObject.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">enum <a class="link" href="NMObject.html#NMObjectError" title="enum NMObjectError">NMObjectError</a>; +#define <a class="link" href="NMObject.html#NM-OBJECT-ERROR:CAPS" title="NM_OBJECT_ERROR">NM_OBJECT_ERROR</a> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMObject.html#nm-object-error-quark" title="nm_object_error_quark ()">nm_object_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +#define <a class="link" href="NMObject.html#NM-OBJECT-DBUS-CONNECTION:CAPS" title="NM_OBJECT_DBUS_CONNECTION">NM_OBJECT_DBUS_CONNECTION</a> +#define <a class="link" href="NMObject.html#NM-OBJECT-DBUS-PATH:CAPS" title="NM_OBJECT_DBUS_PATH">NM_OBJECT_DBUS_PATH</a> + <a class="link" href="NMObject.html#NMObject-struct" title="NMObject">NMObject</a>; + <a class="link" href="NMObject.html#NMObjectClass" title="NMObjectClass">NMObjectClass</a>; +<a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="returnvalue">DBusGConnection</span></a> * <a class="link" href="NMObject.html#nm-object-get-connection" title="nm_object_get_connection ()">nm_object_get_connection</a> (<em class="parameter"><code><a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> *object</code></em>); +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> <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"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> -</td> -<td class="function_name"> -<a class="link" href="NMObject.html#nm-object-error-quark" title="nm_object_error_quark ()">nm_object_error_quark</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="returnvalue">DBusGConnection</span></a> * -</td> -<td class="function_name"> -<a class="link" href="NMObject.html#nm-object-get-connection" title="nm_object_get_connection ()">nm_object_get_connection</a> <span class="c_punctuation">()</span> -</td> -</tr> -<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> +<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="NMClient.html" title="NMClient">NMClient</a> + +----<a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> + +----<a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp">NMWimaxNsp</a> + +----<a class="link" href="NMAccessPoint.html" title="NMAccessPoint">NMAccessPoint</a> + +----<a class="link" href="NMIP4Config.html" title="NMIP4Config">NMIP4Config</a> + +----<a class="link" href="NMIP6Config.html" title="NMIP6Config">NMIP6Config</a> + +----<a class="link" href="NMActiveConnection.html" title="NMActiveConnection">NMActiveConnection</a> + +----<a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config">NMDHCP4Config</a> + +----<a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config">NMDHCP6Config</a> +</pre> +</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> </div> <div class="refsect1"> <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"> -<a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *</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"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> -<td class="property_name"><a class="link" href="NMObject.html#NMObject--dbus-path" title="The “dbus-path” property">dbus-path</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -</tbody> -</table></div> +<pre class="synopsis"> + "<a class="link" href="NMObject.html#NMObject--dbus-connection" title='The "dbus-connection" property'>dbus-connection</a>" <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a>* : Read / Write / Construct Only + "<a class="link" href="NMObject.html#NMObject--dbus-path" title='The "dbus-path" property'>dbus-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 +</pre> </div> <div class="refsect1"> <a name="NMObject.signals"></a><h2>Signals</h2> -<div class="informaltable"><table border="0"> -<colgroup> -<col width="150px" class="signals_return"> -<col width="300px" class="signals_name"> -<col width="200px" class="signals_flags"> -</colgroup> -<tbody><tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="NMObject.html#NMObject-object-creation-failed" title="The “object-creation-failed” signal">object-creation-failed</a></td> -<td class="signal_flags"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> -</tr></tbody> -</table></div> +<pre class="synopsis"> + "<a class="link" href="NMObject.html#NMObject-object-creation-failed" title='The "object-creation-failed" signal'>object-creation-failed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a> +</pre> +</div> +<div class="refsect1"> +<a name="NMObject.description"></a><h2>Description</h2> +<p> +</p> </div> <div class="refsect1"> -<a name="NMObject.other"></a><h2>Types and Values</h2> -<div class="informaltable"><table width="100%" border="0"> +<a name="NMObject.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NMObjectError"></a><h3>enum NMObjectError</h3> +<pre class="programlisting">typedef enum { + NM_OBJECT_ERROR_UNKNOWN = 0, + NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE, +} NMObjectError; +</pre> +<p> +Describes errors that may result from operations involving a <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 width="150px" class="name"> -<col class="description"> +<col align="left" valign="top"> +<col> </colgroup> <tbody> <tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="NMObject.html#NMObjectError" title="enum NMObjectError">NMObjectError</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMObject.html#NM-OBJECT-ERROR:CAPS" title="NM_OBJECT_ERROR">NM_OBJECT_ERROR</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> +<td><p><a name="NM-OBJECT-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_OBJECT_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error +</td> </tr> <tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMObject.html#NM-OBJECT-DBUS-PATH:CAPS" title="NM_OBJECT_DBUS_PATH">NM_OBJECT_DBUS_PATH</a></td> +<td><p><a name="NM-OBJECT-ERROR-OBJECT-CREATION-FAILURE:CAPS"></a><span class="term"><code class="literal">NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE</code></span></p></td> +<td>an error ocured while creating an <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> +</td> </tr> </tbody> </table></div> </div> -<div class="refsect1"> -<a name="NMObject.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> - <span class="lineart">╰──</span> NMObject - <span class="lineart">├──</span> <a class="link" href="NMClient.html" title="NMClient">NMClient</a> - <span class="lineart">├──</span> <a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> - <span class="lineart">├──</span> <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp">NMWimaxNsp</a> - <span class="lineart">├──</span> <a class="link" href="NMAccessPoint.html" title="NMAccessPoint">NMAccessPoint</a> - <span class="lineart">├──</span> <a class="link" href="NMIP4Config.html" title="NMIP4Config">NMIP4Config</a> - <span class="lineart">├──</span> <a class="link" href="NMIP6Config.html" title="NMIP6Config">NMIP6Config</a> - <span class="lineart">├──</span> <a class="link" href="NMActiveConnection.html" title="NMActiveConnection">NMActiveConnection</a> - <span class="lineart">├──</span> <a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config">NMDHCP4Config</a> - <span class="lineart">╰──</span> <a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config">NMDHCP6Config</a> +<hr> +<div class="refsect2"> +<a name="NM-OBJECT-ERROR:CAPS"></a><h3>NM_OBJECT_ERROR</h3> +<pre class="programlisting">#define NM_OBJECT_ERROR nm_object_error_quark () </pre> -</div> -<div class="refsect1"> -<a name="NMObject.description"></a><h2>Description</h2> <p> </p> </div> -<div class="refsect1"> -<a name="NMObject.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="nm-object-error-quark"></a><h3>nm_object_error_quark ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> -nm_object_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Registers an error quark for <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> if necessary.</p> -<div class="refsect3"> -<a name="id-1.3.22.9.2.5"></a><h4>Returns</h4> -<p> the error quark used for <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> errors.</p> -<p></p> -</div> -</div> <hr> <div class="refsect2"> -<a name="nm-object-get-connection"></a><h3>nm_object_get_connection ()</h3> -<pre class="programlisting"><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="returnvalue">DBusGConnection</span></a> * -nm_object_get_connection (<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 <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a>'s DBusGConnection.</p> -<div class="refsect3"> -<a name="id-1.3.22.9.3.5"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="nm-object-error-quark"></a><h3>nm_object_error_quark ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_object_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Registers an error quark for <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> if necessary. +</p> +<div class="variablelist"><table border="0" class="variablelist"> <colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> +<col align="left" valign="top"> +<col> </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> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the error quark used for <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> errors.</td> </tr></tbody> </table></div> </div> -<div class="refsect3"> -<a name="id-1.3.22.9.3.6"></a><h4>Returns</h4> -<p> the connection. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</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="refsect3"> -<a name="id-1.3.22.9.4.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> +<a name="NM-OBJECT-DBUS-CONNECTION:CAPS"></a><h3>NM_OBJECT_DBUS_CONNECTION</h3> +<pre class="programlisting">#define NM_OBJECT_DBUS_CONNECTION "dbus-connection" +</pre> +<p> +</p> </div> -<div class="refsect3"> -<a name="id-1.3.22.9.4.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> +<hr> +<div class="refsect2"> +<a name="NM-OBJECT-DBUS-PATH:CAPS"></a><h3>NM_OBJECT_DBUS_PATH</h3> +<pre class="programlisting">#define NM_OBJECT_DBUS_PATH "dbus-path" +</pre> +<p> +</p> </div> +<hr> +<div class="refsect2"> +<a name="NMObject-struct"></a><h3>NMObject</h3> +<pre class="programlisting">typedef struct _NMObject NMObject;</pre> +<p> +</p> </div> +<hr> +<div class="refsect2"> +<a name="NMObjectClass"></a><h3>NMObjectClass</h3> +<pre class="programlisting">typedef struct { + GObjectClass parent; + + /* Signals */ + /* The "object-creation-failed" signal is PRIVATE for libnm-glib 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, + GError *error, + char *failed_path); + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); + void (*_reserved5) (void); + void (*_reserved6) (void); +} NMObjectClass; +</pre> +<p> +</p> </div> -<div class="refsect1"> -<a name="NMObject.other_details"></a><h2>Types and Values</h2> +<hr> <div class="refsect2"> -<a name="NMObjectError"></a><h3>enum NMObjectError</h3> -<p>Describes errors that may result from operations involving a <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a>.</p> -<div class="refsect3"> -<a name="id-1.3.22.10.2.4"></a><h4>Members</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="nm-object-get-connection"></a><h3>nm_object_get_connection ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="returnvalue">DBusGConnection</span></a> * nm_object_get_connection (<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 <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a>'s DBusGConnection. +</p> +<div class="variablelist"><table border="0" class="variablelist"> <colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> +<col align="left" valign="top"> +<col> </colgroup> <tbody> <tr> -<td class="enum_member_name"><p><a name="NM-OBJECT-ERROR-UNKNOWN:CAPS"></a>NM_OBJECT_ERROR_UNKNOWN</p></td> -<td class="enum_member_description"> -<p>unknown or unclassified error</p> +<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> -<td class="enum_member_annotations"> </td> </tr> <tr> -<td class="enum_member_name"><p><a name="NM-OBJECT-ERROR-OBJECT-CREATION-FAILURE:CAPS"></a>NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE</p></td> -<td class="enum_member_description"> -<p>an error ocured while creating an <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a></p> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the connection. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> </td> -<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> -</div> -<hr> -<div class="refsect2"> -<a name="NM-OBJECT-ERROR:CAPS"></a><h3>NM_OBJECT_ERROR</h3> -<pre class="programlisting">#define NM_OBJECT_ERROR nm_object_error_quark () -</pre> -<p> -</p> -</div> <hr> <div class="refsect2"> -<a name="NM-OBJECT-DBUS-CONNECTION:CAPS"></a><h3>NM_OBJECT_DBUS_CONNECTION</h3> -<pre class="programlisting">#define NM_OBJECT_DBUS_CONNECTION "dbus-connection" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-OBJECT-DBUS-PATH:CAPS"></a><h3>NM_OBJECT_DBUS_PATH</h3> -<pre class="programlisting">#define NM_OBJECT_DBUS_PATH "dbus-path" -</pre> +<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="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *</pre> +<a name="NMObject--dbus-connection"></a><h3>The <code class="literal">"dbus-connection"</code> property</h3> +<pre class="programlisting"> "dbus-connection" <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a>* : Read / Write / Construct Only</pre> <p>Connection.</p> -<p>Flags: Read / Write / Construct Only</p> </div> <hr> <div class="refsect2"> -<a name="NMObject--dbus-path"></a><h3>The <code class="literal">“dbus-path”</code> property</h3> -<pre class="programlisting"> “dbus-path” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<a name="NMObject--dbus-path"></a><h3>The <code class="literal">"dbus-path"</code> property</h3> +<pre class="programlisting"> "dbus-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>DBus Object Path.</p> -<p>Flags: Read / Write / Construct Only</p> <p>Default value: NULL</p> </div> </div> <div class="refsect1"> <a name="NMObject.signal-details"></a><h2>Signal Details</h2> <div class="refsect2"> -<a name="NMObject-object-creation-failed"></a><h3>The <code class="literal">“object-creation-failed”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> *master_object, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> error, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> failed_path, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> -<p>Flags: <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +<a name="NMObject-object-creation-failed"></a><h3>The <code class="literal">"object-creation-failed"</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> *master_object, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> error, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> failed_path, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre> +<p> +Indicates that an error occured while creating an <a class="link" href="NMObject.html" title="NMObject"><span class="type">NMObject</span></a> object +during property handling of <em class="parameter"><code>master_object</code></em>. +</p> +<p> +Note: Be aware that the signal is private for libnm-glib's internal + use. +</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>master_object</code></em> :</span></p></td> +<td>the object that received the signal</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> +<td>the error that occured while creating object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>failed_path</code></em> :</span></p></td> +<td>object path of the failed object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> </div> </div> </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.20</div> + Generated by GTK-Doc V1.19</div> </body> </html>
\ No newline at end of file |