/usr/share/gtk-doc/html/pygtk/class-atkimage.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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Image</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="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkhypertext.html" title="atk.Hypertext"><link rel="next" href="class-atkimplementor.html" title="atk.Implementor"></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">atk.Image</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkhypertext.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkimplementor.html">Next</a></td></tr></table><hr></div><div class="refentry" title="atk.Image"><a name="class-atkimage"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Image</h2><p>atk.Image — the ATK Interface implemented by components that expose
image or pixmap content on-screen. </p></div><div class="refsect1" title="Synopsis"><a name="id2969305"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Image</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkimage.html#method-atkimage--get-image-description" title="atk.Image.get_image_description">get_image_description</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkimage.html#method-atkimage--get-image-size" title="atk.Image.get_image_size">get_image_size</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkimage.html#method-atkimage--set-image-description" title="atk.Image.set_image_description">set_image_description</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>description</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkimage.html#method-atkimage--get-image-position" title="atk.Image.get_image_position">get_image_position</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Description"><a name="id2942585"></a><h2>Description</h2><p><a class="link" href="class-atkimage.html" title="atk.Image"><code class="classname">atk.Image</code></a> should
be implemented by <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
subtypes on behalf of components which display image/pixmap information
onscreen, and which provide information (other than just widget borders,
etc.) via that image content. For instance, icons, buttons with icons,
toolbar elements, and image viewing panes typically should implement
<a class="link" href="class-atkimage.html" title="atk.Image"><code class="classname">atk.Image</code></a>.</p><p><a class="link" href="class-atkimage.html" title="atk.Image"><code class="classname">atk.Image</code></a>
primarily provides two types of information: coordinate information
(useful for screen review mode of screenreaders, and for use by onscreen
magnifiers), and descriptive information. The descriptive information
is provided for alternative, text-only presentation of the most
significant information present in the image.</p></div><div class="refsect1" title="Methods"><a name="id2968784"></a><h2>Methods</h2><div class="refsect2" title="atk.Image.get_image_description"><a name="method-atkimage--get-image-description"></a><h3>atk.Image.get_image_description</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_image_description</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 string representing the image
description</td></tr></tbody></table><p>Get a textual description of this image.</p></div><div class="refsect2" title="atk.Image.get_image_size"><a name="method-atkimage--get-image-size"></a><h3>atk.Image.get_image_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_image_size</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 2-tuple containing the width and height of
the image</td></tr></tbody></table><p>Get the width and height in pixels for the specified image. The
width and height are returned as -1 if the values cannot be
obtained.</p></div><div class="refsect2" title="atk.Image.set_image_description"><a name="method-atkimage--set-image-description"></a><h3>atk.Image.set_image_description</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_image_description</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>description</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>description</code></strong> :</span></p></td><td>a string description to set for
<em class="parameter"><code>image</code></em></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>True if operation could be
completed.</td></tr></tbody></table><p>Sets the textual description for this image.</p></div><div class="refsect2" title="atk.Image.get_image_position"><a name="method-atkimage--get-image-position"></a><h3>atk.Image.get_image_position</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_image_position</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</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>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
to the screen or to the components top level window - one of the
<a class="xref" href="atk-constants.html#atk-coord-type-constants" title="Atk Coord Type Constants">Atk Coord Type Constants</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the x and y coordinates of
the image</td></tr></tbody></table><p>Gets the position of the image in the form of a point specifying
the images top-left corner. The values of x and y are returned as -1
if the values cannot be obtained.</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-atkhypertext.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="atk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-atkimplementor.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">atk.Hypertext </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> atk.Implementor</td></tr></table></div></body></html>
|