gimpprogress: GIMP Library Reference Manual

## gimpprogress gimpprogress |

## Functions

gboolean | gimp_progress_init ()
gboolean | gimp_progress_init_printf ()
gboolean | gimp_progress_update ()
gboolean | gimp_progress_pulse ()
gboolean | gimp_progress_set_text ()
gboolean | gimp_progress_set_text_printf ()
gboolean | gimp_progress_end ()
gint | gimp_progress_get_window_handle ()
void | (*GimpProgressStartCallback) ()
void | (*GimpProgressEndCallback) ()
void | (*GimpProgressTextCallback) ()
void | (*GimpProgressValueCallback) ()
const gchar * | gimp_progress_install_vtable ()
const gchar * | gimp_progress_install ()
gpointer | gimp_progress_uninstall ()
gboolean | gimp_progress_cancel ()

## Types and Values

struct | GimpProgressVtable

## Description

## Functions

### gimp_progress_init ()

    gboolean
    gimp_progress_init (const gchar *message);

### gimp_progress_init_printf ()

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

Since: GIMP 2.4

### gimp_progress_update ()

    gboolean
    gimp_progress_update (gdouble percentage);

### gimp_progress_pulse ()

    gboolean
    gimp_progress_pulse (void);

Since: GIMP 2.4

### gimp_progress_set_text ()

    gboolean
    gimp_progress_set_text (const gchar *message);

Since: GIMP 2.4

### gimp_progress_set_text_printf ()

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

Since: GIMP 2.4

### gimp_progress_end ()

    gboolean
    gimp_progress_end (void);

Since: GIMP 2.4

### gimp_progress_get_window_handle ()

    gint
    gimp_progress_get_window_handle (void);

Since: GIMP 2.2

### GimpProgressStartCallback ()

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

`GimpProgressStartCallback` is deprecated and should not be used in newly-written code.

### GimpProgressEndCallback ()

    void
    (*GimpProgressEndCallback) (gpointer user_data);

`GimpProgressEndCallback` is deprecated and should not be used in newly-written code.

### GimpProgressTextCallback ()

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

`GimpProgressTextCallback` is deprecated and should not be used in newly-written code.

### GimpProgressValueCallback ()

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

`GimpProgressValueCallback` is deprecated and should not be used in newly-written code.

### 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);

`gimp_progress_install` is deprecated and should not be used in newly-written code.

Since: GIMP 2.2

### gimp_progress_uninstall ()

    gpointer
    gimp_progress_uninstall (const gchar *progress_callback);

Since: GIMP 2.2

### gimp_progress_cancel ()

    gboolean
    gimp_progress_cancel (const gchar *progress_callback);

Since: GIMP 2.2

## Types and Values

### 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);
    };