<?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="class-pangofontfamily">
  <refnamediv>
    <refname>pango.FontFamily</refname>
    <refpurpose>an object representing a family of related font
faces.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>pango.FontFamily</classname></ooclass>
      <ooclass><classname><link
linkend="class-gobject">gobject.GObject</link></classname></ooclass>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-pangofontfamily--list-faces">list_faces</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-pangofontfamily--get-name">get_name</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-pangofontfamily--is-monospace">is_monospace</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-pangofontfamily">pango.FontFamily</link>
</synopsis>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>The <link
linkend="class-pangofontfamily"><classname>pango.FontFamily</classname></link> 
object is used to represent a family of related font faces. The faces in a
family share a common design, but differ in slant, weight, width and other
aspects. A list of <link
linkend="class-pangofontfamily"><classname>pango.FontFamily</classname></link> 
objects can be retrieved  from a <link
linkend="class-pangocontext"><classname>pango.Context</classname></link>
object using the <link
linkend="method-pangocontext--list-families"><methodname>pango.Context.list_families</methodname>()</link> 
method and from a <link
linkend="class-pangofontmap"><classname>pango.FontMap</classname></link>
object using the <link
linkend="method-pangofontmap--list-families"><methodname>pango.FontMap.list_families</methodname>()</link> 
method.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

  <refsect2 id="method-pangofontfamily--list-faces">
      <title>pango.FontFamily.list_faces</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>list_faces</methodname>
	  <methodparam></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a list of <link
linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
objects.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>list_faces</methodname>() method returns a list
of the different <link
linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
object that make up the font family>. The faces in a family share a common
design, but differ in slant, weight, width and other aspects.</para>

    </refsect2>

    <refsect2 id="method-pangofontfamily--get-name">
      <title>pango.FontFamily.get_name</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_name</methodname>
	  <methodparam></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the name of the family.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_name</methodname>() method returns a string
containing the name of the font family. The name is unique among all fonts
for the font backend and can be used in a <link
linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link> 
to specify that a face from this family is desired.</para>

    </refsect2>

    <refsect2 id="method-pangofontfamily--is-monospace">
      <title>pango.FontFamily.is_monospace</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>is_monospace</methodname>
	  <methodparam></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the font family is
	  monospace.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>is_monospace</methodname>() method returns
      <literal>True</literal> if the font family describes a monospace
      font. A monospace font is a font designed for text display where the
      the characters form a regular grid. For Western languages this would
      mean that the advance width of all characters are the same, but this
      categorization also includes Asian fonts which include double-width
      characters: characters that occupy two grid cells. The best way to
      find out the grid-cell size is to call the <link
      linkend="method-pangofontmetrics--get-approximate-digit-width"><methodname>get_approximate_digit_width</methodname>()</link>
      method, since the results of the <link
      linkend="method-pangofontmetrics--get-approximate-char-width"><methodname>get_approximate_char_width</methodname>()</link></para>

    </refsect2>

  </refsect1>

</refentry>
