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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.CheckMenuItem</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><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="previous" href="class-gtkcheckbutton.html" title="gtk.CheckButton"><link rel="next" href="class-gtkclipboard.html" title="gtk.Clipboard"></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.CheckMenuItem</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkcheckbutton.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gtkclipboard.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkcheckmenuitem"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.CheckMenuItem</h2><p>gtk.CheckMenuItem — a menu item with a check box.</p></div><div class="refsect1" lang="en"><a name="id3305769"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.CheckMenuItem</span></span>(<span class="ooclass"><span class="classname"><a href="class-gtkmenuitem.html" title="gtk.MenuItem">gtk.MenuItem</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a href="class-gtkcheckmenuitem.html#constructor-gtkcheckmenuitem" title="Constructor">gtk.CheckMenuItem</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>label</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>use_underline</tt></b></span><span class="initializer">=TRUE</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkcheckmenuitem.html#method-gtkcheckmenuitem--set-active" title="gtk.CheckMenuItem.set_active">set_active</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>is_active</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkcheckmenuitem.html#method-gtkcheckmenuitem--get-active" title="gtk.CheckMenuItem.get_active">get_active</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkcheckmenuitem.html#method-gtkcheckmenuitem--toggled" title="gtk.CheckMenuItem.toggled">toggled</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkcheckmenuitem.html#method-gtkcheckmenuitem--set-inconsistent" title="gtk.CheckMenuItem.set_inconsistent">set_inconsistent</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkcheckmenuitem.html#method-gtkcheckmenuitem--get-inconsistent" title="gtk.CheckMenuItem.get_inconsistent">get_inconsistent</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkcheckmenuitem.html#method-gtkcheckmenuitem--set-draw-as-radio" title="gtk.CheckMenuItem.set_draw_as_radio">set_draw_as_radio</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>draw_as_radio</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkcheckmenuitem.html#method-gtkcheckmenuitem--get-draw-as-radio" title="gtk.CheckMenuItem.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="id3213285"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
+-- <a href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a href="class-gtkitem.html" title="gtk.Item">gtk.Item</a>
+-- <a href="class-gtkmenuitem.html" title="gtk.MenuItem">gtk.MenuItem</a>
+-- <a href="class-gtkcheckmenuitem.html" title="gtk.CheckMenuItem">gtk.CheckMenuItem</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3288608"></a><h2>Properties</h2><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 <tt class="literal">TRUE</tt>, the menu item is checked.</td></tr><tr valign="top"><td valign="top">"inconsistent"</td><td valign="top">Read/Write</td><td valign="top">If <tt class="literal">TRUE</tt>, display an "inconsistent"
state.</td></tr><tr valign="top"><td valign="top">"draw-as-radio"</td><td valign="top">Read/Write</td><td valign="top">If <tt class="literal">TRUE</tt>, display like a radio menu item.
GTK+ 2.4 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3294875"></a><h2>Style Properties</h2><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">"indicator-size"</td><td valign="top">Read</td><td valign="top">The size of the check or radio indicator.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3307202"></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><col><col></colgroup><tbody><tr valign="top"><td valign="top">"active"</td><td valign="top">Read</td><td valign="top">If <tt class="literal">TRUE</tt>, the menu item is
checked.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3328976"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term">"<a href="class-gtkcheckmenuitem.html#signal-gtkcheckmenuitem--toggled" title='The "toggled" gtk.CheckMenuItem Signal'>toggled</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>checkmenuitem</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3335358"></a><h2>Description</h2><p>A <a href="class-gtkcheckmenuitem.html" title="gtk.CheckMenuItem"><tt class="classname">gtk.CheckMenuItem</tt></a>
is a menu item that maintains the state of a boolean value in addition to a
<a href="class-gtkmenuitem.html" title="gtk.MenuItem"><tt class="classname">gtk.MenuItem</tt></a>'s
usual role in activating application code. A check box indicating the state
of the boolean value is displayed at the left side of the <a href="class-gtkmenuitem.html" title="gtk.MenuItem"><tt class="classname">gtk.MenuItem</tt></a>.
Activating the <a href="class-gtkmenuitem.html" title="gtk.MenuItem"><tt class="classname">gtk.MenuItem</tt></a>
toggles the value.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkcheckmenuitem"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.CheckMenuItem</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>label</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>use_underline</tt></b></span><span class="initializer">=TRUE</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>label</tt></b>:</span></td><td>a string to be used as the label text or
<tt class="literal">None</tt></td></tr><tr><td><span class="term"><b class="parameter"><tt>use_underline</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt>, an underscore in the
label text indicates the next character should be underlined and used for the
mnemonic accelerator key if it is the first character so
marked. Available in PyGTK 2.4 and above.</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new checkmenuitem</td></tr></tbody></table><p>Creates a new checkmenuitem with a text label specified by
<i class="parameter"><tt>label</tt></i>. If <i class="parameter"><tt>label</tt></i> is
<tt class="literal">None</tt> or not specified then no label is created. If
<i class="parameter"><tt>label</tt></i> contains underscore characters then the
character following the underscore will be underlined and the character
following the first underscore will be used as the mnemonic keyboard
accelerator.</p><p>In PyGTK 2.4 and above the <i class="parameter"><tt>use_underline</tt></i>
parameter is available and defaults to <tt class="literal">TRUE</tt>. If
<i class="parameter"><tt>use_underline</tt></i> is set to <tt class="literal">FALSE</tt> the
label text will not be parsed for mnemonic characters.</p></div><div class="refsect1" lang="en"><a name="id3304681"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkcheckmenuitem--set-active"></a><h3>gtk.CheckMenuItem.set_active</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_active</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>is_active</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>is_active</tt></b>:</span></td><td>If TRUE set the check box
active</td></tr></tbody></table><p>The <tt class="methodname">set_active</tt>() method sets the active
state of the menu item's check box according to the value of
<i class="parameter"><tt>is_active</tt></i>.</p></div><div class="refsect2" lang="en"><a name="method-gtkcheckmenuitem--get-active"></a><h3>gtk.CheckMenuItem.get_active</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_active</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the menu item is
checked (check box is active).</td></tr></tbody></table><p>The <tt class="methodname">get_active</tt>() method returns whether
the check menu item is active. See <a href="class-gtkcheckmenuitem.html#method-gtkcheckmenuitem--set-active" title="gtk.CheckMenuItem.set_active"><tt class="function">gtk.CheckMenuItem.set_active()</tt></a>.</p></div><div class="refsect2" lang="en"><a name="method-gtkcheckmenuitem--toggled"></a><h3>gtk.CheckMenuItem.toggled</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">toggled</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The toggle() method emits the "toggled" signal on the
checkmenuitem</p></div><div class="refsect2" lang="en"><a name="method-gtkcheckmenuitem--set-inconsistent"></a><h3>gtk.CheckMenuItem.set_inconsistent</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_inconsistent</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>setting</tt></b>:</span></td><td>If <tt class="literal">TRUE</tt> display an
"inconsistent" third state check</td></tr></tbody></table><p>The <tt class="methodname">set_inconsistent</tt>() method sets the
check box to display an "inconsistent" state if the value of
<i class="parameter"><tt>setting</tt></i> is <tt class="literal">TRUE</tt>. The
"inconsistent" state display is removed if <i class="parameter"><tt>setting</tt></i> is
<tt class="literal">FALSE</tt>.</p><p>An application may want to display an "inconsistent" state if
the user has selected a range of elements (such as some text or spreadsheet
cells) that are affected by a boolean setting, and the current values for
those elements cannot be represented by a single checkmenuitem state. The
<tt class="methodname">set_inconsistent</tt>() method only affects visual
appearance, it doesn't affect the semantics of the widget.</p></div><div class="refsect2" lang="en"><a name="method-gtkcheckmenuitem--get-inconsistent"></a><h3>gtk.CheckMenuItem.get_inconsistent</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_inconsistent</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the checkmenuitem
displays the "inconsistent" state</td></tr></tbody></table><p>The <tt class="methodname">get_inconsistent</tt>() method retrieves
the value set by the <a href="class-gtkcheckmenuitem.html#method-gtkcheckmenuitem--set-inconsistent" title="gtk.CheckMenuItem.set_inconsistent"><tt class="methodname">set_inconsistent()</tt></a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkcheckmenuitem--set-draw-as-radio"></a><h3>gtk.CheckMenuItem.set_draw_as_radio</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_draw_as_radio</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>draw_as_radio</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>draw_as_radio</tt></b>:</span></td><td>If <tt class="literal">TRUE</tt> display the check
menu item like a radio menu item</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 <tt class="methodname">set_draw_as_radio</tt>() method displays
the check menu item like a radio menu item if the value of
<i class="parameter"><tt>draw_as_radio</tt></i> is <tt class="literal">TRUE</tt>. If
<i class="parameter"><tt>draw_as_radio</tt></i> is <tt class="literal">FALSE</tt> the check
menu item is displayed as normal.</p></div><div class="refsect2" lang="en"><a name="method-gtkcheckmenuitem--get-draw-as-radio"></a><h3>gtk.CheckMenuItem.get_draw_as_radio</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_draw_as_radio</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the checkmenuitem
should be displayed like a radio menu item.</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 <tt class="methodname">get_draw_as_radio</tt>() method
retrieves the value set by the <a href="class-gtkcheckmenuitem.html#method-gtkcheckmenuitem--set-draw-as-radio" title="gtk.CheckMenuItem.set_draw_as_radio"><tt class="methodname">set_draw_as_radio()</tt></a>
method.</p></div></div><div class="refsect1" lang="en"><a name="id3307794"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkcheckmenuitem--toggled"></a><h3>The "toggled" gtk.CheckMenuItem Signal</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>checkmenuitem</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>checkmenuitem</tt></i>:</span></td><td>the checkmenuitem that received the
signal</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_param1</tt></i>:</span></td><td>the first user parameter (if any) specified
with the <a href="class-gobject.html#method-gobject--connect" title="gobject.GObject.connect"><tt class="methodname">connect</tt>()</a>
method</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i>:</span></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "toggled" signal is emitted when the checkmenuitem changes
state.</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-gtkcheckbutton.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-gtkclipboard.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.CheckButton</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.Clipboard</td></tr></table></div></body></html>
|
