1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Value</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="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atktext.html" title="atk.Text"><link rel="next" href="atk-constants.html" title="atk Constants"></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.Value</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atktext.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="atk-constants.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-atkvalue"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Value</h2><p>atk.Value — the ATK interface implemented by valuators and components
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Value</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="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atktext.html" title="atk.Text"><link rel="next" href="atk-constants.html" title="atk Constants"></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.Value</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atktext.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="atk-constants.html">Next</a></td></tr></table><hr></div><div class="refentry" title="atk.Value"><a name="class-atkvalue"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Value</h2><p>atk.Value — the ATK interface implemented by valuators and components
2
2
which display or select a value from a bounded range of values.
3
</p></div><div class="refsect1" lang="en"><a name="id2821508"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Value</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
4
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkvalue.html#method-atkvalue--get-current-value" title="atk.Value.get_current_value">get_current_value</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkvalue.html#method-atkvalue--get-maximum-value" title="atk.Value.get_maximum_value">get_maximum_value</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkvalue.html#method-atkvalue--get-minimum-value" title="atk.Value.get_minimum_value">get_minimum_value</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkvalue.html#method-atkvalue--set-current-value" title="atk.Value.set_current_value">set_current_value</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id2823547"></a><h2>Description</h2><p><a class="link" href="class-atkvalue.html" title="atk.Value"><code class="classname">atk.Value</code></a> should
3
</p></div><div class="refsect1" title="Synopsis"><a name="id3122265"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Value</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
4
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkvalue.html#method-atkvalue--get-current-value" title="atk.Value.get_current_value">get_current_value</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkvalue.html#method-atkvalue--get-maximum-value" title="atk.Value.get_maximum_value">get_maximum_value</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkvalue.html#method-atkvalue--get-minimum-value" title="atk.Value.get_minimum_value">get_minimum_value</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkvalue.html#method-atkvalue--set-current-value" title="atk.Value.set_current_value">set_current_value</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Description"><a name="id3125249"></a><h2>Description</h2><p><a class="link" href="class-atkvalue.html" title="atk.Value"><code class="classname">atk.Value</code></a> should
5
5
be implemented for components which either display a value from a
6
6
bounded range, or which allow the user to specify a value from a bounded
7
7
range, or both. For instance, most sliders and range controls, as well
9
9
representations which implement <a class="link" href="class-atkvalue.html" title="atk.Value"><code class="classname">atk.Value</code></a> on the
10
10
component's behalf. <a class="link" href="class-atkvalue.html" title="atk.Value"><code class="classname">atk.Value</code></a> objects
11
11
may be read-only, in which case attempts to alter the value return
12
<code class="literal">False</code> to indicate failure.</p></div><div class="refsect1" lang="en"><a name="id2799837"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-atkvalue--get-current-value"></a><h3>atk.Value.get_current_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_current_value</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 current accessible
13
value</td></tr></tbody></table><p>Gets the value of this object.</p></div><div class="refsect2" lang="en"><a name="method-atkvalue--get-maximum-value"></a><h3>atk.Value.get_maximum_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_maximum_value</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 maximum accessible
14
value</td></tr></tbody></table><p>Gets the maximum value of this object.</p></div><div class="refsect2" lang="en"><a name="method-atkvalue--get-minimum-value"></a><h3>atk.Value.get_minimum_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_minimum_value</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 minimum accessible
15
value</td></tr></tbody></table><p>Gets the minimum value of this object.</p></div><div class="refsect2" lang="en"><a name="method-atkvalue--set-current-value"></a><h3>atk.Value.set_current_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_current_value</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</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>value</code></strong> :</span></p></td><td>the desired new accessible
12
<code class="literal">False</code> to indicate failure.</p></div><div class="refsect1" title="Methods"><a name="id3118070"></a><h2>Methods</h2><div class="refsect2" title="atk.Value.get_current_value"><a name="method-atkvalue--get-current-value"></a><h3>atk.Value.get_current_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_current_value</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 current accessible
13
value</td></tr></tbody></table><p>Gets the value of this object.</p></div><div class="refsect2" title="atk.Value.get_maximum_value"><a name="method-atkvalue--get-maximum-value"></a><h3>atk.Value.get_maximum_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_maximum_value</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 maximum accessible
14
value</td></tr></tbody></table><p>Gets the maximum value of this object.</p></div><div class="refsect2" title="atk.Value.get_minimum_value"><a name="method-atkvalue--get-minimum-value"></a><h3>atk.Value.get_minimum_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_minimum_value</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 minimum accessible
15
value</td></tr></tbody></table><p>Gets the minimum value of this object.</p></div><div class="refsect2" title="atk.Value.set_current_value"><a name="method-atkvalue--set-current-value"></a><h3>atk.Value.set_current_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_current_value</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</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>value</code></strong> :</span></p></td><td>the desired new accessible
16
16
value.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if new value is
17
17
successfully set, <code class="literal">False</code>
18
18
otherwise.</td></tr></tbody></table><p>Sets the value of this object.</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-atktext.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="atk-constants.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">atk.Text </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> atk Constants</td></tr></table></div></body></html>
added
removed
docs/html/class-atkvalue.html
