diff options
Diffstat (limited to 'docs/reference/pygtk-pangofont.xml')
| -rw-r--r-- | docs/reference/pygtk-pangofont.xml | 352 |
1 files changed, 0 insertions, 352 deletions
diff --git a/docs/reference/pygtk-pangofont.xml b/docs/reference/pygtk-pangofont.xml deleted file mode 100644 index f1e7bf87..00000000 --- a/docs/reference/pygtk-pangofont.xml +++ /dev/null @@ -1,352 +0,0 @@ -<?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-pangofont"> - <refnamediv> - <refname>pango.Font</refname> - <refpurpose>a rendering-system independent font -representation.</refpurpose> - </refnamediv> - - <refsect1> - <title>Synopsis</title> - - <classsynopsis language="python"> - <ooclass><classname>pango.Font</classname></ooclass> - <ooclass><classname><link -linkend="class-gobject">gobject.GObject</link></classname></ooclass> - <methodsynopsis language="python"> - <methodname><link -linkend="method-pangofont--describe">describe</link></methodname> - <methodparam></methodparam> </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-pangofont--get-metrics">get_metrics</link></methodname> - <methodparam><parameter - role="keyword">language</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-pangofont--get-glyph-extents">get_glyph_extents</link></methodname> - <methodparam><parameter - role="keyword">glyph</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-pangofont--get-font-map">get_font_map</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - </classsynopsis> - -<programlisting> -<emphasis role="bold">Functions</emphasis> - -<methodsynopsis language="python"> - <methodname><link linkend="function-pango--PIXELS">pango.PIXELS</link></methodname> - <methodparam><parameter role="keyword">size</parameter></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link linkend="function-pango--ASCENT">pango.ASCENT</link></methodname> - <methodparam><parameter role="keyword">rect</parameter></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link linkend="function-pango--DESCENT">pango.DESCENT</link></methodname> - <methodparam><parameter role="keyword">rect</parameter></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link linkend="function-pango--RBEARING">pango.RBEARING</link></methodname> - <methodparam><parameter role="keyword">rect</parameter></methodparam> - </methodsynopsis><methodsynopsis language="python"> - <methodname><link linkend="function-pango--LBEARING">pango.LBEARING</link></methodname> - <methodparam><parameter role="keyword">rect</parameter></methodparam> - </methodsynopsis></programlisting> - - </refsect1> - - <refsect1> - <title>Ancestry</title> - -<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link> - +-- <link linkend="class-pangofont">pango.Font</link> -</synopsis> - - </refsect1> - - <refsect1> - <title>Description</title> - - <para>A <link -linkend="class-pangofont"><classname>pango.Font</classname></link> object -represents a font in a rendering-system independent way. A <link -linkend="class-pangofont"><classname>pango.Font</classname></link> is -returned from the <link -linkend="method-pangocontext--load-font"><methodname>pango.Context.load_font</methodname>()</link>, -<link -linkend="method-pangofontset--get-font"><methodname>pango.FontSet.get_font</methodname>()</link> -and <link -linkend="method-pangofontmap--load-font"><methodname>pango.FontMap.load_font</methodname>()</link>) -methods.</para> - - </refsect1> - - <refsect1> - <title>Methods</title> - - <refsect2 id="method-pangofont--describe"> - <title>pango.Font.describe</title> - - <programlisting><methodsynopsis language="python"> - <methodname>describe</methodname> - <methodparam></methodparam> </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a <link -linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link> -object.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>describe</methodname>() method returns a -description of the font in a <link -linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link> -object.</para> - - </refsect2> - - <refsect2 id="method-pangofont--get-metrics"> - <title>pango.Font.get_metrics</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_metrics</methodname> - <methodparam><parameter - role="keyword">language</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">language</parameter> :</term> - <listitem><simpara>a <link -linkend="class-pangolanguage"><classname>pango.Language</classname></link> -that determines the script to get the metrics for, or -<literal>None</literal> to get the metrics for the entire -font.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a <link -linkend="class-pangofontmetrics"><classname>pango.FontMetrics</classname></link> -object.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>get_metrics</methodname>() method returns a -<link -linkend="class-pangofontmetrics"><classname>pango.FontMetrics</classname></link> -object containing the metric information for a font using the <link -linkend="class-pangolanguage"><classname>pango.Language</classname></link> -specified by <parameter>language</parameter> to limit the metrics to the -script(s) used by <parameter>language</parameter>. If the value of -<parameter>language</parameter> is <literal>None</literal>, the font metrics -for the entire font is returned.</para> - - </refsect2> - - <refsect2 id="method-pangofont--get-glyph-extents"> - <title>pango.Font.get_glyph_extents</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_glyph_extents</methodname> - <methodparam><parameter - role="keyword">glyph</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">glyph</parameter> :</term> - <listitem><simpara>the glyph index</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a 2-tuple containing two 4-tuples representing -the ink and logical rectangles used to store the extents of -<parameter>glyph</parameter> as drawn.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>get_glyph_extents</methodname>() method returns a -2-tuple containing two 4-tuples representing the values of the logical and -ink extent rectangles of the specified <parameter>glyph</parameter> within a -font. The coordinate system for each rectangle has its origin at the base -line and horizontal origin of the character with increasing coordinates -extending to the right and down. The <function>pango.ASCENT()</function>, -<function>pango.DESCENT()</function>, <function>pango.LBEARING()</function>, -and <function>pango.RBEARING</function> functions can be used to convert -from the extents rectangle to more traditional font metrics. The units of -the rectangles are in <literal>1/pango.SCALE</literal> of a device -unit.</para> - - </refsect2> - - <refsect2 id="method-pangofont--get-font-map"> - <title>pango.Font.get_font_map</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_font_map</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the <link - linkend="class-pangofontmap"><classname>pango.FontMap</classname></link> - for the font</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.10 and above.</para> - </note> - - <para>Gets the font map for which the font was created.</para> - - </refsect2> - - </refsect1> - - <refsect1> - <title>Functions</title> - - <refsect2 id="function-pango--PIXELS"> - <title>pango.PIXELS</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.PIXELS</methodname> - <methodparam><parameter - role="keyword">size</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">size</parameter> :</term> - <listitem><simpara>the integer value to convert to pango -pixels</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the pixel value</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>pango.PIXELS</function>() function converts and -returns the integer value specified by <parameter>size</parameter> to pango -pixels.</para> - - </refsect2> - - <refsect2 id="function-pango--ASCENT"> - <title>pango.ASCENT</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.ASCENT</methodname> - <methodparam><parameter - role="keyword">rect</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">rect</parameter> :</term> - <listitem><simpara>a 4-tuple representing an extent rectangle's -(x, y, width, height) value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the ascent value of -<parameter>rect</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>pango.ASCENT</function>() function returns the -ascent value of the extent rectangle specified by -<parameter>rect</parameter>.</para> - - </refsect2> - - <refsect2 id="function-pango--DESCENT"> - <title>pango.DESCENT</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.DESCENT</methodname> - <methodparam><parameter - role="keyword">rect</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">rect</parameter> :</term> - <listitem><simpara>a 4-tuple representing an extent rectangle's -(x, y, width, height) value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the descent value of -<parameter>rect</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>pango.DESCENT</function>() function returns the -descent value of the extent rectangle specified by -<parameter>rect</parameter>.</para> - - </refsect2> - - <refsect2 id="function-pango--RBEARING"> - <title>pango.RBEARING</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.RBEARING</methodname> - <methodparam><parameter - role="keyword">rect</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">rect</parameter> :</term> - <listitem><simpara>a 4-tuple representing an extent rectangle's -(x, y, width, height) value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the right bearing value of -<parameter>rect</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>pango.RBEARING</function>() function returns the -right bearing value of the extent rectangle specified by -<parameter>rect</parameter>.</para> - - </refsect2> - - <refsect2 id="function-pango--LBEARING"> - <title>pango.LBEARING</title> - - <programlisting><methodsynopsis language="python"> - <methodname>pango.LBEARING</methodname> - <methodparam><parameter - role="keyword">rect</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">rect</parameter> :</term> - <listitem><simpara>a 4-tuple representing an extent rectangle's -(x, y, width, height) value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the left bearing value of -<parameter>rect</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <function>pango.LBEARING</function>() function returns the -left bearing value of the extent rectangle specified by -<parameter>rect</parameter>.</para> - - </refsect2> - - </refsect1> - -</refentry> |