diff options
Diffstat (limited to 'docs/libnm/html/NMVpnEditorPlugin.html')
| -rw-r--r-- | docs/libnm/html/NMVpnEditorPlugin.html | 133 |
1 files changed, 95 insertions, 38 deletions
diff --git a/docs/libnm/html/NMVpnEditorPlugin.html b/docs/libnm/html/NMVpnEditorPlugin.html index 61c3c4a4..126ddb6f 100644 --- a/docs/libnm/html/NMVpnEditorPlugin.html +++ b/docs/libnm/html/NMVpnEditorPlugin.html @@ -77,7 +77,7 @@ </tr> <tr> <td class="function_type"> -<a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="returnvalue">NMConnection</span></a> * +<span class="returnvalue">NMConnection</span> * </td> <td class="function_name"> <a class="link" href="NMVpnEditorPlugin.html#nm-vpn-editor-plugin-import" title="nm_vpn_editor_plugin_import ()">nm_vpn_editor_plugin_import</a> <span class="c_punctuation">()</span> @@ -85,7 +85,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">gboolean</span> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="NMVpnEditorPlugin.html#nm-vpn-editor-plugin-export" title="nm_vpn_editor_plugin_export ()">nm_vpn_editor_plugin_export</a> <span class="c_punctuation">()</span> @@ -121,19 +121,19 @@ <tbody> <tr> <td class="property_type"> -<span class="type">gchar</span> *</td> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> <td class="property_name"><a class="link" href="NMVpnEditorPlugin.html#NMVpnEditorPlugin--description" title="The “description” property">description</a></td> <td class="property_flags">Read</td> </tr> <tr> <td class="property_type"> -<span class="type">gchar</span> *</td> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> <td class="property_name"><a class="link" href="NMVpnEditorPlugin.html#NMVpnEditorPlugin--name" title="The “name” property">name</a></td> <td class="property_flags">Read</td> </tr> <tr> <td class="property_type"> -<span class="type">gchar</span> *</td> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> <td class="property_name"><a class="link" href="NMVpnEditorPlugin.html#NMVpnEditorPlugin--service" title="The “service” property">service</a></td> <td class="property_flags">Read</td> </tr> @@ -151,7 +151,7 @@ <tbody><tr> <td class="signal_type"><span class="returnvalue">void</span></td> <td class="signal_name"><a class="link" href="NMVpnEditorPlugin.html#NMVpnEditor-changed" title="The “changed” signal">changed</a></td> -<td class="signal_flags">Run First</td> +<td class="signal_flags"><a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> </tr></tbody> </table></div> </div> @@ -192,9 +192,9 @@ </div> <div class="refsect1"> <a name="NMVpnEditorPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> +<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html">GFlags</a> <span class="lineart">╰──</span> NMVpnEditorPluginCapability - <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a> + <a href="https://developer.gnome.org/gobject/unstable/GTypeModule.html">GInterface</a> <span class="lineart">├──</span> NMVpnEditor <span class="lineart">╰──</span> NMVpnEditorPlugin </pre> @@ -203,7 +203,7 @@ <a name="NMVpnEditorPlugin.prerequisites"></a><h2>Prerequisites</h2> <p> NMVpnEditor requires - GObject.</p> + <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p> </div> <div class="refsect1"> <a name="NMVpnEditorPlugin.description"></a><h2>Description</h2> @@ -213,24 +213,51 @@ NMVpnEditor requires <div class="refsect2"> <a name="NMVpnEditorPluginFactory"></a><h3>NMVpnEditorPluginFactory ()</h3> <pre class="programlisting"><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="returnvalue">NMVpnEditorPlugin</span></a> * -<span class="c_punctuation">(</span>*NMVpnEditorPluginFactory<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<span class="c_punctuation">(</span>*NMVpnEditorPluginFactory<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> </div> <hr> <div class="refsect2"> <a name="nm-vpn-editor-plugin-factory"></a><h3>nm_vpn_editor_plugin_factory ()</h3> <pre class="programlisting"><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="returnvalue">NMVpnEditorPlugin</span></a> * -nm_vpn_editor_plugin_factory (<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +nm_vpn_editor_plugin_factory (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> </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"><a class="link" href="NMVpnEditorPlugin.html#NMVpnEditor"><span class="returnvalue">NMVpnEditor</span></a> * nm_vpn_editor_plugin_get_editor (<em class="parameter"><code><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> *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><span class="type">GError</span> **error</code></em>);</pre> + <em class="parameter"><code><span class="type">NMConnection</span> *connection</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> <div class="refsect3"> -<a name="id-1.7.3.11.4.4"></a><h4>Returns</h4> -<p>. </p> +<a name="id-1.7.3.11.4.4"></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>plugin</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>connection</p></td> +<td class="parameter_description"><p>the <span class="type">NMConnection</span> to be edited</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>on return, an error or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.7.3.11.4.5"></a><h4>Returns</h4> +<p> a new <a class="link" href="NMVpnEditorPlugin.html#NMVpnEditor"><span class="type">NMVpnEditor</span></a> or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> </div> @@ -243,24 +270,54 @@ nm_vpn_editor_plugin_get_capabilities (<em class="parameter"><code><a class="lin <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> * +<pre class="programlisting"><span class="returnvalue">NMConnection</span> * nm_vpn_editor_plugin_import (<em class="parameter"><code><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> *plugin</code></em>, <em class="parameter"><code>const <span class="type">char</span> *path</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.7.3.11.6.4"></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>plugin</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>path</p></td> +<td class="parameter_description"><p>full path to the file to attempt to read into a new <span class="type">NMConnection</span></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>on return, an error or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> <div class="refsect3"> -<a name="id-1.7.3.11.6.4"></a><h4>Returns</h4> -<p>. </p> +<a name="id-1.7.3.11.6.5"></a><h4>Returns</h4> +<p> a new <span class="type">NMConnection</span> imported from <em class="parameter"><code>path</code></em> +, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> +on error or if the file at <em class="parameter"><code>path</code></em> +was not recognized by this plugin. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> </div> <hr> <div class="refsect2"> <a name="nm-vpn-editor-plugin-export"></a><h3>nm_vpn_editor_plugin_export ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_vpn_editor_plugin_export (<em class="parameter"><code><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> *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><span class="type">GError</span> **error</code></em>);</pre> + <em class="parameter"><code><span class="type">NMConnection</span> *connection</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> </div> <hr> <div class="refsect2"> @@ -268,7 +325,7 @@ nm_vpn_editor_plugin_export (<em class="parameter"><code><a class="link" href="N <pre class="programlisting"><span class="returnvalue">char</span> * nm_vpn_editor_plugin_get_suggested_filename (<em class="parameter"><code><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> *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> + <em class="parameter"><code><span class="type">NMConnection</span> *connection</code></em>);</pre> </div> <hr> <div class="refsect2"> @@ -278,8 +335,8 @@ nm_vpn_editor_plugin_load_from_file (<em class="parameter"><code>const <span cla <em class="parameter"><code>const <span class="type">char</span> *check_service</code></em>, <em class="parameter"><code><span class="type">int</span> check_owner</code></em>, <em class="parameter"><code><a class="link" href="libnm-nm-utils.html#NMUtilsCheckFilePredicate" title="NMUtilsCheckFilePredicate ()"><span class="type">NMUtilsCheckFilePredicate</span></a> check_file</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> <p>Load the shared libary <em class="parameter"><code>plugin_filename</code></em> and create a new <a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> instace via the <a class="link" href="NMVpnEditorPlugin.html#NMVpnEditorPluginFactory" title="NMVpnEditorPluginFactory ()"><span class="type">NMVpnEditorPluginFactory</span></a> @@ -340,7 +397,7 @@ loading the shared library. </p></td> </div> <div class="refsect3"> <a name="id-1.7.3.11.9.6"></a><h4>Returns</h4> -<p> a new plugin instance or <code class="literal">NULL</code> on error. </p> +<p> a new plugin instance or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: 1.2</p> @@ -445,14 +502,14 @@ loading the shared library. </p></td> </colgroup> <tbody> <tr> -<td class="struct_member_name"><p><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="NMVpnEditorPluginInterface.g-iface"></a>g_iface</code></em>;</p></td> +<td class="struct_member_name"><p><a href="https://developer.gnome.org/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>;</p></td> <td class="struct_member_description"><p>the parent interface</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="NMVpnEditorPluginInterface.get-editor"></a>get_editor</code></em> ()</p></td> <td class="struct_member_description"><p>returns an <a class="link" href="NMVpnEditorPlugin.html#NMVpnEditor"><span class="type">NMVpnEditor</span></a>, pre-filled with values from <em class="parameter"><code>connection</code></em> -if non-<code class="literal">NULL</code>.</p></td> +if non-<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> @@ -463,27 +520,27 @@ if non-<code class="literal">NULL</code>.</p></td> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="NMVpnEditorPluginInterface.import-from-file"></a>import_from_file</code></em> ()</p></td> <td class="struct_member_description"><p>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 <code class="literal">NULL</code> and +success, return a partial <span class="type">NMConnection</span> object. On error, return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.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 <code class="literal">NULL</code>, in +can be <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, in which case no additional error information should be provided.</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="NMVpnEditorPluginInterface.export-to-file"></a>export_to_file</code></em> ()</p></td> <td class="struct_member_description"><p>Export the given connection to the specified path. Return -<code class="literal">TRUE</code> on success. On error, return <code class="literal">FALSE</code> and set <em class="parameter"><code>error</code></em> +<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success. On error, return <a href="https://developer.gnome.org/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 <code class="literal">NULL</code>, in which case no +can be <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, in which case no additional error information should be provided.</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="NMVpnEditorPluginInterface.get-suggested-filename"></a>get_suggested_filename</code></em> ()</p></td> <td class="struct_member_description"><p>For a given connection, return a suggested file -name. Returned value will be <code class="literal">NULL</code> or a suggested file name to be freed by +name. Returned value will be <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or a suggested file name to be freed by the caller.</p></td> <td class="struct_member_annotations"> </td> </tr> @@ -501,7 +558,7 @@ the caller.</p></td> <a name="NMVpnEditorPlugin.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="NMVpnEditorPlugin--description"></a><h3>The <code class="literal">“description”</code> property</h3> -<pre class="programlisting"> “description” <span class="type">gchar</span> *</pre> +<pre class="programlisting"> “description” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> <p>Longer description of the VPN plugin.</p> <p>Flags: Read</p> <p>Default value: NULL</p> @@ -509,7 +566,7 @@ the caller.</p></td> <hr> <div class="refsect2"> <a name="NMVpnEditorPlugin--name"></a><h3>The <code class="literal">“name”</code> property</h3> -<pre class="programlisting"> “name” <span class="type">gchar</span> *</pre> +<pre class="programlisting"> “name” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> <p>Short display name of the VPN plugin.</p> <p>Flags: Read</p> <p>Default value: NULL</p> @@ -517,7 +574,7 @@ the caller.</p></td> <hr> <div class="refsect2"> <a name="NMVpnEditorPlugin--service"></a><h3>The <code class="literal">“service”</code> property</h3> -<pre class="programlisting"> “service” <span class="type">gchar</span> *</pre> +<pre class="programlisting"> “service” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> <p>D-Bus service name of the plugin's VPN service.</p> <p>Flags: Read</p> <p>Default value: NULL</p> @@ -529,8 +586,8 @@ the caller.</p></td> <a name="NMVpnEditor-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="NMVpnEditorPlugin.html#NMVpnEditor"><span class="type">NMVpnEditor</span></a> *nmvpneditor, - <span class="type">gpointer</span> user_data)</pre> -<p>Flags: Run First</p> + <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Flags: <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> </div> </div> </div> |