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
|
<!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>accelgroup.hh File Reference</h1>GtkAccelGroup C++ wrapper interface. <a href="#_details">More...</a>
<p>
<code>#include <gfc/glib/object.hh></code><br>
<code>#include <<a class="el" href="accelkey_8hh-source.html">gfc/gtk/accelkey.hh</a>></code><br>
<code>#include <gfc/gtk/inline/accelgroup.inl></code><br>
<p>
<a href="accelgroup_8hh-source.html">Go to the source code of this file.</a><h2>Namespaces</h2>
<ul>
<li>namespace <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a>
<li>namespace <a class="el" href="namespaceGFC_1_1Gtk.html">GFC::Gtk</a>
</ul>
<h2>Classes</h2>
<ul>
<li>class <a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html">GFC::Gtk::AccelGroup</a>
<dl class="el"><dd class="mdescRight">GtkAccelGroup C++ wrapper class. <a href="classGFC_1_1Gtk_1_1AccelGroup.html#_details">More...</a><br></dl></ul>
<h2>Accelerator Methods</h2>
<ul>
<li>bool <a class="el" href="namespaceGFC_1_1Gtk.html#a292">accel_groups_activate</a> (G::Object &object, const AccelKey &accel_key)
<dl class="el"><dd class="mdescRight">Finds the first accelerator in any <a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html">AccelGroup</a> attached to <em>object</em> that matches the key value and modifiers, and activates that accelerator. <a href="#a292"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> <a class="el" href="namespaceGFC_1_1Gtk.html#a293">accelerator_get_default_mod_mask</a> ()
<dl class="el"><dd class="mdescRight">Gets the value set by set_default_mod_mask(). <a href="#a293"></a><br></dl><li>void <a class="el" href="namespaceGFC_1_1Gtk.html#a294">accelerator_set_default_mod_mask</a> (<a class="el" href="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> default_mod_mask)
<dl class="el"><dd class="mdescRight">Sets the modifiers that will be considered significant for keyboard accelerators. <a href="#a294"></a><br></dl><li>bool <a class="el" href="namespaceGFC_1_1Gtk.html#a295">accelerator_valid</a> (const AccelKey &accel_key)
<dl class="el"><dd class="mdescRight">Determines whether a given <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> is a valid keyboard accelerator. <a href="#a295"></a><br></dl><li>AccelKey <a class="el" href="namespaceGFC_1_1Gtk.html#a297">accelerator_parse</a> (const String &accelerator, <a class="el" href="namespaceGFC_1_1Gtk.html#a53">AccelFlagsField</a> accel_flags=Gtk::ACCEL_VISIBLE)
<dl class="el"><dd class="mdescRight">Construct an <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> from a string representing an accelerator. <a href="#a297"></a><br></dl><li>String <a class="el" href="namespaceGFC_1_1Gtk.html#a298">accelerator_name</a> (const AccelKey &accel_key)
<dl class="el"><dd class="mdescRight">Converts an AccelKey's key value and modifier mask into a string parseable by parse(). <a href="#a298"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
GtkAccelGroup C++ wrapper interface.
<p>
Provides Gtk::AccelGroup, an object which represents a group of keyboard accelerators.<hr><h2>Function Documentation</h2>
<a class="anchor" name="a292" doxytag="accelgroup.hh::accel_groups_activate" ></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 accel_groups_activate </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">G::Object & </td>
<td class="mdname" nowrap> <em>object</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const AccelKey & </td>
<td class="mdname" nowrap> <em>accel_key</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Finds the first accelerator in any <a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html">AccelGroup</a> attached to <em>object</em> that matches the key value and modifiers, and activates that accelerator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>object</em> </td><td>The <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html">G::Object</a>, usually a <a class="el" href="classGFC_1_1Gtk_1_1Window.html">Gtk::Window</a>, on which to activate the accelerator. </td></tr>
<tr><td></td><td valign=top><em>accel_key</em> </td><td>An <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> specifying the accelerator key value and modifiers. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if an accelerator was activated and handled this keypress. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a293" doxytag="accelgroup.hh::accelerator_get_default_mod_mask" ></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="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> accelerator_get_default_mod_mask </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>
Gets the value set by set_default_mod_mask().
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The default accelerator modifier mask. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a298" doxytag="accelgroup.hh::accelerator_name" ></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"> String accelerator_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const AccelKey & </td>
<td class="mdname1" valign="top" nowrap> <em>accel_key</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>
Converts an AccelKey's key value and modifier mask into a string parseable by parse().
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_key</em> </td><td>An <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> specifying the accelerator key value and modifiers. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The accelerator name.</dd></dl>
<br>
For example, if you pass in GDK_q and <a class="el" href="namespaceGFC_1_1Gdk.html#a286a183">Gdk::CONTROL_MASK</a>, this function returns "\<Control\>q". </td>
</tr>
</table>
<a class="anchor" name="a297" doxytag="accelgroup.hh::accelerator_parse" ></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"> AccelKey accelerator_parse </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname" nowrap> <em>accelerator</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gtk.html#a53">AccelFlagsField</a> </td>
<td class="mdname" nowrap> <em>accel_flags</em> = <code>Gtk::ACCEL_VISIBLE</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct an <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> from a string representing an accelerator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accelerator</em> </td><td>A string representing an accelerator. </td></tr>
<tr><td></td><td valign=top><em>accel_flags</em> </td><td>A flag mask to configure this accelerator. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>accel_key An <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> specifying the accelerator key value and modifiers.</dd></dl>
<br>
Parses a string representing an accelerator. The format looks like "\<Control\>a" or "\<Shift\>\<Alt\>F1" or "\<Release\>z" (the last one is for key release). The parser is fairly liberal and allows lower or upper case, and also abbreviations such as "\<Ctl\>" and "\<Ctrl\>". If the parse fails, accelerator and its modifiers will be set to 0 (zero). </td>
</tr>
</table>
<a class="anchor" name="a294" doxytag="accelgroup.hh::accelerator_set_default_mod_mask" ></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 accelerator_set_default_mod_mask </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> </td>
<td class="mdname1" valign="top" nowrap> <em>default_mod_mask</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 modifiers that will be considered significant for keyboard accelerators.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>default_mod_mask</em> </td><td>Accelerator modifier mask.</td></tr>
</table>
</dl>
<br>
The default mod mask is GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK, that is, Control, Shift, and Alt. Other modifiers will by default be ignored by <a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html">AccelGroup</a>. You must include at least the three default modifiers in any value you pass to this method.<p>
The default mod mask should be changed on application startup, before using any accelerator groups. </td>
</tr>
</table>
<a class="anchor" name="a295" doxytag="accelgroup.hh::accelerator_valid" ></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 accelerator_valid </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const AccelKey & </td>
<td class="mdname1" valign="top" nowrap> <em>accel_key</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>
Determines whether a given <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> is a valid keyboard accelerator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_key</em> </td><td>An <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> specifying the accelerator key value and modifiers. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the accelerator is valid.</dd></dl>
<br>
For example, the GDK_a keyval plus <a class="el" href="namespaceGFC_1_1Gdk.html#a286a183">Gdk::CONTROL_MASK</a> is valid this is a "Ctrl+a" accelerator. But, you can't, for instance, use the GDK_Control_L key value as an accelerator. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:33 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>
|
