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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::ToggleToolButton Class Reference</h1>A GtkToggleToolButton C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="toggletoolbutton_8hh-source.html">gfc/gtk/toggletoolbutton.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::ToggleToolButton:
<p><center><img src="classGFC_1_1Gtk_1_1ToggleToolButton.png" usemap="#GFC::Gtk::ToggleToolButton_map" border="0" alt=""></center>
<map name="GFC::Gtk::ToggleToolButton_map">
<area href="classGFC_1_1Gtk_1_1ToolButton.html" alt="GFC::Gtk::ToolButton" shape="rect" coords="87,448,252,472">
<area href="classGFC_1_1Gtk_1_1ToolItem.html" alt="GFC::Gtk::ToolItem" shape="rect" coords="87,392,252,416">
<area href="classGFC_1_1Gtk_1_1Bin.html" alt="GFC::Gtk::Bin" shape="rect" coords="87,336,252,360">
<area href="classGFC_1_1Gtk_1_1Container.html" alt="GFC::Gtk::Container" shape="rect" coords="87,280,252,304">
<area href="classGFC_1_1Gtk_1_1Widget.html" alt="GFC::Gtk::Widget" shape="rect" coords="87,224,252,248">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,165,192">
<area href="classGFC_1_1Atk_1_1Implementor.html" alt="GFC::Atk::Implementor" shape="rect" coords="175,168,340,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,165,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="175,112,340,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,165,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="175,56,340,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,165,24">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="175,0,340,24">
<area href="classGFC_1_1Gtk_1_1RadioToolButton.html" alt="GFC::Gtk::RadioToolButton" shape="rect" coords="87,560,252,584">
</map>
<a href="classGFC_1_1Gtk_1_1ToggleToolButton-members.html">List of all members.</a><h2>Signal Prototypes</h2>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ToggledSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z924_2">toggled_signal</a>
<dl class="el"><dd class="mdescRight">Toggled signal (see <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z928_0">sig_toggled()</a>). <a href="#z924_2"></a><br></dl></ul>
<h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z925_0" doxytag="GFC::Gtk::ToggleToolButton::ToggleToolButton" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z925_0">ToggleToolButton</a> ()
<dl class="el"><dd class="mdescRight">Constructs an empty toggle tool button. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z925_1">ToggleToolButton</a> (const <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> &stock_id)
<dl class="el"><dd class="mdescRight">Constructs a new toggle tool button containing the image and text from a stock item. <a href="#z925_1"></a><br></dl><li><a class="anchor" name="z925_2" doxytag="GFC::Gtk::ToggleToolButton::~ToggleToolButton" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z925_2">~ToggleToolButton</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z926_0" doxytag="GFC::Gtk::ToggleToolButton::gtk_toggle_tool_button" ></a>
GtkToggleToolButton * <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z926_0">gtk_toggle_tool_button</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkToggleToolButton structure. <br></dl><li><a class="anchor" name="z926_1" doxytag="GFC::Gtk::ToggleToolButton::operator GtkToggleToolButton *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z926_1">operator GtkToggleToolButton *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html">ToggleToolButton</a> to a GtkToggleToolButton pointer. <br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z926_2">get_active</a> () const
<dl class="el"><dd class="mdescRight">Queries a toggle tool button and returns its current state. <a href="#z926_2"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z927_0">set_active</a> (bool is_active)
<dl class="el"><dd class="mdescRight">Sets the status of the toggle tool button. <a href="#z927_0"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a class="anchor" name="z928_0" doxytag="GFC::Gtk::ToggleToolButton::sig_toggled" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">ToggledSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z928_0">sig_toggled</a> ()
<dl class="el"><dd class="mdescRight">Connect to the toggled_signal; emitted whenever the toggle tool button changes state. <br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z923_0">ToggleToolButton</a> (GtkToggleToolButton *button, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html">ToggleToolButton</a> from an existing GtkToggleToolButton. <a href="#z923_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkToggleToolButton C++ wrapper class.
<p>
A <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html">ToggleToolButton</a> is a <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> that contains a toggle button.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z923_0" doxytag="GFC::Gtk::ToggleToolButton::ToggleToolButton" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::ToggleToolButton::ToggleToolButton </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkToggleToolButton * </td>
<td class="mdname" nowrap> <em>button</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html">ToggleToolButton</a> from an existing GtkToggleToolButton.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>button</em> </td><td>A pointer to a GtkToggleToolButton. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>button</em> can be a newly created GtkToggleToolButton or an existing GtkToggleToolButton (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<a class="anchor" name="z925_1" doxytag="GFC::Gtk::ToggleToolButton::ToggleToolButton" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::ToggleToolButton::ToggleToolButton </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1StockId.html">StockId</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>stock_id</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs a new toggle tool button containing the image and text from a stock item.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>stock_id</em> </td><td>The ID of the stock item (see <a class="el" href="classGFC_1_1Gtk_1_1ToolButton.html#z943_3">set_stock_id()</a>).</td></tr>
</table>
</dl>
<br>
It is an error if <em>stock_id</em> is not a name of a stock item. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z926_2" doxytag="GFC::Gtk::ToggleToolButton::get_active" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::ToggleToolButton::get_active </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Queries a toggle tool button and returns its current state.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the toggle button is pressed in and <em>false</em> if it is raised. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z927_0" doxytag="GFC::Gtk::ToggleToolButton::set_active" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::ToggleToolButton::set_active </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>is_active</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the status of the toggle tool button.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>is_active</em> </td><td>Whether the button should be active or not.</td></tr>
</table>
</dl>
<br>
Set to <em>true</em> if you want the toggle tool button to be 'pressed in', and <em>false</em> to raise it. This action causes the toggled signal to be emitted. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z924_2" doxytag="GFC::Gtk::ToggleToolButton::toggled_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ToggledSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z924_2">GFC::Gtk::ToggleToolButton::toggled_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Toggled signal (see <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html#z928_0">sig_toggled()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function();
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="toggletoolbutton_8hh-source.html">toggletoolbutton.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:43 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
