gimp/app/pdb/help_cmds.c

/* GIMP - The GNU 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 auto-generated by pdbgen.pl. */

#include "config.h"


#include <glib-object.h>

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

#include "core/gimp.h"
#include "plug-in/gimpplugin.h"
#include "plug-in/gimppluginmanager-help-domain.h"
#include "plug-in/gimppluginmanager.h"

#include "internal_procs.h"


static GValueArray *
help_invoker (GimpProcedure     *procedure,
              Gimp              *gimp,
              GimpContext       *context,
              GimpProgress      *progress,
              const GValueArray *args)
{
  gboolean success = TRUE;
  const gchar *help_domain;
  const gchar *help_id;

  help_domain = g_value_get_string (&args->values[0]);
  help_id = g_value_get_string (&args->values[1]);

  if (success)
    {
      GimpPlugInManager *manager = gimp->plug_in_manager;

      if (! help_domain && manager->current_plug_in)
        help_domain = (gchar *)
          gimp_plug_in_manager_get_help_domain (manager,
                                                manager->current_plug_in->prog,
                                                NULL);

      gimp_help (gimp, help_domain, help_id);
    }

  return gimp_procedure_get_return_values (procedure, success);
}

void
register_help_procs (GimpPDB *pdb)
{
  GimpProcedure *procedure;

  /*
   * gimp-help
   */
  procedure = gimp_procedure_new (help_invoker);
  gimp_object_set_static_name (GIMP_OBJECT (procedure), "gimp-help");
  gimp_procedure_set_static_strings (procedure,
                                     "gimp-help",
                                     "Load a help page.",
                                     "This procedure loads the specified help page into the helpbrowser or what ever is configured as help viewer. The help page is identified by its domain and ID: if help_domain is NULL, we use the help_domain which was registered using the 'gimp-plugin-help-register' procedure. If help_domain is NULL and no help domain was registered, the help domain of the main GIMP installation is used.",
                                     "Michael Natterer <mitch@gimp.org>",
                                     "Michael Natterer",
                                     "2000",
                                     NULL);
  gimp_procedure_add_argument (procedure,
                               gimp_param_spec_string ("help-domain",
                                                       "help domain",
                                                       "The help domain in which help_id is registered",
                                                       FALSE, TRUE, FALSE,
                                                       NULL,
                                                       GIMP_PARAM_READWRITE));
  gimp_procedure_add_argument (procedure,
                               gimp_param_spec_string ("help-id",
                                                       "help id",
                                                       "The help page's ID",
                                                       FALSE, FALSE, FALSE,
                                                       NULL,
                                                       GIMP_PARAM_READWRITE));
  gimp_pdb_register_procedure (pdb, procedure);
  g_object_unref (procedure);
}