Function

Gimpparam_spec_resource

since: 3.0

Declaration [src]

GParamSpec*
gimp_param_spec_resource (
  const gchar* name,
  const gchar* nick,
  const gchar* blurb,
  GType resource_type,
  gboolean none_ok,
  GimpResource* default_value,
  gboolean default_to_context,
  GParamFlags flags
)

Description [src]

Creates a new GimpParamSpecResource specifying a GimpResource property. See g_param_spec_internal() for details on property names.

default_to_context cannot be TRUE for a resource_type of value GimpResource, but only for specific subtypes. If it is TRUE, default_value must be NULL. Instead of a fixed default, whatever is the context’s resource for the given type at run time will be used as dynamic default.

Available since: 3.0

Parameters

name

Type: const gchar*

Canonical name of the property specified.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
nick

Type: const gchar*

Nick name of the property specified.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
blurb

Type: const gchar*

Description of the property specified.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
resource_type

Type: GType

A %GType, subtype of GimpResource.

none_ok

Type: gboolean

Whether NULL is a valid value.

default_value

Type: GimpResource

Default resource.

The argument can be NULL.
The data is owned by the caller of the function.
default_to_context

Type: gboolean

Whether the context is the context’s resource for the given resource_type.

flags

Type: GParamFlags

Flags for the property specified.

Return value

Type: GParamSpec

The newly created GimpParamSpecResource.

The data is owned by the called function.