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-glib/html/NMObject.html | 444 ++++++++++++++++++------------------- 1 file changed, 220 insertions(+), 224 deletions(-) (limited to 'docs/libnm-glib/html/NMObject.html') diff --git a/docs/libnm-glib/html/NMObject.html b/docs/libnm-glib/html/NMObject.html index cedff8ee..9cc58a6f 100644 --- a/docs/libnm-glib/html/NMObject.html +++ b/docs/libnm-glib/html/NMObject.html @@ -2,38 +2,29 @@ -NMObject +libnm-glib Reference Manual: NMObject - + - - - - - - - - - - + + + + + + +
@@ -41,281 +32,286 @@

NMObject

NMObject

- +
- -
-

Object Hierarchy

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

Implemented Interfaces

-

-NMObject implements - GInitable and GAsyncInitable.

+

Functions

+
++++ + + + + + + + + + + + + + + +
+GQuark + +nm_object_error_quark () +
+DBusGConnection * + +nm_object_get_connection () +
const char * + +nm_object_get_path () +

Properties

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

Signals

-
-  "object-creation-failed"                         : Run First
-
-
-
-

Description

-

-

+
+++++ + + + + + +
voidobject-creation-failedRun First
-

Details

-
-

enum NMObjectError

-
typedef enum {
-	NM_OBJECT_ERROR_UNKNOWN = 0,
-	NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE,
-} NMObjectError;
-
-

-Describes errors that may result from operations involving a NMObject. -

-
+

Types and Values

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

NM_OBJECT_ERROR_UNKNOWN

unknown or unclassified error -enumNMObjectError

NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE

an error ocured while creating an NMObject -#defineNM_OBJECT_ERROR
#defineNM_OBJECT_DBUS_CONNECTION
#defineNM_OBJECT_DBUS_PATH
-
-
-

NM_OBJECT_ERROR

-
#define NM_OBJECT_ERROR nm_object_error_quark ()
+
+

Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ├── NMClient
+        ├── NMDevice
+        ├── NMWimaxNsp
+        ├── NMAccessPoint
+        ├── NMIP4Config
+        ├── NMIP6Config
+        ├── NMActiveConnection
+        ├── NMDHCP4Config
+        ╰── NMDHCP6Config
 
+
+
+

Description

+
+

Functions

+
+

nm_object_error_quark ()

+
GQuark
+nm_object_error_quark (void);
+

Registers an error quark for NMObject if necessary.

+
+

Returns

+

the error quark used for NMObject errors.

+

+
+

-

nm_object_error_quark ()

-
GQuark              nm_object_error_quark               (void);
-

-Registers an error quark for NMObject if necessary. -

-
+

nm_object_get_connection ()

+
DBusGConnection *
+nm_object_get_connection (NMObject *object);
+

Gets the NMObject's DBusGConnection.

+
+

Parameters

+
--+++ - - + + +

Returns :

the error quark used for NMObject errors.

object

a NMObject

 
-
-
-

NM_OBJECT_DBUS_CONNECTION

-
#define NM_OBJECT_DBUS_CONNECTION "dbus-connection"
-
-

-

+
+

Returns

+

the connection.

+

[transfer none]

-
-
-

NM_OBJECT_DBUS_PATH

-
#define NM_OBJECT_DBUS_PATH "dbus-path"
-
-

-


-

NMObject

-
typedef struct _NMObject NMObject;
-

-

+

nm_object_get_path ()

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

Gets the DBus path of the NMObject.

+
+

Parameters

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

object

a NMObject

 
-
-
-

NMObjectClass

-
typedef struct {
-	GObjectClass parent;
-
-	/* Signals */
-	/* The "object-creation-failed" signal is PRIVATE for libnm-glib and
-	 * is not meant for any external usage.  It indicates that an error
-	 * occured during creation of an object.
-	 */
-	void (*object_creation_failed) (NMObject *master_object,
-	                                GError *error,
-	                                char *failed_path);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMObjectClass;
-
-

-

+
+

Returns

+

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

+

-
+
+
+
+

Types and Values

-

nm_object_get_connection ()

-
DBusGConnection *   nm_object_get_connection            (NMObject *object);
-

-Gets the NMObject's DBusGConnection. -

-
+

enum NMObjectError

+

Describes errors that may result from operations involving a NMObject.

+
+

Members

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

object :

a NMObject +

NM_OBJECT_ERROR_UNKNOWN

+

unknown or unclassified error

 

Returns :

the connection. [transfer none] +

NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE

+

an error ocured while creating an NMObject

 
+

-

nm_object_get_path ()

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

NM_OBJECT_ERROR

+
#define NM_OBJECT_ERROR nm_object_error_quark ()
+
+

+

+
+
+
+

NM_OBJECT_DBUS_CONNECTION

+
#define NM_OBJECT_DBUS_CONNECTION "dbus-connection"
+
+

+

+
+
+
+

NM_OBJECT_DBUS_PATH

+
#define NM_OBJECT_DBUS_PATH "dbus-path"
+

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

The “dbus-connection” property

+
  “dbus-connection”          DBusGConnection *

+

Flags: Read / Write / Construct Only


-

The "dbus-path" property

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

The “dbus-path” property

+
  “dbus-path”                gchar *

+

Flags: Read / Write / Construct Only

Default value: NULL

Signal Details

-

The "object-creation-failed" signal

-
void                user_function                      (NMObject *master_object,
-                                                        gpointer  error,
-                                                        gpointer  failed_path,
-                                                        gpointer  user_data)          : Run First
-

-Indicates that an error occured while creating an NMObject object -during property handling of master_object. -

-

-Note: Be aware that the signal is private for libnm-glib's internal - use. -

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

master_object :

the object that received the signal

error :

the error that occured while creating object

failed_path :

object path of the failed object

user_data :

user data set when the signal handler was connected.
+

The “object-creation-failed” signal

+
void
+user_function (NMObject *master_object,
+               gpointer  error,
+               gpointer  failed_path,
+               gpointer  user_data)
+

Flags: Run First

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