libnm-glib Reference Manual: NMObject

@@ -32,286 +41,281 @@

NMObject

- +

Synopsis

enum                NMObjectError;
+#define             NM_OBJECT_ERROR
+GQuark              nm_object_error_quark               (void);
+#define             NM_OBJECT_DBUS_CONNECTION
+#define             NM_OBJECT_DBUS_PATH
+                    NMObject;
+                    NMObjectClass;
+DBusGConnection *   nm_object_get_connection            (NMObject *object);
+const char *        nm_object_get_path                  (NMObject *object);
+

Functions

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

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

Object Hierarchy

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

Implemented Interfaces

+NMObject implements + GInitable and GAsyncInitable.

Properties

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

-DBusGConnection *	dbus-connection	Read / Write / Construct Only
-gchar *	dbus-path	Read / Write / Construct Only

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

Signals

----- - - - - - -

void

object-creation-failed

Run First

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

Description

Types and Values

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

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

enum	NMObjectError
#define	NM_OBJECT_ERROR
#define	NM_OBJECT_DBUS_CONNECTION	`NM_OBJECT_ERROR_UNKNOWN`	unknown or unclassified error +
#define	NM_OBJECT_DBUS_PATH	`NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE`	an error ocured while creating an NMObject +

Object Hierarchy

    GObject
-    ╰── NMObject
-        ├── NMClient
-        ├── NMDevice
-        ├── NMWimaxNsp
-        ├── NMAccessPoint
-        ├── NMIP4Config
-        ├── NMIP6Config
-        ├── NMActiveConnection
-        ├── NMDHCP4Config
-        ╰── NMDHCP6Config
+
+
+NM_OBJECT_ERROR
+#define NM_OBJECT_ERROR nm_object_error_quark ()
 
-
-
-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_get_connection ()
-DBusGConnection *
-nm_object_get_connection (NMObject *object);
-Gets the NMObject's DBusGConnection.
-
-Parameters
-
+nm_object_error_quark ()
+GQuark              nm_object_error_quark               (void);
+
+Registers an error quark for NMObject if necessary.
+
+
---++
-
-
-
+
+
 





 
 object a NMObject   Returns : the error quark used for NMObject errors.
 
 
 
-
-Returns
- the connection. 
-[transfer none]
-
-
 
 
-nm_object_get_path ()
-const char *
-nm_object_get_path (NMObject *object);
-Gets the DBus path of the NMObject.
-
-Parameters
-
-----
-
-
-
-
-
-



object a NMObject  
+NM_OBJECT_DBUS_CONNECTION
+#define NM_OBJECT_DBUS_CONNECTION "dbus-connection"
+
+
+
 
-
-Returns
- the object's path. This is the internal string used by the
-device, and must not be modified.
-
+
+
+NM_OBJECT_DBUS_PATH
+#define NM_OBJECT_DBUS_PATH "dbus-path"
+
+
+
 
+
+
+NMObject
+typedef struct _NMObject 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;
+
+
+
 
-
-Types and Values
+
 
-enum NMObjectError
-Describes errors that may result from operations involving a NMObject.
-
-Members
-
+nm_object_get_connection ()
+DBusGConnection *   nm_object_get_connection            (NMObject *object);
+
+Gets the NMObject's DBusGConnection.
+
+
---++
-
-
+
-
-
-
+
-
 





 
 
 NM_OBJECT_ERROR_UNKNOWN 
-unknown or unclassified error
+ object : a NMObject
  
 
 NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE 
-an error ocured while creating an NMObject
+ Returns : the connection. [transfer none]
  
 
 
 
 
-
-
-
-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"
-
+nm_object_get_path ()
+const char *        nm_object_get_path                  (NMObject *object);
 
+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 *
+The "dbus-connection" property
+  "dbus-connection"          DBusGConnection*      : Read / Write / Construct Only
 Connection.
-Flags: Read / Write / Construct Only
 
 
 
-The “dbus-path” property
-  “dbus-path”                gchar *
+The "dbus-path" property
+  "dbus-path"                gchar*                : Read / Write / Construct Only
 DBus Object Path.
-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)
-Flags: Run First
+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.
 
 
 
 
 
-          Generated by GTK-Doc V1.20
+          Generated by GTK-Doc V1.19
 
 
\ No newline at end of file
-- 
cgit 1.3.0-6-gf8a5

			libnm-glib Reference Manual
+Top + \| + Description + \| + Object Hierarchy + \| + Implemented Interfaces + \| + Properties + \| + Signals +

NM_OBJECT_ERROR_UNKNOWN	- unknown or unclassified error +	`object` :	a NMObject
NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE	- an error ocured while creating an NMObject +	Returns :	the connection. [transfer none]

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

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