Gimp.ConfigInterface¶

Implementations:: Gimp.ColorConfig, Gimp.Resource

Methods¶

class	`build_data_path` (name)
class	`build_plug_in_path` (name)
class	`build_system_path` (name)
class	`build_writable_path` (name)
class	`deserialize_return` (scanner, expected_token, nest_level)
class	`diff` (a, b, flags)
class	`error_quark` ()
class	`param_spec_duplicate` (pspec)
class	`reset_properties` (object)
class	`reset_property` (object, property_name)
class	`serialize_value` (value, str, escaped)
class	`string_append_escaped` (string, val)
class	`sync` (src, dest, flags)
class	`type_register` (parent_type, type_name, pspecs)

Virtual Methods¶

None

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class Gimp.ConfigInterface¶

Bases:: GObject.GInterface

classmethod build_data_path(name)¶

Parameters:: name (str) – directory name (in UTF-8 encoding)
Returns:: a newly allocated string
Return type:: str

Creates a search path as it is used in the gimprc file. The path returned by Gimp.ConfigInterface.build_data_path() includes a directory below the user’s gimp directory and one in the system-wide data directory.

Note that you cannot use this path directly with Gimp.Path.parse(). As it is in the gimprc notation, you first need to expand and recode it using Gimp.ConfigPath.expand().

New in version 2.4.

classmethod build_plug_in_path(name)¶

Parameters:: name (str) – directory name (in UTF-8 encoding)
Returns:: a newly allocated string
Return type:: str

Creates a search path as it is used in the gimprc file. The path returned by Gimp.ConfigInterface.build_plug_in_path() includes a directory below the user’s gimp directory and one in the system-wide plug-in directory.

Note that you cannot use this path directly with Gimp.Path.parse(). As it is in the gimprc notation, you first need to expand and recode it using Gimp.ConfigPath.expand().

New in version 2.4.

classmethod build_system_path(name)¶

Parameters:: name (str) – directory name (in UTF-8 encoding)
Returns:: a newly allocated string
Return type:: str

Creates a search path as it is used in the gimprc file. The path returned by Gimp.ConfigInterface.build_system_path() is just the read-only parts of the search path constructed by Gimp.ConfigInterface.build_plug_in_path().

Note that you cannot use this path directly with Gimp.Path.parse(). As it is in the gimprc notation, you first need to expand and recode it using Gimp.ConfigPath.expand().

New in version 2.10.6.

classmethod build_writable_path(name)¶

Parameters:: name (str) – directory name (in UTF-8 encoding)
Returns:: a newly allocated string
Return type:: str

Creates a search path as it is used in the gimprc file. The path returned by Gimp.ConfigInterface.build_writable_path() is just the writable parts of the search path constructed by Gimp.ConfigInterface.build_data_path().

Note that you cannot use this path directly with Gimp.Path.parse(). As it is in the gimprc notation, you first need to expand and recode it using Gimp.ConfigPath.expand().

New in version 2.4.

classmethod deserialize_return(scanner, expected_token, nest_level)¶

Parameters:

scanner (GLib.Scanner) – a GLib.Scanner
expected_token (GLib.TokenType) – the expected token
nest_level (int) – the nest level

Return type:

bool

New in version 2.4.

classmethod diff(a, b, flags)¶

Parameters:

a (GObject.Object) – a GObject.Object
b (GObject.Object) – another GObject.Object object
flags (GObject.ParamFlags) – a mask of GObject.ParamFlags

Returns:

a GLib.List of differing GParamSpecs.

Return type:

[GObject.ParamSpec]

Compares all properties of a and b that have all flags set. If flags is 0, all properties are compared.

If the two objects are not of the same type, only properties that exist in both object classes and are of the same value_type are compared.

New in version 2.4.

classmethod error_quark()¶

Returns:: the #GQuark that defines the Gimp.Config error domain.
Return type:: int

This function is never called directly. Use GIMP_CONFIG_ERROR() instead.

New in version 2.4.

classmethod param_spec_duplicate(pspec)¶

Parameters:: pspec (GObject.ParamSpec) – the GObject.ParamSpec to duplicate
Returns:: The new GObject.ParamSpec, or None.
Return type:: GObject.ParamSpec

Creates an exact copy of pspec, with all its properties, returns None if pspec is of an unknown type that can’t be duplicated.

New in version 3.0.

classmethod reset_properties(object)¶

Parameters:: object (GObject.Object) – a GObject.Object

Resets all writable properties of object to the default values as defined in their GObject.ParamSpec. Properties marked as “construct-only” are not touched.

If you want to reset a Gimp.Config object, please use Gimp.Config.reset().

New in version 2.4.

classmethod reset_property(object, property_name)¶

Parameters:

object (GObject.Object) – a GObject.Object
property_name (str) – name of the property to reset

Resets the property named property_name to its default value. The property must be writable and must not be marked as “construct-only”.

New in version 2.4.

classmethod serialize_value(value, str, escaped)¶

Parameters:

value (GObject.Value) – a GObject.Value.
str (GLib.String) – a GLib.String.
escaped (bool) – whether to escape string values.

Returns:

True if serialization succeeded, False otherwise.

Return type:

bool

This utility function appends a string representation of GObject.Value to str.

New in version 2.4.

classmethod string_append_escaped(string, val)¶

Parameters:

string (GLib.String) – pointer to a GLib.String
val (str) – a string to append or None

Escapes and quotes val and appends it to string. The escape algorithm is different from the one used by GLib.strescape() since it leaves non-ASCII characters intact and thus preserves UTF-8 strings. Only control characters and quotes are being escaped.

New in version 2.4.

classmethod sync(src, dest, flags)¶

Parameters:

src (GObject.Object) – a GObject.Object
dest (GObject.Object) – another GObject.Object
flags (GObject.ParamFlags) – a mask of GObject.ParamFlags

Returns:

True if dest was modified, False otherwise

Return type:

bool

Compares all read- and write-able properties from src and dest that have all flags set. Differing values are then copied from src to dest. If flags is 0, all differing read/write properties.

Properties marked as “construct-only” are not touched.

If the two objects are not of the same type, only properties that exist in both object classes and are of the same value_type are synchronized

New in version 2.4.

classmethod type_register(parent_type, type_name, pspecs)¶

Parameters:

parent_type (GObject.GType) – type from which this type will be derived
type_name (str) – string used as the name of the new type
pspecs ([GObject.ParamSpec]) – array of GObject.ParamSpec to install as properties on the new type

Returns:

the newly registered GObject.GType

Return type:

GObject.GType

This function is a fancy wrapper around GObject.type_register_static(). It creates a new object type as subclass of parent_type, installs pspecs on it and makes the new type implement the Gimp.Config interface.

New in version 3.0.