summary refs log tree commit diff
path: root/docs/libnm/html/NMObject.html
blob: 84324d9839e44301c8607a163c7c276d131d92d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>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)">
<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>
<div class="refentry">
<a name="NMObject"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMObject.top_of_page"></a>NMObject</span></h2>
<p>NMObject</p>
</td>
<td 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>
<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>
</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>
<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
</pre>
</div>
<div class="refsect1">
<a name="NMObject.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="NMObject.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="NM-OBJECT-PATH:CAPS"></a><h3>NM_OBJECT_PATH</h3>
<pre class="programlisting">#define NM_OBJECT_PATH "path"
</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="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>
</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>
<p></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>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>