1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>pango.FontMetrics</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="pango-class-reference.html" title="The pango Class Reference"><link rel="prev" href="class-pangofontmap.html" title="pango.FontMap"><link rel="next" href="class-pangofontset.html" title="pango.Fontset"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">pango.FontMetrics</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-pangofontmap.html">Prev</a> </td><th width="60%" align="center">The pango Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-pangofontset.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-pangofontmetrics"></a><div class="titlepage"></div><div class="refnamediv"><h2>pango.FontMetrics</h2><p>pango.FontMetrics — an object containing overall metric information for a
2
font.</p></div><div class="refsect1" lang="en"><a name="id3047610"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">pango.FontMetrics</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
3
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangofontmetrics.html#method-pangofontmetrics--get-ascent" title="pango.FontMetrics.get_ascent">get_ascent</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangofontmetrics.html#method-pangofontmetrics--get-descent" title="pango.FontMetrics.get_descent">get_descent</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangofontmetrics.html#method-pangofontmetrics--get-approximate-char-width" title="pango.FontMetrics.get_approximate_char_width">get_approximate_char_width</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangofontmetrics.html#method-pangofontmetrics--get-approximate-digit-width" title="pango.FontMetrics.get_approximate_digit_width">get_approximate_digit_width</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3047716"></a><h2>Description</h2><p>A <a class="link" href="class-pangofontmetrics.html" title="pango.FontMetrics"><code class="classname">pango.FontMetrics</code></a>
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>pango.FontMetrics</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="pango-class-reference.html" title="The pango Class Reference"><link rel="prev" href="class-pangofontmap.html" title="pango.FontMap"><link rel="next" href="class-pangofontset.html" title="pango.Fontset"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">pango.FontMetrics</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-pangofontmap.html">Prev</a> </td><th width="60%" align="center">The pango Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-pangofontset.html">Next</a></td></tr></table><hr></div><div class="refentry" title="pango.FontMetrics"><a name="class-pangofontmetrics"></a><div class="titlepage"></div><div class="refnamediv"><h2>pango.FontMetrics</h2><p>pango.FontMetrics — an object containing overall metric information for a
2
font.</p></div><div class="refsect1" title="Synopsis"><a name="id3199494"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">pango.FontMetrics</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
3
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangofontmetrics.html#method-pangofontmetrics--get-ascent" title="pango.FontMetrics.get_ascent">get_ascent</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangofontmetrics.html#method-pangofontmetrics--get-descent" title="pango.FontMetrics.get_descent">get_descent</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangofontmetrics.html#method-pangofontmetrics--get-approximate-char-width" title="pango.FontMetrics.get_approximate_char_width">get_approximate_char_width</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangofontmetrics.html#method-pangofontmetrics--get-approximate-digit-width" title="pango.FontMetrics.get_approximate_digit_width">get_approximate_digit_width</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Description"><a name="id3073602"></a><h2>Description</h2><p>A <a class="link" href="class-pangofontmetrics.html" title="pango.FontMetrics"><code class="classname">pango.FontMetrics</code></a>
4
4
object holds the overall metric information for a font. A <a class="link" href="class-pangofontmetrics.html" title="pango.FontMetrics"><code class="classname">pango.FontMetrics</code></a>
5
object is returned from the following methods:</p><div class="itemizedlist"><ul type="disc"><li><a class="link" href="class-pangocontext.html#method-pangocontext--get-metrics" title="pango.Context.get_metrics"><code class="methodname">pango.Context.get_metrics</code>()</a></li><li><a class="link" href="class-pangofont.html#method-pangofont--get-metrics" title="pango.Font.get_metrics"><code class="methodname">pango.Font.get_metrics</code>()</a></li><li><a class="link" href="class-pangofontset.html#method-pangofontset--get-metrics" title="pango.Fontset.get_metrics"><code class="methodname">pango.Fontset.get_metrics</code>()</a></li></ul></div></div><div class="refsect1" lang="en"><a name="id3047782"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-pangofontmetrics--get-ascent"></a><h3>pango.FontMetrics.get_ascent</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_ascent</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the ascent in pango units. (1 point ==
5
object is returned from the following methods:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><a class="link" href="class-pangocontext.html#method-pangocontext--get-metrics" title="pango.Context.get_metrics"><code class="methodname">pango.Context.get_metrics</code>()</a></li><li class="listitem"><a class="link" href="class-pangofont.html#method-pangofont--get-metrics" title="pango.Font.get_metrics"><code class="methodname">pango.Font.get_metrics</code>()</a></li><li class="listitem"><a class="link" href="class-pangofontset.html#method-pangofontset--get-metrics" title="pango.Fontset.get_metrics"><code class="methodname">pango.Fontset.get_metrics</code>()</a></li></ul></div></div><div class="refsect1" title="Methods"><a name="id3250838"></a><h2>Methods</h2><div class="refsect2" title="pango.FontMetrics.get_ascent"><a name="method-pangofontmetrics--get-ascent"></a><h3>pango.FontMetrics.get_ascent</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_ascent</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the ascent in pango units. (1 point ==
6
6
<code class="literal">pango.SCALE</code> pango units.)</td></tr></tbody></table><p>The <code class="methodname">get_ascent</code>() method returns the
7
7
font ascent in pango units where one font point is equal to pango.SCALE
8
8
(1024) pango units. The ascent is the distance from the baseline to the
9
9
logical top of a line of text. (The logical top may be above or below the
10
10
top of the actual drawn ink. It is necessary to lay out the text to figure
11
where the ink will be.)</p></div><div class="refsect2" lang="en"><a name="method-pangofontmetrics--get-descent"></a><h3>pango.FontMetrics.get_descent</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_descent</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the descent in pango units. (1 point ==
11
where the ink will be.)</p></div><div class="refsect2" title="pango.FontMetrics.get_descent"><a name="method-pangofontmetrics--get-descent"></a><h3>pango.FontMetrics.get_descent</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_descent</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the descent in pango units. (1 point ==
12
12
<code class="literal">pango.SCALE</code> pango units.)</td></tr></tbody></table><p>The <code class="methodname">get_descent</code>() method returns the
13
13
font descent in pango units where one font point is equal to pango.SCALE
14
14
(1024) pango units. The descent is the distance from the baseline to the
15
15
logical bottom of a line of text. (The logical bottom may be above or below
16
16
the bottom of the actual drawn ink. It is necessary to lay out the text to
17
figure where the ink will be.)</p></div><div class="refsect2" lang="en"><a name="method-pangofontmetrics--get-approximate-char-width"></a><h3>pango.FontMetrics.get_approximate_char_width</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_approximate_char_width</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the character width in pango units. (1 point ==
17
figure where the ink will be.)</p></div><div class="refsect2" title="pango.FontMetrics.get_approximate_char_width"><a name="method-pangofontmetrics--get-approximate-char-width"></a><h3>pango.FontMetrics.get_approximate_char_width</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_approximate_char_width</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the character width in pango units. (1 point ==
18
18
<code class="literal">pango.SCALE</code> pango units.)</td></tr></tbody></table><p>The <code class="methodname">get_approximate_char_width</code>() method
19
19
returns the approximate character width for a font in pango units where one
20
20
font point is equal to pango.SCALE (1024) pango units. This is merely a
21
21
representative value that is useful, for example, for determining the
22
22
initial size for a window. Actual characters in text will be wider and
23
narrower than this.</p></div><div class="refsect2" lang="en"><a name="method-pangofontmetrics--get-approximate-digit-width"></a><h3>pango.FontMetrics.get_approximate_digit_width</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_approximate_digit_width</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the digit width in pango units. (1 point ==
23
narrower than this.</p></div><div class="refsect2" title="pango.FontMetrics.get_approximate_digit_width"><a name="method-pangofontmetrics--get-approximate-digit-width"></a><h3>pango.FontMetrics.get_approximate_digit_width</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_approximate_digit_width</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the digit width in pango units. (1 point ==
24
24
<code class="literal">pango.SCALE</code> pango units.)</td></tr></tbody></table><p>The <code class="methodname">get_approximate_digit_width</code>()
25
25
method returns the approximate digit width for a font in pango units where
26
26
one font point is equal to pango.SCALE (1024) pango units. This is merely a
added
removed
docs/html/class-pangofontmetrics.html
