From 33491bc4279481db8ae47213e34a6d695a0e8830 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 6 Jul 2014 02:16:10 +0200 Subject: Imported Upstream version 0.9.10.0 --- docs/libnm-util/html/NMSettingBluetooth.html | 463 ++++++++++++--------------- 1 file changed, 213 insertions(+), 250 deletions(-) (limited to 'docs/libnm-util/html/NMSettingBluetooth.html') diff --git a/docs/libnm-util/html/NMSettingBluetooth.html b/docs/libnm-util/html/NMSettingBluetooth.html index 0fa1c00a..d627ed93 100644 --- a/docs/libnm-util/html/NMSettingBluetooth.html +++ b/docs/libnm-util/html/NMSettingBluetooth.html @@ -2,28 +2,34 @@ -libnm-util Reference Manual: NMSettingBluetooth +NMSettingBluetooth - + - - - - - - - + + + + + + + + + +
@@ -31,218 +37,59 @@

NMSettingBluetooth

NMSettingBluetooth — Describes Bluetooth connection properties

- +
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - -
-GQuark - -nm_setting_bluetooth_error_quark () -
-NMSetting * - -nm_setting_bluetooth_new () -
const GByteArray * - -nm_setting_bluetooth_get_bdaddr () -
const char * - -nm_setting_bluetooth_get_connection_type () -
-
-
-

Properties

-
----- - - - - - - - - - - - - -
-GArray_guchar_ *bdaddrRead / Write
-gchar *typeRead / Write
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineNM_SETTING_BLUETOOTH_SETTING_NAME
enumNMSettingBluetoothError
#defineNM_SETTING_BLUETOOTH_ERROR
#defineNM_SETTING_BLUETOOTH_BDADDR
#defineNM_SETTING_BLUETOOTH_TYPE
#defineNM_SETTING_BLUETOOTH_TYPE_DUN
#defineNM_SETTING_BLUETOOTH_TYPE_PANU
+
+

Synopsis

+
+#include <nm-setting-bluetooth.h>
+
+#define             NM_SETTING_BLUETOOTH_SETTING_NAME
+enum                NMSettingBluetoothError;
+#define             NM_SETTING_BLUETOOTH_ERROR
+GQuark              nm_setting_bluetooth_error_quark    (void);
+#define             NM_SETTING_BLUETOOTH_BDADDR
+#define             NM_SETTING_BLUETOOTH_TYPE
+#define             NM_SETTING_BLUETOOTH_TYPE_DUN
+#define             NM_SETTING_BLUETOOTH_TYPE_PANU
+                    NMSettingBluetooth;
+                    NMSettingBluetoothClass;
+NMSetting *         nm_setting_bluetooth_new            (void);
+const GByteArray *  nm_setting_bluetooth_get_bdaddr     (NMSettingBluetooth *setting);
+const char *        nm_setting_bluetooth_get_connection_type
+                                                        (NMSettingBluetooth *setting);
+

Object Hierarchy

-
    GEnum
-    ╰── NMSettingBluetoothError
-    GObject
-    ╰── NMSetting
-        ╰── NMSettingBluetooth
+
+  GEnum
+   +----NMSettingBluetoothError
+

+
+  GObject
+   +----NMSetting
+         +----NMSettingBluetooth
-

Includes

-
#include <nm-setting-bluetooth.h>
+
Properties

+
+  "bdaddr"                   GArray_guchar_*       : Read / Write
+  "type"                     gchar*                : Read / Write

Description

-

The NMSettingBluetooth object is a NMSetting subclass that describes +

+The NMSettingBluetooth object is a NMSetting subclass that describes properties necessary for connection to devices that provide network connections via the Bluetooth Dial-Up Networking (DUN) and Network Access -Point (NAP) profiles.

-
-
-

Functions

-
-

nm_setting_bluetooth_error_quark ()

-
GQuark
-nm_setting_bluetooth_error_quark (void);
-

Registers an error quark for NMSettingBluetooth if necessary.

-
-

Returns

-

the error quark used for NMSettingBluetooth errors.

-

-
-
-
-
-

nm_setting_bluetooth_new ()

-
NMSetting *
-nm_setting_bluetooth_new (void);
-

Creates a new NMSettingBluetooth object with default values.

-
-

Returns

-

the new empty NMSettingBluetooth object.

-

[transfer full]

-
-
-
-
-

nm_setting_bluetooth_get_bdaddr ()

-
const GByteArray *
-nm_setting_bluetooth_get_bdaddr (NMSettingBluetooth *setting);
-

Gets the Bluetooth address of the remote device which this setting -describes a connection to.

-
-

Parameters

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

setting

the NMSettingBluetooth

 
-
-
-

Returns

-

the Bluetooth address

-

-
-
-
-
-

nm_setting_bluetooth_get_connection_type ()

-
const char *
-nm_setting_bluetooth_get_connection_type
-                               (NMSettingBluetooth *setting);
-

Returns the connection method for communicating with the remote device (i.e. -either DUN to a DUN-capable device or PANU to a NAP-capable device).

-
-

Parameters

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

setting

the NMSettingBluetooth

 
-
-
-

Returns

-

the type, either NM_SETTING_BLUETOOTH_PANU or NM_SETTING_BLUETOOTH_DUN

-

-
-
+Point (NAP) profiles. +

-

Types and Values

+

Details

NM_SETTING_BLUETOOTH_SETTING_NAME

#define NM_SETTING_BLUETOOTH_SETTING_NAME "bluetooth"
@@ -252,51 +99,46 @@ either DUN to a DUN-capable device or PANU to a NAP-capable device).
-

enum NMSettingBluetoothError

-
-

Members

-
+

enum NMSettingBluetoothError

+
typedef enum {
+	NM_SETTING_BLUETOOTH_ERROR_UNKNOWN = 0,            /*< nick=UnknownError >*/
+	NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY,       /*< nick=InvalidProperty >*/
+	NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY,       /*< nick=MissingProperty >*/
+	NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND, /*< nick=TypeSettingNotFound >*/
+} NMSettingBluetoothError;
+
+
---++ - - + - - - + - - - + - - - + -

NM_SETTING_BLUETOOTH_ERROR_UNKNOWN

 -

unknown or unclassified error

+

NM_SETTING_BLUETOOTH_ERROR_UNKNOWN

unknown or unclassified error  

NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY

 -

the property was invalid

+

NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY

the property was invalid  

NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY

 -

the property was missing and is -required

+

NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY

the property was missing and is +required  

NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND

 -

the connection +

NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND

the connection did not contain a required type setting, ie for DUN connections the connection -must also contain an NMSettingGsm or NMSettingCdma as appropriate

+must also contain an NMSettingGsm or NMSettingCdma as appropriate 		 
-

NM_SETTING_BLUETOOTH_ERROR

@@ -307,6 +149,24 @@ must also contain an +

nm_setting_bluetooth_error_quark ()

+
GQuark              nm_setting_bluetooth_error_quark    (void);
+

+Registers an error quark for NMSettingBluetooth if necessary. +

+
++++ + + + + +

Returns :

the error quark used for NMSettingBluetooth errors.
+
+
+

NM_SETTING_BLUETOOTH_BDADDR

#define NM_SETTING_BLUETOOTH_BDADDR    "bdaddr"
@@ -326,38 +186,141 @@ must also contain an

NM_SETTING_BLUETOOTH_TYPE_DUN

#define NM_SETTING_BLUETOOTH_TYPE_DUN  "dun"
-

Connection type describing a connection to devices that support the Bluetooth -DUN profile.

+

+Connection type describing a connection to devices that support the Bluetooth +DUN profile. +

NM_SETTING_BLUETOOTH_TYPE_PANU

#define NM_SETTING_BLUETOOTH_TYPE_PANU "panu"
-

Connection type describing a connection to devices that support the Bluetooth -NAP (Network Access Point) protocol, which accepts connections via PANU.

+

+Connection type describing a connection to devices that support the Bluetooth +NAP (Network Access Point) protocol, which accepts connections via PANU. +

+
+
+
+

NMSettingBluetooth

+
typedef struct _NMSettingBluetooth NMSettingBluetooth;
+

+

+
+
+
+

NMSettingBluetoothClass

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

+

+
+
+
+

nm_setting_bluetooth_new ()

+
NMSetting *         nm_setting_bluetooth_new            (void);
+

+Creates a new NMSettingBluetooth object with default values. +

+
++++ + + + + +

Returns :

the new empty NMSettingBluetooth object. [transfer full] +
+
+
+
+

nm_setting_bluetooth_get_bdaddr ()

+
const GByteArray *  nm_setting_bluetooth_get_bdaddr     (NMSettingBluetooth *setting);
+

+Gets the Bluetooth address of the remote device which this setting +describes a connection to. +

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

setting :

the NMSettingBluetooth +

Returns :

the Bluetooth address
+
+
+
+

nm_setting_bluetooth_get_connection_type ()

+
const char *        nm_setting_bluetooth_get_connection_type
+                                                        (NMSettingBluetooth *setting);
+

+Returns the connection method for communicating with the remote device (i.e. +either DUN to a DUN-capable device or PANU to a NAP-capable device). +

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

setting :

the NMSettingBluetooth +

Returns :

the type, either NM_SETTING_BLUETOOTH_PANU or NM_SETTING_BLUETOOTH_DUN +

Property Details

-

The “bdaddr” property

-
  “bdaddr”                   GArray_guchar_ *
-

The Bluetooth address of the device.

-

Flags: Read / Write

+

The "bdaddr" property

+
  "bdaddr"                   GArray_guchar_*       : Read / Write
+

+The Bluetooth address of the device. +

-

The “type” property

-
  “type”                     gchar *
-

Either 'dun' for Dial-Up Networking connections or 'panu' for Personal Area Networking connections.

-

Flags: Read / Write

+

The "type" property

+
  "type"                     gchar*                : Read / Write
+

+Either "dun" for Dial-Up Networking connections or "panu" for Personal +Area Networking connections to devices supporting the NAP profile. +

Default value: NULL

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