up-device

up-device — Client object for accessing information about UPower devices

Synopsis

#define             UP_DEVICE_ERROR
#define             UP_DEVICE_TYPE_ERROR
                    UpDevicePrivate;
void                (*changed)                          (UpClient *client);
UpDevice *          up_device_new                       (void);
gchar *             up_device_to_text                   (UpDevice *device);
gboolean            up_device_refresh_sync              (UpDevice *device,
                                                         GError **error);
gboolean            up_device_set_object_path_sync      (UpDevice *device,
                                                         const gchar *object_path,
                                                         GError **error);
const gchar *       up_device_get_object_path           (UpDevice *device);

Description

A helper GObject to use for accessing UPower devices, and to be notified when it is changed.

Details

UP_DEVICE_ERROR

#define UP_DEVICE_ERROR		(up_device_error_quark ())

UP_DEVICE_TYPE_ERROR

#define UP_DEVICE_TYPE_ERROR (up_device_error_get_type ())

UpDevicePrivate

typedef struct _UpDevicePrivate UpDevicePrivate;

Private PkDevice data

changed ()

void                (*changed)                          (UpClient *client);

up_device_new ()

UpDevice *          up_device_new                       (void);

Creates a new UpDevice object.

Returns :

a new UpDevice object.

Since 0.9.0

up_device_to_text ()

gchar *             up_device_to_text                   (UpDevice *device);

Converts the device to a string description.

`device` :	a UpDevice instance.
Returns :	text representation of UpDevice

Since 0.9.0

up_device_refresh_sync ()

gboolean            up_device_refresh_sync              (UpDevice *device,
                                                         GError **error);

Refreshes properties on the device. This function is normally not required.

`device` :	a UpDevice instance.
`error` :	a GError, or `NULL`.
Returns :	TRUE for success, else FALSE and `error` is used

Since 0.9.0

up_device_set_object_path_sync ()

gboolean            up_device_set_object_path_sync      (UpDevice *device,
                                                         const gchar *object_path,
                                                         GError **error);

Sets the object path of the object and fills up initial properties.

`device` :	a UpDevice instance.
`object_path` :	The UPower object path.
`error` :	a GError, or `NULL`.
Returns :	TRUE for success, else FALSE and `error` is used

Since 0.9.0

up_device_get_object_path ()

const gchar *       up_device_get_object_path           (UpDevice *device);

Gets the object path for the device.

`device` :	a UpDevice instance.
Returns :	the object path, or `NULL`

Since 0.9.0

			UPower Reference Manual
Top \| Description