up-types

up-types — Types used by UPower and libupower-glib

Synopsis

enum                UpDeviceKind;
enum                UpDeviceState;
enum                UpDeviceTechnology;
enum                UpQosKind;
const gchar *       up_device_kind_to_string            (UpDeviceKind type_enum);
const gchar *       up_device_state_to_string           (UpDeviceState state_enum);
const gchar *       up_device_technology_to_string      (UpDeviceTechnology technology_enum);
UpDeviceKind        up_device_kind_from_string          (const gchar *type);
UpDeviceState       up_device_state_from_string         (const gchar *state);
UpDeviceTechnology  up_device_technology_from_string    (const gchar *technology);
const gchar *       up_qos_kind_to_string               (UpQosKind type);
UpQosKind           up_qos_kind_from_string             (const gchar *type);

Description

These helper functions provide a way to marshal enumerated values to text and back again.

See also: UpClient, UpDevice

Details

enum UpDeviceKind

typedef enum {
	UP_DEVICE_KIND_UNKNOWN,
	UP_DEVICE_KIND_LINE_POWER,
	UP_DEVICE_KIND_BATTERY,
	UP_DEVICE_KIND_UPS,
	UP_DEVICE_KIND_MONITOR,
	UP_DEVICE_KIND_MOUSE,
	UP_DEVICE_KIND_KEYBOARD,
	UP_DEVICE_KIND_PDA,
	UP_DEVICE_KIND_PHONE,
	UP_DEVICE_KIND_MEDIA_PLAYER,
	UP_DEVICE_KIND_TABLET,
	UP_DEVICE_KIND_COMPUTER,
	UP_DEVICE_KIND_LAST
} UpDeviceKind;

The device type.


enum UpDeviceState

typedef enum {
	UP_DEVICE_STATE_UNKNOWN,
	UP_DEVICE_STATE_CHARGING,
	UP_DEVICE_STATE_DISCHARGING,
	UP_DEVICE_STATE_EMPTY,
	UP_DEVICE_STATE_FULLY_CHARGED,
	UP_DEVICE_STATE_PENDING_CHARGE,
	UP_DEVICE_STATE_PENDING_DISCHARGE,
	UP_DEVICE_STATE_LAST
} UpDeviceState;

The device state.


enum UpDeviceTechnology

typedef enum {
	UP_DEVICE_TECHNOLOGY_UNKNOWN,
	UP_DEVICE_TECHNOLOGY_LITHIUM_ION,
	UP_DEVICE_TECHNOLOGY_LITHIUM_POLYMER,
	UP_DEVICE_TECHNOLOGY_LITHIUM_IRON_PHOSPHATE,
	UP_DEVICE_TECHNOLOGY_LEAD_ACID,
	UP_DEVICE_TECHNOLOGY_NICKEL_CADMIUM,
	UP_DEVICE_TECHNOLOGY_NICKEL_METAL_HYDRIDE,
	UP_DEVICE_TECHNOLOGY_LAST
} UpDeviceTechnology;

The device technology.


enum UpQosKind

typedef enum {
	UP_QOS_KIND_UNKNOWN,
	UP_QOS_KIND_NETWORK,
	UP_QOS_KIND_CPU_DMA,
	UP_QOS_KIND_LAST
} UpQosKind;

The type of QOS request.


up_device_kind_to_string ()

const gchar *       up_device_kind_to_string            (UpDeviceKind type_enum);

Converts a UpDeviceKind to a string.

Returns :

identifier string

Since 0.9.0


up_device_state_to_string ()

const gchar *       up_device_state_to_string           (UpDeviceState state_enum);

Converts a UpDeviceState to a string.

Returns :

identifier string

Since 0.9.0


up_device_technology_to_string ()

const gchar *       up_device_technology_to_string      (UpDeviceTechnology technology_enum);

Converts a UpDeviceTechnology to a string.

Returns :

identifier string

Since 0.9.0


up_device_kind_from_string ()

UpDeviceKind        up_device_kind_from_string          (const gchar *type);

Converts a string to a UpDeviceKind.

Returns :

enumerated value

Since 0.9.0


up_device_state_from_string ()

UpDeviceState       up_device_state_from_string         (const gchar *state);

Converts a string to a UpDeviceState.

Returns :

enumerated value

Since 0.9.0


up_device_technology_from_string ()

UpDeviceTechnology  up_device_technology_from_string    (const gchar *technology);

Converts a string to a UpDeviceTechnology.

Returns :

enumerated value

Since 0.9.0


up_qos_kind_to_string ()

const gchar *       up_qos_kind_to_string               (UpQosKind type);

Converts a UpQosKind to a string.

Returns :

identifier string

Since 0.9.0


up_qos_kind_from_string ()

UpQosKind           up_qos_kind_from_string             (const gchar *type);

Converts a string to a UpQosKind.

Returns :

enumerated value

Since 0.9.0