NMVpnPluginUi

NMVpnPluginUi

Functions

Types and Values

Description

Functions

NMVpnPluginUiFactory ()

NMVpnPluginUiInterface *
(*NMVpnPluginUiFactory) (GError **error);

Returns


nm_vpn_plugin_ui_factory ()

NMVpnPluginUiInterface *
nm_vpn_plugin_ui_factory (GError **error);

Returns


nm_vpn_plugin_ui_interface_ui_factory ()

NMVpnPluginUiWidgetInterface *
nm_vpn_plugin_ui_interface_ui_factory (NMVpnPluginUiInterface *iface,
                                       NMConnection *connection,
                                       GError **error);

Returns


nm_vpn_plugin_ui_interface_get_capabilities ()

guint32
nm_vpn_plugin_ui_interface_get_capabilities
                               (NMVpnPluginUiInterface *iface);

Returns


nm_vpn_plugin_ui_interface_import ()

NMConnection *
nm_vpn_plugin_ui_interface_import (NMVpnPluginUiInterface *iface,
                                   const char *path,
                                   GError **error);

Returns


nm_vpn_plugin_ui_interface_export ()

gboolean
nm_vpn_plugin_ui_interface_export (NMVpnPluginUiInterface *iface,
                                   const char *path,
                                   NMConnection *connection,
                                   GError **error);

Returns


nm_vpn_plugin_ui_interface_get_suggested_name ()

char *
nm_vpn_plugin_ui_interface_get_suggested_name
                               (NMVpnPluginUiInterface *iface,
                                NMConnection *connection);

Returns


nm_vpn_plugin_ui_interface_delete_connection ()

gboolean
nm_vpn_plugin_ui_interface_delete_connection
                               (NMVpnPluginUiInterface *iface,
                                NMConnection *connection,
                                GError **error);

nm_vpn_plugin_ui_interface_delete_connection is deprecated and should not be used in newly-written code.

Returns


nm_vpn_plugin_ui_widget_interface_get_widget ()

GObject *
nm_vpn_plugin_ui_widget_interface_get_widget
                               (NMVpnPluginUiWidgetInterface *iface);

Returns


nm_vpn_plugin_ui_widget_interface_update_connection ()

gboolean
nm_vpn_plugin_ui_widget_interface_update_connection
                               (NMVpnPluginUiWidgetInterface *iface,
                                NMConnection *connection,
                                GError **error);

Returns


nm_vpn_plugin_ui_widget_interface_save_secrets ()

gboolean
nm_vpn_plugin_ui_widget_interface_save_secrets
                               (NMVpnPluginUiWidgetInterface *iface,
                                NMConnection *connection,
                                GError **error);

nm_vpn_plugin_ui_widget_interface_save_secrets is deprecated and should not be used in newly-written code.

Returns

Types and Values

enum NMVpnPluginUiCapability

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

Members

NM_VPN_PLUGIN_UI_CAPABILITY_NONE

unknown or no capability

 

NM_VPN_PLUGIN_UI_CAPABILITY_IMPORT

the plugin can import new connections

 

NM_VPN_PLUGIN_UI_CAPABILITY_EXPORT

the plugin can export connections

 

NM_VPN_PLUGIN_UI_CAPABILITY_IPV6

the plugin supports IPv6 addressing

 

NM_VPN_PLUGIN_UI_INTERFACE_NAME

#define NM_VPN_PLUGIN_UI_INTERFACE_NAME "name"


NM_VPN_PLUGIN_UI_INTERFACE_DESC

#define NM_VPN_PLUGIN_UI_INTERFACE_DESC "desc"


NM_VPN_PLUGIN_UI_INTERFACE_SERVICE

#define NM_VPN_PLUGIN_UI_INTERFACE_SERVICE "service"


enum NMVpnPluginUiInterfaceProp

GObject property numbers that plugins should override to provide certain information to UI programs.

Members

NM_VPN_PLUGIN_UI_INTERFACE_PROP_FIRST

   

NM_VPN_PLUGIN_UI_INTERFACE_PROP_NAME

the VPN plugin's name

 

NM_VPN_PLUGIN_UI_INTERFACE_PROP_DESC

description of the VPN plugin and what VPN services it supports

 

NM_VPN_PLUGIN_UI_INTERFACE_PROP_SERVICE

the D-Bus service name used by the plugin's VPN service daemon

 

struct NMVpnPluginUiInterface

struct NMVpnPluginUiInterface {
	GTypeInterface g_iface;

	/* Plugin's factory function that returns a GObject that implements
	 * NMVpnPluginUiWidgetInterface, pre-filled with values from 'connection'
	 * if non-NULL.
	 */
	NMVpnPluginUiWidgetInterface * (*ui_factory) (NMVpnPluginUiInterface *iface,
	                                              NMConnection *connection,
	                                              GError **error);

	/* Plugin's capabiltity function that returns a bitmask of capabilities
	 * described by NM_VPN_PLUGIN_UI_CAPABILITY_* defines.
	 */
	guint32 (*get_capabilities) (NMVpnPluginUiInterface *iface);

	/* 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.
	 */
	NMConnection * (*import_from_file) (NMVpnPluginUiInterface *iface,
	                                    const char *path,
	                                    GError **error);

	/* 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.
	 */
	gboolean (*export_to_file) (NMVpnPluginUiInterface *iface,
	                            const char *path,
	                            NMConnection *connection,
	                            GError **error);

	/* For a given connection, return a suggested file name.  Returned value should
	 * be NULL or a suggested file name allocated via g_malloc/g_new/etc to be freed
	 * by the caller.
	 */
	char * (*get_suggested_name) (NMVpnPluginUiInterface *iface, NMConnection *connection);

	/* Deprecated and no longer used */
	gboolean (*delete_connection) (NMVpnPluginUiInterface *iface, NMConnection *connection, GError **error);

	/* Padding for future expansion */
	void (*_reserved1) (void);
	void (*_reserved2) (void);
	void (*_reserved3) (void);
	void (*_reserved4) (void);
	void (*_reserved5) (void);
	void (*_reserved6) (void);
};


struct NMVpnPluginUiWidgetInterface

struct NMVpnPluginUiWidgetInterface {
	GTypeInterface g_iface;

	/* Return the GtkWidget for the VPN's UI */
	GObject * (*get_widget) (NMVpnPluginUiWidgetInterface *iface);

	/* 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.
	 */
	gboolean (*update_connection) (NMVpnPluginUiWidgetInterface *iface,
	                               NMConnection *connection,
	                               GError **error);

	/* Deprecated and no longer used */
	gboolean (*save_secrets) (NMVpnPluginUiWidgetInterface *iface,
	                          NMConnection *connection,
	                          GError **error);

	/* Emitted when the value of a UI widget changes.  May trigger a validity
	 * check via update_connection() to write values to the connection */
	void (*changed) (NMVpnPluginUiWidgetInterface *iface);
};