From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm/html/libnm-NMVpnEditorPlugin.html | 382 --------------------------- 1 file changed, 382 deletions(-) delete mode 100644 docs/libnm/html/libnm-NMVpnEditorPlugin.html (limited to 'docs/libnm/html/libnm-NMVpnEditorPlugin.html') diff --git a/docs/libnm/html/libnm-NMVpnEditorPlugin.html b/docs/libnm/html/libnm-NMVpnEditorPlugin.html deleted file mode 100644 index 1cfdb8e6..00000000 --- a/docs/libnm/html/libnm-NMVpnEditorPlugin.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - -NMVpnEditorPlugin - - - - - - - - - - - - - - - - - - - -
-
-
- - -
-

NMVpnEditorPlugin

-

NMVpnEditorPlugin

-
-
-

Synopsis

-
NMVpnEditorPlugin * (*NMVpnEditorPluginFactory)         (GError **error);
-NMVpnEditorPlugin * nm_vpn_editor_plugin_factory        (GError **error);
-enum                NMVpnEditorPluginCapability;
-#define             NM_VPN_EDITOR_PLUGIN_NAME
-#define             NM_VPN_EDITOR_PLUGIN_DESCRIPTION
-#define             NM_VPN_EDITOR_PLUGIN_SERVICE
-                    NMVpnEditorPluginInterface;
-NMVpnEditor *       nm_vpn_editor_plugin_get_editor     (NMVpnEditorPlugin *plugin,
-                                                         NMConnection *connection,
-                                                         GError **error);
-NMVpnEditorPluginCapability nm_vpn_editor_plugin_get_capabilities
-                                                        (NMVpnEditorPlugin *plugin);
-NMConnection *      nm_vpn_editor_plugin_import         (NMVpnEditorPlugin *plugin,
-                                                         const char *path,
-                                                         GError **error);
-gboolean            nm_vpn_editor_plugin_export         (NMVpnEditorPlugin *plugin,
-                                                         const char *path,
-                                                         NMConnection *connection,
-                                                         GError **error);
-char *              nm_vpn_editor_plugin_get_suggested_filename
-                                                        (NMVpnEditorPlugin *plugin,
-                                                         NMConnection *connection);
-                    NMVpnEditorInterface;
-GObject *           nm_vpn_editor_get_widget            (NMVpnEditor *editor);
-gboolean            nm_vpn_editor_update_connection     (NMVpnEditor *editor,
-                                                         NMConnection *connection,
-                                                         GError **error);
-
-
-
-

Object Hierarchy

-
-  GFlags
-   +----NMVpnEditorPluginCapability
-
-
-
-

Description

-

-

-
-
-

Details

-
-

NMVpnEditorPluginFactory ()

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

-

-
-
-
-

nm_vpn_editor_plugin_factory ()

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

-

-
-
-
-

enum NMVpnEditorPluginCapability

-
typedef enum {
-	NM_VPN_EDITOR_PLUGIN_CAPABILITY_NONE   = 0x00,
-	NM_VPN_EDITOR_PLUGIN_CAPABILITY_IMPORT = 0x01,
-	NM_VPN_EDITOR_PLUGIN_CAPABILITY_EXPORT = 0x02,
-	NM_VPN_EDITOR_PLUGIN_CAPABILITY_IPV6   = 0x04
-} NMVpnEditorPluginCapability;
-
-

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

-
---- - - - - - - - - - - - - - - - - - - -

NM_VPN_EDITOR_PLUGIN_CAPABILITY_NONE

unknown or no capability -

NM_VPN_EDITOR_PLUGIN_CAPABILITY_IMPORT

the plugin can import new connections -

NM_VPN_EDITOR_PLUGIN_CAPABILITY_EXPORT

the plugin can export connections -

NM_VPN_EDITOR_PLUGIN_CAPABILITY_IPV6

the plugin supports IPv6 addressing -
-
-
-
-

NM_VPN_EDITOR_PLUGIN_NAME

-
#define NM_VPN_EDITOR_PLUGIN_NAME "name"
-
-

-

-
-
-
-

NM_VPN_EDITOR_PLUGIN_DESCRIPTION

-
#define NM_VPN_EDITOR_PLUGIN_DESCRIPTION "description"
-
-

-

-
-
-
-

NM_VPN_EDITOR_PLUGIN_SERVICE

-
#define NM_VPN_EDITOR_PLUGIN_SERVICE "service"
-
-

-

-
-
-
-

NMVpnEditorPluginInterface

-
typedef struct {
-	GTypeInterface g_iface;
-
-	NMVpnEditor * (*get_editor) (NMVpnEditorPlugin *plugin,
-	                             NMConnection *connection,
-	                             GError **error);
-
-	NMVpnEditorPluginCapability (*get_capabilities) (NMVpnEditorPlugin *plugin);
-
-	NMConnection * (*import_from_file) (NMVpnEditorPlugin *plugin,
-	                                    const char *path,
-	                                    GError **error);
-
-	gboolean (*export_to_file) (NMVpnEditorPlugin *plugin,
-	                            const char *path,
-	                            NMConnection *connection,
-	                            GError **error);
-
-	char * (*get_suggested_filename) (NMVpnEditorPlugin *plugin, NMConnection *connection);
-} NMVpnEditorPluginInterface;
-
-

-Interface for VPN editor plugins. -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

GTypeInterface g_iface;

the parent interface

get_editor ()

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

get_capabilities ()

returns a bitmask of capabilities.

import_from_file ()

Try to import a connection from the specified path. On -success, return a partial NMConnection object. On error, return NULL and -set error with additional information. Note that error 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 with additional -error information. Note that error 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 -the caller.
-
-
-
-

nm_vpn_editor_plugin_get_editor ()

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

Returns :

. [transfer full] -
-
-
-
-

nm_vpn_editor_plugin_get_capabilities ()

-
NMVpnEditorPluginCapability nm_vpn_editor_plugin_get_capabilities
-                                                        (NMVpnEditorPlugin *plugin);
-

-

-
-
-
-

nm_vpn_editor_plugin_import ()

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

Returns :

. [transfer full] -
-
-
-
-

nm_vpn_editor_plugin_export ()

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

-

-
-
-
-

nm_vpn_editor_plugin_get_suggested_filename ()

-
char *              nm_vpn_editor_plugin_get_suggested_filename
-                                                        (NMVpnEditorPlugin *plugin,
-                                                         NMConnection *connection);
-

-

-
-
-
-

NMVpnEditorInterface

-
typedef struct {
-	GTypeInterface g_iface;
-
-	GObject * (*get_widget) (NMVpnEditor *editor);
-
-	void (*placeholder) (void);
-
-	gboolean (*update_connection) (NMVpnEditor *editor,
-	                               NMConnection *connection,
-	                               GError **error);
-
-	void (*changed) (NMVpnEditor *editor);
-} NMVpnEditorInterface;
-
-

-Interface for editing a specific NMConnection -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

GTypeInterface g_iface;

the parent interface

get_widget ()

return the GtkWidget for the VPN editor's UI

placeholder ()

not currently used

update_connection ()

called to save the user-entered options to the connection -object. Should return FALSE and set error if the current options are -invalid. error should contain enough information for the plugin to -determine which UI widget is invalid at a later point in time. For -example, creating unique error codes for what error occurred and populating -the message field of error with the name of the invalid property.

changed ()

emitted when the value of a UI widget changes. May trigger a -validity check via update_connection to write values to the connection.
-
-
-
-

nm_vpn_editor_get_widget ()

-
GObject *           nm_vpn_editor_get_widget            (NMVpnEditor *editor);
-
---- - - - - -

Returns :

. [transfer none] -
-
-
-
-

nm_vpn_editor_update_connection ()

-
gboolean            nm_vpn_editor_update_connection     (NMVpnEditor *editor,
-                                                         NMConnection *connection,
-                                                         GError **error);
-

-

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