gimp/tools/pdbgen/pdb/floating_sel.pdb

# 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 Manish Singh <yosh@gimp.org>

sub inargs {
    @inargs = (
	{ name => 'floating_sel', type => 'layer',
	  desc => 'The floating selection' }
    );
}

sub invoke {
    my @subname = split /::/, (caller 1)[3];
    my $cmd = pop @subname;
    %invoke = (
	headers => [ qw("core/gimplayer-floating-sel.h") ],
	code => <<CODE
{
  if (gimp_layer_is_floating_sel (floating_sel))
    $cmd (floating_sel);
  else
    success = FALSE;
}
CODE
    );
}

sub floating_sel_remove {
    $blurb = <<'BLURB';
Remove the specified floating selection from its associated drawable.
BLURB

    $help = <<'HELP';
This procedure removes the floating selection completely, without any side
effects. The associated drawable is then set to active.
HELP

    &std_pdb_misc;
    &inargs;
    &invoke;
}

sub floating_sel_anchor {
    $blurb = <<'BLURB';
Anchor the specified floating selection to its associated drawable.
BLURB

    $help = <<'HELP';
This procedure anchors the floating selection to its associated drawable. This 
is similar to merging with a merge type of ClipToBottomLayer.  The floating
selection layer is no longer valid after this operation.
HELP

    &std_pdb_misc;
    &inargs;
    &invoke;
}

sub floating_sel_to_layer {
    $blurb = 'Transforms the specified floating selection into a layer.';

    $help = <<'HELP';
This procedure transforms the specified floating selection into a layer with
the same offsets and extents. The composited image will look precisely the
same, but the floating selection layer will no longer be clipped to the extents
of the drawable it was attached to. The floating selection will become the
active layer. This procedure will not work if the floating selection has a
different base type from the underlying image. This might be the case if the
floating selection is above an auxillary channel or a layer mask.
HELP

    &std_pdb_misc;
    &inargs;
    &invoke;
}

sub floating_sel_attach {
    $blurb = <<'BLURB';
Attach the specified layer as floating to the specified drawable.
BLURB

    $help = <<'HELP';
This procedure attaches the layer as floating selection to the drawable.
HELP

    &std_pdb_misc;

    @inargs = (
	{ name => 'layer', type => 'layer',
	  desc => 'The layer (is attached as floating selection)' },
	{ name => 'drawable', type => 'drawable',
	  desc => 'The drawable (where to attach the floating selection)' }
    );

    %invoke = (
	headers => [ qw("core/gimplayer-floating-sel.h") ],
	code => <<CODE
{
  success = gimp_item_is_attached (GIMP_ITEM (drawable));

  if (success)
    floating_sel_attach (layer, drawable);
}
CODE
    );
}

sub floating_sel_rigor {
    $blurb = 'Rigor the floating selection.';

    $help = <<'HELP';
This procedure rigors the floating selection.
HELP

    &std_pdb_misc;

    &inargs;
    push @inargs, { name => 'undo', type => 'boolean', desc => '%%desc%%' };

    &invoke;
    $invoke{code} =~ s/\(floating_sel\);/(floating_sel, undo);/;
}

sub floating_sel_relax {
    $blurb = 'Relax the floating selection.';

    $help = <<'HELP';
This procedure relaxes the floating selection.
HELP

    &std_pdb_misc;

    &inargs;
    push @inargs, { name => 'undo', type => 'boolean', desc => '%%desc%%' };

    &invoke;
    $invoke{code} =~ s/\(floating_sel\);/(floating_sel, undo);/;
}

@procs = qw(floating_sel_remove floating_sel_anchor floating_sel_to_layer
	    floating_sel_attach floating_sel_rigor floating_sel_relax);
%exports = (app => [@procs], lib => [@procs]);

$desc = 'Floating selections';

1;