← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/html/class-gtktoggleaction.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-gtktoggleaction.html
1
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.ToggleAction</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-gtktextview.html" title="gtk.TextView"><link rel="next" href="class-gtktogglebutton.html" title="gtk.ToggleButton"></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.ToggleAction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtktextview.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtktogglebutton.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtktoggleaction"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.ToggleAction</h2><p>gtk.ToggleAction — an action which can be
2
 
    toggled between two states (new in PyGTK 2.4)</p></div><div class="refsect1" lang="en"><a name="id3739130"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.ToggleAction</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkaction.html" title="gtk.Action">gtk.Action</a></span></span>):
3
 
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtktoggleaction.html#constructor-gtktoggleaction" title="Constructor">gtk.ToggleAction</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tooltip</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>stock_id</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--toggled" title="gtk.ToggleAction.toggled">toggled</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--set-active" title="gtk.ToggleAction.set_active">set_active</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>is_active</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--get-active" title="gtk.ToggleAction.get_active">get_active</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--set-draw-as-radio" title="gtk.ToggleAction.set_draw_as_radio">set_draw_as_radio</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>draw_as_radio</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--get-draw-as-radio" title="gtk.ToggleAction.get_draw_as_radio">get_draw_as_radio</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3739344"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
2
    toggled between two states (new in PyGTK 2.4)</p></div><div class="refsect1" lang="en"><a name="id3940037"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.ToggleAction</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkaction.html" title="gtk.Action">gtk.Action</a></span></span>):
 
3
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtktoggleaction.html#constructor-gtktoggleaction" title="Constructor">gtk.ToggleAction</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tooltip</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>stock_id</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--toggled" title="gtk.ToggleAction.toggled">toggled</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--set-active" title="gtk.ToggleAction.set_active">set_active</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>is_active</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--get-active" title="gtk.ToggleAction.get_active">get_active</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--set-draw-as-radio" title="gtk.ToggleAction.set_draw_as_radio">set_draw_as_radio</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>draw_as_radio</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--get-draw-as-radio" title="gtk.ToggleAction.get_draw_as_radio">get_draw_as_radio</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3940251"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
4
4
  +-- <a class="link" href="class-gtkaction.html" title="gtk.Action">gtk.Action</a>
5
5
    +-- <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction">gtk.ToggleAction</a>
6
 
</pre></div><div class="refsect1" lang="en"><a name="id3739376"></a><h2>Implemented Interfaces</h2><p>
 
6
</pre></div><div class="refsect1" lang="en"><a name="id3940284"></a><h2>Implemented Interfaces</h2><p>
7
7
                        <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</code></a>
8
8
                        implements 
9
9
                        <a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
10
10
                </p></div><div class="refsect1" lang="en"><a name="properties-gtktoggleaction"></a><h2>gtk.ToggleAction Properties</h2><p><a class="link" href="class-gtkaction.html#properties-gtkaction" title="gtk.Action Properties">gtk.Action 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">"active"</td><td valign="top">Read-Write</td><td valign="top">If the toggle action should be active in or not.  This
11
11
          property is available in GTK+ 2.10 and above.</td></tr><tr valign="top"><td valign="top">"draw-as-radio"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, the proxies for this action
12
12
              look like radio action proxies. Available in GTK+ 2.4 and
13
 
              above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtktoggleaction"></a><h2>gtk.ToggleAction Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkaction.html#signal-prototypes-gtkaction" title="gtk.Action Signal Prototypes">gtk.Action 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-gtktoggleaction.html#signal-gtktoggleaction--toggled" title='The "toggled" gtk.ToggleAction Signal'>toggled</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>toggleaction</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="id3739603"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This object is available in PyGTK 2.4 and above.</p></div><p>A <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</code></a>
 
13
              above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtktoggleaction"></a><h2>gtk.ToggleAction Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkaction.html#signal-prototypes-gtkaction" title="gtk.Action Signal Prototypes">gtk.Action 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-gtktoggleaction.html#signal-gtktoggleaction--toggled" title='The "toggled" gtk.ToggleAction Signal'>toggled</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>toggleaction</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="id3940510"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This object is available in PyGTK 2.4 and above.</p></div><p>A <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</code></a>
14
14
which is a subclass of <a class="link" href="class-gtkaction.html" title="gtk.Action"><code class="classname">gtk.Action</code></a>
15
15
corresponds roughly to a <a class="link" href="class-gtkcheckmenuitem.html" title="gtk.CheckMenuItem"><code class="classname">gtk.CheckMenuItem</code></a>. It
16
16
has an "active" state specifying whether the action has been checked or
19
19
the action</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</code></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.4 and above.</p></div><p>Creates a new <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</code></a>
20
20
object. To add the action to a <a class="link" href="class-gtkactiongroup.html" title="gtk.ActionGroup"><code class="classname">gtk.ActionGroup</code></a>
21
21
and set the accelerator for the action, call the <a class="link" href="class-gtkactiongroup.html#method-gtkactiongroup--add-action-with-accel" title="gtk.ActionGroup.add_action_with_accel"><code class="methodname">gtk.ActionGroup.add_action_with_accel()</code></a>
22
 
method.</p></div><div class="refsect1" lang="en"><a name="id3739867"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtktoggleaction--toggled"></a><h3>gtk.ToggleAction.toggled</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">toggled</span>(<span class="methodparam"></span>)</code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">toggled</code>() method emits the
 
22
method.</p></div><div class="refsect1" lang="en"><a name="id3940774"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtktoggleaction--toggled"></a><h3>gtk.ToggleAction.toggled</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">toggled</span>(<span class="methodparam"></span>)</code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">toggled</code>() method emits the
23
23
"toggled" signal on the toggle action.</p></div><div class="refsect2" lang="en"><a name="method-gtktoggleaction--set-active"></a><h3>gtk.ToggleAction.set_active</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_active</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>is_active</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>is_active</code></strong> :</span></p></td><td>if <code class="literal">True</code> the action should be
24
24
          checked</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_active</code>() method sets the
25
25
checked state on the toggle action.</p></div><div class="refsect2" lang="en"><a name="method-gtktoggleaction--get-active"></a><h3>gtk.ToggleAction.get_active</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_active</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 the toggle action is
33
33
          have proxies like a radio action.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_draw_as_radio</code>() method returns
34
34
the value of the "draw-as-radio" property. If "draw-as-radio" is
35
35
<code class="literal">True</code> the action should have proxies like a radio
36
 
action.</p></div></div><div class="refsect1" lang="en"><a name="id3740273"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtktoggleaction--toggled"></a><h3>The "toggled" gtk.ToggleAction Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>toggleaction</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>toggleaction</code></em> :</span></p></td><td>the toggleaction that received the
 
36
action.</p></div></div><div class="refsect1" lang="en"><a name="id3941180"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtktoggleaction--toggled"></a><h3>The "toggled" gtk.ToggleAction Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>toggleaction</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>toggleaction</code></em> :</span></p></td><td>the toggleaction that received the
37
37
signal</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
38
38
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
39
39
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if