544 lines
23 KiB
HTML
544 lines
23 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>gimptexttool</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
||
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
|
||
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
|
||
<link rel="prev" href="libgimp-gimptextlayer.html" title="gimptextlayer">
|
||
<link rel="next" href="libgimp-gimptile.html" title="gimptile">
|
||
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
|
||
<link rel="stylesheet" href="style.css" type="text/css">
|
||
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
|
||
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
|
||
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
|
||
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
|
||
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
|
||
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
|
||
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
|
||
<link rel="index" href="libgimp-index.html" title="Index">
|
||
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
||
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
||
<link rel="index" href="libgimp-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
|
||
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
|
||
<tr valign="middle">
|
||
<td><a accesskey="p" href="libgimp-gimptextlayer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
|
||
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
|
||
<th width="100%" align="center">GIMP Library Reference Manual</th>
|
||
<td><a accesskey="n" href="libgimp-gimptile.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
||
</tr>
|
||
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgimp-gimptexttool.synopsis" class="shortcut">Top</a>
|
||
|
|
||
<a href="#libgimp-gimptexttool.description" class="shortcut">Description</a></nobr></td></tr>
|
||
</table>
|
||
<div class="refentry" lang="en">
|
||
<a name="libgimp-gimptexttool"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="libgimp-gimptexttool.top_of_page"></a>gimptexttool</span></h2>
|
||
<p>gimptexttool — Functions for controlling the text tool.</p>
|
||
</td>
|
||
<td valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsynopsisdiv">
|
||
<a name="libgimp-gimptexttool.synopsis"></a><h2>Synopsis</h2>
|
||
<pre class="synopsis">
|
||
gint32 <a class="link" href="libgimp-gimptexttool.html#gimp-text-fontname" title="gimp_text_fontname ()">gimp_text_fontname</a> (gint32 image_ID,
|
||
gint32 drawable_ID,
|
||
gdouble x,
|
||
gdouble y,
|
||
const gchar *text,
|
||
gint border,
|
||
gboolean antialias,
|
||
gdouble size,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpSizeType"
|
||
>GimpSizeType</a> size_type,
|
||
const gchar *fontname);
|
||
gboolean <a class="link" href="libgimp-gimptexttool.html#gimp-text-get-extents-fontname" title="gimp_text_get_extents_fontname ()">gimp_text_get_extents_fontname</a> (const gchar *text,
|
||
gdouble size,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpSizeType"
|
||
>GimpSizeType</a> size_type,
|
||
const gchar *fontname,
|
||
gint *width,
|
||
gint *height,
|
||
gint *ascent,
|
||
gint *descent);
|
||
gint32 <a class="link" href="libgimp-gimptexttool.html#gimp-text" title="gimp_text ()">gimp_text</a> (gint32 image_ID,
|
||
gint32 drawable_ID,
|
||
gdouble x,
|
||
gdouble y,
|
||
const gchar *text,
|
||
gint border,
|
||
gboolean antialias,
|
||
gdouble size,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpSizeType"
|
||
>GimpSizeType</a> size_type,
|
||
const gchar *foundry,
|
||
const gchar *family,
|
||
const gchar *weight,
|
||
const gchar *slant,
|
||
const gchar *set_width,
|
||
const gchar *spacing,
|
||
const gchar *registry,
|
||
const gchar *encoding);
|
||
gboolean <a class="link" href="libgimp-gimptexttool.html#gimp-text-get-extents" title="gimp_text_get_extents ()">gimp_text_get_extents</a> (const gchar *text,
|
||
gdouble size,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpSizeType"
|
||
>GimpSizeType</a> size_type,
|
||
const gchar *foundry,
|
||
const gchar *family,
|
||
const gchar *weight,
|
||
const gchar *slant,
|
||
const gchar *set_width,
|
||
const gchar *spacing,
|
||
const gchar *registry,
|
||
const gchar *encoding,
|
||
gint *width,
|
||
gint *height,
|
||
gint *ascent,
|
||
gint *descent);
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="libgimp-gimptexttool.description"></a><h2>Description</h2>
|
||
<p>
|
||
Functions for controlling the text tool.
|
||
|
||
</p>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="libgimp-gimptexttool.details"></a><h2>Details</h2>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-text-fontname"></a><h3>gimp_text_fontname ()</h3>
|
||
<pre class="programlisting">gint32 gimp_text_fontname (gint32 image_ID,
|
||
gint32 drawable_ID,
|
||
gdouble x,
|
||
gdouble y,
|
||
const gchar *text,
|
||
gint border,
|
||
gboolean antialias,
|
||
gdouble size,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpSizeType"
|
||
>GimpSizeType</a> size_type,
|
||
const gchar *fontname);</pre>
|
||
<p>
|
||
Add text at the specified location as a floating selection or a new
|
||
layer.
|
||
</p>
|
||
<p>
|
||
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. Parameter size-type is not used
|
||
and is currently ignored. If you need to display a font in points,
|
||
divide the size in points by 72.0 and multiply it by the image's
|
||
vertical resolution.</p>
|
||
<p>
|
||
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td> The image.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></p></td>
|
||
<td> The affected drawable: (-1 for a new text layer).
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
|
||
<td> The x coordinate for the left of the text bounding box.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
|
||
<td> The y coordinate for the top of the text bounding box.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
|
||
<td> The text to generate (in UTF-8 encoding).
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>border</code></em> :</span></p></td>
|
||
<td> The size of the border.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>antialias</code></em> :</span></p></td>
|
||
<td> Antialiasing.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||
<td> The size of text in either pixels or points.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>size_type</code></em> :</span></p></td>
|
||
<td> The units of specified size.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>fontname</code></em> :</span></p></td>
|
||
<td> The name of the font.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td> The new text layer or -1 if no layer was created.
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-text-get-extents-fontname"></a><h3>gimp_text_get_extents_fontname ()</h3>
|
||
<pre class="programlisting">gboolean gimp_text_get_extents_fontname (const gchar *text,
|
||
gdouble size,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpSizeType"
|
||
>GimpSizeType</a> size_type,
|
||
const gchar *fontname,
|
||
gint *width,
|
||
gint *height,
|
||
gint *ascent,
|
||
gint *descent);</pre>
|
||
<p>
|
||
Get extents of the bounding box for the specified text.
|
||
</p>
|
||
<p>
|
||
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. Parameter
|
||
size-type is not used and is currently ignored. If you need to
|
||
display a font in points, divide the size in points by 72.0 and
|
||
multiply it by the vertical resolution of the image you are taking
|
||
into account.</p>
|
||
<p>
|
||
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
|
||
<td> The text to generate (in UTF-8 encoding).
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||
<td> The size of text in either pixels or points.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>size_type</code></em> :</span></p></td>
|
||
<td> The units of specified size.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>fontname</code></em> :</span></p></td>
|
||
<td> The name of the font.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
||
<td> The width of the specified font.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
||
<td> The height of the specified font.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>ascent</code></em> :</span></p></td>
|
||
<td> The ascent of the specified font.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>descent</code></em> :</span></p></td>
|
||
<td> The descent of the specified font.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td> TRUE on success.
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-text"></a><h3>gimp_text ()</h3>
|
||
<pre class="programlisting">gint32 gimp_text (gint32 image_ID,
|
||
gint32 drawable_ID,
|
||
gdouble x,
|
||
gdouble y,
|
||
const gchar *text,
|
||
gint border,
|
||
gboolean antialias,
|
||
gdouble size,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpSizeType"
|
||
>GimpSizeType</a> size_type,
|
||
const gchar *foundry,
|
||
const gchar *family,
|
||
const gchar *weight,
|
||
const gchar *slant,
|
||
const gchar *set_width,
|
||
const gchar *spacing,
|
||
const gchar *registry,
|
||
const gchar *encoding);</pre>
|
||
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_text</code> is deprecated and should not be used in newly-written code.</p>
|
||
</div>
|
||
<p>
|
||
This procedure is deprecated! Use <a class="link" href="libgimp-gimptexttool.html#gimp-text-fontname" title="gimp_text_fontname ()"><code class="function">gimp_text_fontname()</code></a> instead.</p>
|
||
<p>
|
||
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td> The image.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></p></td>
|
||
<td> The affected drawable: (-1 for a new text layer).
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
|
||
<td> The x coordinate for the left of the text bounding box.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
|
||
<td> The y coordinate for the top of the text bounding box.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
|
||
<td> The text to generate (in UTF-8 encoding).
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>border</code></em> :</span></p></td>
|
||
<td> The size of the border.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>antialias</code></em> :</span></p></td>
|
||
<td> Antialiasing.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||
<td> The size of text in either pixels or points.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>size_type</code></em> :</span></p></td>
|
||
<td> The units of specified size.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>foundry</code></em> :</span></p></td>
|
||
<td> The font foundry.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>family</code></em> :</span></p></td>
|
||
<td> The font family.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>weight</code></em> :</span></p></td>
|
||
<td> The font weight.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>slant</code></em> :</span></p></td>
|
||
<td> The font slant.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>set_width</code></em> :</span></p></td>
|
||
<td> The font set-width.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>spacing</code></em> :</span></p></td>
|
||
<td> The font spacing.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>registry</code></em> :</span></p></td>
|
||
<td> The font registry.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td>
|
||
<td> The font encoding.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td> The new text layer or -1 if no layer was created.
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-text-get-extents"></a><h3>gimp_text_get_extents ()</h3>
|
||
<pre class="programlisting">gboolean gimp_text_get_extents (const gchar *text,
|
||
gdouble size,
|
||
<a
|
||
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpSizeType"
|
||
>GimpSizeType</a> size_type,
|
||
const gchar *foundry,
|
||
const gchar *family,
|
||
const gchar *weight,
|
||
const gchar *slant,
|
||
const gchar *set_width,
|
||
const gchar *spacing,
|
||
const gchar *registry,
|
||
const gchar *encoding,
|
||
gint *width,
|
||
gint *height,
|
||
gint *ascent,
|
||
gint *descent);</pre>
|
||
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_text_get_extents</code> is deprecated and should not be used in newly-written code.</p>
|
||
</div>
|
||
<p>
|
||
This procedure is deprecated! Use <a class="link" href="libgimp-gimptexttool.html#gimp-text-get-extents-fontname" title="gimp_text_get_extents_fontname ()"><code class="function">gimp_text_get_extents_fontname()</code></a>
|
||
instead.</p>
|
||
<p>
|
||
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
|
||
<td> The text to generate (in UTF-8 encoding).
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||
<td> The size of text in either pixels or points.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>size_type</code></em> :</span></p></td>
|
||
<td> The units of specified size.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>foundry</code></em> :</span></p></td>
|
||
<td> The font foundry.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>family</code></em> :</span></p></td>
|
||
<td> The font family.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>weight</code></em> :</span></p></td>
|
||
<td> The font weight.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>slant</code></em> :</span></p></td>
|
||
<td> The font slant.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>set_width</code></em> :</span></p></td>
|
||
<td> The font set-width.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>spacing</code></em> :</span></p></td>
|
||
<td> The font spacing.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>registry</code></em> :</span></p></td>
|
||
<td> The font registry.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td>
|
||
<td> The font encoding.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
||
<td> The width of the specified font.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
||
<td> The height of the specified font.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>ascent</code></em> :</span></p></td>
|
||
<td> The ascent of the specified font.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>descent</code></em> :</span></p></td>
|
||
<td> The descent of the specified font.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td> TRUE on success.
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>
|
||
Generated by GTK-Doc V1.10</div>
|
||
</body>
|
||
</html>
|