]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/accel.tex
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / docs / latex / wx / accel.tex
... / ...
CommitLineData
1\section{\class{wxAcceleratorEntry}}\label{wxacceleratorentry}
2
3An object used by an application wishing to create an \helpref{accelerator table}{wxacceleratortable}.
4
5\wxheading{Derived from}
6
7None
8
9\wxheading{Include files}
10
11<wx/accel.h>
12
13\wxheading{See also}
14
15\helpref{wxAcceleratorTable}{wxacceleratortable}, \helpref{wxWindow::SetAcceleratorTable}{wxwindowsetacceleratortable}
16
17\latexignore{\rtfignore{\wxheading{Members}}}
18
19\membersection{wxAcceleratorEntry::wxAcceleratorEntry}\label{wxacceleratorentryconstr}
20
21\func{}{wxAcceleratorEntry}{\void}
22
23Default constructor.
24
25\func{}{wxAcceleratorEntry}{\param{int}{ flags}, \param{int}{ keyCode}, \param{int}{ cmd}}
26
27Constructor.
28
29\wxheading{Parameters}
30
31\docparam{flags}{One of wxACCEL\_ALT, wxACCEL\_SHIFT, wxACCEL\_CTRL and wxACCEL\_NORMAL. Indicates
32which modifier key is held down.}
33
34\docparam{keyCode}{The keycode to be detected. See \helpref{Keycodes}{keycodes} for a full list of keycodes.}
35
36\docparam{cmd}{The menu or control command identifier.}
37
38\membersection{wxAcceleratorEntry::GetCommand}\label{wxacceleratorentrygetcommand}
39
40\constfunc{int}{GetCommand}{\void}
41
42Returns the command identifier for the accelerator table entry.
43
44\membersection{wxAcceleratorEntry::GetFlags}\label{wxacceleratorentrygetflags}
45
46\constfunc{int}{GetFlags}{\void}
47
48Returns the flags for the accelerator table entry.
49
50\membersection{wxAcceleratorEntry::GetKeyCode}\label{wxacceleratorentrygetkeycode}
51
52\constfunc{int}{GetKeyCode}{\void}
53
54Returns the keycode for the accelerator table entry.
55
56\membersection{wxAcceleratorEntry::Set}\label{wxacceleratorentryset}
57
58\func{void}{Set}{\param{int}{ flags}, \param{int}{ keyCode}, \param{int}{ cmd}}
59
60Sets the accelerator entry parameters.
61
62\wxheading{Parameters}
63
64\docparam{flags}{One of wxACCEL\_ALT, wxACCEL\_SHIFT, wxACCEL\_CTRL and wxACCEL\_NORMAL. Indicates
65which modifier key is held down.}
66
67\docparam{keyCode}{The keycode to be detected. See \helpref{Keycodes}{keycodes} for a full list of keycodes.}
68
69\docparam{cmd}{The menu or control command identifier.}
70
71\section{\class{wxAcceleratorTable}}\label{wxacceleratortable}
72
73An accelerator table allows the application to specify a table of keyboard shortcuts for
74menus or other commands. On Windows, menu or button commands are supported; on GTK,
75only menu commands are supported.
76
77The object {\bf wxNullAcceleratorTable} is defined to be a table with no data, and is the
78initial accelerator table for a window.
79
80\wxheading{Derived from}
81
82\helpref{wxObject}{wxobject}
83
84\wxheading{Include files}
85
86<wx/accel.h>
87
88\wxheading{Example}
89
90{\small%
91\begin{verbatim}
92 wxAcceleratorEntry entries[4];
93 entries[0].Set(wxACCEL_CTRL, (int) 'N', ID_NEW_WINDOW);
94 entries[1].Set(wxACCEL_CTRL, (int) 'X', wxID_EXIT);
95 entries[2].Set(wxACCEL_SHIFT, (int) 'A', ID_ABOUT);
96 entries[3].Set(wxACCEL_NORMAL, WXK_DELETE, wxID_CUT);
97 wxAcceleratorTable accel(4, entries);
98 frame->SetAcceleratorTable(accel);
99\end{verbatim}
100}%
101
102\wxheading{Remarks}
103
104An accelerator takes precedence over normal processing and can be a convenient way to program some event handling.
105For example, you can use an accelerator table to enable a dialog with a multi-line text control to
106accept CTRL-Enter as meaning `OK' (but not in GTK+ at present).
107
108\wxheading{See also}
109
110\helpref{wxAcceleratorEntry}{wxacceleratorentry}, \helpref{wxWindow::SetAcceleratorTable}{wxwindowsetacceleratortable}
111
112\latexignore{\rtfignore{\wxheading{Members}}}
113
114\membersection{wxAcceleratorTable::wxAcceleratorTable}\label{wxacceleratortableconstr}
115
116\func{}{wxAcceleratorTable}{\void}
117
118Default constructor.
119
120\func{}{wxAcceleratorTable}{\param{const wxAcceleratorTable\& }{bitmap}}
121
122Copy constructor.
123
124\func{}{wxAcceleratorTable}{\param{int}{ n}, \param{wxAcceleratorEntry}{ entries[]}}
125
126Creates from an array of \helpref{wxAcceleratorEntry}{wxacceleratorentry} objects.
127
128\func{}{wxAcceleratorTable}{\param{const wxString\&}{ resource}}
129
130Loads the accelerator table from a Windows resource (Windows only).
131
132\wxheading{Parameters}
133
134\docparam{n}{Number of accelerator entries.}
135
136\docparam{entries}{The array of entries.}
137
138\docparam{resource}{Name of a Windows accelerator.}
139
140\pythonnote{The wxPython constructor accepts a list of
141wxAcceleratorEntry objects, or 3-tuples consisting of flags, keyCode,
142and cmd values like you would construct wxAcceleratorEntry objects with.}
143
144\perlnote{The wxPerl constructor accepts a list of either
145 Wx::AcceleratorEntry objects or references to 3-element arrays
146 ( flags, keyCode, cmd ), like the parameters of Wx::AcceleratorEntry::new.}
147
148\membersection{wxAcceleratorTable::\destruct{wxAcceleratorTable}}
149
150\func{}{\destruct{wxAcceleratorTable}}{\void}
151
152Destroys the wxAcceleratorTable object.
153
154\membersection{wxAcceleratorTable::Ok}\label{wxacceleratortableok}
155
156\constfunc{bool}{Ok}{\void}
157
158Returns true if the accelerator table is valid.
159
160\membersection{wxAcceleratorTable::operator $=$}
161
162\func{wxAcceleratorTable\& }{operator $=$}{\param{const wxAcceleratorTable\& }{accel}}
163
164Assignment operator. This operator does not copy any data, but instead
165passes a pointer to the data in {\it accel} and increments a reference
166counter. It is a fast operation.
167
168\wxheading{Parameters}
169
170\docparam{accel}{Accelerator table to assign.}
171
172\wxheading{Return value}
173
174Returns reference to this object.
175
176\membersection{wxAcceleratorTable::operator $==$}
177
178\func{bool}{operator $==$}{\param{const wxAcceleratorTable\& }{accel}}
179
180Equality operator. This operator tests whether the internal data pointers are
181equal (a fast test).
182
183\wxheading{Parameters}
184
185\docparam{accel}{Accelerator table to compare with}
186
187\wxheading{Return value}
188
189Returns true if the accelerator tables were effectively equal, false otherwise.
190
191\membersection{wxAcceleratorTable::operator $!=$}
192
193\func{bool}{operator $!=$}{\param{const wxAcceleratorTable\& }{accel}}
194
195Inequality operator. This operator tests whether the internal data pointers are
196unequal (a fast test).
197
198\wxheading{Parameters}
199
200\docparam{accel}{Accelerator table to compare with}
201
202\wxheading{Return value}
203
204Returns true if the accelerator tables were unequal, false otherwise.
205
206