GimpProgress

GimpProgress

Synopsis

                    GimpProgress;
struct              GimpProgressInterface;
GimpProgress *      gimp_progress_start                 (GimpProgress *progress,
                                                         const gchar *message,
                                                         gboolean cancelable);
void                gimp_progress_end                   (GimpProgress *progress);
gboolean            gimp_progress_is_active             (GimpProgress *progress);
void                gimp_progress_set_text              (GimpProgress *progress,
                                                         const gchar *message);
void                gimp_progress_set_value             (GimpProgress *progress,
                                                         gdouble percentage);
gdouble             gimp_progress_get_value             (GimpProgress *progress);
void                gimp_progress_pulse                 (GimpProgress *progress);
guint32             gimp_progress_get_window_id         (GimpProgress *progress);
gboolean            gimp_progress_message               (GimpProgress *progress,
                                                         Gimp *gimp,
                                                         GimpMessageSeverity severity,
                                                         const gchar *domain,
                                                         const gchar *message);
void                gimp_progress_cancel                (GimpProgress *progress);
void                gimp_progress_update_and_flush      (gint min,
                                                         gint max,
                                                         gint current,
                                                         gpointer data);

Object Hierarchy

  GInterface
   +----GimpProgressInterface

Prerequisites

GimpProgressInterface requires GObject.

Known Implementations

GimpProgressInterface is implemented by GimpAirbrushTool, GimpAlignTool, GimpBlendTool, GimpBrightnessContrastTool, GimpBrushTool, GimpBucketFillTool, GimpByColorSelectTool, GimpCageTool, GimpCanvasProgress, GimpCloneTool, GimpColorBalanceTool, GimpColorPickerTool, GimpColorTool, GimpColorizeTool, GimpConvolveTool, GimpCropTool, GimpCurvesTool, GimpDesaturateTool, GimpDisplay, GimpDisplayShell, GimpDodgeBurnTool, GimpDrawTool, GimpEllipseSelectTool, GimpEraserTool, GimpFileDialog, GimpFlipTool, GimpForegroundSelectTool, GimpFreeSelectTool, GimpFuzzySelectTool, GimpGeglTool, GimpHealTool, GimpHueSaturationTool, GimpImageMapTool, GimpInkTool, GimpIscissorsTool, GimpLevelsTool, GimpMagnifyTool, GimpMeasureTool, GimpMoveTool, GimpPaintTool, GimpPaintbrushTool, GimpPdbProgress, GimpPencilTool, GimpPerspectiveCloneTool, GimpPerspectiveTool, GimpPosterizeTool, GimpProgressBox, GimpProgressDialog, GimpRectangleSelectTool, GimpRegionSelectTool, GimpRotateTool, GimpScaleTool, GimpSelectionTool, GimpShearTool, GimpSmudgeTool, GimpSourceTool, GimpStatusbar, GimpSubProgress, GimpTextTool, GimpThresholdTool, GimpThumbBox, GimpTool, GimpTransformTool and GimpVectorTool.

Signals

  "cancel"                                         : Run First

Description

Details

GimpProgress

typedef struct _GimpProgress GimpProgress;


struct GimpProgressInterface

struct GimpProgressInterface;


gimp_progress_start ()

GimpProgress *      gimp_progress_start                 (GimpProgress *progress,
                                                         const gchar *message,
                                                         gboolean cancelable);


gimp_progress_end ()

void                gimp_progress_end                   (GimpProgress *progress);


gimp_progress_is_active ()

gboolean            gimp_progress_is_active             (GimpProgress *progress);


gimp_progress_set_text ()

void                gimp_progress_set_text              (GimpProgress *progress,
                                                         const gchar *message);


gimp_progress_set_value ()

void                gimp_progress_set_value             (GimpProgress *progress,
                                                         gdouble percentage);


gimp_progress_get_value ()

gdouble             gimp_progress_get_value             (GimpProgress *progress);


gimp_progress_pulse ()

void                gimp_progress_pulse                 (GimpProgress *progress);


gimp_progress_get_window_id ()

guint32             gimp_progress_get_window_id         (GimpProgress *progress);


gimp_progress_message ()

gboolean            gimp_progress_message               (GimpProgress *progress,
                                                         Gimp *gimp,
                                                         GimpMessageSeverity severity,
                                                         const gchar *domain,
                                                         const gchar *message);


gimp_progress_cancel ()

void                gimp_progress_cancel                (GimpProgress *progress);


gimp_progress_update_and_flush ()

void                gimp_progress_update_and_flush      (gint min,
                                                         gint max,
                                                         gint current,
                                                         gpointer data);

Signal Details

The "cancel" signal

void                user_function                      (GimpProgressInterface *gimpprogressinterface,
                                                        gpointer               user_data)                  : Run First

gimpprogressinterface :

the object which received the signal.

user_data :

user data set when the signal handler was connected.