Function

Gimpparam_spec_file

since: 3.0

Declaration [src]

GParamSpec*
gimp_param_spec_file (
  const gchar* name,
  const gchar* nick,
  const gchar* blurb,
  GimpFileChooserAction action,
  gboolean none_ok,
  GFile* default_value,
  GParamFlags flags
)

Description [src]

Creates a param spec to hold a file param. See g_param_spec_internal() for more information.

Available since: 3.0

Parameters

name

Type: const gchar*

Canonical name of the param.

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

Type: const gchar*

Nickname of the param.

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

Type: const gchar*

Brief description of param.

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

Type: GimpFileChooserAction

The type of file to expect.

none_ok

Type: gboolean

Whether NULL is allowed.

default_value

Type: GFile

File to use if none is assigned.

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

Type: GParamFlags

A combination of GParamFlags.

Return value

Type: GParamSpec

A newly allocated GParamSpec instance.

The caller of the function takes ownership of the data, and is responsible for freeing it.