ebcb621c51
2004-01-20 Michael Natterer <mitch@gimp.org> * tools/pdbgen/pdb/help.pdb: changed "prog_name" parameter of gimp_help() to "help_domain". It's useless to pass the plug-in's executable name to the core because the core already knows it. Instead, enabled accessing arbitrary help domains via the PDB. Passing NULL as help_domain will use the domain the plug-in registered, or the GIMP main help domain if it didn't register a domain. * app/pdb/help_cmds.c * libgimp/gimphelp_pdb.[ch]: regenerated. * libgimp/gimpui.c (gimp_ui_help_func): pass NULL as help_domain.
63 lines
2 KiB
Text
63 lines
2 KiB
Text
# The GIMP -- an image manipulation program
|
|
# Copyright (C) 1995 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.
|
|
|
|
# "Perlized" from C source by Sven Neumann <sven@gimp.org>
|
|
|
|
sub help {
|
|
$blurb = "Load a help page.";
|
|
|
|
$help = <<HELP;
|
|
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.
|
|
HELP
|
|
|
|
$author = $copyright = 'Michael Natterer <mitch@gimp.org>';
|
|
$date = '2000';
|
|
|
|
@inargs = (
|
|
{ name => 'help_domain', type => 'string', null_ok => 1,
|
|
desc => "The help domain in which help_id is registered" },
|
|
{ name => 'help_id', type => 'string',
|
|
desc => 'The help page\'s ID' }
|
|
);
|
|
|
|
%invoke = (
|
|
code => <<CODE
|
|
{
|
|
if (! help_domain && gimp->current_plug_in)
|
|
help_domain = (gchar *)
|
|
plug_ins_help_domain (gimp, gimp->current_plug_in->prog, NULL);
|
|
|
|
gimp_help (gimp, help_domain, help_id);
|
|
}
|
|
CODE
|
|
);
|
|
}
|
|
|
|
@headers = qw("core/gimp.h" "plug-in/plug-in.h" "plug-in/plug-ins.h"
|
|
"widgets/gimphelp.h");
|
|
|
|
@procs = qw(help);
|
|
%exports = (app => [@procs], lib => [@procs]);
|
|
|
|
$desc = 'Help procedures';
|
|
|
|
1;
|