grid.pdb 8.19 KB
Newer Older
1
# GIMP - The GNU Image Manipulation Program
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# 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.

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

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

26
    &sylvain_pdb_misc('2005', '2.4');
27 28

    @inargs = (
29 30
	{ name => 'image', type => 'image',
	  desc => 'The image' }
31 32 33
    );

    @outargs = (
34 35 36 37
        { 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" }
38 39 40
    );

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

45
  if (grid)
46 47 48 49
    g_object_get (grid,
                  "xspacing", &xspacing,
                  "yspacing", &yspacing,
                  NULL);
50 51 52 53 54 55 56
  else
    success = FALSE;
}
CODE
    );
}

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

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

64
    &sylvain_pdb_misc('2005', '2.4');
65 66

    @inargs = (
67 68 69 70 71 72
	{ 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" }
73 74 75 76 77
    );

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

80
  if (grid)
81
    g_object_set (grid,
82 83
                  "xspacing", xspacing,
                  "yspacing", yspacing,
84
                  NULL);
85 86 87 88 89 90 91
  else
    success = FALSE;
}
CODE
    );
}

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

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

100
    &sylvain_pdb_misc('2005', '2.4');
101 102

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

107
    @outargs = (
108 109 110 111
        { 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" }
112 113 114
    );

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

119
  if (grid)
120 121 122 123
    g_object_get (grid,
                  "xoffset", &xoffset,
                  "yoffset", &yoffset,
                  NULL);
124 125 126 127 128 129 130
  else
    success = FALSE;
}
CODE
    );
}

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

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

138
    &sylvain_pdb_misc('2005', '2.4');
139 140

    @inargs = (
141 142 143 144 145 146
	{ 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" }
147 148 149 150 151
    );

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

154 155
  if (grid)
    g_object_set (grid,
156 157
                  "xoffset", xoffset,
                  "yoffset", yoffset,
158 159 160 161 162 163 164 165
                  NULL);
  else
    success = FALSE;
}
CODE
    );
}

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

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

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

175 176 177 178
    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' }
    );
179

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

185 186 187 188 189 190 191 192 193 194 195 196
    %invoke = (
	code => <<'CODE'
{
  GimpGrid *grid = gimp_image_get_grid (image);

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

sub image_grid_set_foreground_color {
200 201 202 203 204 205 206 207 208 209 210
    $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' },
211
        { name => 'fgcolor', type => 'color', has_alpha => 1,
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
          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
    );
227 228 229
}

sub image_grid_get_background_color {
230 231 232 233 234 235 236 237 238 239 240 241 242 243
    $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 = (
244
        { name => 'bgcolor', type => 'color', has_alpha => 1, void_ret => 1,
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
          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
    );
260 261 262
}

sub image_grid_set_background_color {
263 264 265 266 267 268 269 270 271 272 273
    $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' },
274
        { name => 'bgcolor', type => 'color', has_alpha => 1,
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
          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
    );
290 291 292 293 294 295 296 297 298
}

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

299
    &sylvain_pdb_misc('2005', '2.4');
300 301

    @inargs = (
302 303
	{ name => 'image', type => 'image',
	  desc => 'The image' }
304 305 306
    );

    @outargs = (
307
        { name => 'style', type => 'enum GimpGridStyle',
308
          desc => "The image's grid style" }
309 310 311 312 313
    );

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

316
  if (grid)
317
    g_object_get (grid, "style", &style, NULL);
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
  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

333
    &sylvain_pdb_misc('2005', '2.4');
334 335

    @inargs = (
336 337
	{ name => 'image', type => 'image',
	  desc => 'The image' },
338
        { name => 'style', type => 'enum GimpGridStyle',
339
          desc => "The image's grid style" }
340 341 342 343 344
    );

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

347
  if (grid)
348
    g_object_set (grid, "style", style, NULL);
349 350 351 352 353 354 355 356
  else
    success = FALSE;
}
CODE
    );
}


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

360 361 362 363 364
@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);
365 366 367 368 369 370

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

$desc = 'Image grid procedures';

1;