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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>gtkmm: Gtk::CheckButton Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1CheckButton.html">CheckButton</a>
</div>
</div>
<div class="contents">
<h1>Gtk::CheckButton Class Reference<br/>
<small>
[<a class="el" href="group__Widgets.html">Widgets</a>]</small>
</h1><!-- doxytag: class="Gtk::CheckButton" --><!-- doxytag: inherits="Gtk::ToggleButton" -->
<p>Create widgets with a discrete toggle button. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGtk_1_1ToggleButton.html">Gtk::ToggleButton</a>.</p>
<p>Inherited by <a class="el" href="classGtk_1_1RadioButton.html">Gtk::RadioButton</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::CheckButton:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1CheckButton__coll__graph.png" border="0" usemap="#Gtk_1_1CheckButton_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1CheckButton_coll__map" id="Gtk_1_1CheckButton_coll__map">
<area shape="rect" href="classGtk_1_1ToggleButton.html" title="A Gtk::ToggleButton will remain 'pressed-in' when clicked." alt="" coords="51,624,176,653"/><area shape="rect" href="classGtk_1_1Button.html" title="A widget that creates a signal when clicked on." alt="" coords="69,547,157,576"/><area shape="rect" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="79,469,148,499"/><area shape="rect" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="61,392,165,421"/><area shape="rect" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)." alt="" coords="68,315,159,344"/><area shape="rect" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such..." alt="" coords="5,237,93,267"/><area shape="rect" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,160,96,189"/><area shape="rect" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="51,83,171,112"/><area shape="rect" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="123,160,227,189"/><area shape="rect" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="57,5,164,35"/><area shape="rect" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="117,237,237,267"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGtk_1_1CheckButton-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckButton.html#aa28fef7f3bb24e3f6498ae85e4f62fb1">~CheckButton</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkCheckButton* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckButton.html#a9c03c6bb7097d41b6a1d7437259e7cee">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a9c03c6bb7097d41b6a1d7437259e7cee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkCheckButton* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckButton.html#a89c2952646c6133413f35f8c38a8f7c1">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a89c2952646c6133413f35f8c38a8f7c1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckButton.html#a5f3a383438e1043eaec2150e99ce4e77">CheckButton</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty check button. <a href="#a5f3a383438e1043eaec2150e99ce4e77"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckButton.html#a44c85c68143c52c7500e970173a23688">CheckButton</a> (const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>& label, bool mnemonic=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a check button with a label. <a href="#a44c85c68143c52c7500e970173a23688"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckButton.html#acee09f2588a92bfe255f76cf7cc92d4f">draw_indicator_vfunc</a> (GdkRectangle* area)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emited on button redraw to update indicator. <a href="#acee09f2588a92bfe255f76cf7cc92d4f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1CheckButton.html">Gtk::CheckButton</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1CheckButton.html#a8105b4f7b65bd7214aaff8a0ab0235c5">wrap</a> (GtkCheckButton* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a8105b4f7b65bd7214aaff8a0ab0235c5"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Create widgets with a discrete toggle button. </p>
<p>A <a class="el" href="classGtk_1_1CheckButton.html" title="Create widgets with a discrete toggle button.">Gtk::CheckButton</a> places a discrete <a class="el" href="classGtk_1_1ToggleButton.html" title="A Gtk::ToggleButton will remain 'pressed-in' when clicked.">Gtk::ToggleButton</a> next to a widget, (usually a <a class="el" href="classGtk_1_1Label.html" title="A widget that displays a small to medium amount of text.">Gtk::Label</a>). See <a class="el" href="classGtk_1_1ToggleButton.html" title="A Gtk::ToggleButton will remain 'pressed-in' when clicked.">Gtk::ToggleButton</a> widgets for more information about toggle/check buttons. The important signal, <a class="el" href="classGtk_1_1ToggleButton.html#a85ce4ecde9214e112d1b739ba5fe6ef8" title="Emitted whenever the toggle tool button changes state.">signal_toggled()</a> is also inherited from <a class="el" href="classGtk_1_1ToggleButton.html" title="A Gtk::ToggleButton will remain 'pressed-in' when clicked.">Gtk::ToggleButton</a>.</p>
<p>The <a class="el" href="classGtk_1_1CheckButton.html" title="Create widgets with a discrete toggle button.">CheckButton</a> widget looks like this: </p>
<div align="center">
<img src="checkbutton1.png" alt="checkbutton1.png"/>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa28fef7f3bb24e3f6498ae85e4f62fb1"></a><!-- doxytag: member="Gtk::CheckButton::~CheckButton" ref="aa28fef7f3bb24e3f6498ae85e4f62fb1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::CheckButton::~CheckButton </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a5f3a383438e1043eaec2150e99ce4e77"></a><!-- doxytag: member="Gtk::CheckButton::CheckButton" ref="a5f3a383438e1043eaec2150e99ce4e77" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::CheckButton::CheckButton </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an empty check button. </p>
<p>With an empty button, you can <a class="el" href="classGtk_1_1Container.html#ae5f3b9c32b1b74e7613997843e91f4cc">Gtk::Button::add()</a> a widget such as a Gtk::Pixmap or <a class="el" href="classGtk_1_1Box.html" title="A base class for box containers.">Gtk::Box</a>.</p>
<p>If you just wish to add a <a class="el" href="classGtk_1_1Label.html" title="A widget that displays a small to medium amount of text.">Gtk::Label</a>, you may want to use the Gtk::CheckButton(const Glib::ustring& label) constructor directly instead. </p>
</div>
</div>
<a class="anchor" id="a44c85c68143c52c7500e970173a23688"></a><!-- doxytag: member="Gtk::CheckButton::CheckButton" ref="a44c85c68143c52c7500e970173a23688" args="(const Glib::ustring &label, bool mnemonic=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::CheckButton::CheckButton </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>label</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>mnemonic</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a check button with a label. </p>
<p>You won't be able to add a widget to this button since it already contains a <a class="el" href="classGtk_1_1Label.html" title="A widget that displays a small to medium amount of text.">Gtk::Label</a> </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acee09f2588a92bfe255f76cf7cc92d4f"></a><!-- doxytag: member="Gtk::CheckButton::draw_indicator_vfunc" ref="acee09f2588a92bfe255f76cf7cc92d4f" args="(GdkRectangle *area)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::CheckButton::draw_indicator_vfunc </td>
<td>(</td>
<td class="paramtype">GdkRectangle * </td>
<td class="paramname"> <em>area</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emited on button redraw to update indicator. </p>
<p>Triggered when the button is redrawn (e.g.after being toggled) Overload this signal if you want to implement your own check button look. Otherwise, you most likely don't care about it. The GdkRectangle specifies the area of the widget which will get redrawn. </p>
</div>
</div>
<a class="anchor" id="a89c2952646c6133413f35f8c38a8f7c1"></a><!-- doxytag: member="Gtk::CheckButton::gobj" ref="a89c2952646c6133413f35f8c38a8f7c1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkCheckButton* Gtk::CheckButton::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1ToggleButton.html#a64415628d18b8d76da14ce7109e9b6af">Gtk::ToggleButton</a>.</p>
<p>Reimplemented in <a class="el" href="classGtk_1_1RadioButton.html#a03095fa6bb24ec52d0cceaa3d5ac353d">Gtk::RadioButton</a>.</p>
</div>
</div>
<a class="anchor" id="a9c03c6bb7097d41b6a1d7437259e7cee"></a><!-- doxytag: member="Gtk::CheckButton::gobj" ref="a9c03c6bb7097d41b6a1d7437259e7cee" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkCheckButton* Gtk::CheckButton::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1ToggleButton.html#aaf95f140bb908c7424ce489c8c988993">Gtk::ToggleButton</a>.</p>
<p>Reimplemented in <a class="el" href="classGtk_1_1RadioButton.html#a43c24cc7bea2c2edf043f4b76c632ee7">Gtk::RadioButton</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a8105b4f7b65bd7214aaff8a0ab0235c5"></a><!-- doxytag: member="Gtk::CheckButton::wrap" ref="a8105b4f7b65bd7214aaff8a0ab0235c5" args="(GtkCheckButton *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1CheckButton.html">Gtk::CheckButton</a>* wrap </td>
<td>(</td>
<td class="paramtype">GtkCheckButton * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/checkbutton.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:49 2010 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|