home *** CD-ROM | disk | FTP | other *** search
/ PC Pro 2002 April / pcpro0402.iso / essentials / graphics / Gimp / gimp-src-20001226.exe / src / gimp / libgimp / gimphelp_pdb.c < prev    next >
Encoding:
C/C++ Source or Header  |  2000-08-25  |  2.1 KB  |  64 lines
  1. /* LIBGIMP - The GIMP Library
  2.  * Copyright (C) 1995-2000 Peter Mattis and Spencer Kimball
  3.  *
  4.  * gimphelp_pdb.c
  5.  *
  6.  * This library is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU Lesser General Public
  8.  * License as published by the Free Software Foundation; either
  9.  * version 2 of the License, or (at your option) any later version.
  10.  *
  11.  * This library is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.  * Lesser General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU Lesser General Public
  17.  * License along with this library; if not, write to the
  18.  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19.  * Boston, MA 02111-1307, USA.
  20.  */
  21.  
  22. /* NOTE: This file is autogenerated by pdbgen.pl */
  23.  
  24. #include "gimp.h"
  25.  
  26. /**
  27.  * gimp_help:
  28.  * @prog_name: The plug-in's executable name or an empty string.
  29.  * @help_page: The location of the help page.
  30.  *
  31.  * Load a help page.
  32.  *
  33.  * This procedure loads the specified help page into the helpbrowser or
  34.  * what ever is configured as help viewer. The location of the help
  35.  * page is given relative to the help rootdir. The help rootdir is
  36.  * determined from the prog_name: if prog_name is NULL, we use the help
  37.  * rootdir of the main GIMP installation, if the plug-in's full
  38.  * executable name is passed as prog_name, the GIMP will use this
  39.  * information to look up the help path the plug-in has registered
  40.  * before with gimp-plugin-help-register.
  41.  *
  42.  * Returns: TRUE on success.
  43.  */
  44. gboolean
  45. gimp_help (gchar *prog_name,
  46.        gchar *help_page)
  47. {
  48.   GimpParam *return_vals;
  49.   gint nreturn_vals;
  50.   gboolean success = TRUE;
  51.  
  52.   return_vals = gimp_run_procedure ("gimp_help",
  53.                     &nreturn_vals,
  54.                     GIMP_PDB_STRING, prog_name,
  55.                     GIMP_PDB_STRING, help_page,
  56.                     GIMP_PDB_END);
  57.  
  58.   success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;
  59.  
  60.   gimp_destroy_params (return_vals, nreturn_vals);
  61.  
  62.   return success;
  63. }
  64.