From 45cb5bb3c0e6edb887cf69b417fcaf7053814a9b Mon Sep 17 00:00:00 2001 From: Aron Xu Date: Tue, 20 Dec 2016 20:06:37 +0800 Subject: Imported Upstream version 1.4.4 --- docs/libnm/html/NMVpnEditorPlugin.html | 100 ++++++++++++++++----------------- 1 file changed, 50 insertions(+), 50 deletions(-) (limited to 'docs/libnm/html/NMVpnEditorPlugin.html') diff --git a/docs/libnm/html/NMVpnEditorPlugin.html b/docs/libnm/html/NMVpnEditorPlugin.html index baa30eed..46da86ab 100644 --- a/docs/libnm/html/NMVpnEditorPlugin.html +++ b/docs/libnm/html/NMVpnEditorPlugin.html @@ -3,7 +3,7 @@ NMVpnEditorPlugin: libnm Reference Manual - + @@ -37,7 +37,7 @@

Functions

-
+
@@ -77,7 +77,7 @@
-gsize +gsize nm_vpn_editor_plugin_get_vt () @@ -93,7 +93,7 @@
-gboolean +gboolean nm_vpn_editor_plugin_export () @@ -143,7 +143,7 @@

Properties

-
+
@@ -152,19 +152,19 @@ +gchar * +gchar * +gchar * @@ -173,7 +173,7 @@

Signals

-
-gchar * description Read
-gchar * name Read
-gchar * service Read
+
@@ -182,13 +182,13 @@ - +
void changedRun FirstRun First

Types and Values

-
+
@@ -238,7 +238,7 @@

Prerequisites

NMVpnEditor requires - GObject.

+ GObject.

Description

@@ -248,13 +248,13 @@ NMVpnEditor requires

NMVpnEditorPluginFactory ()

NMVpnEditorPlugin *
-(*NMVpnEditorPluginFactory) (GError **error);
+(*NMVpnEditorPluginFactory) (GError **error);

nm_vpn_editor_plugin_factory ()

NMVpnEditorPlugin *
-nm_vpn_editor_plugin_factory (GError **error);
+nm_vpn_editor_plugin_factory (GError **error);

@@ -262,10 +262,10 @@ nm_vpn_editor_plugin_factory (NMVpnEditor * nm_vpn_editor_plugin_get_editor (NMVpnEditorPlugin *plugin, NMConnection *connection, - GError **error); + GError **error);

Parameters

-
+
@@ -284,7 +284,7 @@ nm_vpn_editor_plugin_get_editor ( - + @@ -292,7 +292,7 @@ nm_vpn_editor_plugin_get_editor (

Returns

-

a new NMVpnEditor or NULL on error.

+

a new NMVpnEditor or NULL on error.

[transfer full]

@@ -305,10 +305,10 @@ nm_vpn_editor_plugin_get_capabilities (

nm_vpn_editor_plugin_get_vt ()

-
gsize
+
gsize
 nm_vpn_editor_plugin_get_vt (NMVpnEditorPlugin *plugin,
                              NMVpnEditorPluginVT *vt,
-                             gsize vt_size);
+ gsize vt_size);

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 @@ -316,7 +316,7 @@ both the plugin and the caller. See the header-only file 'nm-vpn-editor-plugin-call.h' which defines the meaning.

Parameters

-

error

on return, an error or NULL

on return, an error or NULL

 
+
@@ -355,10 +355,10 @@ size of plugin's VT.

NMConnection *
 nm_vpn_editor_plugin_import (NMVpnEditorPlugin *plugin,
                              const char *path,
-                             GError **error);
+ GError **error);

Parameters

-
+
@@ -377,7 +377,7 @@ nm_vpn_editor_plugin_import (

error

-
+ @@ -386,7 +386,7 @@ nm_vpn_editor_plugin_import (

Returns

a new NMConnection imported from path -, or NULL +, or NULL on error or if the file at path was not recognized by this plugin.

[transfer full]

@@ -395,11 +395,11 @@ was not recognized by this plugin.


nm_vpn_editor_plugin_export ()

-
gboolean
+
gboolean
 nm_vpn_editor_plugin_export (NMVpnEditorPlugin *plugin,
                              const char *path,
                              NMConnection *connection,
-                             GError **error);
+ GError **error);

@@ -417,8 +417,8 @@ nm_vpn_editor_plugin_load_from_file (const const char *check_service, int check_owner, NMUtilsCheckFilePredicate check_file, - gpointer user_data, - GError **error); + gpointer user_data, + GError **error);

Load the shared libary plugin_name and create a new NMVpnEditorPlugin instace via the NMVpnEditorPluginFactory @@ -431,7 +431,7 @@ A consequence for that is, that you cannot omit the ".so" suffix as you could for nm_vpn_editor_plugin_load().

Parameters

-

on return, an error or NULL

on return, an error or NULL

 
+
@@ -482,7 +482,7 @@ loading the shared library.

Returns

-

a new plugin instance or NULL on error.

+

a new plugin instance or NULL on error.

[transfer full]

Since: 1.2

@@ -493,7 +493,7 @@ loading the shared library.

NMVpnEditorPlugin *
 nm_vpn_editor_plugin_load (const char *plugin_name,
                            const char *check_service,
-                           GError **error);
+ GError **error);

Load the shared libary plugin_name and create a new NMVpnEditorPlugin instace via the NMVpnEditorPluginFactory @@ -504,7 +504,7 @@ to dlopen(). If you have the full path to a plugin nm_vpn_editor_plugin_load_from_file() is preferred.

Parameters

-
+
@@ -534,7 +534,7 @@ the given service.

Returns

-

a new plugin instance or NULL on error.

+

a new plugin instance or NULL on error.

[transfer full]

Since: 1.4

@@ -546,7 +546,7 @@ the given service.

nm_vpn_editor_plugin_get_plugin_info (NMVpnEditorPlugin *plugin);

Parameters

-
+
@@ -578,7 +578,7 @@ This takes a weak reference on plugin_info

Parameters

-
+
@@ -592,7 +592,7 @@ reference as the plugin-info might also reference the editor-plugin.

- + @@ -608,7 +608,7 @@ reference as the plugin-info might also reference the editor-plugin.

Flags that indicate certain capabilities of the plugin to editor programs.

Members

-

plugin_info

a NMVpnPluginInfo instance or NULL.

a NMVpnPluginInfo instance or NULL.

[allow-none]
+
@@ -698,7 +698,7 @@ reference as the plugin-info might also reference the editor-plugin.

Interface for VPN editor plugins.

Members

-
+
@@ -708,7 +708,7 @@ reference as the plugin-info might also reference the editor-plugin.

+if non-NULL.

@@ -719,27 +719,27 @@ if non- @@ -773,7 +773,7 @@ the plugin, without requiring to update libnm. Used by

Property Details

The “description” property

-
  “description”              gchar *
+
  “description”              gchar *

Longer description of the VPN plugin.

Flags: Read

Default value: NULL

@@ -781,7 +781,7 @@ the plugin, without requiring to update libnm. Used by

The “name” property

-
  “name”                     gchar *
+
  “name”                     gchar *

Short display name of the VPN plugin.

Flags: Read

Default value: NULL

@@ -789,7 +789,7 @@ the plugin, without requiring to update libnm. Used by

The “service” property

-
  “service”                  gchar *
+
  “service”                  gchar *

D-Bus service name of the plugin's VPN service.

Flags: Read

Default value: NULL

@@ -801,8 +801,8 @@ the plugin, without requiring to update libnm. Used by

The “changed” signal

void
 user_function (NMVpnEditor *nmvpneditor,
-               gpointer     user_data)
-

Flags: Run First

+ gpointer user_data) +

Flags: Run First

-- cgit 1.3.0-6-gf8a5

get_editor ()

returns an NMVpnEditor, pre-filled with values from connection -if non-NULL.

 

import_from_file ()

Try to import a connection from the specified path. On -success, return a partial NMConnection object. On error, return NULL and +success, return a partial NMConnection object. On error, return NULL and set error with additional information. Note that error -can be NULL, in +can be NULL, in which case no additional error information should be provided.

 

export_to_file ()

Export the given connection to the specified path. Return -TRUE on success. On error, return FALSE and set error +TRUE on success. On error, return FALSE and set error with additional error information. Note that error -can be NULL, in which case no +can be NULL, in which case no additional error information should be provided.

 

get_suggested_filename ()

For a given connection, return a suggested file -name. Returned value will be NULL or a suggested file name to be freed by +name. Returned value will be NULL or a suggested file name to be freed by the caller.