1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>gtkmm: Gtk::CheckMenuItem Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">gtkmm <span id="projectnumber">2.24.2</span></div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
26
<li><a href="pages.html"><span>Related Pages</span></a></li>
27
<li><a href="modules.html"><span>Modules</span></a></li>
28
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Class List</span></a></li>
35
<li><a href="classes.html"><span>Class Index</span></a></li>
36
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
37
<li><a href="functions.html"><span>Class Members</span></a></li>
40
<div id="nav-path" class="navpath">
42
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
43
<li class="navelem"><a class="el" href="classGtk_1_1CheckMenuItem.html">CheckMenuItem</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> |
50
<a href="#pro-methods">Protected Member Functions</a> |
51
<a href="#related">Related Functions</a> </div>
52
<div class="headertitle">
53
<h1>Gtk::CheckMenuItem Class Reference<div class="ingroups"><a class="el" href="group__Widgets.html">Widgets</a> | <a class="el" href="group__Menus.html">Menu classes</a></div></h1> </div>
55
<div class="contents">
56
<!-- doxytag: class="Gtk::CheckMenuItem" --><!-- doxytag: inherits="Gtk::MenuItem" -->
57
<p>A menu item that maintains the state of a boolean value in addition to a <a class="el" href="classGtk_1_1MenuItem.html" title="Child item for menus.">Gtk::MenuItem</a>'s usual role in activating application code. <a href="#_details">More...</a></p>
58
<div class="dynheader">
59
Inheritance diagram for Gtk::CheckMenuItem:</div>
60
<div class="dyncontent">
61
<div class="center"><img src="classGtk_1_1CheckMenuItem__inherit__graph.png" border="0" usemap="#Gtk_1_1CheckMenuItem_inherit__map" alt="Inheritance graph"/></div>
62
<map name="Gtk_1_1CheckMenuItem_inherit__map" id="Gtk_1_1CheckMenuItem_inherit__map">
63
<area shape="rect" id="node23" href="classGtk_1_1RadioMenuItem.html" title="A CheckMenuItem that belongs to a group." alt="" coords="59,806,200,837"/><area shape="rect" id="node2" href="classGtk_1_1MenuItem.html" title="Child item for menus." alt="" coords="75,646,184,677"/><area shape="rect" id="node4" href="classGtk_1_1Item.html" title="This class should be considered as a virtual base class." alt="" coords="91,566,168,597"/><area shape="rect" id="node6" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="95,486,164,517"/><area shape="rect" id="node8" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="76,406,183,437"/><area shape="rect" id="node10" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)" alt="" coords="84,326,175,357"/><area shape="rect" id="node12" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such as Gtk::Adjustme..." alt="" coords="21,246,109,277"/><area shape="rect" id="node14" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node16" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node18" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/><area shape="rect" id="node20" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="133,246,256,277"/></map>
64
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
65
<div class="dynheader">
66
Collaboration diagram for Gtk::CheckMenuItem:</div>
67
<div class="dyncontent">
68
<div class="center"><img src="classGtk_1_1CheckMenuItem__coll__graph.png" border="0" usemap="#Gtk_1_1CheckMenuItem_coll__map" alt="Collaboration graph"/></div>
69
<map name="Gtk_1_1CheckMenuItem_coll__map" id="Gtk_1_1CheckMenuItem_coll__map">
70
<area shape="rect" id="node2" href="classGtk_1_1MenuItem.html" title="Child item for menus." alt="" coords="173,699,283,730"/><area shape="rect" id="node4" href="classGtk_1_1Item.html" title="This class should be considered as a virtual base class." alt="" coords="123,601,200,631"/><area shape="rect" id="node6" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="127,502,196,533"/><area shape="rect" id="node8" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="108,419,215,450"/><area shape="rect" id="node10" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)" alt="" coords="116,337,207,367"/><area shape="rect" id="node12" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such as Gtk::Adjustme..." alt="" coords="21,254,109,285"/><area shape="rect" id="node14" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,171,111,202"/><area shape="rect" id="node16" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,89,125,119"/><area shape="rect" id="node18" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/><area shape="rect" id="node20" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="133,254,256,285"/><area shape="rect" id="node22" href="classGtk_1_1AccelKey.html" title="Defines accelerator key combinations." alt="" coords="224,601,331,631"/><area shape="rect" id="node24" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html" title="Glib::ustring" alt="" coords="232,502,323,533"/></map>
71
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
73
<p><a href="classGtk_1_1CheckMenuItem-members.html">List of all members.</a></p>
74
<table class="memberdecls">
75
<tr><td colspan="2"><h2><a name="pub-methods"></a>
76
Public Member Functions</h2></td></tr>
77
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a15230103bbc42f6c7d2a31cd296bf401">~CheckMenuItem</a> ()</td></tr>
78
<tr><td class="memItemLeft" align="right" valign="top">GtkCheckMenuItem* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#ae1cd8058cbedb6d2b10c48126aa7cd0b">gobj</a> ()</td></tr>
79
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#ae1cd8058cbedb6d2b10c48126aa7cd0b"></a><br/></td></tr>
80
<tr><td class="memItemLeft" align="right" valign="top">const GtkCheckMenuItem* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a303cc14dedc6089f93eb7a1eb0ef9ea1">gobj</a> () const </td></tr>
81
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a303cc14dedc6089f93eb7a1eb0ef9ea1"></a><br/></td></tr>
82
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#afe71276f497fa41438e9caf056364ebe">CheckMenuItem</a> ()</td></tr>
83
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a89dd5307f2dc327a666b34c42737ea02">CheckMenuItem</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& label, bool mnemonic=false)</td></tr>
84
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#ab2b9dca0ea2dbbbf9ebf5c52025d7656">set_active</a> (bool state=true)</td></tr>
85
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a0df0c0cd1c4236b80f384628cb5bdd1a">get_active</a> () const </td></tr>
86
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the check menu item is active. <a href="#a0df0c0cd1c4236b80f384628cb5bdd1a"></a><br/></td></tr>
87
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#abfd72929d9158bcf0d59ea73c43c1d28">toggled</a> ()</td></tr>
88
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a36b7bce27c9be0fc73667486692ac507">set_inconsistent</a> (bool setting=true)</td></tr>
89
<tr><td class="mdescLeft"> </td><td class="mdescRight">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 in that range are inconsistent, you may want to display the check in an "in between" state. <a href="#a36b7bce27c9be0fc73667486692ac507"></a><br/></td></tr>
90
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a07ff5a33b20d3b5babcdc7cda4f04a08">get_inconsistent</a> () const </td></tr>
91
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the value set by <a class="el" href="classGtk_1_1CheckMenuItem.html#a36b7bce27c9be0fc73667486692ac507" title="If the user has selected a range of elements (such as some text or spreadsheet cells) that are affect...">set_inconsistent()</a>. <a href="#a07ff5a33b20d3b5babcdc7cda4f04a08"></a><br/></td></tr>
92
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a6bc19fef98ea18c634398a654062e4c4">set_draw_as_radio</a> (bool draw_as_radio=true)</td></tr>
93
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether <em>check_menu_item</em> is drawn like a <a class="el" href="classGtk_1_1RadioMenuItem.html" title="A CheckMenuItem that belongs to a group.">Gtk::RadioMenuItem</a>. <a href="#a6bc19fef98ea18c634398a654062e4c4"></a><br/></td></tr>
94
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a28761f5bca1ec7e28d21c56fa2b5f993">get_draw_as_radio</a> () const </td></tr>
95
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether <em>check_menu_item</em> looks like a <a class="el" href="classGtk_1_1RadioMenuItem.html" title="A CheckMenuItem that belongs to a group.">Gtk::RadioMenuItem</a>. <a href="#a28761f5bca1ec7e28d21c56fa2b5f993"></a><br/></td></tr>
96
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a91a132cee0317fc3429b78310ddcc46f">signal_toggled</a> ()</td></tr>
97
<tr><td class="mdescLeft"> </td><td class="mdescRight">Triggered when the item changes state (Note : changing the item's state with <a class="el" href="classGtk_1_1CheckMenuItem.html#ab2b9dca0ea2dbbbf9ebf5c52025d7656">set_active()</a> will also trigger this signal) <a href="#a91a132cee0317fc3429b78310ddcc46f"></a><br/></td></tr>
98
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a0abd9bbaee271a248334398d3e53e5b0">property_active</a> ()</td></tr>
99
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the menu item is checked. <a href="#a0abd9bbaee271a248334398d3e53e5b0"></a><br/></td></tr>
100
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
101
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a2279f36eb8eb5bef364a150b9b021553">property_active</a> () const </td></tr>
102
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the menu item is checked. <a href="#a2279f36eb8eb5bef364a150b9b021553"></a><br/></td></tr>
103
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a1738cb2a515afb19625e143c2c66e7ee">property_inconsistent</a> ()</td></tr>
104
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether to display an 'inconsistent' state. <a href="#a1738cb2a515afb19625e143c2c66e7ee"></a><br/></td></tr>
105
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
106
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a7aecfd1f61e3b117ba69a34b4cce19ad">property_inconsistent</a> () const </td></tr>
107
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether to display an 'inconsistent' state. <a href="#a7aecfd1f61e3b117ba69a34b4cce19ad"></a><br/></td></tr>
108
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a9c8cc22364a1adb5cacbf2f16f7ffe14">property_draw_as_radio</a> ()</td></tr>
109
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the menu item looks like a radio menu item. <a href="#a9c8cc22364a1adb5cacbf2f16f7ffe14"></a><br/></td></tr>
110
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
111
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#adbd033770269d030c4ee580d24a7fc0f">property_draw_as_radio</a> () const </td></tr>
112
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the menu item looks like a radio menu item. <a href="#adbd033770269d030c4ee580d24a7fc0f"></a><br/></td></tr>
113
<tr><td colspan="2"><h2><a name="pro-methods"></a>
114
Protected Member Functions</h2></td></tr>
115
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#aaed9d53fc1ee69bb7d65511c24303dac">on_toggled</a> ()</td></tr>
116
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#a60f2d90cd53a5d08da1e58e8b19a264c">draw_indicator_vfunc</a> (GdkRectangle* area)</td></tr>
117
<tr><td class="mdescLeft"> </td><td class="mdescRight">Triggered when the item is redrawn (e.g.after being toggled) Overload this signal if you want to implement your own check item look. <a href="#a60f2d90cd53a5d08da1e58e8b19a264c"></a><br/></td></tr>
118
<tr><td colspan="2"><h2><a name="related"></a>
119
Related Functions</h2></td></tr>
120
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
121
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1CheckMenuItem.html">Gtk::CheckMenuItem</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckMenuItem.html#af338c70b431ea56cc0797e015e3d8001">wrap</a> (GtkCheckMenuItem* object, bool take_copy=false)</td></tr>
122
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#af338c70b431ea56cc0797e015e3d8001"></a><br/></td></tr>
124
<hr/><a name="_details"></a><h2>Detailed Description</h2>
125
<div class="textblock"><p>A menu item that maintains the state of a boolean value in addition to a <a class="el" href="classGtk_1_1MenuItem.html" title="Child item for menus.">Gtk::MenuItem</a>'s usual role in activating application code. </p>
126
<p>A check box indicating the state of the boolean value is displayed at the left side of the <a class="el" href="classGtk_1_1MenuItem.html" title="Child item for menus.">Gtk::MenuItem</a>. Activating the <a class="el" href="classGtk_1_1MenuItem.html" title="Child item for menus.">Gtk::MenuItem</a> toggles the value. </p>
127
</div><hr/><h2>Constructor & Destructor Documentation</h2>
128
<a class="anchor" id="a15230103bbc42f6c7d2a31cd296bf401"></a><!-- doxytag: member="Gtk::CheckMenuItem::~CheckMenuItem" ref="a15230103bbc42f6c7d2a31cd296bf401" args="()" -->
129
<div class="memitem">
130
<div class="memproto">
131
<table class="memname">
133
<td class="memname">virtual Gtk::CheckMenuItem::~CheckMenuItem </td>
135
<td class="paramname"></td><td>)</td>
136
<td><code> [virtual]</code></td>
144
<a class="anchor" id="afe71276f497fa41438e9caf056364ebe"></a><!-- doxytag: member="Gtk::CheckMenuItem::CheckMenuItem" ref="afe71276f497fa41438e9caf056364ebe" args="()" -->
145
<div class="memitem">
146
<div class="memproto">
147
<table class="memname">
149
<td class="memname">Gtk::CheckMenuItem::CheckMenuItem </td>
151
<td class="paramname"></td><td>)</td>
160
<a class="anchor" id="a89dd5307f2dc327a666b34c42737ea02"></a><!-- doxytag: member="Gtk::CheckMenuItem::CheckMenuItem" ref="a89dd5307f2dc327a666b34c42737ea02" args="(const Glib::ustring &label, bool mnemonic=false)" -->
161
<div class="memitem">
162
<div class="memproto">
163
<table class="memname">
165
<td class="memname">Gtk::CheckMenuItem::CheckMenuItem </td>
167
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
168
<td class="paramname"><em>label</em>, </td>
171
<td class="paramkey"></td>
173
<td class="paramtype">bool </td>
174
<td class="paramname"><em>mnemonic</em> = <code>false</code> </td>
179
<td></td><td><code> [explicit]</code></td>
187
<hr/><h2>Member Function Documentation</h2>
188
<a class="anchor" id="a60f2d90cd53a5d08da1e58e8b19a264c"></a><!-- doxytag: member="Gtk::CheckMenuItem::draw_indicator_vfunc" ref="a60f2d90cd53a5d08da1e58e8b19a264c" args="(GdkRectangle *area)" -->
189
<div class="memitem">
190
<div class="memproto">
191
<table class="memname">
193
<td class="memname">virtual void Gtk::CheckMenuItem::draw_indicator_vfunc </td>
195
<td class="paramtype">GdkRectangle * </td>
196
<td class="paramname"><em>area</em></td><td>)</td>
197
<td><code> [protected, virtual]</code></td>
203
<p>Triggered when the item is redrawn (e.g.after being toggled) Overload this signal if you want to implement your own check item look. </p>
204
<p>Otherwise, you most likely don't care about it. The GdkRectangle specifies the area of the widget which will get redrawn. </p>
208
<a class="anchor" id="a0df0c0cd1c4236b80f384628cb5bdd1a"></a><!-- doxytag: member="Gtk::CheckMenuItem::get_active" ref="a0df0c0cd1c4236b80f384628cb5bdd1a" args="() const " -->
209
<div class="memitem">
210
<div class="memproto">
211
<table class="memname">
213
<td class="memname">bool Gtk::CheckMenuItem::get_active </td>
215
<td class="paramname"></td><td>)</td>
222
<p>Returns whether the check menu item is active. </p>
223
<p>See <a class="el" href="classGtk_1_1CheckMenuItem.html#ab2b9dca0ea2dbbbf9ebf5c52025d7656">set_active()</a>. </p>
224
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the menu item is checked. </dd></dl>
228
<a class="anchor" id="a28761f5bca1ec7e28d21c56fa2b5f993"></a><!-- doxytag: member="Gtk::CheckMenuItem::get_draw_as_radio" ref="a28761f5bca1ec7e28d21c56fa2b5f993" args="() const " -->
229
<div class="memitem">
230
<div class="memproto">
231
<table class="memname">
233
<td class="memname">bool Gtk::CheckMenuItem::get_draw_as_radio </td>
235
<td class="paramname"></td><td>)</td>
242
<p>Returns whether <em>check_menu_item</em> looks like a <a class="el" href="classGtk_1_1RadioMenuItem.html" title="A CheckMenuItem that belongs to a group.">Gtk::RadioMenuItem</a>. </p>
243
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000060">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
244
<dl class="return"><dt><b>Returns:</b></dt><dd>Whether <em>check_menu_item</em> looks like a <a class="el" href="classGtk_1_1RadioMenuItem.html" title="A CheckMenuItem that belongs to a group.">Gtk::RadioMenuItem</a>. </dd></dl>
248
<a class="anchor" id="a07ff5a33b20d3b5babcdc7cda4f04a08"></a><!-- doxytag: member="Gtk::CheckMenuItem::get_inconsistent" ref="a07ff5a33b20d3b5babcdc7cda4f04a08" args="() const " -->
249
<div class="memitem">
250
<div class="memproto">
251
<table class="memname">
253
<td class="memname">bool Gtk::CheckMenuItem::get_inconsistent </td>
255
<td class="paramname"></td><td>)</td>
262
<p>Retrieves the value set by <a class="el" href="classGtk_1_1CheckMenuItem.html#a36b7bce27c9be0fc73667486692ac507" title="If the user has selected a range of elements (such as some text or spreadsheet cells) that are affect...">set_inconsistent()</a>. </p>
263
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if inconsistent. </dd></dl>
267
<a class="anchor" id="ae1cd8058cbedb6d2b10c48126aa7cd0b"></a><!-- doxytag: member="Gtk::CheckMenuItem::gobj" ref="ae1cd8058cbedb6d2b10c48126aa7cd0b" args="()" -->
268
<div class="memitem">
269
<div class="memproto">
270
<table class="memname">
272
<td class="memname">GtkCheckMenuItem* Gtk::CheckMenuItem::gobj </td>
274
<td class="paramname"></td><td>)</td>
275
<td><code> [inline]</code></td>
281
<p>Provides access to the underlying C GtkObject. </p>
283
<p>Reimplemented from <a class="el" href="classGtk_1_1MenuItem.html#aa83fe08a8b6c5e36a7c464c5f2faf946">Gtk::MenuItem</a>.</p>
285
<p>Reimplemented in <a class="el" href="classGtk_1_1RadioMenuItem.html#aabd8e463294ac590ba329a79bda1820b">Gtk::RadioMenuItem</a>.</p>
289
<a class="anchor" id="a303cc14dedc6089f93eb7a1eb0ef9ea1"></a><!-- doxytag: member="Gtk::CheckMenuItem::gobj" ref="a303cc14dedc6089f93eb7a1eb0ef9ea1" args="() const " -->
290
<div class="memitem">
291
<div class="memproto">
292
<table class="memname">
294
<td class="memname">const GtkCheckMenuItem* Gtk::CheckMenuItem::gobj </td>
296
<td class="paramname"></td><td>)</td>
297
<td> const<code> [inline]</code></td>
303
<p>Provides access to the underlying C GtkObject. </p>
305
<p>Reimplemented from <a class="el" href="classGtk_1_1MenuItem.html#a0a65458b00dcc51d4c70402aa3fb0d75">Gtk::MenuItem</a>.</p>
307
<p>Reimplemented in <a class="el" href="classGtk_1_1RadioMenuItem.html#a4e56cc44616edb1533dfcbe95705dc24">Gtk::RadioMenuItem</a>.</p>
311
<a class="anchor" id="aaed9d53fc1ee69bb7d65511c24303dac"></a><!-- doxytag: member="Gtk::CheckMenuItem::on_toggled" ref="aaed9d53fc1ee69bb7d65511c24303dac" args="()" -->
312
<div class="memitem">
313
<div class="memproto">
314
<table class="memname">
316
<td class="memname">virtual void Gtk::CheckMenuItem::on_toggled </td>
318
<td class="paramname"></td><td>)</td>
319
<td><code> [protected, virtual]</code></td>
327
<a class="anchor" id="a2279f36eb8eb5bef364a150b9b021553"></a><!-- doxytag: member="Gtk::CheckMenuItem::property_active" ref="a2279f36eb8eb5bef364a150b9b021553" args="() const " -->
328
<div class="memitem">
329
<div class="memproto">
330
<table class="memname">
332
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::CheckMenuItem::property_active </td>
334
<td class="paramname"></td><td>)</td>
341
<p>Whether the menu item is checked. </p>
342
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
343
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
347
<a class="anchor" id="a0abd9bbaee271a248334398d3e53e5b0"></a><!-- doxytag: member="Gtk::CheckMenuItem::property_active" ref="a0abd9bbaee271a248334398d3e53e5b0" args="()" -->
348
<div class="memitem">
349
<div class="memproto">
350
<table class="memname">
352
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::CheckMenuItem::property_active </td>
354
<td class="paramname"></td><td>)</td>
361
<p>Whether the menu item is checked. </p>
362
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
363
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
367
<a class="anchor" id="a9c8cc22364a1adb5cacbf2f16f7ffe14"></a><!-- doxytag: member="Gtk::CheckMenuItem::property_draw_as_radio" ref="a9c8cc22364a1adb5cacbf2f16f7ffe14" args="()" -->
368
<div class="memitem">
369
<div class="memproto">
370
<table class="memname">
372
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::CheckMenuItem::property_draw_as_radio </td>
374
<td class="paramname"></td><td>)</td>
381
<p>Whether the menu item looks like a radio menu item. </p>
382
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
383
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
387
<a class="anchor" id="adbd033770269d030c4ee580d24a7fc0f"></a><!-- doxytag: member="Gtk::CheckMenuItem::property_draw_as_radio" ref="adbd033770269d030c4ee580d24a7fc0f" args="() const " -->
388
<div class="memitem">
389
<div class="memproto">
390
<table class="memname">
392
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::CheckMenuItem::property_draw_as_radio </td>
394
<td class="paramname"></td><td>)</td>
401
<p>Whether the menu item looks like a radio menu item. </p>
402
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
403
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
407
<a class="anchor" id="a7aecfd1f61e3b117ba69a34b4cce19ad"></a><!-- doxytag: member="Gtk::CheckMenuItem::property_inconsistent" ref="a7aecfd1f61e3b117ba69a34b4cce19ad" args="() const " -->
408
<div class="memitem">
409
<div class="memproto">
410
<table class="memname">
412
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::CheckMenuItem::property_inconsistent </td>
414
<td class="paramname"></td><td>)</td>
421
<p>Whether to display an 'inconsistent' state. </p>
422
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
423
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
427
<a class="anchor" id="a1738cb2a515afb19625e143c2c66e7ee"></a><!-- doxytag: member="Gtk::CheckMenuItem::property_inconsistent" ref="a1738cb2a515afb19625e143c2c66e7ee" args="()" -->
428
<div class="memitem">
429
<div class="memproto">
430
<table class="memname">
432
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::CheckMenuItem::property_inconsistent </td>
434
<td class="paramname"></td><td>)</td>
441
<p>Whether to display an 'inconsistent' state. </p>
442
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
443
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
447
<a class="anchor" id="ab2b9dca0ea2dbbbf9ebf5c52025d7656"></a><!-- doxytag: member="Gtk::CheckMenuItem::set_active" ref="ab2b9dca0ea2dbbbf9ebf5c52025d7656" args="(bool state=true)" -->
448
<div class="memitem">
449
<div class="memproto">
450
<table class="memname">
452
<td class="memname">void Gtk::CheckMenuItem::set_active </td>
454
<td class="paramtype">bool </td>
455
<td class="paramname"><em>state</em> = <code>true</code></td><td>)</td>
464
<a class="anchor" id="a6bc19fef98ea18c634398a654062e4c4"></a><!-- doxytag: member="Gtk::CheckMenuItem::set_draw_as_radio" ref="a6bc19fef98ea18c634398a654062e4c4" args="(bool draw_as_radio=true)" -->
465
<div class="memitem">
466
<div class="memproto">
467
<table class="memname">
469
<td class="memname">void Gtk::CheckMenuItem::set_draw_as_radio </td>
471
<td class="paramtype">bool </td>
472
<td class="paramname"><em>draw_as_radio</em> = <code>true</code></td><td>)</td>
479
<p>Sets whether <em>check_menu_item</em> is drawn like a <a class="el" href="classGtk_1_1RadioMenuItem.html" title="A CheckMenuItem that belongs to a group.">Gtk::RadioMenuItem</a>. </p>
480
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000059">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
481
<dl><dt><b>Parameters:</b></dt><dd>
482
<table class="params">
483
<tr><td class="paramname">draw_as_radio</td><td>Whether <em>check_menu_item</em> is drawn like a <a class="el" href="classGtk_1_1RadioMenuItem.html" title="A CheckMenuItem that belongs to a group.">Gtk::RadioMenuItem</a>. </td></tr>
490
<a class="anchor" id="a36b7bce27c9be0fc73667486692ac507"></a><!-- doxytag: member="Gtk::CheckMenuItem::set_inconsistent" ref="a36b7bce27c9be0fc73667486692ac507" args="(bool setting=true)" -->
491
<div class="memitem">
492
<div class="memproto">
493
<table class="memname">
495
<td class="memname">void Gtk::CheckMenuItem::set_inconsistent </td>
497
<td class="paramtype">bool </td>
498
<td class="paramname"><em>setting</em> = <code>true</code></td><td>)</td>
505
<p>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 in that range are inconsistent, you may want to display the check in an "in between" state. </p>
506
<p>This function turns on "in between" display. Normally you would turn off the inconsistent state again if the user explicitly selects a setting. This has to be done manually, <a class="el" href="classGtk_1_1CheckMenuItem.html#a36b7bce27c9be0fc73667486692ac507" title="If the user has selected a range of elements (such as some text or spreadsheet cells) that are affect...">set_inconsistent()</a> only affects visual appearance, it doesn't affect the semantics of the widget. </p>
507
<dl><dt><b>Parameters:</b></dt><dd>
508
<table class="params">
509
<tr><td class="paramname">setting</td><td><code>true</code> to display an "inconsistent" third state check. </td></tr>
516
<a class="anchor" id="a91a132cee0317fc3429b78310ddcc46f"></a><!-- doxytag: member="Gtk::CheckMenuItem::signal_toggled" ref="a91a132cee0317fc3429b78310ddcc46f" args="()" -->
517
<div class="memitem">
518
<div class="memproto">
519
<table class="memname">
521
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gtk::CheckMenuItem::signal_toggled </td>
523
<td class="paramname"></td><td>)</td>
530
<p>Triggered when the item changes state (Note : changing the item's state with <a class="el" href="classGtk_1_1CheckMenuItem.html#ab2b9dca0ea2dbbbf9ebf5c52025d7656">set_active()</a> will also trigger this signal) </p>
531
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_toggled()</code> </dd></dl>
535
<a class="anchor" id="abfd72929d9158bcf0d59ea73c43c1d28"></a><!-- doxytag: member="Gtk::CheckMenuItem::toggled" ref="abfd72929d9158bcf0d59ea73c43c1d28" args="()" -->
536
<div class="memitem">
537
<div class="memproto">
538
<table class="memname">
540
<td class="memname">void Gtk::CheckMenuItem::toggled </td>
542
<td class="paramname"></td><td>)</td>
551
<hr/><h2>Friends And Related Function Documentation</h2>
552
<a class="anchor" id="af338c70b431ea56cc0797e015e3d8001"></a><!-- doxytag: member="Gtk::CheckMenuItem::wrap" ref="af338c70b431ea56cc0797e015e3d8001" args="(GtkCheckMenuItem *object, bool take_copy=false)" -->
553
<div class="memitem">
554
<div class="memproto">
555
<table class="memname">
557
<td class="memname"><a class="el" href="classGtk_1_1CheckMenuItem.html">Gtk::CheckMenuItem</a>* wrap </td>
559
<td class="paramtype">GtkCheckMenuItem * </td>
560
<td class="paramname"><em>object</em>, </td>
563
<td class="paramkey"></td>
565
<td class="paramtype">bool </td>
566
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
571
<td></td><td><code> [related]</code></td>
577
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
578
<dl><dt><b>Parameters:</b></dt><dd>
579
<table class="params">
580
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
581
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
585
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
589
<hr/>The documentation for this class was generated from the following file:<ul>
590
<li>gtkmm/checkmenuitem.h</li>
593
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:45 for gtkmm by 
594
<a href="http://www.doxygen.org/index.html">
595
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
added
removed
share/doc/gtkmm-2.4/reference/html/classGtk_1_1CheckMenuItem.html
