diff options
Diffstat (limited to 'docs/libnm/html/NMClient.html')
-rw-r--r-- | docs/libnm/html/NMClient.html | 280 |
1 files changed, 176 insertions, 104 deletions
diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index b038c2316..950d72514 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm Reference Manual: NMClient</title> +<title>NMClient: libnm Reference Manual</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="ch02.html" title="Client Object API Reference"> <link rel="next" href="NMSecretAgentOld.html" title="NMSecretAgentOld"> -<meta name="generator" content="GTK-Doc V1.21 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -759,8 +759,6 @@ </div> <div class="refsect1"> <a name="NMClient.description"></a><h2>Description</h2> -<p> -</p> </div> <div class="refsect1"> <a name="NMClient.functions_details"></a><h2>Functions</h2> @@ -772,7 +770,6 @@ nm_client_error_quark (<em class="parameter"><code><span class="type">void</span <div class="refsect3"> <a name="id-1.3.2.9.2.5"></a><h4>Returns</h4> <p> the error quark used for <a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> errors.</p> -<p></p> </div> </div> <hr> @@ -810,7 +807,6 @@ that.</p> <div class="refsect3"> <a name="id-1.3.2.9.3.7"></a><h4>Returns</h4> <p> a new <a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> or NULL on an error</p> -<p></p> </div> </div> <hr> @@ -886,7 +882,6 @@ nm_client_new_finish (<em class="parameter"><code><span class="type">GAsyncResul <div class="refsect3"> <a name="id-1.3.2.9.5.6"></a><h4>Returns</h4> <p> a new <a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a>, or <code class="literal">NULL</code> on error</p> -<p></p> </div> </div> <hr> @@ -913,7 +908,6 @@ nm_client_get_version (<em class="parameter"><code><a class="link" href="NMClien <div class="refsect3"> <a name="id-1.3.2.9.6.6"></a><h4>Returns</h4> <p> string with the version (or <code class="literal">NULL</code> if NetworkManager is not running)</p> -<p></p> </div> </div> <hr> @@ -940,7 +934,6 @@ nm_client_get_state (<em class="parameter"><code><a class="link" href="NMClient. <div class="refsect3"> <a name="id-1.3.2.9.7.6"></a><h4>Returns</h4> <p> the current <a class="link" href="libnm-nm-dbus-interface.html#NMState" title="enum NMState"><code class="literal">NMState</code></a></p> -<p></p> </div> </div> <hr> @@ -968,7 +961,6 @@ connections at startup.</p> <div class="refsect3"> <a name="id-1.3.2.9.8.6"></a><h4>Returns</h4> <p> whether the daemon is still starting up</p> -<p></p> </div> </div> <hr> @@ -995,7 +987,6 @@ nm_client_get_nm_running (<em class="parameter"><code><a class="link" href="NMCl <div class="refsect3"> <a name="id-1.3.2.9.9.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the daemon is running</p> -<p></p> </div> </div> <hr> @@ -1022,7 +1013,6 @@ nm_client_networking_get_enabled (<em class="parameter"><code><a class="link" hr <div class="refsect3"> <a name="id-1.3.2.9.10.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if networking is enabled, <code class="literal">FALSE</code> if networking is disabled</p> -<p></p> </div> </div> <hr> @@ -1065,7 +1055,6 @@ all controlled interfaces are available for activation.</p> <div class="refsect3"> <a name="id-1.3.2.9.11.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise</p> -<p></p> </div> </div> <hr> @@ -1092,7 +1081,6 @@ nm_client_wireless_get_enabled (<em class="parameter"><code><a class="link" href <div class="refsect3"> <a name="id-1.3.2.9.12.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if wireless is enabled</p> -<p></p> </div> </div> <hr> @@ -1150,7 +1138,6 @@ nm_client_wireless_hardware_get_enabled <div class="refsect3"> <a name="id-1.3.2.9.14.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the wireless hardware is enabled</p> -<p></p> </div> </div> <hr> @@ -1177,7 +1164,6 @@ nm_client_wwan_get_enabled (<em class="parameter"><code><a class="link" href="NM <div class="refsect3"> <a name="id-1.3.2.9.15.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if WWAN is enabled</p> -<p></p> </div> </div> <hr> @@ -1234,7 +1220,6 @@ nm_client_wwan_hardware_get_enabled (<em class="parameter"><code><a class="link" <div class="refsect3"> <a name="id-1.3.2.9.17.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the WWAN hardware is enabled</p> -<p></p> </div> </div> <hr> @@ -1261,7 +1246,6 @@ nm_client_wimax_get_enabled (<em class="parameter"><code><a class="link" href="N <div class="refsect3"> <a name="id-1.3.2.9.18.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if WiMAX is enabled</p> -<p></p> </div> </div> <hr> @@ -1318,7 +1302,6 @@ nm_client_wimax_hardware_get_enabled (<em class="parameter"><code><a class="link <div class="refsect3"> <a name="id-1.3.2.9.20.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the WiMAX hardware is enabled</p> -<p></p> </div> </div> <hr> @@ -1366,7 +1349,6 @@ a list of domains separated by ",". </p></td> <div class="refsect3"> <a name="id-1.3.2.9.21.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise</p> -<p></p> </div> </div> <hr> @@ -1414,7 +1396,6 @@ domains separated by ",". (<code class="literal">NULL</code> or an empty string <div class="refsect3"> <a name="id-1.3.2.9.22.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise</p> -<p></p> </div> </div> <hr> @@ -1450,7 +1431,6 @@ client can or cannot perform the action the permission represents</p> <div class="refsect3"> <a name="id-1.3.2.9.23.6"></a><h4>Returns</h4> <p> the permission's result, one of <a class="link" href="NMClient.html#NMClientPermissionResult" title="enum NMClientPermissionResult"><span class="type">NMClientPermissionResult</span></a></p> -<p></p> </div> </div> <hr> @@ -1480,7 +1460,6 @@ connectivity state first before returning any information.</p> <div class="refsect3"> <a name="id-1.3.2.9.24.6"></a><h4>Returns</h4> <p> the current connectivity state</p> -<p></p> </div> </div> <hr> @@ -1525,7 +1504,6 @@ if you do not want to block.</p> <div class="refsect3"> <a name="id-1.3.2.9.25.7"></a><h4>Returns</h4> <p> the (new) current connectivity state</p> -<p></p> </div> </div> <hr> @@ -1614,7 +1592,6 @@ call.</p> <div class="refsect3"> <a name="id-1.3.2.9.27.6"></a><h4>Returns</h4> <p> the (new) current connectivity state</p> -<p></p> </div> </div> <hr> @@ -1663,7 +1640,6 @@ clear any existing persistent hostname. </p></td> <div class="refsect3"> <a name="id-1.3.2.9.28.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the request was successful, <code class="literal">FALSE</code> if it failed</p> -<p></p> </div> </div> <hr> @@ -1755,7 +1731,6 @@ nm_client_save_hostname_finish (<em class="parameter"><code><a class="link" href <div class="refsect3"> <a name="id-1.3.2.9.30.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the request was successful, <code class="literal">FALSE</code> if it failed</p> -<p></p> </div> </div> <hr> @@ -2256,7 +2231,6 @@ nm_client_deactivate_connection (<em class="parameter"><code><a class="link" hre <div class="refsect3"> <a name="id-1.3.2.9.41.6"></a><h4>Returns</h4> <p> success or failure</p> -<p></p> </div> </div> <hr> @@ -2347,7 +2321,6 @@ nm_client_deactivate_connection_finish <div class="refsect3"> <a name="id-1.3.2.9.43.6"></a><h4>Returns</h4> <p> success or failure</p> -<p></p> </div> </div> <hr> @@ -2668,7 +2641,6 @@ filenames that failed to load. </p></td> <p> <code class="literal">TRUE</code> if NetworkManager at least tried to load <em class="parameter"><code>filenames</code></em> , <code class="literal">FALSE</code> if an error occurred (eg, permission denied).</p> -<p></p> </div> </div> <hr> @@ -2770,7 +2742,6 @@ filenames that failed to load. </p></td> <p> <code class="literal">TRUE</code> if NetworkManager at least tried to load <em class="parameter"><code>filenames</code></em> , <code class="literal">FALSE</code> if an error occurred (eg, permission denied).</p> -<p></p> </div> </div> <hr> @@ -2813,7 +2784,6 @@ the in-memory state matches the on-disk state.</p> <div class="refsect3"> <a name="id-1.3.2.9.53.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</p> -<p></p> </div> </div> <hr> @@ -2899,7 +2869,6 @@ nm_client_reload_connections_finish (<em class="parameter"><code><a class="link" <div class="refsect3"> <a name="id-1.3.2.9.55.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</p> -<p></p> </div> </div> </div> @@ -2909,192 +2878,144 @@ nm_client_reload_connections_finish (<em class="parameter"><code><a class="link" <a name="NM-CLIENT-VERSION:CAPS"></a><h3>NM_CLIENT_VERSION</h3> <pre class="programlisting">#define NM_CLIENT_VERSION "version" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-STATE:CAPS"></a><h3>NM_CLIENT_STATE</h3> <pre class="programlisting">#define NM_CLIENT_STATE "state" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-STARTUP:CAPS"></a><h3>NM_CLIENT_STARTUP</h3> <pre class="programlisting">#define NM_CLIENT_STARTUP "startup" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-NM-RUNNING:CAPS"></a><h3>NM_CLIENT_NM_RUNNING</h3> <pre class="programlisting">#define NM_CLIENT_NM_RUNNING "nm-running" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-NETWORKING-ENABLED:CAPS"></a><h3>NM_CLIENT_NETWORKING_ENABLED</h3> <pre class="programlisting">#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-WIRELESS-ENABLED:CAPS"></a><h3>NM_CLIENT_WIRELESS_ENABLED</h3> <pre class="programlisting">#define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-WIRELESS-HARDWARE-ENABLED:CAPS"></a><h3>NM_CLIENT_WIRELESS_HARDWARE_ENABLED</h3> <pre class="programlisting">#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-WWAN-ENABLED:CAPS"></a><h3>NM_CLIENT_WWAN_ENABLED</h3> <pre class="programlisting">#define NM_CLIENT_WWAN_ENABLED "wwan-enabled" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-WWAN-HARDWARE-ENABLED:CAPS"></a><h3>NM_CLIENT_WWAN_HARDWARE_ENABLED</h3> <pre class="programlisting">#define NM_CLIENT_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-WIMAX-ENABLED:CAPS"></a><h3>NM_CLIENT_WIMAX_ENABLED</h3> <pre class="programlisting">#define NM_CLIENT_WIMAX_ENABLED "wimax-enabled" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-WIMAX-HARDWARE-ENABLED:CAPS"></a><h3>NM_CLIENT_WIMAX_HARDWARE_ENABLED</h3> <pre class="programlisting">#define NM_CLIENT_WIMAX_HARDWARE_ENABLED "wimax-hardware-enabled" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-ACTIVE-CONNECTIONS:CAPS"></a><h3>NM_CLIENT_ACTIVE_CONNECTIONS</h3> <pre class="programlisting">#define NM_CLIENT_ACTIVE_CONNECTIONS "active-connections" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-CONNECTIVITY:CAPS"></a><h3>NM_CLIENT_CONNECTIVITY</h3> <pre class="programlisting">#define NM_CLIENT_CONNECTIVITY "connectivity" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-PRIMARY-CONNECTION:CAPS"></a><h3>NM_CLIENT_PRIMARY_CONNECTION</h3> <pre class="programlisting">#define NM_CLIENT_PRIMARY_CONNECTION "primary-connection" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-ACTIVATING-CONNECTION:CAPS"></a><h3>NM_CLIENT_ACTIVATING_CONNECTION</h3> <pre class="programlisting">#define NM_CLIENT_ACTIVATING_CONNECTION "activating-connection" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-DEVICES:CAPS"></a><h3>NM_CLIENT_DEVICES</h3> <pre class="programlisting">#define NM_CLIENT_DEVICES "devices" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-CONNECTIONS:CAPS"></a><h3>NM_CLIENT_CONNECTIONS</h3> <pre class="programlisting">#define NM_CLIENT_CONNECTIONS "connections" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-HOSTNAME:CAPS"></a><h3>NM_CLIENT_HOSTNAME</h3> <pre class="programlisting">#define NM_CLIENT_HOSTNAME "hostname" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-CAN-MODIFY:CAPS"></a><h3>NM_CLIENT_CAN_MODIFY</h3> <pre class="programlisting">#define NM_CLIENT_CAN_MODIFY "can-modify" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-DEVICE-ADDED:CAPS"></a><h3>NM_CLIENT_DEVICE_ADDED</h3> <pre class="programlisting">#define NM_CLIENT_DEVICE_ADDED "device-added" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-DEVICE-REMOVED:CAPS"></a><h3>NM_CLIENT_DEVICE_REMOVED</h3> <pre class="programlisting">#define NM_CLIENT_DEVICE_REMOVED "device-removed" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-PERMISSION-CHANGED:CAPS"></a><h3>NM_CLIENT_PERMISSION_CHANGED</h3> <pre class="programlisting">#define NM_CLIENT_PERMISSION_CHANGED "permission-changed" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-CONNECTION-ADDED:CAPS"></a><h3>NM_CLIENT_CONNECTION_ADDED</h3> <pre class="programlisting">#define NM_CLIENT_CONNECTION_ADDED "connection-added" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-CLIENT-CONNECTION-REMOVED:CAPS"></a><h3>NM_CLIENT_CONNECTION_REMOVED</h3> <pre class="programlisting">#define NM_CLIENT_CONNECTION_REMOVED "connection-removed" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -3313,8 +3234,6 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <a name="NM-CLIENT-ERROR:CAPS"></a><h3>NM_CLIENT_ERROR</h3> <pre class="programlisting">#define NM_CLIENT_ERROR nm_client_error_quark () </pre> -<p> -</p> </div> </div> <div class="refsect1"> @@ -3322,21 +3241,23 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--activating-connection"></a><h3>The <code class="literal">“activating-connection”</code> property</h3> <pre class="programlisting"> “activating-connection” <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> *</pre> -<p></p> +<p>The <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> of the activating connection that is +likely to become the new <a class="link" href="NMClient.html#NMClient--primary-connection" title="The “primary-connection” property"><span class="type">“primary-connection”</span></a>.</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMClient--active-connections"></a><h3>The <code class="literal">“active-connections”</code> property</h3> <pre class="programlisting"> “active-connections” <span class="type">GPtrArray</span> *</pre> -<p></p> +<p>The active connections.</p> +<p>Element-type: NMActiveConnection</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMClient--can-modify"></a><h3>The <code class="literal">“can-modify”</code> property</h3> <pre class="programlisting"> “can-modify” <span class="type">gboolean</span></pre> -<p></p> +<p>If <code class="literal">TRUE</code>, adding and modifying connections is supported.</p> <p>Flags: Read</p> <p>Default value: FALSE</p> </div> @@ -3344,14 +3265,18 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--connections"></a><h3>The <code class="literal">“connections”</code> property</h3> <pre class="programlisting"> “connections” <span class="type">GPtrArray</span> *</pre> -<p></p> +<p>The list of configured connections that are available to the user. (Note +that this differs from the underlying D-Bus property, which may also +contain the object paths of connections that the user does not have +permission to read the details of.)</p> +<p>Element-type: NMRemoteConnection</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMClient--connectivity"></a><h3>The <code class="literal">“connectivity”</code> property</h3> <pre class="programlisting"> “connectivity” <a class="link" href="libnm-nm-dbus-interface.html#NMConnectivityState" title="enum NMConnectivityState"><span class="type">NMConnectivityState</span></a></pre> -<p></p> +<p>The network connectivity state.</p> <p>Flags: Read</p> <p>Default value: NM_CONNECTIVITY_UNKNOWN</p> </div> @@ -3359,14 +3284,16 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--devices"></a><h3>The <code class="literal">“devices”</code> property</h3> <pre class="programlisting"> “devices” <span class="type">GPtrArray</span> *</pre> -<p></p> +<p>List of known network devices.</p> +<p>Element-type: NMDevice</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMClient--hostname"></a><h3>The <code class="literal">“hostname”</code> property</h3> <pre class="programlisting"> “hostname” <span class="type">gchar</span> *</pre> -<p></p> +<p>The machine hostname stored in persistent configuration. This can be +modified by calling <a class="link" href="NMClient.html#nm-client-save-hostname" title="nm_client_save_hostname ()"><code class="function">nm_client_save_hostname()</code></a>.</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -3374,7 +3301,7 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--networking-enabled"></a><h3>The <code class="literal">“networking-enabled”</code> property</h3> <pre class="programlisting"> “networking-enabled” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether networking is enabled.</p> <p>Flags: Read / Write</p> <p>Default value: TRUE</p> </div> @@ -3382,7 +3309,7 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--nm-running"></a><h3>The <code class="literal">“nm-running”</code> property</h3> <pre class="programlisting"> “nm-running” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether the daemon is running.</p> <p>Flags: Read</p> <p>Default value: FALSE</p> </div> @@ -3390,14 +3317,15 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--primary-connection"></a><h3>The <code class="literal">“primary-connection”</code> property</h3> <pre class="programlisting"> “primary-connection” <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> *</pre> -<p></p> +<p>The <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> of the device with the default route; +see <a class="link" href="NMClient.html#nm-client-get-primary-connection" title="nm_client_get_primary_connection ()"><code class="function">nm_client_get_primary_connection()</code></a> for more details.</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMClient--startup"></a><h3>The <code class="literal">“startup”</code> property</h3> <pre class="programlisting"> “startup” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether the daemon is still starting up.</p> <p>Flags: Read</p> <p>Default value: FALSE</p> </div> @@ -3405,7 +3333,7 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--state"></a><h3>The <code class="literal">“state”</code> property</h3> <pre class="programlisting"> “state” <a class="link" href="libnm-nm-dbus-interface.html#NMState" title="enum NMState"><span class="type">NMState</span></a></pre> -<p></p> +<p>The current daemon state.</p> <p>Flags: Read</p> <p>Default value: NM_STATE_UNKNOWN</p> </div> @@ -3413,7 +3341,7 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--version"></a><h3>The <code class="literal">“version”</code> property</h3> <pre class="programlisting"> “version” <span class="type">gchar</span> *</pre> -<p></p> +<p>The NetworkManager version.</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -3421,7 +3349,7 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--wimax-enabled"></a><h3>The <code class="literal">“wimax-enabled”</code> property</h3> <pre class="programlisting"> “wimax-enabled” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether WiMAX functionality is enabled.</p> <p>Flags: Read / Write</p> <p>Default value: FALSE</p> </div> @@ -3429,7 +3357,7 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--wimax-hardware-enabled"></a><h3>The <code class="literal">“wimax-hardware-enabled”</code> property</h3> <pre class="programlisting"> “wimax-hardware-enabled” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether the WiMAX hardware is enabled.</p> <p>Flags: Read</p> <p>Default value: FALSE</p> </div> @@ -3437,7 +3365,7 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--wireless-enabled"></a><h3>The <code class="literal">“wireless-enabled”</code> property</h3> <pre class="programlisting"> “wireless-enabled” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether wireless is enabled.</p> <p>Flags: Read / Write</p> <p>Default value: FALSE</p> </div> @@ -3445,7 +3373,7 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--wireless-hardware-enabled"></a><h3>The <code class="literal">“wireless-hardware-enabled”</code> property</h3> <pre class="programlisting"> “wireless-hardware-enabled” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether the wireless hardware is enabled.</p> <p>Flags: Read</p> <p>Default value: TRUE</p> </div> @@ -3453,7 +3381,7 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--wwan-enabled"></a><h3>The <code class="literal">“wwan-enabled”</code> property</h3> <pre class="programlisting"> “wwan-enabled” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether WWAN functionality is enabled.</p> <p>Flags: Read / Write</p> <p>Default value: FALSE</p> </div> @@ -3461,7 +3389,7 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient <div class="refsect2"> <a name="NMClient--wwan-hardware-enabled"></a><h3>The <code class="literal">“wwan-hardware-enabled”</code> property</h3> <pre class="programlisting"> “wwan-hardware-enabled” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether the WWAN hardware is enabled.</p> <p>Flags: Read</p> <p>Default value: FALSE</p> </div> @@ -3474,6 +3402,34 @@ the user requires to obtain a given <a class="link" href="NMClient.html#NMClient user_function (<a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client, <a class="link" href="NMRemoteConnection.html" title="NMRemoteConnection"><span class="type">NMRemoteConnection</span></a> *connection, <span class="type">gpointer</span> user_data)</pre> +<p>Notifies that a <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> has been added.</p> +<div class="refsect3"> +<a name="id-1.3.2.12.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>client</p></td> +<td class="parameter_description"><p>the settings object that received the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>connection</p></td> +<td class="parameter_description"><p>the new connection</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> <p>Flags: Run First</p> </div> <hr> @@ -3483,6 +3439,34 @@ user_function (<a class="link" href="NMClient.html" title="NMClient"><span class user_function (<a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client, <a class="link" href="NMRemoteConnection.html" title="NMRemoteConnection"><span class="type">NMRemoteConnection</span></a> *connection, <span class="type">gpointer</span> user_data)</pre> +<p>Notifies that a <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> has been removed.</p> +<div class="refsect3"> +<a name="id-1.3.2.12.3.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>client</p></td> +<td class="parameter_description"><p>the settings object that received the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>connection</p></td> +<td class="parameter_description"><p>the removed connection</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> <p>Flags: Run First</p> </div> <hr> @@ -3492,6 +3476,34 @@ user_function (<a class="link" href="NMClient.html" title="NMClient"><span class user_function (<a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client, <span class="type">GObject</span> *device, <span class="type">gpointer</span> user_data)</pre> +<p>Notifies that a <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> is added.</p> +<div class="refsect3"> +<a name="id-1.3.2.12.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>client</p></td> +<td class="parameter_description"><p>the client that received the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p> the new device. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> NMDevice]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> <p>Flags: Run First</p> </div> <hr> @@ -3501,6 +3513,34 @@ user_function (<a class="link" href="NMClient.html" title="NMClient"><span class user_function (<a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client, <span class="type">GObject</span> *device, <span class="type">gpointer</span> user_data)</pre> +<p>Notifies that a <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> is removed.</p> +<div class="refsect3"> +<a name="id-1.3.2.12.5.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>client</p></td> +<td class="parameter_description"><p>the client that received the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p> the removed device. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> NMDevice]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> <p>Flags: Run First</p> </div> <hr> @@ -3511,12 +3551,44 @@ user_function (<a class="link" href="NMClient.html" title="NMClient"><span class <span class="type">guint</span> permission, <span class="type">guint</span> result, <span class="type">gpointer</span> user_data)</pre> +<p>Notifies that a permission has changed</p> +<div class="refsect3"> +<a name="id-1.3.2.12.6.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>client</p></td> +<td class="parameter_description"><p>the client that received the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>permission</p></td> +<td class="parameter_description"><p>a permission from <a class="link" href="NMClient.html#NMClientPermission" title="enum NMClientPermission"><span class="type">NMClientPermission</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>result</p></td> +<td class="parameter_description"><p>the permission's result, one of <a class="link" href="NMClient.html#NMClientPermissionResult" title="enum NMClientPermissionResult"><span class="type">NMClientPermissionResult</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> <p>Flags: Run First</p> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.21</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file |