gimptexttool_pdb.c 10.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-2000 Peter Mattis and Spencer Kimball
 *
 * gimptexttool_pdb.c
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/* NOTE: This file is autogenerated by pdbgen.pl */

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

26 27
#include "gimp.h"

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
/**
 * gimp_text_fontname:
 * @image_ID: The image.
 * @drawable_ID: The affected drawable: (-1 for a new text layer).
 * @x: The x coordinate for the left of the text bounding box.
 * @y: The y coordinate for the top of the text bounding box.
 * @text: The text to generate.
 * @border: The size of the border.
 * @antialias: Antialiasing.
 * @size: The size of text in either pixels or points.
 * @size_type: The units of specified size.
 * @fontname: The fontname (conforming to the X Logical Font Description Conventions).
 *
 * Add text at the specified location as a floating selection or a new
 * layer.
 *
Sven Neumann's avatar
Sven Neumann committed
44 45 46 47 48 49 50 51 52 53
 * This tool requires a fontname matching an installed PangoFT2 font.
 * You can specify the fontsize in units of pixels or points, and the
 * appropriate metric is specified using the size_type argument. The x
 * and y parameters together control the placement of the new text by
 * specifying the upper left corner of the text bounding box. If the
 * specified drawable parameter is valid, the text will be created as a
 * floating selection attached to the drawable. If the drawable
 * parameter is not valid (-1), the text will appear as a new layer.
 * Finally, a border can be specified around the final rendered text.
 * The border is measured in pixels.
54 55 56
 *
 * Returns: The new text layer.
 */
57 58 59 60 61 62 63 64 65 66 67 68
gint32
gimp_text_fontname (gint32        image_ID,
		    gint32        drawable_ID,
		    gdouble       x,
		    gdouble       y,
		    gchar        *text,
		    gint          border,
		    gboolean      antialias,
		    gdouble       size,
		    GimpSizeType  size_type,
		    gchar        *fontname)
{
69
  GimpParam *return_vals;
70 71 72 73 74
  gint nreturn_vals;
  gint32 text_layer_ID = -1;

  return_vals = gimp_run_procedure ("gimp_text_fontname",
				    &nreturn_vals,
75 76 77 78 79 80 81 82 83 84 85 86 87
				    GIMP_PDB_IMAGE, image_ID,
				    GIMP_PDB_DRAWABLE, drawable_ID,
				    GIMP_PDB_FLOAT, x,
				    GIMP_PDB_FLOAT, y,
				    GIMP_PDB_STRING, text,
				    GIMP_PDB_INT32, border,
				    GIMP_PDB_INT32, antialias,
				    GIMP_PDB_FLOAT, size,
				    GIMP_PDB_INT32, size_type,
				    GIMP_PDB_STRING, fontname,
				    GIMP_PDB_END);

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
88 89 90 91 92 93 94
    text_layer_ID = return_vals[1].data.d_layer;

  gimp_destroy_params (return_vals, nreturn_vals);

  return text_layer_ID;
}

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
/**
 * gimp_text_get_extents_fontname:
 * @text: The text to generate.
 * @size: The size of text in either pixels or points.
 * @size_type: The units of specified size.
 * @fontname: The fontname (conforming to the X Logical Font Description Conventions).
 * @width: The width of the specified font.
 * @height: The height of the specified font.
 * @ascent: The ascent of the specified font.
 * @descent: The descent of the specified font.
 *
 * Get extents of the bounding box for the specified text.
 *
 * This tool returns the width and height of a bounding box for the
 * specified text string with the specified font information. Ascent
 * and descent for the specified font are returned as well.
 *
 * Returns: TRUE on success.
 */
114
gboolean
115 116 117 118 119 120 121 122 123
gimp_text_get_extents_fontname (gchar        *text,
				gdouble       size,
				GimpSizeType  size_type,
				gchar        *fontname,
				gint         *width,
				gint         *height,
				gint         *ascent,
				gint         *descent)
{
124
  GimpParam *return_vals;
125
  gint nreturn_vals;
126
  gboolean success = TRUE;
127 128 129

  return_vals = gimp_run_procedure ("gimp_text_get_extents_fontname",
				    &nreturn_vals,
130 131 132 133 134
				    GIMP_PDB_STRING, text,
				    GIMP_PDB_FLOAT, size,
				    GIMP_PDB_INT32, size_type,
				    GIMP_PDB_STRING, fontname,
				    GIMP_PDB_END);
135

136 137 138 139 140
  *width = 0;
  *height = 0;
  *ascent = 0;
  *descent = 0;

141 142 143
  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  if (success)
144 145 146 147 148 149 150 151
    {
      *width = return_vals[1].data.d_int32;
      *height = return_vals[2].data.d_int32;
      *ascent = return_vals[3].data.d_int32;
      *descent = return_vals[4].data.d_int32;
    }

  gimp_destroy_params (return_vals, nreturn_vals);
152 153

  return success;
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
/**
 * gimp_text:
 * @image_ID: The image.
 * @drawable_ID: The affected drawable: (-1 for a new text layer).
 * @x: The x coordinate for the left of the text bounding box.
 * @y: The y coordinate for the top of the text bounding box.
 * @text: The text to generate.
 * @border: The size of the border.
 * @antialias: Antialiasing.
 * @size: The size of text in either pixels or points.
 * @size_type: The units of specified size.
 * @foundry: The font foundry, \"*\" for any.
 * @family: The font family, \"*\" for any.
 * @weight: The font weight, \"*\" for any.
 * @slant: The font slant, \"*\" for any.
 * @set_width: The font set-width, \"*\" for any.
 * @spacing: The font spacing, \"*\" for any.
 * @registry: The font registry, \"*\" for any.
 * @encoding: The font encoding, \"*\" for any.
 *
 * Add text at the specified location as a floating selection or a new
 * layer.
 *
 * This tool requires font information in the form of nine parameters:
 * size, foundry, family, weight, slant, set_width, spacing, registry,
 * encoding. The font size can either be specified in units of pixels
 * or points, and the appropriate metric is specified using the
 * size_type argument. The x and y parameters together control the
 * placement of the new text by specifying the upper left corner of the
 * text bounding box. If the antialias parameter is non-zero, the
 * generated text will blend more smoothly with underlying layers. This
 * option requires more time and memory to compute than non-antialiased
 * text; the resulting floating selection or layer, however, will
 * require the same amount of memory with or without antialiasing. If
 * the specified drawable parameter is valid, the text will be created
 * as a floating selection attached to the drawable. If the drawable
 * parameter is not valid (-1), the text will appear as a new layer.
 * Finally, a border can be specified around the final rendered text.
 * The border is measured in pixels. If the border is specified as -1,
 * empty spaces around the text will not be cropped.
 *
 * Returns: The new text layer.
 */
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
gint32
gimp_text (gint32        image_ID,
	   gint32        drawable_ID,
	   gdouble       x,
	   gdouble       y,
	   gchar        *text,
	   gint          border,
	   gboolean      antialias,
	   gdouble       size,
	   GimpSizeType  size_type,
	   gchar        *foundry,
	   gchar        *family,
	   gchar        *weight,
	   gchar        *slant,
	   gchar        *set_width,
	   gchar        *spacing,
	   gchar        *registry,
	   gchar        *encoding)
{
218
  GimpParam *return_vals;
219 220 221 222 223
  gint nreturn_vals;
  gint32 text_layer_ID = -1;

  return_vals = gimp_run_procedure ("gimp_text",
				    &nreturn_vals,
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
				    GIMP_PDB_IMAGE, image_ID,
				    GIMP_PDB_DRAWABLE, drawable_ID,
				    GIMP_PDB_FLOAT, x,
				    GIMP_PDB_FLOAT, y,
				    GIMP_PDB_STRING, text,
				    GIMP_PDB_INT32, border,
				    GIMP_PDB_INT32, antialias,
				    GIMP_PDB_FLOAT, size,
				    GIMP_PDB_INT32, size_type,
				    GIMP_PDB_STRING, foundry,
				    GIMP_PDB_STRING, family,
				    GIMP_PDB_STRING, weight,
				    GIMP_PDB_STRING, slant,
				    GIMP_PDB_STRING, set_width,
				    GIMP_PDB_STRING, spacing,
				    GIMP_PDB_STRING, registry,
				    GIMP_PDB_STRING, encoding,
				    GIMP_PDB_END);

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
244 245 246 247 248 249 250
    text_layer_ID = return_vals[1].data.d_layer;

  gimp_destroy_params (return_vals, nreturn_vals);

  return text_layer_ID;
}

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
/**
 * gimp_text_get_extents:
 * @text: The text to generate.
 * @size: The size of text in either pixels or points.
 * @size_type: The units of specified size.
 * @foundry: The font foundry, \"*\" for any.
 * @family: The font family, \"*\" for any.
 * @weight: The font weight, \"*\" for any.
 * @slant: The font slant, \"*\" for any.
 * @set_width: The font set-width, \"*\" for any.
 * @spacing: The font spacing, \"*\" for any.
 * @registry: The font registry, \"*\" for any.
 * @encoding: The font encoding, \"*\" for any.
 * @width: The width of the specified font.
 * @height: The height of the specified font.
 * @ascent: The ascent of the specified font.
 * @descent: The descent of the specified font.
 *
 * Get extents of the bounding box for the specified text.
 *
 * This tool returns the width and height of a bounding box for the
 * specified text string with the specified font information. Ascent
 * and descent for the specified font are returned as well.
 *
 * Returns: TRUE on success.
 */
277
gboolean
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
gimp_text_get_extents (gchar        *text,
		       gdouble       size,
		       GimpSizeType  size_type,
		       gchar        *foundry,
		       gchar        *family,
		       gchar        *weight,
		       gchar        *slant,
		       gchar        *set_width,
		       gchar        *spacing,
		       gchar        *registry,
		       gchar        *encoding,
		       gint         *width,
		       gint         *height,
		       gint         *ascent,
		       gint         *descent)
{
294
  GimpParam *return_vals;
295
  gint nreturn_vals;
296
  gboolean success = TRUE;
297 298 299

  return_vals = gimp_run_procedure ("gimp_text_get_extents",
				    &nreturn_vals,
300 301 302 303 304 305 306 307 308 309 310 311
				    GIMP_PDB_STRING, text,
				    GIMP_PDB_FLOAT, size,
				    GIMP_PDB_INT32, size_type,
				    GIMP_PDB_STRING, foundry,
				    GIMP_PDB_STRING, family,
				    GIMP_PDB_STRING, weight,
				    GIMP_PDB_STRING, slant,
				    GIMP_PDB_STRING, set_width,
				    GIMP_PDB_STRING, spacing,
				    GIMP_PDB_STRING, registry,
				    GIMP_PDB_STRING, encoding,
				    GIMP_PDB_END);
312

313 314 315 316 317
  *width = 0;
  *height = 0;
  *ascent = 0;
  *descent = 0;

318 319 320
  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  if (success)
321 322 323 324 325 326 327 328
    {
      *width = return_vals[1].data.d_int32;
      *height = return_vals[2].data.d_int32;
      *ascent = return_vals[3].data.d_int32;
      *descent = return_vals[4].data.d_int32;
    }

  gimp_destroy_params (return_vals, nreturn_vals);
329 330

  return success;
331
}