From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm-util/html/NMSettingBluetooth.html | 465 +++++++++++++++------------ 1 file changed, 251 insertions(+), 214 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 622a3c2c..cf501a32 100644 --- a/docs/libnm-util/html/NMSettingBluetooth.html +++ b/docs/libnm-util/html/NMSettingBluetooth.html @@ -2,34 +2,28 @@ -NMSettingBluetooth +libnm-util Reference Manual: NMSettingBluetooth - + - - - - - - - - - - + + + + + + +
@@ -37,59 +31,219 @@

NMSettingBluetooth

NMSettingBluetooth — Describes Bluetooth connection properties

- +
-
-

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

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

Object Hierarchy

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

Properties

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

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

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. -

+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_TYPE_PANU or +NM_SETTING_BLUETOOTH_TYPE_DUN

+

+
+
-

Details

+

Types and Values

NM_SETTING_BLUETOOTH_SETTING_NAME

#define NM_SETTING_BLUETOOTH_SETTING_NAME "bluetooth"
@@ -99,46 +253,51 @@ Point (NAP) profiles.
-

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

enum NMSettingBluetoothError

+
+

Members

+
--+++ - - + + - - + + - - + + - - + +

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

@@ -149,24 +308,6 @@ 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"
@@ -186,142 +327,38 @@ Registers an error quark for

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. -

-
-
-
-

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_TYPE_PANU or -NM_SETTING_BLUETOOTH_TYPE_DUN -
+

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

Property Details

-

The "bdaddr" property

-
  "bdaddr"                   GArray_guchar_*       : Read / Write
-

-The Bluetooth address of the device. -

+

The “bdaddr” property

+
  “bdaddr”                   GArray_guchar_ *
+

+

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. -

+

The “type” property

+
  “type”                     gchar *
+

+

Flags: Read / Write

Default value: NULL

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