2006-12-10 05:33:38 +08:00
|
|
|
# GIMP - The GNU Image Manipulation Program
|
1998-10-24 13:21:56 +08:00
|
|
|
# Copyright (C) 1995 Spencer Kimball and Peter Mattis
|
|
|
|
|
2009-01-18 06:28:01 +08:00
|
|
|
# This program is free software: you can redistribute it and/or modify
|
1998-10-24 13:21:56 +08:00
|
|
|
# it under the terms of the GNU General Public License as published by
|
2009-01-18 06:28:01 +08:00
|
|
|
# the Free Software Foundation; either version 3 of the License, or
|
1998-10-24 13:21:56 +08:00
|
|
|
# (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
|
2018-07-12 05:27:07 +08:00
|
|
|
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
1998-10-24 13:21:56 +08:00
|
|
|
|
|
|
|
# "Perlized" from C source by Manish Singh <yosh@gimp.org>
|
|
|
|
|
2019-08-29 17:25:35 +08:00
|
|
|
sub display_id_is_valid {
|
|
|
|
$blurb = 'Returns TRUE if the display ID is valid.';
|
2007-01-13 03:59:36 +08:00
|
|
|
|
|
|
|
$help = <<'HELP';
|
|
|
|
This procedure checks if the given display ID is valid and refers to an
|
|
|
|
existing display.
|
|
|
|
HELP
|
|
|
|
|
2019-08-29 17:25:35 +08:00
|
|
|
&neo_pdb_misc('2007', '3.0');
|
2007-01-13 03:59:36 +08:00
|
|
|
|
|
|
|
@inargs = (
|
2019-08-29 17:25:35 +08:00
|
|
|
{ name => 'display_id', type => 'int32',
|
|
|
|
desc => 'The display ID to check' }
|
2007-01-13 03:59:36 +08:00
|
|
|
);
|
|
|
|
|
|
|
|
@outargs = (
|
|
|
|
{ name => 'valid', type => 'boolean',
|
|
|
|
desc => 'Whether the display ID is valid' }
|
|
|
|
);
|
|
|
|
|
|
|
|
%invoke = (
|
|
|
|
code => <<'CODE'
|
|
|
|
{
|
2019-09-04 20:27:18 +08:00
|
|
|
valid = (gimp_display_get_by_id (gimp, display_id) != NULL);
|
2007-01-13 03:59:36 +08:00
|
|
|
}
|
|
|
|
CODE
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
1998-10-24 13:21:56 +08:00
|
|
|
sub display_new {
|
|
|
|
$blurb = 'Create a new display for the specified image.';
|
|
|
|
|
|
|
|
$help = <<'HELP';
|
|
|
|
Creates a new display for the specified image. If the image already has a
|
2007-06-06 16:44:52 +08:00
|
|
|
display, another is added. Multiple displays are handled transparently by
|
1998-10-24 13:21:56 +08:00
|
|
|
GIMP. The newly created display is returned and can be subsequently destroyed
|
2006-06-14 16:32:08 +08:00
|
|
|
with a call to gimp_display_delete(). This procedure only makes sense for use
|
2014-05-27 07:55:36 +08:00
|
|
|
with the GIMP UI, and will result in an execution error if called when
|
|
|
|
GIMP has no UI.
|
1998-10-24 13:21:56 +08:00
|
|
|
HELP
|
|
|
|
|
|
|
|
&std_pdb_misc;
|
|
|
|
|
2006-03-22 17:58:08 +08:00
|
|
|
@inargs = (
|
2006-03-24 05:17:16 +08:00
|
|
|
{ name => 'image', type => 'image',
|
|
|
|
desc => 'The image' }
|
2006-03-22 17:58:08 +08:00
|
|
|
);
|
1998-10-24 13:21:56 +08:00
|
|
|
|
|
|
|
@outargs = (
|
|
|
|
{ name => 'display', type => 'display',
|
2006-03-15 23:32:39 +08:00
|
|
|
desc => 'The new display' }
|
1998-10-24 13:21:56 +08:00
|
|
|
);
|
|
|
|
|
|
|
|
%invoke = (
|
|
|
|
code => <<'CODE'
|
|
|
|
{
|
2007-09-25 19:25:05 +08:00
|
|
|
gimp_image_flush (image);
|
|
|
|
|
2018-04-29 23:27:47 +08:00
|
|
|
display = gimp_create_display (gimp, image, GIMP_UNIT_PIXEL, 1.0, NULL);
|
2001-11-01 05:20:46 +08:00
|
|
|
|
2006-03-23 01:19:14 +08:00
|
|
|
if (display)
|
|
|
|
{
|
|
|
|
/* the first display takes ownership of the image */
|
2010-02-04 04:20:29 +08:00
|
|
|
if (gimp_image_get_display_count (image) == 1)
|
2006-03-24 05:17:16 +08:00
|
|
|
g_object_unref (image);
|
2006-03-23 01:19:14 +08:00
|
|
|
}
|
|
|
|
else
|
2008-02-21 21:43:10 +08:00
|
|
|
{
|
|
|
|
success = FALSE;
|
|
|
|
}
|
1998-10-24 13:21:56 +08:00
|
|
|
}
|
|
|
|
CODE
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
sub display_delete {
|
1999-03-20 07:04:16 +08:00
|
|
|
$blurb = 'Delete the specified display.';
|
1998-10-24 13:21:56 +08:00
|
|
|
|
|
|
|
$help = <<'HELP';
|
|
|
|
This procedure removes the specified display. If this is the last remaining
|
2007-04-13 00:32:20 +08:00
|
|
|
display for the underlying image, then the image is deleted also. Note that
|
|
|
|
the display is closed no matter if the image is dirty or not. Better save
|
|
|
|
the image before calling this procedure.
|
1998-10-24 13:21:56 +08:00
|
|
|
HELP
|
|
|
|
|
|
|
|
&std_pdb_misc;
|
|
|
|
|
|
|
|
@inargs = (
|
|
|
|
{ name => 'display', type => 'display',
|
2003-12-08 20:28:29 +08:00
|
|
|
desc => 'The display to delete' }
|
1998-10-24 13:21:56 +08:00
|
|
|
);
|
|
|
|
|
2006-03-25 05:57:47 +08:00
|
|
|
%invoke = (
|
|
|
|
code => <<'CODE'
|
2006-03-22 17:58:08 +08:00
|
|
|
{
|
|
|
|
gimp_delete_display (gimp, display);
|
|
|
|
}
|
|
|
|
CODE
|
|
|
|
);
|
1998-10-24 13:21:56 +08:00
|
|
|
}
|
|
|
|
|
2021-04-30 09:39:23 +08:00
|
|
|
sub display_present {
|
|
|
|
$blurb = 'Present the specified display.';
|
|
|
|
|
|
|
|
$help = <<'HELP';
|
|
|
|
This procedure presents the specified display at the top of the display stack.
|
|
|
|
HELP
|
|
|
|
|
|
|
|
&jehan_pdb_misc('2021', '3.0');
|
|
|
|
|
|
|
|
@inargs = (
|
|
|
|
{ name => 'display', type => 'display',
|
|
|
|
desc => 'The display to present' }
|
|
|
|
);
|
|
|
|
|
|
|
|
%invoke = (
|
|
|
|
code => <<'CODE'
|
|
|
|
{
|
|
|
|
gimp_display_present (display);
|
|
|
|
}
|
|
|
|
CODE
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2005-09-06 04:47:12 +08:00
|
|
|
sub display_get_window_handle {
|
|
|
|
$blurb = 'Get a handle to the native window for an image display.';
|
|
|
|
|
|
|
|
$help = <<'HELP';
|
|
|
|
This procedure returns a handle to the native window for a given image
|
|
|
|
display. For example in the X backend of GDK, a native window handle is
|
|
|
|
an Xlib XID. A value of 0 is returned for an invalid display or if this
|
|
|
|
function is unimplemented for the windowing system that is being used.
|
|
|
|
HELP
|
|
|
|
|
2006-03-15 05:35:50 +08:00
|
|
|
&neo_pdb_misc('2005', '2.4');
|
2005-09-06 04:47:12 +08:00
|
|
|
|
|
|
|
@inargs = (
|
|
|
|
{ name => 'display', type => 'display',
|
|
|
|
desc => 'The display to get the window handle from' }
|
|
|
|
);
|
|
|
|
|
|
|
|
@outargs = (
|
|
|
|
{ name => 'window', type => 'int32',
|
2006-03-15 23:32:39 +08:00
|
|
|
desc => 'The native window handle or 0' }
|
2005-09-06 04:47:12 +08:00
|
|
|
);
|
|
|
|
|
2006-03-25 05:57:47 +08:00
|
|
|
%invoke = (
|
|
|
|
code => <<'CODE'
|
2006-03-22 17:58:08 +08:00
|
|
|
{
|
2011-02-06 19:07:55 +08:00
|
|
|
window = (gint32) gimp_get_display_window_id (gimp, display);
|
2006-03-22 17:58:08 +08:00
|
|
|
}
|
|
|
|
CODE
|
|
|
|
);
|
2005-09-06 04:47:12 +08:00
|
|
|
}
|
|
|
|
|
1998-10-24 13:21:56 +08:00
|
|
|
sub displays_flush {
|
|
|
|
$blurb = 'Flush all internal changes to the user interface';
|
|
|
|
|
|
|
|
$help = <<'HELP';
|
|
|
|
This procedure takes no arguments and returns nothing except a success status.
|
|
|
|
Its purpose is to flush all pending updates of image manipulations to the user
|
|
|
|
interface. It should be called whenever appropriate.
|
|
|
|
HELP
|
|
|
|
|
|
|
|
&std_pdb_misc;
|
|
|
|
|
2003-10-06 20:17:11 +08:00
|
|
|
%invoke = (
|
|
|
|
headers => [ qw("core/gimpcontainer.h") ],
|
2006-03-22 17:58:08 +08:00
|
|
|
code => <<'CODE'
|
|
|
|
|
|
|
|
{
|
|
|
|
gimp_container_foreach (gimp->images, (GFunc) gimp_image_flush, NULL);
|
|
|
|
}
|
|
|
|
CODE
|
2003-10-06 20:17:11 +08:00
|
|
|
);
|
1998-10-24 13:21:56 +08:00
|
|
|
}
|
|
|
|
|
2002-12-03 20:10:21 +08:00
|
|
|
sub displays_reconnect {
|
|
|
|
$blurb = 'Reconnect displays from one image to another image.';
|
|
|
|
|
|
|
|
$help = <<'HELP';
|
2004-11-30 00:59:53 +08:00
|
|
|
This procedure connects all displays of the old_image to the
|
|
|
|
new_image. If the old_image has no display or new_image already has a
|
|
|
|
display the reconnect is not performed and the procedure returns
|
|
|
|
without success. You should rarely need to use this function.
|
2002-12-03 20:10:21 +08:00
|
|
|
HELP
|
|
|
|
|
|
|
|
&std_pdb_misc;
|
|
|
|
|
|
|
|
@inargs = (
|
|
|
|
{ name => 'old_image', type => 'image',
|
2004-11-30 00:59:53 +08:00
|
|
|
desc => 'The old image (must have at least one display)' },
|
2002-12-03 20:10:21 +08:00
|
|
|
{ name => 'new_image', type => 'image',
|
2003-12-08 20:28:29 +08:00
|
|
|
desc => 'The new image (must not have a display)' }
|
2002-12-03 20:10:21 +08:00
|
|
|
);
|
|
|
|
|
2006-03-25 05:57:47 +08:00
|
|
|
%invoke = (
|
|
|
|
code => <<'CODE'
|
2004-11-30 00:59:53 +08:00
|
|
|
{
|
|
|
|
success = (old_image != new_image &&
|
2010-02-04 04:20:29 +08:00
|
|
|
gimp_image_get_display_count (old_image) > 0 &&
|
|
|
|
gimp_image_get_display_count (new_image) == 0);
|
2004-11-30 00:59:53 +08:00
|
|
|
|
|
|
|
if (success)
|
|
|
|
{
|
|
|
|
gimp_reconnect_displays (gimp, old_image, new_image);
|
|
|
|
|
|
|
|
/* take ownership of the image */
|
2010-02-04 04:20:29 +08:00
|
|
|
if (gimp_image_get_display_count (new_image) > 0)
|
2004-11-30 00:59:53 +08:00
|
|
|
g_object_unref (new_image);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
CODE
|
|
|
|
);
|
2002-12-03 20:10:21 +08:00
|
|
|
}
|
|
|
|
|
2006-03-24 05:17:16 +08:00
|
|
|
|
2019-09-04 20:27:18 +08:00
|
|
|
@headers = qw("core/gimp.h"
|
|
|
|
"core/gimpdisplay.h");
|
1999-03-28 14:36:11 +08:00
|
|
|
|
2019-08-29 17:25:35 +08:00
|
|
|
@procs = qw(display_id_is_valid
|
2008-02-08 01:08:54 +08:00
|
|
|
display_new
|
|
|
|
display_delete
|
2007-01-13 03:59:36 +08:00
|
|
|
display_get_window_handle
|
2021-04-30 09:39:23 +08:00
|
|
|
display_present
|
|
|
|
displays_flush
|
2008-02-08 01:08:54 +08:00
|
|
|
displays_reconnect);
|
2006-03-24 05:17:16 +08:00
|
|
|
|
1998-10-24 13:21:56 +08:00
|
|
|
%exports = (app => [@procs], lib => [@procs]);
|
|
|
|
|
2002-12-04 07:00:42 +08:00
|
|
|
$desc = 'Display procedures';
|
2010-07-07 17:43:10 +08:00
|
|
|
$doc_title = 'gimpdisplay';
|
|
|
|
$doc_short_desc = 'Functions to create, delete and flush displays (views) on an image.';
|
|
|
|
$doc_long_desc = 'Functions to create, delete and flush displays (views) on an image.';
|
1998-10-24 13:21:56 +08:00
|
|
|
|
|
|
|
1;
|