gimpimageguides_pdb.c 7.02 KB
Newer Older
1
/* LIBGIMP - The GIMP Library
2
 * Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
3
 *
4
 * gimpimageguides_pdb.c
5
 *
6
 * This library is free software: you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
9
 * version 3 of the License, or (at your option) any later version.
10 11 12 13
 *
 * This library 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
14
 * Lesser General Public License for more details.
15 16
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with this library.  If not, see
18
 * <https://www.gnu.org/licenses/>.
19 20
 */

21
/* NOTE: This file is auto-generated by pdbgen.pl */
22

Sven Neumann's avatar
Sven Neumann committed
23 24
#include "config.h"

25
#include "gimp.h"
26

27 28

/**
29 30 31
 * SECTION: gimpimageguides
 * @title: gimpimageguides
 * @short_description: Functions for manipulating an image's guides.
32
 *
33
 * Functions for manipulating an image's guides.
34 35 36
 **/


37 38 39 40 41 42 43 44 45 46 47 48
/**
 * gimp_image_add_hguide:
 * @image_ID: The image.
 * @yposition: The guide's y-offset from top of image.
 *
 * Add a horizontal guide to an image.
 *
 * This procedure adds a horizontal guide to an image. It takes the
 * input image and the y-position of the new guide as parameters. It
 * returns the guide ID of the new guide.
 *
 * Returns: The new guide.
49
 **/
50 51
gint32
gimp_image_add_hguide (gint32 image_ID,
52
                       gint   yposition)
53
{
54
  GimpParam *return_vals;
55
  gint nreturn_vals;
56
  gint32 guide_ID = -1;
57

58
  return_vals = gimp_run_procedure ("gimp-image-add-hguide",
59 60 61 62
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, yposition,
                                    GIMP_PDB_END);
63

64
  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
65 66 67 68 69 70 71
    guide_ID = return_vals[1].data.d_int32;

  gimp_destroy_params (return_vals, nreturn_vals);

  return guide_ID;
}

72 73 74 75 76 77 78 79 80 81 82 83
/**
 * gimp_image_add_vguide:
 * @image_ID: The image.
 * @xposition: The guide's x-offset from left of image.
 *
 * Add a vertical guide to an image.
 *
 * This procedure adds a vertical guide to an image. It takes the input
 * image and the x-position of the new guide as parameters. It returns
 * the guide ID of the new guide.
 *
 * Returns: The new guide.
84
 **/
85 86
gint32
gimp_image_add_vguide (gint32 image_ID,
87
                       gint   xposition)
88
{
89
  GimpParam *return_vals;
90
  gint nreturn_vals;
91
  gint32 guide_ID = -1;
92

93
  return_vals = gimp_run_procedure ("gimp-image-add-vguide",
94 95 96 97
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, xposition,
                                    GIMP_PDB_END);
98

99
  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
100 101 102 103 104 105 106
    guide_ID = return_vals[1].data.d_int32;

  gimp_destroy_params (return_vals, nreturn_vals);

  return guide_ID;
}

107 108 109 110 111 112 113 114 115 116 117
/**
 * gimp_image_delete_guide:
 * @image_ID: The image.
 * @guide_ID: The ID of the guide to be removed.
 *
 * Deletes a guide from an image.
 *
 * This procedure takes an image and a guide ID as input and removes
 * the specified guide from the specified image.
 *
 * Returns: TRUE on success.
118
 **/
119
gboolean
120
gimp_image_delete_guide (gint32 image_ID,
121
                         gint32 guide_ID)
122
{
123
  GimpParam *return_vals;
124
  gint nreturn_vals;
125
  gboolean success = TRUE;
126

127
  return_vals = gimp_run_procedure ("gimp-image-delete-guide",
128 129 130 131
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, guide_ID,
                                    GIMP_PDB_END);
132

133 134
  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

135
  gimp_destroy_params (return_vals, nreturn_vals);
136 137

  return success;
138 139
}

140 141 142 143 144 145 146 147 148 149 150 151 152 153
/**
 * gimp_image_find_next_guide:
 * @image_ID: The image.
 * @guide_ID: The ID of the current guide (0 if first invocation).
 *
 * Find next guide on an image.
 *
 * This procedure takes an image and a guide ID as input and finds the
 * guide ID of the successor of the given guide ID in the image's guide
 * list. If the supplied guide ID is 0, the procedure will return the
 * first Guide. The procedure will return 0 if given the final guide ID
 * as an argument or the image has no guides.
 *
 * Returns: The next guide's ID.
154
 **/
155 156
gint32
gimp_image_find_next_guide (gint32 image_ID,
157
                            gint32 guide_ID)
158
{
159
  GimpParam *return_vals;
160
  gint nreturn_vals;
161
  gint32 next_guide_ID = -1;
162

163
  return_vals = gimp_run_procedure ("gimp-image-find-next-guide",
164 165 166 167
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, guide_ID,
                                    GIMP_PDB_END);
168

169
  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
170
    next_guide_ID = return_vals[1].data.d_int32;
171 172 173

  gimp_destroy_params (return_vals, nreturn_vals);

174
  return next_guide_ID;
175 176
}

177 178 179 180 181 182 183 184 185 186 187
/**
 * gimp_image_get_guide_orientation:
 * @image_ID: The image.
 * @guide_ID: The guide.
 *
 * Get orientation of a guide on an image.
 *
 * This procedure takes an image and a guide ID as input and returns
 * the orientations of the guide.
 *
 * Returns: The guide's orientation.
188
 **/
189
GimpOrientationType
190
gimp_image_get_guide_orientation (gint32 image_ID,
191
                                  gint32 guide_ID)
192
{
193
  GimpParam *return_vals;
194
  gint nreturn_vals;
195
  GimpOrientationType orientation = GIMP_ORIENTATION_UNKNOWN;
196

197
  return_vals = gimp_run_procedure ("gimp-image-get-guide-orientation",
198 199 200 201
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, guide_ID,
                                    GIMP_PDB_END);
202

203
  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
204
    orientation = return_vals[1].data.d_int32;
205 206 207

  gimp_destroy_params (return_vals, nreturn_vals);

208
  return orientation;
209 210
}

211 212 213 214 215 216 217 218 219 220 221
/**
 * gimp_image_get_guide_position:
 * @image_ID: The image.
 * @guide_ID: The guide.
 *
 * Get position of a guide on an image.
 *
 * This procedure takes an image and a guide ID as input and returns
 * the position of the guide relative to the top or left of the image.
 *
 * Returns: The guide's position relative to top or left of image.
222
 **/
223
gint
224
gimp_image_get_guide_position (gint32 image_ID,
225
                               gint32 guide_ID)
226
{
227
  GimpParam *return_vals;
228
  gint nreturn_vals;
Michael Natterer's avatar
Michael Natterer committed
229
  gint position = G_MININT /* GIMP_GUIDE_POSITION_UNDEFINED */;
230

231
  return_vals = gimp_run_procedure ("gimp-image-get-guide-position",
232 233 234 235
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, guide_ID,
                                    GIMP_PDB_END);
236

237
  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
238
    position = return_vals[1].data.d_int32;
239 240 241

  gimp_destroy_params (return_vals, nreturn_vals);

242
  return position;
243
}