path: root/docs/reference/pygtk-pango-constants.xml

<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="pango-constants">
  <refnamediv>
    <refname>pango Constants</refname>
    <refpurpose>the built-in constants of the pango module</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <programlisting>
<xref linkend="pango-alignment-constants" endterm="pango-alignment-constants-title"></xref>
<xref linkend="pango-attribute-type-constants" endterm="pango-attribute-type-constants-title"></xref>
<xref linkend="pango-coverage-level-constants" endterm="pango-coverage-level-constants-title"></xref>
<xref linkend="pango-direction-constants" endterm="pango-direction-constants-title"></xref>
<xref linkend="pango-ellipsize-mode-constants" endterm="pango-ellipsize-mode-constants-title"></xref>
<xref linkend="pango-font-mask-constants" endterm="pango-font-mask-constants-title"></xref>
<xref linkend="pango-render-part-constants" endterm="pango-render-part-constants-title"></xref>
<xref linkend="pango-scale-constants" endterm="pango-scale-constants-title"></xref>
<xref linkend="pango-stretch-constants" endterm="pango-stretch-constants-title"></xref>
<xref linkend="pango-style-constants" endterm="pango-style-constants-title"></xref>
<xref linkend="pango-tab-constants" endterm="pango-tab-constants-title"></xref>
<xref linkend="pango-underline-constants" endterm="pango-underline-constants-title"></xref>
<xref linkend="pango-variant-constants" endterm="pango-variant-constants-title"></xref>
<xref linkend="pango-weight-constants" endterm="pango-weight-constants-title"></xref>
<xref linkend="pango-wrap-mode-constants" endterm="pango-wrap-mode-constants-title"></xref>
</programlisting>

  </refsect1>

  <refsect1 id="pango-constants-description">
    <title>Description</title>

    <refsect2 id="pango-alignment-constants">
      <title id="pango-alignment-constants-title">Pango Alignment Constants</title>

      <para>The Alignment constants specify how to align the lines of a
<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
within the available space. If the <link
linkend="class-pangolayout"><classname>pango.Layout</classname></link> is
set to justify using the <link
linkend="method-pangolayout--set-justify"><methodname>pango.Layout.set_justify</methodname>()</link>
method, then this only has an effect for partial lines.</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.ALIGN_LEFT</literal></term>
	  <listitem>
	    <simpara>Put all available space on the right</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ALIGN_CENTER</literal></term>
	  <listitem>
	    <simpara>Center the line within the available space</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ALIGN_RIGHT</literal></term>
	  <listitem>
	    <simpara>Put all available space on the left</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-attribute-type-constants">
      <title id="pango-attribute-type-constants-title">Pango Attribute Type Constants</title>

      <para>The Attribute Type constants specify the type of a <link
linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>.Along
with the predefined values, it is possible to allocate additional values for
custom attributes using the <link
linkend="function-pango--attr-type-register"><function>pango.attr_type_register</function>()</link>
function. The predefined values are given below. The type of structure used
to store the attribute is listed in parentheses after the
description.</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.ATTR_LANGUAGE</literal></term>
	  <listitem>
	    <simpara>Specifies a <link
linkend="class-pangolanguage"><classname>pango.Language</classname></link>.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_FAMILY</literal></term>
	  <listitem>
	    <simpara>Specifies a font family name list as a string.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_STYLE</literal></term>
	  <listitem>
	    <simpara>Specifies a font slant style. See the <link
linkend="function-pango--attrstyle"><function>pango.AttrStyle</function>()</link> 
function for more details.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_WEIGHT</literal></term>
	  <listitem>
	    <simpara>Specifies a font weight. See the <link
linkend="function-pango--attrweight"><function>pango.AttrWeight</function>()</link> 
function for more detail.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_VARIANT</literal></term>
	  <listitem>
	    <simpara>Specifies a font variant (normal or small caps). See the
<link
linkend="function-pango--attrvariant"><function>pango.AttrVariant</function>()</link> 
function for more detail.</simpara>
	  </listitem> 
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_STRETCH</literal></term>
	  <listitem>
	    <simpara>Specifies a font stretch. See the <link
linkend="function-pango--attrstretch"><function>pango.AttrStretch</function>()</link> 
function for more details.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_SIZE</literal></term>
	  <listitem>
	    <simpara>Specifies a font size in thousandths of a point.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_FONT_DESC</literal></term>
	  <listitem>
	    <simpara>Specifies a <link
linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_FOREGROUND</literal></term>
	  <listitem>
	    <simpara>Specifies a foreground <link
linkend="class-pangocolor"><classname>pango.Color</classname></link>.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_BACKGROUND</literal></term>
	  <listitem>
	    <simpara>Specifies a background <link
linkend="class-pangocolor"><classname>pango.Color</classname></link>.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_UNDERLINE</literal></term>
	  <listitem>
	    <simpara>Specifies an underline style. See the <link
linkend="function-pango--attrunderline"><function>pango.AttrUnderline</function>()</link> 
function for more details.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_STRIKETHROUGH</literal></term>
	  <listitem>
	    <simpara>If <literal>True</literal> the text is struck
through.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_RISE</literal></term>
	  <listitem>
	    <simpara>Specifies the displacement of the text from the
baseline.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_SHAPE</literal></term>
	  <listitem>
	    <simpara>Specifies a shape. See the <link
linkend="function-pango--attrshape"><function>pango.AttrShape</function>()</link> 
function for more details.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_SCALE</literal></term>
	  <listitem>
	    <simpara>Specifies a font size scale factor.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ATTR_FALLBACK</literal></term>
	  <listitem>
	    <simpara>if <literal>True</literal>, fallback to other fonts is
	  enabled (</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-coverage-level-constants">
      <title id="pango-coverage-level-constants-title">Pango Coverage Level Constants</title>

      <para></para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.COVERAGE_NONE</literal></term>
	  <listitem>
	    <simpara>The character is not representable with the
	    font.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.COVERAGE_FALLBACK</literal></term>
	  <listitem>
	    <simpara>The character is represented in a way that may be
	    comprehensible but is not the correct graphical form. For
	    instance, a Hangul character represented as a a sequence of
	    Jamos, or a Latin transliteration of a Cyrillic word.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.COVERAGE_APPROXIMATE</literal></term>
	  <listitem>
	    <simpara>The character is represented as basically the correct
	    graphical form, but with a stylistic variant inappropriate for
	    the current script.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.COVERAGE_EXACT</literal></term>
	  <listitem>
	    <simpara>The character is represented as the correct graphical
	    form.</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-direction-constants">
      <title id="pango-direction-constants-title">Pango Direction Constants</title>

      <para>The pango Direction constants specify a direction in the Unicode
bidirectional algorithm. Not every value in this enumeration makes sense for
every usage of pango Direction.<!-- for example, the return value of the <link
linkend="function-pango- -unichar-direction"><function>pango.unichar_direction</function>()</link>
and <link
linkend="function-pango- -find-base-direction"><function>pango.find_base_direction</function>()</link>
functions cannot be <literal>pango.DIRECTION_WEAK_LTR</literal> or
<literal>pango.DIRECTION_WEAK_RTL</literal>, since every character is either
neutral or has a strong direction.--></para>

      <para>The <literal>pango.DIRECTION_TTB_LTR</literal>,
<literal>pango.DIRECTION_TTB_RTL</literal> values come from an earlier
interpretation of this enumeration as the writing direction of a block of
text and are no longer used; See the Text module of the CSS3 spec for how
vertical text is planned to be handled in a future version of Pango. The
explanation of why <literal>pango.DIRECTION_TTB_LTR</literal> is treated as
<literal>pango.DIRECTION_RTL</literal> can be found there as well.</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.DIRECTION_LTR</literal></term>
	  <listitem>
	    <simpara>A strong left-to-right direction</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.DIRECTION_RTL</literal></term>
	  <listitem>
	    <simpara>A strong right-to-left direction</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.DIRECTION_TTB_LTR</literal></term>
	  <listitem>
	    <simpara>Deprecated value; treated the same as
	    <literal>pango.DIRECTION_RTL</literal>.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.DIRECTION_TTB_RTL</literal></term>
	  <listitem>
	    <simpara>Deprecated value; treated the same as
	    <literal>pango.DIRECTION_LTR</literal></simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.DIRECTION_WEAK_LTR</literal></term>
	  <listitem>
	    <simpara>A weak left-to-right direction</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.DIRECTION_WEAK_RTL</literal></term>
	  <listitem>
	    <simpara>A weak right-to-left direction</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.DIRECTION_NEUTRAL</literal></term>
	  <listitem>
	    <simpara>No direction specified</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-ellipsize-mode-constants">
      <title id="pango-ellipsize-mode-constants-title">Pango Ellipsize Mode Constants</title>

      <para>The Ellipsize Mode constants specify what sort of (if any)
ellipsization should be applied to a line of text. In the ellipsization
process characters are removed from the text in order to make it fit to a
given width and replaced with an ellipsis (...).</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.ELLIPSIZE_NONE</literal></term>
	  <listitem>
	    <simpara> No ellipsization.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ELLIPSIZE_START</literal></term>
	  <listitem>
	    <simpara>Omit characters at the start of the text.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ELLIPSIZE_MIDDLE</literal></term>
	  <listitem>
	    <simpara> Omit characters in the middle of the text.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.ELLIPSIZE_END</literal></term>
	  <listitem>
	    <simpara> Omit characters at the end of the text.</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-font-mask-constants">
      <title id="pango-font-mask-constants-title">Pango Font Mask Flag Constants</title>

      <para>The Font Mask flag constants are bit-flags that correspond to
fields in a <link
linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
that have been set.</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.FONT_MASK_FAMILY</literal></term>
	  <listitem>
	    <simpara>the font family is specified.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.FONT_MASK_STYLE</literal></term>
	  <listitem>
	    <simpara>the font style is specified.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.FONT_MASK_VARIANT</literal></term>
	  <listitem>
	    <simpara>the font variant is specified.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.FONT_MASK_WEIGHT</literal></term>
	  <listitem>
	    <simpara>the font weight is specified.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.FONT_MASK_STRETCH</literal></term>
	  <listitem>
	    <simpara>the font stretch is specified.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.FONT_MASK_SIZE</literal></term>
	  <listitem>
	    <simpara>the font size is specified.</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-render-part-constants">
      <title id="pango-render-part-constants-title">Pango Render Part Constants</title>

      <para></para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.RENDER_PART</literal></term>
	  <listitem>
	    <simpara>The <literal>pango.RENDER_PART</literal> constants
define different items to render for purposes such as setting
colors. Available since PyGTK 2.8.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.RENDER_PART_FOREGROUND</literal></term>
	  <listitem>
	    <simpara>The text itself.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.RENDER_PART_BACKGROUND</literal></term>
	  <listitem>
	    <simpara>The area behind the text.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.RENDER_PART_UNDERLINE</literal></term>
	  <listitem>
	    <simpara>The underlined areas.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.RENDER_PART_STRIKETHROUGH</literal></term>
	  <listitem>
	    <simpara>The strikethrough areas.</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-scale-constants">
      <title id="pango-scale-constants-title">Pango Scale Constants</title>

      <para></para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.SCALE</literal></term>
	  <listitem>
	    <simpara>The <literal>pango.SCALE</literal> constant represents
	    the scale between dimensions used for Pango distances and device
	    units. (The definition of device units is dependent on the
	    output device; it will typically be pixels for a screen, and
	    points for a printer.) <literal>pango.SCALE</literal> is
	    currently 1024, but this may be changed in the future. When
	    setting font sizes, device units are always considered to be
	    points (as in "12 point font"), rather than pixels.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.SCALE_XX_SMALL</literal></term>
	  <listitem>
	    <simpara>The scale factor for three shrinking steps
(1 / (1.2 * 1.2 * 1.2)).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.SCALE_X_SMALL</literal></term>
	  <listitem>
	    <simpara>The scale factor for two shrinking steps
(1 / (1.2 * 1.2)).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.SCALE_SMALL</literal></term>
	  <listitem>
	    <simpara>The scale factor for one shrinking step
(1 / 1.2).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.SCALE_MEDIUM</literal></term>
	  <listitem>
	    <simpara>The scale factor for normal size (1.0).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.SCALE_LARGE</literal></term>
	  <listitem>
	    <simpara>The scale factor for one magnification step
(1.2).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.SCALE_X_LARGE</literal></term>
	  <listitem>
	    <simpara>he scale factor for two magnification steps
(1.2 * 1.2).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.SCALE_XX_LARGE</literal></term>
	  <listitem>
	    <simpara>The scale factor for three magnification steps
(1.2 * 1.2 * 1.2).</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-stretch-constants">
      <title id="pango-stretch-constants-title">Pango Stretch Constants</title>

      <para>The Stretch constants specify the width of the font relative to
other designs within a family.</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.STRETCH_ULTRA_CONDENSED</literal></term>
	  <listitem>
	    <simpara>The most narrow width</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.STRETCH_EXTRA_CONDENSED</literal></term>
	  <listitem>
	    <simpara></simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.STRETCH_CONDENSED</literal></term>
	  <listitem>
	    <simpara></simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.STRETCH_SEMI_CONDENSED</literal></term>
	  <listitem>
	    <simpara></simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.STRETCH_NORMAL</literal></term>
	  <listitem>
	    <simpara>The normal width.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.STRETCH_SEMI_EXPANDED</literal></term>
	  <listitem>
	    <simpara></simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.STRETCH_EXPANDED</literal></term>
	  <listitem>
	    <simpara></simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.STRETCH_EXTRA_EXPANDED</literal></term>
	  <listitem>
	    <simpara></simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.STRETCH_ULTRA_EXPANDED</literal></term>
	  <listitem>
	    <simpara>The most expanded width</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-style-constants">
      <title id="pango-style-constants-title">Pango Style Constants</title>

      <para>The Style constants specify the various slant styles possible
for a font.</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.STYLE_NORMAL</literal></term>
	  <listitem>
	    <simpara>The font is upright.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.STYLE_OBLIQUE</literal></term>
	  <listitem>
	    <simpara>The font is slanted in a roman style.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.STYLE_ITALIC</literal></term>
	  <listitem>
	    <simpara>The font is slanted in an italic style.</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-tab-constants">
      <title id="pango-tab-constants-title">Pango Tab Constants</title>

      <para>The Tab constants specify where a tab stop appears relative to
the text.</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.TAB_LEFT</literal></term>
	  <listitem>
	    <simpara>the tab stop appears to the left of the text.</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-underline-constants">
      <title id="pango-underline-constants-title">Pango Underline Constants</title>

      <para>The Underline constants specify he type of underlining (if any)
to be used.</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.UNDERLINE_NONE</literal></term>
	  <listitem>
	    <simpara>No underline should be drawn.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.UNDERLINE_SINGLE</literal></term>
	  <listitem>
	    <simpara>A single underline should be drawn.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.UNDERLINE_DOUBLE</literal></term>
	  <listitem>
	    <simpara>A double underline should be drawn.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.UNDERLINE_LOW</literal></term>
	  <listitem>
	    <simpara>A single underline should be drawn at a position
beneath the ink extents of the text being underlined. This should be used
only for underlining single characters, such as for keyboard accelerators.
<literal>pango.UNDERLINE_SINGLE</literal> should be used for extended
portions of text.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.UNDERLINE_ERROR</literal></term>
	  <listitem>
	    <simpara>a wavy underline should be drawn below. This underline is typically
	      used to indicate an error such as a possilble mispelling; in some cases a
	      contrasting color may automatically be used. This type of underlining is
	      available since Pango 1.4.</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-variant-constants">
      <title id="pango-variant-constants-title">Pango Variant Constants</title>

      <para>The Variant constants specify the capitalization variant of the
font.</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.VARIANT_NORMAL</literal></term>
	  <listitem>
	    <simpara>A normal font.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.VARIANT_SMALL_CAPS</literal></term>
	  <listitem>
	    <simpara>A font with the lower case characters replaced by
smaller variants of the capital characters.</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-weight-constants">
      <title id="pango-weight-constants-title">Pango Weight Constants</title>

      <para>The Weight constants specify the weight (boldness) of a
font. This is a numerical value ranging from 100 to 900, but there are some
predefined values:</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.WEIGHT_ULTRALIGHT</literal></term>
	  <listitem>
	    <simpara>The ultralight weight (= 200).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.WEIGHT_LIGHT</literal></term>
	  <listitem>
	    <simpara>The light weight (=300).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.WEIGHT_NORMAL</literal></term>
	  <listitem>
	    <simpara>The default weight (= 400).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.WEIGHT_BOLD</literal></term>
	  <listitem>
	    <simpara>The bold weight (= 700).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.WEIGHT_ULTRABOLD</literal></term>
	  <listitem>
	    <simpara>The ultrabold weight (= 800).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.WEIGHT_HEAVY</literal></term>
	  <listitem>
	    <simpara>The heavy weight (= 900).</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="pango-wrap-mode-constants">
      <title id="pango-wrap-mode-constants-title">Pango Wrap Mode Constants</title>

      <para>The Wrap Mode constants specify how to wrap the lines of a <link
linkend="class-pangolayout"><classname>pango.Layout</classname></link> to
the desired width.</para>

      <variablelist>
	<varlistentry>
	  <term><literal>pango.WRAP_WORD</literal></term>
	  <listitem>
	    <simpara>wrap lines at word boundaries.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.WRAP_CHAR</literal></term>
	  <listitem>
	    <simpara>wrap lines at character boundaries.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>pango.WRAP_WORD_CHAR</literal></term>
	  <listitem>
	    <simpara>wrap lines at word boundaries, but fall back to
	    character boundaries if there is not enough space for a full
	    word.</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

  </refsect1>

</refentry>