diff options
Diffstat (limited to 'docs/libnm/html/libnm-NMVpnEditorPlugin.html')
| -rw-r--r-- | docs/libnm/html/libnm-NMVpnEditorPlugin.html | 382 |
1 files changed, 382 insertions, 0 deletions
diff --git a/docs/libnm/html/libnm-NMVpnEditorPlugin.html b/docs/libnm/html/libnm-NMVpnEditorPlugin.html new file mode 100644 index 00000000..1cfdb8e6 --- /dev/null +++ b/docs/libnm/html/libnm-NMVpnEditorPlugin.html @@ -0,0 +1,382 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMVpnEditorPlugin</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="ch06.html" title="VPN Plugin API Reference"> +<link rel="prev" href="libnm-nm-vpn-dbus-interface.html" title="nm-vpn-dbus-interface"> +<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libnm-nm-vpn-dbus-interface.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch06.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="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-NMVpnEditorPlugin.synopsis" class="shortcut">Top</a> + | + <a href="#libnm-NMVpnEditorPlugin.description" class="shortcut">Description</a> + | + <a href="#libnm-NMVpnEditorPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="libnm-NMVpnEditorPlugin"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libnm-NMVpnEditorPlugin.top_of_page"></a>NMVpnEditorPlugin</span></h2> +<p>NMVpnEditorPlugin</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="libnm-NMVpnEditorPlugin.synopsis"></a><h2>Synopsis</h2> +<a name="NMVpnEditorPluginCapability"></a><pre class="synopsis"><span class="returnvalue">NMVpnEditorPlugin</span> * (<a class="link" href="libnm-NMVpnEditorPlugin.html#NMVpnEditorPluginFactory" title="NMVpnEditorPluginFactory ()">*NMVpnEditorPluginFactory</a>) (<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>); +<span class="returnvalue">NMVpnEditorPlugin</span> * <a class="link" href="libnm-NMVpnEditorPlugin.html#nm-vpn-editor-plugin-factory" title="nm_vpn_editor_plugin_factory ()">nm_vpn_editor_plugin_factory</a> (<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>); +enum <a class="link" href="libnm-NMVpnEditorPlugin.html#NMVpnEditorPluginCapability-enum" title="enum NMVpnEditorPluginCapability">NMVpnEditorPluginCapability</a>; +#define <a class="link" href="libnm-NMVpnEditorPlugin.html#NM-VPN-EDITOR-PLUGIN-NAME:CAPS" title="NM_VPN_EDITOR_PLUGIN_NAME">NM_VPN_EDITOR_PLUGIN_NAME</a> +#define <a class="link" href="libnm-NMVpnEditorPlugin.html#NM-VPN-EDITOR-PLUGIN-DESCRIPTION:CAPS" title="NM_VPN_EDITOR_PLUGIN_DESCRIPTION">NM_VPN_EDITOR_PLUGIN_DESCRIPTION</a> +#define <a class="link" href="libnm-NMVpnEditorPlugin.html#NM-VPN-EDITOR-PLUGIN-SERVICE:CAPS" title="NM_VPN_EDITOR_PLUGIN_SERVICE">NM_VPN_EDITOR_PLUGIN_SERVICE</a> + <a class="link" href="libnm-NMVpnEditorPlugin.html#NMVpnEditorPluginInterface" title="NMVpnEditorPluginInterface">NMVpnEditorPluginInterface</a>; +<span class="returnvalue">NMVpnEditor</span> * <a class="link" href="libnm-NMVpnEditorPlugin.html#nm-vpn-editor-plugin-get-editor" title="nm_vpn_editor_plugin_get_editor ()">nm_vpn_editor_plugin_get_editor</a> (<em class="parameter"><code><span class="type">NMVpnEditorPlugin</span> *plugin</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *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>); +<a class="link" href="libnm-NMVpnEditorPlugin.html#NMVpnEditorPluginCapability"><span class="returnvalue">NMVpnEditorPluginCapability</span></a> <a class="link" href="libnm-NMVpnEditorPlugin.html#nm-vpn-editor-plugin-get-capabilities" title="nm_vpn_editor_plugin_get_capabilities ()">nm_vpn_editor_plugin_get_capabilities</a> + (<em class="parameter"><code><span class="type">NMVpnEditorPlugin</span> *plugin</code></em>); +<a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="returnvalue">NMConnection</span></a> * <a class="link" href="libnm-NMVpnEditorPlugin.html#nm-vpn-editor-plugin-import" title="nm_vpn_editor_plugin_import ()">nm_vpn_editor_plugin_import</a> (<em class="parameter"><code><span class="type">NMVpnEditorPlugin</span> *plugin</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</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>); +<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-NMVpnEditorPlugin.html#nm-vpn-editor-plugin-export" title="nm_vpn_editor_plugin_export ()">nm_vpn_editor_plugin_export</a> (<em class="parameter"><code><span class="type">NMVpnEditorPlugin</span> *plugin</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *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>); +<span class="returnvalue">char</span> * <a class="link" href="libnm-NMVpnEditorPlugin.html#nm-vpn-editor-plugin-get-suggested-filename" title="nm_vpn_editor_plugin_get_suggested_filename ()">nm_vpn_editor_plugin_get_suggested_filename</a> + (<em class="parameter"><code><span class="type">NMVpnEditorPlugin</span> *plugin</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>); + <a class="link" href="libnm-NMVpnEditorPlugin.html#NMVpnEditorInterface" title="NMVpnEditorInterface">NMVpnEditorInterface</a>; +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * <a class="link" href="libnm-NMVpnEditorPlugin.html#nm-vpn-editor-get-widget" title="nm_vpn_editor_get_widget ()">nm_vpn_editor_get_widget</a> (<em class="parameter"><code><span class="type">NMVpnEditor</span> *editor</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-NMVpnEditorPlugin.html#nm-vpn-editor-update-connection" title="nm_vpn_editor_update_connection ()">nm_vpn_editor_update_connection</a> (<em class="parameter"><code><span class="type">NMVpnEditor</span> *editor</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *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>); +</pre> +</div> +<div class="refsect1"> +<a name="libnm-NMVpnEditorPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GFlags + +----NMVpnEditorPluginCapability +</pre> +</div> +<div class="refsect1"> +<a name="libnm-NMVpnEditorPlugin.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1"> +<a name="libnm-NMVpnEditorPlugin.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NMVpnEditorPluginFactory"></a><h3>NMVpnEditorPluginFactory ()</h3> +<pre class="programlisting"><span class="returnvalue">NMVpnEditorPlugin</span> * (*NMVpnEditorPluginFactory) (<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>);</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-vpn-editor-plugin-factory"></a><h3>nm_vpn_editor_plugin_factory ()</h3> +<pre class="programlisting"><span class="returnvalue">NMVpnEditorPlugin</span> * nm_vpn_editor_plugin_factory (<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>);</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMVpnEditorPluginCapability-enum"></a><h3>enum NMVpnEditorPluginCapability</h3> +<pre class="programlisting">typedef enum { + NM_VPN_EDITOR_PLUGIN_CAPABILITY_NONE = 0x00, + NM_VPN_EDITOR_PLUGIN_CAPABILITY_IMPORT = 0x01, + NM_VPN_EDITOR_PLUGIN_CAPABILITY_EXPORT = 0x02, + NM_VPN_EDITOR_PLUGIN_CAPABILITY_IPV6 = 0x04 +} NMVpnEditorPluginCapability; +</pre> +<p> +Flags that indicate certain capabilities of the plugin to editor programs. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><a name="NM-VPN-EDITOR-PLUGIN-CAPABILITY-NONE:CAPS"></a><span class="term"><code class="literal">NM_VPN_EDITOR_PLUGIN_CAPABILITY_NONE</code></span></p></td> +<td>unknown or no capability +</td> +</tr> +<tr> +<td><p><a name="NM-VPN-EDITOR-PLUGIN-CAPABILITY-IMPORT:CAPS"></a><span class="term"><code class="literal">NM_VPN_EDITOR_PLUGIN_CAPABILITY_IMPORT</code></span></p></td> +<td>the plugin can import new connections +</td> +</tr> +<tr> +<td><p><a name="NM-VPN-EDITOR-PLUGIN-CAPABILITY-EXPORT:CAPS"></a><span class="term"><code class="literal">NM_VPN_EDITOR_PLUGIN_CAPABILITY_EXPORT</code></span></p></td> +<td>the plugin can export connections +</td> +</tr> +<tr> +<td><p><a name="NM-VPN-EDITOR-PLUGIN-CAPABILITY-IPV6:CAPS"></a><span class="term"><code class="literal">NM_VPN_EDITOR_PLUGIN_CAPABILITY_IPV6</code></span></p></td> +<td>the plugin supports IPv6 addressing +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="NM-VPN-EDITOR-PLUGIN-NAME:CAPS"></a><h3>NM_VPN_EDITOR_PLUGIN_NAME</h3> +<pre class="programlisting">#define NM_VPN_EDITOR_PLUGIN_NAME "name" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-VPN-EDITOR-PLUGIN-DESCRIPTION:CAPS"></a><h3>NM_VPN_EDITOR_PLUGIN_DESCRIPTION</h3> +<pre class="programlisting">#define NM_VPN_EDITOR_PLUGIN_DESCRIPTION "description" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-VPN-EDITOR-PLUGIN-SERVICE:CAPS"></a><h3>NM_VPN_EDITOR_PLUGIN_SERVICE</h3> +<pre class="programlisting">#define NM_VPN_EDITOR_PLUGIN_SERVICE "service" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMVpnEditorPluginInterface"></a><h3>NMVpnEditorPluginInterface</h3> +<pre class="programlisting">typedef struct { + GTypeInterface g_iface; + + NMVpnEditor * (*get_editor) (NMVpnEditorPlugin *plugin, + NMConnection *connection, + GError **error); + + NMVpnEditorPluginCapability (*get_capabilities) (NMVpnEditorPlugin *plugin); + + NMConnection * (*import_from_file) (NMVpnEditorPlugin *plugin, + const char *path, + GError **error); + + gboolean (*export_to_file) (NMVpnEditorPlugin *plugin, + const char *path, + NMConnection *connection, + GError **error); + + char * (*get_suggested_filename) (NMVpnEditorPlugin *plugin, NMConnection *connection); +} NMVpnEditorPluginInterface; +</pre> +<p> +Interface for VPN editor plugins. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="NMVpnEditorPluginInterface.g-iface"></a>g_iface</code></em>;</span></p></td> +<td>the parent interface</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="NMVpnEditorPluginInterface.get-editor"></a>get_editor</code></em> ()</span></p></td> +<td>returns an <span class="type">NMVpnEditor</span>, pre-filled with values from <em class="parameter"><code>connection</code></em> +if non-<a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="NMVpnEditorPluginInterface.get-capabilities"></a>get_capabilities</code></em> ()</span></p></td> +<td>returns a bitmask of capabilities.</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="NMVpnEditorPluginInterface.import-from-file"></a>import_from_file</code></em> ()</span></p></td> +<td>Try to import a connection from the specified path. On +success, return a partial <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> object. On error, return <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> and +set <em class="parameter"><code>error</code></em> with additional information. Note that <em class="parameter"><code>error</code></em> can be <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, in +which case no additional error information should be provided.</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="NMVpnEditorPluginInterface.export-to-file"></a>export_to_file</code></em> ()</span></p></td> +<td>Export the given connection to the specified path. Return +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success. On error, return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set <em class="parameter"><code>error</code></em> with additional +error information. Note that <em class="parameter"><code>error</code></em> can be <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, in which case no +additional error information should be provided.</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="NMVpnEditorPluginInterface.get-suggested-filename"></a>get_suggested_filename</code></em> ()</span></p></td> +<td>For a given connection, return a suggested file +name. Returned value will be <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> or a suggested file name to be freed by +the caller.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-vpn-editor-plugin-get-editor"></a><h3>nm_vpn_editor_plugin_get_editor ()</h3> +<pre class="programlisting"><span class="returnvalue">NMVpnEditor</span> * nm_vpn_editor_plugin_get_editor (<em class="parameter"><code><span class="type">NMVpnEditorPlugin</span> *plugin</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *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>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-vpn-editor-plugin-get-capabilities"></a><h3>nm_vpn_editor_plugin_get_capabilities ()</h3> +<pre class="programlisting"><a class="link" href="libnm-NMVpnEditorPlugin.html#NMVpnEditorPluginCapability"><span class="returnvalue">NMVpnEditorPluginCapability</span></a> nm_vpn_editor_plugin_get_capabilities + (<em class="parameter"><code><span class="type">NMVpnEditorPlugin</span> *plugin</code></em>);</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-vpn-editor-plugin-import"></a><h3>nm_vpn_editor_plugin_import ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="returnvalue">NMConnection</span></a> * nm_vpn_editor_plugin_import (<em class="parameter"><code><span class="type">NMVpnEditorPlugin</span> *plugin</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</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>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-vpn-editor-plugin-export"></a><h3>nm_vpn_editor_plugin_export ()</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_editor_plugin_export (<em class="parameter"><code><span class="type">NMVpnEditorPlugin</span> *plugin</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *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>);</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-vpn-editor-plugin-get-suggested-filename"></a><h3>nm_vpn_editor_plugin_get_suggested_filename ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * nm_vpn_editor_plugin_get_suggested_filename + (<em class="parameter"><code><span class="type">NMVpnEditorPlugin</span> *plugin</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMVpnEditorInterface"></a><h3>NMVpnEditorInterface</h3> +<pre class="programlisting">typedef struct { + GTypeInterface g_iface; + + GObject * (*get_widget) (NMVpnEditor *editor); + + void (*placeholder) (void); + + gboolean (*update_connection) (NMVpnEditor *editor, + NMConnection *connection, + GError **error); + + void (*changed) (NMVpnEditor *editor); +} NMVpnEditorInterface; +</pre> +<p> +Interface for editing a specific <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</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"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="NMVpnEditorInterface.g-iface"></a>g_iface</code></em>;</span></p></td> +<td>the parent interface</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="NMVpnEditorInterface.get-widget"></a>get_widget</code></em> ()</span></p></td> +<td>return the <a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> for the VPN editor's UI</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="NMVpnEditorInterface.placeholder"></a>placeholder</code></em> ()</span></p></td> +<td>not currently used</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="NMVpnEditorInterface.update-connection"></a>update_connection</code></em> ()</span></p></td> +<td>called to save the user-entered options to the connection +object. Should return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set <em class="parameter"><code>error</code></em> if the current options are +invalid. <em class="parameter"><code>error</code></em> should contain enough information for the plugin to +determine which UI widget is invalid at a later point in time. For +example, creating unique error codes for what error occurred and populating +the message field of <em class="parameter"><code>error</code></em> with the name of the invalid property.</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="NMVpnEditorInterface.changed"></a>changed</code></em> ()</span></p></td> +<td>emitted when the value of a UI widget changes. May trigger a +validity check via <em class="parameter"><code>update_connection</code></em> to write values to the connection.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-vpn-editor-get-widget"></a><h3>nm_vpn_editor_get_widget ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * nm_vpn_editor_get_widget (<em class="parameter"><code><span class="type">NMVpnEditor</span> *editor</code></em>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>. <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-vpn-editor-update-connection"></a><h3>nm_vpn_editor_update_connection ()</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_editor_update_connection (<em class="parameter"><code><span class="type">NMVpnEditor</span> *editor</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *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>);</pre> +<p> +</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html> \ No newline at end of file |