diff options
Diffstat (limited to 'docs/libnm/html/NMVpnEditorPlugin.html')
| -rw-r--r-- | docs/libnm/html/NMVpnEditorPlugin.html | 110 |
1 files changed, 85 insertions, 25 deletions
diff --git a/docs/libnm/html/NMVpnEditorPlugin.html b/docs/libnm/html/NMVpnEditorPlugin.html index 4085af30..5a94ae31 100644 --- a/docs/libnm/html/NMVpnEditorPlugin.html +++ b/docs/libnm/html/NMVpnEditorPlugin.html @@ -7,8 +7,8 @@ <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="NMVpnEditor.html" title="NMVpnEditor"> -<link rel="next" href="libnm-nm-vpn-plugin-old.html" title="nm-vpn-plugin-old"> -<meta name="generator" content="GTK-Doc V1.29 (XML mode)"> +<link rel="next" href="NMVpnPluginOld.html" title="NMVpnPluginOld"> +<meta name="generator" content="GTK-Doc V1.32.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -16,7 +16,8 @@ <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> <a href="#NMVpnEditorPlugin.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#NMVpnEditorPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span> + <a href="#NMVpnEditorPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#NMVpnEditorPlugin.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_prerequisites"> <span class="dim">|</span> <a href="#NMVpnEditorPlugin.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_properties"> <span class="dim">|</span> <a href="#NMVpnEditorPlugin.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> <a href="#NMVpnEditorPlugin.signals" class="shortcut">Signals</a></span> @@ -24,7 +25,7 @@ <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="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> <td><a accesskey="p" href="NMVpnEditor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libnm-nm-vpn-plugin-old.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="NMVpnPluginOld.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="NMVpnEditorPlugin"></a><div class="titlepage"></div> @@ -39,8 +40,8 @@ <a name="NMVpnEditorPlugin.functions"></a><h2>Functions</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> -<col width="150px" class="functions_return"> -<col class="functions_name"> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> </colgroup> <tbody> <tr> @@ -125,7 +126,7 @@ </tr> <tr> <td class="function_type"> -<a class="link" href="libnm-nm-vpn-plugin-info.html#NMVpnPluginInfo" title="NMVpnPluginInfo"><span class="returnvalue">NMVpnPluginInfo</span></a> * +<a class="link" href="NMVpnPluginInfo.html" title="NMVpnPluginInfo"><span class="returnvalue">NMVpnPluginInfo</span></a> * </td> <td class="function_name"> <a class="link" href="NMVpnEditorPlugin.html#nm-vpn-editor-plugin-get-plugin-info" title="nm_vpn_editor_plugin_get_plugin_info ()">nm_vpn_editor_plugin_get_plugin_info</a> <span class="c_punctuation">()</span> @@ -154,6 +155,24 @@ <tr> <td class="property_type"> <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#NMVpnPluginInfo--filename" title="The “filename” property">filename</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Key-value-file-parser.html#GKeyFile"><span class="type">GKeyFile</span></a> *</td> +<td class="property_name"><a class="link" href="NMVpnEditorPlugin.html#NMVpnPluginInfo--keyfile" title="The “keyfile” property">keyfile</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"> +<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#NMVpnPluginInfo--name" title="The “name” property">name</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<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> @@ -176,9 +195,9 @@ <a name="NMVpnEditorPlugin.signals"></a><h2>Signals</h2> <div class="informaltable"><table class="informaltable" border="0"> <colgroup> -<col width="150px" class="signals_return"> -<col width="300px" class="signals_name"> -<col width="200px" class="signals_flags"> +<col width="150px" class="signal_proto_type"> +<col width="300px" class="signal_proto_name"> +<col width="200px" class="signal_proto_flags"> </colgroup> <tbody><tr> <td class="signal_type"><span class="returnvalue">void</span></td> @@ -187,12 +206,12 @@ </tr></tbody> </table></div> </div> -<a name="NMVpnEditor"></a><div class="refsect1"> +<a name="NMVpnEditor"></a><a name="NMVpnPluginInfo"></a><div class="refsect1"> <a name="NMVpnEditorPlugin.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> -<col width="150px" class="name"> -<col class="description"> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> </colgroup> <tbody> <tr> @@ -225,7 +244,7 @@ </tr> <tr> <td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="libnm-nm-vpn-plugin-info.html#NMVpnPluginInfo" title="NMVpnPluginInfo">NMVpnPluginInfo</a></td> +<td class="function_name"><a class="link" href="NMVpnEditorPlugin.html#NMVpnPluginInfo-struct" title="NMVpnPluginInfo">NMVpnPluginInfo</a></td> </tr> </tbody> </table></div> @@ -237,6 +256,8 @@ <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a> <span class="lineart">├──</span> NMVpnEditor <span class="lineart">╰──</span> NMVpnEditorPlugin + <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> NMVpnPluginInfo </pre> </div> <div class="refsect1"> @@ -246,6 +267,12 @@ NMVpnEditor requires <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>.</p> </div> <div class="refsect1"> +<a name="NMVpnEditorPlugin.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +NMVpnPluginInfo implements + <a href="https://developer.gnome.org/gio/unstable/GInitable.html#GInitable-struct">GInitable</a>.</p> +</div> +<div class="refsect1"> <a name="NMVpnEditorPlugin.description"></a><h2>Description</h2> </div> <div class="refsect1"> @@ -547,7 +574,7 @@ the given service.</p></td> <hr> <div class="refsect2"> <a name="nm-vpn-editor-plugin-get-plugin-info"></a><h3>nm_vpn_editor_plugin_get_plugin_info ()</h3> -<pre class="programlisting"><a class="link" href="libnm-nm-vpn-plugin-info.html#NMVpnPluginInfo" title="NMVpnPluginInfo"><span class="returnvalue">NMVpnPluginInfo</span></a> * +<pre class="programlisting"><a class="link" href="NMVpnPluginInfo.html" title="NMVpnPluginInfo"><span class="returnvalue">NMVpnPluginInfo</span></a> * nm_vpn_editor_plugin_get_plugin_info (<em class="parameter"><code><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> *plugin</code></em>);</pre> <div class="refsect3"> <a name="nm-vpn-editor-plugin-get-plugin-info.parameters"></a><h4>Parameters</h4> @@ -566,7 +593,7 @@ nm_vpn_editor_plugin_get_plugin_info (<em class="parameter"><code><a class="link </div> <div class="refsect3"> <a name="nm-vpn-editor-plugin-get-plugin-info.returns"></a><h4>Returns</h4> -<p>if set, return the <a class="link" href="libnm-nm-vpn-plugin-info.html#NMVpnPluginInfo" title="NMVpnPluginInfo"><span class="type">NMVpnPluginInfo</span></a> instance. </p> +<p>if set, return the <a class="link" href="NMVpnPluginInfo.html" title="NMVpnPluginInfo"><span class="type">NMVpnPluginInfo</span></a> instance. </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> </div> <p class="since">Since: 1.4</p> @@ -576,7 +603,7 @@ nm_vpn_editor_plugin_get_plugin_info (<em class="parameter"><code><a class="link <a name="nm-vpn-editor-plugin-set-plugin-info"></a><h3>nm_vpn_editor_plugin_set_plugin_info ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> nm_vpn_editor_plugin_set_plugin_info (<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="libnm-nm-vpn-plugin-info.html#NMVpnPluginInfo" title="NMVpnPluginInfo"><span class="type">NMVpnPluginInfo</span></a> *plugin_info</code></em>);</pre> + <em class="parameter"><code><a class="link" href="NMVpnPluginInfo.html" title="NMVpnPluginInfo"><span class="type">NMVpnPluginInfo</span></a> *plugin_info</code></em>);</pre> <p>Set or clear the plugin-info instance. This takes a weak reference on <em class="parameter"><code>plugin_info</code></em> , to avoid circular @@ -597,7 +624,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 <a class="link" href="libnm-nm-vpn-plugin-info.html#NMVpnPluginInfo" title="NMVpnPluginInfo"><span class="type">NMVpnPluginInfo</span></a> instance 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_description"><p>a <a class="link" href="NMVpnPluginInfo.html" title="NMVpnPluginInfo"><span class="type">NMVpnPluginInfo</span></a> instance 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"><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> @@ -775,20 +802,51 @@ the plugin, without requiring to update libnm. Used by <a class="link" href="NMV </div> <hr> <div class="refsect2"> -<a name="NMVpnPluginInfo"></a><h3>NMVpnPluginInfo</h3> -<pre class="programlisting">typedef struct { - NM_AVAILABLE_IN_1_2 - GObject parent; -} NMVpnPluginInfo; -</pre> +<a name="NMVpnPluginInfo-struct"></a><h3>NMVpnPluginInfo</h3> +<pre class="programlisting">typedef struct _NMVpnPluginInfo NMVpnPluginInfo;</pre> </div> </div> <div class="refsect1"> <a name="NMVpnEditorPlugin.property-details"></a><h2>Property Details</h2> <div class="refsect2"> +<a name="NMVpnPluginInfo--filename"></a><h3>The <code class="literal">“filename”</code> property</h3> +<pre class="programlisting"> “filename” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The filename from which the info was loaded. +Can be <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the instance was not loaded from +a file (i.e. the keyfile instance was passed to the +constructor).</p> +<p>Owner: NMVpnPluginInfo</p> +<p>Flags: Read / Write / Construct Only</p> +<p>Default value: NULL</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMVpnPluginInfo--keyfile"></a><h3>The <code class="literal">“keyfile”</code> property</h3> +<pre class="programlisting"> “keyfile” <a href="https://developer.gnome.org/glib/unstable/glib-Key-value-file-parser.html#GKeyFile"><span class="type">GKeyFile</span></a> *</pre> +<p>Initialize the instance with a different keyfile instance. +When passing a keyfile instance, the constructor will not +try to read from filename.</p> +<p>Owner: NMVpnPluginInfo</p> +<p>Flags: Write / Construct Only</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMVpnPluginInfo--name"></a><h3>The <code class="literal">“name”</code> property</h3> +<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>The name of the VPN plugin.</p> +<p>Owner: NMVpnPluginInfo</p> +<p>Flags: Read</p> +<p>Default value: NULL</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> <a name="NMVpnEditorPlugin--description"></a><h3>The <code class="literal">“description”</code> property</h3> <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>Owner: NMVpnEditorPlugin</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -797,6 +855,7 @@ the plugin, without requiring to update libnm. Used by <a class="link" href="NMV <a name="NMVpnEditorPlugin--name"></a><h3>The <code class="literal">“name”</code> property</h3> <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>Owner: NMVpnEditorPlugin</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -805,6 +864,7 @@ the plugin, without requiring to update libnm. Used by <a class="link" href="NMV <a name="NMVpnEditorPlugin--service"></a><h3>The <code class="literal">“service”</code> property</h3> <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>Owner: NMVpnEditorPlugin</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -821,6 +881,6 @@ user_function (<a class="link" href="NMVpnEditor.html" title="NMVpnEditor"><span </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.29</div> +<hr>Generated by GTK-Doc V1.32.1</div> </body> </html> \ No newline at end of file |