![]() |
![]() |
![]() |
colord Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#define CD_DEVICE_ERROR #define CD_DEVICE_TYPE_ERROR void (*changed) (CdProfile *profile
); void (*_cd_device_reserved1) (void
); void (*_cd_device_reserved2) (void
); void (*_cd_device_reserved3) (void
); void (*_cd_device_reserved4) (void
); void (*_cd_device_reserved5) (void
); void (*_cd_device_reserved6) (void
); void (*_cd_device_reserved7) (void
); void (*_cd_device_reserved8) (void
); enum CdDeviceError; GQuark cd_device_error_quark (void
); CdDevice * cd_device_new (void
); gchar * cd_device_to_string (CdDevice *device
); gboolean cd_device_set_object_path_sync (CdDevice *device
,const gchar *object_path
,GCancellable *cancellable
,GError **error
); gboolean cd_device_set_model_sync (CdDevice *device
,const gchar *value
,GCancellable *cancellable
,GError **error
); gboolean cd_device_set_serial_sync (CdDevice *device
,const gchar *value
,GCancellable *cancellable
,GError **error
); gboolean cd_device_set_vendor_sync (CdDevice *device
,const gchar *value
,GCancellable *cancellable
,GError **error
); gboolean cd_device_set_kind_sync (CdDevice *device
,CdDeviceKind kind
,GCancellable *cancellable
,GError **error
); gboolean cd_device_set_colorspace_sync (CdDevice *device
,CdColorspace colorspace
,GCancellable *cancellable
,GError **error
); gboolean cd_device_set_mode_sync (CdDevice *device
,CdDeviceMode mode
,GCancellable *cancellable
,GError **error
); gboolean cd_device_add_profile_sync (CdDevice *device
,CdDeviceRelation relation
,CdProfile *profile
,GCancellable *cancellable
,GError **error
); gboolean cd_device_remove_profile_sync (CdDevice *device
,CdProfile *profile
,GCancellable *cancellable
,GError **error
); CdProfile * cd_device_get_profile_for_qualifiers_sync (CdDevice *device
,const gchar **qualifiers
,GCancellable *cancellable
,GError **error
); gboolean cd_device_make_profile_default_sync (CdDevice *device
,CdProfile *profile
,GCancellable *cancellable
,GError **error
); gboolean cd_device_profiling_inhibit_sync (CdDevice *device
,GCancellable *cancellable
,GError **error
); gboolean cd_device_profiling_uninhibit_sync (CdDevice *device
,GCancellable *cancellable
,GError **error
); CdDeviceRelation cd_device_get_profile_relation (CdDevice *device
,CdProfile *profile
,GCancellable *cancellable
,GError **error
); const gchar * cd_device_get_id (CdDevice *device
); const gchar * cd_device_get_model (CdDevice *device
); const gchar * cd_device_get_vendor (CdDevice *device
); const gchar * cd_device_get_serial (CdDevice *device
); guint64 cd_device_get_created (CdDevice *device
); guint64 cd_device_get_modified (CdDevice *device
); CdDeviceKind cd_device_get_kind (CdDevice *device
); CdColorspace cd_device_get_colorspace (CdDevice *device
); CdDeviceMode cd_device_get_mode (CdDevice *device
); GPtrArray * cd_device_get_profiles (CdDevice *device
); CdProfile * cd_device_get_default_profile (CdDevice *device
); const gchar * cd_device_get_object_path (CdDevice *device
); GHashTable * cd_device_get_metadata (CdDevice *device
); const gchar * cd_device_get_metadata_item (CdDevice *device
,const gchar *key
); CdDevicePrivate;
A helper GObject to use for accessing colord devices, and to be notified when it is changed.
See also: CdClient
typedef enum { CD_DEVICE_ERROR_FAILED, CD_DEVICE_ERROR_LAST } CdDeviceError;
Errors that can be thrown
CdDevice * cd_device_new (void
);
Creates a new CdDevice object.
Returns : |
a new CdDevice object. |
Since 0.1.0
gchar * cd_device_to_string (CdDevice *device
);
Converts the device to a string description.
|
a CdDevice instance. |
Returns : |
text representation of CdDevice |
Since 0.1.0
gboolean cd_device_set_object_path_sync (CdDevice *device
,const gchar *object_path
,GCancellable *cancellable
,GError **error
);
Sets the object path of the object and fills up initial properties.
|
a CdDevice instance. |
|
The colord object path. |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.0
gboolean cd_device_set_model_sync (CdDevice *device
,const gchar *value
,GCancellable *cancellable
,GError **error
);
Sets the device model.
|
a CdDevice instance. |
|
The model. |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.0
gboolean cd_device_set_serial_sync (CdDevice *device
,const gchar *value
,GCancellable *cancellable
,GError **error
);
Sets the device serial number.
|
a CdDevice instance. |
|
The string value. |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.1
gboolean cd_device_set_vendor_sync (CdDevice *device
,const gchar *value
,GCancellable *cancellable
,GError **error
);
Sets the device vendor.
|
a CdDevice instance. |
|
The string value. |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.1
gboolean cd_device_set_kind_sync (CdDevice *device
,CdDeviceKind kind
,GCancellable *cancellable
,GError **error
);
Sets the device kind.
|
a CdDevice instance. |
|
The device kind, e.g. CD_DEVICE_KIND_DISPLAY |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.0
gboolean cd_device_set_colorspace_sync (CdDevice *device
,CdColorspace colorspace
,GCancellable *cancellable
,GError **error
);
Sets the device kind.
|
a CdDevice instance. |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.1
gboolean cd_device_set_mode_sync (CdDevice *device
,CdDeviceMode mode
,GCancellable *cancellable
,GError **error
);
Sets the device mode.
|
a CdDevice instance. |
|
The device kind, e.g. CD_DEVICE_MODE_VIRTUAL |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.2
gboolean cd_device_add_profile_sync (CdDevice *device
,CdDeviceRelation relation
,CdProfile *profile
,GCancellable *cancellable
,GError **error
);
Adds a profile to a device.
|
a CdDevice instance. |
|
a CdDeviceRelation, e.g. CD_DEVICE_RELATION_HARD |
|
a CdProfile instance |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.3
gboolean cd_device_remove_profile_sync (CdDevice *device
,CdProfile *profile
,GCancellable *cancellable
,GError **error
);
Removes a profile from a device.
|
a CdDevice instance. |
|
a CdProfile instance |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.2
CdProfile * cd_device_get_profile_for_qualifiers_sync (CdDevice *device
,const gchar **qualifiers
,GCancellable *cancellable
,GError **error
);
Gets the prefered profile for some qualifiers.
|
a CdDevice instance. |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
a CdProfile, free with g_object_unref()
|
Since 0.1.3
gboolean cd_device_make_profile_default_sync (CdDevice *device
,CdProfile *profile
,GCancellable *cancellable
,GError **error
);
Makes an already added profile default for a device.
|
a CdDevice instance. |
|
a CdProfile instance |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.0
gboolean cd_device_profiling_inhibit_sync (CdDevice *device
,GCancellable *cancellable
,GError **error
);
Sets up the device for profiling and causes no profiles to be
returned if cd_device_get_profile_for_qualifiers_sync()
is used.
|
a CdDevice instance. |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.1
gboolean cd_device_profiling_uninhibit_sync (CdDevice *device
,GCancellable *cancellable
,GError **error
);
Restores the device after profiling and causes normal profiles to be
returned if cd_device_get_profile_for_qualifiers_sync()
is used.
|
a CdDevice instance. |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
TRUE for success, else FALSE and error is used |
Since 0.1.1
CdDeviceRelation cd_device_get_profile_relation (CdDevice *device
,CdProfile *profile
,GCancellable *cancellable
,GError **error
);
Gets the property relationship to the device.
|
a CdDevice instance. |
|
a CdProfile instance. |
|
a GCancellable or NULL
|
|
a GError, or NULL . |
Returns : |
a CdDeviceRelation |
Since 0.1.4
const gchar * cd_device_get_id (CdDevice *device
);
Gets the device ID.
|
a CdDevice instance. |
Returns : |
A string, or NULL for invalid |
Since 0.1.0
const gchar * cd_device_get_model (CdDevice *device
);
Gets the device model.
|
a CdDevice instance. |
Returns : |
A string, or NULL for invalid |
Since 0.1.0
const gchar * cd_device_get_vendor (CdDevice *device
);
Gets the device vendor.
|
a CdDevice instance. |
Returns : |
A string, or NULL for invalid |
Since 0.1.1
const gchar * cd_device_get_serial (CdDevice *device
);
Gets the device serial number.
|
a CdDevice instance. |
Returns : |
A string, or NULL for invalid |
Since 0.1.0
guint64 cd_device_get_created (CdDevice *device
);
Gets the device creation date.
|
a CdDevice instance. |
Returns : |
A value in seconds, or 0 for invalid |
Since 0.1.0
guint64 cd_device_get_modified (CdDevice *device
);
Gets the device modified date.
|
a CdDevice instance. |
Returns : |
A value in seconds, or 0 for invalid |
Since 0.1.1
CdDeviceKind cd_device_get_kind (CdDevice *device
);
Gets the device kind.
|
a CdDevice instance. |
Returns : |
A device kind, e.g. CD_DEVICE_KIND_DISPLAY
|
Since 0.1.0
CdColorspace cd_device_get_colorspace (CdDevice *device
);
Gets the device colorspace.
|
a CdDevice instance. |
Returns : |
A colorspace, e.g. CD_COLORSPACE_RGB
|
Since 0.1.1
CdDeviceMode cd_device_get_mode (CdDevice *device
);
Gets the device mode.
|
a CdDevice instance. |
Returns : |
A colorspace, e.g. CD_DEVICE_MODE_VIRTUAL
|
Since 0.1.2
GPtrArray * cd_device_get_profiles (CdDevice *device
);
Gets the device profiles.
|
a CdDevice instance. |
Returns : |
An array of CdProfile's, free with g_ptr_array_unref()
|
Since 0.1.0
CdProfile * cd_device_get_default_profile (CdDevice *device
);
Gets the default device profile.
|
a CdDevice instance. |
Returns : |
A CdProfile's or NULL, free with g_object_unref()
|
Since 0.1.1
const gchar * cd_device_get_object_path (CdDevice *device
);
Gets the object path for the device.
|
a CdDevice instance. |
Returns : |
the object path, or NULL
|
Since 0.1.0
GHashTable * cd_device_get_metadata (CdDevice *device
);
Returns the device metadata.
|
a CdDevice instance. |
Returns : |
a GHashTable, free with g_hash_table_unref() . |
Since 0.1.5
const gchar * cd_device_get_metadata_item (CdDevice *device
,const gchar *key
);
Returns the device metadata for a specific key.
|
a CdDevice instance. |
|
a key for the metadata dictionary |
Returns : |
the metadata value, or NULL if not set. |
Since 0.1.5