From 9fae01fa351805b2903e535736e06971bc0b925e Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Mon, 29 Nov 2010 00:47:11 +0100 Subject: Imported Upstream version 0.8.1 --- docs/libnm-glib/html/NMCdmaDevice.html | 105 +++ docs/libnm-glib/html/NMDHCP4Config.html | 187 ++++++ docs/libnm-glib/html/NMDHCP6Config.html | 169 +++++ docs/libnm-glib/html/NMGsmDevice.html | 105 +++ docs/libnm-glib/html/NMIP4Config.html | 370 ++++++++++ docs/libnm-glib/html/NMIP6Config.html | 290 ++++++++ docs/libnm-glib/html/NMSerialDevice.html | 170 +++++ docs/libnm-glib/html/ch01.html | 113 ++++ docs/libnm-glib/html/home.png | Bin 0 -> 654 bytes docs/libnm-glib/html/index.html | 116 ++++ docs/libnm-glib/html/index.sgml | 498 ++++++++++++++ docs/libnm-glib/html/left.png | Bin 0 -> 459 bytes .../html/libnm-glib-NMExportedConnection.html | 89 +++ .../html/libnm-glib-NMRemoteConnection.html | 104 +++ .../html/libnm-glib-NMRemoteSettingsSystem.html | 89 +++ .../html/libnm-glib-nm-access-point.html | 503 ++++++++++++++ .../html/libnm-glib-nm-active-connection.html | 445 ++++++++++++ docs/libnm-glib/html/libnm-glib-nm-client.html | 724 ++++++++++++++++++++ docs/libnm-glib/html/libnm-glib-nm-device-bt.html | 196 ++++++ .../html/libnm-glib-nm-device-ethernet.html | 243 +++++++ .../libnm-glib/html/libnm-glib-nm-device-wifi.html | 458 +++++++++++++ docs/libnm-glib/html/libnm-glib-nm-device.html | 743 +++++++++++++++++++++ docs/libnm-glib/html/libnm-glib-nm-object.html | 170 +++++ .../html/libnm-glib-nm-remote-settings.html | 123 ++++ ...ibnm-glib-nm-settings-connection-interface.html | 403 +++++++++++ .../html/libnm-glib-nm-settings-interface.html | 331 +++++++++ .../html/libnm-glib-nm-settings-service.html | 158 +++++ .../libnm-glib-nm-settings-system-interface.html | 322 +++++++++ docs/libnm-glib/html/libnm-glib-nm-types.html | 231 +++++++ .../html/libnm-glib-nm-vpn-connection.html | 159 +++++ .../libnm-glib-nm-vpn-plugin-ui-interface.html | 679 +++++++++++++++++++ docs/libnm-glib/html/libnm-glib-nm-vpn-plugin.html | 328 +++++++++ docs/libnm-glib/html/libnm-glib.devhelp | 378 +++++++++++ docs/libnm-glib/html/libnm-glib.devhelp2 | 378 +++++++++++ docs/libnm-glib/html/right.png | Bin 0 -> 472 bytes docs/libnm-glib/html/style.css | 257 +++++++ docs/libnm-glib/html/up.png | Bin 0 -> 406 bytes 37 files changed, 9634 insertions(+) create mode 100644 docs/libnm-glib/html/NMCdmaDevice.html create mode 100644 docs/libnm-glib/html/NMDHCP4Config.html create mode 100644 docs/libnm-glib/html/NMDHCP6Config.html create mode 100644 docs/libnm-glib/html/NMGsmDevice.html create mode 100644 docs/libnm-glib/html/NMIP4Config.html create mode 100644 docs/libnm-glib/html/NMIP6Config.html create mode 100644 docs/libnm-glib/html/NMSerialDevice.html create mode 100644 docs/libnm-glib/html/ch01.html create mode 100644 docs/libnm-glib/html/home.png create mode 100644 docs/libnm-glib/html/index.html create mode 100644 docs/libnm-glib/html/index.sgml create mode 100644 docs/libnm-glib/html/left.png create mode 100644 docs/libnm-glib/html/libnm-glib-NMExportedConnection.html create mode 100644 docs/libnm-glib/html/libnm-glib-NMRemoteConnection.html create mode 100644 docs/libnm-glib/html/libnm-glib-NMRemoteSettingsSystem.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-access-point.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-active-connection.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-client.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-device-bt.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-device-ethernet.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-device-wifi.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-device.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-object.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-remote-settings.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-settings-connection-interface.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-settings-interface.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-settings-service.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-settings-system-interface.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-types.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-vpn-connection.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-vpn-plugin-ui-interface.html create mode 100644 docs/libnm-glib/html/libnm-glib-nm-vpn-plugin.html create mode 100644 docs/libnm-glib/html/libnm-glib.devhelp create mode 100644 docs/libnm-glib/html/libnm-glib.devhelp2 create mode 100644 docs/libnm-glib/html/right.png create mode 100644 docs/libnm-glib/html/style.css create mode 100644 docs/libnm-glib/html/up.png (limited to 'docs/libnm-glib/html') diff --git a/docs/libnm-glib/html/NMCdmaDevice.html b/docs/libnm-glib/html/NMCdmaDevice.html new file mode 100644 index 00000000..f0765444 --- /dev/null +++ b/docs/libnm-glib/html/NMCdmaDevice.html @@ -0,0 +1,105 @@ + + + + +NMCdmaDevice + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMCdmaDevice

+

NMCdmaDevice

+
+
+

Synopsis

+
                    NMCdmaDevice;
+GObject *           nm_cdma_device_new                  (DBusGConnection *connection,
+                                                         const char *path);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMSerialDevice
+                     +----NMCdmaDevice
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMCdmaDevice

+
typedef struct _NMCdmaDevice NMCdmaDevice;
+

+

+
+
+
+

nm_cdma_device_new ()

+
GObject *           nm_cdma_device_new                  (DBusGConnection *connection,
+                                                         const char *path);
+

+Creates a new NMCdmaDevice. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

path :

the DBus object path of the device +

Returns :

a new device +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/NMDHCP4Config.html b/docs/libnm-glib/html/NMDHCP4Config.html new file mode 100644 index 00000000..697744f7 --- /dev/null +++ b/docs/libnm-glib/html/NMDHCP4Config.html @@ -0,0 +1,187 @@ + + + + +NMDHCP4Config + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDHCP4Config

+

NMDHCP4Config

+
+
+

Synopsis

+
                    NMDHCP4Config;
+#define             NM_DHCP4_CONFIG_OPTIONS
+GObject *           nm_dhcp4_config_new                 (DBusGConnection *connection,
+                                                         const char *object_path);
+GHashTable *        nm_dhcp4_config_get_options         (NMDHCP4Config *config);
+const char *        nm_dhcp4_config_get_one_option      (NMDHCP4Config *config,
+                                                         const char *option);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDHCP4Config
+
+
+
+

Properties

+
+  "options"                  GHashTable*           : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMDHCP4Config

+
typedef struct _NMDHCP4Config NMDHCP4Config;
+

+

+
+
+
+

NM_DHCP4_CONFIG_OPTIONS

+
#define NM_DHCP4_CONFIG_OPTIONS "options"
+
+

+

+
+
+
+

nm_dhcp4_config_new ()

+
GObject *           nm_dhcp4_config_new                 (DBusGConnection *connection,
+                                                         const char *object_path);
+

+Creates a new NMDHCP4Config. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

object_path :

the DBus object path of the device +

Returns :

a new configuration +
+
+
+
+

nm_dhcp4_config_get_options ()

+
GHashTable *        nm_dhcp4_config_get_options         (NMDHCP4Config *config);
+

+Gets all the options contained in the configuration. +

+
++ + + + + + + + + + +

config :

a NMDHCP4Config +

Returns :

the GHashTable containing strings for keys and values. +This is the internal copy used by the configuration, and must not be modified. +
+
+
+
+

nm_dhcp4_config_get_one_option ()

+
const char *        nm_dhcp4_config_get_one_option      (NMDHCP4Config *config,
+                                                         const char *option);
+

+Gets one option by option name. +

+
++ + + + + + + + + + + + + + +

config :

a NMDHCP4Config +

option :

the option to retrieve +

Returns :

the configuration option's value. This is the internal string used by the +configuration, and must not be modified. +
+
+
+
+

Property Details

+
+

The "options" property

+
  "options"                  GHashTable*           : Read
+

+The GHashTable containing options of the configuration. +

+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/NMDHCP6Config.html b/docs/libnm-glib/html/NMDHCP6Config.html new file mode 100644 index 00000000..8edffbb6 --- /dev/null +++ b/docs/libnm-glib/html/NMDHCP6Config.html @@ -0,0 +1,169 @@ + + + + +NMDHCP6Config + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDHCP6Config

+

NMDHCP6Config

+
+
+

Synopsis

+
                    NMDHCP6Config;
+#define             NM_DHCP6_CONFIG_OPTIONS
+GObject *           nm_dhcp6_config_new                 (DBusGConnection *connection,
+                                                         const char *object_path);
+GHashTable *        nm_dhcp6_config_get_options         (NMDHCP6Config *config);
+const char *        nm_dhcp6_config_get_one_option      (NMDHCP6Config *config,
+                                                         const char *option);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDHCP6Config
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMDHCP6Config

+
typedef struct _NMDHCP6Config NMDHCP6Config;
+

+

+
+
+
+

NM_DHCP6_CONFIG_OPTIONS

+
#define NM_DHCP6_CONFIG_OPTIONS "options"
+
+

+

+
+
+
+

nm_dhcp6_config_new ()

+
GObject *           nm_dhcp6_config_new                 (DBusGConnection *connection,
+                                                         const char *object_path);
+

+Creates a new NMDHCP6Config. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

object_path :

the DBus object path of the device +

Returns :

a new configuration +
+
+
+
+

nm_dhcp6_config_get_options ()

+
GHashTable *        nm_dhcp6_config_get_options         (NMDHCP6Config *config);
+

+Gets all the options contained in the configuration. +

+
++ + + + + + + + + + +

config :

a NMDHCP6Config +

Returns :

the GHashTable containing strings for keys and values. +This is the internal copy used by the configuration, and must not be modified. +
+
+
+
+

nm_dhcp6_config_get_one_option ()

+
const char *        nm_dhcp6_config_get_one_option      (NMDHCP6Config *config,
+                                                         const char *option);
+

+Gets one option by option name. +

+
++ + + + + + + + + + + + + + +

config :

a NMDHCP6Config +

option :

the option to retrieve +

Returns :

the configuration option's value. This is the internal string used by the +configuration, and must not be modified. +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/NMGsmDevice.html b/docs/libnm-glib/html/NMGsmDevice.html new file mode 100644 index 00000000..257c3bb8 --- /dev/null +++ b/docs/libnm-glib/html/NMGsmDevice.html @@ -0,0 +1,105 @@ + + + + +NMGsmDevice + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMGsmDevice

+

NMGsmDevice

+
+
+

Synopsis

+
                    NMGsmDevice;
+NMGsmDevice *       nm_gsm_device_new                   (DBusGConnection *connection,
+                                                         const char *path);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMSerialDevice
+                     +----NMGsmDevice
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMGsmDevice

+
typedef struct _NMGsmDevice NMGsmDevice;
+

+

+
+
+
+

nm_gsm_device_new ()

+
NMGsmDevice *       nm_gsm_device_new                   (DBusGConnection *connection,
+                                                         const char *path);
+

+Creates a new NMGsmDevice. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

path :

the DBus object path of the device +

Returns :

a new device +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/NMIP4Config.html b/docs/libnm-glib/html/NMIP4Config.html new file mode 100644 index 00000000..d8b6411e --- /dev/null +++ b/docs/libnm-glib/html/NMIP4Config.html @@ -0,0 +1,370 @@ + + + + +NMIP4Config + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMIP4Config

+

NMIP4Config

+
+ +
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMIP4Config
+
+
+
+

Properties

+
+  "addresses"                gpointer              : Read
+  "domains"                  nm-string-array*      : Read
+  "hostname"                 gchar*                : Read
+  "nameservers"              nm-uint-array*        : Read
+  "routes"                   gpointer              : Read
+  "wins-servers"             nm-uint-array*        : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMIP4Config

+
typedef struct _NMIP4Config NMIP4Config;
+

+

+
+
+
+

NM_IP4_CONFIG_ADDRESSES

+
#define NM_IP4_CONFIG_ADDRESSES "addresses"
+
+

+

+
+
+
+

NM_IP4_CONFIG_HOSTNAME

+
#define NM_IP4_CONFIG_HOSTNAME "hostname" /* DEPRECATED */
+
+

+

+
+
+
+

NM_IP4_CONFIG_NAMESERVERS

+
#define NM_IP4_CONFIG_NAMESERVERS "nameservers"
+
+

+

+
+
+
+

NM_IP4_CONFIG_DOMAINS

+
#define NM_IP4_CONFIG_DOMAINS "domains"
+
+

+

+
+
+
+

NM_IP4_CONFIG_ROUTES

+
#define NM_IP4_CONFIG_ROUTES "routes"
+
+

+

+
+
+
+

NM_IP4_CONFIG_WINS_SERVERS

+
#define NM_IP4_CONFIG_WINS_SERVERS "wins-servers"
+
+

+

+
+
+
+

nm_ip4_config_new ()

+
GObject *           nm_ip4_config_new                   (DBusGConnection *connection,
+                                                         const char *object_path);
+

+Creates a new NMIP4Config. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

object_path :

the DBus object path of the device +

Returns :

a new IP4 configuration +
+
+
+
+

nm_ip4_config_get_addresses ()

+
const GSList *      nm_ip4_config_get_addresses         (NMIP4Config *config);
+

+Gets the IP4 addresses (containing the address, prefix, and gateway). +

+
++ + + + + + + + + + +

config :

a NMIP4Config +

Returns :

the GSList containing NMSettingIP4Addresses. This is the internal copy +used by the configuration and must not be modified. +
+
+
+
+

nm_ip4_config_get_hostname ()

+
const char *        nm_ip4_config_get_hostname          (NMIP4Config *config);
+

+DEPRECATED. Don't use. +

+
++ + + + + + + + + + +

config :

a NMIP4Config +

Returns :

NULL +
+
+
+
+

nm_ip4_config_get_nameservers ()

+
const GArray *      nm_ip4_config_get_nameservers       (NMIP4Config *config);
+

+Gets the domain name servers (DNS). +

+
++ + + + + + + + + + +

config :

a NMIP4Config +

Returns :

the GArray containing guint32s. This is the internal copy used by the +configuration and must not be modified. +
+
+
+
+

nm_ip4_config_get_domains ()

+
const GPtrArray *   nm_ip4_config_get_domains           (NMIP4Config *config);
+

+Gets the domain names. +

+
++ + + + + + + + + + +

config :

a NMIP4Config +

Returns :

the GPtrArray containing domains as strings. This is the +internal copy used by the configuration, and must not be modified. +
+
+
+
+

nm_ip4_config_get_routes ()

+
const GSList *      nm_ip4_config_get_routes            (NMIP4Config *config);
+

+Gets the routes. +

+
++ + + + + + + + + + +

config :

a NMIP4Config +

Returns :

the GSList containing NMSettingIP4Routes. This is the +internal copy used by the configuration, and must not be modified. +
+
+
+
+

nm_ip4_config_get_wins_servers ()

+
const GArray *      nm_ip4_config_get_wins_servers      (NMIP4Config *config);
+

+Gets the Windows Internet Name Service servers (WINS). +

+
++ + + + + + + + + + +

config :

a NMIP4Config +

Returns :

the GArray containing guint32s. This is the internal copy used by the +configuration and must not be modified. +
+
+
+
+

Property Details

+
+

The "addresses" property

+
  "addresses"                gpointer              : Read
+

+The GPtrArray containing NMSettingIP4Addresses of the configuration. +

+
+
+
+

The "domains" property

+
  "domains"                  nm-string-array*      : Read
+

+The GPtrArray containing domain strings of the configuration. +

+
+
+
+

The "hostname" property

+
  "hostname"                 gchar*                : Read
+

+DEPRECATED. Don't use. +

+

Default value: NULL

+
+
+
+

The "nameservers" property

+
  "nameservers"              nm-uint-array*        : Read
+

+The GArray containing name servers (guint32es) of the configuration. +

+
+
+
+

The "routes" property

+
  "routes"                   gpointer              : Read
+

+The GPtrArray containing NMSettingIP4Routes of the configuration. +

+
+
+
+

The "wins-servers" property

+
  "wins-servers"             nm-uint-array*        : Read
+

+The GArray containing WINS servers (guint32es) of the configuration. +

+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/NMIP6Config.html b/docs/libnm-glib/html/NMIP6Config.html new file mode 100644 index 00000000..738699ba --- /dev/null +++ b/docs/libnm-glib/html/NMIP6Config.html @@ -0,0 +1,290 @@ + + + + +NMIP6Config + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMIP6Config

+

NMIP6Config

+
+ +
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMIP6Config
+
+
+
+

Properties

+
+  "addresses"                nm-ip6-address-object-array*  : Read
+  "domains"                  nm-string-array*      : Read
+  "nameservers"              nm-ip6-address-array*  : Read
+  "routes"                   nm-ip6-route-object-array*  : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMIP6Config

+
typedef struct _NMIP6Config NMIP6Config;
+

+

+
+
+
+

NM_IP6_CONFIG_ADDRESSES

+
#define NM_IP6_CONFIG_ADDRESSES "addresses"
+
+

+

+
+
+
+

NM_IP6_CONFIG_NAMESERVERS

+
#define NM_IP6_CONFIG_NAMESERVERS "nameservers"
+
+

+

+
+
+
+

NM_IP6_CONFIG_DOMAINS

+
#define NM_IP6_CONFIG_DOMAINS "domains"
+
+

+

+
+
+
+

NM_IP6_CONFIG_ROUTES

+
#define NM_IP6_CONFIG_ROUTES "routes"
+
+

+

+
+
+
+

nm_ip6_config_new ()

+
GObject *           nm_ip6_config_new                   (DBusGConnection *connection,
+                                                         const char *object_path);
+

+Creates a new NMIP6Config. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

object_path :

the DBus object path of the device +

Returns :

a new IP6 configuration +
+
+
+
+

nm_ip6_config_get_addresses ()

+
const GSList *      nm_ip6_config_get_addresses         (NMIP6Config *config);
+

+Gets the IP6 addresses (containing the address, prefix, and gateway). +

+
++ + + + + + + + + + +

config :

a NMIP6Config +

Returns :

the GSList containing NMSettingIP6Addresses. This is the internal copy +used by the configuration and must not be modified. +
+
+
+
+

nm_ip6_config_get_nameservers ()

+
const GSList *      nm_ip6_config_get_nameservers       (NMIP6Config *config);
+

+Gets the domain name servers (DNS). +

+
++ + + + + + + + + + +

config :

a NMIP6Config +

Returns :

a GSList containing elements of type 'struct in6_addr' which contain +the addresses of nameservers of the configuration. This is the internal copy +used by the configuration and must not be modified. +
+
+
+
+

nm_ip6_config_get_domains ()

+
const GPtrArray *   nm_ip6_config_get_domains           (NMIP6Config *config);
+

+Gets the domain names. +

+
++ + + + + + + + + + +

config :

a NMIP6Config +

Returns :

the GPtrArray containing domains as strings. This is the +internal copy used by the configuration, and must not be modified. +
+
+
+
+

nm_ip6_config_get_routes ()

+
const GSList *      nm_ip6_config_get_routes            (NMIP6Config *config);
+

+Gets the routes. +

+
++ + + + + + + + + + +

config :

a NMIP6Config +

Returns :

the GSList containing NMSettingIP6Routes. This is the +internal copy used by the configuration, and must not be modified. +
+
+
+
+

Property Details

+
+

The "addresses" property

+
  "addresses"                nm-ip6-address-object-array*  : Read
+

+The GPtrArray containing the IPv6 addresses; use +nm_utils_ip6_addresses_from_gvalue() to return a GSList of +NMSettingIP6Address objects that is more usable than the raw data. +

+
+
+
+

The "domains" property

+
  "domains"                  nm-string-array*      : Read
+

+The GPtrArray containing domain strings of the configuration. +

+
+
+
+

The "nameservers" property

+
  "nameservers"              nm-ip6-address-array*  : Read
+

+The GPtrArray containing elements of type 'struct ip6_addr' which +contain the addresses of nameservers of the configuration. +

+
+
+
+

The "routes" property

+
  "routes"                   nm-ip6-route-object-array*  : Read
+

+The GPtrArray containing the IPv6 routes; use +nm_utils_ip6_routes_from_gvalue() to return a GSList of +NMSettingIP6Address objects that is more usable than the raw data. +

+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/NMSerialDevice.html b/docs/libnm-glib/html/NMSerialDevice.html new file mode 100644 index 00000000..a4354823 --- /dev/null +++ b/docs/libnm-glib/html/NMSerialDevice.html @@ -0,0 +1,170 @@ + + + + +NMSerialDevice + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSerialDevice

+

NMSerialDevice

+
+ +
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMSerialDevice
+                     +----NMGsmDevice
+                     +----NMCdmaDevice
+
+
+
+

Signals

+
+  "ppp-stats"                                      : Run First
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMSerialDevice

+
typedef struct _NMSerialDevice NMSerialDevice;
+

+

+
+
+
+

nm_serial_device_get_bytes_received ()

+
guint32             nm_serial_device_get_bytes_received (NMSerialDevice *self);
+

+Gets the amount of bytes received by the serial device. +This counter is reset when the device is activated. +

+
++ + + + + + + + + + +

self :

a NMSerialDevice +

Returns :

bytes received +
+
+
+
+

nm_serial_device_get_bytes_sent ()

+
guint32             nm_serial_device_get_bytes_sent     (NMSerialDevice *self);
+

+Gets the amount of bytes sent by the serial device. +This counter is reset when the device is activated. +

+
++ + + + + + + + + + +

self :

a NMSerialDevice +

Returns :

bytes sent +
+
+
+
+

Signal Details

+
+

The "ppp-stats" signal

+
void                user_function                      (NMSerialDevice *device,
+                                                        guint           in_bytes,
+                                                        guint           out_bytes,
+                                                        gpointer        user_data)      : Run First
+

+Notifies that a NMAccessPoint is added to the wifi device. +

+
++ + + + + + + + + + + + + + + + + + +

device :

the serial device that received the signal +

in_bytes :

the amount of bytes received +

out_bytes :

the amount of bytes sent +

user_data :

user data set when the signal handler was connected.
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/ch01.html b/docs/libnm-glib/html/ch01.html new file mode 100644 index 00000000..c795714a --- /dev/null +++ b/docs/libnm-glib/html/ch01.html @@ -0,0 +1,113 @@ + + + + +libnm-glib Objects + + + + + + + + + + + + + + + + +
+

+libnm-glib Objects

+ +
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/home.png b/docs/libnm-glib/html/home.png new file mode 100644 index 00000000..17003611 Binary files /dev/null and b/docs/libnm-glib/html/home.png differ diff --git a/docs/libnm-glib/html/index.html b/docs/libnm-glib/html/index.html new file mode 100644 index 00000000..5ff93e32 --- /dev/null +++ b/docs/libnm-glib/html/index.html @@ -0,0 +1,116 @@ + + + + +libnm-glib Reference Manual + + + + + + + +
+
+
+
+

+ for libnm-glib 0.8 + The latest version of this documentation can be found on-line at + http://projects.gnome.org/NetworkManager/developers/libnm-glib/08/. +

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/index.sgml b/docs/libnm-glib/html/index.sgml new file mode 100644 index 00000000..810b8b0e --- /dev/null +++ b/docs/libnm-glib/html/index.sgml @@ -0,0 +1,498 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/libnm-glib/html/left.png b/docs/libnm-glib/html/left.png new file mode 100644 index 00000000..2d05b3d5 Binary files /dev/null and b/docs/libnm-glib/html/left.png differ diff --git a/docs/libnm-glib/html/libnm-glib-NMExportedConnection.html b/docs/libnm-glib/html/libnm-glib-NMExportedConnection.html new file mode 100644 index 00000000..58492295 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-NMExportedConnection.html @@ -0,0 +1,89 @@ + + + + +NMExportedConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMExportedConnection

+

NMExportedConnection

+
+ +
+

Description

+

+

+
+
+

Details

+
+

NMExportedConnection

+
typedef struct {
+	NMConnection parent;
+} NMExportedConnection;
+
+

+

+
+
+
+

nm_exported_connection_new ()

+
NMExportedConnection * nm_exported_connection_new       (NMConnectionScope scope);
+

+Creates a new object representing the remote connection. +

+
++ + + + + + + + + + +

scope :

the Connection scope (either user or system) +

Returns :

the new exported connection object on success, or NULL on failure +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-NMRemoteConnection.html b/docs/libnm-glib/html/libnm-glib-NMRemoteConnection.html new file mode 100644 index 00000000..9bac6e61 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-NMRemoteConnection.html @@ -0,0 +1,104 @@ + + + + +NMRemoteConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMRemoteConnection

+

NMRemoteConnection

+
+
+

Synopsis

+
                    NMRemoteConnection;
+NMRemoteConnection * nm_remote_connection_new           (DBusGConnection *bus,
+                                                         NMConnectionScope scope,
+                                                         const char *path);
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMRemoteConnection

+
typedef struct {
+	NMConnection parent;
+} NMRemoteConnection;
+
+

+

+
+
+
+

nm_remote_connection_new ()

+
NMRemoteConnection * nm_remote_connection_new           (DBusGConnection *bus,
+                                                         NMConnectionScope scope,
+                                                         const char *path);
+

+Creates a new object representing the remote connection. +

+
++ + + + + + + + + + + + + + + + + + +

bus :

a valid and connected D-Bus connection +

scope :

the Connection scope (either user or system) +

path :

the D-Bus path of the connection as exported by the settings service + indicated by scope +

Returns :

the new remote connection object on success, or NULL on failure +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-NMRemoteSettingsSystem.html b/docs/libnm-glib/html/libnm-glib-NMRemoteSettingsSystem.html new file mode 100644 index 00000000..c84d4665 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-NMRemoteSettingsSystem.html @@ -0,0 +1,89 @@ + + + + +NMRemoteSettingsSystem + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMRemoteSettingsSystem

+

NMRemoteSettingsSystem

+
+ +
+

Description

+

+

+
+
+

Details

+
+

NMRemoteSettingsSystem

+
typedef struct {
+	NMRemoteSettings parent;
+} NMRemoteSettingsSystem;
+
+

+

+
+
+
+

nm_remote_settings_system_new ()

+
NMRemoteSettingsSystem * nm_remote_settings_system_new  (DBusGConnection *bus);
+

+Creates a new object representing the remote system settings service. +

+
++ + + + + + + + + + +

bus :

a valid and connected D-Bus connection +

Returns :

the new remote system settings object on success, or NULL on failure +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-access-point.html b/docs/libnm-glib/html/libnm-glib-nm-access-point.html new file mode 100644 index 00000000..cfddf32a --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-access-point.html @@ -0,0 +1,503 @@ + + + + +NMAccessPoint + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMAccessPoint

+

NMAccessPoint

+
+ +
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMAccessPoint
+
+
+
+

Properties

+
+  "flags"                    guint                 : Read
+  "frequency"                guint                 : Read
+  "hw-address"               gchar*                : Read
+  "max-bitrate"              guint                 : Read
+  "mode"                     guint                 : Read
+  "rsn-flags"                guint                 : Read
+  "ssid"                     nm-ssid*              : Read
+  "strength"                 guchar                : Read
+  "wpa-flags"                guint                 : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_ACCESS_POINT_FLAGS

+
#define NM_ACCESS_POINT_FLAGS       "flags"
+
+

+

+
+
+
+

NM_ACCESS_POINT_WPA_FLAGS

+
#define NM_ACCESS_POINT_WPA_FLAGS   "wpa-flags"
+
+

+

+
+
+
+

NM_ACCESS_POINT_RSN_FLAGS

+
#define NM_ACCESS_POINT_RSN_FLAGS   "rsn-flags"
+
+

+

+
+
+
+

NM_ACCESS_POINT_SSID

+
#define NM_ACCESS_POINT_SSID        "ssid"
+
+

+

+
+
+
+

NM_ACCESS_POINT_FREQUENCY

+
#define NM_ACCESS_POINT_FREQUENCY   "frequency"
+
+

+

+
+
+
+

NM_ACCESS_POINT_HW_ADDRESS

+
#define NM_ACCESS_POINT_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

NM_ACCESS_POINT_MODE

+
#define NM_ACCESS_POINT_MODE        "mode"
+
+

+

+
+
+
+

NM_ACCESS_POINT_MAX_BITRATE

+
#define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate"
+
+

+

+
+
+
+

NM_ACCESS_POINT_STRENGTH

+
#define NM_ACCESS_POINT_STRENGTH    "strength"
+
+

+

+
+
+
+

NMAccessPoint

+
typedef struct _NMAccessPoint NMAccessPoint;
+

+

+
+
+
+

nm_access_point_new ()

+
GObject *           nm_access_point_new                 (DBusGConnection *connection,
+                                                         const char *path);
+

+Creates a new NMAccessPoint. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

path :

the DBusobject path of the access point +

Returns :

a new access point +
+
+
+
+

nm_access_point_get_flags ()

+
guint32             nm_access_point_get_flags           (NMAccessPoint *ap);
+

+Gets the flags of the access point +

+
++ + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the flags +
+
+
+
+

nm_access_point_get_wpa_flags ()

+
guint32             nm_access_point_get_wpa_flags       (NMAccessPoint *ap);
+

+Gets the WPA flags of the access point. +

+
++ + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the WPA flags +
+
+
+
+

nm_access_point_get_rsn_flags ()

+
guint32             nm_access_point_get_rsn_flags       (NMAccessPoint *ap);
+

+Gets the RSN flags of the access point. +

+
++ + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the RSN flags +
+
+
+
+

nm_access_point_get_ssid ()

+
const GByteArray *  nm_access_point_get_ssid            (NMAccessPoint *ap);
+

+Gets the SSID of the access point. +

+
++ + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the GByteArray containing the SSID. This is the internal copy used by the +access point, and must not be modified. +
+
+
+
+

nm_access_point_get_frequency ()

+
guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);
+

+Gets the frequency of the access point. +

+
++ + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the frequency +
+
+
+
+

nm_access_point_get_hw_address ()

+
const char *        nm_access_point_get_hw_address      (NMAccessPoint *ap);
+

+Gets the hardware (MAC) address of the access point. +

+
++ + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the hardware address of the access point. This is the internal string used by the +access point and must not be modified. +
+
+
+
+

nm_access_point_get_mode ()

+
NM80211Mode         nm_access_point_get_mode            (NMAccessPoint *ap);
+

+Gets the mode of the access point. +

+
++ + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the mode +
+
+
+
+

nm_access_point_get_max_bitrate ()

+
guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);
+

+Gets the maximum bit rate of the access point. +

+
++ + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the maximum bit rate +
+
+
+
+

nm_access_point_get_strength ()

+
guint8              nm_access_point_get_strength        (NMAccessPoint *ap);
+

+Gets the current signal strength of the access point. +

+
++ + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the signal strength +
+
+
+
+

Property Details

+
+

The "flags" property

+
  "flags"                    guint                 : Read
+

+The flags of the access point. +

+

Allowed values: <= 1

+

Default value: 0

+
+
+
+

The "frequency" property

+
  "frequency"                guint                 : Read
+

+The frequency of the access point. +

+

Allowed values: <= 10000

+

Default value: 0

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware address of the access point. +

+

Default value: NULL

+
+
+
+

The "max-bitrate" property

+
  "max-bitrate"              guint                 : Read
+

+The maximum bit rate of the access point. +

+

Default value: 0

+
+
+
+

The "mode" property

+
  "mode"                     guint                 : Read
+

+The mode of the access point. +

+

Allowed values: [1,2]

+

Default value: 2

+
+
+
+

The "rsn-flags" property

+
  "rsn-flags"                guint                 : Read
+

+The RSN flags of the access point. +

+

Default value: 0

+
+
+
+

The "ssid" property

+
  "ssid"                     nm-ssid*              : Read
+

+The SSID of the access point. +

+
+
+
+

The "strength" property

+
  "strength"                 guchar                : Read
+

+The current signal strength of the access point. +

+

Default value: 0

+
+
+
+

The "wpa-flags" property

+
  "wpa-flags"                guint                 : Read
+

+The WPA flags of the access point. +

+

Default value: 0

+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-active-connection.html b/docs/libnm-glib/html/libnm-glib-nm-active-connection.html new file mode 100644 index 00000000..1b5f8fd5 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-active-connection.html @@ -0,0 +1,445 @@ + + + + +NMActiveConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMActiveConnection

+

NMActiveConnection

+
+ +
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMActiveConnection
+
+
+
+

Properties

+
+  "connection"               gchar*                : Read
+  "default"                  gboolean              : Read
+  "default6"                 gboolean              : Read
+  "devices"                  nm-object-array*      : Read
+  "service-name"             gchar*                : Read
+  "specific-object"          gchar*                : Read
+  "state"                    guint                 : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_ACTIVE_CONNECTION_SERVICE_NAME

+
#define NM_ACTIVE_CONNECTION_SERVICE_NAME        "service-name"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_CONNECTION

+
#define NM_ACTIVE_CONNECTION_CONNECTION          "connection"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT

+
#define NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT     "specific-object"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DEVICES

+
#define NM_ACTIVE_CONNECTION_DEVICES             "devices"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_STATE

+
#define NM_ACTIVE_CONNECTION_STATE               "state"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DEFAULT

+
#define NM_ACTIVE_CONNECTION_DEFAULT             "default"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DEFAULT6

+
#define NM_ACTIVE_CONNECTION_DEFAULT6            "default6"
+
+

+

+
+
+
+

NMActiveConnection

+
typedef struct _NMActiveConnection NMActiveConnection;
+

+

+
+
+
+

nm_active_connection_new ()

+
GObject *           nm_active_connection_new            (DBusGConnection *connection,
+                                                         const char *path);
+

+Creates a new NMActiveConnection. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

path :

the DBus object path of the device +

Returns :

a new active connection +
+
+
+
+

nm_active_connection_get_service_name ()

+
const char *        nm_active_connection_get_service_name
+                                                        (NMActiveConnection *connection);
+

+Gets the service name of the active connection. +

+
++ + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the service name. This is the internal string used by the +connection, and must not be modified. +
+
+
+
+

nm_active_connection_get_scope ()

+
NMConnectionScope   nm_active_connection_get_scope      (NMActiveConnection *connection);
+

+Gets the scope of the active connection. +

+
++ + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the connection's scope +
+
+
+
+

nm_active_connection_get_connection ()

+
const char *        nm_active_connection_get_connection (NMActiveConnection *connection);
+

+Gets the NMConnection's DBus object path. +

+
++ + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the object path of the NMConnection inside of NMActiveConnection. +This is the internal string used by the connection, and must not be modified. +
+
+
+
+

nm_active_connection_get_specific_object ()

+
const char *        nm_active_connection_get_specific_object
+                                                        (NMActiveConnection *connection);
+

+Gets the "specific object" used at the activation. +

+
++ + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the specific object's DBus path. This is the internal string used by the +connection, and must not be modified. +
+
+
+
+

nm_active_connection_get_devices ()

+
const GPtrArray *   nm_active_connection_get_devices    (NMActiveConnection *connection);
+

+Gets the NMDevices used for the active connections. +

+
++ + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the GPtrArray containing NMDevices. +This is the internal copy used by the connection, and must not be modified. +
+
+
+
+

nm_active_connection_get_state ()

+
NMActiveConnectionState  nm_active_connection_get_state (NMActiveConnection *connection);
+

+Gets the active connection's state. +

+
++ + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the state +
+
+
+
+

nm_active_connection_get_default ()

+
gboolean            nm_active_connection_get_default    (NMActiveConnection *connection);
+

+Whether the active connection is the default IPv4 one (that is, is used for +the default IPv4 route and DNS information). +

+
++ + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

TRUE if the active connection is the default IPv4 connection +
+
+
+
+

nm_active_connection_get_default6 ()

+
gboolean            nm_active_connection_get_default6   (NMActiveConnection *connection);
+

+Whether the active connection is the default IPv6 one (that is, is used for +the default IPv6 route and DNS information). +

+
++ + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

TRUE if the active connection is the default IPv6 connection +
+
+
+
+

Property Details

+
+

The "connection" property

+
  "connection"               gchar*                : Read
+

+The connection's path of the active connection. +

+

Default value: NULL

+
+
+
+

The "default" property

+
  "default"                  gboolean              : Read
+

+Whether the active connection is the default IPv4 one. +

+

Default value: FALSE

+
+
+
+

The "default6" property

+
  "default6"                 gboolean              : Read
+

+Whether the active connection is the default IPv6 one. +

+

Default value: FALSE

+
+
+
+

The "devices" property

+
  "devices"                  nm-object-array*      : Read
+

Devices.

+
+
+
+

The "service-name" property

+
  "service-name"             gchar*                : Read
+

+The service name of the active connection. +

+

Default value: NULL

+
+
+
+

The "specific-object" property

+
  "specific-object"          gchar*                : Read
+

+The specific object's path of the active connection. +

+

Default value: NULL

+
+
+
+

The "state" property

+
  "state"                    guint                 : Read
+

+The state of the active connection. +

+

Allowed values: <= 2

+

Default value: 0

+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-client.html b/docs/libnm-glib/html/libnm-glib-nm-client.html new file mode 100644 index 00000000..b7af2851 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-client.html @@ -0,0 +1,724 @@ + + + + +NMClient + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMClient

+

NMClient

+
+
+

Synopsis

+
#define             NM_CLIENT_STATE
+#define             NM_CLIENT_MANAGER_RUNNING
+#define             NM_CLIENT_WIRELESS_ENABLED
+#define             NM_CLIENT_WIRELESS_HARDWARE_ENABLED
+#define             NM_CLIENT_WWAN_ENABLED
+#define             NM_CLIENT_WWAN_HARDWARE_ENABLED
+#define             NM_CLIENT_ACTIVE_CONNECTIONS
+                    NMClient;
+NMClient *          nm_client_new                       (void);
+const GPtrArray *   nm_client_get_devices               (NMClient *client);
+NMDevice *          nm_client_get_device_by_path        (NMClient *client,
+                                                         const char *object_path);
+void                (*NMClientActivateDeviceFn)         (gpointer user_data,
+                                                         const char *object_path,
+                                                         GError *error);
+void                nm_client_activate_connection       (NMClient *client,
+                                                         const char *service_name,
+                                                         const char *connection_path,
+                                                         NMDevice *device,
+                                                         const char *specific_object,
+                                                         NMClientActivateDeviceFn callback,
+                                                         gpointer user_data);
+void                nm_client_deactivate_connection     (NMClient *client,
+                                                         NMActiveConnection *active);
+gboolean            nm_client_wireless_get_enabled      (NMClient *client);
+void                nm_client_wireless_set_enabled      (NMClient *client,
+                                                         gboolean enabled);
+gboolean            nm_client_wireless_hardware_get_enabled
+                                                        (NMClient *client);
+gboolean            nm_client_wwan_get_enabled          (NMClient *client);
+void                nm_client_wwan_set_enabled          (NMClient *client,
+                                                         gboolean enabled);
+gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);
+NMState             nm_client_get_state                 (NMClient *client);
+gboolean            nm_client_get_manager_running       (NMClient *client);
+const GPtrArray *   nm_client_get_active_connections    (NMClient *client);
+void                nm_client_sleep                     (NMClient *client,
+                                                         gboolean sleep);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMClient
+
+
+
+

Properties

+
+  "active-connections"       nm-object-array*      : Read
+  "manager-running"          gboolean              : Read
+  "networking-enabled"       gboolean              : Read
+  "state"                    guint                 : Read
+  "wireless-enabled"         gboolean              : Read / Write
+  "wireless-hardware-enabled" gboolean              : Read
+  "wwan-enabled"             gboolean              : Read / Write / Construct
+  "wwan-hardware-enabled"    gboolean              : Read / Write / Construct Only
+
+
+
+

Signals

+
+  "device-added"                                   : Run First
+  "device-removed"                                 : Run First
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_CLIENT_STATE

+
#define NM_CLIENT_STATE "state"
+
+

+

+
+
+
+

NM_CLIENT_MANAGER_RUNNING

+
#define NM_CLIENT_MANAGER_RUNNING "manager-running"
+
+

+

+
+
+
+

NM_CLIENT_WIRELESS_ENABLED

+
#define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled"
+
+

+

+
+
+
+

NM_CLIENT_WIRELESS_HARDWARE_ENABLED

+
#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
+
+

+

+
+
+
+

NM_CLIENT_WWAN_ENABLED

+
#define NM_CLIENT_WWAN_ENABLED "wwan-enabled"
+
+

+

+
+
+
+

NM_CLIENT_WWAN_HARDWARE_ENABLED

+
#define NM_CLIENT_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled"
+
+

+

+
+
+
+

NM_CLIENT_ACTIVE_CONNECTIONS

+
#define NM_CLIENT_ACTIVE_CONNECTIONS "active-connections"
+
+

+

+
+
+
+

NMClient

+
typedef struct _NMClient NMClient;
+

+

+
+
+
+

nm_client_new ()

+
NMClient *          nm_client_new                       (void);
+

+Creates a new NMClient. +

+
++ + + + +

Returns :

a new NMClient +
+
+
+
+

nm_client_get_devices ()

+
const GPtrArray *   nm_client_get_devices               (NMClient *client);
+

+Gets all the detected devices. +

+
++ + + + + + + + + + +

client :

a NMClient +

Returns :

a GPtrArray containing all the NMDevices. +The returned array is owned by the client and should not be modified. +
+
+
+
+

nm_client_get_device_by_path ()

+
NMDevice *          nm_client_get_device_by_path        (NMClient *client,
+                                                         const char *object_path);
+

+Gets a NMDevice from a NMClient. +

+
++ + + + + + + + + + + + + + +

client :

a NMClient +

object_path :

the object path to search for +

Returns :

the NMDevice for the given object_path or NULL if none is found. +
+
+
+
+

NMClientActivateDeviceFn ()

+
void                (*NMClientActivateDeviceFn)         (gpointer user_data,
+                                                         const char *object_path,
+                                                         GError *error);
+

+

+
++ + + + + + + + + + + + + + +

user_data :

+

object_path :

+

error :

+
+
+
+
+

nm_client_activate_connection ()

+
void                nm_client_activate_connection       (NMClient *client,
+                                                         const char *service_name,
+                                                         const char *connection_path,
+                                                         NMDevice *device,
+                                                         const char *specific_object,
+                                                         NMClientActivateDeviceFn callback,
+                                                         gpointer user_data);
+

+Activates a connection with the given NMDevice. +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

client :

a NMClient +

service_name :

the connection's service name +

connection_path :

the connection's DBus path +

device :

the NMDevice +

specific_object :

the device specific object (currently used only for +activating wireless devices and should be the NMAccessPoint's path. +

callback :

the function to call when the call is done +

user_data :

user data to pass to the callback function +
+
+
+
+

nm_client_deactivate_connection ()

+
void                nm_client_deactivate_connection     (NMClient *client,
+                                                         NMActiveConnection *active);
+

+Deactivates an active NMActiveConnection. +

+
++ + + + + + + + + + +

client :

a NMClient +

active :

the NMActiveConnection to deactivate +
+
+
+
+

nm_client_wireless_get_enabled ()

+
gboolean            nm_client_wireless_get_enabled      (NMClient *client);
+

+Determines whether the wireless is enabled. +

+
++ + + + + + + + + + +

client :

a NMClient +

Returns :

TRUE if wireless is enabled +
+
+
+
+

nm_client_wireless_set_enabled ()

+
void                nm_client_wireless_set_enabled      (NMClient *client,
+                                                         gboolean enabled);
+

+Enables or disables wireless devices. +

+
++ + + + + + + + + + +

client :

a NMClient +

enabled :

+TRUE to enable wireless +
+
+
+
+

nm_client_wireless_hardware_get_enabled ()

+
gboolean            nm_client_wireless_hardware_get_enabled
+                                                        (NMClient *client);
+

+Determines whether the wireless hardware is enabled. +

+
++ + + + + + + + + + +

client :

a NMClient +

Returns :

TRUE if the wireless hardware is enabled +
+
+
+
+

nm_client_wwan_get_enabled ()

+
gboolean            nm_client_wwan_get_enabled          (NMClient *client);
+

+Determines whether WWAN is enabled. +

+
++ + + + + + + + + + +

client :

a NMClient +

Returns :

TRUE if WWAN is enabled +
+
+
+
+

nm_client_wwan_set_enabled ()

+
void                nm_client_wwan_set_enabled          (NMClient *client,
+                                                         gboolean enabled);
+

+Enables or disables WWAN devices. +

+
++ + + + + + + + + + +

client :

a NMClient +

enabled :

+TRUE to enable WWAN +
+
+
+
+

nm_client_wwan_hardware_get_enabled ()

+
gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);
+

+Determines whether the WWAN hardware is enabled. +

+
++ + + + + + + + + + +

client :

a NMClient +

Returns :

TRUE if the WWAN hardware is enabled +
+
+
+
+

nm_client_get_state ()

+
NMState             nm_client_get_state                 (NMClient *client);
+

+Gets the current daemon state. +

+
++ + + + + + + + + + +

client :

a NMClient +

Returns :

the current NMState +
+
+
+
+

nm_client_get_manager_running ()

+
gboolean            nm_client_get_manager_running       (NMClient *client);
+

+Determines whether the daemon is running. +

+
++ + + + + + + + + + +

client :

a NMClient +

Returns :

TRUE if the daemon is running +
+
+
+
+

nm_client_get_active_connections ()

+
const GPtrArray *   nm_client_get_active_connections    (NMClient *client);
+

+Gets the active connections. +

+
++ + + + + + + + + + +

client :

a NMClient +

Returns :

a GPtrArray containing all the active NMActiveConnections. +The returned array is owned by the client and should not be modified. +
+
+
+
+

nm_client_sleep ()

+
void                nm_client_sleep                     (NMClient *client,
+                                                         gboolean sleep);
+

+Deprecated; use nm_client_networking_set_enabled() instead. +

+
++ + + + + + + + + + +

client :

a NMClient +

sleep :

+TRUE to put the daemon to sleep +
+
+
+
+

Property Details

+
+

The "active-connections" property

+
  "active-connections"       nm-object-array*      : Read
+

Active connections.

+
+
+
+

The "manager-running" property

+
  "manager-running"          gboolean              : Read
+

Whether NetworkManager is running.

+

Default value: FALSE

+
+
+
+

The "networking-enabled" property

+
  "networking-enabled"       gboolean              : Read
+

Is networking enabled.

+

Default value: TRUE

+
+
+
+

The "state" property

+
  "state"                    guint                 : Read
+

+The current daemon state. +

+

Allowed values: <= 4

+

Default value: 0

+
+
+
+

The "wireless-enabled" property

+
  "wireless-enabled"         gboolean              : Read / Write
+

Is wireless enabled.

+

Default value: TRUE

+
+
+
+

The "wireless-hardware-enabled" property

+
  "wireless-hardware-enabled" gboolean              : Read
+

Is wireless hardware enabled.

+

Default value: TRUE

+
+
+
+

The "wwan-enabled" property

+
  "wwan-enabled"             gboolean              : Read / Write / Construct
+

Is WWAN enabled.

+

Default value: TRUE

+
+
+
+

The "wwan-hardware-enabled" property

+
  "wwan-hardware-enabled"    gboolean              : Read / Write / Construct Only
+

Is WWAN hardware enabled.

+

Default value: TRUE

+
+
+
+

Signal Details

+
+

The "device-added" signal

+
void                user_function                      (NMClient *client,
+                                                        GObject  *device,
+                                                        gpointer  user_data)      : Run First
+

+Notifies that a NMDevice is added. +

+
++ + + + + + + + + + + + + + +

client :

the client that received the signal +

device :

the new device +

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "device-removed" signal

+
void                user_function                      (NMClient *widget,
+                                                        GObject  *device,
+                                                        gpointer  user_data)      : Run First
+

+Notifies that a NMDevice is removed. +

+
++ + + + + + + + + + + + + + +

widget :

the client that received the signal +

device :

the removed device +

user_data :

user data set when the signal handler was connected.
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-device-bt.html b/docs/libnm-glib/html/libnm-glib-nm-device-bt.html new file mode 100644 index 00000000..4372ca11 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-device-bt.html @@ -0,0 +1,196 @@ + + + + +NMDeviceBt + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceBt

+

NMDeviceBt

+
+
+

Synopsis

+
#define             NM_DEVICE_BT_HW_ADDRESS
+#define             NM_DEVICE_BT_NAME
+#define             NM_DEVICE_BT_CAPABILITIES
+                    NMDeviceBt;
+GObject *           nm_device_bt_new                    (DBusGConnection *connection,
+                                                         const char *path);
+const char *        nm_device_bt_get_hw_address         (NMDeviceBt *device);
+const char *        nm_device_bt_get_name               (NMDeviceBt *device);
+NMBluetoothCapabilities  nm_device_bt_get_capabilities  (NMDeviceBt *device);
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_BT_HW_ADDRESS

+
#define NM_DEVICE_BT_HW_ADDRESS   "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_BT_NAME

+
#define NM_DEVICE_BT_NAME         "name"
+
+

+

+
+
+
+

NM_DEVICE_BT_CAPABILITIES

+
#define NM_DEVICE_BT_CAPABILITIES "bt-capabilities"
+
+

+

+
+
+
+

NMDeviceBt

+
typedef struct {
+	NMDevice parent;
+} NMDeviceBt;
+
+

+

+
+
+
+

nm_device_bt_new ()

+
GObject *           nm_device_bt_new                    (DBusGConnection *connection,
+                                                         const char *path);
+

+Creates a new NMDeviceBt. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

path :

the DBus object path of the device +

Returns :

a new device +
+
+
+
+

nm_device_bt_get_hw_address ()

+
const char *        nm_device_bt_get_hw_address         (NMDeviceBt *device);
+

+Gets the hardware (MAC) address of the NMDeviceBt +

+
++ + + + + + + + + + +

device :

a NMDeviceBt +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified. +
+
+
+
+

nm_device_bt_get_name ()

+
const char *        nm_device_bt_get_name               (NMDeviceBt *device);
+

+Gets the name of the NMDeviceBt. +

+
++ + + + + + + + + + +

device :

a NMDeviceBt +

Returns :

the name of the device +
+
+
+
+

nm_device_bt_get_capabilities ()

+
NMBluetoothCapabilities  nm_device_bt_get_capabilities  (NMDeviceBt *device);
+

+Returns the Bluetooth device's usable capabilities. +

+
++ + + + + + + + + + +

device :

a NMDeviceBt +

Returns :

a combination of NMBluetoothCapabilities +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-device-ethernet.html b/docs/libnm-glib/html/libnm-glib-nm-device-ethernet.html new file mode 100644 index 00000000..ad47fde5 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-device-ethernet.html @@ -0,0 +1,243 @@ + + + + +NMDeviceEthernet + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceEthernet

+

NMDeviceEthernet

+
+ +
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceEthernet
+
+
+
+

Properties

+
+  "carrier"                  gboolean              : Read
+  "hw-address"               gchar*                : Read
+  "speed"                    guint                 : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_ETHERNET_HW_ADDRESS

+
#define NM_DEVICE_ETHERNET_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_ETHERNET_SPEED

+
#define NM_DEVICE_ETHERNET_SPEED       "speed"
+
+

+

+
+
+
+

NM_DEVICE_ETHERNET_CARRIER

+
#define NM_DEVICE_ETHERNET_CARRIER     "carrier"
+
+

+

+
+
+
+

NMDeviceEthernet

+
typedef struct _NMDeviceEthernet NMDeviceEthernet;
+

+

+
+
+
+

nm_device_ethernet_new ()

+
GObject *           nm_device_ethernet_new              (DBusGConnection *connection,
+                                                         const char *path);
+

+Creates a new NMDeviceEthernet. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

path :

the DBus object path of the device +

Returns :

a new device +
+
+
+
+

nm_device_ethernet_get_hw_address ()

+
const char *        nm_device_ethernet_get_hw_address   (NMDeviceEthernet *device);
+

+Gets the hardware (MAC) address of the NMDeviceEthernet +

+
++ + + + + + + + + + +

device :

a NMDeviceEthernet +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified. +
+
+
+
+

nm_device_ethernet_get_speed ()

+
guint32             nm_device_ethernet_get_speed        (NMDeviceEthernet *device);
+

+Gets the speed of the NMDeviceEthernet. +

+
++ + + + + + + + + + +

device :

a NMDeviceEthernet +

Returns :

the speed of the device +
+
+
+
+

nm_device_ethernet_get_carrier ()

+
gboolean            nm_device_ethernet_get_carrier      (NMDeviceEthernet *device);
+

+Whether the device has carrier. +

+
++ + + + + + + + + + +

device :

a NMDeviceEthernet +

Returns :

TRUE if the device has carrier +
+
+
+
+

Property Details

+
+

The "carrier" property

+
  "carrier"                  gboolean              : Read
+

+Whether the device has carrier. +

+

Default value: FALSE

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "speed" property

+
  "speed"                    guint                 : Read
+

+The speed of the device. +

+

Default value: 0

+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-device-wifi.html b/docs/libnm-glib/html/libnm-glib-nm-device-wifi.html new file mode 100644 index 00000000..acc5f6e0 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-device-wifi.html @@ -0,0 +1,458 @@ + + + + +NMDeviceWifi + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceWifi

+

NMDeviceWifi

+
+ +
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceWifi
+
+
+
+

Properties

+
+  "active-access-point"      NMAccessPoint*        : Read
+  "bitrate"                  guint                 : Read
+  "hw-address"               gchar*                : Read
+  "mode"                     guint                 : Read
+  "wireless-capabilities"    guint                 : Read
+
+
+
+

Signals

+
+  "access-point-added"                             : Run First
+  "access-point-removed"                           : Run First
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_WIFI_HW_ADDRESS

+
#define NM_DEVICE_WIFI_HW_ADDRESS          "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_WIFI_MODE

+
#define NM_DEVICE_WIFI_MODE                "mode"
+
+

+

+
+
+
+

NM_DEVICE_WIFI_BITRATE

+
#define NM_DEVICE_WIFI_BITRATE             "bitrate"
+
+

+

+
+
+
+

NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT

+
#define NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT "active-access-point"
+
+

+

+
+
+
+

NM_DEVICE_WIFI_CAPABILITIES

+
#define NM_DEVICE_WIFI_CAPABILITIES        "wireless-capabilities"
+
+

+

+
+
+
+

NMDeviceWifi

+
typedef struct _NMDeviceWifi NMDeviceWifi;
+

+

+
+
+
+

nm_device_wifi_new ()

+
GObject *           nm_device_wifi_new                  (DBusGConnection *connection,
+                                                         const char *path);
+

+Creates a new NMDeviceWifi. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

path :

the DBus object path of the device +

Returns :

a new device +
+
+
+
+

nm_device_wifi_get_hw_address ()

+
const char *        nm_device_wifi_get_hw_address       (NMDeviceWifi *device);
+

+Gets the hardware (MAC) address of the NMDeviceWifi +

+
++ + + + + + + + + + +

device :

a NMDeviceWifi +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified. +
+
+
+
+

nm_device_wifi_get_mode ()

+
NM80211Mode         nm_device_wifi_get_mode             (NMDeviceWifi *device);
+

+Gets the NMDeviceWifi mode. +

+
++ + + + + + + + + + +

device :

a NMDeviceWifi +

Returns :

the mode +
+
+
+
+

nm_device_wifi_get_bitrate ()

+
guint32             nm_device_wifi_get_bitrate          (NMDeviceWifi *device);
+

+Gets the bit rate of the NMDeviceWifi. +

+
++ + + + + + + + + + +

device :

a NMDeviceWifi +

Returns :

the bit rate +
+
+
+
+

nm_device_wifi_get_capabilities ()

+
guint32             nm_device_wifi_get_capabilities     (NMDeviceWifi *device);
+

+Gets the WIFI capabilities of the NMDeviceWifi. +

+
++ + + + + + + + + + +

device :

a NMDeviceWifi +

Returns :

the capabilities +
+
+
+
+

nm_device_wifi_get_active_access_point ()

+
NMAccessPoint *     nm_device_wifi_get_active_access_point
+                                                        (NMDeviceWifi *device);
+

+Gets the active NMAccessPoint. +

+
++ + + + + + + + + + +

device :

a NMDeviceWifi +

Returns :

the access point or NULL if none is active +
+
+
+
+

nm_device_wifi_get_access_point_by_path ()

+
NMAccessPoint *     nm_device_wifi_get_access_point_by_path
+                                                        (NMDeviceWifi *device,
+                                                         const char *path);
+

+Gets a NMAccessPoint by path. +

+
++ + + + + + + + + + + + + + +

device :

a NMDeviceWifi +

path :

the object path of the access point +

Returns :

the access point or NULL if none is found. +
+
+
+
+

nm_device_wifi_get_access_points ()

+
const GPtrArray *   nm_device_wifi_get_access_points    (NMDeviceWifi *device);
+

+Gets all the scanned access points of the NMDeviceWifi. +

+
++ + + + + + + + + + +

device :

a NMDeviceWifi +

Returns :

a GPtrArray containing all the scanned NMAccessPoints. +The returned array is owned by the client and should not be modified. +
+
+
+
+

Property Details

+
+

The "active-access-point" property

+
  "active-access-point"      NMAccessPoint*        : Read
+

+The active NMAccessPoint of the device. +

+
+
+
+

The "bitrate" property

+
  "bitrate"                  guint                 : Read
+

+The bit rate of the device. +

+

Default value: 0

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "mode" property

+
  "mode"                     guint                 : Read
+

+The mode of the device. +

+

Allowed values: <= 2

+

Default value: 2

+
+
+
+

The "wireless-capabilities" property

+
  "wireless-capabilities"    guint                 : Read
+

+The wireless capabilities of the device. +

+

Default value: 0

+
+
+
+

Signal Details

+
+

The "access-point-added" signal

+
void                user_function                      (NMDeviceWifi *device,
+                                                        GObject      *ap,
+                                                        gpointer      user_data)      : Run First
+

+Notifies that a NMAccessPoint is added to the wifi device. +

+
++ + + + + + + + + + + + + + +

device :

the wifi device that received the signal +

ap :

the new access point +

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "access-point-removed" signal

+
void                user_function                      (NMDeviceWifi *device,
+                                                        GObject      *ap,
+                                                        gpointer      user_data)      : Run First
+

+Notifies that a NMAccessPoint is removed from the wifi device. +

+
++ + + + + + + + + + + + + + +

device :

the wifi device that received the signal +

ap :

the removed access point +

user_data :

user data set when the signal handler was connected.
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-device.html b/docs/libnm-glib/html/libnm-glib-nm-device.html new file mode 100644 index 00000000..d37903e1 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-device.html @@ -0,0 +1,743 @@ + + + + +NMDevice + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDevice

+

NMDevice

+
+
+

Synopsis

+
#define             NM_DEVICE_UDI
+#define             NM_DEVICE_INTERFACE
+#define             NM_DEVICE_DRIVER
+#define             NM_DEVICE_CAPABILITIES
+#define             NM_DEVICE_MANAGED
+#define             NM_DEVICE_IP4_CONFIG
+#define             NM_DEVICE_DHCP4_CONFIG
+#define             NM_DEVICE_IP6_CONFIG
+#define             NM_DEVICE_DHCP6_CONFIG
+#define             NM_DEVICE_STATE
+#define             NM_DEVICE_VENDOR
+#define             NM_DEVICE_PRODUCT
+                    NMDevice;
+GObject *           nm_device_new                       (DBusGConnection *connection,
+                                                         const char *path);
+const char *        nm_device_get_iface                 (NMDevice *device);
+const char *        nm_device_get_udi                   (NMDevice *device);
+const char *        nm_device_get_driver                (NMDevice *device);
+guint32             nm_device_get_capabilities          (NMDevice *device);
+gboolean            nm_device_get_managed               (NMDevice *device);
+NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);
+NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);
+NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);
+NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);
+NMDeviceState       nm_device_get_state                 (NMDevice *device);
+const char *        nm_device_get_product               (NMDevice *device);
+const char *        nm_device_get_vendor                (NMDevice *device);
+void                (*NMDeviceDeactivateFn)             (NMDevice *device,
+                                                         GError *error,
+                                                         gpointer user_data);
+void                nm_device_disconnect                (NMDevice *device,
+                                                         NMDeviceDeactivateFn callback,
+                                                         gpointer user_data);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceEthernet
+               +----NMDeviceWifi
+               +----NMSerialDevice
+
+
+
+

Properties

+
+  "capabilities"             guint                 : Read
+  "dhcp4-config"             NMDHCP4Config*        : Read
+  "dhcp6-config"             NMDHCP6Config*        : Read
+  "driver"                   gchar*                : Read
+  "interface"                gchar*                : Read
+  "ip4-config"               NMIP4Config*          : Read
+  "ip6-config"               NMIP6Config*          : Read
+  "managed"                  gboolean              : Read
+  "product"                  gchar*                : Read
+  "state"                    guint                 : Read
+  "udi"                      gchar*                : Read
+  "vendor"                   gchar*                : Read
+
+
+
+

Signals

+
+  "state-changed"                                  : Run First
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_DEVICE_UDI

+
#define NM_DEVICE_UDI "udi"
+
+

+

+
+
+
+

NM_DEVICE_INTERFACE

+
#define NM_DEVICE_INTERFACE "interface"
+
+

+

+
+
+
+

NM_DEVICE_DRIVER

+
#define NM_DEVICE_DRIVER "driver"
+
+

+

+
+
+
+

NM_DEVICE_CAPABILITIES

+
#define NM_DEVICE_CAPABILITIES "capabilities"
+
+

+

+
+
+
+

NM_DEVICE_MANAGED

+
#define NM_DEVICE_MANAGED "managed"
+
+

+

+
+
+
+

NM_DEVICE_IP4_CONFIG

+
#define NM_DEVICE_IP4_CONFIG "ip4-config"
+
+

+

+
+
+
+

NM_DEVICE_DHCP4_CONFIG

+
#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
+
+

+

+
+
+
+

NM_DEVICE_IP6_CONFIG

+
#define NM_DEVICE_IP6_CONFIG "ip6-config"
+
+

+

+
+
+
+

NM_DEVICE_DHCP6_CONFIG

+
#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
+
+

+

+
+
+
+

NM_DEVICE_STATE

+
#define NM_DEVICE_STATE "state"
+
+

+

+
+
+
+

NM_DEVICE_VENDOR

+
#define NM_DEVICE_VENDOR "vendor"
+
+

+

+
+
+
+

NM_DEVICE_PRODUCT

+
#define NM_DEVICE_PRODUCT "product"
+
+

+

+
+
+
+

NMDevice

+
typedef struct _NMDevice NMDevice;
+

+

+
+
+
+

nm_device_new ()

+
GObject *           nm_device_new                       (DBusGConnection *connection,
+                                                         const char *path);
+

+Creates a new NMDevice. +

+
++ + + + + + + + + + + + + + +

connection :

the DBusGConnection +

path :

the DBus object path of the device +

Returns :

a new device +
+
+
+
+

nm_device_get_iface ()

+
const char *        nm_device_get_iface                 (NMDevice *device);
+

+Gets the interface name of the NMDevice. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the interface of the device. This is the internal string used by the +device, and must not be modified. +
+
+
+
+

nm_device_get_udi ()

+
const char *        nm_device_get_udi                   (NMDevice *device);
+

+Gets the Unique Device Identifier of the NMDevice. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the Unique Device Identifier of the device. This identifier may be +used to gather more information about the device from various operating +system services like udev or sysfs. +
+
+
+
+

nm_device_get_driver ()

+
const char *        nm_device_get_driver                (NMDevice *device);
+

+Gets the driver of the NMDevice. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the driver of the device. This is the internal string used by the +device, and must not be modified. +
+
+
+
+

nm_device_get_capabilities ()

+
guint32             nm_device_get_capabilities          (NMDevice *device);
+

+Gets the device' capabilities. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the capabilities +
+
+
+
+

nm_device_get_managed ()

+
gboolean            nm_device_get_managed               (NMDevice *device);
+

+Whether the NMDevice is managed by NetworkManager. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

TRUE if the device is managed by NetworkManager +
+
+
+
+

nm_device_get_ip4_config ()

+
NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);
+

+Gets the current NMIP4Config associated with the NMDevice. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the NMIP4Config or NULL if the device is not activated. +
+
+
+
+

nm_device_get_dhcp4_config ()

+
NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);
+

+Gets the current NMDHCP4Config associated with the NMDevice. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the NMDHCPConfig or NULL if the device is not activated or not +using DHCP. +
+
+
+
+

nm_device_get_ip6_config ()

+
NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);
+

+Gets the current NMIP6Config associated with the NMDevice. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the NMIP6Config or NULL if the device is not activated. +
+
+
+
+

nm_device_get_dhcp6_config ()

+
NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);
+

+Gets the current NMDHCP6Config associated with the NMDevice. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the NMDHCPConfig or NULL if the device is not activated or not +using DHCP. +
+
+
+
+

nm_device_get_state ()

+
NMDeviceState       nm_device_get_state                 (NMDevice *device);
+

+Gets the current NMDevice state. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the current device state +
+
+
+
+

nm_device_get_product ()

+
const char *        nm_device_get_product               (NMDevice *device);
+

+Gets the product string of the NMDevice. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the product name of the device. This is the internal string used by the +device, and must not be modified. +
+
+
+
+

nm_device_get_vendor ()

+
const char *        nm_device_get_vendor                (NMDevice *device);
+

+Gets the vendor string of the NMDevice. +

+
++ + + + + + + + + + +

device :

a NMDevice +

Returns :

the vendor name of the device. This is the internal string used by the +device, and must not be modified. +
+
+
+
+

NMDeviceDeactivateFn ()

+
void                (*NMDeviceDeactivateFn)             (NMDevice *device,
+                                                         GError *error,
+                                                         gpointer user_data);
+

+

+
++ + + + + + + + + + + + + + +

device :

+

error :

+

user_data :

+
+
+
+
+

nm_device_disconnect ()

+
void                nm_device_disconnect                (NMDevice *device,
+                                                         NMDeviceDeactivateFn callback,
+                                                         gpointer user_data);
+

+Disconnects the device if currently connected, and prevents the device from +automatically connecting to networks until the next manual network connection +request. +

+
++ + + + + + + + + + + + + + +

device :

a NMDevice +

callback :

callback to be called when disconnect operation completes +

user_data :

caller-specific data passed to callback +
+
+
+
+

Property Details

+
+

The "capabilities" property

+
  "capabilities"             guint                 : Read
+

+The capabilities of the device. +

+

Default value: 0

+
+
+
+

The "dhcp4-config" property

+
  "dhcp4-config"             NMDHCP4Config*        : Read
+

+The NMDHCP4Config of the device. +

+
+
+
+

The "dhcp6-config" property

+
  "dhcp6-config"             NMDHCP6Config*        : Read
+

+The NMDHCP6Config of the device. +

+
+
+
+

The "driver" property

+
  "driver"                   gchar*                : Read
+

+The driver of the device. +

+

Default value: NULL

+
+
+
+

The "interface" property

+
  "interface"                gchar*                : Read
+

+The interface of the device. +

+

Default value: NULL

+
+
+
+

The "ip4-config" property

+
  "ip4-config"               NMIP4Config*          : Read
+

+The NMIP4Config of the device. +

+
+
+
+

The "ip6-config" property

+
  "ip6-config"               NMIP6Config*          : Read
+

+The NMIP6Config of the device. +

+
+
+
+

The "managed" property

+
  "managed"                  gboolean              : Read
+

+Whether the device is managed by NetworkManager. +

+

Default value: FALSE

+
+
+
+

The "product" property

+
  "product"                  gchar*                : Read
+

+The product string of the device. +

+

Default value: NULL

+
+
+
+

The "state" property

+
  "state"                    guint                 : Read
+

+The state of the device. +

+

Default value: 0

+
+
+
+

The "udi" property

+
  "udi"                      gchar*                : Read
+

+The Unique Device Identifier of the device. +

+

Default value: NULL

+
+
+
+

The "vendor" property

+
  "vendor"                   gchar*                : Read
+

+The vendor string of the device. +

+

Default value: NULL

+
+
+
+

Signal Details

+
+

The "state-changed" signal

+
void                user_function                      (NMDevice *device,
+                                                        guint     state,
+                                                        guint     arg2,
+                                                        guint     arg3,
+                                                        gpointer  user_data)      : Run First
+

+Notifies the state change of a NMDevice. +

+
++ + + + + + + + + + + + + + +

device :

the client that received the signal +

state :

the new state of the device +

user_data :

user data set when the signal handler was connected.
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-object.html b/docs/libnm-glib/html/libnm-glib-nm-object.html new file mode 100644 index 00000000..1a511d0b --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-object.html @@ -0,0 +1,170 @@ + + + + +NMObject + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMObject

+

NMObject

+
+ +
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMClient
+         +----NMDevice
+         +----NMAccessPoint
+         +----NMIP4Config
+         +----NMActiveConnection
+         +----NMDHCP4Config
+         +----NMIP6Config
+         +----NMDHCP6Config
+
+
+
+

Properties

+
+  "dbus-connection"          DBusGConnection*      : Read / Write / Construct Only
+  "dbus-path"                gchar*                : Read / Write / Construct Only
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_OBJECT_DBUS_CONNECTION

+
#define NM_OBJECT_DBUS_CONNECTION "dbus-connection"
+
+

+

+
+
+
+

NM_OBJECT_DBUS_PATH

+
#define NM_OBJECT_DBUS_PATH "dbus-path"
+
+

+

+
+
+
+

NMObject

+
typedef struct _NMObject NMObject;
+

+

+
+
+
+

nm_object_get_connection ()

+
DBusGConnection *   nm_object_get_connection            (NMObject *object);
+

+Gets the NMObject's DBusGConnection. +

+
++ + + + + + + + + + +

object :

a NMObject +

Returns :

the connection +
+
+
+
+

nm_object_get_path ()

+
const char *        nm_object_get_path                  (NMObject *object);
+

+Gets the DBus path of the NMObject. +

+
++ + + + + + + + + + +

object :

a NMObject +

Returns :

the object's path. This is the internal string used by the +device, and must not be modified. +
+
+
+
+

Property Details

+
+

The "dbus-connection" property

+
  "dbus-connection"          DBusGConnection*      : Read / Write / Construct Only
+

Connection.

+
+
+
+

The "dbus-path" property

+
  "dbus-path"                gchar*                : Read / Write / Construct Only
+

DBus Object Path.

+

Default value: NULL

+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-remote-settings.html b/docs/libnm-glib/html/libnm-glib-nm-remote-settings.html new file mode 100644 index 00000000..7f2c41cb --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-remote-settings.html @@ -0,0 +1,123 @@ + + + + +NMRemoteSettings + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMRemoteSettings

+

NMRemoteSettings

+
+ +
+

Description

+

+

+
+
+

Details

+
+

NM_REMOTE_SETTINGS_BUS

+
#define NM_REMOTE_SETTINGS_BUS "bus"
+
+

+

+
+
+
+

NM_REMOTE_SETTINGS_SCOPE

+
#define NM_REMOTE_SETTINGS_SCOPE "scope"
+
+

+

+
+
+
+

NM_REMOTE_SETTINGS_SERVICE_RUNNING

+
#define NM_REMOTE_SETTINGS_SERVICE_RUNNING "service-running"
+
+

+

+
+
+
+

NMRemoteSettings

+
typedef struct {
+	GObject parent;
+} NMRemoteSettings;
+
+

+

+
+
+
+

nm_remote_settings_new ()

+
NMRemoteSettings *  nm_remote_settings_new              (DBusGConnection *bus,
+                                                         NMConnectionScope scope);
+

+Creates a new object representing the remote settings service. +

+
++ + + + + + + + + + + + + + +

bus :

a valid and connected D-Bus connection +

scope :

the settings service scope (either user or system) +

Returns :

the new remote settings object on success, or NULL on failure +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-settings-connection-interface.html b/docs/libnm-glib/html/libnm-glib-nm-settings-connection-interface.html new file mode 100644 index 00000000..3fada84f --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-settings-connection-interface.html @@ -0,0 +1,403 @@ + + + + +nm-settings-connection-interface + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-settings-connection-interface

+

nm-settings-connection-interface

+
+ +
+

Description

+

+

+
+
+

Details

+
+

NM_SETTINGS_CONNECTION_INTERFACE_GET_INTERFACE()

+
#define NM_SETTINGS_CONNECTION_INTERFACE_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), NM_TYPE_SETTINGS_CONNECTION_INTERFACE, NMSettingsConnectionInterface))
+
+

+

+
++ + + + +

obj :

+
+
+
+
+

NM_SETTINGS_CONNECTION_INTERFACE_UPDATED

+
#define NM_SETTINGS_CONNECTION_INTERFACE_UPDATED               "updated"
+
+

+

+
+
+
+

NM_SETTINGS_CONNECTION_INTERFACE_REMOVED

+
#define NM_SETTINGS_CONNECTION_INTERFACE_REMOVED               "removed"
+
+

+

+
+
+
+

NMSettingsConnectionInterface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	/* Methods */
+	gboolean (*update) (NMSettingsConnectionInterface *connection,
+	                    NMSettingsConnectionInterfaceUpdateFunc callback,
+	                    gpointer user_data);
+
+	gboolean (*delete) (NMSettingsConnectionInterface *connection,
+	                    NMSettingsConnectionInterfaceDeleteFunc callback,
+	                    gpointer user_data);
+
+	gboolean (*get_secrets) (NMSettingsConnectionInterface *connection,
+	                         const char *setting_name,
+                             const char **hints,
+                             gboolean request_new,
+                             NMSettingsConnectionInterfaceGetSecretsFunc callback,
+                             gpointer user_data);
+
+	void (*emit_updated) (NMSettingsConnectionInterface *connection);
+
+	/* Signals */
+	/* 'new_settings' hash should *not* contain secrets */
+	void (*updated) (NMSettingsConnectionInterface *connection,
+	                 GHashTable *new_settings);
+
+	void (*removed) (NMSettingsConnectionInterface *connection);
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+	void (*_reserved5) (void);
+	void (*_reserved6) (void);
+} NMSettingsConnectionInterface;
+
+

+

+
+
+
+

NMSettingsConnectionInterfaceUpdateFunc ()

+
void                (*NMSettingsConnectionInterfaceUpdateFunc)
+                                                        (NMSettingsConnectionInterface *connection,
+                                                         GError *error,
+                                                         gpointer user_data);
+

+

+
++ + + + + + + + + + + + + + +

connection :

+

error :

+

user_data :

+
+
+
+
+

NMSettingsConnectionInterfaceDeleteFunc ()

+
void                (*NMSettingsConnectionInterfaceDeleteFunc)
+                                                        (NMSettingsConnectionInterface *connection,
+                                                         GError *error,
+                                                         gpointer user_data);
+

+

+
++ + + + + + + + + + + + + + +

connection :

+

error :

+

user_data :

+
+
+
+
+

NMSettingsConnectionInterfaceGetSecretsFunc ()

+
void                (*NMSettingsConnectionInterfaceGetSecretsFunc)
+                                                        (NMSettingsConnectionInterface *connection,
+                                                         GHashTable *secrets,
+                                                         GError *error,
+                                                         gpointer user_data);
+

+

+
++ + + + + + + + + + + + + + + + + + +

connection :

+

secrets :

+

error :

+

user_data :

+
+
+
+
+

nm_settings_connection_interface_update ()

+
gboolean            nm_settings_connection_interface_update
+                                                        (NMSettingsConnectionInterface *connection,
+                                                         NMSettingsConnectionInterfaceUpdateFunc callback,
+                                                         gpointer user_data);
+

+Update the connection with current settings and properties. +

+
++ + + + + + + + + + + + + + + + + + +

connection :

an object implementing NMSettingsConnectionInterface +

callback :

a function to be called when the update completes +

user_data :

caller-specific data to be passed to callback +

Returns :

TRUE on success, FALSE on failure +
+
+
+
+

nm_settings_connection_interface_delete ()

+
gboolean            nm_settings_connection_interface_delete
+                                                        (NMSettingsConnectionInterface *connection,
+                                                         NMSettingsConnectionInterfaceDeleteFunc callback,
+                                                         gpointer user_data);
+

+Delete the connection. +

+
++ + + + + + + + + + + + + + + + + + +

connection :

a objecting implementing NMSettingsConnectionInterface +

callback :

a function to be called when the delete completes +

user_data :

caller-specific data to be passed to callback +

Returns :

TRUE on success, FALSE on failure +
+
+
+
+

nm_settings_connection_interface_get_secrets ()

+
gboolean            nm_settings_connection_interface_get_secrets
+                                                        (NMSettingsConnectionInterface *connection,
+                                                         const char *setting_name,
+                                                         const char **hints,
+                                                         gboolean request_new,
+                                                         NMSettingsConnectionInterfaceGetSecretsFunc callback,
+                                                         gpointer user_data);
+

+Request the connection's secrets. +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

connection :

a object implementing NMSettingsConnectionInterface +

setting_name :

the NMSetting object name to get secrets for +

hints :

+NMSetting key names to get secrets for (optional) +

request_new :

hint that new secrets (instead of cached or stored secrets) + should be returned +

callback :

a function to be called when the update completes +

user_data :

caller-specific data to be passed to callback +

Returns :

TRUE on success, FALSE on failure +
+
+
+
+

nm_settings_connection_interface_emit_updated ()

+
void                nm_settings_connection_interface_emit_updated
+                                                        (NMSettingsConnectionInterface *connection);
+

+

+
++ + + + +

connection :

+
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-settings-interface.html b/docs/libnm-glib/html/libnm-glib-nm-settings-interface.html new file mode 100644 index 00000000..8fedb758 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-settings-interface.html @@ -0,0 +1,331 @@ + + + + +nm-settings-interface + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-settings-interface

+

nm-settings-interface

+
+ +
+

Description

+

+

+
+
+

Details

+
+

enum NMSettingsInterfaceError

+
typedef enum {
+	NM_SETTINGS_INTERFACE_ERROR_INVALID_CONNECTION = 0,
+	NM_SETTINGS_INTERFACE_ERROR_READ_ONLY_CONNECTION,
+	NM_SETTINGS_INTERFACE_ERROR_INTERNAL_ERROR,
+	NM_SETTINGS_INTERFACE_ERROR_SECRETS_UNAVAILABLE,
+	NM_SETTINGS_INTERFACE_ERROR_SECRETS_REQUEST_CANCELED,
+	NM_SETTINGS_INTERFACE_ERROR_PERMISSION_DENIED,
+	NM_SETTINGS_INTERFACE_ERROR_INVALID_SETTING,
+} NMSettingsInterfaceError;
+
+

+

+
+
+
+

NM_SETTINGS_INTERFACE_ERROR

+
#define NM_SETTINGS_INTERFACE_ERROR (nm_settings_interface_error_quark ())
+
+

+

+
+
+
+

nm_settings_interface_error_quark ()

+
GQuark              nm_settings_interface_error_quark   (void);
+

+Setting error quark. +

+
++ + + + +

Returns :

the setting error quark +
+
+
+
+

NM_TYPE_SETTINGS_INTERFACE_ERROR

+
#define NM_TYPE_SETTINGS_INTERFACE_ERROR (nm_settings_interface_error_get_type ()) 
+
+

+

+
+
+
+

NM_SETTINGS_INTERFACE_GET_INTERFACE()

+
#define NM_SETTINGS_INTERFACE_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), NM_TYPE_SETTINGS_INTERFACE, NMSettingsInterface))
+
+

+

+
++ + + + +

obj :

+
+
+
+
+

NM_SETTINGS_INTERFACE_NEW_CONNECTION

+
#define NM_SETTINGS_INTERFACE_NEW_CONNECTION   "new-connection"
+
+

+

+
+
+
+

NM_SETTINGS_INTERFACE_CONNECTIONS_READ

+
#define NM_SETTINGS_INTERFACE_CONNECTIONS_READ "connections-read"
+
+

+

+
+
+
+

NMSettingsInterface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	/* Methods */
+	/* Returns a list of objects implementing NMSettingsConnectionInterface */
+	GSList * (*list_connections) (NMSettingsInterface *settings);
+
+	NMSettingsConnectionInterface * (*get_connection_by_path) (NMSettingsInterface *settings,
+	                                                           const char *path);
+
+	gboolean (*add_connection) (NMSettingsInterface *settings,
+	                            NMConnection *connection,
+	                            NMSettingsAddConnectionFunc callback,
+	                            gpointer user_data);
+
+	/* Signals */
+	void (*new_connection) (NMSettingsInterface *settings,
+	                        NMSettingsConnectionInterface *connection);
+
+	void (*connections_read) (NMSettingsInterface *settings);
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+	void (*_reserved5) (void);
+	void (*_reserved6) (void);
+} NMSettingsInterface;
+
+

+

+
+
+
+

NMSettingsAddConnectionFunc ()

+
void                (*NMSettingsAddConnectionFunc)      (NMSettingsInterface *settings,
+                                                         GError *error,
+                                                         gpointer user_data);
+

+

+
++ + + + + + + + + + + + + + +

settings :

+

error :

+

user_data :

+
+
+
+
+

nm_settings_interface_get_type ()

+
GType               nm_settings_interface_get_type      (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+

nm_settings_interface_list_connections ()

+
GSList *            nm_settings_interface_list_connections
+                                                        (NMSettingsInterface *settings);
+

+

+
++ + + + + + + + + + +

settings :

+

Returns :

+
+
+
+
+

nm_settings_interface_get_connection_by_path ()

+
NMSettingsConnectionInterface * nm_settings_interface_get_connection_by_path
+                                                        (NMSettingsInterface *settings,
+                                                         const char *path);
+

+

+
++ + + + + + + + + + + + + + +

settings :

+

path :

+

Returns :

+
+
+
+
+

nm_settings_interface_add_connection ()

+
gboolean            nm_settings_interface_add_connection
+                                                        (NMSettingsInterface *settings,
+                                                         NMConnection *connection,
+                                                         NMSettingsAddConnectionFunc callback,
+                                                         gpointer user_data);
+

+Requests that the settings service add the given settings to a new connection. +

+
++ + + + + + + + + + + + + + + + + + + + + + +

settings :

a object implementing NMSettingsInterface +

connection :

the settings to add; note that this object's settings will be + added, not the object itself +

callback :

callback to be called when the add operation completes +

user_data :

caller-specific data passed to callback +

Returns :

TRUE if the request was successful, FALSE if it failed +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-settings-service.html b/docs/libnm-glib/html/libnm-glib-nm-settings-service.html new file mode 100644 index 00000000..86df33fc --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-settings-service.html @@ -0,0 +1,158 @@ + + + + +NMSettingsService + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingsService

+

NMSettingsService

+
+ +
+

Description

+

+

+
+
+

Details

+
+

NM_SETTINGS_SERVICE_BUS

+
#define NM_SETTINGS_SERVICE_BUS "bus"
+
+

+

+
+
+
+

NM_SETTINGS_SERVICE_SCOPE

+
#define NM_SETTINGS_SERVICE_SCOPE "scope"
+
+

+

+
+
+
+

NMSettingsService

+
typedef struct {
+	GObject parent;
+} NMSettingsService;
+
+

+

+
+
+
+

nm_settings_service_get_connection_by_path ()

+
NMExportedConnection * nm_settings_service_get_connection_by_path
+                                                        (NMSettingsService *self,
+                                                         const char *path);
+

+

+
++ + + + + + + + + + + + + + +

self :

+

path :

+

Returns :

+
+
+
+
+

nm_settings_service_export ()

+
void                nm_settings_service_export          (NMSettingsService *self);
+

+

+
++ + + + +

self :

+
+
+
+
+

nm_settings_service_export_connection ()

+
void                nm_settings_service_export_connection
+                                                        (NMSettingsService *self,
+                                                         NMSettingsConnectionInterface *exported);
+

+

+
++ + + + + + + + + + +

self :

+

exported :

+
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-settings-system-interface.html b/docs/libnm-glib/html/libnm-glib-nm-settings-system-interface.html new file mode 100644 index 00000000..e8c500de --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-settings-system-interface.html @@ -0,0 +1,322 @@ + + + + +nm-settings-system-interface + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-settings-system-interface

+

nm-settings-system-interface

+
+ +
+

Description

+

+

+
+
+

Details

+
+

enum NMSettingsSystemPermissions

+
typedef enum {
+	NM_SETTINGS_SYSTEM_PERMISSION_NONE = 0x0,
+	NM_SETTINGS_SYSTEM_PERMISSION_CONNECTION_MODIFY = 0x1,
+	NM_SETTINGS_SYSTEM_PERMISSION_WIFI_SHARE_PROTECTED = 0x2,
+	NM_SETTINGS_SYSTEM_PERMISSION_WIFI_SHARE_OPEN = 0x4,
+	NM_SETTINGS_SYSTEM_PERMISSION_HOSTNAME_MODIFY = 0x8
+} NMSettingsSystemPermissions;
+
+

+

+
+
+
+

NM_SETTINGS_SYSTEM_INTERFACE_GET_INTERFACE()

+
#define NM_SETTINGS_SYSTEM_INTERFACE_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), NM_TYPE_SETTINGS_SYSTEM_INTERFACE, NMSettingsSystemInterface))
+
+

+

+
++ + + + +

obj :

+
+
+
+
+

NM_SETTINGS_SYSTEM_INTERFACE_HOSTNAME

+
#define NM_SETTINGS_SYSTEM_INTERFACE_HOSTNAME          "hostname"
+
+

+

+
+
+
+

NM_SETTINGS_SYSTEM_INTERFACE_CAN_MODIFY

+
#define NM_SETTINGS_SYSTEM_INTERFACE_CAN_MODIFY        "can-modify"
+
+

+

+
+
+
+

NM_SETTINGS_SYSTEM_INTERFACE_CHECK_PERMISSIONS

+
#define NM_SETTINGS_SYSTEM_INTERFACE_CHECK_PERMISSIONS "check-permissions"
+
+

+

+
+
+
+

enum NMSettingsSystemInterfaceProp

+
typedef enum {
+	NM_SETTINGS_SYSTEM_INTERFACE_PROP_FIRST = 0x1000,
+
+	NM_SETTINGS_SYSTEM_INTERFACE_PROP_HOSTNAME = NM_SETTINGS_SYSTEM_INTERFACE_PROP_FIRST,
+	NM_SETTINGS_SYSTEM_INTERFACE_PROP_CAN_MODIFY
+} NMSettingsSystemInterfaceProp;
+
+

+

+
+
+
+

NMSettingsSystemInterface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	/* Methods */
+	gboolean (*save_hostname) (NMSettingsSystemInterface *settings,
+	                           const char *hostname,
+	                           NMSettingsSystemSaveHostnameFunc callback,
+	                           gpointer user_data);
+
+	gboolean (*get_permissions) (NMSettingsSystemInterface *settings,
+	                             NMSettingsSystemGetPermissionsFunc callback,
+	                             gpointer user_data);
+
+	/* Signals */
+	void (*check_permissions) (NMSettingsSystemInterface *settings);
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+	void (*_reserved5) (void);
+	void (*_reserved6) (void);
+} NMSettingsSystemInterface;
+
+

+

+
+
+
+

NMSettingsSystemSaveHostnameFunc ()

+
void                (*NMSettingsSystemSaveHostnameFunc) (NMSettingsSystemInterface *settings,
+                                                         GError *error,
+                                                         gpointer user_data);
+

+

+
++ + + + + + + + + + + + + + +

settings :

+

error :

+

user_data :

+
+
+
+
+

NMSettingsSystemGetPermissionsFunc ()

+
void                (*NMSettingsSystemGetPermissionsFunc)
+                                                        (NMSettingsSystemInterface *settings,
+                                                         NMSettingsSystemPermissions permissions,
+                                                         GError *error,
+                                                         gpointer user_data);
+

+

+
++ + + + + + + + + + + + + + + + + + +

settings :

+

permissions :

+

error :

+

user_data :

+
+
+
+
+

nm_settings_system_interface_save_hostname ()

+
gboolean            nm_settings_system_interface_save_hostname
+                                                        (NMSettingsSystemInterface *settings,
+                                                         const char *hostname,
+                                                         NMSettingsSystemSaveHostnameFunc callback,
+                                                         gpointer user_data);
+

+Requests that the machine's persistent hostname be set to the specified value +or cleared. +

+
++ + + + + + + + + + + + + + + + + + + + + + +

settings :

a object implementing NMSettingsSystemInterface +

hostname :

the new persistent hostname to set, or NULL to clear any existing + persistent hostname +

callback :

callback to be called when the hostname operation completes +

user_data :

caller-specific data passed to callback +

Returns :

TRUE if the request was successful, FALSE if it failed +
+
+
+
+

nm_settings_system_interface_get_permissions ()

+
gboolean            nm_settings_system_interface_get_permissions
+                                                        (NMSettingsSystemInterface *settings,
+                                                         NMSettingsSystemGetPermissionsFunc callback,
+                                                         gpointer user_data);
+

+Requests an indication of the operations the caller is permitted to perform +including those that may require authorization. +

+
++ + + + + + + + + + + + + + + + + + +

settings :

a object implementing NMSettingsSystemInterface +

callback :

callback to be called when the permissions operation completes +

user_data :

caller-specific data passed to callback +

Returns :

TRUE if the request was successful, FALSE if it failed +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-types.html b/docs/libnm-glib/html/libnm-glib-nm-types.html new file mode 100644 index 00000000..4f136208 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-types.html @@ -0,0 +1,231 @@ + + + + +nm-types + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-types

+

nm-types

+
+ +
+

Description

+

+

+
+
+

Details

+
+

NM_TYPE_SSID

+
#define NM_TYPE_SSID  (nm_ssid_get_type ())
+
+

+

+
+
+
+

nm_ssid_get_type ()

+
GType               nm_ssid_get_type                    (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+

NM_TYPE_UINT_ARRAY

+
#define NM_TYPE_UINT_ARRAY  (nm_uint_array_get_type ())
+
+

+

+
+
+
+

nm_uint_array_get_type ()

+
GType               nm_uint_array_get_type              (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+

NM_TYPE_STRING_ARRAY

+
#define NM_TYPE_STRING_ARRAY  (nm_string_array_get_type ())
+
+

+

+
+
+
+

nm_string_array_get_type ()

+
GType               nm_string_array_get_type            (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+

NM_TYPE_OBJECT_ARRAY

+
#define NM_TYPE_OBJECT_ARRAY  (nm_object_array_get_type ())
+
+

+

+
+
+
+

nm_object_array_get_type ()

+
GType               nm_object_array_get_type            (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+

NM_TYPE_IP6_ADDRESS_OBJECT_ARRAY

+
#define NM_TYPE_IP6_ADDRESS_OBJECT_ARRAY  (nm_ip6_address_object_array_get_type ())
+
+

+

+
+
+
+

nm_ip6_address_object_array_get_type ()

+
GType               nm_ip6_address_object_array_get_type
+                                                        (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+

NM_TYPE_IP6_ADDRESS_ARRAY

+
#define NM_TYPE_IP6_ADDRESS_ARRAY  (nm_ip6_address_array_get_type ())
+
+

+

+
+
+
+

nm_ip6_address_array_get_type ()

+
GType               nm_ip6_address_array_get_type       (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+

NM_TYPE_IP6_ROUTE_OBJECT_ARRAY

+
#define NM_TYPE_IP6_ROUTE_OBJECT_ARRAY  (nm_ip6_route_object_array_get_type ())
+
+

+

+
+
+
+

nm_ip6_route_object_array_get_type ()

+
GType               nm_ip6_route_object_array_get_type  (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-vpn-connection.html b/docs/libnm-glib/html/libnm-glib-nm-vpn-connection.html new file mode 100644 index 00000000..36421d4b --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-vpn-connection.html @@ -0,0 +1,159 @@ + + + + +NMVPNConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMVPNConnection

+

NMVPNConnection

+
+
+

Synopsis

+
#define             NM_VPN_CONNECTION_VPN_STATE
+#define             NM_VPN_CONNECTION_BANNER
+                    NMVPNConnection;
+GObject *           nm_vpn_connection_new               (DBusGConnection *dbus_connection,
+                                                         const char *path);
+NMVPNConnectionState  nm_vpn_connection_get_vpn_state   (NMVPNConnection *vpn);
+const char *        nm_vpn_connection_get_banner        (NMVPNConnection *vpn);
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_VPN_CONNECTION_VPN_STATE

+
#define NM_VPN_CONNECTION_VPN_STATE "vpn-state"
+
+

+

+
+
+
+

NM_VPN_CONNECTION_BANNER

+
#define NM_VPN_CONNECTION_BANNER "banner"
+
+

+

+
+
+
+

NMVPNConnection

+
typedef struct {
+	NMActiveConnection parent;
+} NMVPNConnection;
+
+

+

+
+
+
+

nm_vpn_connection_new ()

+
GObject *           nm_vpn_connection_new               (DBusGConnection *dbus_connection,
+                                                         const char *path);
+

+

+
++ + + + + + + + + + + + + + +

dbus_connection :

+

path :

+

Returns :

+
+
+
+
+

nm_vpn_connection_get_vpn_state ()

+
NMVPNConnectionState  nm_vpn_connection_get_vpn_state   (NMVPNConnection *vpn);
+

+

+
++ + + + + + + + + + +

vpn :

+

Returns :

+
+
+
+
+

nm_vpn_connection_get_banner ()

+
const char *        nm_vpn_connection_get_banner        (NMVPNConnection *vpn);
+

+

+
++ + + + + + + + + + +

vpn :

+

Returns :

+
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-vpn-plugin-ui-interface.html b/docs/libnm-glib/html/libnm-glib-nm-vpn-plugin-ui-interface.html new file mode 100644 index 00000000..7fa7e7f0 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-vpn-plugin-ui-interface.html @@ -0,0 +1,679 @@ + + + + +nm-vpn-plugin-ui-interface + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-vpn-plugin-ui-interface

+

nm-vpn-plugin-ui-interface

+
+
+

Synopsis

+
                    NMVpnPluginUiInterface;
+                    NMVpnPluginUiWidgetInterface;
+NMVpnPluginUiInterface * (*NMVpnPluginUiFactory)        (GError **error);
+NMVpnPluginUiInterface * nm_vpn_plugin_ui_factory       (GError **error);
+#define             NM_VPN_PLUGIN_UI_INTERFACE_GET_INTERFACE(obj)
+#define             NM_VPN_PLUGIN_UI_CAPABILITY_NONE
+#define             NM_VPN_PLUGIN_UI_CAPABILITY_IMPORT
+#define             NM_VPN_PLUGIN_UI_CAPABILITY_EXPORT
+#define             NM_VPN_PLUGIN_UI_INTERFACE_NAME
+#define             NM_VPN_PLUGIN_UI_INTERFACE_DESC
+#define             NM_VPN_PLUGIN_UI_INTERFACE_SERVICE
+enum                NMVpnPluginUiInterfaceProp;
+NMVpnPluginUiWidgetInterface * nm_vpn_plugin_ui_interface_ui_factory
+                                                        (NMVpnPluginUiInterface *iface,
+                                                         NMConnection *connection,
+                                                         GError **error);
+guint32             nm_vpn_plugin_ui_interface_get_capabilities
+                                                        (NMVpnPluginUiInterface *iface);
+NMConnection *      nm_vpn_plugin_ui_interface_import   (NMVpnPluginUiInterface *iface,
+                                                         const char *path,
+                                                         GError **error);
+gboolean            nm_vpn_plugin_ui_interface_export   (NMVpnPluginUiInterface *iface,
+                                                         const char *path,
+                                                         NMConnection *connection,
+                                                         GError **error);
+char *              nm_vpn_plugin_ui_interface_get_suggested_name
+                                                        (NMVpnPluginUiInterface *iface,
+                                                         NMConnection *connection);
+gboolean            nm_vpn_plugin_ui_interface_delete_connection
+                                                        (NMVpnPluginUiInterface *iface,
+                                                         NMConnection *connection,
+                                                         GError **error);
+#define             NM_TYPE_VPN_PLUGIN_UI_WIDGET_INTERFACE
+#define             NM_VPN_PLUGIN_UI_WIDGET_INTERFACE   (obj)
+#define             NM_IS_VPN_PLUGIN_UI_WIDGET_INTERFACE(obj)
+#define             NM_VPN_PLUGIN_UI_WIDGET_INTERFACE_GET_INTERFACE(obj)
+GType               nm_vpn_plugin_ui_widget_interface_get_type
+                                                        (void);
+GObject *           nm_vpn_plugin_ui_widget_interface_get_widget
+                                                        (NMVpnPluginUiWidgetInterface *iface);
+gboolean            nm_vpn_plugin_ui_widget_interface_update_connection
+                                                        (NMVpnPluginUiWidgetInterface *iface,
+                                                         NMConnection *connection,
+                                                         GError **error);
+gboolean            nm_vpn_plugin_ui_widget_interface_save_secrets
+                                                        (NMVpnPluginUiWidgetInterface *iface,
+                                                         NMConnection *connection,
+                                                         GError **error);
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMVpnPluginUiInterface

+
typedef struct {
+	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) (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) (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);
+} NMVpnPluginUiInterface;
+
+

+

+
+
+
+

NMVpnPluginUiWidgetInterface

+
typedef struct {
+	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);
+} NMVpnPluginUiWidgetInterface;
+
+

+

+
+
+
+

NMVpnPluginUiFactory ()

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

+

+
++ + + + + + + + + + +

error :

+

Returns :

+
+
+
+
+

nm_vpn_plugin_ui_factory ()

+
NMVpnPluginUiInterface * nm_vpn_plugin_ui_factory       (GError **error);
+

+

+
++ + + + + + + + + + +

error :

+

Returns :

+
+
+
+
+

NM_VPN_PLUGIN_UI_INTERFACE_GET_INTERFACE()

+
#define NM_VPN_PLUGIN_UI_INTERFACE_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), NM_TYPE_VPN_PLUGIN_UI_INTERFACE, NMVpnPluginUiInterface))
+
+

+

+
++ + + + +

obj :

+
+
+
+
+

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;
+
+

+

+
+
+
+

nm_vpn_plugin_ui_interface_ui_factory ()

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

+

+
++ + + + + + + + + + + + + + + + + + +

iface :

+

connection :

+

error :

+

Returns :

+
+
+
+
+

nm_vpn_plugin_ui_interface_get_capabilities ()

+
guint32             nm_vpn_plugin_ui_interface_get_capabilities
+                                                        (NMVpnPluginUiInterface *iface);
+

+

+
++ + + + + + + + + + +

iface :

+

Returns :

+
+
+
+
+

nm_vpn_plugin_ui_interface_import ()

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

+

+
++ + + + + + + + + + + + + + + + + + +

iface :

+

path :

+

error :

+

Returns :

+
+
+
+
+

nm_vpn_plugin_ui_interface_export ()

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

+

+
++ + + + + + + + + + + + + + + + + + + + + + +

iface :

+

path :

+

connection :

+

error :

+

Returns :

+
+
+
+
+

nm_vpn_plugin_ui_interface_get_suggested_name ()

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

+

+
++ + + + + + + + + + + + + + +

iface :

+

connection :

+

Returns :

+
+
+
+
+

nm_vpn_plugin_ui_interface_delete_connection ()

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

+

+
++ + + + + + + + + + + + + + + + + + +

iface :

+

connection :

+

error :

+

Returns :

+
+
+
+
+

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))
+
+

+

+
++ + + + +

obj :

+
+
+
+
+

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))
+
+

+

+
++ + + + +

obj :

+
+
+
+
+

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))
+
+

+

+
++ + + + +

obj :

+
+
+
+
+

nm_vpn_plugin_ui_widget_interface_get_type ()

+
GType               nm_vpn_plugin_ui_widget_interface_get_type
+                                                        (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+

nm_vpn_plugin_ui_widget_interface_get_widget ()

+
GObject *           nm_vpn_plugin_ui_widget_interface_get_widget
+                                                        (NMVpnPluginUiWidgetInterface *iface);
+

+

+
++ + + + + + + + + + +

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);
+

+

+
++ + + + + + + + + + + + + + + + + + +

iface :

+

connection :

+

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);
+

+

+
++ + + + + + + + + + + + + + + + + + +

iface :

+

connection :

+

error :

+

Returns :

+
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib-nm-vpn-plugin.html b/docs/libnm-glib/html/libnm-glib-nm-vpn-plugin.html new file mode 100644 index 00000000..5b39eb8b --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-vpn-plugin.html @@ -0,0 +1,328 @@ + + + + +NMVPNPlugin + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMVPNPlugin

+

NMVPNPlugin

+
+
+

Synopsis

+
#define             NM_VPN_PLUGIN_DBUS_SERVICE_NAME
+#define             NM_VPN_PLUGIN_STATE
+enum                NMVPNPluginError;
+#define             NM_VPN_PLUGIN_ERROR
+#define             NM_TYPE_VPN_PLUGIN_ERROR
+                    NMVPNPlugin;
+GQuark              nm_vpn_plugin_error_quark           (void);
+GType               nm_vpn_plugin_error_get_type        (void);
+DBusGConnection *   nm_vpn_plugin_get_connection        (NMVPNPlugin *plugin);
+NMVPNServiceState   nm_vpn_plugin_get_state             (NMVPNPlugin *plugin);
+void                nm_vpn_plugin_set_state             (NMVPNPlugin *plugin,
+                                                         NMVPNServiceState state);
+void                nm_vpn_plugin_set_login_banner      (NMVPNPlugin *plugin,
+                                                         const char *banner);
+void                nm_vpn_plugin_failure               (NMVPNPlugin *plugin,
+                                                         NMVPNPluginFailure reason);
+void                nm_vpn_plugin_set_ip4_config        (NMVPNPlugin *plugin,
+                                                         GHashTable *ip4_config);
+gboolean            nm_vpn_plugin_disconnect            (NMVPNPlugin *plugin,
+                                                         GError **err);
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_VPN_PLUGIN_DBUS_SERVICE_NAME

+
#define NM_VPN_PLUGIN_DBUS_SERVICE_NAME "service-name"
+
+

+

+
+
+
+

NM_VPN_PLUGIN_STATE

+
#define NM_VPN_PLUGIN_STATE             "state"
+
+

+

+
+
+
+

enum NMVPNPluginError

+
typedef enum {
+	NM_VPN_PLUGIN_ERROR_GENERAL,
+	NM_VPN_PLUGIN_ERROR_STARTING_IN_PROGRESS,
+	NM_VPN_PLUGIN_ERROR_ALREADY_STARTED,
+	NM_VPN_PLUGIN_ERROR_STOPPING_IN_PROGRESS,
+	NM_VPN_PLUGIN_ERROR_ALREADY_STOPPED,
+	NM_VPN_PLUGIN_ERROR_WRONG_STATE,
+	NM_VPN_PLUGIN_ERROR_BAD_ARGUMENTS,
+	NM_VPN_PLUGIN_ERROR_LAUNCH_FAILED,
+	NM_VPN_PLUGIN_ERROR_CONNECTION_INVALID,
+} NMVPNPluginError;
+
+

+

+
+
+
+

NM_VPN_PLUGIN_ERROR

+
#define NM_VPN_PLUGIN_ERROR      (nm_vpn_plugin_error_quark ())
+
+

+

+
+
+
+

NM_TYPE_VPN_PLUGIN_ERROR

+
#define NM_TYPE_VPN_PLUGIN_ERROR (nm_vpn_plugin_error_get_type ()) 
+
+

+

+
+
+
+

NMVPNPlugin

+
typedef struct {
+	GObject parent;
+} NMVPNPlugin;
+
+

+

+
+
+
+

nm_vpn_plugin_error_quark ()

+
GQuark              nm_vpn_plugin_error_quark           (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+

nm_vpn_plugin_error_get_type ()

+
GType               nm_vpn_plugin_error_get_type        (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+

nm_vpn_plugin_get_connection ()

+
DBusGConnection *   nm_vpn_plugin_get_connection        (NMVPNPlugin *plugin);
+

+

+
++ + + + + + + + + + +

plugin :

+

Returns :

+
+
+
+
+

nm_vpn_plugin_get_state ()

+
NMVPNServiceState   nm_vpn_plugin_get_state             (NMVPNPlugin *plugin);
+

+

+
++ + + + + + + + + + +

plugin :

+

Returns :

+
+
+
+
+

nm_vpn_plugin_set_state ()

+
void                nm_vpn_plugin_set_state             (NMVPNPlugin *plugin,
+                                                         NMVPNServiceState state);
+

+

+
++ + + + + + + + + + +

plugin :

+

state :

+
+
+
+
+

nm_vpn_plugin_set_login_banner ()

+
void                nm_vpn_plugin_set_login_banner      (NMVPNPlugin *plugin,
+                                                         const char *banner);
+

+

+
++ + + + + + + + + + +

plugin :

+

banner :

+
+
+
+
+

nm_vpn_plugin_failure ()

+
void                nm_vpn_plugin_failure               (NMVPNPlugin *plugin,
+                                                         NMVPNPluginFailure reason);
+

+

+
++ + + + + + + + + + +

plugin :

+

reason :

+
+
+
+
+

nm_vpn_plugin_set_ip4_config ()

+
void                nm_vpn_plugin_set_ip4_config        (NMVPNPlugin *plugin,
+                                                         GHashTable *ip4_config);
+

+

+
++ + + + + + + + + + +

plugin :

+

ip4_config :

+
+
+
+
+

nm_vpn_plugin_disconnect ()

+
gboolean            nm_vpn_plugin_disconnect            (NMVPNPlugin *plugin,
+                                                         GError **err);
+

+

+
++ + + + + + + + + + + + + + +

plugin :

+

err :

+

Returns :

+
+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-glib/html/libnm-glib.devhelp b/docs/libnm-glib/html/libnm-glib.devhelp new file mode 100644 index 00000000..68f0a080 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib.devhelp @@ -0,0 +1,378 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/libnm-glib/html/libnm-glib.devhelp2 b/docs/libnm-glib/html/libnm-glib.devhelp2 new file mode 100644 index 00000000..d7b770d2 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib.devhelp2 @@ -0,0 +1,378 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/libnm-glib/html/right.png b/docs/libnm-glib/html/right.png new file mode 100644 index 00000000..92832e3a Binary files /dev/null and b/docs/libnm-glib/html/right.png differ diff --git a/docs/libnm-glib/html/style.css b/docs/libnm-glib/html/style.css new file mode 100644 index 00000000..82115eb7 --- /dev/null +++ b/docs/libnm-glib/html/style.css @@ -0,0 +1,257 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + position: relative; + padding-top:4.5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/docs/libnm-glib/html/up.png b/docs/libnm-glib/html/up.png new file mode 100644 index 00000000..85b3e2a2 Binary files /dev/null and b/docs/libnm-glib/html/up.png differ -- cgit 1.3.0-6-gf8a5