Function

GimpUiHelpFunc

Declaration

void
(* GimpHelpFunc) (
  const gchar* help_id,
  gpointer help_data
)

Description [src]

This is the prototype for all functions you pass as help_func to the various GIMP dialog constructors like gimp_dialog_new(), gimp_query_int_box() etc.

Help IDs are textual identifiers the help system uses to figure which page to display.

All these dialog constructors functions call gimp_help_connect().

In most cases it will be ok to use gimp_standard_help_func() which does nothing but passing the help_id string to gimp_help(). If your plug-in needs some more sophisticated help handling you can provide your own help_func which has to call gimp_help() to actually display the help.

Parameters

help_id

Type: const gchar*

The help ID.

The data is owned by the caller of the function.

The value is a NUL terminated UTF-8 string.

help_data

Type: gpointer

The help user data.

The argument can be NULL.

The data is owned by the caller of the function.