File: class-pangofontset.html

package info (click to toggle)
python-gtk2-doc 2.5.2-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 8,304 kB
  • ctags: 3,741
  • sloc: makefile: 38
file content (24 lines) | stat: -rw-r--r-- 8,649 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>pango.Fontset</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.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="previous" href="class-pangofontmetrics.html" title="pango.FontMetrics"><link rel="next" href="class-pangofontsetsimple.html" title="pango.FontsetSimple"></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.Fontset</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-pangofontmetrics.html">Prev</a></td><th width="60%" align="center">The pango Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-pangofontsetsimple.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-pangofontset"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>pango.Fontset</h2><p>pango.Fontset &#8212; an object containing a set of <a href="class-pangofont.html" title="pango.Font"><tt class="classname">pango.Font</tt></a>
objects.</p></div><div class="refsect1" lang="en"><a name="id3227852"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">pango.Fontset</span></span>(<span class="ooclass"><span class="classname"><a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a></span></span>):
<code class="methodsynopsis">    def <span class="methodname"><a href="class-pangofontset.html#method-pangofontset--get-font" title="pango.Fontset.get_font">get_font</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>wc</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-pangofontset.html#method-pangofontset--get-metrics" title="pango.Fontset.get_metrics">get_metrics</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-pangofontset.html#method-pangofontset--foreach" title="pango.Fontset.foreach">foreach</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>func</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>data</tt></b></span><span class="initializer">=None</span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3227923"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
  +-- <a href="class-pangofontset.html" title="pango.Fontset">pango.Fontset</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3288455"></a><h2>Description</h2><p>A <a href="class-pangofontset.html" title="pango.Fontset"><tt class="classname">pango.Fontset</tt></a>
object holds a set of <a href="class-pangofont.html" title="pango.Font"><tt class="classname">pango.Font</tt></a> objects.
A <a href="class-pangofontset.html" title="pango.Fontset"><tt class="classname">pango.FontSet</tt></a>
object is returned from the following methods:</p><div class="itemizedlist"><ul type="disc"><li><a href="class-pangocontext.html#method-pangocontext--load-fontset" title="pango.Context.load_fontset"><tt class="methodname">pango.Context.load_fontset</tt>()</a></li><li><a href="class-pangofontmap.html#method-pangofontmap--load-fontset" title="pango.FontMap.load_fontset"><tt class="methodname">pango.FontMap.load_fontset</tt>()</a></li></ul></div></div><div class="refsect1" lang="en"><a name="id3288505"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-pangofontset--get-font"></a><h3>pango.Fontset.get_font</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_font</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>wc</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>wc</tt></b>:</span></td><td>a unicode character</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a <a href="class-pangofont.html" title="pango.Font"><tt class="classname">pango.Font</tt></a>.</td></tr></tbody></table><p>The <tt class="methodname">get_font</tt>() method returns the <a href="class-pangofont.html" title="pango.Font"><tt class="classname">pango.Font</tt></a> in the
fontset that contains the best glyph for the unicode character specified by
<i class="parameter"><tt>wc</tt></i>.</p></div><div class="refsect2" lang="en"><a name="method-pangofontset--get-metrics"></a><h3>pango.Fontset.get_metrics</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_metrics</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a <a href="class-pangofontmetrics.html" title="pango.FontMetrics"><tt class="classname">pango.FontMetrics</tt></a>
	  object.</td></tr></tbody></table><p>The <tt class="methodname">get_metrics</tt>() method returns a
<a href="class-pangofontmetrics.html" title="pango.FontMetrics"><tt class="classname">pango.FontMetrics</tt></a> 
object that contains the overall metric information for the fonts in the
fontset.</p></div><div class="refsect2" lang="en"><a name="method-pangofontset--foreach"></a><h3>pango.Fontset.foreach</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">foreach</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>func</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>data</tt></b></span><span class="initializer">=None</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>func</tt></b>:</span></td><td>a callback function</td></tr><tr><td><span class="term"><b class="parameter"><tt>data</tt></b>:</span></td><td>user data to pass to
	  <i class="parameter"><tt>func</tt></i></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <tt class="methodname">foreach</tt>() method invokes the
function specified by <i class="parameter"><tt>func</tt></i> on each <a href="class-pangofont.html" title="pango.Font"><tt class="classname">pango.Font</tt></a> of the
font set passing it the optional user data specified by
<i class="parameter"><tt>data</tt></i>. The signature of <i class="parameter"><tt>func</tt></i>
is:</p><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting">
  def func(fontset, font, user_data)
</pre></td></tr></table><p>where <i class="parameter"><tt>fontset</tt></i> is the <a href="class-pangofontset.html" title="pango.Fontset"><tt class="classname">pango.Fontset</tt></a>
containing the <a href="class-pangofont.html" title="pango.Font"><tt class="classname">pango.Font</tt></a>
<i class="parameter"><tt>font</tt></i> and <i class="parameter"><tt>user_data</tt></i> is
<i class="parameter"><tt>data</tt></i></p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-pangofontmetrics.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="pango-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="class-pangofontsetsimple.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">pango.FontMetrics</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">pango.FontsetSimple</td></tr></table></div></body></html>