atktext.xml

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

<listitem><simpara> Specify whether coordinates are relative to the screen or widget window.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x_clip_type</parameter>&nbsp;:</term>
<listitem><simpara> Specify the horizontal clip type.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y_clip_type</parameter>&nbsp;:</term>
<listitem><simpara> Specify the vertical clip type.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Array of AtkTextRange. The last element of the array returned 
         by this function will be NULL.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-get-range-extents"/>atk_text_get_range_extents ()</title>
<indexterm><primary>atk_text_get_range_extents</primary></indexterm><programlisting><link linkend="void">void</link>        atk_text_get_range_extents      (<link linkend="AtkText">AtkText</link> *text,
                                             <link linkend="gint">gint</link> start_offset,
                                             <link linkend="gint">gint</link> end_offset,
                                             <link linkend="AtkCoordType">AtkCoordType</link> coord_type,
                                             <link linkend="AtkTextRectangle">AtkTextRectangle</link> *rect);</programlisting>
<para>
Get the bounding box for text within the specified range.</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> The offset of the first text character for which boundary 
       information is required.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end_offset</parameter>&nbsp;:</term>
<listitem><simpara> The offset of the text character after the last character 
       for which boundary information is required.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>coord_type</parameter>&nbsp;:</term>
<listitem><simpara> Specify whether coordinates are relative to the screen or widget window.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rect</parameter>&nbsp;:</term>
<listitem><simpara> A pointer to a AtkTextRectangle which is filled in by this function.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-free-ranges"/>atk_text_free_ranges ()</title>
<indexterm><primary>atk_text_free_ranges</primary></indexterm><programlisting><link linkend="void">void</link>        atk_text_free_ranges            (<link linkend="AtkTextRange">AtkTextRange</link> **ranges);</programlisting>
<para>
Frees the memory associated with an array of AtkTextRange. It is assumed
that the array was returned by the function atk_text_get_bounded_ranges
and is NULL terminated.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ranges</parameter>&nbsp;:</term>
<listitem><simpara> A pointer to an array of  <link linkend="AtkTextRange"><type>AtkTextRange</type></link> which is to be freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-get-n-selections"/>atk_text_get_n_selections ()</title>
<indexterm><primary>atk_text_get_n_selections</primary></indexterm><programlisting><link linkend="gint">gint</link>        atk_text_get_n_selections       (<link linkend="AtkText">AtkText</link> *text);</programlisting>
<para>
Gets the number of selected regions.</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><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of selected regions, or -1 if a failure
  occurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-get-selection"/>atk_text_get_selection ()</title>
<indexterm><primary>atk_text_get_selection</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      atk_text_get_selection          (<link linkend="AtkText">AtkText</link> *text,
                                             <link linkend="gint">gint</link> selection_num,
                                             <link linkend="gint">gint</link> *start_offset,
                                             <link linkend="gint">gint</link> *end_offset);</programlisting>
<para>
Gets the text from the specified selection.</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>selection_num</parameter>&nbsp;:</term>
<listitem><simpara> The selection number.  The selected regions are
assigned numbers that correspond to how far the region is from the
start of the text.  The selected region closest to the beginning
of the text region is assigned the number 0, etc.  Note that adding,
moving or deleting a selected region can change the numbering.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start_offset</parameter>&nbsp;:</term>
<listitem><simpara> passes back the start position of the selected region
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end_offset</parameter>&nbsp;:</term>
<listitem><simpara> passes back the end position of the selected region
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the selected text.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-add-selection"/>atk_text_add_selection ()</title>
<indexterm><primary>atk_text_add_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    atk_text_add_selection          (<link linkend="AtkText">AtkText</link> *text,
                                             <link linkend="gint">gint</link> start_offset,
                                             <link linkend="gint">gint</link> end_offset);</programlisting>
<para>
Adds a selection bounded by the specified offsets.</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> the start position of the selected region
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end_offset</parameter>&nbsp;:</term>
<listitem><simpara> the end position of the selected region
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if success, <literal>FALSE</literal> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-remove-selection"/>atk_text_remove_selection ()</title>
<indexterm><primary>atk_text_remove_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    atk_text_remove_selection       (<link linkend="AtkText">AtkText</link> *text,
                                             <link linkend="gint">gint</link> selection_num);</programlisting>
<para>
Removes the specified selection.</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>selection_num</parameter>&nbsp;:</term>
<listitem><simpara> The selection number.  The selected regions are
assigned numbers that correspond to how far the region is from the
start of the text.  The selected region closest to the beginning
of the text region is assigned the number 0, etc.  Note that adding,
moving or deleting a selected region can change the numbering.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if success, <literal>FALSE</literal> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-set-selection"/>atk_text_set_selection ()</title>
<indexterm><primary>atk_text_set_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    atk_text_set_selection          (<link linkend="AtkText">AtkText</link> *text,
                                             <link linkend="gint">gint</link> selection_num,
                                             <link linkend="gint">gint</link> start_offset,
                                             <link linkend="gint">gint</link> end_offset);</programlisting>
<para>
Changes the start and end offset of the specified selection.</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>selection_num</parameter>&nbsp;:</term>
<listitem><simpara> The selection number.  The selected regions are
assigned numbers that correspond to how far the region is from the
start of the text.  The selected region closest to the beginning
of the text region is assigned the number 0, etc.  Note that adding,
moving or deleting a selected region can change the numbering.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start_offset</parameter>&nbsp;:</term>
<listitem><simpara> the new start position of the selection
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end_offset</parameter>&nbsp;:</term>
<listitem><simpara> the new end position of the selection
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if success, <literal>FALSE</literal> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-set-caret-offset"/>atk_text_set_caret_offset ()</title>
<indexterm><primary>atk_text_set_caret_offset</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    atk_text_set_caret_offset       (<link linkend="AtkText">AtkText</link> *text,
                                             <link linkend="gint">gint</link> offset);</programlisting>
<para>
Sets the caret (cursor) position to the specified <parameter>offset</parameter>.</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> <literal>TRUE</literal> if success, <literal>FALSE</literal> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-attribute-set-free"/>atk_attribute_set_free ()</title>
<indexterm><primary>atk_attribute_set_free</primary></indexterm><programlisting><link linkend="void">void</link>        atk_attribute_set_free          (<link linkend="AtkAttributeSet">AtkAttributeSet</link> *attrib_set);</programlisting>
<para>
Frees the memory used by an <link linkend="AtkAttributeSet"><type>AtkAttributeSet</type></link>, including all its
<link linkend="AtkAttributes"><type>AtkAttributes</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>attrib_set</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkAttributeSet"><type>AtkAttributeSet</type></link> to free
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-attribute-register"/>atk_text_attribute_register ()</title>
<indexterm><primary>atk_text_attribute_register</primary></indexterm><programlisting><link linkend="AtkTextAttribute">AtkTextAttribute</link> atk_text_attribute_register
                                            (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Associate <parameter>name</parameter> with a new <link linkend="AtkTextAttribute"><type>AtkTextAttribute</type></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> a name string
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an <link linkend="AtkTextAttribute"><type>AtkTextAttribute</type></link> associated with <parameter>name</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-attribute-get-name"/>atk_text_attribute_get_name ()</title>
<indexterm><primary>atk_text_attribute_get_name</primary></indexterm><programlisting>G_CONST_RETURN <link linkend="gchar">gchar</link>* atk_text_attribute_get_name
                                            (<link linkend="AtkTextAttribute">AtkTextAttribute</link> attr);</programlisting>
<para>
Gets the name corresponding to the <link linkend="AtkTextAttribute"><type>AtkTextAttribute</type></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>attr</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkTextAttribute"><type>AtkTextAttribute</type></link> whose name is required
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a string containing the name; this string should not be freed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-text-attribute-for-name"/>atk_text_attribute_for_name ()</title>
<indexterm><primary>atk_text_attribute_for_name</primary></indexterm><programlisting><link linkend="AtkTextAttribute">AtkTextAttribute</link> atk_text_attribute_for_name
                                            (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Get the <link linkend="AtkTextAttribute"><type>AtkTextAttribute</type></link> type corresponding to a text attribute name.</para>
<para>

</para><variablelist role="params">
<varlistentry><