Class: Gegl::MetadataStore

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Overview

The class structure for the Gegl::MetadataStore

Direct Known Subclasses

MetadataHash

Instance Method Summary collapse

Instance Method Details

#artist ⇒ String

Name of image creator.

Returns:

  • (String) —

    artist

#artist=(artist) ⇒ String

Name of image creator.

Parameters:

  • artist (String)

Returns:

  • (String) —

    artist

  • (String) —

    artist

#comment ⇒ String

Miscellaneous comment; conversion from GIF comment.

Returns:

  • (String) —

    comment

#comment=(comment) ⇒ String

Miscellaneous comment; conversion from GIF comment.

Parameters:

  • comment (String)

Returns:

  • (String) —

    comment

  • (String) —

    comment

#copyright ⇒ String

Copyright notice.

Returns:

  • (String) —

    copyright

#copyright=(copyright) ⇒ String

Copyright notice.

Parameters:

  • copyright (String)

Returns:

  • (String) —

    copyright

  • (String) —

    copyright

#declare(pspec) ⇒ nil

Declare a metadata value using a GParam::Spec.

Parameters:

  • pspec (GObject::ParamSpec) —

    A GParam::Spec

Returns:

  • (nil)

#description ⇒ String

Description of image (possibly long).

Returns:

  • (String) —

    description

#description=(description) ⇒ String

Description of image (possibly long).

Parameters:

  • description (String)

Returns:

  • (String) —

    description

  • (String) —

    description

#disclaimer ⇒ String

Legal disclaimer.

Returns:

  • (String) —

    disclaimer

#disclaimer=(disclaimer) ⇒ String

Legal disclaimer.

Parameters:

  • disclaimer (String)

Returns:

  • (String) —

    disclaimer

  • (String) —

    disclaimer

#file_module_name ⇒ String

Current file loader/saver module name. Valid only while a Gegl::Metadata mapping is registered. This property is mainly provided for use in signal handlers.

Returns:

  • (String) —

    file-module-name

#file_module_name=(file_module_name) ⇒ String

Current file loader/saver module name. Valid only while a Gegl::Metadata mapping is registered. This property is mainly provided for use in signal handlers.

Parameters:

  • file_module_name (String)

Returns:

  • (String) —

    file-module-name

  • (String) —

    file-module-name

#get_string(name) ⇒ String

A slightly more efficient version of gegl_metadata_store_get_value() for string values avoiding a duplication. Otherwise it behaves the same gegl_metadata_store_get_value().

Parameters:

  • name (String) —

    Metadata name

Returns:

  • (String) —

    String or nil.

#get_value(name, value) ⇒ nil

Retrieve the metadata value. value must be initialised with a compatible type. If the value is unset or has not been previously declared value is unchanged and an error message is logged.

Parameters:

  • name (String) —

    Metadata name

  • value (GObject::Value) —

    An initialised #GValue.

Returns:

  • (nil)

#has_value(name) ⇒ Boolean

Test whether the Gegl::MetadataStore contains a value for the specified name.

Parameters:

  • name (String) —

    Metadata name

Returns:

  • (Boolean) —

    true if metadata is declared and contains a valid value.

#notify(pspec, shadow) ⇒ nil

gegl_metadata_store_notify() is called by subclasses when the value of a metadata variable changes. It emits the ::changed signal with the variable name as the detail parameter. Set shadow = true if variable is shadowed by a property so that a notify signal is emitted with the property name as the detail parameter.

Parameters:

  • pspec (GObject::ParamSpec) —

    The GParam::Spec used to declare the variable.

  • shadow (Boolean) —

    The metadata variable shadows a property.

Returns:

  • (nil)

#register(local_name, name, transform) ⇒ nil

Parameters:

  • local_name (String) —

    Metadata name known to file module

  • name (String) —

    Metadata name

  • transform (GObject::ValueTransform) —

    A GValue::Transform function or nil

Returns:

  • (nil)

#resolution_unit ⇒ Gegl::ResolutionUnit

A Gegl::ResolutionUnit specifying units for the image resolution (density).

Returns:

#resolution_unit=(resolution_unit) ⇒ Gegl::ResolutionUnit

A Gegl::ResolutionUnit specifying units for the image resolution (density).

Parameters:

Returns:

#resolution_x ⇒ Float

X resolution or density in dots per unit.

Returns:

  • (Float) —

    resolution-x

#resolution_x=(resolution_x) ⇒ Float

X resolution or density in dots per unit.

Parameters:

  • resolution_x (Float)

Returns:

  • (Float) —

    resolution-x

  • (Float) —

    resolution-x

#resolution_y ⇒ Float

Y resolution or density in dots per unit.

Returns:

  • (Float) —

    resolution-y

#resolution_y=(resolution_y) ⇒ Float

Y resolution or density in dots per unit.

Parameters:

  • resolution_y (Float)

Returns:

  • (Float) —

    resolution-y

  • (Float) —

    resolution-y

#set_string(name, string) ⇒ nil

A slightly more efficient version of gegl_metadata_store_set_value() for string values avoiding a duplication. Otherwise it behaves the same gegl_metadata_store_set_value().

Parameters:

  • name (String) —

    Metadata name

  • string (String) —

    String value to set

Returns:

  • (nil)

#set_value(name, value) ⇒ nil

Set the specified metadata value. If value is nil the default value from the associated GParam::Spec is used. This operation will fail if the value has not been previously declared. A changed::name signal is emitted when the value is set. If the value is shadowed by a property a notify::name signal is also emitted.

Parameters:

  • name (String) —

    Metadata name

  • value (GObject::Value) —

    (nullable): A valid #GValue or nil

Returns:

  • (nil)

#software ⇒ String

Software used to create the image.

Returns:

  • (String) —

    software

#software=(software) ⇒ String

Software used to create the image.

Parameters:

  • software (String)

Returns:

  • (String) —

    software

  • (String) —

    software

#source ⇒ String

Device used to create the image.

Returns:

  • (String) —

    source

#source=(source) ⇒ String

Device used to create the image.

Parameters:

  • source (String)

Returns:

  • (String) —

    source

  • (String) —

    source

#timestamp ⇒ GLib::DateTime

Time of original image creation.

Returns:

  • (GLib::DateTime) —

    timestamp

#timestamp=(timestamp) ⇒ GLib::DateTime

Time of original image creation.

Parameters:

  • timestamp (GLib::DateTime)

Returns:

  • (GLib::DateTime) —

    timestamp

  • (GLib::DateTime) —

    timestamp

#title ⇒ String

Short (one line) title or caption for image.

Returns:

  • (String) —

    title

#title=(title) ⇒ String

Short (one line) title or caption for image.

Parameters:

  • title (String)

Returns:

  • (String) —

    title

  • (String) —

    title

#typeof_value(name) ⇒ GLib::Type

Get the declared type of the value in the Gegl::MetadataStore.

Parameters:

  • name (String) —

    Metadata name

Returns:

  • (GLib::Type) —

    Declared #GType of metadata value or %G_TYPE_INVALID.

#warning ⇒ String

Warning of nature of content.

Returns:

  • (String) —

    warning

#warning=(warning) ⇒ String

Warning of nature of content.

Parameters:

  • warning (String)

Returns:

  • (String) —

    warning

  • (String) —

    warning