CdProfile: colord Reference Manual

CdProfile

CdProfile — Client object for accessing information about colord profiles

Functions

GQuark	cd_profile_error_quark ()
CdProfile *	cd_profile_new ()
CdProfile *	cd_profile_new_with_object_path ()
void	cd_profile_connect ()
gboolean	cd_profile_connect_finish ()
void	cd_profile_set_property ()
gboolean	cd_profile_set_property_finish ()
void	cd_profile_install_system_wide ()
gboolean	cd_profile_install_system_wide_finish ()
const gchar *	cd_profile_get_id ()
const gchar *	cd_profile_get_filename ()
const gchar *	cd_profile_get_qualifier ()
const gchar *	cd_profile_get_format ()
const gchar *	cd_profile_get_title ()
const gchar *	cd_profile_get_object_path ()
CdProfileKind	cd_profile_get_kind ()
CdColorspace	cd_profile_get_colorspace ()
CdObjectScope	cd_profile_get_scope ()
guint	cd_profile_get_owner ()
gchar **	cd_profile_get_warnings ()
gint64	cd_profile_get_created ()
gint64	cd_profile_get_age ()
gboolean	cd_profile_get_has_vcgt ()
gboolean	cd_profile_get_is_system_wide ()
GHashTable *	cd_profile_get_metadata ()
const gchar *	cd_profile_get_metadata_item ()
void	cd_profile_set_object_path ()
gboolean	cd_profile_get_connected ()
gchar *	cd_profile_to_string ()
gboolean	cd_profile_equal ()
gboolean	cd_profile_has_access ()
CdIcc *	cd_profile_load_icc ()

Properties

gchar *	colorspace	Read
gchar *	connected	Read
gint64	created	Read
gchar *	filename	Read
gchar *	format	Read
gchar *	has-vcgt	Read
gchar *	id	Read
gchar *	is-system-wide	Read
gchar *	kind	Read
gchar *	object-path	Read / Write / Construct
guint	owner	Read
gchar *	qualifier	Read
guint	scope	Read
gchar *	title	Read
GStrv	warnings	Read

Signals

void

changed

Run Last

Types and Values

#define	CD_PROFILE_ERROR
#define	CD_PROFILE_TYPE_ERROR
#define	CD_TYPE_PROFILE
struct	CdProfileClass
	CdProfile

Object Hierarchy

    GObject
    ╰── CdProfile

Description

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

Functions

cd_profile_error_quark ()

GQuark
cd_profile_error_quark (void);

Returns

An error quark.

Since: 0.1.0

cd_profile_new ()

CdProfile *
cd_profile_new (void);

Creates a new CdProfile object.

Returns

a new CdProfile object.

Since: 0.1.0

cd_profile_new_with_object_path ()

CdProfile *
cd_profile_new_with_object_path (const gchar *object_path);

Creates a new CdProfile object with a known object path.

Parameters

object_path

The colord object path.

Returns

a new profile object.

Since: 0.1.8

cd_profile_connect ()

void
cd_profile_connect (CdProfile *profile,
                    GCancellable *cancellable,
                    GAsyncReadyCallback callback,
                    gpointer user_data);

Connects to the object and fills up initial properties.

Parameters

profile	a CdProfile instance.
cancellable	a GCancellable, or `NULL`
callback	the function to run on completion
user_data	the data to pass to `callback`

Since: 0.1.8

cd_profile_connect_finish ()

gboolean
cd_profile_connect_finish (CdProfile *profile,
                           GAsyncResult *res,
                           GError **error);

Gets the result from the asynchronous function.

Parameters

profile	a CdProfile instance.
res	the GAsyncResult
error	A GError or `NULL`

Returns

success

Since: 0.1.8

cd_profile_set_property ()

void
cd_profile_set_property (CdProfile *profile,
                         const gchar *key,
                         const gchar *value,
                         GCancellable *cancellable,
                         GAsyncReadyCallback callback,
                         gpointer user_data);

Deletes a color device.

Parameters

profile	a CdProfile instance.
key	a key name
value	a key value
cancellable	a GCancellable, or `NULL`
callback	the function to run on completion
user_data	the data to pass to `callback`

Since: 0.1.8

cd_profile_set_property_finish ()

gboolean
cd_profile_set_property_finish (CdProfile *profile,
                                GAsyncResult *res,
                                GError **error);

Gets the result from the asynchronous function.

Parameters

profile	a CdProfile instance.
res	the GAsyncResult
error	A GError or `NULL`

Returns

success

Since: 0.1.8

cd_profile_install_system_wide ()

void
cd_profile_install_system_wide (CdProfile *profile,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Sets the profile system wide.

Parameters

profile	a CdProfile instance.
cancellable	a GCancellable, or `NULL`
callback	the function to run on completion
user_data	the data to pass to `callback`

Since: 0.1.8

cd_profile_install_system_wide_finish ()

gboolean
cd_profile_install_system_wide_finish (CdProfile *profile,
                                       GAsyncResult *res,
                                       GError **error);

Gets the result from the asynchronous function.

Parameters

profile	a CdProfile instance.
res	the GAsyncResult
error	A GError or `NULL`

Returns

success

Since: 0.1.8

cd_profile_get_id ()

const gchar *
cd_profile_get_id (CdProfile *profile);

Gets the profile ID.

Parameters

profile

a CdProfile instance.

Returns

A string, or NULL for invalid

Since: 0.1.0

cd_profile_get_filename ()

const gchar *
cd_profile_get_filename (CdProfile *profile);

Gets the profile filename.

Parameters

profile

a CdProfile instance.

Returns

A string, or NULL for invalid

Since: 0.1.0

cd_profile_get_qualifier ()

const gchar *
cd_profile_get_qualifier (CdProfile *profile);

Gets the profile qualifier.

Parameters

profile

a CdProfile instance.

Returns

A string, or NULL for invalid

Since: 0.1.0

cd_profile_get_format ()

const gchar *
cd_profile_get_format (CdProfile *profile);

Gets the profile format.

Parameters

profile

a CdProfile instance.

Returns

A string, or NULL for invalid

Since: 0.1.4

cd_profile_get_title ()

const gchar *
cd_profile_get_title (CdProfile *profile);

Gets the profile title.

Parameters

profile

a CdProfile instance.

Returns

A string, or NULL for invalid

Since: 0.1.0

cd_profile_get_object_path ()

const gchar *
cd_profile_get_object_path (CdProfile *profile);

Gets the object path for the profile.

Parameters

profile

a CdProfile instance.

Returns

the object path, or NULL

Since: 0.1.0

cd_profile_get_kind ()

CdProfileKind
cd_profile_get_kind (CdProfile *profile);

Gets the profile kind.

Parameters

profile

a CdProfile instance.

Returns

A CdProfileKind, e.g. CD_PROFILE_KIND_DISPLAY_DEVICE

Since: 0.1.1

cd_profile_get_colorspace ()

CdColorspace
cd_profile_get_colorspace (CdProfile *profile);

Gets the profile colorspace.

Parameters

profile

a CdProfile instance.

Returns

A CdColorspace, e.g. CD_COLORSPACE_RGB

Since: 0.1.2

cd_profile_get_scope ()

CdObjectScope
cd_profile_get_scope (CdProfile *profile);

Gets the profile scope.

Parameters

profile

a CdProfile instance.

Returns

A CdObjectScope, e.g. CD_OBJECT_SCOPE_UNKNOWN

Since: 0.1.10

cd_profile_get_owner ()

guint
cd_profile_get_owner (CdProfile *profile);

Gets the profile owner.

Parameters

profile

a CdProfile instance.

Returns

The UID of the user that created the device

Since: 0.1.13

cd_profile_get_warnings ()

gchar **
cd_profile_get_warnings (CdProfile *profile);

Gets the profile warnings as a string array.

Parameters

profile

a CdProfile instance.

Returns

Any profile warnings, e.g. "vcgt-non-monotonic".

[transfer none]

Since: 0.1.25

cd_profile_get_created ()

gint64
cd_profile_get_created (CdProfile *profile);

Gets the profile created date and time.

Parameters

profile

a CdProfile instance.

Returns

A UNIX time, or 0 if the profile has no creation date

Since: 0.1.8

cd_profile_get_age ()

gint64
cd_profile_get_age (CdProfile *profile);

Gets the profile age in seconds relative to the current time.

Parameters

profile

a CdProfile instance.

Returns

A UNIX time, or 0 if the profile has no creation date

Since: 0.1.8

cd_profile_get_has_vcgt ()

gboolean
cd_profile_get_has_vcgt (CdProfile *profile);

Returns if the profile has a VCGT table.

Parameters

profile

a CdProfile instance.

Returns

TRUE if VCGT is valid.

Since: 0.1.2

cd_profile_get_is_system_wide ()

gboolean
cd_profile_get_is_system_wide (CdProfile *profile);

Returns if the profile is installed system wide and available for all users.

Parameters

profile

a CdProfile instance.

Returns

TRUE if system wide.

Since: 0.1.2

cd_profile_get_metadata ()

GHashTable *
cd_profile_get_metadata (CdProfile *profile);

Returns the profile metadata.

Parameters

profile

a CdProfile instance.

Returns

a GHashTable.

[transfer container][element-type utf8 utf8]

Since: 0.1.2

cd_profile_get_metadata_item ()

const gchar *
cd_profile_get_metadata_item (CdProfile *profile,
                              const gchar *key);

Returns the profile metadata for a specific key.

Parameters

profile	a CdProfile instance.
key	a key for the metadata dictionary

Returns

the metadata value, or NULL if not set.

Since: 0.1.5

cd_profile_set_object_path ()

void
cd_profile_set_object_path (CdProfile *profile,
                            const gchar *object_path);

Sets the object path of the profile.

Parameters

profile	a CdProfile instance.
object_path	The colord object path.

Since: 0.1.8

cd_profile_get_connected ()

gboolean
cd_profile_get_connected (CdProfile *profile);

Gets if the profile has been connected.

Parameters

profile

a CdProfile instance.

Returns

TRUE if properties are valid

Since: 0.1.9

cd_profile_to_string ()

gchar *
cd_profile_to_string (CdProfile *profile);

Converts the profile to a string description.

Parameters

profile

a CdProfile instance.

Returns

text representation of CdProfile

Since: 0.1.0

cd_profile_equal ()

gboolean
cd_profile_equal (CdProfile *profile1,
                  CdProfile *profile2);

Tests two profiles for equality.

Parameters

profile1	one CdProfile instance.
profile2	another CdProfile instance.

Returns

TRUE if the profiles are the same device

Since: 0.1.8

cd_profile_has_access ()

gboolean
cd_profile_has_access (CdProfile *profile);

Gets if the current user has access permissions to the profile.

Parameters

profile

a CdProfile instance.

Returns

A string, or NULL for invalid

Since: 0.1.13

cd_profile_load_icc ()

CdIcc *
cd_profile_load_icc (CdProfile *profile,
                     CdIccLoadFlags flags,
                     GCancellable *cancellable,
                     GError **error);

Loads a local ICC object from the abstract profile.

Parameters

profile	a CdProfile instance.
flags	options for loading the profile
cancellable	A GCancellable, or `NULL`
error	A GError or `NULL`

Returns

A new CdIcc object, or NULL for error.

[transfer full]

Since: 0.1.32

Types and Values

CD_PROFILE_ERROR

#define CD_PROFILE_ERROR (cd_profile_error_quark ())

CD_PROFILE_TYPE_ERROR

#define CD_PROFILE_TYPE_ERROR (cd_profile_error_get_type ())

CD_TYPE_PROFILE

#define CD_TYPE_PROFILE (cd_profile_get_type ())

struct CdProfileClass

struct CdProfileClass {
	GObjectClass		 parent_class;
	void			(*changed)		(CdProfile		*profile);
};

CdProfile

typedef struct _CdProfile CdProfile;

Property Details

The `“colorspace”` property

  “colorspace”               gchar *

The profile colorspace.

Flags: Read

Default value: NULL

Since: 0.1.2

The `“connected”` property

  “connected”                gchar *

The if the object path has been connected as is valid for use.

Flags: Read

Default value: NULL

Since: 0.1.9

The `“created”` property

  “created”                  gint64

When the profile was created.

Flags: Read

Allowed values: >= 0

Default value: 0

Since: 0.1.8

The `“filename”` property

  “filename”                 gchar *

The profile filename.

Flags: Read

Default value: NULL

Since: 0.1.0

The `“format”` property

  “format”                   gchar *

The profile format.

Flags: Read

Default value: NULL

Since: 0.1.4

The `“has-vcgt”` property

  “has-vcgt”                 gchar *

If the profile has a VCGT table.

Flags: Read

Default value: NULL

Since: 0.1.2

The `“id”` property

  “id”                       gchar *

The profile ID.

Flags: Read

Default value: NULL

Since: 0.1.0

The `“is-system-wide”` property

  “is-system-wide”           gchar *

If the profile is installed system wide for all users.

Flags: Read

Default value: NULL

Since: 0.1.2

The `“kind”` property

  “kind”                     gchar *

The profile kind.

Flags: Read

Default value: NULL

Since: 0.1.1

The `“object-path”` property

  “object-path”              gchar *

The object path of the remote object

Flags: Read / Write / Construct

Default value: NULL

Since: 0.1.8

The `“owner”` property

  “owner”                    guint

The profile owner, e.g. 500.

Flags: Read

Default value: 0

Since: 0.1.13

The `“qualifier”` property

  “qualifier”                gchar *

The profile qualifier.

Flags: Read

Default value: NULL

Since: 0.1.0

The `“scope”` property

  “scope”                    guint

The profile scope, e.g. CD_OBJECT_SCOPE_TEMP.

Flags: Read

Default value: 0

Since: 0.1.10

The `“title”` property

  “title”                    gchar *

The profile title.

Flags: Read

Default value: NULL

Since: 0.1.0

The `“warnings”` property

  “warnings”                 GStrv

The profile warnings, e.g. "vcgt-non-monotonic".

Flags: Read

Since: 0.1.25

Signal Details

The `“changed”` signal

void
user_function (CdProfile *profile,
               gpointer   user_data)

The ::changed signal is emitted when the profile data has changed.

Parameters

profile	the CdProfile instance that emitted the signal
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 0.1.0