tab-stops.xml

Pango is a library for layout and rendering of text, with an emphasis on internationalization. Pang

<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
<listitem><simpara> additional alignment/position pairs
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly allocated <link linkend="PangoTabArray"><type>PangoTabArray</type></link>, which should
              be freed with <link linkend="pango-tab-array-free"><function>pango_tab_array_free()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-tab-array-copy" role="function">
<title>pango_tab_array_copy ()</title>
<indexterm zone="pango-tab-array-copy"><primary>pango_tab_array_copy</primary></indexterm><programlisting><link linkend="PangoTabArray">PangoTabArray</link>*      pango_tab_array_copy                (<link linkend="PangoTabArray">PangoTabArray</link> *src);</programlisting>
<para>
Copies a <link linkend="PangoTabArray"><type>PangoTabArray</type></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>src</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="PangoTabArray"><type>PangoTabArray</type></link> to copy
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly allocated <link linkend="PangoTabArray"><type>PangoTabArray</type></link>, which should
              be freed with <link linkend="pango-tab-array-free"><function>pango_tab_array_free()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-tab-array-free" role="function">
<title>pango_tab_array_free ()</title>
<indexterm zone="pango-tab-array-free"><primary>pango_tab_array_free</primary></indexterm><programlisting><link linkend="void">void</link>                pango_tab_array_free                (<link linkend="PangoTabArray">PangoTabArray</link> *tab_array);</programlisting>
<para>
Frees a tab array and associated resources.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>tab_array</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoTabArray"><type>PangoTabArray</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-tab-array-get-size" role="function">
<title>pango_tab_array_get_size ()</title>
<indexterm zone="pango-tab-array-get-size"><primary>pango_tab_array_get_size</primary></indexterm><programlisting><link linkend="gint">gint</link>                pango_tab_array_get_size            (<link linkend="PangoTabArray">PangoTabArray</link> *tab_array);</programlisting>
<para>
Gets the number of tab stops in <parameter>tab_array</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>tab_array</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoTabArray"><type>PangoTabArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the number of tab stops in the array.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-tab-array-resize" role="function">
<title>pango_tab_array_resize ()</title>
<indexterm zone="pango-tab-array-resize"><primary>pango_tab_array_resize</primary></indexterm><programlisting><link linkend="void">void</link>                pango_tab_array_resize              (<link linkend="PangoTabArray">PangoTabArray</link> *tab_array,
                                                         <link linkend="gint">gint</link> new_size);</programlisting>
<para>
Resizes a tab array. You must subsequently initialize any tabs that
were added as a result of growing the array.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>tab_array</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoTabArray"><type>PangoTabArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_size</parameter>&nbsp;:</term>
<listitem><simpara> new size of the array
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-tab-array-set-tab" role="function">
<title>pango_tab_array_set_tab ()</title>
<indexterm zone="pango-tab-array-set-tab"><primary>pango_tab_array_set_tab</primary></indexterm><programlisting><link linkend="void">void</link>                pango_tab_array_set_tab             (<link linkend="PangoTabArray">PangoTabArray</link> *tab_array,
                                                         <link linkend="gint">gint</link> tab_index,
                                                         <link linkend="PangoTabAlign">PangoTabAlign</link> alignment,
                                                         <link linkend="gint">gint</link> location);</programlisting>
<para>
Sets the alignment and location of a tab stop.
<parameter>alignment</parameter> must always be <link linkend="PANGO-TAB-LEFT:CAPS"><type>PANGO_TAB_LEFT</type></link> in the current
implementation.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>tab_array</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoTabArray"><type>PangoTabArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tab_index</parameter>&nbsp;:</term>
<listitem><simpara> the index of a tab stop
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>alignment</parameter>&nbsp;:</term>
<listitem><simpara> tab alignment
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>location</parameter>&nbsp;:</term>
<listitem><simpara> tab location in Pango units
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-tab-array-get-tab" role="function">
<title>pango_tab_array_get_tab ()</title>
<indexterm zone="pango-tab-array-get-tab"><primary>pango_tab_array_get_tab</primary></indexterm><programlisting><link linkend="void">void</link>                pango_tab_array_get_tab             (<link linkend="PangoTabArray">PangoTabArray</link> *tab_array,
                                                         <link linkend="gint">gint</link> tab_index,
                                                         <link linkend="PangoTabAlign">PangoTabAlign</link> *alignment,
                                                         <link linkend="gint">gint</link> *location);</programlisting>
<para>
Gets the alignment and position of a tab stop.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>tab_array</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoTabArray"><type>PangoTabArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tab_index</parameter>&nbsp;:</term>
<listitem><simpara> tab stop index
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>alignment</parameter>&nbsp;:</term>
<listitem><simpara> location to store alignment, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>location</parameter>&nbsp;:</term>
<listitem><simpara> location to store tab position, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-tab-array-get-tabs" role="function">
<title>pango_tab_array_get_tabs ()</title>
<indexterm zone="pango-tab-array-get-tabs"><primary>pango_tab_array_get_tabs</primary></indexterm><programlisting><link linkend="void">void</link>                pango_tab_array_get_tabs            (<link linkend="PangoTabArray">PangoTabArray</link> *tab_array,
                                                         <link linkend="PangoTabAlign">PangoTabAlign</link> **alignments,
                                                         <link linkend="gint">gint</link> **locations);</programlisting>
<para>
If non-<link linkend="NULL:CAPS"><literal>NULL</literal></link>, <parameter>alignments</parameter> and <parameter>locations</parameter> are filled with allocated
arrays of length <link linkend="pango-tab-array-get-size"><function>pango_tab_array_get_size()</function></link>. You must free the
returned array.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>tab_array</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoTabArray"><type>PangoTabArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>alignments</parameter>&nbsp;:</term>
<listitem><simpara> location to store an array of tab stop alignments, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>locations</parameter>&nbsp;:</term>
<listitem><simpara> location to store an array of tab positions, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-tab-array-get-positions-in-pixels" role="function">
<title>pango_tab_array_get_positions_in_pixels ()</title>
<indexterm zone="pango-tab-array-get-positions-in-pixels"><primary>pango_tab_array_get_positions_in_pixels</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_tab_array_get_positions_in_pixels
                                                        (<link linkend="PangoTabArray">PangoTabArray</link> *tab_array);</programlisting>
<para>
Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the tab positions are in pixels, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if they are
in Pango units.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>tab_array</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoTabArray"><type>PangoTabArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> whether positions are in pixels.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>