gimpprogress_pdb.c 8.52 KB
Newer Older
1 2 3 4 5
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
 *
 * gimpprogress_pdb.c
 *
6
 * This library is free software: you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
9
 * version 3 of the License, or (at your option) any later version.
10 11 12 13 14 15 16
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with this library.  If not, see
18
 * <https://www.gnu.org/licenses/>.
19 20
 */

21
/* NOTE: This file is auto-generated by pdbgen.pl */
22 23 24 25 26

#include "config.h"

#include "gimp.h"

27 28 29 30 31 32 33 34 35 36

/**
 * SECTION: gimpprogress
 * @title: gimpprogress
 * @short_description: Functions for embedding the progress bar into a plug-in's GUI.
 *
 * Functions for embedding the progress bar into a plug-in's GUI.
 **/


37
/**
38
 * _gimp_progress_init:
39
 * @message: Message to use in the progress dialog.
40
 * @gdisplay_ID: GimpDisplay to update progressbar in, or -1 for a separate window.
41 42 43 44 45 46 47
 *
 * 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.
 *
 * Returns: TRUE on success.
48
 **/
49
gboolean
50
_gimp_progress_init (const gchar *message,
51
                     gint32       gdisplay_ID)
52 53 54 55 56
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

57
  return_vals = gimp_run_procedure ("gimp-progress-init",
58 59 60 61
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, message,
                                    GIMP_PDB_DISPLAY, gdisplay_ID,
                                    GIMP_PDB_END);
62 63 64 65 66 67 68 69 70

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
71
 * _gimp_progress_update:
72 73 74 75 76 77 78 79
 * @percentage: Percentage of progress completed which must be between 0.0 and 1.0.
 *
 * 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.
 *
 * Returns: TRUE on success.
80
 **/
81
gboolean
82
_gimp_progress_update (gdouble percentage)
83 84 85 86 87
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

88
  return_vals = gimp_run_procedure ("gimp-progress-update",
89 90 91
                                    &nreturn_vals,
                                    GIMP_PDB_FLOAT, percentage,
                                    GIMP_PDB_END);
92 93 94 95 96 97 98

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}
99

100 101 102 103 104 105 106 107 108 109 110 111 112
/**
 * gimp_progress_pulse:
 *
 * 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.
 *
 * Returns: TRUE on success.
 *
113
 * Since: 2.4
114
 **/
115 116 117 118 119 120 121
gboolean
gimp_progress_pulse (void)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

122
  return_vals = gimp_run_procedure ("gimp-progress-pulse",
123 124
                                    &nreturn_vals,
                                    GIMP_PDB_END);
125 126 127 128 129 130 131 132

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

133
/**
134
 * gimp_progress_set_text:
135 136 137 138
 * @message: Message to use in the progress dialog.
 *
 * Changes the text in the progress bar for the current plug-in.
 *
139 140
 * This function changes the text in the progress bar for the current
 * plug-in. Unlike gimp_progress_init() it does not change the
141 142 143 144
 * displayed value.
 *
 * Returns: TRUE on success.
 *
145
 * Since: 2.4
146
 **/
147
gboolean
148
gimp_progress_set_text (const gchar *message)
149 150 151 152 153
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

154
  return_vals = gimp_run_procedure ("gimp-progress-set-text",
155 156 157
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, message,
                                    GIMP_PDB_END);
158 159 160 161 162 163 164 165

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

166 167 168 169 170 171 172 173 174 175 176
/**
 * gimp_progress_end:
 *
 * 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.
 *
 * Returns: TRUE on success.
 *
177
 * Since: 2.4
178
 **/
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
gboolean
gimp_progress_end (void)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

  return_vals = gimp_run_procedure ("gimp-progress-end",
                                    &nreturn_vals,
                                    GIMP_PDB_END);

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

197 198 199 200 201 202 203 204 205 206 207
/**
 * gimp_progress_get_window_handle:
 *
 * 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.
 *
 * Returns: The progress bar's toplevel window.
 *
208
 * Since: 2.2
209
 **/
210 211 212 213 214 215 216 217
gint
gimp_progress_get_window_handle (void)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gint window = 0;

  return_vals = gimp_run_procedure ("gimp-progress-get-window-handle",
218 219
                                    &nreturn_vals,
                                    GIMP_PDB_END);
220 221 222 223 224 225 226 227 228

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
    window = return_vals[1].data.d_int32;

  gimp_destroy_params (return_vals, nreturn_vals);

  return window;
}

229 230 231 232 233 234 235 236 237 238 239 240 241
/**
 * _gimp_progress_install:
 * @progress_callback: The callback PDB proc to call.
 *
 * Installs a progress callback for the current plug-in.
 *
 * This function installs a temporary PDB procedure which will handle
 * all progress calls made by this plug-in and any procedure it calls.
 * Calling this function multiple times simply replaces the old
 * progress callbacks.
 *
 * Returns: TRUE on success.
 *
242
 * Since: 2.2
243
 **/
244 245 246 247 248 249 250
gboolean
_gimp_progress_install (const gchar *progress_callback)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

251
  return_vals = gimp_run_procedure ("gimp-progress-install",
252 253 254
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, progress_callback,
                                    GIMP_PDB_END);
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * _gimp_progress_uninstall:
 * @progress_callback: The name of the callback registered for this progress.
 *
 * Uninstalls the progress callback for the current plug-in.
 *
 * This function uninstalls any progress callback installed with
 * gimp_progress_install() before.
 *
 * Returns: TRUE on success.
 *
274
 * Since: 2.2
275
 **/
276 277 278 279 280 281 282
gboolean
_gimp_progress_uninstall (const gchar *progress_callback)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

283
  return_vals = gimp_run_procedure ("gimp-progress-uninstall",
284 285 286
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, progress_callback,
                                    GIMP_PDB_END);
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * gimp_progress_cancel:
 * @progress_callback: The name of the callback registered for this progress.
 *
 * Cancels a running progress.
 *
 * This function cancels the currently running progress.
 *
 * Returns: TRUE on success.
 *
305
 * Since: 2.2
306
 **/
307 308 309 310 311 312 313
gboolean
gimp_progress_cancel (const gchar *progress_callback)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

314
  return_vals = gimp_run_procedure ("gimp-progress-cancel",
315 316 317
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, progress_callback,
                                    GIMP_PDB_END);
318 319 320 321 322 323 324

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}