From 59c3714a494c3b3765657c0551ad82842d98a7d2 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Sat, 26 Apr 2014 20:55:09 +0200 Subject: Imported Upstream version 0.9.8.10 --- docs/libnm-glib/html/NMDeviceBt.html | 539 +++++++++++++++++++---------------- 1 file changed, 296 insertions(+), 243 deletions(-) (limited to 'docs/libnm-glib/html/NMDeviceBt.html') diff --git a/docs/libnm-glib/html/NMDeviceBt.html b/docs/libnm-glib/html/NMDeviceBt.html index e3a59fc7..e951a85a 100644 --- a/docs/libnm-glib/html/NMDeviceBt.html +++ b/docs/libnm-glib/html/NMDeviceBt.html @@ -2,36 +2,28 @@ -NMDeviceBt +libnm-glib Reference Manual: NMDeviceBt - + - - - - - - - - - - + + + + + + +
@@ -39,321 +31,382 @@

NMDeviceBt

NMDeviceBt

- +
-
-

Synopsis

-
enum                NMDeviceBtError;
-#define             NM_DEVICE_BT_ERROR
-GQuark              nm_device_bt_error_quark            (void);
-#define             NM_DEVICE_BT_HW_ADDRESS
-#define             NM_DEVICE_BT_NAME
-#define             NM_DEVICE_BT_CAPABILITIES
-                    NMDeviceBt;
-                    NMDeviceBtClass;
-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);
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceBt
-
-
-
-

Implemented Interfaces

-

-NMDeviceBt implements - GInitable and GAsyncInitable.

-
-
-

Properties

-
-  "bt-capabilities"          guint                 : Read
-  "hw-address"               gchar*                : Read
-  "name"                     gchar*                : Read
-
-
-
-

Description

-

-

-
-
-

Details

-
-

enum NMDeviceBtError

-
typedef enum {
-	NM_DEVICE_BT_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
-	NM_DEVICE_BT_ERROR_NOT_BT_CONNECTION,     /*< nick=NotBtConnection >*/
-	NM_DEVICE_BT_ERROR_INVALID_BT_CONNECTION, /*< nick=InvalidBtConnection >*/
-	NM_DEVICE_BT_ERROR_INVALID_DEVICE_MAC,    /*< nick=InvalidDeviceMac >*/
-	NM_DEVICE_BT_ERROR_MAC_MISMATCH,          /*< nick=MacMismatch >*/
-	NM_DEVICE_BT_ERROR_MISSING_DEVICE_CAPS,   /*< nick=MissingDeviceCaps >*/
-} NMDeviceBtError;
-
-
+

Functions

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

NM_DEVICE_BT_ERROR_UNKNOWN

unknown or unclassified error + +GQuark

NM_DEVICE_BT_ERROR_NOT_BT_CONNECTION

the connection was not of bluetooth type + +nm_device_bt_error_quark ()

NM_DEVICE_BT_ERROR_INVALID_BT_CONNECTION

the bluetooth connection was invalid + +GObject * + +nm_device_bt_new ()

NM_DEVICE_BT_ERROR_INVALID_DEVICE_MAC

the device's MAC was invalid +const char * + +nm_device_bt_get_hw_address ()

NM_DEVICE_BT_ERROR_MAC_MISMATCH

the MACs of the connection and the device mismatched +const char * + +nm_device_bt_get_name ()

NM_DEVICE_BT_ERROR_MISSING_DEVICE_CAPS

the device missed required capabilities + +NMBluetoothCapabilities + +nm_device_bt_get_capabilities ()
-
-
-

NM_DEVICE_BT_ERROR

-
#define NM_DEVICE_BT_ERROR nm_device_bt_error_quark ()
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + +
guintbt-capabilitiesRead
+gchar *hw-addressRead
+gchar *nameRead
-
-
-

nm_device_bt_error_quark ()

-
GQuark              nm_device_bt_error_quark            (void);
-

-Registers an error quark for NMDeviceBt if necessary. -

-
+
+

Types and Values

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

Returns :

the error quark used for NMDeviceBt errors.
enumNMDeviceBtError
#defineNM_DEVICE_BT_ERROR
#defineNM_DEVICE_BT_HW_ADDRESS
#defineNM_DEVICE_BT_NAME
#defineNM_DEVICE_BT_CAPABILITIES
-
-
-

NM_DEVICE_BT_HW_ADDRESS

-
#define NM_DEVICE_BT_HW_ADDRESS   "hw-address"
+

+
Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceBt
 

-

-

 

-

-

-
NM_DEVICE_BT_NAME

-
#define NM_DEVICE_BT_NAME         "name"
-

+

+
Description

 

 

 

-

+

+
Functions

 

-
NM_DEVICE_BT_CAPABILITIES

-
#define NM_DEVICE_BT_CAPABILITIES "bt-capabilities"
-

-

-

+
nm_device_bt_error_quark ()

+
GQuark
+nm_device_bt_error_quark (void);

+
Registers an error quark for NMDeviceBt if necessary.

+

+
Returns

+
 the error quark used for NMDeviceBt errors.

+

 

-

-

-
NMDeviceBt

-
typedef struct _NMDeviceBt NMDeviceBt;

-

-

 

 

 

-
NMDeviceBtClass

-
typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceBtClass;
-

-

-

-

-

-

-
nm_device_bt_new ()

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

-

-Creates a new NMDeviceBt.
-

-

+
nm_device_bt_new ()

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

+
Creates a new NMDeviceBt.

+

+
Parameters

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

 





 
 
 
connection :
the DBusGConnection
-
connection
the DBusGConnection
 
 

 
path :
the DBus object path of the device
Returns :
a new device. [transfer full]
-
path
the DBus object path of the device
 
 

 
 

 

+

+
Returns

+
 a new device. 

+
[transfer full]

+

+

 

 

-
nm_device_bt_get_hw_address ()

-
const char *        nm_device_bt_get_hw_address         (NMDeviceBt *device);

-

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

-

+
nm_device_bt_get_hw_address ()

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

+
Gets the hardware (MAC) address of the NMDeviceBt

+

+
Parameters

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

 





 
device :
a NMDeviceBt
-
Returns :
the hardware address. This is the internal string used by the
-device, and must not be modified.
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.
-

-

+
nm_device_bt_get_name ()

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

+
Gets the name of the NMDeviceBt.

+

+
Parameters

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

 





 
device :
a NMDeviceBt
-
Returns :
the name of the device
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.
-

-

+
nm_device_bt_get_capabilities ()

+
NMBluetoothCapabilities
+nm_device_bt_get_capabilities (NMDeviceBt *device);

+
Returns the Bluetooth device's usable capabilities.

+

+
Parameters

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

 






device
a NMDeviceBt
 

+

+

+
Returns

+
 a combination of NMBluetoothCapabilities

+

+

+
+
+
+

Types and Values

+
+

enum NMDeviceBtError

+
+

Members

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

device :

a NMDeviceBt +

NM_DEVICE_BT_ERROR_UNKNOWN

 +

unknown or unclassified error

+		 

NM_DEVICE_BT_ERROR_NOT_BT_CONNECTION

 +

the connection was not of bluetooth type

+		 

NM_DEVICE_BT_ERROR_INVALID_BT_CONNECTION

 +

the bluetooth connection was invalid

+		 

NM_DEVICE_BT_ERROR_INVALID_DEVICE_MAC

 +

the device's MAC was invalid

+		 

NM_DEVICE_BT_ERROR_MAC_MISMATCH

 +

the MACs of the connection and the device mismatched

 

Returns :

a combination of NMBluetoothCapabilities +

NM_DEVICE_BT_ERROR_MISSING_DEVICE_CAPS

 +

the device missed required capabilities

 
-
-

Property Details

+
-

The "bt-capabilities" property

-
  "bt-capabilities"          guint                 : Read
+

NM_DEVICE_BT_ERROR

+
#define NM_DEVICE_BT_ERROR nm_device_bt_error_quark ()
+

-The device's bluetooth capabilities, a combination of NMBluetoothCapabilities.

-

Default value: 0

-

The "hw-address" property

-
  "hw-address"               gchar*                : Read
+

NM_DEVICE_BT_HW_ADDRESS

+
#define NM_DEVICE_BT_HW_ADDRESS   "hw-address"
+

-The hardware (MAC) address of the device.

-

Default value: NULL

-

The "name" property

-
  "name"                     gchar*                : Read
+

NM_DEVICE_BT_NAME

+
#define NM_DEVICE_BT_NAME         "name"
+
+

+

+
+
+
+

NM_DEVICE_BT_CAPABILITIES

+
#define NM_DEVICE_BT_CAPABILITIES "bt-capabilities"
+

-The name of the bluetooth device.

+
+
+
+

Property Details

+
+

The “bt-capabilities” property

+
  “bt-capabilities”          guint
+

Bluetooth capabilities.

+

Flags: Read

+

Default value: 0

+
+
+
+

The “hw-address” property

+
  “hw-address”               gchar *
+

Hardware MAC address.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “name” property

+
  “name”                     gchar *
+

Device name.

+

Flags: Read

Default value: NULL

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