gimp/app/pdb/progress_cmds.c

/* The GIMP -- an image manipulation program
 * Copyright (C) 1995-2003 Spencer Kimball and Peter Mattis
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

/* NOTE: This file is autogenerated by pdbgen.pl. */

#include "config.h"


#include <glib-object.h>

#include "pdb-types.h"
#include "gimpprocedure.h"
#include "procedural_db.h"
#include "core/gimpparamspecs.h"

#include "core/gimp.h"
#include "plug-in/plug-in-progress.h"
#include "plug-in/plug-in.h"

static ProcRecord progress_init_proc;
static ProcRecord progress_update_proc;
static ProcRecord progress_pulse_proc;
static ProcRecord progress_set_text_proc;
static ProcRecord progress_get_window_handle_proc;
static ProcRecord progress_install_proc;
static ProcRecord progress_uninstall_proc;
static ProcRecord progress_cancel_proc;

void
register_progress_procs (Gimp *gimp)
{
  ProcRecord *procedure;

  /*
   * progress_init
   */
  procedure = gimp_procedure_init (&progress_init_proc, 2, 0);
  gimp_procedure_add_argument (procedure,
                               GIMP_PDB_STRING,
                               gimp_param_spec_string ("message",
                                                       "message",
                                                       "Message to use in the progress dialog",
                                                       FALSE, TRUE,
                                                       NULL,
                                                       GIMP_PARAM_READWRITE));
  gimp_procedure_add_argument (procedure,
                               GIMP_PDB_DISPLAY,
                               gimp_param_spec_display_id ("gdisplay",
                                                           "gdisplay",
                                                           "GimpDisplay to update progressbar in, or -1 for a seperate window",
                                                           gimp,
                                                           GIMP_PARAM_READWRITE | GIMP_PARAM_NO_VALIDATE));
  procedural_db_register (gimp, procedure);

  /*
   * progress_update
   */
  procedure = gimp_procedure_init (&progress_update_proc, 1, 0);
  gimp_procedure_add_argument (procedure,
                               GIMP_PDB_FLOAT,
                               g_param_spec_double ("percentage",
                                                    "percentage",
                                                    "Percentage of progress completed which must be between 0.0 and 1.0",
                                                    -G_MAXDOUBLE, G_MAXDOUBLE, 0,
                                                    GIMP_PARAM_READWRITE));
  procedural_db_register (gimp, procedure);

  /*
   * progress_pulse
   */
  procedure = gimp_procedure_init (&progress_pulse_proc, 0, 0);
  procedural_db_register (gimp, procedure);

  /*
   * progress_set_text
   */
  procedure = gimp_procedure_init (&progress_set_text_proc, 1, 0);
  gimp_procedure_add_argument (procedure,
                               GIMP_PDB_STRING,
                               gimp_param_spec_string ("message",
                                                       "message",
                                                       "Message to use in the progress dialog",
                                                       FALSE, TRUE,
                                                       NULL,
                                                       GIMP_PARAM_READWRITE));
  procedural_db_register (gimp, procedure);

  /*
   * progress_get_window_handle
   */
  procedure = gimp_procedure_init (&progress_get_window_handle_proc, 0, 1);
  gimp_procedure_add_return_value (procedure,
                                   GIMP_PDB_INT32,
                                   g_param_spec_int ("window",
                                                     "window",
                                                     "The progress bar's toplevel window",
                                                     G_MININT32, G_MAXINT32, 0,
                                                     GIMP_PARAM_READWRITE));
  procedural_db_register (gimp, procedure);

  /*
   * progress_install
   */
  procedure = gimp_procedure_init (&progress_install_proc, 1, 0);
  gimp_procedure_add_argument (procedure,
                               GIMP_PDB_STRING,
                               gimp_param_spec_string ("progress-callback",
                                                       "progress callback",
                                                       "The callback PDB proc to call",
                                                       FALSE, FALSE,
                                                       NULL,
                                                       GIMP_PARAM_READWRITE));
  procedural_db_register (gimp, procedure);

  /*
   * progress_uninstall
   */
  procedure = gimp_procedure_init (&progress_uninstall_proc, 1, 0);
  gimp_procedure_add_argument (procedure,
                               GIMP_PDB_STRING,
                               gimp_param_spec_string ("progress-callback",
                                                       "progress callback",
                                                       "The name of the callback registered for this progress",
                                                       FALSE, FALSE,
                                                       NULL,
                                                       GIMP_PARAM_READWRITE));
  procedural_db_register (gimp, procedure);

  /*
   * progress_cancel
   */
  procedure = gimp_procedure_init (&progress_cancel_proc, 1, 0);
  gimp_procedure_add_argument (procedure,
                               GIMP_PDB_STRING,
                               gimp_param_spec_string ("progress-callback",
                                                       "progress callback",
                                                       "The name of the callback registered for this progress",
                                                       FALSE, FALSE,
                                                       NULL,
                                                       GIMP_PARAM_READWRITE));
  procedural_db_register (gimp, procedure);

}

static Argument *
progress_init_invoker (ProcRecord   *proc_record,
                       Gimp         *gimp,
                       GimpContext  *context,
                       GimpProgress *progress,
                       Argument     *args)
{
  gboolean success = TRUE;
  gchar *message;
  GimpObject *gdisplay;

  message = (gchar *) g_value_get_string (&args[0].value);
  gdisplay = gimp_value_get_display (&args[1].value, gimp);

  if (success)
    {
      if (gimp->current_plug_in && gimp->current_plug_in->open)
        {
          if (! gimp->no_interface)
            plug_in_progress_start (gimp->current_plug_in, message, gdisplay);
        }
      else
        success = FALSE;
    }

  return gimp_procedure_get_return_values (proc_record, success);
}

static ProcRecord progress_init_proc =
{
  TRUE, TRUE,
  "gimp-progress-init",
  "gimp-progress-init",
  "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.",
  "Spencer Kimball & Peter Mattis",
  "Spencer Kimball & Peter Mattis",
  "1995-1996",
  NULL,
  GIMP_INTERNAL,
  0, NULL, 0, NULL,
  { { progress_init_invoker } }
};

static Argument *
progress_update_invoker (ProcRecord   *proc_record,
                         Gimp         *gimp,
                         GimpContext  *context,
                         GimpProgress *progress,
                         Argument     *args)
{
  gboolean success = TRUE;
  gdouble percentage;

  percentage = g_value_get_double (&args[0].value);

  if (success)
    {
      if (gimp->current_plug_in && gimp->current_plug_in->open)
        {
          if (! gimp->no_interface)
            plug_in_progress_set_value (gimp->current_plug_in, percentage);
        }
      else
        success = FALSE;
    }

  return gimp_procedure_get_return_values (proc_record, success);
}

static ProcRecord progress_update_proc =
{
  TRUE, TRUE,
  "gimp-progress-update",
  "gimp-progress-update",
  "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.",
  "Spencer Kimball & Peter Mattis",
  "Spencer Kimball & Peter Mattis",
  "1995-1996",
  NULL,
  GIMP_INTERNAL,
  0, NULL, 0, NULL,
  { { progress_update_invoker } }
};

static Argument *
progress_pulse_invoker (ProcRecord   *proc_record,
                        Gimp         *gimp,
                        GimpContext  *context,
                        GimpProgress *progress,
                        Argument     *args)
{
  gboolean success = TRUE;
  if (gimp->current_plug_in && gimp->current_plug_in->open)
    {
      if (! gimp->no_interface)
        plug_in_progress_pulse (gimp->current_plug_in);
    }
  else
    success = FALSE;
  return gimp_procedure_get_return_values (proc_record, success);
}

static ProcRecord progress_pulse_proc =
{
  TRUE, TRUE,
  "gimp-progress-pulse",
  "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.",
  "Sven Neumann <sven@gimp.org>",
  "Sven Neumann",
  "2005",
  NULL,
  GIMP_INTERNAL,
  0, NULL, 0, NULL,
  { { progress_pulse_invoker } }
};

static Argument *
progress_set_text_invoker (ProcRecord   *proc_record,
                           Gimp         *gimp,
                           GimpContext  *context,
                           GimpProgress *progress,
                           Argument     *args)
{
  gboolean success = TRUE;
  gchar *message;

  message = (gchar *) g_value_get_string (&args[0].value);

  if (success)
    {
      if (gimp->current_plug_in && gimp->current_plug_in->open)
        {
          if (! gimp->no_interface)
            plug_in_progress_set_text (gimp->current_plug_in, message);
        }
      else
        success = FALSE;
    }

  return gimp_procedure_get_return_values (proc_record, success);
}

static ProcRecord progress_set_text_proc =
{
  TRUE, TRUE,
  "gimp-progress-set-text",
  "gimp-progress-set-text",
  "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.",
  "Sven Neumann <sven@gimp.org>",
  "Sven Neumann",
  "2005",
  NULL,
  GIMP_INTERNAL,
  0, NULL, 0, NULL,
  { { progress_set_text_invoker } }
};

static Argument *
progress_get_window_handle_invoker (ProcRecord   *proc_record,
                                    Gimp         *gimp,
                                    GimpContext  *context,
                                    GimpProgress *progress,
                                    Argument     *args)
{
  gboolean success = TRUE;
  Argument *return_vals;
  gint32 window = 0;

  if (gimp->current_plug_in && gimp->current_plug_in->open)
    {
      if (! gimp->no_interface)
        window = plug_in_progress_get_window (gimp->current_plug_in);
    }
  else
    success = FALSE;

  return_vals = gimp_procedure_get_return_values (proc_record, success);

  if (success)
    g_value_set_int (&return_vals[1].value, window);

  return return_vals;
}

static ProcRecord progress_get_window_handle_proc =
{
  TRUE, TRUE,
  "gimp-progress-get-window-handle",
  "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.",
  "Michael Natterer <mitch@gimp.org>",
  "Michael Natterer",
  "2004",
  NULL,
  GIMP_INTERNAL,
  0, NULL, 0, NULL,
  { { progress_get_window_handle_invoker } }
};

static Argument *
progress_install_invoker (ProcRecord   *proc_record,
                          Gimp         *gimp,
                          GimpContext  *context,
                          GimpProgress *progress,
                          Argument     *args)
{
  gboolean success = TRUE;
  gchar *progress_callback;

  progress_callback = (gchar *) g_value_get_string (&args[0].value);

  if (success)
    {
      if (gimp->current_plug_in && gimp->current_plug_in->open)
        success = plug_in_progress_install (gimp->current_plug_in,
                                            progress_callback);
      else
        success = FALSE;
    }

  return gimp_procedure_get_return_values (proc_record, success);
}

static ProcRecord progress_install_proc =
{
  TRUE, TRUE,
  "gimp-progress-install",
  "gimp-progress-install",
  "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.",
  "Michael Natterer <mitch@gimp.org>",
  "Michael Natterer",
  "2004",
  NULL,
  GIMP_INTERNAL,
  0, NULL, 0, NULL,
  { { progress_install_invoker } }
};

static Argument *
progress_uninstall_invoker (ProcRecord   *proc_record,
                            Gimp         *gimp,
                            GimpContext  *context,
                            GimpProgress *progress,
                            Argument     *args)
{
  gboolean success = TRUE;
  gchar *progress_callback;

  progress_callback = (gchar *) g_value_get_string (&args[0].value);

  if (success)
    {
      if (gimp->current_plug_in && gimp->current_plug_in->open)
        success = plug_in_progress_uninstall (gimp->current_plug_in,
                                              progress_callback);
      else
        success = FALSE;
    }

  return gimp_procedure_get_return_values (proc_record, success);
}

static ProcRecord progress_uninstall_proc =
{
  TRUE, TRUE,
  "gimp-progress-uninstall",
  "gimp-progress-uninstall",
  "Uninstalls the progress callback for the current plug-in.",
  "This function uninstalls any progress callback installed with gimp_progress_install() before.",
  "Michael Natterer <mitch@gimp.org>",
  "Michael Natterer",
  "2004",
  NULL,
  GIMP_INTERNAL,
  0, NULL, 0, NULL,
  { { progress_uninstall_invoker } }
};

static Argument *
progress_cancel_invoker (ProcRecord   *proc_record,
                         Gimp         *gimp,
                         GimpContext  *context,
                         GimpProgress *progress,
                         Argument     *args)
{
  gboolean success = TRUE;
  gchar *progress_callback;

  progress_callback = (gchar *) g_value_get_string (&args[0].value);

  if (success)
    {
      if (gimp->current_plug_in && gimp->current_plug_in->open)
        success = plug_in_progress_cancel (gimp->current_plug_in,
                                           progress_callback);
      else
        success = FALSE;
    }

  return gimp_procedure_get_return_values (proc_record, success);
}

static ProcRecord progress_cancel_proc =
{
  TRUE, TRUE,
  "gimp-progress-cancel",
  "gimp-progress-cancel",
  "Cancels a running progress.",
  "This function cancels the currently running progress.",
  "Michael Natterer <mitch@gimp.org>",
  "Michael Natterer",
  "2004",
  NULL,
  GIMP_INTERNAL,
  0, NULL, 0, NULL,
  { { progress_cancel_invoker } }
};