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
|
<!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::AccelKey Class Reference</h1>An accelerator key value, modifier and flag class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="accelkey_8hh-source.html">gfc/gtk/accelkey.hh</a>></code>
<p>
<a href="classGFC_1_1Gtk_1_1AccelKey-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="z267_0" doxytag="GFC::Gtk::AccelKey::AccelKey" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z267_0">AccelKey</a> ()
<dl class="el"><dd class="mdescRight">Construct an empty <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a>. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z267_2">AccelKey</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &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="#z267_2"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z267_3">AccelKey</a> (unsigned int accel_key, <a class="el" href="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> accel_mods, <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> with the specified key, modifier and flag values. <a href="#z267_3"></a><br></dl><li><a class="anchor" name="z267_4" doxytag="GFC::Gtk::AccelKey::AccelKey" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z267_4">AccelKey</a> (const <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> &src)
<dl class="el"><dd class="mdescRight">Copy constructor. <br></dl><li><a class="anchor" name="z267_5" doxytag="GFC::Gtk::AccelKey::operator=" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> & <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z267_5">operator=</a> (const <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> &src)
<dl class="el"><dd class="mdescRight">Assignment operator. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z268_0" doxytag="GFC::Gtk::AccelKey::gtk_accel_key" ></a>
GtkAccelKey * <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z268_0">gtk_accel_key</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkAccelKey structure. <br></dl><li><a class="anchor" name="z268_1" doxytag="GFC::Gtk::AccelKey::operator GtkAccelKey *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z268_1">operator GtkAccelKey *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> to a GtkAccelKey pointer. <br></dl><li><a class="anchor" name="z268_2" doxytag="GFC::Gtk::AccelKey::key" ></a>
unsigned int <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z268_2">key</a> () const
<dl class="el"><dd class="mdescRight">Get the key value of the accelerator. <br></dl><li><a class="anchor" name="z268_3" doxytag="GFC::Gtk::AccelKey::mods" ></a>
<a class="el" href="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z268_3">mods</a> () const
<dl class="el"><dd class="mdescRight">Get the modifier flags. <br></dl><li><a class="anchor" name="z268_4" doxytag="GFC::Gtk::AccelKey::flags" ></a>
<a class="el" href="namespaceGFC_1_1Gtk.html#a53">AccelFlagsField</a> <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z268_4">flags</a> () const
<dl class="el"><dd class="mdescRight">Get the accelerator flags. <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_1AccelKey.html#z269_1">set</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &accelerator, <a class="el" href="namespaceGFC_1_1Gtk.html#a53">AccelFlagsField</a> accel_flags=Gtk::ACCEL_VISIBLE)
<dl class="el"><dd class="mdescRight">Set the accelerator values from a string representation of an accelerator. <a href="#z269_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html#z269_2">set</a> (unsigned int accel_key, <a class="el" href="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> accel_mods, <a class="el" href="namespaceGFC_1_1Gtk.html#a53">AccelFlagsField</a> accel_flags=Gtk::ACCEL_VISIBLE)
<dl class="el"><dd class="mdescRight">Set the accelerator key, modifier and flag values. <a href="#z269_2"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An accelerator key value, modifier and flag class.
<p>
<a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> encapsulates an accelerator key, its accelerator flags (for configuring the accelerator) and its modifier flags (the modifier combination of the accelerator).
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z267_2" doxytag="GFC::Gtk::AccelKey::AccelKey" ></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::AccelKey::AccelKey </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>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>
<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="z267_3" doxytag="GFC::Gtk::AccelKey::AccelKey" ></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::AccelKey::AccelKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname" nowrap> <em>accel_key</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> </td>
<td class="mdname" nowrap> <em>accel_mods</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> with the specified key, modifier and flag values.
<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>Key value of the accelerator. </td></tr>
<tr><td></td><td valign=top><em>accel_mods</em> </td><td>Modifier combination of the 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>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z269_2" doxytag="GFC::Gtk::AccelKey::set" ></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::AccelKey::set </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname" nowrap> <em>accel_key</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gdk.html#a136">Gdk::ModifierTypeField</a> </td>
<td class="mdname" nowrap> <em>accel_mods</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>
Set the accelerator key, modifier and flag values.
<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>Key value of the accelerator. </td></tr>
<tr><td></td><td valign=top><em>accel_mods</em> </td><td>Modifier combination of the 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>
</td>
</tr>
</table>
<a class="anchor" name="z269_1" doxytag="GFC::Gtk::AccelKey::set" ></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::AccelKey::set </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>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>
Set the accelerator values from a string representation of 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>
<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>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="accelkey_8hh-source.html">accelkey.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>
|
