atktext.xml

linux下图形库开发包atk-1.4.0.tar.gz

<varlistentry>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<title><anchor id="atk-text-get-text"/>atk_text_get_text ()</title>
<indexterm><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> :</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>
<title><anchor id="atk-text-get-character-at-offset"/>atk_text_get_character_at_offset ()</title>
<indexterm><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> :</term><listitem><simpara> the character at <parameter>offset</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-get-text-after-offset"/>atk_text_get_text_after_offset ()</title>
<indexterm><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 end offset of the returned string.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the text after <parameter>offset</parameter> bounded by the specified <parameter>boundary_type</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-get-text-at-offset"/>atk_text_get_text_at_offset ()</title>
<indexterm><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
is from the word end before the offset to the word end at or 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 after to 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 at or before the offset to the sentence
start after the offset.
</para>
<para>
The returned string will contain the sentence at the offset if the offset
is inside a sentence and will contain the sentence before the offset 
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 before the offset to the sentence end at or
after the offset.
</para>
<para>
The returned string will contain the sentence at the offset if the offset
is inside a sentence and will contain 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 at or before the offset to the line
start after the offset.
</para>
<para>
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end before the offset to the line end at or after
the offset.</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 end offset of the returned string.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the text at <parameter>offset</parameter> bounded by the specified <parameter>boundary_type</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-get-text-before-offset"/>atk_text_get_text_before_offset ()</title>
<indexterm><primary>atk_text_get_text_before_offset</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      atk_text_get_text_before_offset (<link linkend="AtkText">AtkText</link> *text,