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

« back to all changes in this revision

Viewing changes to qwt-5.0.2/doc/man/man3/QwtPickerMachine.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
* 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:
 
1
.TH "QwtPickerMachine" 3 "11 Jun 2007" "Version 5.0.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtPickerMachine \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherited by \fBQwtPickerClickPointMachine\fP, \fBQwtPickerClickRectMachine\fP, \fBQwtPickerDragPointMachine\fP, \fBQwtPickerDragRectMachine\fP, and \fBQwtPickerPolygonMachine\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
A state machine for \fBQwtPicker\fP selections. 
 
14
 
 
15
\fBQwtPickerMachine\fP accepts key and mouse events and translates them into selection commands.
 
16
.PP
 
17
\fBSee also:\fP
 
18
.RS 4
 
19
\fBQwtEventPattern::MousePatternCode\fP, \fBQwtEventPattern::KeyPatternCode\fP 
 
20
.RE
 
21
.PP
 
22
 
 
23
.PP
 
24
Definition at line 32 of file qwt_picker_machine.h.
 
25
.SS "Public Types"
 
26
 
 
27
.in +1c
 
28
.ti -1c
 
29
.RI "typedef QList< \fBCommand\fP > \fBCommandList\fP"
 
30
.br
 
31
.ti -1c
 
32
.RI "enum \fBCommand\fP { \fBBegin\fP, \fBAppend\fP, \fBMove\fP, \fBEnd\fP }"
 
33
.br
 
34
.in -1c
 
35
.SS "Public Member Functions"
 
36
 
 
37
.in +1c
 
38
.ti -1c
 
39
.RI "virtual \fB~QwtPickerMachine\fP ()"
 
40
.br
 
41
.ti -1c
 
42
.RI "virtual \fBCommandList\fP \fBtransition\fP (const \fBQwtEventPattern\fP &, const QEvent *)=0"
 
43
.br
 
44
.ti -1c
 
45
.RI "void \fBreset\fP ()"
 
46
.br
 
47
.ti -1c
 
48
.RI "int \fBstate\fP () const "
 
49
.br
 
50
.ti -1c
 
51
.RI "void \fBsetState\fP (int)"
 
52
.br
 
53
.in -1c
 
54
.SS "Protected Member Functions"
 
55
 
 
56
.in +1c
 
57
.ti -1c
 
58
.RI "\fBQwtPickerMachine\fP ()"
 
59
.br
 
60
.in -1c
 
61
.SH "Member Enumeration Documentation"
 
62
.PP 
 
63
.SS "enum \fBQwtPickerMachine::Command\fP"
 
64
.PP
 
65
Commands - the output of the state machine. 
 
66
.PP
 
67
Definition at line 36 of file qwt_picker_machine.h.
 
68
.SH "Constructor & Destructor Documentation"
 
69
.PP 
 
70
.SS "QwtPickerMachine::~QwtPickerMachine ()\fC [virtual]\fP"
 
71
.PP
 
72
Destructor. 
 
73
.PP
 
74
Definition at line 21 of file qwt_picker_machine.cpp.
 
75
.SS "QwtPickerMachine::QwtPickerMachine ()\fC [protected]\fP"
 
76
.PP
 
77
Constructor. 
 
78
.PP
 
79
Definition at line 15 of file qwt_picker_machine.cpp.
 
80
.SH "Member Function Documentation"
 
81
.PP 
 
82
.SS "void QwtPickerMachine::reset ()"
 
83
.PP
 
84
Set the current state to 0. 
 
85
.PP
 
86
Definition at line 38 of file qwt_picker_machine.cpp.
 
87
.PP
 
88
References setState().
 
89
.SS "void QwtPickerMachine::setState (int)"
 
90
.PP
 
91
Change the current state. 
 
92
.PP
 
93
Definition at line 32 of file qwt_picker_machine.cpp.
 
94
.PP
 
95
Referenced by reset(), QwtPickerPolygonMachine::transition(), QwtPickerDragRectMachine::transition(), QwtPickerClickRectMachine::transition(), and QwtPickerDragPointMachine::transition().
 
96
.SS "int QwtPickerMachine::state () const"
 
97
.PP
 
98
Return the current state. 
 
99
.PP
 
100
Definition at line 26 of file qwt_picker_machine.cpp.
 
101
.PP
 
102
Referenced by QwtPickerPolygonMachine::transition(), QwtPickerDragRectMachine::transition(), QwtPickerClickRectMachine::transition(), and QwtPickerDragPointMachine::transition().
 
103
.SS "virtual \fBCommandList\fP QwtPickerMachine::transition (const \fBQwtEventPattern\fP &, const QEvent *)\fC [pure virtual]\fP"
 
104
.PP
 
105
Transition. 
 
106
.PP
 
107
Implemented in \fBQwtPickerClickPointMachine\fP, \fBQwtPickerDragPointMachine\fP, \fBQwtPickerClickRectMachine\fP, \fBQwtPickerDragRectMachine\fP, and \fBQwtPickerPolygonMachine\fP.
 
108
 
 
109
.SH "Author"
 
110
.PP 
 
111
Generated automatically by Doxygen for Qwt User's Guide from the source code.