Details
NM_VPN_PLUGIN_UI_CAPABILITY_NONE
#define NM_VPN_PLUGIN_UI_CAPABILITY_NONE 0x00
NM_VPN_PLUGIN_UI_CAPABILITY_IMPORT
#define NM_VPN_PLUGIN_UI_CAPABILITY_IMPORT 0x01
NM_VPN_PLUGIN_UI_CAPABILITY_EXPORT
#define NM_VPN_PLUGIN_UI_CAPABILITY_EXPORT 0x02
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
typedef enum {
NM_VPN_PLUGIN_UI_INTERFACE_PROP_FIRST = 0x1000,
NM_VPN_PLUGIN_UI_INTERFACE_PROP_NAME = NM_VPN_PLUGIN_UI_INTERFACE_PROP_FIRST,
NM_VPN_PLUGIN_UI_INTERFACE_PROP_DESC,
NM_VPN_PLUGIN_UI_INTERFACE_PROP_SERVICE
} NMVpnPluginUiInterfaceProp;
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);
/* Called when the user has chosen to remove the connection (for user
* connections only; system connections are handled by the system
* settings service). Should clear out any VPN-specific secrets or data
* related to the connection.
*/
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);
};
NM_TYPE_VPN_PLUGIN_UI_WIDGET_INTERFACE
#define NM_TYPE_VPN_PLUGIN_UI_WIDGET_INTERFACE (nm_vpn_plugin_ui_widget_interface_get_type ())
NM_VPN_PLUGIN_UI_WIDGET_INTERFACE()
#define NM_VPN_PLUGIN_UI_WIDGET_INTERFACE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_VPN_PLUGIN_UI_WIDGET_INTERFACE, NMVpnPluginUiWidgetInterface))
NM_IS_VPN_PLUGIN_UI_WIDGET_INTERFACE()
#define NM_IS_VPN_PLUGIN_UI_WIDGET_INTERFACE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_VPN_PLUGIN_UI_WIDGET_INTERFACE))
NM_VPN_PLUGIN_UI_WIDGET_INTERFACE_GET_INTERFACE()
#define NM_VPN_PLUGIN_UI_WIDGET_INTERFACE_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), NM_TYPE_VPN_PLUGIN_UI_WIDGET_INTERFACE, NMVpnPluginUiWidgetInterface))
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);
/* Called when the user has chosen to save the connection (for user
* connections only; system connections are handled by the system
* settings service). Should save VPN-specific connection secrets in
* a way that the auth-dialog can read them.
*/
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);
};
nm_vpn_plugin_ui_widget_interface_get_type ()
GType nm_vpn_plugin_ui_widget_interface_get_type
(void);
