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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>wxWidgets: wxAcceleratorEntry Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr>
<td id="projectlogo">
<a href="http://www.wxwidgets.org/" target="_new">
<img alt="wxWidgets" src="logo.png"/>
</a>
</td>
<td style="padding-left: 0.5em; text-align: right;">
<span id="projectnumber">Version: 3.0.2</span>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Categories</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classwx_accelerator_entry-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wxAcceleratorEntry Class Reference<div class="ingroups"><a class="el" href="group__group__class__data.html">Data Structures</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <wx/accel.h></code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An object used by an application wishing to create an accelerator table (see <a class="el" href="classwx_accelerator_table.html" title="An accelerator table allows the application to specify a table of keyboard shortcuts for menu or butt...">wxAcceleratorTable</a>). </p>
<h2></h2>
<div><span class="lib">Library:</span>  <span class="lib_text"><a class="el" href="page_libs.html#page_libs_wxcore">wxCore</a></span></div><div><span class="category">Category:</span>  <span class="category_text"><a class="el" href="group__group__class__data.html">Data Structures</a></span></div><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_accelerator_table.html" title="An accelerator table allows the application to specify a table of keyboard shortcuts for menu or butt...">wxAcceleratorTable</a>, <a class="el" href="classwx_window.html#a0af5e9aa4dee6a4e92c0700f92605642" title="Sets the accelerator table for this window.">wxWindow::SetAcceleratorTable</a> </dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9387fbbaed1cbfb8673308ec2b10da3e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#a9387fbbaed1cbfb8673308ec2b10da3e">wxAcceleratorEntry</a> (int flags=0, int keyCode=0, int cmd=0, <a class="el" href="classwx_menu_item.html">wxMenuItem</a> *item=NULL)</td></tr>
<tr class="memdesc:a9387fbbaed1cbfb8673308ec2b10da3e"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a9387fbbaed1cbfb8673308ec2b10da3e"></a><br/></td></tr>
<tr class="separator:a9387fbbaed1cbfb8673308ec2b10da3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8853051e5706c505d15ff70e1e44c7df"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#a8853051e5706c505d15ff70e1e44c7df">wxAcceleratorEntry</a> (const <a class="el" href="classwx_accelerator_entry.html">wxAcceleratorEntry</a> &entry)</td></tr>
<tr class="memdesc:a8853051e5706c505d15ff70e1e44c7df"><td class="mdescLeft"> </td><td class="mdescRight">Copy ctor. <a href="#a8853051e5706c505d15ff70e1e44c7df"></a><br/></td></tr>
<tr class="separator:a8853051e5706c505d15ff70e1e44c7df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1d386394ee03b85d4826237071e3fb6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#ae1d386394ee03b85d4826237071e3fb6">GetCommand</a> () const </td></tr>
<tr class="memdesc:ae1d386394ee03b85d4826237071e3fb6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the command identifier for the accelerator table entry. <a href="#ae1d386394ee03b85d4826237071e3fb6"></a><br/></td></tr>
<tr class="separator:ae1d386394ee03b85d4826237071e3fb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb84cd94b583e18eeb02597f4907e4ba"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#abb84cd94b583e18eeb02597f4907e4ba">GetFlags</a> () const </td></tr>
<tr class="memdesc:abb84cd94b583e18eeb02597f4907e4ba"><td class="mdescLeft"> </td><td class="mdescRight">Returns the flags for the accelerator table entry. <a href="#abb84cd94b583e18eeb02597f4907e4ba"></a><br/></td></tr>
<tr class="separator:abb84cd94b583e18eeb02597f4907e4ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2da2c566731201caaabee443dc4bee1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#af2da2c566731201caaabee443dc4bee1">GetKeyCode</a> () const </td></tr>
<tr class="memdesc:af2da2c566731201caaabee443dc4bee1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the keycode for the accelerator table entry. <a href="#af2da2c566731201caaabee443dc4bee1"></a><br/></td></tr>
<tr class="separator:af2da2c566731201caaabee443dc4bee1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48d31d2dbf55bdd3cae39135b3ec83a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_menu_item.html">wxMenuItem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#a48d31d2dbf55bdd3cae39135b3ec83a3">GetMenuItem</a> () const </td></tr>
<tr class="memdesc:a48d31d2dbf55bdd3cae39135b3ec83a3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the menu item associated with this accelerator entry. <a href="#a48d31d2dbf55bdd3cae39135b3ec83a3"></a><br/></td></tr>
<tr class="separator:a48d31d2dbf55bdd3cae39135b3ec83a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abaac10bba35d3e3c32f05761e0d19d1a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#abaac10bba35d3e3c32f05761e0d19d1a">Set</a> (int flags, int keyCode, int cmd, <a class="el" href="classwx_menu_item.html">wxMenuItem</a> *item=NULL)</td></tr>
<tr class="memdesc:abaac10bba35d3e3c32f05761e0d19d1a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the accelerator entry parameters. <a href="#abaac10bba35d3e3c32f05761e0d19d1a"></a><br/></td></tr>
<tr class="separator:abaac10bba35d3e3c32f05761e0d19d1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8087cc425e16773f76911ea67a39631"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#aa8087cc425e16773f76911ea67a39631">IsOk</a> () const </td></tr>
<tr class="memdesc:aa8087cc425e16773f76911ea67a39631"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if this object is correctly initialized. <a href="#aa8087cc425e16773f76911ea67a39631"></a><br/></td></tr>
<tr class="separator:aa8087cc425e16773f76911ea67a39631"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d164fa98bba518e6b6f9cca65332d36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_string.html">wxString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#a0d164fa98bba518e6b6f9cca65332d36">ToString</a> () const </td></tr>
<tr class="memdesc:a0d164fa98bba518e6b6f9cca65332d36"><td class="mdescLeft"> </td><td class="mdescRight">Returns a textual representation of this accelerator. <a href="#a0d164fa98bba518e6b6f9cca65332d36"></a><br/></td></tr>
<tr class="separator:a0d164fa98bba518e6b6f9cca65332d36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1da1f2622d05fc436b552de71b14d96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_string.html">wxString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#ae1da1f2622d05fc436b552de71b14d96">ToRawString</a> () const </td></tr>
<tr class="memdesc:ae1da1f2622d05fc436b552de71b14d96"><td class="mdescLeft"> </td><td class="mdescRight">Returns a textual representation of this accelerator which is appropriate for saving in configuration files. <a href="#ae1da1f2622d05fc436b552de71b14d96"></a><br/></td></tr>
<tr class="separator:ae1da1f2622d05fc436b552de71b14d96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a201b717e9069367c60bd8765eda60371"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#a201b717e9069367c60bd8765eda60371">FromString</a> (const <a class="el" href="classwx_string.html">wxString</a> &str)</td></tr>
<tr class="memdesc:a201b717e9069367c60bd8765eda60371"><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string and sets the accelerator accordingly. <a href="#a201b717e9069367c60bd8765eda60371"></a><br/></td></tr>
<tr class="separator:a201b717e9069367c60bd8765eda60371"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e3f35ba5bb44a9f0b7c073e4294eb62"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_accelerator_entry.html">wxAcceleratorEntry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#a3e3f35ba5bb44a9f0b7c073e4294eb62">operator=</a> (const <a class="el" href="classwx_accelerator_entry.html">wxAcceleratorEntry</a> &entry)</td></tr>
<tr class="separator:a3e3f35ba5bb44a9f0b7c073e4294eb62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a129c9a53e8c540b0ce7b2ce22401e027"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#a129c9a53e8c540b0ce7b2ce22401e027">operator==</a> (const <a class="el" href="classwx_accelerator_entry.html">wxAcceleratorEntry</a> &entry) const </td></tr>
<tr class="separator:a129c9a53e8c540b0ce7b2ce22401e027"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f6079d45fd5916dacebdc91bf00d243"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_accelerator_entry.html#a2f6079d45fd5916dacebdc91bf00d243">operator!=</a> (const <a class="el" href="classwx_accelerator_entry.html">wxAcceleratorEntry</a> &entry) const </td></tr>
<tr class="separator:a2f6079d45fd5916dacebdc91bf00d243"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9387fbbaed1cbfb8673308ec2b10da3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxAcceleratorEntry::wxAcceleratorEntry </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>keyCode</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>cmd</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwx_menu_item.html">wxMenuItem</a> * </td>
<td class="paramname"><em>item</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>A combination of the <a class="el" href="accel_8h.html#ae3253ea019602f79fde0d3195f507a9f" title="wxAcceleratorEntry flags">wxAcceleratorEntryFlags</a> values, which indicates which modifier keys are held down. </td></tr>
<tr><td class="paramname">keyCode</td><td>The keycode to be detected. See <a class="el" href="defs_8h.html#a41c4609211685cff198618963ec8f77d" title="Virtual keycodes used by wxKeyEvent and some other wxWidgets functions.">wxKeyCode</a> for a full list of keycodes. </td></tr>
<tr><td class="paramname">cmd</td><td>The menu or control command identifier (ID). </td></tr>
<tr><td class="paramname">item</td><td>The menu item associated with this accelerator. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8853051e5706c505d15ff70e1e44c7df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxAcceleratorEntry::wxAcceleratorEntry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_accelerator_entry.html">wxAcceleratorEntry</a> & </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy ctor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a201b717e9069367c60bd8765eda60371"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxAcceleratorEntry::FromString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses the given string and sets the accelerator accordingly. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>This string may be either in the same format as returned by <a class="el" href="classwx_accelerator_entry.html#a0d164fa98bba518e6b6f9cca65332d36" title="Returns a textual representation of this accelerator.">ToString()</a>, i.e. contain the accelerator itself only, or have the format of a full menu item text with i.e. <code>Label TAB Accelerator</code>. In the latter case, the part of the string before the TAB is ignored. Notice that the latter format is only supported for the compatibility with the previous wxWidgets versions and the new code should pass only the accelerator string itself to this function.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><span class="literal">true</span> if the given string correctly initialized this object (i.e. if <a class="el" href="classwx_accelerator_entry.html#aa8087cc425e16773f76911ea67a39631" title="Returns true if this object is correctly initialized.">IsOk()</a> returns true after this call) </dd></dl>
</div>
</div>
<a class="anchor" id="ae1d386394ee03b85d4826237071e3fb6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wxAcceleratorEntry::GetCommand </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the command identifier for the accelerator table entry. </p>
</div>
</div>
<a class="anchor" id="abb84cd94b583e18eeb02597f4907e4ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wxAcceleratorEntry::GetFlags </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the flags for the accelerator table entry. </p>
</div>
</div>
<a class="anchor" id="af2da2c566731201caaabee443dc4bee1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wxAcceleratorEntry::GetKeyCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the keycode for the accelerator table entry. </p>
</div>
</div>
<a class="anchor" id="a48d31d2dbf55bdd3cae39135b3ec83a3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwx_menu_item.html">wxMenuItem</a>* wxAcceleratorEntry::GetMenuItem </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the menu item associated with this accelerator entry. </p>
</div>
</div>
<a class="anchor" id="aa8087cc425e16773f76911ea67a39631"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxAcceleratorEntry::IsOk </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <span class="literal">true</span> if this object is correctly initialized. </p>
</div>
</div>
<a class="anchor" id="a2f6079d45fd5916dacebdc91bf00d243"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxAcceleratorEntry::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_accelerator_entry.html">wxAcceleratorEntry</a> & </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3e3f35ba5bb44a9f0b7c073e4294eb62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwx_accelerator_entry.html">wxAcceleratorEntry</a>& wxAcceleratorEntry::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_accelerator_entry.html">wxAcceleratorEntry</a> & </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a129c9a53e8c540b0ce7b2ce22401e027"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxAcceleratorEntry::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_accelerator_entry.html">wxAcceleratorEntry</a> & </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="abaac10bba35d3e3c32f05761e0d19d1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxAcceleratorEntry::Set </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>keyCode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwx_menu_item.html">wxMenuItem</a> * </td>
<td class="paramname"><em>item</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the accelerator entry parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>A combination of the <a class="el" href="accel_8h.html#ae3253ea019602f79fde0d3195f507a9f" title="wxAcceleratorEntry flags">wxAcceleratorEntryFlags</a> values, which indicates which modifier keys are held down. </td></tr>
<tr><td class="paramname">keyCode</td><td>The keycode to be detected. See <a class="el" href="defs_8h.html#a41c4609211685cff198618963ec8f77d" title="Virtual keycodes used by wxKeyEvent and some other wxWidgets functions.">wxKeyCode</a> for a full list of keycodes. </td></tr>
<tr><td class="paramname">cmd</td><td>The menu or control command identifier (ID). </td></tr>
<tr><td class="paramname">item</td><td>The menu item associated with this accelerator. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae1da1f2622d05fc436b552de71b14d96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwx_string.html">wxString</a> wxAcceleratorEntry::ToRawString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a textual representation of this accelerator which is appropriate for saving in configuration files. </p>
<p>Unlike the string returned by <a class="el" href="classwx_accelerator_entry.html#a0d164fa98bba518e6b6f9cca65332d36" title="Returns a textual representation of this accelerator.">ToString()</a>, this one is never translated so, while it's not suitable for showing to the user, it can be used to uniquely identify the accelerator independently of the user language.</p>
<p>The returned string can still be parsed by <a class="el" href="classwx_accelerator_entry.html#a201b717e9069367c60bd8765eda60371" title="Parses the given string and sets the accelerator accordingly.">FromString()</a>.</p>
<dl class="section since"><dt>Since</dt><dd>2.9.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a0d164fa98bba518e6b6f9cca65332d36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwx_string.html">wxString</a> wxAcceleratorEntry::ToString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a textual representation of this accelerator. </p>
<p>The returned string is of the form <code>[Alt+][Ctrl+][RawCtrl+][Shift+]Key</code> where the modifier keys are present only if the corresponding flag is set. </p>
</div>
</div>
</div><!-- contents -->
<address class="footer">
<small>
Generated on Thu Nov 27 2014 13:46:43 for wxWidgets by <a href="http://www.doxygen.org/index.html" target="_new">Doxygen</a> 1.8.2
</small>
</address>
<script src="wxwidgets.js" type="text/javascript"></script>
</div><!-- #page_container -->
</body>
</html>
|
