atktext.xml

The ATK library provides a set of interfaces for accessibility.By supporting the ATK interfaces, an

Describes the type of clipping required.</para>
<para>

</para><variablelist role="enum">
<varlistentry id="ATK-TEXT-CLIP-NONE:CAPS" role="constant">
<term><literal>ATK_TEXT_CLIP_NONE</literal></term>
<listitem><simpara> No clipping to be done
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-CLIP-MIN:CAPS" role="constant">
<term><literal>ATK_TEXT_CLIP_MIN</literal></term>
<listitem><simpara> Text clipped by min coordinate is omitted
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-CLIP-MAX:CAPS" role="constant">
<term><literal>ATK_TEXT_CLIP_MAX</literal></term>
<listitem><simpara> Text clipped by max coordinate is omitted
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-CLIP-BOTH:CAPS" role="constant">
<term><literal>ATK_TEXT_CLIP_BOTH</literal></term>
<listitem><simpara> Only text fully within mix/max bound is retained
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkTextRange" role="struct">
<title>AtkTextRange</title>
<indexterm zone="AtkTextRange"><primary>AtkTextRange</primary></indexterm><programlisting>typedef struct {
  AtkTextRectangle bounds;
  gint start_offset;
  gint end_offset;
  gchar* content;
} AtkTextRange;
</programlisting>
<para>
A structure used to describe a text range.</para>
<para>

</para><variablelist role="struct">
<varlistentry>
<term><link linkend="AtkTextRectangle">AtkTextRectangle</link>&nbsp;<structfield>bounds</structfield>;</term>
<listitem><simpara> A rectangle giving the bounds of the text range
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>start_offset</structfield>;</term>
<listitem><simpara> The start offset of a AtkTextRange
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>end_offset</structfield>;</term>
<listitem><simpara> The end offset of a AtkTextRange
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>content</structfield>;</term>
<listitem><simpara> The text in the text range
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkTextRectangle" role="struct">
<title>AtkTextRectangle</title>
<indexterm zone="AtkTextRectangle"><primary>AtkTextRectangle</primary></indexterm><programlisting>typedef struct {
  gint x;
  gint y;
  gint width;
  gint height;
} AtkTextRectangle;
</programlisting>
<para>
A structure used to store a rectangle used by AtkText.</para>
<para>

</para><variablelist role="struct">
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>x</structfield>;</term>
<listitem><simpara> The horizontal coordinate of a rectangle
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>y</structfield>;</term>
<listitem><simpara> The vertical coordinate of a rectangle
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>width</structfield>;</term>
<listitem><simpara> The width of a rectangle
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>height</structfield>;</term>
<listitem><simpara> The height of a rectangle
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkAttribute" role="struct">
<title>AtkAttribute</title>
<indexterm zone="AtkAttribute"><primary>AtkAttribute</primary></indexterm><programlisting>typedef struct {
  gchar* name;
  gchar* value;
} AtkAttribute;
</programlisting>
<para>
A string name/value pair representing a text attribute.</para>
<para>

</para><variablelist role="struct">
<varlistentry>
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>name</structfield>;</term>
<listitem><simpara> The attribute name. Call <link linkend="atk-text-attr-get-name"><function>atk_text_attr_get_name()</function></link>
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>value</structfield>;</term>
<listitem><simpara> the value of the attribute, represented as a string. 
Call <link linkend="atk-text-attr-get-value"><function>atk_text_attr_get_value()</function></link> for those which are strings.
For values which are numbers, the string representation of the number 
is in value.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkAttributeSet" role="typedef">
<title>AtkAttributeSet</title>
<indexterm zone="AtkAttributeSet"><primary>AtkAttributeSet</primary></indexterm><programlisting>typedef GSList AtkAttributeSet;
</programlisting>
<para>
This is a singly-linked list (a <link linkend="GSList"><type>GSList</type></link>) of <link linkend="AtkAttribute"><type>AtkAttribute</type></link>. It is
used by <link linkend="atk-text-get-run-attributes"><function>atk_text_get_run_attributes()</function></link>, <link linkend="atk-text-get-default-attributes"><function>atk_text_get_default_attributes()</function></link>
and <link linkend="atk-editable-text-set-run-attributes"><function>atk_editable_text_set_run_attributes()</function></link></para>
<para>

</para></refsect2>
<refsect2 id="AtkTextAttribute" role="enum">
<title>enum AtkTextAttribute</title>
<indexterm zone="AtkTextAttribute"><primary>AtkTextAttribute</primary></indexterm><programlisting>typedef enum
{
  ATK_TEXT_ATTR_INVALID = 0,
  ATK_TEXT_ATTR_LEFT_MARGIN,
  ATK_TEXT_ATTR_RIGHT_MARGIN,
  ATK_TEXT_ATTR_INDENT,
  ATK_TEXT_ATTR_INVISIBLE,
  ATK_TEXT_ATTR_EDITABLE,
  ATK_TEXT_ATTR_PIXELS_ABOVE_LINES,
  ATK_TEXT_ATTR_PIXELS_BELOW_LINES,
  ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP,
  ATK_TEXT_ATTR_BG_FULL_HEIGHT,
  ATK_TEXT_ATTR_RISE,
  ATK_TEXT_ATTR_UNDERLINE,
  ATK_TEXT_ATTR_STRIKETHROUGH,
  ATK_TEXT_ATTR_SIZE,
  ATK_TEXT_ATTR_SCALE,
  ATK_TEXT_ATTR_WEIGHT,
  ATK_TEXT_ATTR_LANGUAGE,
  ATK_TEXT_ATTR_FAMILY_NAME,
  ATK_TEXT_ATTR_BG_COLOR,
  ATK_TEXT_ATTR_FG_COLOR,
  ATK_TEXT_ATTR_BG_STIPPLE,
  ATK_TEXT_ATTR_FG_STIPPLE,
  ATK_TEXT_ATTR_WRAP_MODE,
  ATK_TEXT_ATTR_DIRECTION,
  ATK_TEXT_ATTR_JUSTIFICATION,
  ATK_TEXT_ATTR_STRETCH,
  ATK_TEXT_ATTR_VARIANT,
  ATK_TEXT_ATTR_STYLE,
  ATK_TEXT_ATTR_LAST_DEFINED
} AtkTextAttribute;
</programlisting>
<para>
Describes the text attributes supported</para>
<para>

</para><variablelist role="enum">
<varlistentry id="ATK-TEXT-ATTR-INVALID:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_INVALID</literal></term>
<listitem><simpara> Invalid attribute
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-LEFT-MARGIN:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_LEFT_MARGIN</literal></term>
<listitem><simpara> The pixel width of the left margin
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-RIGHT-MARGIN:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_RIGHT_MARGIN</literal></term>
<listitem><simpara> The pixel width of the right margin
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-INDENT:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_INDENT</literal></term>
<listitem><simpara> The number of pixels that the text is indented
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-INVISIBLE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_INVISIBLE</literal></term>
<listitem><simpara> Either "true" or "false" indicating whether text is visible or not
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-EDITABLE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_EDITABLE</literal></term>
<listitem><simpara> Either "true" or "false" indicating whether text is editable or not
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-PIXELS-ABOVE-LINES:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_PIXELS_ABOVE_LINES</literal></term>
<listitem><simpara> Pixels of blank space to leave above each newline-terminated line. 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-PIXELS-BELOW-LINES:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_PIXELS_BELOW_LINES</literal></term>
<listitem><simpara> Pixels of blank space to leave below each newline-terminated line.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-PIXELS-INSIDE-WRAP:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP</literal></term>
<listitem><simpara> Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-BG-FULL-HEIGHT:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_BG_FULL_HEIGHT</literal></term>
<listitem><simpara> "true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-RISE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_RISE</literal></term>
<listitem><simpara> Number of pixels that the characters are risen above the baseline
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-UNDERLINE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_UNDERLINE</literal></term>
<listitem><simpara> "none", "single", "double" or "low"
</simpara></listitem>