← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/qwt/oneiric-proposed

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/man/man3/QwtEventPattern.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-07-01 16:08:21 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20090701160821-gog44m4w7x2f4u6o
Tags: 5.2.0-1
* New upstream release.
* Add branch pull patch from svn r544.
* Bump Standards-Version to 3.8.2. No changes needed.
* Update installed manpages.
* Use qwt as base name for directory (drop version).
* Add missing warnings patch.
* Rewrite debian/rules: use dh.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.2/doc/man/man3/QwtEventPattern.3
1
 
.TH "QwtEventPattern" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtEventPattern \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
Inherited by \fBQwtPicker\fP.
10
 
.PP
11
 
.SH "Detailed Description"
12
 
.PP 
13
 
A collection of event patterns. 
14
 
 
15
 
\fBQwtEventPattern\fP introduces an level of indirection for mouse and keyboard inputs. Those are represented by symbolic names, so the application code can be configured by individual mappings.
16
 
.PP
17
 
\fBSee also:\fP
18
 
.RS 4
19
 
\fBQwtPicker\fP, \fBQwtPickerMachine\fP, \fBQwtPlotZoomer\fP 
20
 
.RE
21
 
.PP
22
 
 
23
 
.PP
24
 
Definition at line 28 of file qwt_event_pattern.h.
25
 
.SS "Public Types"
26
 
 
27
 
.in +1c
28
 
.ti -1c
29
 
.RI "enum \fBMousePatternCode\fP { \fBMouseSelect1\fP, \fBMouseSelect2\fP, \fBMouseSelect3\fP, \fBMouseSelect4\fP, \fBMouseSelect5\fP, \fBMouseSelect6\fP, \fBMousePatternCount\fP }"
30
 
.br
31
 
.ti -1c
32
 
.RI "enum \fBKeyPatternCode\fP { \fBKeySelect1\fP, \fBKeySelect2\fP, \fBKeyAbort\fP, \fBKeyLeft\fP, \fBKeyRight\fP, \fBKeyUp\fP, \fBKeyDown\fP, \fBKeyRedo\fP, \fBKeyUndo\fP, \fBKeyHome\fP, \fBKeyPatternCount\fP }"
33
 
.br
34
 
.in -1c
35
 
.SS "Public Member Functions"
36
 
 
37
 
.in +1c
38
 
.ti -1c
39
 
.RI "\fBQwtEventPattern\fP ()"
40
 
.br
41
 
.ti -1c
42
 
.RI "virtual \fB~QwtEventPattern\fP ()"
43
 
.br
44
 
.ti -1c
45
 
.RI "void \fBinitMousePattern\fP (int numButtons)"
46
 
.br
47
 
.ti -1c
48
 
.RI "void \fBinitKeyPattern\fP ()"
49
 
.br
50
 
.ti -1c
51
 
.RI "void \fBsetMousePattern\fP (uint pattern, int button, int state=Qt::NoButton)"
52
 
.br
53
 
.ti -1c
54
 
.RI "void \fBsetKeyPattern\fP (uint pattern, int key, int state=Qt::NoButton)"
55
 
.br
56
 
.ti -1c
57
 
.RI "void \fBsetMousePattern\fP (const QwtArray< \fBMousePattern\fP > &)"
58
 
.br
59
 
.ti -1c
60
 
.RI "void \fBsetKeyPattern\fP (const QwtArray< \fBKeyPattern\fP > &)"
61
 
.br
62
 
.ti -1c
63
 
.RI "const QwtArray< \fBMousePattern\fP > & \fBmousePattern\fP () const"
64
 
.br
65
 
.ti -1c
66
 
.RI "const QwtArray< \fBKeyPattern\fP > & \fBkeyPattern\fP () const"
67
 
.br
68
 
.ti -1c
69
 
.RI "QwtArray< \fBMousePattern\fP > & \fBmousePattern\fP ()"
70
 
.br
71
 
.ti -1c
72
 
.RI "QwtArray< \fBKeyPattern\fP > & \fBkeyPattern\fP ()"
73
 
.br
74
 
.ti -1c
75
 
.RI "bool \fBmouseMatch\fP (uint pattern, const QMouseEvent *) const"
76
 
.br
77
 
.ti -1c
78
 
.RI "bool \fBkeyMatch\fP (uint pattern, const QKeyEvent *) const"
79
 
.br
80
 
.in -1c
81
 
.SS "Protected Member Functions"
82
 
 
83
 
.in +1c
84
 
.ti -1c
85
 
.RI "virtual bool \fBmouseMatch\fP (const \fBMousePattern\fP &, const QMouseEvent *) const"
86
 
.br
87
 
.ti -1c
88
 
.RI "virtual bool \fBkeyMatch\fP (const \fBKeyPattern\fP &, const QKeyEvent *) const"
89
 
.br
90
 
.in -1c
91
 
.SS "Classes"
92
 
 
93
 
.in +1c
94
 
.ti -1c
95
 
.RI "class \fBKeyPattern\fP"
96
 
.br
97
 
.RI "\fIA pattern for key events. \fP"
98
 
.ti -1c
99
 
.RI "class \fBMousePattern\fP"
100
 
.br
101
 
.RI "\fIA pattern for mouse events. \fP"
102
 
.in -1c
103
 
.SH "Member Enumeration Documentation"
104
 
.PP 
105
 
.SS "enum \fBQwtEventPattern::MousePatternCode\fP"
106
 
.PP
107
 
Symbolic mouse input codes. 
108
 
.PP
109
 
The default initialization for 3 button mice is:
110
 
.IP "\(bu" 2
111
 
MouseSelect1
112
 
.br
113
 
 Qt::LeftButton
114
 
.IP "\(bu" 2
115
 
MouseSelect2
116
 
.br
117
 
 Qt::RightButton
118
 
.IP "\(bu" 2
119
 
MouseSelect3
120
 
.br
121
 
 Qt::MidButton
122
 
.IP "\(bu" 2
123
 
MouseSelect4
124
 
.br
125
 
 Qt::LeftButton + Qt::ShiftButton
126
 
.IP "\(bu" 2
127
 
MouseSelect5
128
 
.br
129
 
 Qt::RightButton + Qt::ShiftButton
130
 
.IP "\(bu" 2
131
 
MouseSelect6
132
 
.br
133
 
 Qt::MidButton + Qt::ShiftButton
134
 
.PP
135
 
.PP
136
 
The default initialization for 2 button mice is:
137
 
.IP "\(bu" 2
138
 
MouseSelect1
139
 
.br
140
 
 Qt::LeftButton
141
 
.IP "\(bu" 2
142
 
MouseSelect2
143
 
.br
144
 
 Qt::RightButton
145
 
.IP "\(bu" 2
146
 
MouseSelect3
147
 
.br
148
 
 Qt::LeftButton + Qt::AltButton
149
 
.IP "\(bu" 2
150
 
MouseSelect4
151
 
.br
152
 
 Qt::LeftButton + Qt::ShiftButton
153
 
.IP "\(bu" 2
154
 
MouseSelect5
155
 
.br
156
 
 Qt::RightButton + Qt::ShiftButton
157
 
.IP "\(bu" 2
158
 
MouseSelect6
159
 
.br
160
 
 Qt::LeftButton + Qt::AltButton + Qt::ShiftButton
161
 
.PP
162
 
.PP
163
 
The default initialization for 1 button mice is:
164
 
.IP "\(bu" 2
165
 
MouseSelect1
166
 
.br
167
 
 Qt::LeftButton
168
 
.IP "\(bu" 2
169
 
MouseSelect2
170
 
.br
171
 
 Qt::LeftButton + Qt::ControlButton
172
 
.IP "\(bu" 2
173
 
MouseSelect3
174
 
.br
175
 
 Qt::LeftButton + Qt::AltButton
176
 
.IP "\(bu" 2
177
 
MouseSelect4
178
 
.br
179
 
 Qt::LeftButton + Qt::ShiftButton
180
 
.IP "\(bu" 2
181
 
MouseSelect5
182
 
.br
183
 
 Qt::LeftButton + Qt::ControlButton + Qt::ShiftButton
184
 
.IP "\(bu" 2
185
 
MouseSelect6
186
 
.br
187
 
 Qt::LeftButton + Qt::AltButton + Qt::ShiftButton
188
 
.PP
189
 
.PP
190
 
\fBSee also:\fP
191
 
.RS 4
192
 
\fBinitMousePattern()\fP 
193
 
.RE
194
 
.PP
195
 
 
196
 
.PP
197
 
Definition at line 79 of file qwt_event_pattern.h.
198
 
.SS "enum \fBQwtEventPattern::KeyPatternCode\fP"
199
 
.PP
200
 
Symbolic keyboard input codes. 
201
 
.PP
202
 
Default initialization:
203
 
.IP "\(bu" 2
204
 
KeySelect1
205
 
.br
206
 
 Qt::Key_Return
207
 
.IP "\(bu" 2
208
 
KeySelect2
209
 
.br
210
 
 Qt::Key_Space
211
 
.IP "\(bu" 2
212
 
KeyAbort
213
 
.br
214
 
 Qt::Key_Escape
215
 
.PP
216
 
.PP
217
 
.IP "\(bu" 2
218
 
KeyLeft
219
 
.br
220
 
 Qt::Key_Left
221
 
.IP "\(bu" 2
222
 
KeyRight
223
 
.br
224
 
 Qt::Key_Right
225
 
.IP "\(bu" 2
226
 
KeyUp
227
 
.br
228
 
 Qt::Key_Up
229
 
.IP "\(bu" 2
230
 
KeyDown
231
 
.br
232
 
 Qt::Key_Down
233
 
.PP
234
 
.PP
235
 
.IP "\(bu" 2
236
 
KeyUndo
237
 
.br
238
 
 Qt::Key_Minus
239
 
.IP "\(bu" 2
240
 
KeyRedo
241
 
.br
242
 
 Qt::Key_Plus
243
 
.IP "\(bu" 2
244
 
KeyHome
245
 
.br
246
 
 Qt::Key_Escape 
247
 
.PP
248
 
 
249
 
.PP
250
 
Definition at line 118 of file qwt_event_pattern.h.
251
 
.SH "Constructor & Destructor Documentation"
252
 
.PP 
253
 
.SS "QwtEventPattern::QwtEventPattern ()"
254
 
.PP
255
 
Constructor
256
 
.PP
257
 
\fBSee also:\fP
258
 
.RS 4
259
 
\fBMousePatternCode\fP, \fBKeyPatternCode\fP 
260
 
.RE
261
 
.PP
262
 
 
263
 
.PP
264
 
Definition at line 19 of file qwt_event_pattern.cpp.
265
 
.PP
266
 
References initKeyPattern(), and initMousePattern().
267
 
.SS "QwtEventPattern::~QwtEventPattern ()\fC [virtual]\fP"
268
 
.PP
269
 
Destructor. 
270
 
.PP
271
 
Definition at line 28 of file qwt_event_pattern.cpp.
272
 
.SH "Member Function Documentation"
273
 
.PP 
274
 
.SS "void QwtEventPattern::initMousePattern (int numButtons)"
275
 
.PP
276
 
Set default mouse patterns, depending on the number of mouse buttons
277
 
.PP
278
 
\fBParameters:\fP
279
 
.RS 4
280
 
\fInumButtons\fP Number of mouse buttons ( <= 3 ) 
281
 
.RE
282
 
.PP
283
 
\fBSee also:\fP
284
 
.RS 4
285
 
\fBMousePatternCode\fP 
286
 
.RE
287
 
.PP
288
 
 
289
 
.PP
290
 
Definition at line 38 of file qwt_event_pattern.cpp.
291
 
.PP
292
 
References setMousePattern().
293
 
.PP
294
 
Referenced by QwtEventPattern().
295
 
.SS "void QwtEventPattern::initKeyPattern ()"
296
 
.PP
297
 
Set default mouse patterns.
298
 
.PP
299
 
\fBSee also:\fP
300
 
.RS 4
301
 
\fBKeyPatternCode\fP 
302
 
.RE
303
 
.PP
304
 
 
305
 
.PP
306
 
Definition at line 88 of file qwt_event_pattern.cpp.
307
 
.PP
308
 
References setKeyPattern().
309
 
.PP
310
 
Referenced by QwtEventPattern().
311
 
.SS "void QwtEventPattern::setMousePattern (uint pattern, int button, int state = \fCQt::NoButton\fP)"
312
 
.PP
313
 
Change one mouse pattern
314
 
.PP
315
 
\fBParameters:\fP
316
 
.RS 4
317
 
\fIpattern\fP Index of the pattern 
318
 
.br
319
 
\fIbutton\fP Button 
320
 
.br
321
 
\fIstate\fP State
322
 
.RE
323
 
.PP
324
 
\fBSee also:\fP
325
 
.RS 4
326
 
QMouseEvent 
327
 
.RE
328
 
.PP
329
 
 
330
 
.PP
331
 
Definition at line 115 of file qwt_event_pattern.cpp.
332
 
.PP
333
 
Referenced by initMousePattern().
334
 
.SS "void QwtEventPattern::setKeyPattern (uint pattern, int key, int state = \fCQt::NoButton\fP)"
335
 
.PP
336
 
Change one key pattern
337
 
.PP
338
 
\fBParameters:\fP
339
 
.RS 4
340
 
\fIpattern\fP Index of the pattern 
341
 
.br
342
 
\fIkey\fP Key 
343
 
.br
344
 
\fIstate\fP State
345
 
.RE
346
 
.PP
347
 
\fBSee also:\fP
348
 
.RS 4
349
 
QKeyEvent 
350
 
.RE
351
 
.PP
352
 
 
353
 
.PP
354
 
Definition at line 133 of file qwt_event_pattern.cpp.
355
 
.PP
356
 
Referenced by initKeyPattern().
357
 
.SS "void QwtEventPattern::setMousePattern (const QwtArray< \fBMousePattern\fP > &)"
358
 
.PP
359
 
Change the mouse event patterns. 
360
 
.PP
361
 
Definition at line 143 of file qwt_event_pattern.cpp.
362
 
.SS "void QwtEventPattern::setKeyPattern (const QwtArray< \fBKeyPattern\fP > &)"
363
 
.PP
364
 
Change the key event patterns. 
365
 
.PP
366
 
Definition at line 149 of file qwt_event_pattern.cpp.
367
 
.SS "const QwtArray< \fBQwtEventPattern::MousePattern\fP > & QwtEventPattern::mousePattern () const"
368
 
.PP
369
 
Return mouse patterns. 
370
 
.PP
371
 
Definition at line 156 of file qwt_event_pattern.cpp.
372
 
.SS "const QwtArray< \fBQwtEventPattern::KeyPattern\fP > & QwtEventPattern::keyPattern () const"
373
 
.PP
374
 
Return key patterns. 
375
 
.PP
376
 
Definition at line 163 of file qwt_event_pattern.cpp.
377
 
.SS "QwtArray< \fBQwtEventPattern::MousePattern\fP > & QwtEventPattern::mousePattern ()"
378
 
.PP
379
 
Return ,ouse patterns. 
380
 
.PP
381
 
Definition at line 169 of file qwt_event_pattern.cpp.
382
 
.SS "QwtArray< \fBQwtEventPattern::KeyPattern\fP > & QwtEventPattern::keyPattern ()"
383
 
.PP
384
 
Return Key patterns. 
385
 
.PP
386
 
Definition at line 175 of file qwt_event_pattern.cpp.
387
 
.SS "bool QwtEventPattern::mouseMatch (uint pattern, const QMouseEvent * e) const"
388
 
.PP
389
 
Compare a mouse event with an event pattern. 
390
 
.PP
391
 
A mouse event matches the pattern when both have the same button value and in the state value the same key flags(Qt::KeyButtonMask) are set.
392
 
.PP
393
 
\fBParameters:\fP
394
 
.RS 4
395
 
\fIpattern\fP Index of the event pattern 
396
 
.br
397
 
\fIe\fP Mouse event 
398
 
.RE
399
 
.PP
400
 
\fBReturns:\fP
401
 
.RS 4
402
 
true if matches
403
 
.RE
404
 
.PP
405
 
\fBSee also:\fP
406
 
.RS 4
407
 
\fBkeyMatch()\fP 
408
 
.RE
409
 
.PP
410
 
 
411
 
.PP
412
 
Definition at line 193 of file qwt_event_pattern.cpp.
413
 
.PP
414
 
Referenced by QwtPickerPolygonMachine::transition(), QwtPickerDragRectMachine::transition(), QwtPickerClickRectMachine::transition(), QwtPickerDragPointMachine::transition(), QwtPickerClickPointMachine::transition(), and QwtPlotZoomer::widgetMouseReleaseEvent().
415
 
.SS "bool QwtEventPattern::keyMatch (uint pattern, const QKeyEvent * e) const"
416
 
.PP
417
 
Compare a key event with an event pattern. 
418
 
.PP
419
 
A key event matches the pattern when both have the same key value and in the state value the same key flags (Qt::KeyButtonMask) are set.
420
 
.PP
421
 
\fBParameters:\fP
422
 
.RS 4
423
 
\fIpattern\fP Index of the event pattern 
424
 
.br
425
 
\fIe\fP Key event 
426
 
.RE
427
 
.PP
428
 
\fBReturns:\fP
429
 
.RS 4
430
 
true if matches
431
 
.RE
432
 
.PP
433
 
\fBSee also:\fP
434
 
.RS 4
435
 
\fBmouseMatch()\fP 
436
 
.RE
437
 
.PP
438
 
 
439
 
.PP
440
 
Definition at line 248 of file qwt_event_pattern.cpp.
441
 
.PP
442
 
Referenced by QwtPickerPolygonMachine::transition(), QwtPickerDragRectMachine::transition(), QwtPickerClickRectMachine::transition(), QwtPickerDragPointMachine::transition(), QwtPickerClickPointMachine::transition(), QwtPlotZoomer::widgetKeyPressEvent(), and QwtPicker::widgetKeyPressEvent().
443
 
.SS "bool QwtEventPattern::mouseMatch (const \fBMousePattern\fP & pattern, const QMouseEvent * e) const\fC [protected, virtual]\fP"
444
 
.PP
445
 
Compare a mouse event with an event pattern. 
446
 
.PP
447
 
A mouse event matches the pattern when both have the same button value and in the state value the same key flags(Qt::KeyButtonMask) are set.
448
 
.PP
449
 
\fBParameters:\fP
450
 
.RS 4
451
 
\fIpattern\fP Mouse event pattern 
452
 
.br
453
 
\fIe\fP Mouse event 
454
 
.RE
455
 
.PP
456
 
\fBReturns:\fP
457
 
.RS 4
458
 
true if matches
459
 
.RE
460
 
.PP
461
 
\fBSee also:\fP
462
 
.RS 4
463
 
\fBkeyMatch()\fP 
464
 
.RE
465
 
.PP
466
 
 
467
 
.PP
468
 
Definition at line 217 of file qwt_event_pattern.cpp.
469
 
.PP
470
 
References QwtEventPattern::MousePattern::button, and QwtEventPattern::MousePattern::state.
471
 
.SS "bool QwtEventPattern::keyMatch (const \fBKeyPattern\fP & pattern, const QKeyEvent * e) const\fC [protected, virtual]\fP"
472
 
.PP
473
 
Compare a key event with an event pattern. 
474
 
.PP
475
 
A key event matches the pattern when both have the same key value and in the state value the same key flags (Qt::KeyButtonMask) are set.
476
 
.PP
477
 
\fBParameters:\fP
478
 
.RS 4
479
 
\fIpattern\fP Key event pattern 
480
 
.br
481
 
\fIe\fP Key event 
482
 
.RE
483
 
.PP
484
 
\fBReturns:\fP
485
 
.RS 4
486
 
true if matches
487
 
.RE
488
 
.PP
489
 
\fBSee also:\fP
490
 
.RS 4
491
 
\fBmouseMatch()\fP 
492
 
.RE
493
 
.PP
494
 
 
495
 
.PP
496
 
Definition at line 272 of file qwt_event_pattern.cpp.
497
 
.PP
498
 
References QwtEventPattern::KeyPattern::key, and QwtEventPattern::KeyPattern::state.
499
 
 
500
 
.SH "Author"
501
 
.PP 
502
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.