Method

GimpChoiceadd_deprecated

unstable since: 3.4

Declaration [src] 

void
gimp_choice_add_deprecated (
  GimpChoice* choice,
  const gchar* nick,
  gint id,
  const gchar* redirect_to,
  const gchar* reason
)

Description [src]

This procedure is used to add a deprecated nick. It must either have a valid redirect_to alias (when you are basically renaming a choice) or a free-text reason (e.g. for planning choice removal through a deprecation period).

If redirect_to is non NULL, then id must be identical to the ID of redirect_to. The redirect_to value must not be deprecated itself.

Available since: 3.4

Parameters

nick

Type: const gchar*

The nick of the deprecated choice.

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

Type: gint

Optional integer ID for nick.

redirect_to

Type: const gchar*

The valid nick to redirect the deprecated one to.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
reason

Type: const gchar*

The deprecation reason.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.