From e152ec7bf4ba252ff9d3eb13eabd417b931dac9a Mon Sep 17 00:00:00 2001 From: Iain Lane Date: Mon, 24 Sep 2018 09:29:55 +0100 Subject: Import Upstream version 1.12.2 --- docs/libnm/html/NMVpnEditorPlugin.html | 116 ++++++++++++++++++--------------- 1 file changed, 65 insertions(+), 51 deletions(-) (limited to 'docs/libnm/html/NMVpnEditorPlugin.html') diff --git a/docs/libnm/html/NMVpnEditorPlugin.html b/docs/libnm/html/NMVpnEditorPlugin.html index 7bdc9f9b..3d75ec7d 100644 --- a/docs/libnm/html/NMVpnEditorPlugin.html +++ b/docs/libnm/html/NMVpnEditorPlugin.html @@ -6,9 +6,9 @@ - - - + + + @@ -23,8 +23,8 @@ Home Up -Prev -Next +Prev +Next
@@ -61,7 +61,7 @@ -NMVpnEditor * +NMVpnEditor * nm_vpn_editor_plugin_get_editor () @@ -77,7 +77,7 @@ -gsize +gsize nm_vpn_editor_plugin_get_vt () @@ -93,7 +93,7 @@ -gboolean +gboolean nm_vpn_editor_plugin_export () @@ -124,7 +124,8 @@ -struct _NMVpnPluginInfo * + +NMVpnPluginInfo * nm_vpn_editor_plugin_get_plugin_info () @@ -152,19 +153,19 @@ -gchar * +gchar * description Read -gchar * +gchar * name Read -gchar * +gchar * service Read @@ -182,7 +183,7 @@ void changed -Run First +Run First
@@ -222,6 +223,10 @@   NMVpnEditorPluginVT + +  +NMVpnPluginInfo + @@ -238,7 +243,7 @@

Prerequisites

NMVpnEditor requires - GObject.

+ GObject.

Description

@@ -248,21 +253,21 @@ 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);

nm_vpn_editor_plugin_get_editor ()

-
NMVpnEditor *
+
NMVpnEditor *
 nm_vpn_editor_plugin_get_editor (NMVpnEditorPlugin *plugin,
                                  NMConnection *connection,
-                                 GError **error);
+ GError **error);

Parameters

@@ -284,7 +289,7 @@ nm_vpn_editor_plugin_get_editor ( - + @@ -292,7 +297,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 +310,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 @@ -355,7 +360,7 @@ size of plugin's VT.

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

Parameters

error

on return, an error or NULL

on return, an error or NULL

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

error

-
+ @@ -386,7 +391,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 +400,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 +422,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 @@ -482,7 +487,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 +498,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 @@ -534,7 +539,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

@@ -542,7 +547,7 @@ the given service.


nm_vpn_editor_plugin_get_plugin_info ()

-
struct _NMVpnPluginInfo *
+
NMVpnPluginInfo *
 nm_vpn_editor_plugin_get_plugin_info (NMVpnEditorPlugin *plugin);

Parameters

@@ -561,7 +566,7 @@ nm_vpn_editor_plugin_get_plugin_info (

Returns

-

if set, return the NMVpnPluginInfo instance.

+

if set, return the NMVpnPluginInfo instance.

[transfer none]

Since: 1.4

@@ -571,7 +576,7 @@ nm_vpn_editor_plugin_get_plugin_info (

nm_vpn_editor_plugin_set_plugin_info ()

void
 nm_vpn_editor_plugin_set_plugin_info (NMVpnEditorPlugin *plugin,
-                                      struct _NMVpnPluginInfo *plugin_info);
+ NMVpnPluginInfo *plugin_info);

Set or clear the plugin-info instance. This takes a weak reference on plugin_info , to avoid circular @@ -592,7 +597,7 @@ reference as the plugin-info might also reference the editor-plugin.

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

char * (*get_suggested_filename) (NMVpnEditorPlugin *plugin, NMConnection *connection); void (*notify_plugin_info_set) (NMVpnEditorPlugin *plugin, - struct _NMVpnPluginInfo *plugin_info); + NMVpnPluginInfo *plugin_info); const NMVpnEditorPluginVT *(*get_vt) (NMVpnEditorPlugin *plugin, gsize *out_vt_size); @@ -707,8 +712,8 @@ reference as the plugin-info might also reference the editor-plugin.

- + @@ -719,27 +724,27 @@ if non-

import_from_file ()

@@ -768,12 +773,21 @@ the plugin, without requiring to update libnm. Used by

NMVpnEditorPluginVT

typedef struct _NMVpnEditorPluginVT NMVpnEditorPluginVT;
+
+
+

NMVpnPluginInfo

+
typedef struct {
+	NM_AVAILABLE_IN_1_2
+	GObject parent;
+} NMVpnPluginInfo;
+
+

Property Details

The “description” property

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

Longer description of the VPN plugin.

Flags: Read

Default value: NULL

@@ -781,7 +795,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 +803,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

@@ -800,13 +814,13 @@ the plugin, without requiring to update libnm. Used by

The “changed” signal

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

Flags: Run First

+user_function (NMVpnEditor *nmvpneditor, + gpointer user_data) +

Flags: Run First

+
Generated by GTK-Doc V1.28 \ No newline at end of file -- cgit 1.3.0-6-gf8a5

on return, an error or NULL

on return, an error or NULL

 

plugin_info

a NMVpnPluginInfo instance or NULL.

a NMVpnPluginInfo instance or NULL.

[allow-none]

get_editor ()

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

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

 

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.