atktext.xml

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

</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-STRIKETHROUGH:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_STRIKETHROUGH</literal></term>
<listitem><simpara> "true" or "false" whether the text is strikethrough 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-SIZE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_SIZE</literal></term>
<listitem><simpara> The size of the characters. 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-SCALE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_SCALE</literal></term>
<listitem><simpara> The scale of the characters. The value is a string representation of a double 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-WEIGHT:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_WEIGHT</literal></term>
<listitem><simpara> The weight of the characters.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-LANGUAGE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_LANGUAGE</literal></term>
<listitem><simpara> The language used
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-FAMILY-NAME:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_FAMILY_NAME</literal></term>
<listitem><simpara> The font family name
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-BG-COLOR:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_BG_COLOR</literal></term>
<listitem><simpara> The background color. The value is an RGB value of the format "<link linkend="u"><literal>u</literal></link>,<link linkend="u"><literal>u</literal></link>,<link linkend="u"><literal>u</literal></link>"
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-FG-COLOR:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_FG_COLOR</literal></term>
<listitem><simpara>The foreground color. The value is an RGB value of the format "<link linkend="u"><literal>u</literal></link>,<link linkend="u"><literal>u</literal></link>,<link linkend="u"><literal>u</literal></link>"
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-BG-STIPPLE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_BG_STIPPLE</literal></term>
<listitem><simpara> "true" if a <link linkend="GdkBitmap"><type>GdkBitmap</type></link> is set for stippling the background color.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-FG-STIPPLE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_FG_STIPPLE</literal></term>
<listitem><simpara> "true" if a <link linkend="GdkBitmap"><type>GdkBitmap</type></link> is set for stippling the foreground color.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-WRAP-MODE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_WRAP_MODE</literal></term>
<listitem><simpara> The wrap mode of the text, if any. Values are "none", "char" or "word" 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-DIRECTION:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_DIRECTION</literal></term>
<listitem><simpara> The direction of the text, if set. Values are "none", "ltr" or "rtl" 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-JUSTIFICATION:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_JUSTIFICATION</literal></term>
<listitem><simpara> The justification of the text, if set. Values are "left", "right", "center" or "fill" 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-STRETCH:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_STRETCH</literal></term>
<listitem><simpara> The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded"
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-VARIANT:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_VARIANT</literal></term>
<listitem><simpara> The capitalization variant of the text, if set. Values are "normal" or "small_caps"
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-STYLE:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_STYLE</literal></term>
<listitem><simpara> The slant style of the text, if set. Values are "normal", "oblique" or "italic"
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-TEXT-ATTR-LAST-DEFINED:CAPS" role="constant">
<term><literal>ATK_TEXT_ATTR_LAST_DEFINED</literal></term>
<listitem><simpara> not a valid text attribute, used for finding end of enumeration
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-text-get-text" role="function">
<title>atk_text_get_text ()</title>
<indexterm zone="atk-text-get-text"><primary>atk_text_get_text</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              atk_text_get_text                   (<link linkend="AtkText">AtkText</link> *text,
                                                         <link linkend="gint">gint</link> start_offset,
                                                         <link linkend="gint">gint</link> end_offset);</programlisting>
<para>
Gets the specified text.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkText"><type>AtkText</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start_offset</parameter>&nbsp;:</term>
<listitem><simpara> start position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end_offset</parameter>&nbsp;:</term>
<listitem><simpara> end position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the text from <parameter>start_offset</parameter> up to, but not including <parameter>end_offset</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-text-get-character-at-offset" role="function">
<title>atk_text_get_character_at_offset ()</title>
<indexterm zone="atk-text-get-character-at-offset"><primary>atk_text_get_character_at_offset</primary></indexterm><programlisting><link linkend="gunichar">gunichar</link>            atk_text_get_character_at_offset    (<link linkend="AtkText">AtkText</link> *text,
                                                         <link linkend="gint">gint</link> offset);</programlisting>
<para>
Gets the specified text.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkText"><type>AtkText</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter>&nbsp;:</term>
<listitem><simpara> position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the character at <parameter>offset</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-text-get-text-after-offset" role="function">
<title>atk_text_get_text_after_offset ()</title>
<indexterm zone="atk-text-get-text-after-offset"><primary>atk_text_get_text_after_offset</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              atk_text_get_text_after_offset      (<link linkend="AtkText">AtkText</link> *text,
                                                         <link linkend="gint">gint</link> offset,
                                                         <link linkend="AtkTextBoundary">AtkTextBoundary</link> boundary_type,
                                                         <link linkend="gint">gint</link> *start_offset,
                                                         <link linkend="gint">gint</link> *end_offset);</programlisting>
<para>
Gets the specified text.
</para>
<para>
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character after the 
offset is returned.
</para>
<para>
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start after the offset to the next word start.
</para>
<para>
The returned string will contain the word after the offset if the offset 
is inside a word or if the offset is not inside a word.
</para>
<para>
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end at or after the offset to the next work end.
</para>
<para>
The returned string will contain the word after the offset if the offset
is inside a word and will contain the word after the word after the offset
if the offset is not inside a word.
</para>
<para>
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
string is from the sentence start after the offset to the next sentence
start.
</para>
<para>
The returned string will contain the sentence after the offset if the offset
is inside a sentence or if the offset is not inside a sentence.
</para>
<para>
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end at or after the offset to the next sentence end.
</para>
<para>
The returned string will contain the sentence after the offset if the offset
is inside a sentence and will contain the sentence after the sentence
after the offset if the offset is not inside a sentence.
</para>
<para>
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start after the offset to the next line start.
</para>
<para>
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end at or after the offset to the next line start.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkText"><type>AtkText</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter>&nbsp;:</term>
<listitem><simpara> position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>boundary_type</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="AtkTextBoundary"><type>AtkTextBoundary</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start_offset</parameter>&nbsp;:</term>
<listitem><simpara> the start offset of the returned string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end_offset</parameter>&nbsp;:</term>
<listitem><simpara> the offset of the first character after the 
             returned substring
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the text after <parameter>offset</parameter> bounded by the specified <parameter>boundary_type</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-text-get-text-at-offset" role="function">
<title>atk_text_get_text_at_offset ()</title>
<indexterm zone="atk-text-get-text-at-offset"><primary>atk_text_get_text_at_offset</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              atk_text_get_text_at_offset         (<link linkend="AtkText">AtkText</link> *text,
                                                         <link linkend="gint">gint</link> offset,
                                                         <link linkend="AtkTextBoundary">AtkTextBoundary</link> boundary_type,
                                                         <link linkend="gint">gint</link> *start_offset,
                                                         <link linkend="gint">gint</link> *end_offset);</programlisting>
<para>
Gets the specified text.
</para>
<para>
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the
offset is returned.
</para>
<para>
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start at or before the offset to the word start after 
the offset.
</para>
<para>
The returned string will contain the word at the offset if the offset
is inside a word and will contain the word before the offset if the 
offset is not inside a word.
</para>
<para>
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string