vertical.xml

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

</para></refsect2>
<refsect2 id="PangoGravityHint" role="enum" condition="since:1.16">
<title>enum PangoGravityHint</title>
<indexterm zone="PangoGravityHint" role="1.16"><primary>PangoGravityHint</primary></indexterm><programlisting>typedef enum {
  PANGO_GRAVITY_HINT_NATURAL,
  PANGO_GRAVITY_HINT_STRONG,
  PANGO_GRAVITY_HINT_LINE
} PangoGravityHint;
</programlisting>
<para>
The <link linkend="PangoGravityHint"><type>PangoGravityHint</type></link> defines how horizontal scripts should behave in a
vertical context.  That is, English excerpt in a vertical paragraph for
example.
</para>
<para>
See <link linkend="PangoGravity"><type>PangoGravity</type></link>.</para>
<para>

</para><variablelist role="enum">
<varlistentry id="PANGO-GRAVITY-HINT-NATURAL:CAPS" role="constant">
<term><literal>PANGO_GRAVITY_HINT_NATURAL</literal></term>
<listitem><simpara> scripts will take their natural gravity based
on the base gravity and the script.  This is the default.
</simpara></listitem>
</varlistentry>
<varlistentry id="PANGO-GRAVITY-HINT-STRONG:CAPS" role="constant">
<term><literal>PANGO_GRAVITY_HINT_STRONG</literal></term>
<listitem><simpara> always use the base gravity set, regardless of
the script.
</simpara></listitem>
</varlistentry>
<varlistentry id="PANGO-GRAVITY-HINT-LINE:CAPS" role="constant">
<term><literal>PANGO_GRAVITY_HINT_LINE</literal></term>
<listitem><simpara> for scripts not in their natural direction (eg.
Latin in East gravity), choose per-script gravity such that every script
respects the line progression.  This means, Latin and Arabic will take
opposite gravities and both flow top-to-bottom for example.
</simpara></listitem>
</varlistentry>
</variablelist><para role="since">Since  1.16
</para></refsect2>
<refsect2 id="PANGO-TYPE-GRAVITY-HINT:CAPS" role="macro">
<title>PANGO_TYPE_GRAVITY_HINT</title>
<indexterm zone="PANGO-TYPE-GRAVITY-HINT:CAPS"><primary>PANGO_TYPE_GRAVITY_HINT</primary></indexterm><programlisting>#define PANGO_TYPE_GRAVITY_HINT (pango_gravity_hint_get_type())
</programlisting>
<para>
The <link linkend="GObject"><type>GObject</type></link> type for <link linkend="PangoGravity"><type>PangoGravity</type></link>.
</para></refsect2>
<refsect2 id="PANGO-GRAVITY-IS-VERTICAL:CAPS" role="macro" condition="since:1.16">
<title>PANGO_GRAVITY_IS_VERTICAL()</title>
<indexterm zone="PANGO-GRAVITY-IS-VERTICAL:CAPS" role="1.16"><primary>PANGO_GRAVITY_IS_VERTICAL</primary></indexterm><programlisting>#define             PANGO_GRAVITY_IS_VERTICAL(gravity)</programlisting>
<para>
Whether a <link linkend="PangoGravity"><type>PangoGravity</type></link> represents vertical writing directions.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>gravity</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="PangoGravity"><type>PangoGravity</type></link> to check
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.16
</para></refsect2>
<refsect2 id="pango-gravity-get-for-matrix" role="function" condition="since:1.16">
<title>pango_gravity_get_for_matrix ()</title>
<indexterm zone="pango-gravity-get-for-matrix" role="1.16"><primary>pango_gravity_get_for_matrix</primary></indexterm><programlisting><link linkend="PangoGravity">PangoGravity</link>        pango_gravity_get_for_matrix        (const <link linkend="PangoMatrix">PangoMatrix</link> *matrix);</programlisting>
<para>
Finds the gravity that best matches the rotation component
in a <link linkend="PangoMatrix"><type>PangoMatrix</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoMatrix"><type>PangoMatrix</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the gravity of <parameter>matrix</parameter>, which will never be
<link linkend="PANGO-GRAVITY-AUTO:CAPS"><literal>PANGO_GRAVITY_AUTO</literal></link>, or <link linkend="PANGO-GRAVITY-SOUTH:CAPS"><literal>PANGO_GRAVITY_SOUTH</literal></link> if <parameter>matrix</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.16
</para></refsect2>
<refsect2 id="pango-gravity-get-for-script" role="function" condition="since:1.16">
<title>pango_gravity_get_for_script ()</title>
<indexterm zone="pango-gravity-get-for-script" role="1.16"><primary>pango_gravity_get_for_script</primary></indexterm><programlisting><link linkend="PangoGravity">PangoGravity</link>        pango_gravity_get_for_script        (<link linkend="PangoScript">PangoScript</link> script,
                                                         <link linkend="PangoGravity">PangoGravity</link> base_gravity,
                                                         <link linkend="PangoGravityHint">PangoGravityHint</link> hint);</programlisting>
<para>
Based on the script, base gravity, and hint, returns actual gravity
to use in laying out a single <link linkend="PangoItem"><type>PangoItem</type></link>.
</para>
<para>
If <parameter>base_gravity</parameter> is <link linkend="PANGO-GRAVITY-AUTO:CAPS"><literal>PANGO_GRAVITY_AUTO</literal></link>, it is first replaced with the
preferred gravity of <parameter>script</parameter>.  To get the preferred gravity of a script,
pass <link linkend="PANGO-GRAVITY-AUTO:CAPS"><literal>PANGO_GRAVITY_AUTO</literal></link> and <link linkend="PANGO-GRAVITY-HINT-STRONG:CAPS"><literal>PANGO_GRAVITY_HINT_STRONG</literal></link> in.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>script</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="PangoScript"><type>PangoScript</type></link> to query
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>base_gravity</parameter>&nbsp;:</term>
<listitem><simpara> base gravity of the paragraph
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hint</parameter>&nbsp;:</term>
<listitem><simpara> orientation hint
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> resolved gravity suitable to use for a run of text

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.16
</para></refsect2>
<refsect2 id="pango-gravity-to-rotation" role="function" condition="since:1.16">
<title>pango_gravity_to_rotation ()</title>
<indexterm zone="pango-gravity-to-rotation" role="1.16"><primary>pango_gravity_to_rotation</primary></indexterm><programlisting><link linkend="double">double</link>              pango_gravity_to_rotation           (<link linkend="PangoGravity">PangoGravity</link> gravity);</programlisting>
<para>
Converts a <link linkend="PangoGravity"><type>PangoGravity</type></link> value to its natural rotation in radians.
<parameter>gravity</parameter> should not be <link linkend="PANGO-GRAVITY-AUTO:CAPS"><literal>PANGO_GRAVITY_AUTO</literal></link>.
</para>
<para>
Note that <link linkend="pango-matrix-rotate"><function>pango_matrix_rotate()</function></link> takes angle in degrees, not radians.
So, to call <link linkend="pango-matrix-rotate"><function>pango_matrix_rotate()</function></link> with the output of this function
you should multiply it by (180. / G_PI).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>gravity</parameter>&nbsp;:</term>
<listitem><simpara> gravity to query
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the rotation value corresponding to <parameter>gravity</parameter>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.16
</para></refsect2>

</refsect1>



<refsect1 id="pango-Vertical-Text.see-also">
<title>See Also</title>
<para>
<link linkend="pango-context-get-base-gravity"><function>pango_context_get_base_gravity()</function></link>,
<link linkend="pango-context-set-base-gravity"><function>pango_context_set_base_gravity()</function></link>,
<link linkend="pango-context-get-gravity"><function>pango_context_get_gravity()</function></link>,
<link linkend="pango-context-get-gravity-hint"><function>pango_context_get_gravity_hint()</function></link>,
<link linkend="pango-context-set-gravity-hint"><function>pango_context_set_gravity_hint()</function></link>,
<link linkend="pango-font-description-set-gravity"><function>pango_font_description_set_gravity()</function></link>,
<link linkend="pango-font-description-get-gravity"><function>pango_font_description_get_gravity()</function></link>,
<link linkend="pango-attr-gravity-new"><function>pango_attr_gravity_new()</function></link>,
<link linkend="pango-attr-gravity-hint-new"><function>pango_attr_gravity_hint_new()</function></link>
</para>
</refsect1>

</refentry>