## gimpplugin

gimpplugin — Functions useful for plugins, e.g. registration and progress indicators.

## Synopsis

    gboolean    gimp_progress_init              (const gchar *message);
    gboolean    gimp_progress_update            (gdouble percentage);
    gchar*      gimp_temp_PDB_name              (void);
    gboolean    gimp_plugin_domain_register     (const gchar *domain_name,
                                                 const gchar *domain_path);
    gboolean    gimp_plugin_help_register       (const gchar *domain_name,
                                                 const gchar *domain_uri);

## Description

Functions useful for plugins, e.g. registration and progress indicators.

## Details

### gimp_progress_init ()

    gboolean    gimp_progress_init              (const gchar *message);

Initializes the progress bar for the current plug-in.

Initializes the progress bar for the current plug-in. It is only valid to call this procedure from a plug-in.

`message` : | Message to use in the progress dialog.
Returns : | TRUE on success.

### gimp_progress_update ()

    gboolean    gimp_progress_update            (gdouble percentage);

Updates the progress bar for the current plug-in.

Updates the progress bar for the current plug-in. It is only valid to call this procedure from a plug-in.

`percentage` : | Percentage of progress completed which must be between 0.0 and 1.0.
Returns : | TRUE on success.

### gimp_temp_PDB_name ()

    gchar*      gimp_temp_PDB_name              (void);

Generates a unique temporary PDB name.

This procedure generates a temporary PDB entry name that is guaranteed to be unique. It is many used by the interactive popup dialogs to generate a PDB entry name.

Returns : | A unique temporary name for a temporary PDB entry.

### gimp_plugin_domain_register ()

    gboolean    gimp_plugin_domain_register     (const gchar *domain_name,
                                                 const gchar *domain_path);

Registers a textdomain for localisation.

This procedure adds a textdomain to the list of domains Gimp searches for strings when translating its menu entries. There is no need to call this function for plug-ins that have their strings included in the gimp-std-plugins domain as that is used by default. If the compiled message catalog is not in the standard location, you may specify an absolute path to another location. This procedure can only be called in the query function of a plug-in and it has to be called before any procedure is installed.

`domain_name` : | The name of the textdomain (must be unique).
`domain_path` : | The absolute path to the compiled message catalog (may be NULL).
Returns : | TRUE on success.

### gimp_plugin_help_register ()

    gboolean    gimp_plugin_help_register       (const gchar *domain_name,
                                                 const gchar *domain_uri);

Register a help path for a plug-in.

This procedure changes the help rootdir for the plug-in which calls it. All subsequent calls of gimp_help from this plug-in will be interpreted relative to this rootdir.

`domain_name` : | The XML namespace of the plug-in's help pages.
`domain_uri` : | The root URI of the plug-in's help pages.
Returns : | TRUE on success.