~inkscape.dev/inkscape-devlibs/devlibs-gtk3

« back to all changes in this revision

Viewing changes to share/doc/gtkmm-2.4/reference/html/classGtk_1_1ToggleToolButton.html

  • Committer: JazzyNico
  • Date: 2013-01-21 10:11:05 UTC
  • Revision ID: nicoduf@yahoo.fr-20130121101105-i8d8slkq9ng4olx8
Adding gtk2 libraries.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>gtkmm: Gtk::ToggleToolButton Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.3 -->
 
11
<div id="top">
 
12
<div id="titlearea">
 
13
<table cellspacing="0" cellpadding="0">
 
14
 <tbody>
 
15
 <tr style="height: 56px;">
 
16
  <td style="padding-left: 0.5em;">
 
17
   <div id="projectname">gtkmm&#160;<span id="projectnumber">2.24.2</span></div>
 
18
  </td>
 
19
 </tr>
 
20
 </tbody>
 
21
</table>
 
22
</div>
 
23
  <div id="navrow1" class="tabs">
 
24
    <ul class="tablist">
 
25
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
26
      <li><a href="pages.html"><span>Related&#160;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>
 
30
    </ul>
 
31
  </div>
 
32
  <div id="navrow2" class="tabs2">
 
33
    <ul class="tablist">
 
34
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
35
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
36
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
 
37
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
38
    </ul>
 
39
  </div>
 
40
  <div id="nav-path" class="navpath">
 
41
    <ul>
 
42
      <li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
 
43
      <li class="navelem"><a class="el" href="classGtk_1_1ToggleToolButton.html">ToggleToolButton</a> </li>
 
44
    </ul>
 
45
  </div>
 
46
</div>
 
47
<div class="header">
 
48
  <div class="summary">
 
49
<a href="#pub-methods">Public Member Functions</a> &#124;
 
50
<a href="#pro-methods">Protected Member Functions</a> &#124;
 
51
<a href="#related">Related Functions</a> </div>
 
52
  <div class="headertitle">
 
53
<h1>Gtk::ToggleToolButton Class Reference<div class="ingroups"><a class="el" href="group__Widgets.html">Widgets</a></div></h1> </div>
 
54
</div>
 
55
<div class="contents">
 
56
<!-- doxytag: class="Gtk::ToggleToolButton" --><!-- doxytag: inherits="Gtk::ToolButton" -->
 
57
<p>A <a class="el" href="classGtk_1_1ToolItem.html">Gtk::ToolItem</a> containing a toggle button. <a href="#_details">More...</a></p>
 
58
<div class="dynheader">
 
59
Inheritance diagram for Gtk::ToggleToolButton:</div>
 
60
<div class="dyncontent">
 
61
<div class="center"><img src="classGtk_1_1ToggleToolButton__inherit__graph.png" border="0" usemap="#Gtk_1_1ToggleToolButton_inherit__map" alt="Inheritance graph"/></div>
 
62
<map name="Gtk_1_1ToggleToolButton_inherit__map" id="Gtk_1_1ToggleToolButton_inherit__map">
 
63
<area shape="rect" id="node23" href="classGtk_1_1RadioToolButton.html" title="A toolbar item that contains a radio button." alt="" coords="56,806,203,837"/><area shape="rect" id="node2" href="classGtk_1_1ToolButton.html" title="A Gtk::ToolItem subclass that displays buttons." alt="" coords="73,646,185,677"/><area shape="rect" id="node4" href="classGtk_1_1ToolItem.html" title="Gtk::ToolItem" alt="" coords="79,566,180,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&#45;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::ToggleToolButton:</div>
 
67
<div class="dyncontent">
 
68
<div class="center"><img src="classGtk_1_1ToggleToolButton__coll__graph.png" border="0" usemap="#Gtk_1_1ToggleToolButton_coll__map" alt="Collaboration graph"/></div>
 
69
<map name="Gtk_1_1ToggleToolButton_coll__map" id="Gtk_1_1ToggleToolButton_coll__map">
 
70
<area shape="rect" id="node2" href="classGtk_1_1ToolButton.html" title="A Gtk::ToolItem subclass that displays buttons." alt="" coords="73,646,185,677"/><area shape="rect" id="node4" href="classGtk_1_1ToolItem.html" title="Gtk::ToolItem" alt="" coords="79,566,180,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&#45;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>
 
71
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
72
 
 
73
<p><a href="classGtk_1_1ToggleToolButton-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&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#afbf46342ea49274e3277cf536693ebb8">~ToggleToolButton</a> ()</td></tr>
 
78
<tr><td class="memItemLeft" align="right" valign="top">GtkToggleToolButton*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#a9826ae502d32b3f6ef07972172bc1296">gobj</a> ()</td></tr>
 
79
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a9826ae502d32b3f6ef07972172bc1296"></a><br/></td></tr>
 
80
<tr><td class="memItemLeft" align="right" valign="top">const GtkToggleToolButton*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#a54b7be9878cfa076d1060beffd018e51">gobj</a> () const </td></tr>
 
81
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a54b7be9878cfa076d1060beffd018e51"></a><br/></td></tr>
 
82
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#a0254c1286f800d5e7d7630005081e443">ToggleToolButton</a> ()</td></tr>
 
83
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a>. <a href="#a0254c1286f800d5e7d7630005081e443"></a><br/></td></tr>
 
84
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#a74c380a2de7ea6ed29299f233e30314b">ToggleToolButton</a> (const <a class="el" href="classGtk_1_1StockID.html">Gtk::StockID</a>&amp; stock_id)</td></tr>
 
85
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> from a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a>. <a href="#a74c380a2de7ea6ed29299f233e30314b"></a><br/></td></tr>
 
86
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#aeaedbe559ff1d257b5ed26027213da5f">ToggleToolButton</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&amp; label)</td></tr>
 
87
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> with a label. <a href="#aeaedbe559ff1d257b5ed26027213da5f"></a><br/></td></tr>
 
88
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#ae3d37f4d91093f86a24415a5a5da5570">ToggleToolButton</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>&amp; icon_widget, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&amp; label=<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>())</td></tr>
 
89
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> with an image. <a href="#ae3d37f4d91093f86a24415a5a5da5570"></a><br/></td></tr>
 
90
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#ab1704b77fd0bbde1d8e6cf3818c750a8">set_active</a> (bool is_active=true)</td></tr>
 
91
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the status of the toggle tool button. <a href="#ab1704b77fd0bbde1d8e6cf3818c750a8"></a><br/></td></tr>
 
92
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#a06ddc9daba3a310f4ee7c9224b7e6c9f">get_active</a> () const </td></tr>
 
93
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Queries a <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">Gtk::ToggleToolButton</a> and returns its current state. <a href="#a06ddc9daba3a310f4ee7c9224b7e6c9f"></a><br/></td></tr>
 
94
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#a656d6699e722f343a3d0599951190078">signal_toggled</a> ()</td></tr>
 
95
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#ae6c32f2f5195d816f29362e97dd10756">property_active</a> ()</td></tr>
 
96
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">If the toggle button should be pressed in or not. <a href="#ae6c32f2f5195d816f29362e97dd10756"></a><br/></td></tr>
 
97
<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"/>
 
98
&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#a211aec068776ede075d42617c8f3c4e8">property_active</a> () const </td></tr>
 
99
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">If the toggle button should be pressed in or not. <a href="#a211aec068776ede075d42617c8f3c4e8"></a><br/></td></tr>
 
100
<tr><td colspan="2"><h2><a name="pro-methods"></a>
 
101
Protected Member Functions</h2></td></tr>
 
102
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#ad4606040c0bbbb8a9353c2cff7a2f0ef">on_toggled</a> ()</td></tr>
 
103
<tr><td colspan="2"><h2><a name="related"></a>
 
104
Related Functions</h2></td></tr>
 
105
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
 
106
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1ToggleToolButton.html">Gtk::ToggleToolButton</a>*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ToggleToolButton.html#a8db6fb242327dc215d018582e0609966">wrap</a> (GtkToggleToolButton* object, bool take_copy=false)</td></tr>
 
107
<tr><td class="mdescLeft">&#160;</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="#a8db6fb242327dc215d018582e0609966"></a><br/></td></tr>
 
108
</table>
 
109
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
110
<div class="textblock"><p>A <a class="el" href="classGtk_1_1ToolItem.html">Gtk::ToolItem</a> containing a toggle button. </p>
 
111
<p>A <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> is a <a class="el" href="classGtk_1_1ToolItem.html">Gtk::ToolItem</a> that contains a toggle button.</p>
 
112
<p>A <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> widget looks like this: </p>
 
113
<div align="center">
 
114
<img src="toggletoolbutton1.png" alt="toggletoolbutton1.png"/>
 
115
</div>
 
116
 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
117
<a class="anchor" id="afbf46342ea49274e3277cf536693ebb8"></a><!-- doxytag: member="Gtk::ToggleToolButton::~ToggleToolButton" ref="afbf46342ea49274e3277cf536693ebb8" args="()" -->
 
118
<div class="memitem">
 
119
<div class="memproto">
 
120
      <table class="memname">
 
121
        <tr>
 
122
          <td class="memname">virtual Gtk::ToggleToolButton::~ToggleToolButton </td>
 
123
          <td>(</td>
 
124
          <td class="paramname"></td><td>)</td>
 
125
          <td><code> [virtual]</code></td>
 
126
        </tr>
 
127
      </table>
 
128
</div>
 
129
<div class="memdoc">
 
130
 
 
131
</div>
 
132
</div>
 
133
<a class="anchor" id="a0254c1286f800d5e7d7630005081e443"></a><!-- doxytag: member="Gtk::ToggleToolButton::ToggleToolButton" ref="a0254c1286f800d5e7d7630005081e443" args="()" -->
 
134
<div class="memitem">
 
135
<div class="memproto">
 
136
      <table class="memname">
 
137
        <tr>
 
138
          <td class="memname">Gtk::ToggleToolButton::ToggleToolButton </td>
 
139
          <td>(</td>
 
140
          <td class="paramname"></td><td>)</td>
 
141
          <td></td>
 
142
        </tr>
 
143
      </table>
 
144
</div>
 
145
<div class="memdoc">
 
146
 
 
147
<p>Creates a new <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a>. </p>
 
148
 
 
149
</div>
 
150
</div>
 
151
<a class="anchor" id="a74c380a2de7ea6ed29299f233e30314b"></a><!-- doxytag: member="Gtk::ToggleToolButton::ToggleToolButton" ref="a74c380a2de7ea6ed29299f233e30314b" args="(const Gtk::StockID &amp;stock_id)" -->
 
152
<div class="memitem">
 
153
<div class="memproto">
 
154
      <table class="memname">
 
155
        <tr>
 
156
          <td class="memname">Gtk::ToggleToolButton::ToggleToolButton </td>
 
157
          <td>(</td>
 
158
          <td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">Gtk::StockID</a>&amp;&#160;</td>
 
159
          <td class="paramname"><em>stock_id</em></td><td>)</td>
 
160
          <td><code> [explicit]</code></td>
 
161
        </tr>
 
162
      </table>
 
163
</div>
 
164
<div class="memdoc">
 
165
 
 
166
<p>Creates a new <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> from a <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a>. </p>
 
167
<p>The <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> will be created according to the <em>stock_id</em> properties.</p>
 
168
<dl><dt><b>Parameters:</b></dt><dd>
 
169
  <table class="params">
 
170
    <tr><td class="paramname">stock_id</td><td>The <a class="el" href="classGtk_1_1StockID.html" title="See also Gtk::BuiltinStockID.">StockID</a> which determines the look of the <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a>. </td></tr>
 
171
  </table>
 
172
  </dd>
 
173
</dl>
 
174
 
 
175
</div>
 
176
</div>
 
177
<a class="anchor" id="aeaedbe559ff1d257b5ed26027213da5f"></a><!-- doxytag: member="Gtk::ToggleToolButton::ToggleToolButton" ref="aeaedbe559ff1d257b5ed26027213da5f" args="(const Glib::ustring &amp;label)" -->
 
178
<div class="memitem">
 
179
<div class="memproto">
 
180
      <table class="memname">
 
181
        <tr>
 
182
          <td class="memname">Gtk::ToggleToolButton::ToggleToolButton </td>
 
183
          <td>(</td>
 
184
          <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&#160;</td>
 
185
          <td class="paramname"><em>label</em></td><td>)</td>
 
186
          <td><code> [explicit]</code></td>
 
187
        </tr>
 
188
      </table>
 
189
</div>
 
190
<div class="memdoc">
 
191
 
 
192
<p>Creates a new <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> with a label. </p>
 
193
<p>The <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> will have the label <em>label</em>.</p>
 
194
<dl><dt><b>Parameters:</b></dt><dd>
 
195
  <table class="params">
 
196
    <tr><td class="paramname">label</td><td>The string used to display the label for this <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a>. </td></tr>
 
197
  </table>
 
198
  </dd>
 
199
</dl>
 
200
 
 
201
</div>
 
202
</div>
 
203
<a class="anchor" id="ae3d37f4d91093f86a24415a5a5da5570"></a><!-- doxytag: member="Gtk::ToggleToolButton::ToggleToolButton" ref="ae3d37f4d91093f86a24415a5a5da5570" args="(Widget &amp;icon_widget, const Glib::ustring &amp;label=Glib::ustring())" -->
 
204
<div class="memitem">
 
205
<div class="memproto">
 
206
      <table class="memname">
 
207
        <tr>
 
208
          <td class="memname">Gtk::ToggleToolButton::ToggleToolButton </td>
 
209
          <td>(</td>
 
210
          <td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>&amp;&#160;</td>
 
211
          <td class="paramname"><em>icon_widget</em>, </td>
 
212
        </tr>
 
213
        <tr>
 
214
          <td class="paramkey"></td>
 
215
          <td></td>
 
216
          <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&#160;</td>
 
217
          <td class="paramname"><em>label</em> = <code><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>()</code>&#160;</td>
 
218
        </tr>
 
219
        <tr>
 
220
          <td></td>
 
221
          <td>)</td>
 
222
          <td></td><td><code> [explicit]</code></td>
 
223
        </tr>
 
224
      </table>
 
225
</div>
 
226
<div class="memdoc">
 
227
 
 
228
<p>Creates a new <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> with an image. </p>
 
229
<p>The <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a> will have the label <em>label</em> and an image widget <em>icon_widget</em>.</p>
 
230
<dl><dt><b>Parameters:</b></dt><dd>
 
231
  <table class="params">
 
232
    <tr><td class="paramname">icon_widget</td><td>The widget placed as the ToggleToolButton's icon. </td></tr>
 
233
    <tr><td class="paramname">label</td><td>The string used to display the label for this <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">ToggleToolButton</a>. </td></tr>
 
234
  </table>
 
235
  </dd>
 
236
</dl>
 
237
 
 
238
</div>
 
239
</div>
 
240
<hr/><h2>Member Function Documentation</h2>
 
241
<a class="anchor" id="a06ddc9daba3a310f4ee7c9224b7e6c9f"></a><!-- doxytag: member="Gtk::ToggleToolButton::get_active" ref="a06ddc9daba3a310f4ee7c9224b7e6c9f" args="() const " -->
 
242
<div class="memitem">
 
243
<div class="memproto">
 
244
      <table class="memname">
 
245
        <tr>
 
246
          <td class="memname">bool Gtk::ToggleToolButton::get_active </td>
 
247
          <td>(</td>
 
248
          <td class="paramname"></td><td>)</td>
 
249
          <td> const</td>
 
250
        </tr>
 
251
      </table>
 
252
</div>
 
253
<div class="memdoc">
 
254
 
 
255
<p>Queries a <a class="el" href="classGtk_1_1ToggleToolButton.html" title="A Gtk::ToolItem containing a toggle button.">Gtk::ToggleToolButton</a> and returns its current state. </p>
 
256
<p>Returns <code>true</code> if the toggle button is pressed in and <code>false</code> if it is raised.</p>
 
257
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000250">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
 
258
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the toggle tool button is pressed in, <code>false</code> if not. </dd></dl>
 
259
 
 
260
</div>
 
261
</div>
 
262
<a class="anchor" id="a9826ae502d32b3f6ef07972172bc1296"></a><!-- doxytag: member="Gtk::ToggleToolButton::gobj" ref="a9826ae502d32b3f6ef07972172bc1296" args="()" -->
 
263
<div class="memitem">
 
264
<div class="memproto">
 
265
      <table class="memname">
 
266
        <tr>
 
267
          <td class="memname">GtkToggleToolButton* Gtk::ToggleToolButton::gobj </td>
 
268
          <td>(</td>
 
269
          <td class="paramname"></td><td>)</td>
 
270
          <td><code> [inline]</code></td>
 
271
        </tr>
 
272
      </table>
 
273
</div>
 
274
<div class="memdoc">
 
275
 
 
276
<p>Provides access to the underlying C GtkObject. </p>
 
277
 
 
278
<p>Reimplemented from <a class="el" href="classGtk_1_1ToolButton.html#a451fe61a9536f6eb5e55e70ba79eaeea">Gtk::ToolButton</a>.</p>
 
279
 
 
280
<p>Reimplemented in <a class="el" href="classGtk_1_1RadioToolButton.html#a7508ede2d8cda64545c0c1511db8333d">Gtk::RadioToolButton</a>.</p>
 
281
 
 
282
</div>
 
283
</div>
 
284
<a class="anchor" id="a54b7be9878cfa076d1060beffd018e51"></a><!-- doxytag: member="Gtk::ToggleToolButton::gobj" ref="a54b7be9878cfa076d1060beffd018e51" args="() const " -->
 
285
<div class="memitem">
 
286
<div class="memproto">
 
287
      <table class="memname">
 
288
        <tr>
 
289
          <td class="memname">const GtkToggleToolButton* Gtk::ToggleToolButton::gobj </td>
 
290
          <td>(</td>
 
291
          <td class="paramname"></td><td>)</td>
 
292
          <td> const<code> [inline]</code></td>
 
293
        </tr>
 
294
      </table>
 
295
</div>
 
296
<div class="memdoc">
 
297
 
 
298
<p>Provides access to the underlying C GtkObject. </p>
 
299
 
 
300
<p>Reimplemented from <a class="el" href="classGtk_1_1ToolButton.html#a4a54eeeeeff0a72d2d3b1cc6db6e7350">Gtk::ToolButton</a>.</p>
 
301
 
 
302
<p>Reimplemented in <a class="el" href="classGtk_1_1RadioToolButton.html#aa0b9bd1858a09e71d8405fc188b0e4dc">Gtk::RadioToolButton</a>.</p>
 
303
 
 
304
</div>
 
305
</div>
 
306
<a class="anchor" id="ad4606040c0bbbb8a9353c2cff7a2f0ef"></a><!-- doxytag: member="Gtk::ToggleToolButton::on_toggled" ref="ad4606040c0bbbb8a9353c2cff7a2f0ef" args="()" -->
 
307
<div class="memitem">
 
308
<div class="memproto">
 
309
      <table class="memname">
 
310
        <tr>
 
311
          <td class="memname">virtual void Gtk::ToggleToolButton::on_toggled </td>
 
312
          <td>(</td>
 
313
          <td class="paramname"></td><td>)</td>
 
314
          <td><code> [protected, virtual]</code></td>
 
315
        </tr>
 
316
      </table>
 
317
</div>
 
318
<div class="memdoc">
 
319
 
 
320
</div>
 
321
</div>
 
322
<a class="anchor" id="ae6c32f2f5195d816f29362e97dd10756"></a><!-- doxytag: member="Gtk::ToggleToolButton::property_active" ref="ae6c32f2f5195d816f29362e97dd10756" args="()" -->
 
323
<div class="memitem">
 
324
<div class="memproto">
 
325
      <table class="memname">
 
326
        <tr>
 
327
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>&lt;bool&gt; Gtk::ToggleToolButton::property_active </td>
 
328
          <td>(</td>
 
329
          <td class="paramname"></td><td>)</td>
 
330
          <td></td>
 
331
        </tr>
 
332
      </table>
 
333
</div>
 
334
<div class="memdoc">
 
335
 
 
336
<p>If the toggle button should be pressed in or not. </p>
 
337
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
 
338
<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>
 
339
 
 
340
</div>
 
341
</div>
 
342
<a class="anchor" id="a211aec068776ede075d42617c8f3c4e8"></a><!-- doxytag: member="Gtk::ToggleToolButton::property_active" ref="a211aec068776ede075d42617c8f3c4e8" args="() const " -->
 
343
<div class="memitem">
 
344
<div class="memproto">
 
345
      <table class="memname">
 
346
        <tr>
 
347
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>&lt;bool&gt; Gtk::ToggleToolButton::property_active </td>
 
348
          <td>(</td>
 
349
          <td class="paramname"></td><td>)</td>
 
350
          <td> const</td>
 
351
        </tr>
 
352
      </table>
 
353
</div>
 
354
<div class="memdoc">
 
355
 
 
356
<p>If the toggle button should be pressed in or not. </p>
 
357
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
 
358
<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>
 
359
 
 
360
</div>
 
361
</div>
 
362
<a class="anchor" id="ab1704b77fd0bbde1d8e6cf3818c750a8"></a><!-- doxytag: member="Gtk::ToggleToolButton::set_active" ref="ab1704b77fd0bbde1d8e6cf3818c750a8" args="(bool is_active=true)" -->
 
363
<div class="memitem">
 
364
<div class="memproto">
 
365
      <table class="memname">
 
366
        <tr>
 
367
          <td class="memname">void Gtk::ToggleToolButton::set_active </td>
 
368
          <td>(</td>
 
369
          <td class="paramtype">bool&#160;</td>
 
370
          <td class="paramname"><em>is_active</em> = <code>true</code></td><td>)</td>
 
371
          <td></td>
 
372
        </tr>
 
373
      </table>
 
374
</div>
 
375
<div class="memdoc">
 
376
 
 
377
<p>Sets the status of the toggle tool button. </p>
 
378
<p>Set to <code>true</code> if you want the GtkToggleButton to be 'pressed in', and <code>false</code> to raise it. This action causes the toggled signal to be emitted.</p>
 
379
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000249">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
 
380
<dl><dt><b>Parameters:</b></dt><dd>
 
381
  <table class="params">
 
382
    <tr><td class="paramname">is_active</td><td>Whether <em>button</em> should be active. </td></tr>
 
383
  </table>
 
384
  </dd>
 
385
</dl>
 
386
 
 
387
</div>
 
388
</div>
 
389
<a class="anchor" id="a656d6699e722f343a3d0599951190078"></a><!-- doxytag: member="Gtk::ToggleToolButton::signal_toggled" ref="a656d6699e722f343a3d0599951190078" args="()" -->
 
390
<div class="memitem">
 
391
<div class="memproto">
 
392
      <table class="memname">
 
393
        <tr>
 
394
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>&lt; void &gt; Gtk::ToggleToolButton::signal_toggled </td>
 
395
          <td>(</td>
 
396
          <td class="paramname"></td><td>)</td>
 
397
          <td></td>
 
398
        </tr>
 
399
      </table>
 
400
</div>
 
401
<div class="memdoc">
 
402
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_toggled()</code> </dd></dl>
 
403
 
 
404
</div>
 
405
</div>
 
406
<hr/><h2>Friends And Related Function Documentation</h2>
 
407
<a class="anchor" id="a8db6fb242327dc215d018582e0609966"></a><!-- doxytag: member="Gtk::ToggleToolButton::wrap" ref="a8db6fb242327dc215d018582e0609966" args="(GtkToggleToolButton *object, bool take_copy=false)" -->
 
408
<div class="memitem">
 
409
<div class="memproto">
 
410
      <table class="memname">
 
411
        <tr>
 
412
          <td class="memname"><a class="el" href="classGtk_1_1ToggleToolButton.html">Gtk::ToggleToolButton</a>* wrap </td>
 
413
          <td>(</td>
 
414
          <td class="paramtype">GtkToggleToolButton *&#160;</td>
 
415
          <td class="paramname"><em>object</em>, </td>
 
416
        </tr>
 
417
        <tr>
 
418
          <td class="paramkey"></td>
 
419
          <td></td>
 
420
          <td class="paramtype">bool&#160;</td>
 
421
          <td class="paramname"><em>take_copy</em> = <code>false</code>&#160;</td>
 
422
        </tr>
 
423
        <tr>
 
424
          <td></td>
 
425
          <td>)</td>
 
426
          <td></td><td><code> [related]</code></td>
 
427
        </tr>
 
428
      </table>
 
429
</div>
 
430
<div class="memdoc">
 
431
 
 
432
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
 
433
<dl><dt><b>Parameters:</b></dt><dd>
 
434
  <table class="params">
 
435
    <tr><td class="paramname">object</td><td>The C instance. </td></tr>
 
436
    <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>
 
437
  </table>
 
438
  </dd>
 
439
</dl>
 
440
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
 
441
 
 
442
</div>
 
443
</div>
 
444
<hr/>The documentation for this class was generated from the following file:<ul>
 
445
<li>gtkmm/toggletoolbutton.h</li>
 
446
</ul>
 
447
</div>
 
448
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:48 for gtkmm by&#160;
 
449
<a href="http://www.doxygen.org/index.html">
 
450
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
 
451
</body>
 
452
</html>