# PIKA - Photo and Image Kooker Application
# 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 <https://www.gnu.org/licenses/>.

# "Perlized" from C source by Manish Singh <yosh@gimp.org>

sub gradients_refresh {
    $blurb = 'Refresh current gradients. This function always succeeds.';

    $help = <<'HELP';
This procedure retrieves all gradients currently in the user's gradient path
and updates the gradient dialogs accordingly.
HELP

    &mitch_pdb_misc('2002');

    %invoke = (
        code => <<'CODE'
{
  pika_data_factory_data_refresh (pika->gradient_factory, context);
}
CODE
    );
}

sub gradients_get_list {
    $blurb = 'Retrieve the list of loaded gradients.';

    $help = <<'HELP';
This procedure returns a list of the gradients that are currently loaded.
You can later use the pika_context_set_gradient() function to
set the active gradient.
HELP

    &federico_pdb_misc('1997');

    @inargs = (
	{ name => 'filter', type => 'string', null_ok => 1,
          desc => 'An optional regular expression used to filter the list' }
    );

    @outargs = (
	{ name => 'gradient_list', type => 'strv',
	  desc => 'The list of gradient names' }
    );

    %invoke = (
        headers => [ qw("core/pikacontainer-filter.h") ],
	code => <<'CODE'
{
  gradient_list = pika_container_get_filtered_name_array (pika_data_factory_get_container (pika->gradient_factory),
                                                          filter);
}
CODE
    );
}


@headers = qw(<string.h>
              "core/pika.h"
              "core/pikacontext.h"
              "core/pikadatafactory.h"
              "core/pikagradient.h"
              "pikapdb-utils.h");

@procs = qw(gradients_refresh
            gradients_get_list);

%exports = (app => [@procs], lib => [@procs]);

$desc = 'Gradients';
$doc_title = 'pikagradients';
$doc_short_desc = 'Operations related to gradients.';
$doc_long_desc = 'Operations related to gradients.';

1;