Gimp/tools/pdbgen/pdb/misc.pdb
Michael Natterer 3a2cd14382 tools: add pdbgen support for generating gtk-doc SECTION comments
Add the new $doc_title, $doc_short_desc and $doc_long_desc strings to
all .pdb files.
2010-07-07 11:43:10 +02:00

106 lines
2.4 KiB
Text

# GIMP - The GNU 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 3 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, see <http://www.gnu.org/licenses/>.
# "Perlized" from C source by Manish Singh <yosh@gimp.org>
sub version {
$blurb = 'Returns the host GIMP version.';
$help = <<'HELP';
This procedure returns the version number of the currently running GIMP.
HELP
&yosh_pdb_misc('1999');
@outargs = (
{ name => 'version', type => 'string',
desc => 'GIMP version number' }
);
%invoke = (
headers => [ qw("libgimpbase/gimpbase.h") ],
code => <<'CODE'
{
version = g_strdup (GIMP_VERSION);
}
CODE
);
}
sub getpid {
$blurb = 'Returns the PID of the host GIMP process.';
$help = <<'HELP';
This procedure returns the process ID of the currently running GIMP.
HELP
&mitch_pdb_misc('2005', '2.4');
@outargs = (
{ name => 'pid', type => 'int32',
desc => 'The PID' }
);
%invoke = (
headers => [ qw("base/base-utils.h") ],
code => <<'CODE'
{
pid = get_pid ();
}
CODE
);
}
sub quit {
$blurb = 'Causes GIMP to exit gracefully.';
$help = <<'HELP';
If there are unsaved images in an interactive GIMP session, the user
will be asked for confirmation. If force is TRUE, the application is
quit without querying the user to save any dirty images.
HELP
&std_pdb_misc;
@inargs = (
{ name => 'force', type => 'boolean',
desc => 'Force GIMP to quit without asking' }
);
%invoke = (
code => <<'CODE'
{
gimp_exit (gimp, force);
}
CODE
);
}
@headers = qw("core/gimp.h");
@procs = qw(version
getpid
quit);
%exports = (app => [@procs], lib => [@procs[0..1]]);
$desc = 'Miscellaneous';
$doc_title = 'gimpmisc';
$doc_short_desc = 'Miscellaneous procedures';
$doc_long_desc = 'Miscellaneous procedures not fitting in any category.';
1;