diff options
author | Michael Biebl <biebl@debian.org> | 2011-08-23 19:16:47 +0200 |
---|---|---|
committer | Michael Biebl <biebl@debian.org> | 2011-08-23 19:16:47 +0200 |
commit | 263bf4c0c89bb88dc995acd9a6a2de9095fbd461 (patch) | |
tree | 7224326afe367409e7150e49fad9029f81fe24b8 /docs/libnm-glib | |
parent | d465e5fac63f36bcf4069e36827f4b62c494556d (diff) |
Imported Upstream version 0.9.0upstream/0.9.0
Diffstat (limited to 'docs/libnm-glib')
-rw-r--r-- | docs/libnm-glib/html/NMClient.html | 32 | ||||
-rw-r--r-- | docs/libnm-glib/html/NMDevice.html | 11 | ||||
-rw-r--r-- | docs/libnm-glib/html/NMDeviceWifi.html | 4 | ||||
-rw-r--r-- | docs/libnm-glib/html/NMDeviceWimax.html | 4 | ||||
-rw-r--r-- | docs/libnm-glib/html/NMRemoteConnection.html | 2 | ||||
-rw-r--r-- | docs/libnm-glib/html/NMRemoteSettings.html | 2 | ||||
-rw-r--r-- | docs/libnm-glib/html/api-index-full.html | 8 | ||||
-rw-r--r-- | docs/libnm-glib/html/ch02.html | 5 | ||||
-rw-r--r-- | docs/libnm-glib/html/index.html | 5 | ||||
-rw-r--r-- | docs/libnm-glib/html/index.sgml | 7 | ||||
-rw-r--r-- | docs/libnm-glib/html/libnm-glib-NMVpnPluginUi.html | 16 | ||||
-rw-r--r-- | docs/libnm-glib/html/libnm-glib-nm-vpn-plugin-utils.html | 137 | ||||
-rw-r--r-- | docs/libnm-glib/html/libnm-glib.devhelp | 4 | ||||
-rw-r--r-- | docs/libnm-glib/html/libnm-glib.devhelp2 | 4 | ||||
-rw-r--r-- | docs/libnm-glib/html/object-tree.html | 4 | ||||
-rw-r--r-- | docs/libnm-glib/libnm-glib-docs.xml | 1 | ||||
-rw-r--r-- | docs/libnm-glib/libnm-glib-sections.txt | 1 |
17 files changed, 217 insertions, 30 deletions
diff --git a/docs/libnm-glib/html/NMClient.html b/docs/libnm-glib/html/NMClient.html index 26d99de00..48fe024f4 100644 --- a/docs/libnm-glib/html/NMClient.html +++ b/docs/libnm-glib/html/NMClient.html @@ -62,6 +62,8 @@ enum <a class="link" href="NMClient.html#NMClientPermissionResult const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="NMClient.html#nm-client-get-devices" title="nm_client_get_devices ()">nm_client_get_devices</a> (<em class="parameter"><code><a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client</code></em>); <a class="link" href="NMDevice.html" title="NMDevice"><span class="returnvalue">NMDevice</span></a> * <a class="link" href="NMClient.html#nm-client-get-device-by-path" title="nm_client_get_device_by_path ()">nm_client_get_device_by_path</a> (<em class="parameter"><code><a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client</code></em>, <em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>); +<a class="link" href="NMDevice.html" title="NMDevice"><span class="returnvalue">NMDevice</span></a> * <a class="link" href="NMClient.html#nm-client-get-device-by-iface" title="nm_client_get_device_by_iface ()">nm_client_get_device_by_iface</a> (<em class="parameter"><code><a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *iface</code></em>); <span class="returnvalue">void</span> (<a class="link" href="NMClient.html#NMClientActivateFn" title="NMClientActivateFn ()">*NMClientActivateFn</a>) (<em class="parameter"><code><a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client</code></em>, <em class="parameter"><code><a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> *active_connection</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>, @@ -370,7 +372,35 @@ Gets a <a class="link" href="NMDevice.html" title="NMDevice"><span class="type"> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> for the given <em class="parameter"><code>object_path</code></em> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is found. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +<td>the <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> for the given <em class="parameter"><code>object_path</code></em> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is found. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-client-get-device-by-iface"></a><h3>nm_client_get_device_by_iface ()</h3> +<pre class="programlisting"><a class="link" href="NMDevice.html" title="NMDevice"><span class="returnvalue">NMDevice</span></a> * nm_client_get_device_by_iface (<em class="parameter"><code><a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *iface</code></em>);</pre> +<p> +Gets a <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> from a <a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td> +<td>a <a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td> +<td>the interface name to search for</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> for the given <em class="parameter"><code>iface</code></em> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is found. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> </td> </tr> </tbody> diff --git a/docs/libnm-glib/html/NMDevice.html b/docs/libnm-glib/html/NMDevice.html index f7f01aa2a..2b01b135b 100644 --- a/docs/libnm-glib/html/NMDevice.html +++ b/docs/libnm-glib/html/NMDevice.html @@ -530,7 +530,7 @@ Gets the current <a class="link" href="NMIP4Config.html" title="NMIP4Config"><sp </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +<td>the <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> </td> </tr> </tbody> @@ -553,7 +553,7 @@ Gets the current <a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config" </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <span class="type">NMDHCPConfig</span> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated or not +<td>the <span class="type">NMDHCPConfig</span> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated or not using DHCP. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> </td> </tr> @@ -577,7 +577,7 @@ Gets the current <a class="link" href="NMIP6Config.html" title="NMIP6Config"><sp </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +<td>the <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> </td> </tr> </tbody> @@ -600,7 +600,7 @@ Gets the current <a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config" </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <span class="type">NMDHCPConfig</span> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated or not +<td>the <span class="type">NMDHCPConfig</span> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated or not using DHCP. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> </td> </tr> @@ -646,7 +646,8 @@ Gets the <a class="link" href="NMActiveConnection.html" title="NMActiveConnectio </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> +<td>the <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is +not part of an active connection. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> </td> </tr> </tbody> diff --git a/docs/libnm-glib/html/NMDeviceWifi.html b/docs/libnm-glib/html/NMDeviceWifi.html index e7ddf0a94..b107ad45d 100644 --- a/docs/libnm-glib/html/NMDeviceWifi.html +++ b/docs/libnm-glib/html/NMDeviceWifi.html @@ -339,7 +339,7 @@ Gets the active <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the access point or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is active. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +<td>the access point or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is active. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> </td> </tr> </tbody> @@ -368,7 +368,7 @@ Gets a <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span cla </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the access point or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is found. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +<td>the access point or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is found. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> </td> </tr> </tbody> diff --git a/docs/libnm-glib/html/NMDeviceWimax.html b/docs/libnm-glib/html/NMDeviceWimax.html index a9b65251a..e24928d71 100644 --- a/docs/libnm-glib/html/NMDeviceWimax.html +++ b/docs/libnm-glib/html/NMDeviceWimax.html @@ -246,7 +246,7 @@ Gets the active <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the access point or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is active. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +<td>the access point or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is active. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> </td> </tr> </tbody> @@ -274,7 +274,7 @@ Gets a <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="ty </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the access point or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is found. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +<td>the access point or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is found. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> </td> </tr> </tbody> diff --git a/docs/libnm-glib/html/NMRemoteConnection.html b/docs/libnm-glib/html/NMRemoteConnection.html index 8be508bee..87aaf32b1 100644 --- a/docs/libnm-glib/html/NMRemoteConnection.html +++ b/docs/libnm-glib/html/NMRemoteConnection.html @@ -196,7 +196,7 @@ Creates a new object representing the remote connection. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the new remote connection object on success, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure</td> +<td>the new remote connection object on success, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure</td> </tr> </tbody> </table></div> diff --git a/docs/libnm-glib/html/NMRemoteSettings.html b/docs/libnm-glib/html/NMRemoteSettings.html index 4274c72a9..0457a5673 100644 --- a/docs/libnm-glib/html/NMRemoteSettings.html +++ b/docs/libnm-glib/html/NMRemoteSettings.html @@ -300,7 +300,7 @@ Creates a new object representing the remote settings service. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the new remote settings object on success, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure</td> +<td>the new remote settings object on success, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure</td> </tr> </tbody> </table></div> diff --git a/docs/libnm-glib/html/api-index-full.html b/docs/libnm-glib/html/api-index-full.html index 311e89966..adba6f393 100644 --- a/docs/libnm-glib/html/api-index-full.html +++ b/docs/libnm-glib/html/api-index-full.html @@ -388,6 +388,10 @@ </dt> <dd></dd> <dt> +<a class="link" href="NMClient.html#nm-client-get-device-by-iface" title="nm_client_get_device_by_iface ()">nm_client_get_device_by_iface</a>, function in <a class="link" href="NMClient.html" title="NMClient">NMClient</a> +</dt> +<dd></dd> +<dt> <a class="link" href="NMClient.html#nm-client-get-device-by-path" title="nm_client_get_device_by_path ()">nm_client_get_device_by_path</a>, function in <a class="link" href="NMClient.html" title="NMClient">NMClient</a> </dt> <dd></dd> @@ -1925,11 +1929,11 @@ g_marshal_value_peek_variant, macro in nm-secret-agent-glue </dt> <dd></dd> <dt> -nm_vpn_plugin_utils_get_secret_flags, function in nm-vpn-plugin-utils +<a class="link" href="libnm-glib-nm-vpn-plugin-utils.html#nm-vpn-plugin-utils-get-secret-flags" title="nm_vpn_plugin_utils_get_secret_flags ()">nm_vpn_plugin_utils_get_secret_flags</a>, function in <a class="link" href="libnm-glib-nm-vpn-plugin-utils.html" title="nm-vpn-plugin-utils">nm-vpn-plugin-utils</a> </dt> <dd></dd> <dt> -nm_vpn_plugin_utils_read_vpn_details, function in nm-vpn-plugin-utils +<a class="link" href="libnm-glib-nm-vpn-plugin-utils.html#nm-vpn-plugin-utils-read-vpn-details" title="nm_vpn_plugin_utils_read_vpn_details ()">nm_vpn_plugin_utils_read_vpn_details</a>, function in <a class="link" href="libnm-glib-nm-vpn-plugin-utils.html" title="nm-vpn-plugin-utils">nm-vpn-plugin-utils</a> </dt> <dd></dd> <a name="idxW"></a><h3 class="title">W</h3> diff --git a/docs/libnm-glib/html/ch02.html b/docs/libnm-glib/html/ch02.html index bfc170070..4aa9ceee7 100644 --- a/docs/libnm-glib/html/ch02.html +++ b/docs/libnm-glib/html/ch02.html @@ -21,7 +21,7 @@ </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h2 class="title"> -<a name="id340247"></a>libnm-glib API Reference</h2></div></div></div> +<a name="id446675"></a>libnm-glib API Reference</h2></div></div></div> <div class="toc"><dl> <dt> <span class="refentrytitle"><a href="NMClient.html">NMClient</a></span><span class="refpurpose"></span> @@ -89,6 +89,9 @@ <dt> <span class="refentrytitle"><a href="libnm-glib-NMVpnPluginUi.html">NMVpnPluginUi</a></span><span class="refpurpose"></span> </dt> +<dt> +<span class="refentrytitle"><a href="libnm-glib-nm-vpn-plugin-utils.html">nm-vpn-plugin-utils</a></span><span class="refpurpose"></span> +</dt> </dl></div> </div> <div class="footer"> diff --git a/docs/libnm-glib/html/index.html b/docs/libnm-glib/html/index.html index 665edd03a..10f59ff83 100644 --- a/docs/libnm-glib/html/index.html +++ b/docs/libnm-glib/html/index.html @@ -29,7 +29,7 @@ </p></div> <div><p class="copyright">Copyright © 2011 The NetworkManager Authors</p></div> <div><div class="legalnotice"> -<a name="id310650"></a><p> +<a name="id417078"></a><p> Permission is granted to copy, distribute and/or modify this document under the terms of the <em class="citetitle">GNU Free Documentation License</em>, Version 1.1 or any later @@ -130,6 +130,9 @@ <dt> <span class="refentrytitle"><a href="libnm-glib-NMVpnPluginUi.html">NMVpnPluginUi</a></span><span class="refpurpose"></span> </dt> +<dt> +<span class="refentrytitle"><a href="libnm-glib-nm-vpn-plugin-utils.html">nm-vpn-plugin-utils</a></span><span class="refpurpose"></span> +</dt> </dl></dd> <dt><span class="chapter"><a href="object-tree.html">Object Hierarchy</a></span></dt> <dt><span class="index"><a href="api-index-full.html">API Index</a></span></dt> diff --git a/docs/libnm-glib/html/index.sgml b/docs/libnm-glib/html/index.sgml index db6d2d8af..b12be4b26 100644 --- a/docs/libnm-glib/html/index.sgml +++ b/docs/libnm-glib/html/index.sgml @@ -24,6 +24,7 @@ <ANCHOR id="nm-client-new" href="libnm-glib/NMClient.html#nm-client-new"> <ANCHOR id="nm-client-get-devices" href="libnm-glib/NMClient.html#nm-client-get-devices"> <ANCHOR id="nm-client-get-device-by-path" href="libnm-glib/NMClient.html#nm-client-get-device-by-path"> +<ANCHOR id="nm-client-get-device-by-iface" href="libnm-glib/NMClient.html#nm-client-get-device-by-iface"> <ANCHOR id="NMClientActivateFn" href="libnm-glib/NMClient.html#NMClientActivateFn"> <ANCHOR id="nm-client-activate-connection" href="libnm-glib/NMClient.html#nm-client-activate-connection"> <ANCHOR id="NMClientAddActivateFn" href="libnm-glib/NMClient.html#NMClientAddActivateFn"> @@ -622,6 +623,12 @@ <ANCHOR id="nm-vpn-plugin-ui-widget-interface-get-widget" href="libnm-glib/libnm-glib-NMVpnPluginUi.html#nm-vpn-plugin-ui-widget-interface-get-widget"> <ANCHOR id="nm-vpn-plugin-ui-widget-interface-update-connection" href="libnm-glib/libnm-glib-NMVpnPluginUi.html#nm-vpn-plugin-ui-widget-interface-update-connection"> <ANCHOR id="nm-vpn-plugin-ui-widget-interface-save-secrets" href="libnm-glib/libnm-glib-NMVpnPluginUi.html#nm-vpn-plugin-ui-widget-interface-save-secrets"> +<ANCHOR id="libnm-glib-nm-vpn-plugin-utils" href="libnm-glib/libnm-glib-nm-vpn-plugin-utils.html"> +<ANCHOR id="libnm-glib-nm-vpn-plugin-utils.synopsis" href="libnm-glib/libnm-glib-nm-vpn-plugin-utils.html#libnm-glib-nm-vpn-plugin-utils.synopsis"> +<ANCHOR id="libnm-glib-nm-vpn-plugin-utils.description" href="libnm-glib/libnm-glib-nm-vpn-plugin-utils.html#libnm-glib-nm-vpn-plugin-utils.description"> +<ANCHOR id="libnm-glib-nm-vpn-plugin-utils.details" href="libnm-glib/libnm-glib-nm-vpn-plugin-utils.html#libnm-glib-nm-vpn-plugin-utils.details"> +<ANCHOR id="nm-vpn-plugin-utils-read-vpn-details" href="libnm-glib/libnm-glib-nm-vpn-plugin-utils.html#nm-vpn-plugin-utils-read-vpn-details"> +<ANCHOR id="nm-vpn-plugin-utils-get-secret-flags" href="libnm-glib/libnm-glib-nm-vpn-plugin-utils.html#nm-vpn-plugin-utils-get-secret-flags"> <ANCHOR id="annotation-glossterm-out" href="libnm-glib/annotation-glossary.html#annotation-glossterm-out"> <ANCHOR id="annotation-glossterm-scope async" href="libnm-glib/annotation-glossary.html#annotation-glossterm-scope async"> <ANCHOR id="annotation-glossterm-allow-none" href="libnm-glib/annotation-glossary.html#annotation-glossterm-allow-none"> diff --git a/docs/libnm-glib/html/libnm-glib-NMVpnPluginUi.html b/docs/libnm-glib/html/libnm-glib-NMVpnPluginUi.html index 834996c20..468382ce0 100644 --- a/docs/libnm-glib/html/libnm-glib-NMVpnPluginUi.html +++ b/docs/libnm-glib/html/libnm-glib-NMVpnPluginUi.html @@ -7,7 +7,7 @@ <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="libnm-glib-NMVPNPlugin.html" title="NMVPNPlugin"> -<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<link rel="next" href="libnm-glib-nm-vpn-plugin-utils.html" title="nm-vpn-plugin-utils"> <meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -18,7 +18,7 @@ <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="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="libnm-glib-nm-vpn-plugin-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"> <a href="#libnm-glib-NMVpnPluginUi.synopsis" class="shortcut">Top</a> @@ -212,11 +212,7 @@ struct <a class="link" href="libnm-glib-NMVpnPluginUi.html#NMVpnPlu */ char * (*get_suggested_name) (NMVpnPluginUiInterface *iface, NMConnection *connection); - /* Called when the user has chosen to remove the connection (for user - * connections only; system connections are handled by the system - * settings service). Should clear out any VPN-specific secrets or data - * related to the connection. - */ + /* Deprecated and no longer used */ gboolean (*delete_connection) (NMVpnPluginUiInterface *iface, NMConnection *connection, GError **error); /* Padding for future expansion */ @@ -339,11 +335,7 @@ struct <a class="link" href="libnm-glib-NMVpnPluginUi.html#NMVpnPlu NMConnection *connection, GError **error); - /* Called when the user has chosen to save the connection (for user - * connections only; system connections are handled by the system - * settings service). Should save VPN-specific connection secrets in - * a way that the auth-dialog can read them. - */ + /* Deprecated and no longer used */ gboolean (*save_secrets) (NMVpnPluginUiWidgetInterface *iface, NMConnection *connection, GError **error); diff --git a/docs/libnm-glib/html/libnm-glib-nm-vpn-plugin-utils.html b/docs/libnm-glib/html/libnm-glib-nm-vpn-plugin-utils.html new file mode 100644 index 000000000..164576fb3 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-vpn-plugin-utils.html @@ -0,0 +1,137 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>nm-vpn-plugin-utils</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.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="libnm-glib-NMVpnPluginUi.html" title="NMVpnPluginUi"> +<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<meta name="generator" content="GTK-Doc V1.17 (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="libnm-glib-NMVpnPluginUi.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="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libnm-glib-nm-vpn-plugin-utils.synopsis" class="shortcut">Top</a> + | + <a href="#libnm-glib-nm-vpn-plugin-utils.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="libnm-glib-nm-vpn-plugin-utils"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libnm-glib-nm-vpn-plugin-utils.top_of_page"></a>nm-vpn-plugin-utils</span></h2> +<p>nm-vpn-plugin-utils</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="libnm-glib-nm-vpn-plugin-utils.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libnm-glib-nm-vpn-plugin-utils.html#nm-vpn-plugin-utils-read-vpn-details" title="nm_vpn_plugin_utils_read_vpn_details ()">nm_vpn_plugin_utils_read_vpn_details</a> + (<em class="parameter"><code><span class="type">int</span> fd</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **out_data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **out_secrets</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libnm-glib-nm-vpn-plugin-utils.html#nm-vpn-plugin-utils-get-secret-flags" title="nm_vpn_plugin_utils_get_secret_flags ()">nm_vpn_plugin_utils_get_secret_flags</a> + (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *data</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *secret_name</code></em>, + <em class="parameter"><code><a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> *out_flags</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="libnm-glib-nm-vpn-plugin-utils.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1"> +<a name="libnm-glib-nm-vpn-plugin-utils.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="nm-vpn-plugin-utils-read-vpn-details"></a><h3>nm_vpn_plugin_utils_read_vpn_details ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_vpn_plugin_utils_read_vpn_details + (<em class="parameter"><code><span class="type">int</span> fd</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **out_data</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **out_secrets</code></em>);</pre> +<p> +Parses key/value pairs from a file descriptor (normally stdin) passed by +an applet when the applet calls the authentication dialog of the VPN plugin. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td> +<td>file descriptor to read from, usually stdin (0)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>out_data</code></em> :</span></p></td> +<td>on successful return, a hash table +(mapping char*:char*) containing the key/value pairs of VPN data items. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>out_secrets</code></em> :</span></p></td> +<td>on successful return, a hash table +(mapping char*:char*) containing the key/value pairsof VPN secrets. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if reading values was successful, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-vpn-plugin-utils-get-secret-flags"></a><h3>nm_vpn_plugin_utils_get_secret_flags ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_vpn_plugin_utils_get_secret_flags + (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *data</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *secret_name</code></em>, + <em class="parameter"><code><a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> *out_flags</code></em>);</pre> +<p> +Given a VPN secret key name, attempts to find the corresponding flags data +item in <em class="parameter"><code>data</code></em>. If found, converts the flags data item to +<a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/09/NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> and returns it. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>hash table containing VPN key/value pair data items</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>secret_name</code></em> :</span></p></td> +<td>VPN secret key name for which to retrieve flags for</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>out_flags</code></em> :</span></p></td> +<td>on success, the flags associated with <em class="parameter"><code>secret_name</code></em>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the flag data item was found and successfully converted +to flags, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.17</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib.devhelp b/docs/libnm-glib/html/libnm-glib.devhelp index cd1d08574..54edc1f6f 100644 --- a/docs/libnm-glib/html/libnm-glib.devhelp +++ b/docs/libnm-glib/html/libnm-glib.devhelp @@ -26,6 +26,7 @@ <sub name="NMVPNConnection" link="NMVPNConnection.html"/> <sub name="NMVPNPlugin" link="libnm-glib-NMVPNPlugin.html"/> <sub name="NMVpnPluginUi" link="libnm-glib-NMVpnPluginUi.html"/> + <sub name="nm-vpn-plugin-utils" link="libnm-glib-nm-vpn-plugin-utils.html"/> </sub> <sub name="Object Hierarchy" link="object-tree.html"/> <sub name="API Index" link="api-index-full.html"/> @@ -50,6 +51,7 @@ <function name="nm_client_new ()" link="NMClient.html#nm-client-new"/> <function name="nm_client_get_devices ()" link="NMClient.html#nm-client-get-devices"/> <function name="nm_client_get_device_by_path ()" link="NMClient.html#nm-client-get-device-by-path"/> + <function name="nm_client_get_device_by_iface ()" link="NMClient.html#nm-client-get-device-by-iface"/> <function name="NMClientActivateFn ()" link="NMClient.html#NMClientActivateFn"/> <function name="nm_client_activate_connection ()" link="NMClient.html#nm-client-activate-connection"/> <function name="NMClientAddActivateFn ()" link="NMClient.html#NMClientAddActivateFn"/> @@ -488,5 +490,7 @@ <function name="nm_vpn_plugin_ui_widget_interface_get_widget ()" link="libnm-glib-NMVpnPluginUi.html#nm-vpn-plugin-ui-widget-interface-get-widget"/> <function name="nm_vpn_plugin_ui_widget_interface_update_connection ()" link="libnm-glib-NMVpnPluginUi.html#nm-vpn-plugin-ui-widget-interface-update-connection"/> <function name="nm_vpn_plugin_ui_widget_interface_save_secrets ()" link="libnm-glib-NMVpnPluginUi.html#nm-vpn-plugin-ui-widget-interface-save-secrets"/> + <function name="nm_vpn_plugin_utils_read_vpn_details ()" link="libnm-glib-nm-vpn-plugin-utils.html#nm-vpn-plugin-utils-read-vpn-details"/> + <function name="nm_vpn_plugin_utils_get_secret_flags ()" link="libnm-glib-nm-vpn-plugin-utils.html#nm-vpn-plugin-utils-get-secret-flags"/> </functions> </book> diff --git a/docs/libnm-glib/html/libnm-glib.devhelp2 b/docs/libnm-glib/html/libnm-glib.devhelp2 index a74fd6879..866602d81 100644 --- a/docs/libnm-glib/html/libnm-glib.devhelp2 +++ b/docs/libnm-glib/html/libnm-glib.devhelp2 @@ -26,6 +26,7 @@ <sub name="NMVPNConnection" link="NMVPNConnection.html"/> <sub name="NMVPNPlugin" link="libnm-glib-NMVPNPlugin.html"/> <sub name="NMVpnPluginUi" link="libnm-glib-NMVpnPluginUi.html"/> + <sub name="nm-vpn-plugin-utils" link="libnm-glib-nm-vpn-plugin-utils.html"/> </sub> <sub name="Object Hierarchy" link="object-tree.html"/> <sub name="API Index" link="api-index-full.html"/> @@ -50,6 +51,7 @@ <keyword type="function" name="nm_client_new ()" link="NMClient.html#nm-client-new"/> <keyword type="function" name="nm_client_get_devices ()" link="NMClient.html#nm-client-get-devices"/> <keyword type="function" name="nm_client_get_device_by_path ()" link="NMClient.html#nm-client-get-device-by-path"/> + <keyword type="function" name="nm_client_get_device_by_iface ()" link="NMClient.html#nm-client-get-device-by-iface"/> <keyword type="function" name="NMClientActivateFn ()" link="NMClient.html#NMClientActivateFn"/> <keyword type="function" name="nm_client_activate_connection ()" link="NMClient.html#nm-client-activate-connection"/> <keyword type="function" name="NMClientAddActivateFn ()" link="NMClient.html#NMClientAddActivateFn"/> @@ -488,6 +490,8 @@ <keyword type="function" name="nm_vpn_plugin_ui_widget_interface_get_widget ()" link="libnm-glib-NMVpnPluginUi.html#nm-vpn-plugin-ui-widget-interface-get-widget"/> <keyword type="function" name="nm_vpn_plugin_ui_widget_interface_update_connection ()" link="libnm-glib-NMVpnPluginUi.html#nm-vpn-plugin-ui-widget-interface-update-connection"/> <keyword type="function" name="nm_vpn_plugin_ui_widget_interface_save_secrets ()" link="libnm-glib-NMVpnPluginUi.html#nm-vpn-plugin-ui-widget-interface-save-secrets"/> + <keyword type="function" name="nm_vpn_plugin_utils_read_vpn_details ()" link="libnm-glib-nm-vpn-plugin-utils.html#nm-vpn-plugin-utils-read-vpn-details"/> + <keyword type="function" name="nm_vpn_plugin_utils_get_secret_flags ()" link="libnm-glib-nm-vpn-plugin-utils.html#nm-vpn-plugin-utils-get-secret-flags"/> <keyword type="constant" name="NM_REMOTE_SETTINGS_ERROR_UNKNOWN" link="NMRemoteSettings.html#NM-REMOTE-SETTINGS-ERROR-UNKNOWN:CAPS"/> <keyword type="constant" name="NM_REMOTE_SETTINGS_ERROR_CONNECTION_REMOVED" link="NMRemoteSettings.html#NM-REMOTE-SETTINGS-ERROR-CONNECTION-REMOVED:CAPS"/> <keyword type="constant" name="NM_REMOTE_SETTINGS_ERROR_CONNECTION_UNAVAILABLE" link="NMRemoteSettings.html#NM-REMOTE-SETTINGS-ERROR-CONNECTION-UNAVAILABLE:CAPS"/> diff --git a/docs/libnm-glib/html/object-tree.html b/docs/libnm-glib/html/object-tree.html index 6bcd8f422..db0f954be 100644 --- a/docs/libnm-glib/html/object-tree.html +++ b/docs/libnm-glib/html/object-tree.html @@ -6,14 +6,14 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="index.html" title="libnm-glib Reference Manual"> <link rel="up" href="index.html" title="libnm-glib Reference Manual"> -<link rel="prev" href="libnm-glib-NMVpnPluginUi.html" title="NMVpnPluginUi"> +<link rel="prev" href="libnm-glib-nm-vpn-plugin-utils.html" title="nm-vpn-plugin-utils"> <link rel="next" href="api-index-full.html" title="API Index"> <meta name="generator" content="GTK-Doc V1.17 (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="libnm-glib-NMVpnPluginUi.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="p" href="libnm-glib-nm-vpn-plugin-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td> </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> diff --git a/docs/libnm-glib/libnm-glib-docs.xml b/docs/libnm-glib/libnm-glib-docs.xml index 533010e15..92dad87cc 100644 --- a/docs/libnm-glib/libnm-glib-docs.xml +++ b/docs/libnm-glib/libnm-glib-docs.xml @@ -102,6 +102,7 @@ <xi:include href="xml/nm-vpn-connection.xml"/> <xi:include href="xml/nm-vpn-plugin.xml"/> <xi:include href="xml/nm-vpn-plugin-ui-interface.xml"/> + <xi:include href="xml/nm-vpn-plugin-utils.xml"/> </chapter> <chapter id="object-tree"> diff --git a/docs/libnm-glib/libnm-glib-sections.txt b/docs/libnm-glib/libnm-glib-sections.txt index 90733f9b2..b4475d2ff 100644 --- a/docs/libnm-glib/libnm-glib-sections.txt +++ b/docs/libnm-glib/libnm-glib-sections.txt @@ -530,6 +530,7 @@ NMClientClass nm_client_new nm_client_get_devices nm_client_get_device_by_path +nm_client_get_device_by_iface NMClientActivateFn nm_client_activate_connection NMClientAddActivateFn |