GimpSubProgress

GimpSubProgress

Synopsis

                    GimpSubProgress;
GimpProgress *      gimp_sub_progress_new               (GimpProgress *progress);
void                gimp_sub_progress_set_range         (GimpSubProgress *progress,
                                                         gdouble start,
                                                         gdouble end);
void                gimp_sub_progress_set_step          (GimpSubProgress *progress,
                                                         gint index,
                                                         gint num_steps);

Object Hierarchy

  GObject
   +----GimpSubProgress

Implemented Interfaces

GimpSubProgress implements GimpProgressInterface.

Description

Details

GimpSubProgress

typedef struct _GimpSubProgress GimpSubProgress;


gimp_sub_progress_new ()

GimpProgress *      gimp_sub_progress_new               (GimpProgress *progress);

GimpSubProgress implements the GimpProgress interface and can be used whereever a GimpProgress is needed. It maps progress information to a sub-range of its parent progress. This is useful when an action breaks down into multiple sub-actions that itself need a GimpProgress pointer. See gimp_image_scale() for an example.

progress :

parent progress or NULL

Returns :

a new GimpProgress object

gimp_sub_progress_set_range ()

void                gimp_sub_progress_set_range         (GimpSubProgress *progress,
                                                         gdouble start,
                                                         gdouble end);

Sets a range on the parent progress that this progress should be mapped to.

start :

start value of range on the parent process

end :

end value of range on the parent process

gimp_sub_progress_set_step ()

void                gimp_sub_progress_set_step          (GimpSubProgress *progress,
                                                         gint index,
                                                         gint num_steps);

A more convenient form of gimp_sub_progress_set_range().

index :

step index

num_steps :

number of steps