/usr/share/gtk-doc/html/pygtk/class-gtktextattributes.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
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 33 34 35 36 37 38 39 40 41 42 43 44 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.TextAttributes</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="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtktearoffmenuitem.html" title="gtk.TearoffMenuItem"><link rel="next" href="class-gtktextbuffer.html" title="gtk.TextBuffer"></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">gtk.TextAttributes</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtktearoffmenuitem.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtktextbuffer.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.TextAttributes"><a name="class-gtktextattributes"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.TextAttributes</h2><p>gtk.TextAttributes — an object containing the attributes set on some
text</p></div><div class="refsect1" title="Synopsis"><a name="id3933963"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.TextAttributes</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtktextattributes.html#constructor-gtktextattributes" title="Constructor">gtk.TextAttributes</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktextattributes.html#method-gtktextattributes--copy" title="gtk.TextAttributes.copy">copy</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktextattributes.html#method-gtktextattributes--copy-values" title="gtk.TextAttributes.copy_values">copy_values</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>dest</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Attributes"><a name="id3934056"></a><h2>Attributes</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"bg_color"</td><td valign="top">Read</td><td valign="top">The background color</td></tr><tr valign="top"><td valign="top">"fg_color"</td><td valign="top">Read</td><td valign="top">The foreground color</td></tr><tr valign="top"><td valign="top">"bg_stipple"</td><td valign="top">Read</td><td valign="top">The background stipple bitmap</td></tr><tr valign="top"><td valign="top">"fg_stipple"</td><td valign="top">Read</td><td valign="top">The foreground stipple bitmap</td></tr><tr valign="top"><td valign="top">"rise"</td><td valign="top">Read</td><td valign="top">The subscript or superscript rise</td></tr><tr valign="top"><td valign="top">"underline"</td><td valign="top">Read</td><td valign="top">The style of underline - one of:
<code class="literal">pango.UNDERLINE_NONE</code>,
<code class="literal">pango.UNDERLINE_SINGLE</code>,
<code class="literal">pango.UNDERLINE_DOUBLE</code>,
<code class="literal">pango.UNDERLINE_LOW</code></td></tr><tr valign="top"><td valign="top">"strikethrough"</td><td valign="top">Read</td><td valign="top">If <code class="literal">True</code> strikethrough the text</td></tr><tr valign="top"><td valign="top">"draw_bg"</td><td valign="top">Read</td><td valign="top">If <code class="literal">True</code> some background attributes
are set</td></tr><tr valign="top"><td valign="top">"justification"</td><td valign="top">Read</td><td valign="top">The type of justification - one of:
<code class="literal">gtk.JUSTIFY_LEFT</code>, <code class="literal">gtk.JUSTIFY_RIGHT</code>,
<code class="literal">gtk.JUSTIFY_CENTER</code>,
<code class="literal">gtk.JUSTIFY_FILL</code></td></tr><tr valign="top"><td valign="top">"direction"</td><td valign="top">Read</td><td valign="top">The text direction - one of:
<code class="literal">gtk.TEXT_DIR_NONE</code>, <code class="literal">gtk.TEXT_DIR_LTR</code>,
<code class="literal">gtk.TEXT_DIR_RTL</code></td></tr><tr valign="top"><td valign="top">"font"</td><td valign="top">Read</td><td valign="top">A <code class="classname">pango.FontDescription</code></td></tr><tr valign="top"><td valign="top">"font_scale"</td><td valign="top">Read</td><td valign="top">The scale of the font e.g. 2.5</td></tr><tr valign="top"><td valign="top">"left_margin"</td><td valign="top">Read</td><td valign="top">The width of the left margin in pixels</td></tr><tr valign="top"><td valign="top">"indent"</td><td valign="top">Read</td><td valign="top">The width of the paragraph indent in pixels</td></tr><tr valign="top"><td valign="top">"right_margin"</td><td valign="top">Read</td><td valign="top">The width of the right margin</td></tr><tr valign="top"><td valign="top">"pixels_above_lines"</td><td valign="top">Read</td><td valign="top">The number of pixels space above a paragraph</td></tr><tr valign="top"><td valign="top">"pixels_below_lines"</td><td valign="top">Read</td><td valign="top">The number of pixels space below a paragraph</td></tr><tr valign="top"><td valign="top">"pixels_inside_wrap"</td><td valign="top">Read</td><td valign="top">The number of pixels of space between wrapped lines in
a paragraph</td></tr><tr valign="top"><td valign="top">"tabs"</td><td valign="top">Read</td><td valign="top">A set of tabs contained in a
<code class="classname">pango.TabArray</code></td></tr><tr valign="top"><td valign="top">"wrap_mode"</td><td valign="top">Read</td><td valign="top">The wrap mode - one of: <code class="literal">gtk.WRAP_NONE</code>,
<code class="literal">gtk.WRAP_CHAR</code>,
<code class="literal">gtk.WRAP_WORD</code></td></tr><tr valign="top"><td valign="top">"language"</td><td valign="top">Read</td><td valign="top">The <code class="classname">pango.Language</code> object
describing the text language</td></tr><tr valign="top"><td valign="top">"invisible"</td><td valign="top">Read</td><td valign="top">If <code class="literal">True</code> the text is hidden (Not
implemented in PyGTK2)</td></tr><tr valign="top"><td valign="top">"bg_full_height"</td><td valign="top">Read</td><td valign="top">If <code class="literal">True</code> the background is fit to the
full line height</td></tr><tr valign="top"><td valign="top">"editable"</td><td valign="top">Read</td><td valign="top">If <code class="literal">True</code> the text is editable</td></tr><tr valign="top"><td valign="top">"realized"</td><td valign="top">Read</td><td valign="top">If <code class="literal">True</code> the text has been
realized</td></tr><tr valign="top"><td valign="top">"pad1"</td><td valign="top">Read</td><td valign="top"> </td></tr><tr valign="top"><td valign="top">"pad2"</td><td valign="top">Read</td><td valign="top"> </td></tr><tr valign="top"><td valign="top">"pad3"</td><td valign="top">Read</td><td valign="top"> </td></tr><tr valign="top"><td valign="top">"pad4"</td><td valign="top">Read</td><td valign="top"> </td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="Description"><a name="id3934743"></a><h2>Description</h2><p>A <a class="link" href="class-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a>
object holds a set of attributes that describe the properties of a section
of text. A <a class="link" href="class-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a>
object is usually obtained by calling either of the <a class="link" href="class-gtktextiter.html#method-gtktextiter--get-attributes" title="gtk.TextIter.get_attributes"><code class="methodname">gtk.TextIter.get_attributes</code>()</a>
or <a class="link" href="class-gtktextview.html#method-gtktextview--get-default-attributes" title="gtk.TextView.get_default_attributes"><code class="methodname">gtk.TextView.get_default_attributes</code>()</a>
methods to retrieve the attributes in effect.</p><p>A <a class="link" href="class-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a>
object created with <a class="link" href="class-gtktextattributes.html#constructor-gtktextattributes" title="Constructor">gtk.TextAttributes</a>() cannot
be applied within PyGTK because there is no way to set the attributes.
Likewise, the <a class="link" href="class-gtktextattributes.html#method-gtktextattributes--copy" title="gtk.TextAttributes.copy"><code class="methodname">copy</code>()</a>
and <a class="link" href="class-gtktextattributes.html#method-gtktextattributes--copy-values" title="gtk.TextAttributes.copy_values"><code class="methodname">copy_values</code>()</a>
methods can create a new copy or copy the attributes but there are no
methods in PyGTK that take a <a class="link" href="class-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a>
object as an argument. The most effective way to use a <a class="link" href="class-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a>
object is to read its attributes and use them to set the properties of a
<a class="link" href="class-gtktexttag.html" title="gtk.TextTag"><code class="classname">gtk.TextTag</code></a>.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtktextattributes"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.TextAttributes</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-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a></td></tr></tbody></table><p>Creates a <a class="link" href="class-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a>
object, that contains a set of attributes of some text.</p></div><div class="refsect1" title="Methods"><a name="id3934923"></a><h2>Methods</h2><div class="refsect2" title="gtk.TextAttributes.copy"><a name="method-gtktextattributes--copy"></a><h3>gtk.TextAttributes.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 copy of the <a class="link" href="class-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a>
object</td></tr></tbody></table><p>The <code class="methodname">copy</code>() method copies the text
attributes and returns a new <a class="link" href="class-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a>
object.</p></div><div class="refsect2" title="gtk.TextAttributes.copy_values"><a name="method-gtktextattributes--copy-values"></a><h3>gtk.TextAttributes.copy_values</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">copy_values</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>dest</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>dest</code></strong> :</span></p></td><td>the <a class="link" href="class-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a>
whose attributes will be set</td></tr></tbody></table><p>The <code class="methodname">copy_values</code>() method copies the
values from the <a class="link" href="class-gtktextattributes.html" title="gtk.TextAttributes"><code class="classname">gtk.TextAttributes</code></a>
object to <em class="parameter"><code>dest</code></em> so that <em class="parameter"><code>dest</code></em>
has the same values. Frees existing values in
<em class="parameter"><code>dest</code></em>.</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-gtktearoffmenuitem.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtktextbuffer.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.TearoffMenuItem </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.TextBuffer</td></tr></table></div></body></html>
|