diff options
Diffstat (limited to 'docs/libnm/html/NMVpnEditorPlugin.html')
| -rw-r--r-- | docs/libnm/html/NMVpnEditorPlugin.html | 76 |
1 files changed, 38 insertions, 38 deletions
diff --git a/docs/libnm/html/NMVpnEditorPlugin.html b/docs/libnm/html/NMVpnEditorPlugin.html index 2260ccc0..18967a8a 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="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> +<span class="returnvalue">gsize</span> </td> <td class="function_name"> <a class="link" href="NMVpnEditorPlugin.html#nm-vpn-editor-plugin-get-vt" title="nm_vpn_editor_plugin_get_vt ()">nm_vpn_editor_plugin_get_vt</a> <span class="c_punctuation">()</span> @@ -93,7 +93,7 @@ </tr> <tr> <td class="function_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="returnvalue">gboolean</span> </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> @@ -152,19 +152,19 @@ <tbody> <tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</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"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</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"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</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> @@ -182,7 +182,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"><a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +<td class="signal_flags">Run First</td> </tr></tbody> </table></div> </div> @@ -227,9 +227,9 @@ </div> <div class="refsect1"> <a name="NMVpnEditorPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html">GFlags</a> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> <span class="lineart">╰──</span> NMVpnEditorPluginCapability - <a href="https://developer.gnome.org/gobject/unstable/GTypeModule.html">GInterface</a> + <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a> <span class="lineart">├──</span> NMVpnEditor <span class="lineart">╰──</span> NMVpnEditorPlugin </pre> @@ -238,7 +238,7 @@ <a name="NMVpnEditorPlugin.prerequisites"></a><h2>Prerequisites</h2> <p> NMVpnEditor requires - <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>.</p> + GObject.</p> </div> <div class="refsect1"> <a name="NMVpnEditorPlugin.description"></a><h2>Description</h2> @@ -248,13 +248,13 @@ 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><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<span class="c_punctuation">(</span>*NMVpnEditorPluginFactory<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">GError</span> **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><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +nm_vpn_editor_plugin_factory (<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> </div> <hr> <div class="refsect2"> @@ -262,7 +262,7 @@ nm_vpn_editor_plugin_factory (<em class="parameter"><code><a href="/usr/share/gt <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 class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> <div class="refsect3"> <a name="nm-vpn-editor-plugin-get-editor.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -284,7 +284,7 @@ nm_vpn_editor_plugin_get_editor (<em class="parameter"><code><a class="link" hre </tr> <tr> <td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>on return, an error or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_description"><p>on return, an error or <code class="literal">NULL</code></p></td> <td class="parameter_annotations"> </td> </tr> </tbody> @@ -292,7 +292,7 @@ nm_vpn_editor_plugin_get_editor (<em class="parameter"><code><a class="link" hre </div> <div class="refsect3"> <a name="nm-vpn-editor-plugin-get-editor.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="NMVpnEditorPlugin.html#NMVpnEditor"><span class="type">NMVpnEditor</span></a> or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p> +<p> a new <a class="link" href="NMVpnEditorPlugin.html#NMVpnEditor"><span class="type">NMVpnEditor</span></a> or <code class="literal">NULL</code> 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> @@ -305,10 +305,10 @@ nm_vpn_editor_plugin_get_capabilities (<em class="parameter"><code><a class="lin <hr> <div class="refsect2"> <a name="nm-vpn-editor-plugin-get-vt"></a><h3>nm_vpn_editor_plugin_get_vt ()</h3> -<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> +<pre class="programlisting"><span class="returnvalue">gsize</span> nm_vpn_editor_plugin_get_vt (<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 class="link" href="NMVpnEditorPlugin.html#NMVpnEditorPluginVT" title="NMVpnEditorPluginVT"><span class="type">NMVpnEditorPluginVT</span></a> *vt</code></em>, - <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gsize"><span class="type">gsize</span></a> vt_size</code></em>);</pre> + <em class="parameter"><code><span class="type">gsize</span> vt_size</code></em>);</pre> <p>Returns an opaque VT function table for the plugin to extend functionality. The actual meaning of NMVpnEditorPluginVT is not defined in public API of libnm, instead it must be agreed by @@ -355,7 +355,7 @@ size of plugin's VT.</p></td> <pre class="programlisting"><a class="link" href="NMConnection.html" title="NMConnection"><span class="returnvalue">NMConnection</span></a> * 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><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> <div class="refsect3"> <a name="nm-vpn-editor-plugin-import.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -377,7 +377,7 @@ nm_vpn_editor_plugin_import (<em class="parameter"><code><a class="link" href="N </tr> <tr> <td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>on return, an error or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_description"><p>on return, an error or <code class="literal">NULL</code></p></td> <td class="parameter_annotations"> </td> </tr> </tbody> @@ -386,7 +386,7 @@ nm_vpn_editor_plugin_import (<em class="parameter"><code><a class="link" href="N <div class="refsect3"> <a name="nm-vpn-editor-plugin-import.returns"></a><h4>Returns</h4> <p> a new <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> imported from <em class="parameter"><code>path</code></em> -, or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> +, or <code class="literal">NULL</code> 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> @@ -395,11 +395,11 @@ was not recognized by this plugin. </p> <hr> <div class="refsect2"> <a name="nm-vpn-editor-plugin-export"></a><h3>nm_vpn_editor_plugin_export ()</h3> -<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<pre class="programlisting"><span class="returnvalue">gboolean</span> 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 class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> </div> <hr> <div class="refsect2"> @@ -417,8 +417,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><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>, - <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> + <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> <p>Load the shared libary <em class="parameter"><code>plugin_name</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> @@ -482,7 +482,7 @@ loading the shared library. </p></td> </div> <div class="refsect3"> <a name="nm-vpn-editor-plugin-load-from-file.returns"></a><h4>Returns</h4> -<p> a new plugin instance or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p> +<p> a new plugin instance or <code class="literal">NULL</code> 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> @@ -493,7 +493,7 @@ loading the shared library. </p></td> <pre class="programlisting"><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="returnvalue">NMVpnEditorPlugin</span></a> * nm_vpn_editor_plugin_load (<em class="parameter"><code>const <span class="type">char</span> *plugin_name</code></em>, <em class="parameter"><code>const <span class="type">char</span> *check_service</code></em>, - <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> <p>Load the shared libary <em class="parameter"><code>plugin_name</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> @@ -534,7 +534,7 @@ the given service.</p></td> </div> <div class="refsect3"> <a name="nm-vpn-editor-plugin-load.returns"></a><h4>Returns</h4> -<p> a new plugin instance or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p> +<p> a new plugin instance or <code class="literal">NULL</code> 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.4</p> @@ -592,7 +592,7 @@ reference as the plugin-info might also reference the editor-plugin.</p> </tr> <tr> <td class="parameter_name"><p>plugin_info</p></td> -<td class="parameter_description"><p> a <span class="type">NMVpnPluginInfo</span> instance or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> +<td class="parameter_description"><p> a <span class="type">NMVpnPluginInfo</span> instance or <code class="literal">NULL</code>. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> </tr> </tbody> @@ -708,7 +708,7 @@ reference as the plugin-info might also reference the editor-plugin.</p> <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-<a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td> +if non-<code class="literal">NULL</code>.</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> @@ -719,27 +719,27 @@ if non-<a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS" <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 class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> object. On error, return <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and +success, return a partial <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> object. On error, return <code class="literal">NULL</code> 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/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, in +can be <code class="literal">NULL</code>, 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 -<a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success. On error, return <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set <em class="parameter"><code>error</code></em> +<code class="literal">TRUE</code> on success. On error, return <code class="literal">FALSE</code> 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/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, in which case no +can be <code class="literal">NULL</code>, 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 <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or a suggested file name to be freed by +name. Returned value will be <code class="literal">NULL</code> or a suggested file name to be freed by the caller.</p></td> <td class="struct_member_annotations"> </td> </tr> @@ -773,7 +773,7 @@ the plugin, without requiring to update libnm. Used by <a class="link" href="NMV <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” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “description” <span class="type">gchar</span> *</pre> <p>Longer description of the VPN plugin.</p> <p>Flags: Read</p> <p>Default value: NULL</p> @@ -781,7 +781,7 @@ the plugin, without requiring to update libnm. Used by <a class="link" href="NMV <hr> <div class="refsect2"> <a name="NMVpnEditorPlugin--name"></a><h3>The <code class="literal">“name”</code> property</h3> -<pre class="programlisting"> “name” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “name” <span class="type">gchar</span> *</pre> <p>Short display name of the VPN plugin.</p> <p>Flags: Read</p> <p>Default value: NULL</p> @@ -789,7 +789,7 @@ the plugin, without requiring to update libnm. Used by <a class="link" href="NMV <hr> <div class="refsect2"> <a name="NMVpnEditorPlugin--service"></a><h3>The <code class="literal">“service”</code> property</h3> -<pre class="programlisting"> “service” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “service” <span class="type">gchar</span> *</pre> <p>D-Bus service name of the plugin's VPN service.</p> <p>Flags: Read</p> <p>Default value: NULL</p> @@ -801,8 +801,8 @@ the plugin, without requiring to update libnm. Used by <a class="link" href="NMV <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, - <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> -<p>Flags: <a href="/usr/share/gtk-doc/html/gobjectgobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> + <span class="type">gpointer</span> user_data)</pre> +<p>Flags: Run First</p> </div> </div> </div> |