gimp/pdb/groups/brushes.pdb

# 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 <https://www.gnu.org/licenses/>.

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

sub brushes_refresh {
    $blurb = 'Refresh current brushes. This function always succeeds.';

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

    &seth_pdb_misc('1997');

    %invoke = (
	code => <<'CODE'
{
  gimp_data_factory_data_refresh (gimp->brush_factory, context);
}
CODE
    );
}

sub brushes_get_list {
    $blurb = 'Retrieve a complete listing of the available brushes.';

    $help = <<'HELP';
This procedure returns a complete listing of available GIMP
brushes. Each name returned can be used as input to the
gimp_context_set_brush() procedure.
HELP

    &std_pdb_misc;

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

    @outargs = (
	{ name => 'brush_list', type => 'stringarray',
	  desc => 'The list of brush names',
	  array => { name => 'num_brushes',
		     desc => 'The number of brushes in the brush list' } }
    );

    %invoke = (
        headers => [ qw("core/gimpcontainer-filter.h") ],
	code    => <<'CODE'
{
  brush_list = gimp_container_get_filtered_name_array (gimp_data_factory_get_container (gimp->brush_factory),
                                                       filter, &num_brushes);
}
CODE
    );
}

@headers = qw(<string.h>
              "core/gimp.h"
              "core/gimpbrush.h"
              "core/gimpcontext.h"
              "core/gimpdatafactory.h"
              "core/gimptempbuf.h"
              "gimppdb-utils.h");

@procs = qw(brushes_refresh
            brushes_get_list);

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

$desc = 'Brushes';
$doc_title = 'gimpbrushes';
$doc_short_desc = 'Functions for manipulating brushes.';
$doc_long_desc = 'Functions related to getting and setting brushes.';

1;