summaryrefslogtreecommitdiffstats
path: root/pdb/groups/image_grid.pdb
blob: ae5e9bfd7ada8cbb0254fc7c3ff7d76b83c353f1 (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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
# 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/>.

sub image_grid_get_spacing {
    $blurb = "Gets the spacing of an image's grid.";

    $help = <<HELP;
This procedure retrieves the horizontal and vertical spacing of an image's grid.
It takes the image as parameter.
HELP

    &sylvain_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' }
    );

    @outargs = (
        { name => 'xspacing', type => 'float', void_ret => 1,
          desc => "The image's grid horizontal spacing" },
        { name => 'yspacing', type => 'float', void_ret => 1,
          desc => "The image's grid vertical spacing" }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpGrid *grid = gimp_image_get_grid (image);

  if (grid)
    g_object_get (grid,
                  "xspacing", &xspacing,
                  "yspacing", &yspacing,
                  NULL);
  else
    success = FALSE;
}
CODE
    );
}

sub image_grid_set_spacing {
    $blurb = "Sets the spacing of an image's grid.";

    $help = <<HELP;
This procedure sets the horizontal and vertical spacing of an image's grid.
HELP

    &sylvain_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' },
        { name => 'xspacing', type => 'float',
          desc => "The image's grid horizontal spacing" },
        { name => 'yspacing', type => 'float',
          desc => "The image's grid vertical spacing" }
    );

    %invoke = (
	code => <<CODE
{
  GimpGrid *grid = gimp_image_get_grid (image);

  if (grid)
    g_object_set (grid,
                  "xspacing", xspacing,
                  "yspacing", yspacing,
                  NULL);
  else
    success = FALSE;
}
CODE
    );
}

sub image_grid_get_offset {
    $blurb = "Gets the offset of an image's grid.";

    $help = <<HELP;
This procedure retrieves the horizontal and vertical offset of an image's grid.
It takes the image as parameter.
HELP

    &sylvain_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' }
    );

    @outargs = (
        { name => 'xoffset', type => 'float', void_ret => 1,
          desc => "The image's grid horizontal offset" },
        { name => 'yoffset', type => 'float', void_ret => 1,
          desc => "The image's grid vertical offset" }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpGrid *grid = gimp_image_get_grid (image);

  if (grid)
    g_object_get (grid,
                  "xoffset", &xoffset,
                  "yoffset", &yoffset,
                  NULL);
  else
    success = FALSE;
}
CODE
    );
}

sub image_grid_set_offset {
    $blurb = "Sets the offset of an image's grid.";

    $help = <<HELP;
This procedure sets the horizontal and vertical offset of an image's grid.
HELP

    &sylvain_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' },
        { name => 'xoffset', type => 'float',
          desc => "The image's grid horizontal offset" },
        { name => 'yoffset', type => 'float',
          desc => "The image's grid vertical offset" }
    );

    %invoke = (
	code => <<CODE
{
  GimpGrid *grid = gimp_image_get_grid (image);

  if (grid)
    g_object_set (grid,
                  "xoffset", xoffset,
                  "yoffset", yoffset,
                  NULL);
  else
    success = FALSE;
}
CODE
    );
}

sub image_grid_get_foreground_color {
    $blurb = "Sets the foreground color of an image's grid.";

    $help = <<HELP;
This procedure gets the foreground color of an image's grid.
HELP

    &sylvain_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' }
    );

    @outargs = (
        { name => 'fgcolor', type => 'color', has_alpha => 1, void_ret => 1,
          desc => "The image's grid foreground color" }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpGrid *grid = gimp_image_get_grid (image);

  if (grid)
    fgcolor = grid->fgcolor;
  else
    success = FALSE;
}
CODE
    );
}

sub image_grid_set_foreground_color {
    $blurb = "Gets the foreground color of an image's grid.";

    $help = <<HELP;
This procedure sets the foreground color of an image's grid.
HELP

    &sylvain_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' },
        { name => 'fgcolor', type => 'color', has_alpha => 1,
          desc => "The new foreground color" }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpGrid *grid = gimp_image_get_grid (image);

  if (grid)
    g_object_set (grid, "fgcolor", &fgcolor, NULL);
  else
    success = FALSE;
}
CODE
    );
}

sub image_grid_get_background_color {
    $blurb = "Sets the background color of an image's grid.";

    $help = <<HELP;
This procedure gets the background color of an image's grid.
HELP

    &sylvain_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' }
    );

    @outargs = (
        { name => 'bgcolor', type => 'color', has_alpha => 1, void_ret => 1,
          desc => "The image's grid background color" }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpGrid *grid = gimp_image_get_grid (image);

  if (grid)
    bgcolor = grid->bgcolor;
  else
    success = FALSE;
}
CODE
    );
}

sub image_grid_set_background_color {
    $blurb = "Gets the background color of an image's grid.";

    $help = <<HELP;
This procedure sets the background color of an image's grid.
HELP

    &sylvain_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' },
        { name => 'bgcolor', type => 'color', has_alpha => 1,
          desc => "The new background color" }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpGrid *grid = gimp_image_get_grid (image);

  if (grid)
    g_object_set (grid, "bgcolor", &bgcolor, NULL);
  else
    success = FALSE;
}
CODE
    );
}

sub image_grid_get_style {
    $blurb = "Gets the style of an image's grid.";

    $help = <<HELP;
This procedure retrieves the style of an image's grid.
HELP

    &sylvain_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' }
    );

    @outargs = (
        { name => 'style', type => 'enum GimpGridStyle',
          desc => "The image's grid style" }
    );

    %invoke = (
	code => <<CODE
{
  GimpGrid *grid = gimp_image_get_grid (image);

  if (grid)
    g_object_get (grid, "style", &style, NULL);
  else
    success = FALSE;
}
CODE
    );
}

sub image_grid_set_style {
    $blurb = "Sets the style unit of an image's grid.";

    $help = <<HELP;
This procedure sets the style of an image's grid.
It takes the image and the new style as parameters.
HELP

    &sylvain_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' },
        { name => 'style', type => 'enum GimpGridStyle',
          desc => "The image's grid style" }
    );

    %invoke = (
	code => <<CODE
{
  GimpGrid *grid = gimp_image_get_grid (image);

  if (grid)
    g_object_set (grid, "style", style, NULL);
  else
    success = FALSE;
}
CODE
    );
}


@headers = qw("core/gimpimage-grid.h" "core/gimpgrid.h"
              "libgimpbase/gimpbaseenums.h");

@procs = qw(image_grid_get_spacing image_grid_set_spacing
            image_grid_get_offset image_grid_set_offset
            image_grid_get_foreground_color image_grid_set_foreground_color
            image_grid_get_background_color image_grid_set_background_color
            image_grid_get_style image_grid_set_style);

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

$desc = 'Image grid procedures';
$doc_title = 'gimpimagegrid';
$doc_short_desc = "Functions manuipulating an image's grid.";
$doc_long_desc = "Functions manuipulating an image's grid.";

1;