From a4256940da049f91bbbea5e53e469a59ea9c10f7 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Fri, 25 Oct 2013 21:20:58 +0200 Subject: Imported Upstream version 0.9.8.8 --- docs/libnm-util/html/NMSettingGsm.html | 586 ++++++++++++++++++--------------- 1 file changed, 317 insertions(+), 269 deletions(-) (limited to 'docs/libnm-util/html/NMSettingGsm.html') diff --git a/docs/libnm-util/html/NMSettingGsm.html b/docs/libnm-util/html/NMSettingGsm.html index d10521ac..653911bb 100644 --- a/docs/libnm-util/html/NMSettingGsm.html +++ b/docs/libnm-util/html/NMSettingGsm.html @@ -3,12 +3,12 @@ NMSettingGsm - + - + @@ -41,60 +41,60 @@

Synopsis

-
+
 #include <nm-setting-gsm.h>
 
-                    NMSettingGsm;
-                    NMSettingGsmClass;
+#define             NM_SETTING_GSM_SETTING_NAME
 enum                NMSettingGsmError;
-enum                NMSettingGsmNetworkBand;
-enum                NMSettingGsmNetworkType;
-#define             NM_SETTING_GSM_ALLOWED_BANDS
-#define             NM_SETTING_GSM_APN
 #define             NM_SETTING_GSM_ERROR
-#define             NM_SETTING_GSM_HOME_ONLY
-#define             NM_SETTING_GSM_NETWORK_ID
-#define             NM_SETTING_GSM_NETWORK_TYPE
+GQuark              nm_setting_gsm_error_quark          (void);
 #define             NM_SETTING_GSM_NUMBER
+#define             NM_SETTING_GSM_USERNAME
 #define             NM_SETTING_GSM_PASSWORD
 #define             NM_SETTING_GSM_PASSWORD_FLAGS
+#define             NM_SETTING_GSM_APN
+#define             NM_SETTING_GSM_NETWORK_ID
+#define             NM_SETTING_GSM_NETWORK_TYPE
+#define             NM_SETTING_GSM_ALLOWED_BANDS
 #define             NM_SETTING_GSM_PIN
 #define             NM_SETTING_GSM_PIN_FLAGS
-#define             NM_SETTING_GSM_SETTING_NAME
-#define             NM_SETTING_GSM_USERNAME
-GQuark              nm_setting_gsm_error_quark          (void);
-guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
+#define             NM_SETTING_GSM_HOME_ONLY
+enum                NMSettingGsmNetworkType;
+enum                NMSettingGsmNetworkBand;
+                    NMSettingGsm;
+                    NMSettingGsmClass;
+NMSetting *         nm_setting_gsm_new                  (void);
+const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
+const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
+const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
 const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
-gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
 const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
 int                 nm_setting_gsm_get_network_type     (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
-NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
+guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
 const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
+gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
 NMSettingSecretFlags nm_setting_gsm_get_pin_flags       (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
-NMSetting *         nm_setting_gsm_new                  (void);
+NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);

Object Hierarchy

-  GObject
-   +----NMSetting
-         +----NMSettingGsm
+  GEnum
+   +----NMSettingGsmError
 
   GEnum
-   +----NMSettingGsmError
+   +----NMSettingGsmNetworkType
 
   GEnum
    +----NMSettingGsmNetworkBand
 
-  GEnum
-   +----NMSettingGsmNetworkType
+  GObject
+   +----NMSetting
+         +----NMSettingGsm
@@ -124,23 +124,8 @@ networks, including those using GPRS/EDGE and UMTS/HSPA technology.

Details

-

NMSettingGsm

-
typedef struct _NMSettingGsm NMSettingGsm;
-

-

-
-
-
-

NMSettingGsmClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingGsmClass;
+
NM_SETTING_GSM_SETTING_NAME

+
#define NM_SETTING_GSM_SETTING_NAME "gsm"
 

 

 

@@ -155,8 +140,11 @@ networks, including those using GPRS/EDGE and UMTS/HSPA technology.
 	NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING /*< nick=MissingSerialSetting >*/
 } NMSettingGsmError;
-
+
+++ @@ -185,6 +173,187 @@ is missing in the connection
+

NM_SETTING_GSM_ERROR

+
#define NM_SETTING_GSM_ERROR nm_setting_gsm_error_quark ()
+
+

+

+
+
+
+

nm_setting_gsm_error_quark ()

+
GQuark              nm_setting_gsm_error_quark          (void);
+

+Registers an error quark for NMSettingGsm if necessary. +

+

NM_SETTING_GSM_ERROR_UNKNOWN
++++ + + + + +

Returns :

the error quark used for NMSettingGsm errors.
+
+
+
+

NM_SETTING_GSM_NUMBER

+
#define NM_SETTING_GSM_NUMBER         "number"
+
+

+

+
+
+
+

NM_SETTING_GSM_USERNAME

+
#define NM_SETTING_GSM_USERNAME       "username"
+
+

+

+
+
+
+

NM_SETTING_GSM_PASSWORD

+
#define NM_SETTING_GSM_PASSWORD       "password"
+
+

+

+
+
+
+

NM_SETTING_GSM_PASSWORD_FLAGS

+
#define NM_SETTING_GSM_PASSWORD_FLAGS "password-flags"
+
+

+

+
+
+
+

NM_SETTING_GSM_APN

+
#define NM_SETTING_GSM_APN            "apn"
+
+

+

+
+
+
+

NM_SETTING_GSM_NETWORK_ID

+
#define NM_SETTING_GSM_NETWORK_ID     "network-id"
+
+

+

+
+
+
+

NM_SETTING_GSM_NETWORK_TYPE

+
#define NM_SETTING_GSM_NETWORK_TYPE   "network-type"
+
+

+

+
+
+
+

NM_SETTING_GSM_ALLOWED_BANDS

+
#define NM_SETTING_GSM_ALLOWED_BANDS  "allowed-bands"
+
+

+

+
+
+
+

NM_SETTING_GSM_PIN

+
#define NM_SETTING_GSM_PIN            "pin"
+
+

+

+
+
+
+

NM_SETTING_GSM_PIN_FLAGS

+
#define NM_SETTING_GSM_PIN_FLAGS      "pin-flags"
+
+

+

+
+
+
+

NM_SETTING_GSM_HOME_ONLY

+
#define NM_SETTING_GSM_HOME_ONLY      "home-only"
+
+

+

+
+
+
+

enum NMSettingGsmNetworkType

+
typedef enum {
+	NM_SETTING_GSM_NETWORK_TYPE_ANY = -1,
+	NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA = 0,
+	NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE = 1,
+	NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA = 2,
+	NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE = 3,
+	NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G = 4,
+	NM_SETTING_GSM_NETWORK_TYPE_4G = 5
+} NMSettingGsmNetworkType;
+
+

+NMSettingGsmNetworkType values indicate the allowed access technologies +the device may use when connecting to this network. +

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

NM_SETTING_GSM_NETWORK_TYPE_ANY

any access technology may be used +

NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA

only 3G-type (UMTS and HSPA) +technologies may be used +

NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE

only 2G-type (GPRS and EDGE) +technologies may be used +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA

3G-type technologies are +preferred but 2G-type technologies may be used as a fallback +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE

2G-type technologies are +preferred but 3G-type technologies may be used as a fallback +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G

4G/LTE-type technologies are +preferred but 3G/2/-type technologies may be used as a fallback +

NM_SETTING_GSM_NETWORK_TYPE_4G

only 4G/LTE type +technologies may be used +
+
+
+

enum NMSettingGsmNetworkBand

typedef enum {
 	NM_SETTING_GSM_BAND_UNKNOWN      = 0x00000000,
@@ -208,8 +377,11 @@ is missing in the connection
 NMSettingGsmNetworkBand values indicate the allowed frequency bands
 the device may use when connecting to this network.
 

-

+

+++
@@ -291,193 +463,54 @@ the device may use when connecting to this network.
 

-
enum NMSettingGsmNetworkType

-
typedef enum {
-	NM_SETTING_GSM_NETWORK_TYPE_ANY = -1,
-	NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA = 0,
-	NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE = 1,
-	NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA = 2,
-	NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE = 3,
-	NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G = 4,
-	NM_SETTING_GSM_NETWORK_TYPE_4G = 5
-} NMSettingGsmNetworkType;
-

-

-NMSettingGsmNetworkType values indicate the allowed access technologies
-the device may use when connecting to this network.
-

-

 


 
 

 
NM_SETTING_GSM_BAND_UNKNOWN

 
 

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


NM_SETTING_GSM_NETWORK_TYPE_ANY
any access technology may be used
-
NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA
only 3G-type (UMTS and HSPA)
-technologies may be used
-
NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE
only 2G-type (GPRS and EDGE)
-technologies may be used
-
NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA
3G-type technologies are
-preferred but 2G-type technologies may be used as a fallback
-
NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE
2G-type technologies are
-preferred but 3G-type technologies may be used as a fallback
-
NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G
4G/LTE-type technologies are
-preferred but 3G/2/-type technologies may be used as a fallback
-
NM_SETTING_GSM_NETWORK_TYPE_4G
only 4G/LTE type
-technologies may be used
-

-
-
-
-

NM_SETTING_GSM_ALLOWED_BANDS

-
#define NM_SETTING_GSM_ALLOWED_BANDS  "allowed-bands"
-
-

-

-
-
-
-

NM_SETTING_GSM_APN

-
#define NM_SETTING_GSM_APN            "apn"
-
-

-

-
-
-
-

NM_SETTING_GSM_ERROR

-
#define NM_SETTING_GSM_ERROR nm_setting_gsm_error_quark ()
-
-

-

-
-
-
-

NM_SETTING_GSM_HOME_ONLY

-
#define NM_SETTING_GSM_HOME_ONLY      "home-only"
-
-

-

-
-
-
-

NM_SETTING_GSM_NETWORK_ID

-
#define NM_SETTING_GSM_NETWORK_ID     "network-id"
-
-

-

-
-
-
-

NM_SETTING_GSM_NETWORK_TYPE

-
#define NM_SETTING_GSM_NETWORK_TYPE   "network-type"
-
-

-

-
-
-
-

NM_SETTING_GSM_NUMBER

-
#define NM_SETTING_GSM_NUMBER         "number"
-
-

-

-
-
-
-

NM_SETTING_GSM_PASSWORD

-
#define NM_SETTING_GSM_PASSWORD       "password"
-
-

-

-
-
-
-

NM_SETTING_GSM_PASSWORD_FLAGS

-
#define NM_SETTING_GSM_PASSWORD_FLAGS "password-flags"
-
-

-

-
-
-
-

NM_SETTING_GSM_PIN

-
#define NM_SETTING_GSM_PIN            "pin"
-
-

-

-
-
-
-

NM_SETTING_GSM_PIN_FLAGS

-
#define NM_SETTING_GSM_PIN_FLAGS      "pin-flags"
-
-

-

-
-
-
-

NM_SETTING_GSM_SETTING_NAME

-
#define NM_SETTING_GSM_SETTING_NAME "gsm"
-
+

NMSettingGsm

+
typedef struct _NMSettingGsm NMSettingGsm;

-

NM_SETTING_GSM_USERNAME

-
#define NM_SETTING_GSM_USERNAME       "username"
+
NMSettingGsmClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingGsmClass;
-

nm_setting_gsm_error_quark ()

-
GQuark              nm_setting_gsm_error_quark          (void);
+

nm_setting_gsm_new ()

+
NMSetting *         nm_setting_gsm_new                  (void);

-Registers an error quark for NMSettingGsm if necessary. +Creates a new NMSettingGsm object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingGsm errors.the new empty NMSettingGsm object
-

nm_setting_gsm_get_allowed_bands ()

-
guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_number ()

+
const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
+
+++ @@ -486,17 +519,20 @@ Registers an error quark for Returns :

- +

setting :

the "allowed-bands" property of the settingthe "number" property of the setting
-

nm_setting_gsm_get_apn ()

-
const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_username ()

+
const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
+
+++ @@ -505,17 +541,20 @@ Registers an error quark for Returns :

- +

setting :

the "apn" property of the settingthe "username" property of the setting
-

nm_setting_gsm_get_home_only ()

-
gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_password ()

+
const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
+
+++ @@ -524,17 +563,20 @@ Registers an error quark for Returns :

- +

setting :

the "home-only" property of the settingthe "password" property of the setting
-

nm_setting_gsm_get_network_id ()

-
const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_apn ()

+
const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
+
+++ @@ -543,17 +585,20 @@ Registers an error quark for Returns :

- +

setting :

the "network-id" property of the settingthe "apn" property of the setting
-

nm_setting_gsm_get_network_type ()

-
int                 nm_setting_gsm_get_network_type     (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_network_id ()

+
const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
+
+++ @@ -562,17 +607,20 @@ Registers an error quark for Returns :

- +

setting :

the "network-type" property of the settingthe "network-id" property of the setting
-

nm_setting_gsm_get_number ()

-
const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_network_type ()

+
int                 nm_setting_gsm_get_network_type     (NMSettingGsm *setting);
+
+++ @@ -581,17 +629,20 @@ Registers an error quark for Returns :

- +

setting :

the "number" property of the settingthe "network-type" property of the setting
-

nm_setting_gsm_get_password ()

-
const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_allowed_bands ()

+
guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
+
+++ @@ -600,17 +651,20 @@ Registers an error quark for Returns :

- +

setting :

the "password" property of the settingthe "allowed-bands" property of the setting
-

nm_setting_gsm_get_password_flags ()

-
NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_pin ()

+
const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
+
+++ @@ -619,18 +673,20 @@ Registers an error quark for Returns :

- +

setting :

the NMSettingSecretFlags pertaining to the "password" -the "pin" property of the setting
-

nm_setting_gsm_get_pin ()

-
const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_home_only ()

+
gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
+
+++ @@ -639,7 +695,7 @@ Registers an error quark for Returns :

- +

setting :

the "pin" property of the settingthe "home-only" property of the setting
@@ -648,8 +704,11 @@ Registers an error quark for

nm_setting_gsm_get_pin_flags ()

NMSettingSecretFlags nm_setting_gsm_get_pin_flags       (NMSettingGsm *setting);
-
+
+++ @@ -666,10 +725,13 @@ Registers an error quark for -

nm_setting_gsm_get_username ()

-
const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
-

setting :

+

nm_setting_gsm_get_password_flags ()

+
NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
+
+++ @@ -678,26 +740,12 @@ Registers an error quark for Returns :

- +

setting :

the "username" property of the settingthe NMSettingSecretFlags pertaining to the "password" +
-
-
-

nm_setting_gsm_new ()

-
NMSetting *         nm_setting_gsm_new                  (void);
-

-Creates a new NMSettingGsm object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingGsm object
-

Property Details

@@ -709,7 +757,7 @@ Bitfield of allowed frequency bands. Note that not all devices allow frequency band control. Permitted values are those specified by NMSettingGsmNetworkBand.

-

Allowed values: <= 1

+

Allowed values: <= 16383

Default value: 1

@@ -760,7 +808,7 @@ technologies. Permitted values are those specified by NMSettingGsmNetworkType. Note that not all devices allow network preference control.

-

Allowed values: [G_MAXULONG,5]

+

Allowed values: [-1,5]

Default value: -1

@@ -832,6 +880,6 @@ username is required, it is specified here.
- Generated by GTK-Doc V1.18
+ Generated by GTK-Doc V1.19 \ No newline at end of file -- cgit 1.3.0-6-gf8a5