/usr/share/gtk-doc/html/pygtk/class-pangotabarray.html is in python-gtk2-doc 2.24.0-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>pango.TabArray</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><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-pangorenderer.html" title="pango.Renderer"><link rel="next" href="pango-markup-language.html" title="The Pango Markup Language"></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.TabArray</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-pangorenderer.html">Prev</a> </td><th width="60%" align="center">The pango Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="pango-markup-language.html">Next</a></td></tr></table><hr></div><div class="refentry" title="pango.TabArray"><a name="class-pangotabarray"></a><div class="titlepage"></div><div class="refnamediv"><h2>pango.TabArray</h2><p>pango.TabArray — an object containing an array of tab stops.</p></div><div class="refsect1" title="Synopsis"><a name="id2911978"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">pango.TabArray</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-pangotabarray.html#constructor-pangotabarray" title="Constructor">pango.TabArray</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>initial_size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>positions_in_pixels</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangotabarray.html#method-pangotabarray--copy" title="pango.TabArray.copy">copy</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangotabarray.html#method-pangotabarray--get-size" title="pango.TabArray.get_size">get_size</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangotabarray.html#method-pangotabarray--resize" title="pango.TabArray.resize">resize</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>new_size</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangotabarray.html#method-pangotabarray--set-tab" title="pango.TabArray.set_tab">set_tab</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_index</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>alignment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>location</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangotabarray.html#method-pangotabarray--get-tab" title="pango.TabArray.get_tab">get_tab</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_index</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangotabarray.html#method-pangotabarray--get-tabs" title="pango.TabArray.get_tabs">get_tabs</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-pangotabarray.html#method-pangotabarray--get-positions-in-pixels" title="pango.TabArray.get_positions_in_pixels">get_positions_in_pixels</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Description"><a name="id2939673"></a><h2>Description</h2><p>A <a class="link" href="class-pangotabarray.html" title="pango.TabArray"><code class="classname">pango.TabArray</code></a>
object contains an array of tab stops. Each tab stop has an alignment and a
position.</p></div><div class="refsect1" title="Constructor"><a name="constructor-pangotabarray"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">pango.TabArray</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>initial_size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>positions_in_pixels</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>initial_size</code></strong> :</span></p></td><td>Initial number of tab stops to allocate, can be
0</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>positions_in_pixels</code></strong> :</span></p></td><td>if <code class="literal">True</code> the tab positions are
in pixel units</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-pangotabarray.html" title="pango.TabArray"><code class="classname">pango.TabArray</code></a></td></tr></tbody></table><p>Creates a new <a class="link" href="class-pangotabarray.html" title="pango.TabArray"><code class="classname">pango.TabArray</code></a>
object with the number of tab stops specified by
<em class="parameter"><code>initial_size</code></em>. If
<em class="parameter"><code>positions_in_pixels</code></em> is <code class="literal">True</code>, the
tab stop positions are specified in pixel units otherwise in pango units
(one pixel = <code class="literal">pango.SCALE</code> pango units). All tab stops are
initially at position 0.</p></div><div class="refsect1" title="Methods"><a name="id3144385"></a><h2>Methods</h2><div class="refsect2" title="pango.TabArray.copy"><a name="method-pangotabarray--copy"></a><h3>pango.TabArray.copy</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">copy</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>a new <a class="link" href="class-pangotabarray.html" title="pango.TabArray"><code class="classname">pango.TabArray</code></a>
object</td></tr></tbody></table><p>The <code class="methodname">copy</code>() method returns a new <a class="link" href="class-pangotabarray.html" title="pango.TabArray"><code class="classname">pango.TabArray</code></a>
that is copy of this <a class="link" href="class-pangotabarray.html" title="pango.TabArray"><code class="classname">pango.TabArray</code></a>.</p></div><div class="refsect2" title="pango.TabArray.get_size"><a name="method-pangotabarray--get-size"></a><h3>pango.TabArray.get_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_size</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 number of tab stops in the
array.</td></tr></tbody></table><p>The <code class="methodname">get_size</code>() method returns the
number of tab stops in the tab array.</p></div><div class="refsect2" title="pango.TabArray.resize"><a name="method-pangotabarray--resize"></a><h3>pango.TabArray.resize</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">resize</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>new_size</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>new_size</code></strong> :</span></p></td><td>the new size of the array</td></tr></tbody></table><p>The <code class="methodname">resize</code>() method sets the size of
the tab array to the value specified by <em class="parameter"><code>new_size</code></em>. You
must subsequently initialize any tabs that were added to the array.</p></div><div class="refsect2" title="pango.TabArray.set_tab"><a name="method-pangotabarray--set-tab"></a><h3>pango.TabArray.set_tab</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_tab</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_index</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>alignment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>location</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>tab_index</code></strong> :</span></p></td><td>the index of a tab stop</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>alignment</code></strong> :</span></p></td><td>the tab alignment</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>location</code></strong> :</span></p></td><td>the tab location in pango
units</td></tr></tbody></table><p>The <code class="methodname">set_tab</code>() method sets the specified
<em class="parameter"><code>alignment</code></em> and <em class="parameter"><code>location</code></em> of the
tab stop specified by <em class="parameter"><code>tab_index</code></em>. The value of
<em class="parameter"><code>alignment</code></em> must always be
<code class="literal">pango.TAB_LEFT</code> in the current implementation.</p></div><div class="refsect2" title="pango.TabArray.get_tab"><a name="method-pangotabarray--get-tab"></a><h3>pango.TabArray.get_tab</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_tab</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_index</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>tab_index</code></strong> :</span></p></td><td>the tab stop index</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the tab alignment and
position</td></tr></tbody></table><p>The <code class="methodname">get_tab</code>() method returns a 2-tuple
containing the alignment and position of the tab stop specified by
<em class="parameter"><code>tab_index</code></em>.</p></div><div class="refsect2" title="pango.TabArray.get_tabs"><a name="method-pangotabarray--get-tabs"></a><h3>pango.TabArray.get_tabs</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_tabs</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>a tuple containing a list of 2-tuples (each
holding the alignment and position of a tab stop).</td></tr></tbody></table><p>The <code class="methodname">get_tabs</code>() method returns a tuple
containing a list of 2-tuples (each holding the alignment and position of a
tab stop)</p></div><div class="refsect2" title="pango.TabArray.get_positions_in_pixels"><a name="method-pangotabarray--get-positions-in-pixels"></a><h3>pango.TabArray.get_positions_in_pixels</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_positions_in_pixels</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><code class="literal">True</code> if tab stop positions
are specified in pixels</td></tr></tbody></table><p>The <code class="methodname">get_positions_in_pixels</code>() method
returns <em class="parameter"><code>True</code></em> if the tab positions are specified in
pixels and <code class="literal">False</code> if they are in pango units.</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-pangorenderer.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="pango-markup-language.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">pango.Renderer </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> The Pango Markup Language</td></tr></table></div></body></html>
|