725 lines
40 KiB
XML
725 lines
40 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="libgimp-gimptextlayer">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page" id="libgimp-gimptextlayer.top_of_page">gimptextlayer</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimptextlayer</refname>
|
|
<refpurpose></refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv id="libgimp-gimptextlayer.synopsis" role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-text-layer-new">gimp_text_layer_new</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
const <link linkend="gchar">gchar</link> *text,
|
|
const <link linkend="gchar">gchar</link> *fontname,
|
|
<link linkend="gdouble">gdouble</link> size,
|
|
<link linkend="GimpUnit">GimpUnit</link> unit);
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-text-layer-get-text">gimp_text_layer_get_text</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-text">gimp_text_layer_set_text</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
const <link linkend="gchar">gchar</link> *text);
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-text-layer-get-font">gimp_text_layer_get_font</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-font">gimp_text_layer_set_font</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
const <link linkend="gchar">gchar</link> *font);
|
|
<link linkend="gdouble">gdouble</link> <link linkend="gimp-text-layer-get-font-size">gimp_text_layer_get_font_size</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpUnit">GimpUnit</link> *unit);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-font-size">gimp_text_layer_set_font_size</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gdouble">gdouble</link> font_size,
|
|
<link linkend="GimpUnit">GimpUnit</link> unit);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-get-hinting">gimp_text_layer_get_hinting</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> *autohint);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-hinting">gimp_text_layer_set_hinting</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> hinting,
|
|
<link linkend="gboolean">gboolean</link> autohint);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-get-antialias">gimp_text_layer_get_antialias</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-antialias">gimp_text_layer_set_antialias</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> antialias);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-get-kerning">gimp_text_layer_get_kerning</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-kerning">gimp_text_layer_set_kerning</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> kerning);
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-text-layer-get-language">gimp_text_layer_get_language</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-language">gimp_text_layer_set_language</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
const <link linkend="gchar">gchar</link> *language);
|
|
<link linkend="GimpTextDirection">GimpTextDirection</link> <link linkend="gimp-text-layer-get-base-direction">gimp_text_layer_get_base_direction</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-base-direction">gimp_text_layer_set_base_direction</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpTextDirection">GimpTextDirection</link> direction);
|
|
<link linkend="GimpTextJustification">GimpTextJustification</link> <link linkend="gimp-text-layer-get-justification">gimp_text_layer_get_justification</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-justification">gimp_text_layer_set_justification</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpTextJustification">GimpTextJustification</link> justify);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-get-color">gimp_text_layer_get_color</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpRGB">GimpRGB</link> *color);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-color">gimp_text_layer_set_color</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
const <link linkend="GimpRGB">GimpRGB</link> *color);
|
|
<link linkend="gdouble">gdouble</link> <link linkend="gimp-text-layer-get-indent">gimp_text_layer_get_indent</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-indent">gimp_text_layer_set_indent</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gdouble">gdouble</link> indent);
|
|
<link linkend="gdouble">gdouble</link> <link linkend="gimp-text-layer-get-line-spacing">gimp_text_layer_get_line_spacing</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-line-spacing">gimp_text_layer_set_line_spacing</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gdouble">gdouble</link> line_spacing);
|
|
<link linkend="gdouble">gdouble</link> <link linkend="gimp-text-layer-get-letter-spacing">gimp_text_layer_get_letter_spacing</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-text-layer-set-letter-spacing">gimp_text_layer_set_letter_spacing</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gdouble">gdouble</link> letter_spacing);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 id="libgimp-gimptextlayer.description" role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 id="libgimp-gimptextlayer.details" role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2 id="gimp-text-layer-new" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_new ()</title>
|
|
<indexterm zone="gimp-text-layer-new" role="GIMP 2.6"><primary>gimp_text_layer_new</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_text_layer_new (<link linkend="gint32">gint32</link> image_ID,
|
|
const <link linkend="gchar">gchar</link> *text,
|
|
const <link linkend="gchar">gchar</link> *fontname,
|
|
<link linkend="gdouble">gdouble</link> size,
|
|
<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
|
|
<para>
|
|
Creates a new text layer.
|
|
</para>
|
|
<para>
|
|
This procedure creates a new text layer. The arguments are kept as
|
|
simple as necessary for the normal case. All text attributes,
|
|
however, can be modified with the appropriate
|
|
gimp_text_layer_set_*() procedures. The new layer still needs to be
|
|
added to the image, as this is not automatic. Add the new layer
|
|
using <link linkend="gimp-image-add-layer"><function>gimp_image_add_layer()</function></link>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>text</parameter> :</term>
|
|
<listitem><simpara> The text to generate (in UTF-8 encoding).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>fontname</parameter> :</term>
|
|
<listitem><simpara> The name of the font.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>size</parameter> :</term>
|
|
<listitem><simpara> The size of text in either pixels or points.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>unit</parameter> :</term>
|
|
<listitem><simpara> The units of specified size.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new text layer.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-text" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_text ()</title>
|
|
<indexterm zone="gimp-text-layer-get-text" role="GIMP 2.6"><primary>gimp_text_layer_get_text</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_text_layer_get_text (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the text from a text layer as string.
|
|
</para>
|
|
<para>
|
|
This procedure returns the text from a text layer as a string.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The text from the specified text layer.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-text" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_text ()</title>
|
|
<indexterm zone="gimp-text-layer-set-text" role="GIMP 2.6"><primary>gimp_text_layer_set_text</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_text (<link linkend="gint32">gint32</link> layer_ID,
|
|
const <link linkend="gchar">gchar</link> *text);</programlisting>
|
|
<para>
|
|
Set the text of a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure changes the text of a text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>text</parameter> :</term>
|
|
<listitem><simpara> The new text to set.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-font" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_font ()</title>
|
|
<indexterm zone="gimp-text-layer-get-font" role="GIMP 2.6"><primary>gimp_text_layer_get_font</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_text_layer_get_font (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the font from a text layer as string.
|
|
</para>
|
|
<para>
|
|
This procedure returns the name of the font from a text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The font which is used in the specified text layer.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-font" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_font ()</title>
|
|
<indexterm zone="gimp-text-layer-set-font" role="GIMP 2.6"><primary>gimp_text_layer_set_font</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_font (<link linkend="gint32">gint32</link> layer_ID,
|
|
const <link linkend="gchar">gchar</link> *font);</programlisting>
|
|
<para>
|
|
Set the font of a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure modifies the font used in the specified text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>font</parameter> :</term>
|
|
<listitem><simpara> The new font to use.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-font-size" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_font_size ()</title>
|
|
<indexterm zone="gimp-text-layer-get-font-size" role="GIMP 2.6"><primary>gimp_text_layer_get_font_size</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_text_layer_get_font_size (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpUnit">GimpUnit</link> *unit);</programlisting>
|
|
<para>
|
|
Get the font size from a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the size of the font which is used in a text
|
|
layer. You will receive the size as a float 'font-size' in 'unit'
|
|
units.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>unit</parameter> :</term>
|
|
<listitem><simpara> The unit used for the font size.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The font size.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-font-size" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_font_size ()</title>
|
|
<indexterm zone="gimp-text-layer-set-font-size" role="GIMP 2.6"><primary>gimp_text_layer_set_font_size</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_font_size (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gdouble">gdouble</link> font_size,
|
|
<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
|
|
<para>
|
|
Set the font size.
|
|
</para>
|
|
<para>
|
|
This procedure changes the font size of a text layer. The size of
|
|
your font will be a double 'font-size' of 'unit' units.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>font_size</parameter> :</term>
|
|
<listitem><simpara> The font size.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>unit</parameter> :</term>
|
|
<listitem><simpara> The unit to use for the font size.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-hinting" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_hinting ()</title>
|
|
<indexterm zone="gimp-text-layer-get-hinting" role="GIMP 2.6"><primary>gimp_text_layer_get_hinting</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_get_hinting (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> *autohint);</programlisting>
|
|
<para>
|
|
Get information about hinting in the specified text layer.
|
|
</para>
|
|
<para>
|
|
This procedure provides information about the hinting that is being
|
|
used in a text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>autohint</parameter> :</term>
|
|
<listitem><simpara> A flag which is true if the text layer is forced to use the autohinter from FreeType.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A flag which is true if hinting is used on the font.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-hinting" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_hinting ()</title>
|
|
<indexterm zone="gimp-text-layer-set-hinting" role="GIMP 2.6"><primary>gimp_text_layer_set_hinting</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_hinting (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> hinting,
|
|
<link linkend="gboolean">gboolean</link> autohint);</programlisting>
|
|
<para>
|
|
Enable/disable the use of hinting in a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure enables or disables hinting on the text of a text
|
|
layer. If you enable 'auto-hint', FreeType\'s automatic hinter will
|
|
be used and hinting information from the font will be ignored.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>hinting</parameter> :</term>
|
|
<listitem><simpara> Enable/disable the use of hinting on the text.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>autohint</parameter> :</term>
|
|
<listitem><simpara> Force the use of the autohinter provided through FreeType.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-antialias" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_antialias ()</title>
|
|
<indexterm zone="gimp-text-layer-get-antialias" role="GIMP 2.6"><primary>gimp_text_layer_get_antialias</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_get_antialias (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Check if antialiasing is used in the text layer.
|
|
</para>
|
|
<para>
|
|
This procedure checks if antialiasing is enabled in the specified
|
|
text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A flag which is true if antialiasing is used for rendering the font in the text layer.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-antialias" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_antialias ()</title>
|
|
<indexterm zone="gimp-text-layer-set-antialias" role="GIMP 2.6"><primary>gimp_text_layer_set_antialias</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_antialias (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> antialias);</programlisting>
|
|
<para>
|
|
Enable/disable anti-aliasing in a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure enables or disables anti-aliasing of the text in a
|
|
text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>antialias</parameter> :</term>
|
|
<listitem><simpara> Enable/disable antialiasing of the text.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-kerning" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_kerning ()</title>
|
|
<indexterm zone="gimp-text-layer-get-kerning" role="GIMP 2.6"><primary>gimp_text_layer_get_kerning</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_get_kerning (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Check if kerning is used in the text layer.
|
|
</para>
|
|
<para>
|
|
This procedure checks if kerning is enabled in the specified text
|
|
layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A flag which is true if kerning is used in the text layer.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-kerning" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_kerning ()</title>
|
|
<indexterm zone="gimp-text-layer-set-kerning" role="GIMP 2.6"><primary>gimp_text_layer_set_kerning</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_kerning (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> kerning);</programlisting>
|
|
<para>
|
|
Enable/disable kerning in a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure enables or disables kerning in a text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>kerning</parameter> :</term>
|
|
<listitem><simpara> Enable/disable kerning in the text.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-language" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_language ()</title>
|
|
<indexterm zone="gimp-text-layer-get-language" role="GIMP 2.6"><primary>gimp_text_layer_get_language</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_text_layer_get_language (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the language used in the text layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the language string which is set for the text
|
|
in the text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The language used in the text layer.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-language" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_language ()</title>
|
|
<indexterm zone="gimp-text-layer-set-language" role="GIMP 2.6"><primary>gimp_text_layer_set_language</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_language (<link linkend="gint32">gint32</link> layer_ID,
|
|
const <link linkend="gchar">gchar</link> *language);</programlisting>
|
|
<para>
|
|
Set the language of the text layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the language of the text in text layer. For some
|
|
scripts the language has an influence of how the text is rendered.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>language</parameter> :</term>
|
|
<listitem><simpara> The new language to use for the text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-base-direction" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_base_direction ()</title>
|
|
<indexterm zone="gimp-text-layer-get-base-direction" role="GIMP 2.6"><primary>gimp_text_layer_get_base_direction</primary></indexterm><programlisting><link linkend="GimpTextDirection">GimpTextDirection</link> gimp_text_layer_get_base_direction (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the base direction used for rendering the text layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the base direction used for rendering the
|
|
text in the text layer</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The based direction used for the text layer.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-base-direction" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_base_direction ()</title>
|
|
<indexterm zone="gimp-text-layer-set-base-direction" role="GIMP 2.6"><primary>gimp_text_layer_set_base_direction</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_base_direction (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpTextDirection">GimpTextDirection</link> direction);</programlisting>
|
|
<para>
|
|
Set the base direction in the text layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the base direction used in applying the Unicode
|
|
bidirectional algorithm when rendering the text.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>direction</parameter> :</term>
|
|
<listitem><simpara> The base direction of the text.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-justification" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_justification ()</title>
|
|
<indexterm zone="gimp-text-layer-get-justification" role="GIMP 2.6"><primary>gimp_text_layer_get_justification</primary></indexterm><programlisting><link linkend="GimpTextJustification">GimpTextJustification</link> gimp_text_layer_get_justification (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the text justification information of the text layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the alignment of the lines in the text layer
|
|
relative to each other.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The justification used in the text layer.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-justification" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_justification ()</title>
|
|
<indexterm zone="gimp-text-layer-set-justification" role="GIMP 2.6"><primary>gimp_text_layer_set_justification</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_justification (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpTextJustification">GimpTextJustification</link> justify);</programlisting>
|
|
<para>
|
|
Set the justification of the text in a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the alignment of the lines in the text layer
|
|
relative to each other.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>justify</parameter> :</term>
|
|
<listitem><simpara> The justification for your text.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-color" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_color ()</title>
|
|
<indexterm zone="gimp-text-layer-get-color" role="GIMP 2.6"><primary>gimp_text_layer_get_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_get_color (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
|
<para>
|
|
Get the color of the text in a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the color of the text in a text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color</parameter> :</term>
|
|
<listitem><simpara> The color of the text.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-color" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_color ()</title>
|
|
<indexterm zone="gimp-text-layer-set-color" role="GIMP 2.6"><primary>gimp_text_layer_set_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_color (<link linkend="gint32">gint32</link> layer_ID,
|
|
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
|
<para>
|
|
Set the color of the text in the text layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the text color in the text layer 'layer'.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color</parameter> :</term>
|
|
<listitem><simpara> The color to use for the text.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-indent" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_indent ()</title>
|
|
<indexterm zone="gimp-text-layer-get-indent" role="GIMP 2.6"><primary>gimp_text_layer_get_indent</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_text_layer_get_indent (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the line indentation of text layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the indentation of the first line in a text
|
|
layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The indentation value of the first line.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-indent" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_indent ()</title>
|
|
<indexterm zone="gimp-text-layer-set-indent" role="GIMP 2.6"><primary>gimp_text_layer_set_indent</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_indent (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gdouble">gdouble</link> indent);</programlisting>
|
|
<para>
|
|
Set the indentation of the first line in a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the indentation of the first line in the text
|
|
layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>indent</parameter> :</term>
|
|
<listitem><simpara> The indentation for the first line.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-line-spacing" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_line_spacing ()</title>
|
|
<indexterm zone="gimp-text-layer-get-line-spacing" role="GIMP 2.6"><primary>gimp_text_layer_get_line_spacing</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_text_layer_get_line_spacing (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the spacing between lines of text.
|
|
</para>
|
|
<para>
|
|
This procedure returns the line-spacing between lines of text in a
|
|
text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The line-spacing value.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-line-spacing" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_line_spacing ()</title>
|
|
<indexterm zone="gimp-text-layer-set-line-spacing" role="GIMP 2.6"><primary>gimp_text_layer_set_line_spacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_line_spacing (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gdouble">gdouble</link> line_spacing);</programlisting>
|
|
<para>
|
|
Adjust the line spacing in a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the additional spacing used between lines a text
|
|
layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>line_spacing</parameter> :</term>
|
|
<listitem><simpara> The additional line spacing to use.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-get-letter-spacing" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_get_letter_spacing ()</title>
|
|
<indexterm zone="gimp-text-layer-get-letter-spacing" role="GIMP 2.6"><primary>gimp_text_layer_get_letter_spacing</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_text_layer_get_letter_spacing (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the letter spacing used in a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the additional spacing between the single
|
|
glyps in a text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The letter-spacing value.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-text-layer-set-letter-spacing" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_text_layer_set_letter_spacing ()</title>
|
|
<indexterm zone="gimp-text-layer-set-letter-spacing" role="GIMP 2.6"><primary>gimp_text_layer_set_letter_spacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_text_layer_set_letter_spacing (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gdouble">gdouble</link> letter_spacing);</programlisting>
|
|
<para>
|
|
Adjust the letter spacing in a text layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the additional spacing between the single glyphs
|
|
in a text layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The text layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>letter_spacing</parameter> :</term>
|
|
<listitem><simpara> The additional letter spacing to use.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|