Imported Upstream version 2.2.4
This commit is contained in:
Ari Pollak
187
devel-docs/libgimp/html/libgimp-gimptexttool.html
Normal file
187
devel-docs/libgimp/html/libgimp-gimptexttool.html
Normal file
@ -0,0 +1,187 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimptexttool</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Library Reference Manual"><link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties"><link rel="prev" href="libgimp-gimpselection.html" title="gimpselection"><link rel="next" href="libgimp-gimptile.html" title="gimptile"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="gimpdefinitions.html" title="Part<72>I.<2E>GIMP Constants"><link rel="part" href="libgimp.html" title="Part<72>II.<2E>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 all 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<72>III.<2E>GIMP User Interface Library"><link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimp-gimpselection.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></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">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"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
gint32 <a href="libgimp-gimptexttool.html#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="libgimp-gimpenums.html#GimpSizeType">GimpSizeType</a> size_type,
|
||||
const gchar *fontname);
|
||||
gboolean <a href="libgimp-gimptexttool.html#gimp-text-get-extents-fontname">gimp_text_get_extents_fontname</a> (const gchar *text,
|
||||
gdouble size,
|
||||
<a href="libgimp-gimpenums.html#GimpSizeType">GimpSizeType</a> size_type,
|
||||
const gchar *fontname,
|
||||
gint *width,
|
||||
gint *height,
|
||||
gint *ascent,
|
||||
gint *descent);
|
||||
gint32 <a href="libgimp-gimptexttool.html#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="libgimp-gimpenums.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 href="libgimp-gimptexttool.html#gimp-text-get-extents">gimp_text_get_extents</a> (const gchar *text,
|
||||
gdouble size,
|
||||
<a href="libgimp-gimpenums.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="id2632890"></a><h2>Description</h2><p>
|
||||
Functions for controlling the text tool.
|
||||
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2632899"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2632905"></a><h3><a name="gimp-text-fontname"></a>gimp_text_fontname ()</h3><a class="indexterm" name="id2632913"></a><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="libgimp-gimpenums.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.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>image_ID</tt></i><EFBFBD>:</span></td><td> The image.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> The affected drawable: (-1 for a new text layer).
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>x</tt></i><EFBFBD>:</span></td><td> The x coordinate for the left of the text bounding box.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>y</tt></i><EFBFBD>:</span></td><td> The y coordinate for the top of the text bounding box.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>text</tt></i><EFBFBD>:</span></td><td> The text to generate (in UTF-8 encoding).
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>border</tt></i><EFBFBD>:</span></td><td> The size of the border.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>antialias</tt></i><EFBFBD>:</span></td><td> Antialiasing.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i><EFBFBD>:</span></td><td> The size of text in either pixels or points.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size_type</tt></i><EFBFBD>:</span></td><td> The units of specified size.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>fontname</tt></i><EFBFBD>:</span></td><td> The name of the font.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></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="id2634836"></a><h3><a name="gimp-text-get-extents-fontname"></a>gimp_text_get_extents_fontname ()</h3><a class="indexterm" name="id2634843"></a><pre class="programlisting">gboolean gimp_text_get_extents_fontname (const gchar *text,
|
||||
gdouble size,
|
||||
<a href="libgimp-gimpenums.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.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>text</tt></i><EFBFBD>:</span></td><td> The text to generate (in UTF-8 encoding).
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i><EFBFBD>:</span></td><td> The size of text in either pixels or points.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size_type</tt></i><EFBFBD>:</span></td><td> The units of specified size.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>fontname</tt></i><EFBFBD>:</span></td><td> The name of the font.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>width</tt></i><EFBFBD>:</span></td><td> The width of the specified font.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>height</tt></i><EFBFBD>:</span></td><td> The height of the specified font.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>ascent</tt></i><EFBFBD>:</span></td><td> The ascent of the specified font.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>descent</tt></i><EFBFBD>:</span></td><td> The descent of the specified font.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2635006"></a><h3><a name="gimp-text"></a>gimp_text ()</h3><a class="indexterm" name="id2635014"></a><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="libgimp-gimpenums.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><tt class="literal">gimp_text</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||||
This procedure is deprecated! Use <a href="libgimp-gimptexttool.html#gimp-text-fontname"><tt class="function">gimp_text_fontname()</tt></a> instead.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>image_ID</tt></i><EFBFBD>:</span></td><td> The image.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> The affected drawable: (-1 for a new text layer).
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>x</tt></i><EFBFBD>:</span></td><td> The x coordinate for the left of the text bounding box.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>y</tt></i><EFBFBD>:</span></td><td> The y coordinate for the top of the text bounding box.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>text</tt></i><EFBFBD>:</span></td><td> The text to generate (in UTF-8 encoding).
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>border</tt></i><EFBFBD>:</span></td><td> The size of the border.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>antialias</tt></i><EFBFBD>:</span></td><td> Antialiasing.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i><EFBFBD>:</span></td><td> The size of text in either pixels or points.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size_type</tt></i><EFBFBD>:</span></td><td> The units of specified size.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>foundry</tt></i><EFBFBD>:</span></td><td> The font foundry.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>family</tt></i><EFBFBD>:</span></td><td> The font family.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>weight</tt></i><EFBFBD>:</span></td><td> The font weight.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>slant</tt></i><EFBFBD>:</span></td><td> The font slant.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>set_width</tt></i><EFBFBD>:</span></td><td> The font set-width.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>spacing</tt></i><EFBFBD>:</span></td><td> The font spacing.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>registry</tt></i><EFBFBD>:</span></td><td> The font registry.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>encoding</tt></i><EFBFBD>:</span></td><td> The font encoding.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></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="id2642054"></a><h3><a name="gimp-text-get-extents"></a>gimp_text_get_extents ()</h3><a class="indexterm" name="id2642063"></a><pre class="programlisting">gboolean gimp_text_get_extents (const gchar *text,
|
||||
gdouble size,
|
||||
<a href="libgimp-gimpenums.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><tt class="literal">gimp_text_get_extents</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||||
This procedure is deprecated! Use <a href="libgimp-gimptexttool.html#gimp-text-get-extents-fontname"><tt class="function">gimp_text_get_extents_fontname()</tt></a>
|
||||
instead.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>text</tt></i><EFBFBD>:</span></td><td> The text to generate (in UTF-8 encoding).
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i><EFBFBD>:</span></td><td> The size of text in either pixels or points.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size_type</tt></i><EFBFBD>:</span></td><td> The units of specified size.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>foundry</tt></i><EFBFBD>:</span></td><td> The font foundry.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>family</tt></i><EFBFBD>:</span></td><td> The font family.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>weight</tt></i><EFBFBD>:</span></td><td> The font weight.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>slant</tt></i><EFBFBD>:</span></td><td> The font slant.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>set_width</tt></i><EFBFBD>:</span></td><td> The font set-width.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>spacing</tt></i><EFBFBD>:</span></td><td> The font spacing.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>registry</tt></i><EFBFBD>:</span></td><td> The font registry.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>encoding</tt></i><EFBFBD>:</span></td><td> The font encoding.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>width</tt></i><EFBFBD>:</span></td><td> The width of the specified font.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>height</tt></i><EFBFBD>:</span></td><td> The height of the specified font.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>ascent</tt></i><EFBFBD>:</span></td><td> The ascent of the specified font.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>descent</tt></i><EFBFBD>:</span></td><td> The descent of the specified font.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
|
||||
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimp-gimpselection.html"><b><<<EFBFBD>gimpselection</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimptile.html"><b>gimptile<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
Reference in New Issue
Block a user