← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2007-10-05 15:20:41 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071005152041-qmybqh4fj9jejyo2
Tags: 5.0.2-2
http://bugs.debian.org/437877
http://bugs.debian.org/443110
* Handle nostrip build option. (Closes: #437877)
* Build libqwt5-doc package in binary-indep target. (Closes: #443110)

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.0.1/doc/man/man3/QwtEventPattern.3
1
 
.TH "QwtEventPattern" 3 "26 Feb 2007" "Version 5.0.1" "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::KeyPatternCode\fP"
106
 
.PP
107
 
Symbolic keyboard input codes. 
108
 
.PP
109
 
Default initialization:
110
 
.IP "\(bu" 2
111
 
KeySelect1
112
 
.br
113
 
 Qt::Key_Return
114
 
.IP "\(bu" 2
115
 
KeySelect2
116
 
.br
117
 
 Qt::Key_Space
118
 
.IP "\(bu" 2
119
 
KeyAbort
120
 
.br
121
 
 Qt::Key_Escape
122
 
.PP
123
 
.PP
124
 
.IP "\(bu" 2
125
 
KeyLeft
126
 
.br
127
 
 Qt::Key_Left
128
 
.IP "\(bu" 2
129
 
KeyRight
130
 
.br
131
 
 Qt::Key_Right
132
 
.IP "\(bu" 2
133
 
KeyUp
134
 
.br
135
 
 Qt::Key_Up
136
 
.IP "\(bu" 2
137
 
KeyDown
138
 
.br
139
 
 Qt::Key_Down
140
 
.PP
141
 
.PP
142
 
.IP "\(bu" 2
143
 
KeyUndo
144
 
.br
145
 
 Qt::Key_Minus
146
 
.IP "\(bu" 2
147
 
KeyRedo
148
 
.br
149
 
 Qt::Key_Plus
150
 
.IP "\(bu" 2
151
 
KeyHome
152
 
.br
153
 
 Qt::Key_Escape 
154
 
.PP
155
 
 
156
 
.PP
157
 
Definition at line 118 of file qwt_event_pattern.h.
158
 
.SS "enum \fBQwtEventPattern::MousePatternCode\fP"
159
 
.PP
160
 
Symbolic mouse input codes. 
161
 
.PP
162
 
The default initialization for 3 button mice is:
163
 
.IP "\(bu" 2
164
 
MouseSelect1
165
 
.br
166
 
 Qt::LeftButton
167
 
.IP "\(bu" 2
168
 
MouseSelect2
169
 
.br
170
 
 Qt::RightButton
171
 
.IP "\(bu" 2
172
 
MouseSelect3
173
 
.br
174
 
 Qt::MidButton
175
 
.IP "\(bu" 2
176
 
MouseSelect4
177
 
.br
178
 
 Qt::LeftButton + Qt::ShiftButton
179
 
.IP "\(bu" 2
180
 
MouseSelect5
181
 
.br
182
 
 Qt::RightButton + Qt::ShiftButton
183
 
.IP "\(bu" 2
184
 
MouseSelect6
185
 
.br
186
 
 Qt::MidButton + Qt::ShiftButton
187
 
.PP
188
 
.PP
189
 
The default initialization for 2 button mice is:
190
 
.IP "\(bu" 2
191
 
MouseSelect1
192
 
.br
193
 
 Qt::LeftButton
194
 
.IP "\(bu" 2
195
 
MouseSelect2
196
 
.br
197
 
 Qt::RightButton
198
 
.IP "\(bu" 2
199
 
MouseSelect3
200
 
.br
201
 
 Qt::LeftButton + Qt::AltButton
202
 
.IP "\(bu" 2
203
 
MouseSelect4
204
 
.br
205
 
 Qt::LeftButton + Qt::ShiftButton
206
 
.IP "\(bu" 2
207
 
MouseSelect5
208
 
.br
209
 
 Qt::RightButton + Qt::ShiftButton
210
 
.IP "\(bu" 2
211
 
MouseSelect6
212
 
.br
213
 
 Qt::LeftButton + Qt::AltButton + Qt::ShiftButton
214
 
.PP
215
 
.PP
216
 
The default initialization for 1 button mice is:
217
 
.IP "\(bu" 2
218
 
MouseSelect1
219
 
.br
220
 
 Qt::LeftButton
221
 
.IP "\(bu" 2
222
 
MouseSelect2
223
 
.br
224
 
 Qt::LeftButton + Qt::ControlButton
225
 
.IP "\(bu" 2
226
 
MouseSelect3
227
 
.br
228
 
 Qt::LeftButton + Qt::AltButton
229
 
.IP "\(bu" 2
230
 
MouseSelect4
231
 
.br
232
 
 Qt::LeftButton + Qt::ShiftButton
233
 
.IP "\(bu" 2
234
 
MouseSelect5
235
 
.br
236
 
 Qt::LeftButton + Qt::ControlButton + Qt::ShiftButton
237
 
.IP "\(bu" 2
238
 
MouseSelect6
239
 
.br
240
 
 Qt::LeftButton + Qt::AltButton + Qt::ShiftButton
241
 
.PP
242
 
.PP
243
 
\fBSee also:\fP
244
 
.RS 4
245
 
\fBinitMousePattern()\fP 
246
 
.RE
247
 
.PP
248
 
 
249
 
.PP
250
 
Definition at line 79 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::initKeyPattern ()"
275
 
.PP
276
 
Set default mouse patterns.
277
 
.PP
278
 
\fBSee also:\fP
279
 
.RS 4
280
 
\fBKeyPatternCode\fP 
281
 
.RE
282
 
.PP
283
 
 
284
 
.PP
285
 
Definition at line 88 of file qwt_event_pattern.cpp.
286
 
.PP
287
 
References setKeyPattern().
288
 
.PP
289
 
Referenced by QwtEventPattern().
290
 
.SS "void QwtEventPattern::initMousePattern (int numButtons)"
291
 
.PP
292
 
Set default mouse patterns, depending on the number of mouse buttons
293
 
.PP
294
 
\fBParameters:\fP
295
 
.RS 4
296
 
\fInumButtons\fP Number of mouse buttons ( <= 3 ) 
297
 
.RE
298
 
.PP
299
 
\fBSee also:\fP
300
 
.RS 4
301
 
\fBMousePatternCode\fP 
302
 
.RE
303
 
.PP
304
 
 
305
 
.PP
306
 
Definition at line 38 of file qwt_event_pattern.cpp.
307
 
.PP
308
 
References setMousePattern().
309
 
.PP
310
 
Referenced by QwtEventPattern().
311
 
.SS "bool QwtEventPattern::keyMatch (const \fBKeyPattern\fP & pattern, const QKeyEvent * e) const\fC [protected, virtual]\fP"
312
 
.PP
313
 
Compare a key event with an event pattern. 
314
 
.PP
315
 
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.
316
 
.PP
317
 
\fBParameters:\fP
318
 
.RS 4
319
 
\fIpattern\fP Key event pattern 
320
 
.br
321
 
\fIe\fP Key event 
322
 
.RE
323
 
.PP
324
 
\fBReturns:\fP
325
 
.RS 4
326
 
true if matches
327
 
.RE
328
 
.PP
329
 
\fBSee also:\fP
330
 
.RS 4
331
 
\fBmouseMatch()\fP 
332
 
.RE
333
 
.PP
334
 
 
335
 
.PP
336
 
Definition at line 272 of file qwt_event_pattern.cpp.
337
 
.PP
338
 
References QwtEventPattern::KeyPattern::key, and QwtEventPattern::KeyPattern::state.
339
 
.SS "bool QwtEventPattern::keyMatch (uint pattern, const QKeyEvent * e) const"
340
 
.PP
341
 
Compare a key event with an event pattern. 
342
 
.PP
343
 
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.
344
 
.PP
345
 
\fBParameters:\fP
346
 
.RS 4
347
 
\fIpattern\fP Index of the event pattern 
348
 
.br
349
 
\fIe\fP Key event 
350
 
.RE
351
 
.PP
352
 
\fBReturns:\fP
353
 
.RS 4
354
 
true if matches
355
 
.RE
356
 
.PP
357
 
\fBSee also:\fP
358
 
.RS 4
359
 
\fBmouseMatch()\fP 
360
 
.RE
361
 
.PP
362
 
 
363
 
.PP
364
 
Definition at line 248 of file qwt_event_pattern.cpp.
365
 
.PP
366
 
Referenced by QwtPlotZoomer::widgetKeyPressEvent(), and QwtPicker::widgetKeyPressEvent().
367
 
.SS "QwtArray< \fBQwtEventPattern::KeyPattern\fP > & QwtEventPattern::keyPattern ()"
368
 
.PP
369
 
Return Key patterns. 
370
 
.PP
371
 
Definition at line 175 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 "bool QwtEventPattern::mouseMatch (const \fBMousePattern\fP & pattern, const QMouseEvent * e) const\fC [protected, virtual]\fP"
378
 
.PP
379
 
Compare a mouse event with an event pattern. 
380
 
.PP
381
 
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.
382
 
.PP
383
 
\fBParameters:\fP
384
 
.RS 4
385
 
\fIpattern\fP Mouse event pattern 
386
 
.br
387
 
\fIe\fP Mouse event 
388
 
.RE
389
 
.PP
390
 
\fBReturns:\fP
391
 
.RS 4
392
 
true if matches
393
 
.RE
394
 
.PP
395
 
\fBSee also:\fP
396
 
.RS 4
397
 
\fBkeyMatch()\fP 
398
 
.RE
399
 
.PP
400
 
 
401
 
.PP
402
 
Definition at line 217 of file qwt_event_pattern.cpp.
403
 
.PP
404
 
References QwtEventPattern::MousePattern::button, and QwtEventPattern::MousePattern::state.
405
 
.SS "bool QwtEventPattern::mouseMatch (uint pattern, const QMouseEvent * e) const"
406
 
.PP
407
 
Compare a mouse event with an event pattern. 
408
 
.PP
409
 
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.
410
 
.PP
411
 
\fBParameters:\fP
412
 
.RS 4
413
 
\fIpattern\fP Index of the event pattern 
414
 
.br
415
 
\fIe\fP Mouse event 
416
 
.RE
417
 
.PP
418
 
\fBReturns:\fP
419
 
.RS 4
420
 
true if matches
421
 
.RE
422
 
.PP
423
 
\fBSee also:\fP
424
 
.RS 4
425
 
\fBkeyMatch()\fP 
426
 
.RE
427
 
.PP
428
 
 
429
 
.PP
430
 
Definition at line 193 of file qwt_event_pattern.cpp.
431
 
.PP
432
 
Referenced by QwtPickerPolygonMachine::transition(), QwtPickerDragRectMachine::transition(), QwtPickerClickRectMachine::transition(), QwtPickerDragPointMachine::transition(), QwtPickerClickPointMachine::transition(), and QwtPlotZoomer::widgetMouseReleaseEvent().
433
 
.SS "QwtArray< \fBQwtEventPattern::MousePattern\fP > & QwtEventPattern::mousePattern ()"
434
 
.PP
435
 
Return ,ouse patterns. 
436
 
.PP
437
 
Definition at line 169 of file qwt_event_pattern.cpp.
438
 
.SS "const QwtArray< \fBQwtEventPattern::MousePattern\fP > & QwtEventPattern::mousePattern () const"
439
 
.PP
440
 
Return mouse patterns. 
441
 
.PP
442
 
Definition at line 156 of file qwt_event_pattern.cpp.
443
 
.SS "void QwtEventPattern::setKeyPattern (const QwtArray< \fBKeyPattern\fP > &)"
444
 
.PP
445
 
Change the key event patterns. 
446
 
.PP
447
 
Definition at line 149 of file qwt_event_pattern.cpp.
448
 
.SS "void QwtEventPattern::setKeyPattern (uint pattern, int key, int state = \fCQt::NoButton\fP)"
449
 
.PP
450
 
Change one key pattern
451
 
.PP
452
 
\fBParameters:\fP
453
 
.RS 4
454
 
\fIpattern\fP Index of the pattern 
455
 
.br
456
 
\fIkey\fP Key 
457
 
.br
458
 
\fIstate\fP State
459
 
.RE
460
 
.PP
461
 
\fBSee also:\fP
462
 
.RS 4
463
 
QKeyEvent 
464
 
.RE
465
 
.PP
466
 
 
467
 
.PP
468
 
Definition at line 133 of file qwt_event_pattern.cpp.
469
 
.PP
470
 
Referenced by initKeyPattern().
471
 
.SS "void QwtEventPattern::setMousePattern (const QwtArray< \fBMousePattern\fP > &)"
472
 
.PP
473
 
Change the mouse event patterns. 
474
 
.PP
475
 
Definition at line 143 of file qwt_event_pattern.cpp.
476
 
.SS "void QwtEventPattern::setMousePattern (uint pattern, int button, int state = \fCQt::NoButton\fP)"
477
 
.PP
478
 
Change one mouse pattern
479
 
.PP
480
 
\fBParameters:\fP
481
 
.RS 4
482
 
\fIpattern\fP Index of the pattern 
483
 
.br
484
 
\fIbutton\fP Button 
485
 
.br
486
 
\fIstate\fP State
487
 
.RE
488
 
.PP
489
 
\fBSee also:\fP
490
 
.RS 4
491
 
QMouseEvent 
492
 
.RE
493
 
.PP
494
 
 
495
 
.PP
496
 
Definition at line 115 of file qwt_event_pattern.cpp.
497
 
.PP
498
 
Referenced by initMousePattern().
499
 
 
500
 
.SH "Author"
501
 
.PP 
502
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.