diff options
| author | Michael Biebl <biebl@debian.org> | 2015-05-05 17:48:57 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2015-05-05 17:48:57 +0200 |
| commit | f408e27bccfacf347605a8d98649975a68f38a17 (patch) | |
| tree | 654fd6695c31511baf919b1c0870d119a352ed75 /docs/libnm/html/NMVpnConnection.html | |
| parent | 2c032d8f1c6292c1338a615e6ec40252889ba85c (diff) | |
Imported Upstream version 1.0.2 upstream/1.0.2
Diffstat (limited to 'docs/libnm/html/NMVpnConnection.html')
| -rw-r--r-- | docs/libnm/html/NMVpnConnection.html | 330 |
1 files changed, 170 insertions, 160 deletions
diff --git a/docs/libnm/html/NMVpnConnection.html b/docs/libnm/html/NMVpnConnection.html index 33abdad9..e1e8ab62 100644 --- a/docs/libnm/html/NMVpnConnection.html +++ b/docs/libnm/html/NMVpnConnection.html @@ -2,38 +2,29 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMVpnConnection</title> +<title>libnm Reference Manual: NMVpnConnection</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="ch04.html" title="Device and Runtime Configuration API Reference"> <link rel="prev" href="NMActiveConnection.html" title="NMActiveConnection"> <link rel="next" href="NMRemoteConnection.html" title="NMRemoteConnection"> -<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.21 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="NMActiveConnection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch04.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="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="#NMVpnConnection.synopsis" class="shortcut">Top</a> - | - <a href="#NMVpnConnection.description" class="shortcut">Description</a> - | - <a href="#NMVpnConnection.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMVpnConnection.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#NMVpnConnection.properties" class="shortcut">Properties</a> - | - <a href="#NMVpnConnection.signals" class="shortcut">Signals</a> -</td></tr> -</table> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#NMVpnConnection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMVpnConnection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMVpnConnection.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#NMVpnConnection.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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="NMActiveConnection.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> <div class="refentry"> <a name="NMVpnConnection"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -41,44 +32,97 @@ <h2><span class="refentrytitle"><a name="NMVpnConnection.top_of_page"></a>NMVpnConnection</span></h2> <p>NMVpnConnection</p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> -<a name="NMVpnConnection.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis">#define <a class="link" href="NMVpnConnection.html#NM-VPN-CONNECTION-VPN-STATE:CAPS" title="NM_VPN_CONNECTION_VPN_STATE">NM_VPN_CONNECTION_VPN_STATE</a> -#define <a class="link" href="NMVpnConnection.html#NM-VPN-CONNECTION-BANNER:CAPS" title="NM_VPN_CONNECTION_BANNER">NM_VPN_CONNECTION_BANNER</a> -struct <a class="link" href="NMVpnConnection.html#NMVpnConnection-struct" title="struct NMVpnConnection">NMVpnConnection</a>; - <a class="link" href="NMVpnConnection.html#NMVpnConnectionClass" title="NMVpnConnectionClass">NMVpnConnectionClass</a>; -<a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState"><span class="returnvalue">NMVpnConnectionState</span></a> <a class="link" href="NMVpnConnection.html#nm-vpn-connection-get-vpn-state" title="nm_vpn_connection_get_vpn_state ()">nm_vpn_connection_get_vpn_state</a> (<em class="parameter"><code><a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *vpn</code></em>); -const <span class="returnvalue">char</span> * <a class="link" href="NMVpnConnection.html#nm-vpn-connection-get-banner" title="nm_vpn_connection_get_banner ()">nm_vpn_connection_get_banner</a> (<em class="parameter"><code><a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *vpn</code></em>); -</pre> +<div class="refsect1"> +<a name="NMVpnConnection.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 class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState" title="enum NMVpnConnectionState"><span class="returnvalue">NMVpnConnectionState</span></a> +</td> +<td class="function_name"> +<a class="link" href="NMVpnConnection.html#nm-vpn-connection-get-vpn-state" title="nm_vpn_connection_get_vpn_state ()">nm_vpn_connection_get_vpn_state</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="NMVpnConnection.html#nm-vpn-connection-get-banner" title="nm_vpn_connection_get_banner ()">nm_vpn_connection_get_banner</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMVpnConnection.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> - +----<a class="link" href="NMObject.html" title="NMObject">NMObject</a> - +----<a class="link" href="NMActiveConnection.html" title="NMActiveConnection">NMActiveConnection</a> - +----NMVpnConnection -</pre> +<a name="NMVpnConnection.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<span class="type">gchar</span> *</td> +<td class="property_name"><a class="link" href="NMVpnConnection.html#NMVpnConnection--banner" title="The “banner” property">banner</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState" title="enum NMVpnConnectionState"><span class="type">NMVpnConnectionState</span></a></td> +<td class="property_name"><a class="link" href="NMVpnConnection.html#NMVpnConnection--vpn-state" title="The “vpn-state” property">vpn-state</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMVpnConnection.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -NMVpnConnection implements - <a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.</p> +<a name="NMVpnConnection.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="NMVpnConnection.html#NMVpnConnection-vpn-state-changed" title="The “vpn-state-changed” signal">vpn-state-changed</a></td> +<td class="signal_flags">Run First</td> +</tr></tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMVpnConnection.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMVpnConnection.html#NMVpnConnection--banner" title='The "banner" property'>banner</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read - "<a class="link" href="NMVpnConnection.html#NMVpnConnection--vpn-state" title='The "vpn-state" property'>vpn-state</a>" <a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState"><span class="type">NMVpnConnectionState</span></a> : Read -</pre> +<a name="NMVpnConnection.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMVpnConnection.html#NM-VPN-CONNECTION-VPN-STATE:CAPS" title="NM_VPN_CONNECTION_VPN_STATE">NM_VPN_CONNECTION_VPN_STATE</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMVpnConnection.html#NM-VPN-CONNECTION-BANNER:CAPS" title="NM_VPN_CONNECTION_BANNER">NM_VPN_CONNECTION_BANNER</a></td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMVpnConnection.signals"></a><h2>Signals</h2> -<pre class="synopsis"> - "<a class="link" href="NMVpnConnection.html#NMVpnConnection-vpn-state-changed" title='The "vpn-state-changed" signal'>vpn-state-changed</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> +<a name="NMVpnConnection.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> + <span class="lineart">╰──</span> <a class="link" href="NMActiveConnection.html" title="NMActiveConnection">NMActiveConnection</a> + <span class="lineart">╰──</span> NMVpnConnection </pre> </div> <div class="refsect1"> @@ -87,147 +131,113 @@ NMVpnConnection implements </p> </div> <div class="refsect1"> -<a name="NMVpnConnection.details"></a><h2>Details</h2> +<a name="NMVpnConnection.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="NM-VPN-CONNECTION-VPN-STATE:CAPS"></a><h3>NM_VPN_CONNECTION_VPN_STATE</h3> -<pre class="programlisting">#define NM_VPN_CONNECTION_VPN_STATE "vpn-state" -</pre> -<p> -</p> +<a name="nm-vpn-connection-get-vpn-state"></a><h3>nm_vpn_connection_get_vpn_state ()</h3> +<pre class="programlisting"><a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState" title="enum NMVpnConnectionState"><span class="returnvalue">NMVpnConnectionState</span></a> +nm_vpn_connection_get_vpn_state (<em class="parameter"><code><a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *vpn</code></em>);</pre> +<p>Gets the current <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> state.</p> +<div class="refsect3"> +<a name="id-1.5.17.9.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>vpn</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.5.17.9.2.6"></a><h4>Returns</h4> +<p> the VPN state of the active VPN connection.</p> +<p></p> </div> -<hr> -<div class="refsect2"> -<a name="NM-VPN-CONNECTION-BANNER:CAPS"></a><h3>NM_VPN_CONNECTION_BANNER</h3> -<pre class="programlisting">#define NM_VPN_CONNECTION_BANNER "banner" -</pre> -<p> -</p> </div> <hr> <div class="refsect2"> -<a name="NMVpnConnection-struct"></a><h3>struct NMVpnConnection</h3> -<pre class="programlisting">struct NMVpnConnection;</pre> -<p> -</p> +<a name="nm-vpn-connection-get-banner"></a><h3>nm_vpn_connection_get_banner ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_vpn_connection_get_banner (<em class="parameter"><code><a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *vpn</code></em>);</pre> +<p>Gets the VPN login banner of the active <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a>.</p> +<div class="refsect3"> +<a name="id-1.5.17.9.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>vpn</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> </div> -<hr> +<div class="refsect3"> +<a name="id-1.5.17.9.3.6"></a><h4>Returns</h4> +<p> the VPN login banner of the VPN connection. This is the internal +string used by the connection, and must not be modified.</p> +<p></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="NMVpnConnection.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> -<a name="NMVpnConnectionClass"></a><h3>NMVpnConnectionClass</h3> -<pre class="programlisting">typedef struct { - NMActiveConnectionClass parent; - - /* Signals */ - void (*vpn_state_changed) (NMVpnConnection *connection, - NMVpnConnectionState state, - NMVpnConnectionStateReason reason); -} NMVpnConnectionClass; +<a name="NM-VPN-CONNECTION-VPN-STATE:CAPS"></a><h3>NM_VPN_CONNECTION_VPN_STATE</h3> +<pre class="programlisting">#define NM_VPN_CONNECTION_VPN_STATE "vpn-state" </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="nm-vpn-connection-get-vpn-state"></a><h3>nm_vpn_connection_get_vpn_state ()</h3> -<pre class="programlisting"><a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState"><span class="returnvalue">NMVpnConnectionState</span></a> nm_vpn_connection_get_vpn_state (<em class="parameter"><code><a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *vpn</code></em>);</pre> -<p> -Gets the current <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> state. -</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>vpn</code></em> :</span></p></td> -<td>a <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the VPN state of the active VPN connection.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-vpn-connection-get-banner"></a><h3>nm_vpn_connection_get_banner ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_vpn_connection_get_banner (<em class="parameter"><code><a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *vpn</code></em>);</pre> +<a name="NM-VPN-CONNECTION-BANNER:CAPS"></a><h3>NM_VPN_CONNECTION_BANNER</h3> +<pre class="programlisting">#define NM_VPN_CONNECTION_BANNER "banner" +</pre> <p> -Gets the VPN login banner of the active <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</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>vpn</code></em> :</span></p></td> -<td>a <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the VPN login banner of the VPN connection. This is the internal -string used by the connection, and must not be modified.</td> -</tr> -</tbody> -</table></div> </div> </div> <div class="refsect1"> <a name="NMVpnConnection.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NMVpnConnection--banner"></a><h3>The <code class="literal">"banner"</code> property</h3> -<pre class="programlisting"> "banner" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> -<p> -The VPN login banner of the active VPN connection. -</p> +<a name="NMVpnConnection--banner"></a><h3>The <code class="literal">“banner”</code> property</h3> +<pre class="programlisting"> “banner” <span class="type">gchar</span> *</pre> +<p></p> +<p>Flags: Read</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2"> -<a name="NMVpnConnection--vpn-state"></a><h3>The <code class="literal">"vpn-state"</code> property</h3> -<pre class="programlisting"> "vpn-state" <a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState"><span class="type">NMVpnConnectionState</span></a> : Read</pre> -<p> -The VPN state of the active VPN connection. -</p> +<a name="NMVpnConnection--vpn-state"></a><h3>The <code class="literal">“vpn-state”</code> property</h3> +<pre class="programlisting"> “vpn-state” <a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState" title="enum NMVpnConnectionState"><span class="type">NMVpnConnectionState</span></a></pre> +<p></p> +<p>Flags: Read</p> <p>Default value: NM_VPN_CONNECTION_STATE_UNKNOWN</p> </div> </div> <div class="refsect1"> <a name="NMVpnConnection.signal-details"></a><h2>Signal Details</h2> <div class="refsect2"> -<a name="NMVpnConnection-vpn-state-changed"></a><h3>The <code class="literal">"vpn-state-changed"</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *nmvpnconnection, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg1, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg2, - <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> -</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>nmvpnconnection</code></em> :</span></p></td> -<td>the object which received the signal.</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> +<a name="NMVpnConnection-vpn-state-changed"></a><h3>The <code class="literal">“vpn-state-changed”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *nmvpnconnection, + <span class="type">guint</span> arg1, + <span class="type">guint</span> arg2, + <span class="type">gpointer</span> user_data)</pre> +<p>Flags: Run First</p> </div> </div> </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.19</div> + Generated by GTK-Doc V1.21</div> </body> </html> \ No newline at end of file |