| colord Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | ||||
gboolean cd_client_connect_sync (CdClient *client,GCancellable *cancellable,GError **error); CdDevice * cd_client_create_device_sync (CdClient *client,const gchar *id,CdObjectScope scope,GHashTable *properties,GCancellable *cancellable,GError **error); CdProfile * cd_client_create_profile_sync (CdClient *client,const gchar *id,CdObjectScope scope,GHashTable *properties,GCancellable *cancellable,GError **error); gboolean cd_client_delete_device_sync (CdClient *client,CdDevice *device,GCancellable *cancellable,GError **error); gboolean cd_client_delete_profile_sync (CdClient *client,CdProfile *profile,GCancellable *cancellable,GError **error); CdDevice * cd_client_find_device_by_property_sync (CdClient *client,const gchar *key,const gchar *value,GCancellable *cancellable,GError **error); CdDevice * cd_client_find_device_sync (CdClient *client,const gchar *id,GCancellable *cancellable,GError **error); CdProfile * cd_client_find_profile_by_filename_sync (CdClient *client,const gchar *filename,GCancellable *cancellable,GError **error); CdProfile * cd_client_find_profile_sync (CdClient *client,const gchar *id,GCancellable *cancellable,GError **error); GPtrArray * cd_client_get_devices_by_kind_sync (CdClient *client,CdDeviceKind kind,GCancellable *cancellable,GError **error); GPtrArray * cd_client_get_devices_sync (CdClient *client,GCancellable *cancellable,GError **error); GPtrArray * cd_client_get_profiles_sync (CdClient *client,GCancellable *cancellable,GError **error); GPtrArray * cd_client_get_sensors_sync (CdClient *client,GCancellable *cancellable,GError **error); CdProfile * cd_client_get_standard_space_sync (CdClient *client,CdStandardSpace standard_space,GCancellable *cancellable,GError **error); CdProfile * cd_client_import_profile_sync (CdClient *client,GFile *file,GCancellable *cancellable,GError **error);
These helper functions provide a simple way to use the async functions in command line tools.
See also: CdClient
gboolean cd_client_connect_sync (CdClient *client,GCancellable *cancellable,GError **error);
Connects to the colord daemon.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
a GCancellable or NULL
|
|
a GError, or NULL. |
Returns : |
TRUE for success, else FALSE. |
Since 0.1.0
CdDevice * cd_client_create_device_sync (CdClient *client,const gchar *id,CdObjectScope scope,GHashTable *properties,GCancellable *cancellable,GError **error);
Creates a color device.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
identifier for the device |
|
the scope of the device |
|
properties to set on the device, or NULL
|
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
A CdDevice object, or NULL for error. [transfer full]
|
Since 0.1.2
CdProfile * cd_client_create_profile_sync (CdClient *client,const gchar *id,CdObjectScope scope,GHashTable *properties,GCancellable *cancellable,GError **error);
Creates a color profile.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
identifier for the device |
|
the scope of the profile |
|
properties to set on the profile, or NULL
|
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
A CdProfile object, or NULL for error. [transfer full]
|
Since 0.1.2
gboolean cd_client_delete_device_sync (CdClient *client,CdDevice *device,GCancellable *cancellable,GError **error);
Deletes a color device.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
a CdDevice. |
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
TRUE is the device was deleted |
Since 0.1.8
gboolean cd_client_delete_profile_sync (CdClient *client,CdProfile *profile,GCancellable *cancellable,GError **error);
Deletes a color profile.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
a CdProfile. |
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
TRUE is the profile was deleted |
Since 0.1.8
CdDevice * cd_client_find_device_by_property_sync (CdClient *client,const gchar *key,const gchar *value,GCancellable *cancellable,GError **error);
Finds a color device that has a property value.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
The device property key. |
|
The device property value. |
|
a GCancellable or NULL
|
|
a GError, or NULL. |
Returns : |
A CdDevice object, or NULL for error. [transfer full]
|
Since 0.1.8
CdDevice * cd_client_find_device_sync (CdClient *client,const gchar *id,GCancellable *cancellable,GError **error);
Finds a color device.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
The device ID. |
|
a GCancellable or NULL
|
|
a GError, or NULL. |
Returns : |
A CdDevice object, or NULL for error. [transfer full]
|
Since 0.1.0
CdProfile * cd_client_find_profile_by_filename_sync (CdClient *client,const gchar *filename,GCancellable *cancellable,GError **error);
Finds a color profile from its filename.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
filename for the profile |
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
A CdProfile object, or NULL for error. [transfer full]
|
Since 0.1.3
CdProfile * cd_client_find_profile_sync (CdClient *client,const gchar *id,GCancellable *cancellable,GError **error);
Finds a color profile from its id.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
id for the profile |
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
A CdProfile object, or NULL for error. [transfer full]
|
Since 0.1.0
GPtrArray * cd_client_get_devices_by_kind_sync (CdClient *client,CdDeviceKind kind,GCancellable *cancellable,GError **error);
Get an array of the device objects of a specified kind.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
a CdDeviceKind, e.g. CD_DEVICE_KIND_DISPLAY
|
|
a GCancellable or NULL
|
|
a GError, or NULL. |
Returns : |
an array of CdDevice objects,
free with g_ptr_array_unref(). [transfer full]
|
Since 0.1.0
GPtrArray * cd_client_get_devices_sync (CdClient *client,GCancellable *cancellable,GError **error);
Get an array of the device objects.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
an array of CdDevice objects,
free with g_ptr_array_unref(). [transfer full]
|
Since 0.1.0
GPtrArray * cd_client_get_profiles_sync (CdClient *client,GCancellable *cancellable,GError **error);
Get an array of the profile objects.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
an array of CdProfile objects,
free with g_ptr_array_unref(). [transfer full]
|
Since 0.1.0
GPtrArray * cd_client_get_sensors_sync (CdClient *client,GCancellable *cancellable,GError **error);
Get an array of the sensor objects.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
an array of CdSensor objects,
free with g_ptr_array_unref(). [transfer full]
|
Since 0.1.0
CdProfile * cd_client_get_standard_space_sync (CdClient *client,CdStandardSpace standard_space,GCancellable *cancellable,GError **error);
Finds a standard colorspace.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
standard colorspace value |
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
A CdProfile object, or NULL for error. [transfer full]
|
Since 0.1.2
CdProfile * cd_client_import_profile_sync (CdClient *client,GFile *file,GCancellable *cancellable,GError **error);
Imports a color profile into the users home directory.
WARNING: This function is synchronous, and may block. Do not use it in GUI applications.
|
a CdClient instance. |
|
A GFile |
|
a GCancellable, or NULL
|
|
a GError, or NULL
|
Returns : |
A CdProfile object, or NULL for error. [transfer full]
|
Since 0.1.12