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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
<!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::AccelLabel Class Reference</h1>A GtkAccelLabel C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="accellabel_8hh-source.html">gfc/gtk/accellabel.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::AccelLabel:
<p><center><img src="classGFC_1_1Gtk_1_1AccelLabel.png" usemap="#GFC::Gtk::AccelLabel_map" border="0" alt=""></center>
<map name="GFC::Gtk::AccelLabel_map">
<area href="classGFC_1_1Gtk_1_1Label.html" alt="GFC::Gtk::Label" shape="rect" coords="73,336,210,360">
<area href="classGFC_1_1Gtk_1_1Misc.html" alt="GFC::Gtk::Misc" shape="rect" coords="73,280,210,304">
<area href="classGFC_1_1Gtk_1_1Widget.html" alt="GFC::Gtk::Widget" shape="rect" coords="73,224,210,248">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,137,192">
<area href="classGFC_1_1Atk_1_1Implementor.html" alt="GFC::Atk::Implementor" shape="rect" coords="147,168,284,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,137,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="147,112,284,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,137,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="147,56,284,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,137,24">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="147,0,284,24">
</map>
<a href="classGFC_1_1Gtk_1_1AccelLabel-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z271_0" doxytag="GFC::Gtk::AccelLabel::AccelLabel" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z271_0">AccelLabel</a> ()
<dl class="el"><dd class="mdescRight">Construct an empty accelerator label. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z271_2">AccelLabel</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &str, bool use_underline=false)
<dl class="el"><dd class="mdescRight">Construct an accelerator label. <a href="#z271_2"></a><br></dl><li><a class="anchor" name="z271_3" doxytag="GFC::Gtk::AccelLabel::~AccelLabel" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z271_3">~AccelLabel</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="z272_0" doxytag="GFC::Gtk::AccelLabel::gtk_accel_label" ></a>
GtkAccelLabel * <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z272_0">gtk_accel_label</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkAccelLabel structure. <br></dl><li><a class="anchor" name="z272_1" doxytag="GFC::Gtk::AccelLabel::operator GtkAccelLabel *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z272_1">operator GtkAccelLabel *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html">AccelLabel</a> to a GtkAccelLabel pointer. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> * <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z272_2">get_accel_widget</a> () const
<dl class="el"><dd class="mdescRight">Fetches the widget monitored by this accelerator label (See <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z273_0">set_accel_widget()</a>). <a href="#z272_2"></a><br></dl><li>unsigned int <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z272_3">get_accel_width</a> () const
<dl class="el"><dd class="mdescRight">Returns the width needed to display the accelerator key(s). <a href="#z272_3"></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_1AccelLabel.html#z273_0">set_accel_widget</a> (<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &accel_widget)
<dl class="el"><dd class="mdescRight">Sets the widget to be monitored by this accelerator label. <a href="#z273_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z273_1">set_accel_closure</a> (GClosure *accel_closure)
<dl class="el"><dd class="mdescRight">Sets the closure to be monitored by this accelerator label. <a href="#z273_1"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z273_2">refetch</a> ()
<dl class="el"><dd class="mdescRight">Recreates the string representing the accelerator keys. <a href="#z273_2"></a><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_1AccelLabel.html#z270_0">AccelLabel</a> (GtkAccelLabel *accel_label, 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_1AccelLabel.html">AccelLabel</a> from an existing GtkAccelLabel. <a href="#z270_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkAccelLabel C++ wrapper class.
<p>
The <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html">AccelLabel</a> widget is a subclass of <a class="el" href="classGFC_1_1Gtk_1_1Label.html">Label</a> that also displays an accelerator key on the right of the label text, e.g. 'Ctl+S'. It is commonly used in menus to show the keyboard short-cuts for commands. The accelerator key to display is not set explicitly. Instead, the <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html">AccelLabel</a> displays the accelerators which have been added to a particular widget. This widget is set by calling <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z273_0">set_accel_widget()</a>.<p>
For example, a <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> widget may have an accelerator added to emit the "activate" signal when the 'Ctl+S' key combination is pressed. An <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html">AccelLabel</a> is created and added to the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a>, and <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z273_0">set_accel_widget()</a> is called with the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> as its argument. The <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html">AccelLabel</a> will now display 'Ctl+S' after its label.<p>
Note that creating a <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> with a label (or <a class="el" href="classGFC_1_1Gtk_1_1CheckMenuItem.html">CheckMenuItem</a> and <a class="el" href="classGFC_1_1Gtk_1_1RadioMenuItem.html">RadioMenuItem</a>) automatically adds an <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html">AccelLabel</a> to the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> and calls <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z273_0">set_accel_widget()</a> to set it up for you. An <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html">AccelLabel</a> will only display accelerators which have <a class="el" href="namespaceGFC_1_1Gtk.html#a318a55">Gtk::ACCEL_VISIBLE</a> set. An <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html">AccelLabel</a> can display multiple accelerators and even signal names, though it is almost always used to display just one accelerator key.<p>
<b>Example:</b> Creating a simple menu item with an accelerator key. <div class="fragment"><pre> <span class="comment">// Create a AccelGroup and add it to the window.</span>
Pointer<Gtk::AccelGroup> accel_group;
window->add_accel_group(accel_group):
<span class="comment">// Create the menu item.</span>
Gtk::MenuItem *save_item = new Gtk::MenuItem(<span class="stringliteral">"Save"</span>);
menu->add(*save_item);
save_item->show();
<span class="comment">// Now add the accelerator to the MenuItem.</span>
save_item->add_accelerator(<span class="stringliteral">"activate"</span>, *accel_group, AccelKey(GDK_s, Gdk::CONTROL_MASK));
</pre></div>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z270_0" doxytag="GFC::Gtk::AccelLabel::AccelLabel" ></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::AccelLabel::AccelLabel </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkAccelLabel * </td>
<td class="mdname" nowrap> <em>accel_label</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_1AccelLabel.html">AccelLabel</a> from an existing GtkAccelLabel.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_label</em> </td><td>A pointer to a GtkAccelLabel. </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>accel_label</em> can be a newly created GtkAccelLabel or an existing GtkAccelLabel. (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="z271_2" doxytag="GFC::Gtk::AccelLabel::AccelLabel" ></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::AccelLabel::AccelLabel </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>str</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>use_underline</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct an accelerator label.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>str</em> </td><td>The label string. </td></tr>
<tr><td></td><td valign=top><em>use_underline</em> </td><td>Set <em>true</em> if label contains a mnemonic character. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z272_2" doxytag="GFC::Gtk::AccelLabel::get_accel_widget" ></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"> <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a>* GFC::Gtk::AccelLabel::get_accel_widget </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>
Fetches the widget monitored by this accelerator label (See <a class="el" href="classGFC_1_1Gtk_1_1AccelLabel.html#z273_0">set_accel_widget()</a>).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The widget monitored by this accelerator label. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z272_3" doxytag="GFC::Gtk::AccelLabel::get_accel_width" ></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"> unsigned int GFC::Gtk::AccelLabel::get_accel_width </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>
Returns the width needed to display the accelerator key(s).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The width needed to display the accelerator key(s).</dd></dl>
<br>
This is used by menus to align all of the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> widgets, and shouldn't be needed by applications. </td>
</tr>
</table>
<a class="anchor" name="z273_2" doxytag="GFC::Gtk::AccelLabel::refetch" ></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::AccelLabel::refetch </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </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>
Recreates the string representing the accelerator keys.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Always returns <em>false</em>.</dd></dl>
<br>
This should not be needed since the string is automatically updated whenever accelerators are added or removed from the associated widget. </td>
</tr>
</table>
<a class="anchor" name="z273_1" doxytag="GFC::Gtk::AccelLabel::set_accel_closure" ></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::AccelLabel::set_accel_closure </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GClosure * </td>
<td class="mdname1" valign="top" nowrap> <em>accel_closure</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 closure to be monitored by this accelerator label.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_closure</em> </td><td>The closure to monitor for accelerator changes.</td></tr>
</table>
</dl>
<br>
The closure must be connected to an accelerator group; see <a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html#z263_2">Gtk::AccelGroup::connect()</a>. </td>
</tr>
</table>
<a class="anchor" name="z273_0" doxytag="GFC::Gtk::AccelLabel::set_accel_widget" ></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::AccelLabel::set_accel_widget </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>accel_widget</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 widget to be monitored by this accelerator label.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_widget</em> </td><td>The widget to be monitored. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="accellabel_8hh-source.html">accellabel.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:37 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>
|
