struct GimpProgressVtable

struct GimpProgressVtable {
  void    (* start)        (const gchar *message,
                            gboolean     cancelable,
                            gpointer     user_data);
  void    (* end)          (gpointer     user_data);
  void    (* set_text)     (const gchar *message,
                            gpointer     user_data);
  void    (* set_value)    (gdouble      percentage,
                            gpointer     user_data);
  void    (* pulse)        (gpointer     user_data);

  guint32 (* get_window)   (gpointer     user_data);

  /* Padding for future expansion. Must be initialized with NULL! */
  void (* _gimp_reserved1) (void);
  void (* _gimp_reserved2) (void);
  void (* _gimp_reserved3) (void);
  void (* _gimp_reserved4) (void);
  void (* _gimp_reserved5) (void);
  void (* _gimp_reserved6) (void);
  void (* _gimp_reserved7) (void);
  void (* _gimp_reserved8) (void);
};

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.

gimp_progress_init_printf ()

gboolean            gimp_progress_init_printf           (const gchar *format,
                                                         ...);

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.

Since GIMP 2.4

gimp_progress_update ()

gboolean            gimp_progress_update                (gdouble percentage);

Updates the progress bar for the current plug-in.

gimp_progress_pulse ()

gboolean            gimp_progress_pulse                 (void);

Pulses 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. Use this function instead of gimp_progress_update() if you cannot tell how much progress has been made. This usually causes the the progress bar to enter \"activity mode\", where a block bounces back and forth.

Since GIMP 2.4

gimp_progress_set_text ()

gboolean            gimp_progress_set_text              (const gchar *message);

Changes the text in the progress bar for the current plug-in.

This function allows to change the text in the progress bar for the current plug-in. Unlike gimp_progress_init() it does not change the displayed value.

Since GIMP 2.4

gimp_progress_set_text_printf ()

gboolean            gimp_progress_set_text_printf       (const gchar *format,
                                                         ...);

Changes the text in the progress bar for the current plug-in.

This function allows to change the text in the progress bar for the current plug-in. Unlike gimp_progress_init() it does not change the displayed value.

Since GIMP 2.4

gimp_progress_end ()

gboolean            gimp_progress_end                   (void);

Ends the progress bar for the current plug-in.

Ends the progress display for the current plug-in. Most plug-ins don't need to call this, they just exit when the work is done. It is only valid to call this procedure from a plug-in.

Since GIMP 2.4

gimp_progress_get_window_handle ()

gint                gimp_progress_get_window_handle     (void);

Returns the native window ID of the toplevel window this plug-in's progress is displayed in.

This function returns the native window ID of the toplevel window this plug-in\'s progress is displayed in.

Since GIMP 2.2

GimpProgressStartCallback ()

void                (*GimpProgressStartCallback)        (const gchar *message,
                                                         gboolean cancelable,
                                                         gpointer user_data);

GimpProgressEndCallback ()

void                (*GimpProgressEndCallback)          (gpointer user_data);

GimpProgressTextCallback ()

void                (*GimpProgressTextCallback)         (const gchar *message,
                                                         gpointer user_data);

GimpProgressValueCallback ()

void                (*GimpProgressValueCallback)        (gdouble percentage,
                                                         gpointer user_data);

gimp_progress_install_vtable ()

const gchar *       gimp_progress_install_vtable        (const GimpProgressVtable *vtable,
                                                         gpointer user_data);

Since GIMP 2.4

gimp_progress_install ()

const gchar *       gimp_progress_install               (GimpProgressStartCallback start_callback,
                                                         GimpProgressEndCallback end_callback,
                                                         GimpProgressTextCallback text_callback,
                                                         GimpProgressValueCallback value_callback,
                                                         gpointer user_data);

Note that since GIMP 2.4, value_callback can be called with negative values. This is triggered by calls to gimp_progress_pulse(). The callback should then implement a progress indicating business, e.g. by calling gtk_progress_bar_pulse().

Since GIMP 2.2

gimp_progress_uninstall ()

gpointer            gimp_progress_uninstall             (const gchar *progress_callback);

Uninstalls a temporary progress procedure that was installed using gimp_progress_install().

Since GIMP 2.2

gimp_progress_cancel ()

gboolean            gimp_progress_cancel                (const gchar *progress_callback);

Cancels a running progress.

This function cancels the currently running progress.

Since GIMP 2.2