![]() |
![]() |
![]() |
colord Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#define CD_CLIENT_ERROR #define CD_CLIENT_TYPE_ERROR enum CdClientError; void (*_cd_client_reserved1) (void
); void (*_cd_client_reserved2) (void
); void (*_cd_client_reserved3) (void
); void (*_cd_client_reserved4) (void
); void (*_cd_client_reserved5) (void
); void (*_cd_client_reserved6) (void
); void (*_cd_client_reserved7) (void
); void (*_cd_client_reserved8) (void
); void cd_client_connect (CdClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean cd_client_connect_finish (CdClient *client
,GAsyncResult *res
,GError **error
); void cd_client_create_device (CdClient *client
,const gchar *id
,CdObjectScope scope
,GHashTable *properties
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); CdDevice * cd_client_create_device_finish (CdClient *client
,GAsyncResult *res
,GError **error
); void cd_client_create_profile (CdClient *client
,const gchar *id
,CdObjectScope scope
,GHashTable *properties
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); CdProfile * cd_client_create_profile_finish (CdClient *client
,GAsyncResult *res
,GError **error
); void cd_client_delete_device (CdClient *client
,CdDevice *device
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean cd_client_delete_device_finish (CdClient *client
,GAsyncResult *res
,GError **error
); void cd_client_delete_profile (CdClient *client
,CdProfile *profile
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean cd_client_delete_profile_finish (CdClient *client
,GAsyncResult *res
,GError **error
); GQuark cd_client_error_quark (void
); void cd_client_find_device (CdClient *client
,const gchar *id
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); void cd_client_find_device_by_property (CdClient *client
,const gchar *key
,const gchar *value
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); CdDevice * cd_client_find_device_by_property_finish (CdClient *client
,GAsyncResult *res
,GError **error
); CdDevice * cd_client_find_device_finish (CdClient *client
,GAsyncResult *res
,GError **error
); void cd_client_find_profile (CdClient *client
,const gchar *id
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); void cd_client_find_profile_by_filename (CdClient *client
,const gchar *filename
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); CdProfile * cd_client_find_profile_by_filename_finish (CdClient *client
,GAsyncResult *res
,GError **error
); CdProfile * cd_client_find_profile_finish (CdClient *client
,GAsyncResult *res
,GError **error
); gboolean cd_client_get_connected (CdClient *client
); const gchar * cd_client_get_daemon_version (CdClient *client
); void cd_client_get_devices (CdClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); void cd_client_get_devices_by_kind (CdClient *client
,CdDeviceKind kind
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); GPtrArray * cd_client_get_devices_by_kind_finish (CdClient *client
,GAsyncResult *res
,GError **error
); GPtrArray * cd_client_get_devices_finish (CdClient *client
,GAsyncResult *res
,GError **error
); gboolean cd_client_get_has_server (CdClient *client
); void cd_client_get_profiles (CdClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); GPtrArray * cd_client_get_profiles_finish (CdClient *client
,GAsyncResult *res
,GError **error
); void cd_client_get_sensors (CdClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); GPtrArray * cd_client_get_sensors_finish (CdClient *client
,GAsyncResult *res
,GError **error
); void cd_client_get_standard_space (CdClient *client
,CdStandardSpace standard_space
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); CdProfile * cd_client_get_standard_space_finish (CdClient *client
,GAsyncResult *res
,GError **error
); void cd_client_import_profile (CdClient *client
,GFile *file
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); CdProfile * cd_client_import_profile_finish (CdClient *client
,GAsyncResult *res
,GError **error
); CdClient * cd_client_new (void
); void (*changed) (CdClient *client
); void (*device_added) (CdClient *client
,CdDevice *device
); void (*device_changed) (CdClient *client
,CdDevice *device
); void (*device_removed) (CdClient *client
,CdDevice *device
); void (*profile_added) (CdClient *client
,CdProfile *profile
); void (*profile_changed) (CdClient *client
,CdProfile *profile
); void (*profile_removed) (CdClient *client
,CdProfile *profile
); void (*sensor_added) (CdClient *client
,CdSensor *sensor
); void (*sensor_changed) (CdClient *client
,CdSensor *sensor
); void (*sensor_removed) (CdClient *client
,CdSensor *sensor
);
A helper GObject to use for accessing colord information, and to be notified when it is changed.
See also: CdDevice
typedef enum { CD_CLIENT_ERROR_FAILED, CD_CLIENT_ERROR_ALREADY_EXISTS, CD_CLIENT_ERROR_FILE_INVALID, CD_CLIENT_ERROR_LAST } CdClientError;
Errors that can be thrown
void cd_client_connect (CdClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Connects to the colord daemon.
|
a CdClient instance |
|
a GCancellable or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.6
gboolean cd_client_connect_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
success |
Since 0.1.6
void cd_client_create_device (CdClient *client
,const gchar *id
,CdObjectScope scope
,GHashTable *properties
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Creates a color device.
|
a CdClient instance. |
|
identifier for the device |
|
the scope of the device |
|
properties to set on the device, or NULL
|
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
CdDevice * cd_client_create_device_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
a CdDevice or NULL . [transfer full]
|
Since 0.1.8
void cd_client_create_profile (CdClient *client
,const gchar *id
,CdObjectScope scope
,GHashTable *properties
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Creates a color profile.
|
a CdClient instance. |
|
identifier for the profile |
|
the scope of the profile |
|
properties to set on the profile, or NULL
|
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
CdProfile * cd_client_create_profile_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
a CdProfile or NULL . [transfer full]
|
Since 0.1.8
void cd_client_delete_device (CdClient *client
,CdDevice *device
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Deletes a device.
|
a CdClient instance. |
|
a CdDevice |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
gboolean cd_client_delete_device_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
success |
Since 0.1.8
void cd_client_delete_profile (CdClient *client
,CdProfile *profile
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Deletes a profile.
|
a CdClient instance. |
|
a CdProfile |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
gboolean cd_client_delete_profile_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
success |
Since 0.1.8
void cd_client_find_device (CdClient *client
,const gchar *id
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Finds a device by an ID.
|
a CdClient instance. |
|
a device id |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
void cd_client_find_device_by_property (CdClient *client
,const gchar *key
,const gchar *value
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Finds a color device that has a property value.
|
a CdClient instance. |
|
the device property key |
|
the device property value |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
CdDevice * cd_client_find_device_by_property_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
a CdDevice or NULL . [transfer full]
|
Since 0.1.8
CdDevice * cd_client_find_device_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
a CdDevice or NULL . [transfer full]
|
Since 0.1.8
void cd_client_find_profile (CdClient *client
,const gchar *id
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Finds a profile by an ID.
|
a CdClient instance. |
|
a profile id |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
void cd_client_find_profile_by_filename (CdClient *client
,const gchar *filename
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Finds a profile by a filename.
|
a CdClient instance. |
|
a profile filename |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
CdProfile * cd_client_find_profile_by_filename_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
a CdProfile or NULL . [transfer full]
|
Since 0.1.8
CdProfile * cd_client_find_profile_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
a CdProfile or NULL . [transfer full]
|
Since 0.1.8
gboolean cd_client_get_connected (CdClient *client
);
Gets if the client has been connected.
|
a CdClient instance. |
Returns : |
TRUE if properties are valid
|
Since 0.1.9
const gchar * cd_client_get_daemon_version (CdClient *client
);
Get colord daemon version.
|
a CdClient instance. |
Returns : |
string containing the daemon version, e.g. "0.1.0" |
Since 0.1.0
void cd_client_get_devices (CdClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Gets an array of color devices.
|
a CdClient instance. |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
void cd_client_get_devices_by_kind (CdClient *client
,CdDeviceKind kind
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Gets an array of color devices.
|
a CdClient instance. |
|
the type of device. |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
GPtrArray * cd_client_get_devices_by_kind_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
the devices. [element-type CdDevice][transfer full CdDevice] |
Since 0.1.8
GPtrArray * cd_client_get_devices_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
the devices. [element-type CdDevice][transfer full CdDevice] |
Since 0.1.8
gboolean cd_client_get_has_server (CdClient *client
);
Gets if the colord server is currently running.
|
a CdClient instance. |
Returns : |
TRUE if the colord process is running
|
Since 0.1.12
void cd_client_get_profiles (CdClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Gets an array of color profiles.
|
a CdClient instance. |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
GPtrArray * cd_client_get_profiles_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
the profiles. [element-type CdProfile][transfer full CdProfile] |
Since 0.1.8
void cd_client_get_sensors (CdClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Gets an array of color sensors.
|
a CdClient instance. |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
GPtrArray * cd_client_get_sensors_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
the sensors. [element-type CdSensor][transfer full CdSensor] |
Since 0.1.8
void cd_client_get_standard_space (CdClient *client
,CdStandardSpace standard_space
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Finds a standard profile space.
|
a CdStandardSpace instance. |
|
a profile id |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.8
CdProfile * cd_client_get_standard_space_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
a CdProfile or NULL . [transfer full]
|
Since 0.1.8
void cd_client_import_profile (CdClient *client
,GFile *file
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Imports a color profile into the users home directory.
If the profile should be accessable for all users, then call
cd_profile_install_system_wide()
on the result.
|
a CdClient instance. |
|
a GFile |
|
a GCancellable, or NULL
|
|
the function to run on completion |
|
the data to pass to callback
|
Since 0.1.12
CdProfile * cd_client_import_profile_finish (CdClient *client
,GAsyncResult *res
,GError **error
);
Gets the result from the asynchronous function.
|
a CdClient instance. |
|
the GAsyncResult |
|
A GError or NULL
|
Returns : |
a CdProfile or NULL . [transfer full]
|
Since 0.1.12
CdClient * cd_client_new (void
);
Creates a new CdClient object.
Returns : |
a new CdClient object. |
Since 0.1.0
void (*profile_changed) (CdClient *client
,CdProfile *profile
);
|
|
|
void (*profile_removed) (CdClient *client
,CdProfile *profile
);
|
|
|