summaryrefslogtreecommitdiffstats
path: root/pdb/groups/palettes.pdb
blob: 4abd0c9e10ff33820f5d1e92d1047314c9458d8d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# 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 palettes_refresh {
    $blurb = 'Refreshes current palettes. This function always succeeds.';

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

    &adrian_pdb_misc('1998');

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

sub palettes_get_list {
    $blurb = 'Retrieves a list of all of the available palettes';

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

    &rock_pdb_misc('2001');

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

    @outargs = (
        { name => 'palette_list', type => 'stringarray',
          desc => 'The list of palette names',
          array => { name => 'num_palettes',
                     desc => 'The number of palettes in the list' } }
    );

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

sub palettes_get_palette {
    &std_pdb_deprecated ('gimp-context-get-palette');

    @outargs = (
	{ name => 'name', type => 'string', null_ok => 1,
	  desc => 'The palette name' },
	{ name => 'num_colors', type => 'int32',
	  desc => 'The palette num_colors' }
    );

    %invoke = (
        code => <<'CODE'
{
  GimpPalette *palette = gimp_context_get_palette (context);

  if (palette)
    {
      name       = g_strdup (gimp_object_get_name (palette));
      num_colors = gimp_palette_get_n_colors (palette);
    }
  else
    success = FALSE;
}
CODE
    );
}

sub palettes_get_palette_entry {
    &std_pdb_deprecated ('gimp-palette-entry-get-color');

    @inargs = (
	{ name => 'name', type => 'string', null_ok => 1,
	  desc => 'The palette name ("" means currently active palette)' },
        { name => 'entry_num', type => 'int32',
          desc => 'The entry to retrieve' }
    );

    @outargs = (
	{ name => 'actual_name', type => 'string',
	  desc => 'The palette name' },
	{ name => 'num_colors', type => 'int32',
	  desc => 'The palette num_colors' },
	{ name => 'color', type => 'color', void_ret => 1,
	  desc => 'The color requested' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette;

  if (name && strlen (name))
    palette = gimp_pdb_get_palette (gimp, name, FALSE, error);
  else
    palette = gimp_context_get_palette (context);

  if (palette)
    {
      GimpPaletteEntry *entry = gimp_palette_get_entry (palette, entry_num);

      if (entry)
        {
          actual_name = g_strdup (gimp_object_get_name (palette));
          num_colors  = gimp_palette_get_n_colors (palette);
          color       = entry->color;
        }
      else
        success = FALSE;
    }
  else
    success = FALSE;
}
CODE
    );
}


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

@procs = qw(palettes_refresh
            palettes_get_list
            palettes_get_palette
            palettes_get_palette_entry);

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

$desc = 'Palettes';
$doc_title = 'gimppalettes';
$doc_short_desc = 'Operations related to palettes.';
$doc_long_desc = 'Operations related to palettes.';

1;