← Back to branch summary

~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-gtkscale.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-06-22 16:49:42 UTC
  • mfrom: (1.2.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20090622164942-19zeltp4z0u5iw72
Tags: 2.15.2-0ubuntu1
* New upstream version:
  - Rename gtk.Statusbar.remove() to gtk.Statusbar.remove_message
  - Allow pango.Context creation 
  - Make gtk.gdk.Pixbuf.add_alpha accept integers, retaining backward
    compatibility accepting also chars 
  - Protect window obj from GC in gtk.window_get_toplevels 
  - Plug huge number of memory leaks in Pango wrappers 
  - Add gtk.gdk.WINDOWING constant 
  - Wrap gdk_pixbuf_apply_embedded_orientation 
  - Modernize constructors of seven more types 
  - Don't free a string we don't own 
  - Some docs tweaking 
* debian/control.in:
  - set vcs location
* debian/patches/02_fix_get_application_info_crash.patch:
  - the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/class-gtkscale.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Scale</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="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkruler.html" title="gtk.Ruler"><link rel="next" href="class-gtkscalebutton.html" title="gtk.ScaleButton"></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.Scale</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkruler.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkscalebutton.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkscale"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Scale</h2><p>gtk.Scale — a base class for the scale widgets.</p></div><div class="refsect1" lang="en"><a name="id3639336"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Scale</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkrange.html" title="gtk.Range">gtk.Range</a></span></span>):
2
 
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--set-digits" title="gtk.Scale.set_digits">set_digits</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>digits</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--get-digits" title="gtk.Scale.get_digits">get_digits</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--set-draw-value" title="gtk.Scale.set_draw_value">set_draw_value</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>draw_value</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--get-draw-value" title="gtk.Scale.get_draw_value">get_draw_value</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--set-value-pos" title="gtk.Scale.set_value_pos">set_value_pos</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>pos</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--get-value-pos" title="gtk.Scale.get_value_pos">get_value_pos</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--get-layout" title="gtk.Scale.get_layout">get_layout</a></span>()</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--get-layout-offsets" title="gtk.Scale.get_layout_offsets">get_layout_offsets</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3639541"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Scale</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="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkruler.html" title="gtk.Ruler"><link rel="next" href="class-gtkscalebutton.html" title="gtk.ScaleButton"></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.Scale</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkruler.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkscalebutton.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkscale"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Scale</h2><p>gtk.Scale — a base class for the scale widgets.</p></div><div class="refsect1" lang="en"><a name="id3840141"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Scale</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkrange.html" title="gtk.Range">gtk.Range</a></span></span>):
 
2
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--set-digits" title="gtk.Scale.set_digits">set_digits</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>digits</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--get-digits" title="gtk.Scale.get_digits">get_digits</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--set-draw-value" title="gtk.Scale.set_draw_value">set_draw_value</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>draw_value</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--get-draw-value" title="gtk.Scale.get_draw_value">get_draw_value</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--set-value-pos" title="gtk.Scale.set_value_pos">set_value_pos</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>pos</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--get-value-pos" title="gtk.Scale.get_value_pos">get_value_pos</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--get-layout" title="gtk.Scale.get_layout">get_layout</a></span>()</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscale.html#method-gtkscale--get-layout-offsets" title="gtk.Scale.get_layout_offsets">get_layout_offsets</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3840346"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
3
3
  +-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
4
4
    +-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
5
5
      +-- <a class="link" href="class-gtkrange.html" title="gtk.Range">gtk.Range</a>
6
6
        +-- <a class="link" href="class-gtkscale.html" title="gtk.Scale">gtk.Scale</a>
7
 
</pre></div><div class="refsect1" lang="en"><a name="id3639586"></a><h2>Implemented Interfaces</h2><p>
 
7
</pre></div><div class="refsect1" lang="en"><a name="id3840391"></a><h2>Implemented Interfaces</h2><p>
8
8
                        <a class="link" href="class-gtkscale.html" title="gtk.Scale"><code class="classname">gtk.Scale</code></a>
9
9
                        implements 
10
10
                        <a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
13
13
displayed as a string next to the slider</td></tr><tr valign="top"><td valign="top">"value-pos"</td><td valign="top">Read-Write</td><td valign="top">The position in which the current value is displayed:
14
14
<code class="literal">gtk.POS_LEFT</code>, <code class="literal">gtk.POS_RIGHT</code>,
15
15
<code class="literal">gtk.POS_TOP</code> or <code class="literal">gtk.POS_BOTTOM</code></td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkscale"></a><h2>gtk.Scale Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p><p><a class="link" href="class-gtkrange.html#style-properties-gtkrange" title="gtk.Range Style Properties">gtk.Range Style Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"slider-length"</td><td valign="top">Read</td><td valign="top">The length of scale's slider</td></tr><tr valign="top"><td valign="top">"value-spacing"</td><td valign="top">Read</td><td valign="top">The space between value text and the slider or trough
16
 
              area</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkscale"></a><h2>gtk.Scale Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkrange.html#signal-prototypes-gtkrange" title="gtk.Range Signal Prototypes">gtk.Range Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkscale.html#signal-gtkscale--format-value" title='The "format-value" gtk.Scale Signal'>format-value</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>scale</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3639989"></a><h2>Description</h2><p>The <a class="link" href="class-gtkscale.html" title="gtk.Scale"><code class="classname">gtk.Scale</code></a> widget is
 
16
              area</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkscale"></a><h2>gtk.Scale Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkrange.html#signal-prototypes-gtkrange" title="gtk.Range Signal Prototypes">gtk.Range Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkscale.html#signal-gtkscale--format-value" title='The "format-value" gtk.Scale Signal'>format-value</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>scale</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3840794"></a><h2>Description</h2><p>The <a class="link" href="class-gtkscale.html" title="gtk.Scale"><code class="classname">gtk.Scale</code></a> widget is
17
17
an abstract base class, used only for deriving the subclasses <a class="link" href="class-gtkhscale.html" title="gtk.HScale"><code class="classname">gtk.HScale</code></a> and <a class="link" href="class-gtkvscale.html" title="gtk.VScale"><code class="classname">gtk.VScale</code></a>. A <a class="link" href="class-gtkscale.html" title="gtk.Scale"><code class="classname">gtk.Scale</code></a> is a slider
18
18
control used to select a numeric value. Since <a class="link" href="class-gtkscale.html" title="gtk.Scale"><code class="classname">gtk.Scale</code></a> is a
19
19
subclass of <a class="link" href="class-gtkrange.html" title="gtk.Range"><code class="classname">gtk.Range</code></a>, see the
21
21
methods for additional methods. To set the value of a scale, you would
22
22
normally use <a class="link" href="class-gtkrange.html#method-gtkrange--set-value" title="gtk.Range.set_value"><code class="methodname">set_value</code>()</a>. 
23
23
To detect changes to the value, you would normally use the "value_changed"
24
 
signal.</p></div><div class="refsect1" lang="en"><a name="id3640064"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkscale--set-digits"></a><h3>gtk.Scale.set_digits</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_digits</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>digits</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>digits</code></strong> :</span></p></td><td>the number of decimal places to
 
24
signal.</p></div><div class="refsect1" lang="en"><a name="id3840869"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkscale--set-digits"></a><h3>gtk.Scale.set_digits</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_digits</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>digits</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>digits</code></strong> :</span></p></td><td>the number of decimal places to
25
25
display</td></tr></tbody></table><p>The <code class="methodname">set_digits</code>() method sets the
26
26
"digits" property to the value specified by <em class="parameter"><code>digits</code></em>.
27
27
The value of <em class="parameter"><code>digits</code></em> specifies the number of decimal
61
61
representing the text in the scale. Remember when using the <a class="link" href="class-pangolayout.html" title="pango.Layout"><code class="classname">pango.Layout</code></a>
62
62
function you need to convert to and from pixels using the <a class="link" href="class-pangofont.html#function-pango--PIXELS" title="pango.PIXELS"><code class="function">pango.PIXELS</code>()</a>
63
63
function or <code class="literal">pango.SCALE</code>. If the "draw-value" property is
64
 
<code class="literal">False</code>, the return values are undefined.</p></div></div><div class="refsect1" lang="en"><a name="id3640788"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkscale--format-value"></a><h3>The "format-value" gtk.Scale Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>scale</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>value</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>scale</code></em> :</span></p></td><td>the scale that received the
 
64
<code class="literal">False</code>, the return values are undefined.</p></div></div><div class="refsect1" lang="en"><a name="id3841593"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkscale--format-value"></a><h3>The "format-value" gtk.Scale Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>scale</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>value</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>scale</code></em> :</span></p></td><td>the scale that received the
65
65
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td><td>the value to be formatted</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
66
66
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
67
67
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if