gimpparamspecs

gimpparamspecs

Functions

GimpArray * gimp_array_new ()
GimpArray * gimp_array_copy ()
void gimp_array_free ()
GParamSpec * gimp_param_spec_array ()
GParamSpec * gimp_param_spec_uint8_array ()
const guint8 * gimp_value_get_uint8_array ()
guint8 * gimp_value_dup_uint8_array ()
void gimp_value_set_uint8_array ()
void gimp_value_set_static_uint8_array ()
void gimp_value_take_uint8_array ()
GParamSpec * gimp_param_spec_int32_array ()
const gint32 * gimp_value_get_int32_array ()
gint32 * gimp_value_dup_int32_array ()
void gimp_value_set_int32_array ()
void gimp_value_set_static_int32_array ()
void gimp_value_take_int32_array ()
GParamSpec * gimp_param_spec_float_array ()
const gdouble * gimp_value_get_float_array ()
gdouble * gimp_value_dup_float_array ()
void gimp_value_set_float_array ()
void gimp_value_set_static_float_array ()
void gimp_value_take_float_array ()
GimpStringArray * gimp_string_array_new ()
GimpStringArray * gimp_string_array_copy ()
void gimp_string_array_free ()
GParamSpec * gimp_param_spec_string_array ()
const gchar ** gimp_value_get_string_array ()
gchar ** gimp_value_dup_string_array ()
void gimp_value_set_string_array ()
void gimp_value_set_static_string_array ()
void gimp_value_take_string_array ()
GParamSpec * gimp_param_spec_rgb_array ()
const GimpRGB * gimp_value_get_rgb_array ()
GimpRGB * gimp_value_dup_rgb_array ()
void gimp_value_set_rgb_array ()
void gimp_value_set_static_rgb_array ()
void gimp_value_take_rgb_array ()
GimpObjectArray * gimp_object_array_new ()
GimpObjectArray * gimp_object_array_copy ()
void gimp_object_array_free ()
GParamSpec * gimp_param_spec_object_array ()
GObject ** gimp_value_get_object_array ()
GObject ** gimp_value_dup_object_array ()
void gimp_value_set_object_array ()
void gimp_value_set_static_object_array ()
void gimp_value_take_object_array ()

Types and Values

Object Hierarchy

    GBoxed
    ├── GimpArray
    ╰── GimpStringArray

Description

Functions

gimp_array_new ()

GimpArray *
gimp_array_new (const guint8 *data,
                gsize length,
                gboolean static_data);

Parameters

data

.

[array length=length]

gimp_array_copy ()

GimpArray *
gimp_array_copy (const GimpArray *array);

gimp_array_free ()

void
gimp_array_free (GimpArray *array);

gimp_param_spec_array ()

GParamSpec *
gimp_param_spec_array (const gchar *name,
                       const gchar *nick,
                       const gchar *blurb,
                       GParamFlags flags);

Creates a new GimpParamSpecArray specifying a GIMP_TYPE_ARRAY property.

See g_param_spec_internal() for details on property names.

Parameters

name

Canonical name of the property specified.

 

nick

Nick name of the property specified.

 

blurb

Description of the property specified.

 

flags

Flags for the property specified.

 

Returns

The newly created GimpParamSpecArray.

[transfer full]

Since: 3.0


gimp_param_spec_uint8_array ()

GParamSpec *
gimp_param_spec_uint8_array (const gchar *name,
                             const gchar *nick,
                             const gchar *blurb,
                             GParamFlags flags);

Creates a new GimpParamSpecUInt8Array specifying a GIMP_TYPE_UINT8_ARRAY property.

See g_param_spec_internal() for details on property names.

Parameters

name

Canonical name of the property specified.

 

nick

Nick name of the property specified.

 

blurb

Description of the property specified.

 

flags

Flags for the property specified.

 

Returns

The newly created GimpParamSpecUInt8Array.

[transfer full]

Since: 3.0


gimp_value_get_uint8_array ()

const guint8 *
gimp_value_get_uint8_array (const GValue *value);

Gets the contents of a GIMP_TYPE_UINT8_ARRAY GValue

Parameters

value

A valid value of type GIMP_TYPE_UINT8_ARRAY

 

Returns

The contents of value .

[transfer none][array]


gimp_value_dup_uint8_array ()

guint8 *
gimp_value_dup_uint8_array (const GValue *value);

Gets the contents of a GIMP_TYPE_UINT8_ARRAY GValue

Parameters

value

A valid value of type GIMP_TYPE_UINT8_ARRAY

 

Returns

The contents of value .

[transfer full][array]


gimp_value_set_uint8_array ()

void
gimp_value_set_uint8_array (GValue *value,
                            const guint8 *data,
                            gsize length);

Sets the contents of value to data .

Parameters

value

A valid value of type GIMP_TYPE_UINT8_ARRAY

 

data

A guint8 array.

[array length=length]

length

The number of elements in data

 

gimp_value_set_static_uint8_array ()

void
gimp_value_set_static_uint8_array (GValue *value,
                                   const guint8 *data,
                                   gsize length);

Sets the contents of value to data , without copying the data.

Parameters

value

A valid value of type GIMP_TYPE_UINT8_ARRAY

 

data

A guint8 array.

[array length=length]

length

The number of elements in data

 

gimp_value_take_uint8_array ()

void
gimp_value_take_uint8_array (GValue *value,
                             guint8 *data,
                             gsize length);

Sets the contents of value to data , and takes ownership of data .

Parameters

value

A valid value of type GIMP_TYPE_UINT8_ARRAY

 

data

A guint8 array.

[transfer full][array length=length]

length

The number of elements in data

 

gimp_param_spec_int32_array ()

GParamSpec *
gimp_param_spec_int32_array (const gchar *name,
                             const gchar *nick,
                             const gchar *blurb,
                             GParamFlags flags);

Creates a new GimpParamSpecInt32Array specifying a GIMP_TYPE_INT32_ARRAY property.

See g_param_spec_internal() for details on property names.

Parameters

name

Canonical name of the property specified.

 

nick

Nick name of the property specified.

 

blurb

Description of the property specified.

 

flags

Flags for the property specified.

 

Returns

The newly created GimpParamSpecInt32Array.

[transfer full]

Since: 3.0


gimp_value_get_int32_array ()

const gint32 *
gimp_value_get_int32_array (const GValue *value);

Gets the contents of a GIMP_TYPE_INT32_ARRAY GValue

Parameters

value

A valid value of type GIMP_TYPE_INT32_ARRAY

 

Returns

The contents of value .

[transfer none][array]


gimp_value_dup_int32_array ()

gint32 *
gimp_value_dup_int32_array (const GValue *value);

Gets the contents of a GIMP_TYPE_INT32_ARRAY GValue

Parameters

value

A valid value of type GIMP_TYPE_INT32_ARRAY

 

Returns

The contents of value .

[transfer full][array]


gimp_value_set_int32_array ()

void
gimp_value_set_int32_array (GValue *value,
                            const gint32 *data,
                            gsize length);

Sets the contents of value to data .

Parameters

value

A valid value of type GIMP_TYPE_INT32_ARRAY

 

data

A gint32 array.

[array length=length]

length

The number of elements in data

 

gimp_value_set_static_int32_array ()

void
gimp_value_set_static_int32_array (GValue *value,
                                   const gint32 *data,
                                   gsize length);

Sets the contents of value to data , without copying the data.

Parameters

value

A valid value of type GIMP_TYPE_INT32_ARRAY

 

data

A gint32 array.

[array length=length]

length

The number of elements in data

 

gimp_value_take_int32_array ()

void
gimp_value_take_int32_array (GValue *value,
                             gint32 *data,
                             gsize length);

Sets the contents of value to data , and takes ownership of data .

Parameters

value

A valid value of type GIMP_TYPE_int32_ARRAY

 

data

A gint32 array.

[transfer full][array length=length]

length

The number of elements in data

 

gimp_param_spec_float_array ()

GParamSpec *
gimp_param_spec_float_array (const gchar *name,
                             const gchar *nick,
                             const gchar *blurb,
                             GParamFlags flags);

Creates a new GimpParamSpecFloatArray specifying a GIMP_TYPE_FLOAT_ARRAY property.

See g_param_spec_internal() for details on property names.

Parameters

name

Canonical name of the property specified.

 

nick

Nick name of the property specified.

 

blurb

Description of the property specified.

 

flags

Flags for the property specified.

 

Returns

The newly created GimpParamSpecFloatArray.

[transfer full]

Since: 3.0


gimp_value_get_float_array ()

const gdouble *
gimp_value_get_float_array (const GValue *value);

Gets the contents of a GIMP_TYPE_FLOAT_ARRAY GValue

Parameters

value

A valid value of type GIMP_TYPE_FLOAT_ARRAY

 

Returns

The contents of value .

[transfer none][array]


gimp_value_dup_float_array ()

gdouble *
gimp_value_dup_float_array (const GValue *value);

Gets the contents of a GIMP_TYPE_FLOAT_ARRAY GValue

Parameters

value

A valid value of type GIMP_TYPE_FLOAT_ARRAY

 

Returns

The contents of value .

[transfer full][array]


gimp_value_set_float_array ()

void
gimp_value_set_float_array (GValue *value,
                            const gdouble *data,
                            gsize length);

Sets the contents of value to data .

Parameters

value

A valid value of type GIMP_TYPE_FLOAT_ARRAY

 

data

A gfloat array.

[array length=length]

length

The number of elements in data

 

gimp_value_set_static_float_array ()

void
gimp_value_set_static_float_array (GValue *value,
                                   const gdouble *data,
                                   gsize length);

Sets the contents of value to data , without copying the data.

Parameters

value

A valid value of type GIMP_TYPE_FLOAT_ARRAY

 

data

A gfloat array.

[array length=length]

length

The number of elements in data

 

gimp_value_take_float_array ()

void
gimp_value_take_float_array (GValue *value,
                             gdouble *data,
                             gsize length);

Sets the contents of value to data , and takes ownership of data .

Parameters

value

A valid value of type GIMP_TYPE_FLOAT_ARRAY

 

data

A gfloat array.

[transfer full][array length=length]

length

The number of elements in data

 

gimp_string_array_new ()

GimpStringArray *
gimp_string_array_new (const gchar **data,
                       gsize length,
                       gboolean static_data);

Creates a new GimpStringArray containing string data, of size length .

If static_data is TRUE, data is used as-is.

If static_data is FALSE, the string and array will be re-allocated, hence you are expected to free your input data after.

Parameters

data

an array of strings.

[array length=length][transfer none]

length

the length of data .

 

static_data

whether the strings in data are static strings rather than allocated.

 

Returns

a new GimpStringArray.

[transfer full]


gimp_string_array_copy ()

GimpStringArray *
gimp_string_array_copy (const GimpStringArray *array);

Creates a new GimpStringArray containing a deep copy of array .

Parameters

array

an original GimpStringArray of strings.

 

Returns

a new GimpStringArray.

[transfer full]


gimp_string_array_free ()

void
gimp_string_array_free (GimpStringArray *array);

gimp_param_spec_string_array ()

GParamSpec *
gimp_param_spec_string_array (const gchar *name,
                              const gchar *nick,
                              const gchar *blurb,
                              GParamFlags flags);

Creates a new GimpParamSpecStringArray specifying a GIMP_TYPE_STRING_ARRAY property.

See g_param_spec_internal() for details on property names.

Parameters

name

Canonical name of the property specified.

 

nick

Nick name of the property specified.

 

blurb

Description of the property specified.

 

flags

Flags for the property specified.

 

Returns

The newly created GimpParamSpecStringArray.

[transfer full]

Since: 3.0


gimp_value_get_string_array ()

const gchar **
gimp_value_get_string_array (const GValue *value);

Parameters

value

a GValue holding a string GimpStringArray.

 

Returns

the internal array of strings.

[transfer none][array zero-terminated=1]


gimp_value_dup_string_array ()

gchar **
gimp_value_dup_string_array (const GValue *value);

Parameters

value

a GValue holding a string GimpStringArray.

 

Returns

a deep copy of the array of strings.

[transfer full][array zero-terminated=1]


gimp_value_set_string_array ()

void
gimp_value_set_string_array (GValue *value,
                             const gchar **data,
                             gsize length);

Sets the contents of value to data .

Parameters

value

A valid value of type GIMP_TYPE_STRING_ARRAY

 

data

A string array.

[array length=length]

length

The number of elements in data

 

gimp_value_set_static_string_array ()

void
gimp_value_set_static_string_array (GValue *value,
                                    const gchar **data,
                                    gsize length);

Sets the contents of value to data , without copying the data.

Parameters

value

A valid value of type GIMP_TYPE_STRING_ARRAY

 

data

A string array.

[array length=length]

length

The number of elements in data

 

gimp_value_take_string_array ()

void
gimp_value_take_string_array (GValue *value,
                              gchar **data,
                              gsize length);

Sets the contents of value to data , and takes ownership of data .

Parameters

value

A valid value of type GIMP_TYPE_STRING_ARRAY

 

data

A string array.

[transfer full][array length=length]

length

The number of elements in data

 

gimp_param_spec_rgb_array ()

GParamSpec *
gimp_param_spec_rgb_array (const gchar *name,
                           const gchar *nick,
                           const gchar *blurb,
                           GParamFlags flags);

Creates a new GimpParamSpecRGBArray specifying a GIMP_TYPE_RGB_ARRAY property.

See g_param_spec_internal() for details on property names.

Parameters

name

Canonical name of the property specified.

 

nick

Nick name of the property specified.

 

blurb

Description of the property specified.

 

flags

Flags for the property specified.

 

Returns

The newly created GimpParamSpecRGBArray.

[transfer full]

Since: 3.0


gimp_value_get_rgb_array ()

const GimpRGB *
gimp_value_get_rgb_array (const GValue *value);

Gets the contents of a GIMP_TYPE_RGB_ARRAY GValue

Parameters

value

A valid value of type GIMP_TYPE_RGB_ARRAY

 

Returns

The contents of value .

[transfer none][array]


gimp_value_dup_rgb_array ()

GimpRGB *
gimp_value_dup_rgb_array (const GValue *value);

Gets the contents of a GIMP_TYPE_RGB_ARRAY GValue

Parameters

value

A valid value of type GIMP_TYPE_RGB_ARRAY

 

Returns

The contents of value .

[transfer full][array]


gimp_value_set_rgb_array ()

void
gimp_value_set_rgb_array (GValue *value,
                          const GimpRGB *data,
                          gsize length);

Sets the contents of value to data .

Parameters

value

A valid value of type GIMP_TYPE_RGB_ARRAY

 

data

A GimpRGB array.

[array length=length]

length

The number of elements in data

 

gimp_value_set_static_rgb_array ()

void
gimp_value_set_static_rgb_array (GValue *value,
                                 const GimpRGB *data,
                                 gsize length);

Sets the contents of value to data , without copying the data.

Parameters

value

A valid value of type GIMP_TYPE_RGB_ARRAY

 

data

A GimpRGB array.

[array length=length]

length

The number of elements in data

 

gimp_value_take_rgb_array ()

void
gimp_value_take_rgb_array (GValue *value,
                           GimpRGB *data,
                           gsize length);

Sets the contents of value to data , and takes ownership of data .

Parameters

value

A valid value of type GIMP_TYPE_RGB_ARRAY

 

data

A GimpRGB array.

[transfer full][array length=length]

length

The number of elements in data

 

gimp_object_array_new ()

GimpObjectArray *
gimp_object_array_new (GType object_type,
                       GObject **data,
                       gsize length,
                       gboolean static_data);

Creates a new GimpObjectArray containing object pointers, of size length .

If static_data is TRUE, data is used as-is.

If static_data is FALSE, the object and array will be re-allocated, hence you are expected to free your input data after.

Parameters

data

an array of objects.

[array length=length][transfer none]

object_type

the array will hold objects of this type

 

length

the length of data .

 

static_data

whether the objects in data are static objects and don't need to be copied.

 

Returns

a new GimpObjectArray.

[transfer full]


gimp_object_array_copy ()

GimpObjectArray *
gimp_object_array_copy (const GimpObjectArray *array);

Creates a new GimpObjectArray containing a deep copy of array .

Parameters

array

an original GimpObjectArray of objects.

 

Returns

a new GimpObjectArray.

[transfer full]


gimp_object_array_free ()

void
gimp_object_array_free (GimpObjectArray *array);

gimp_param_spec_object_array ()

GParamSpec *
gimp_param_spec_object_array (const gchar *name,
                              const gchar *nick,
                              const gchar *blurb,
                              GType object_type,
                              GParamFlags flags);

Creates a new GimpParamSpecObjectArray specifying a GIMP_TYPE_OBJECT_ARRAY property.

See g_param_spec_internal() for details on property names.

Parameters

name

Canonical name of the property specified.

 

nick

Nick name of the property specified.

 

blurb

Description of the property specified.

 

object_type

GType of the array's elements.

 

flags

Flags for the property specified.

 

Returns

The newly created GimpParamSpecObjectArray.

[transfer full]

Since: 3.0


gimp_value_get_object_array ()

GObject **
gimp_value_get_object_array (const GValue *value);

Parameters

value

a GValue holding a object GimpObjectArray.

 

Returns

the internal array of objects.

[transfer none]


gimp_value_dup_object_array ()

GObject **
gimp_value_dup_object_array (const GValue *value);

Parameters

value

a GValue holding a object GimpObjectArray.

 

Returns

a deep copy of the array of objects.

[transfer full]


gimp_value_set_object_array ()

void
gimp_value_set_object_array (GValue *value,
                             GType object_type,
                             GObject **data,
                             gsize length);

Sets the contents of value to data .

Parameters

value

A valid value of type GIMP_TYPE_OBJECT_ARRAY

 

object_type

The GType of the object elements

 

data

A GObject array.

[array length=length]

length

The number of elements in data

 

gimp_value_set_static_object_array ()

void
gimp_value_set_static_object_array (GValue *value,
                                    GType object_type,
                                    GObject **data,
                                    gsize length);

Sets the contents of value to data , without copying the data.

Parameters

value

A valid value of type GIMP_TYPE_OBJECT_ARRAY

 

object_type

The GType of the object elements

 

data

A GObject array.

[array length=length]

length

The number of elements in data

 

gimp_value_take_object_array ()

void
gimp_value_take_object_array (GValue *value,
                              GType object_type,
                              GObject **data,
                              gsize length);

Sets the contents of value to data , and takes ownership of data .

Parameters

value

A valid value of type GIMP_TYPE_OBJECT_ARRAY

 

object_type

The GType of the object elements

 

data

A GObject array.

[transfer full][array length=length]

length

The number of elements in data

 

Types and Values

GIMP_PARAM_NO_VALIDATE

#define GIMP_PARAM_NO_VALIDATE (1 << (6 + G_PARAM_USER_SHIFT))

Since 3.0


GIMP_PARAM_STATIC_STRINGS

#define             GIMP_PARAM_STATIC_STRINGS

Since: 2.4


GIMP_PARAM_READABLE

#define             GIMP_PARAM_READABLE

Since: 2.4


GIMP_PARAM_WRITABLE

#define             GIMP_PARAM_WRITABLE

Since: 2.4


GIMP_PARAM_READWRITE

#define             GIMP_PARAM_READWRITE

Since: 2.4


struct GimpArray

struct GimpArray {
  guint8   *data;
  gsize     length;
  gboolean  static_data;
};

Members

guint8 *data;

pointer to the array's data.

[array length=length]

gsize length;

length of data , in bytes.

 

gboolean static_data;

whether data points to statically allocated memory.

 

struct GimpStringArray

struct GimpStringArray {
  gchar   **data;
  gsize     length;
  gboolean  static_data;
};

Members

gchar **data;

pointer to the array's data.

[array length=length]

gsize length;

length of data , in number of strings.

 

gboolean static_data;

whether data points to statically allocated memory.

 

struct GimpObjectArray

struct GimpObjectArray {
  GType     object_type;
  GObject **data;
  gsize     length;
  gboolean  static_data;
};

Members

GType object_type;

GType of the contained objects.

 

GObject **data;

pointer to the array's data.

[array length=length]

gsize length;

length of data , in number of objects.

 

gboolean static_data;

whether data points to statically allocated memory.