qwteventpattern.3

linux下qt的第三方的一个类

.TH "QwtEventPattern" 3 "16 Nov 2004" "Version 4.2.0" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtEventPattern \- 
.SH SYNOPSIS
.br
.PP
Inherited by \fBQwtPicker\fP.
.PP
.SH "Detailed Description"
.PP 
A collection of event patterns. 

QwtEventPattern 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.
.PP
\fBSee also:\fP
.RS 4
\fBQwtPicker\fP, \fBQwtPickerMachine\fP, \fBQwtPlotZoomer\fP 
.RE
.PP

.PP
Definition at line 27 of file qwt_event_pattern.h.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBMousePatternCode\fP { \fBMouseSelect1\fP, \fBMouseSelect2\fP, \fBMouseSelect3\fP, \fBMouseSelect4\fP, \fBMouseSelect5\fP, \fBMouseSelect6\fP, \fBMousePatternCount\fP }"
.br
.ti -1c
.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 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtEventPattern\fP ()"
.br
.ti -1c
.RI "virtual \fB~QwtEventPattern\fP ()"
.br
.ti -1c
.RI "void \fBinitMousePattern\fP (int numButtons)"
.br
.ti -1c
.RI "void \fBinitKeyPattern\fP ()"
.br
.ti -1c
.RI "void \fBsetMousePattern\fP (uint pattern, int button, int state=Qt::NoButton)"
.br
.ti -1c
.RI "void \fBsetKeyPattern\fP (uint pattern, int key, int state=Qt::NoButton)"
.br
.ti -1c
.RI "void \fBsetMousePattern\fP (const QwtArray< MousePattern > &)"
.br
.ti -1c
.RI "void \fBsetKeyPattern\fP (const QwtArray< KeyPattern > &)"
.br
.ti -1c
.RI "const QwtArray< MousePattern > & \fBmousePattern\fP () const"
.br
.ti -1c
.RI "const QwtArray< KeyPattern > & \fBkeyPattern\fP () const"
.br
.ti -1c
.RI "QwtArray< MousePattern > & \fBmousePattern\fP ()"
.br
.ti -1c
.RI "QwtArray< KeyPattern > & \fBkeyPattern\fP ()"
.br
.ti -1c
.RI "bool \fBmouseMatch\fP (uint pattern, const QMouseEvent *) const"
.br
.ti -1c
.RI "bool \fBkeyMatch\fP (uint pattern, const QKeyEvent *) const"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual bool \fBmouseMatch\fP (const MousePattern &, const QMouseEvent *) const"
.br
.ti -1c
.RI "virtual bool \fBkeyMatch\fP (const KeyPattern &, const QKeyEvent *) const"
.br
.in -1c
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBQwtEventPattern::KeyPatternCode\fP"
.PP
Symbolic keyboard input codes. 
.PP
Default initialization:
.IP "\(bu" 2
KeySelect1
.br
 Qt::Key_Return
.IP "\(bu" 2
KeySelect2
.br
 Qt::Key_Space
.IP "\(bu" 2
KeyAbort
.br
 Qt::Key_Escape
.PP
.PP
.IP "\(bu" 2
KeyLeft
.br
 Qt::Key_Left
.IP "\(bu" 2
KeyRight
.br
 Qt::Key_Right
.IP "\(bu" 2
KeyUp
.br
 Qt::Key_Up
.IP "\(bu" 2
KeyDown
.br
 Qt::Key_Down
.PP
.PP
.IP "\(bu" 2
KeyUndo
.br
 Qt::Key_Minus
.IP "\(bu" 2
KeyRedo
.br
 Qt::Key_Plus
.IP "\(bu" 2
KeyHome
.br
 Qt::Key_Escape 
.PP
Definition at line 117 of file qwt_event_pattern.h.
.SS "enum \fBQwtEventPattern::MousePatternCode\fP"
.PP
Symbolic mouse input codes. 
.PP
The default initialization for 3 button mice is:
.IP "\(bu" 2
MouseSelect1
.br
 Qt::LeftButton
.IP "\(bu" 2
MouseSelect2
.br
 Qt::RightButton
.IP "\(bu" 2
MouseSelect3
.br
 Qt::MidButton
.IP "\(bu" 2
MouseSelect4
.br
 Qt::LeftButton + Qt::ShiftButton
.IP "\(bu" 2
MouseSelect5
.br
 Qt::RightButton + Qt::ShiftButton
.IP "\(bu" 2
MouseSelect6
.br
 Qt::MidButton + Qt::ShiftButton
.PP
.PP
The default initialization for 2 button mice is:
.IP "\(bu" 2
MouseSelect1
.br
 Qt::LeftButton
.IP "\(bu" 2
MouseSelect2
.br
 Qt::RightButton
.IP "\(bu" 2
MouseSelect3
.br
 Qt::LeftButton + Qt::AltButton
.IP "\(bu" 2
MouseSelect4
.br
 Qt::LeftButton + Qt::ShiftButton
.IP "\(bu" 2
MouseSelect5
.br
 Qt::RightButton + Qt::ShiftButton
.IP "\(bu" 2
MouseSelect6
.br
 Qt::LeftButton + Qt::AltButton + Qt::ShiftButton
.PP
.PP
The default initialization for 1 button mice is:
.IP "\(bu" 2
MouseSelect1
.br
 Qt::LeftButton
.IP "\(bu" 2
MouseSelect2
.br
 Qt::LeftButton + Qt::ControlButton
.IP "\(bu" 2
MouseSelect3
.br
 Qt::LeftButton + Qt::AltButton
.IP "\(bu" 2
MouseSelect4
.br
 Qt::LeftButton + Qt::ShiftButton
.IP "\(bu" 2
MouseSelect5
.br
 Qt::LeftButton + Qt::ControlButton + Qt::ShiftButton
.IP "\(bu" 2
MouseSelect6
.br
 Qt::LeftButton + Qt::AltButton + Qt::ShiftButton
.PP
.PP
\fBSee also:\fP
.RS 4
\fBinitMousePattern()\fP 
.RE
.PP
Definition at line 78 of file qwt_event_pattern.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "QwtEventPattern::QwtEventPattern ()"
.PP
Constructor
.PP
\fBSee also:\fP
.RS 4
\fBMousePatternCode\fP, \fBKeyPatternCode\fP 
.RE
.PP
Definition at line 19 of file qwt_event_pattern.cpp.
.PP
References initKeyPattern(), and initMousePattern().
.SS "QwtEventPattern::~\fBQwtEventPattern\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
Definition at line 28 of file qwt_event_pattern.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void QwtEventPattern::initKeyPattern ()"
.PP
Set default mouse patterns.
.PP
\fBSee also:\fP
.RS 4
\fBKeyPatternCode\fP 
.RE
.PP
Definition at line 78 of file qwt_event_pattern.cpp.
.PP
References setKeyPattern().
.PP
Referenced by QwtEventPattern().
.SS "void QwtEventPattern::initMousePattern (int numButtons)"
.PP
Set default mouse patterns, depending on the number of mouse buttons
.PP
\fBParameters:\fP
.RS 4
\fInumButtons\fP Number of mouse buttons ( <= 3 ) 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBMousePatternCode\fP 
.RE
.PP
Definition at line 38 of file qwt_event_pattern.cpp.
.PP
References setMousePattern().
.PP
Referenced by QwtEventPattern().
.SS "bool QwtEventPattern::keyMatch (const KeyPattern & pattern, const QKeyEvent * e) const\fC [protected, virtual]\fP"
.PP
Compare a key event with an event pattern. 
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fIpattern\fP Key event pattern 
.br
\fIe\fP Key event 
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE if matches
.RE
.PP
\fBSee also:\fP
.RS 4
\fBmouseMatch()\fP 
.RE
.PP
Definition at line 251 of file qwt_event_pattern.cpp.
.SS "bool QwtEventPattern::keyMatch (uint pattern, const QKeyEvent * e) const"
.PP
Compare a key event with an event pattern. 
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fIpattern\fP Index of the event pattern 
.br
\fIe\fP Key event 
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE if matches
.RE
.PP
\fBSee also:\fP
.RS 4
\fBmouseMatch()\fP 
.RE
.PP
Definition at line 227 of file qwt_event_pattern.cpp.
.PP
Referenced by QwtPickerPolygonMachine::transition(), QwtPickerDragRectMachine::transition(), QwtPickerClickRectMachine::transition(), QwtPickerDragPointMachine::transition(), QwtPickerClickPointMachine::transition(), QwtPlotZoomer::widgetKeyPressEvent(), and QwtPicker::widgetKeyPressEvent().
.SS "QwtArray< QwtEventPattern::KeyPattern > & QwtEventPattern::keyPattern ()"
.PP
Return Key patterns. 
.PP
Definition at line 165 of file qwt_event_pattern.cpp.
.SS "const QwtArray< QwtEventPattern::KeyPattern > & QwtEventPattern::keyPattern () const"
.PP
Return key patterns. 
.PP
Definition at line 153 of file qwt_event_pattern.cpp.
.SS "bool QwtEventPattern::mouseMatch (const MousePattern & pattern, const QMouseEvent * e) const\fC [protected, virtual]\fP"
.PP
Compare a mouse event with an event pattern. 
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fIpattern\fP Mouse event pattern 
.br
\fIe\fP Mouse event 
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE if matches
.RE
.PP
\fBSee also:\fP
.RS 4
\fBkeyMatch()\fP 
.RE
.PP
Definition at line 207 of file qwt_event_pattern.cpp.
.SS "bool QwtEventPattern::mouseMatch (uint pattern, const QMouseEvent * e) const"
.PP
Compare a mouse event with an event pattern. 
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fIpattern\fP Index of the event pattern 
.br
\fIe\fP Mouse event 
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE if matches
.RE
.PP
\fBSee also:\fP
.RS 4
\fBkeyMatch()\fP 
.RE
.PP
Definition at line 183 of file qwt_event_pattern.cpp.
.PP
Referenced by QwtPickerPolygonMachine::transition(), QwtPickerDragRectMachine::transition(), QwtPickerClickRectMachine::transition(), QwtPickerDragPointMachine::transition(), QwtPickerClickPointMachine::transition(), and QwtPlotZoomer::widgetMouseReleaseEvent().
.SS "QwtArray< QwtEventPattern::MousePattern > & QwtEventPattern::mousePattern ()"
.PP
Return ,ouse patterns. 
.PP
Definition at line 159 of file qwt_event_pattern.cpp.
.SS "const QwtArray< QwtEventPattern::MousePattern > & QwtEventPattern::mousePattern () const"
.PP
Return mouse patterns. 
.PP
Definition at line 146 of file qwt_event_pattern.cpp.
.SS "void QwtEventPattern::setKeyPattern (const QwtArray< KeyPattern > &)"
.PP
Change the key event patterns. 
.PP
Definition at line 139 of file qwt_event_pattern.cpp.
.SS "void QwtEventPattern::setKeyPattern (uint pattern, int key, int state = \fCQt::NoButton\fP)"
.PP
Change one key pattern
.PP
\fBParameters:\fP
.RS 4
\fIpattern\fP Index of the pattern 
.br
\fIkey\fP Key 
.br
\fIstate\fP State
.RE
.PP
\fBSee also:\fP
.RS 4
QKeyEvent 
.RE
.PP
Definition at line 123 of file qwt_event_pattern.cpp.
.PP
Referenced by initKeyPattern().
.SS "void QwtEventPattern::setMousePattern (const QwtArray< MousePattern > &)"
.PP
Change the mouse event patterns. 
.PP
Definition at line 133 of file qwt_event_pattern.cpp.
.SS "void QwtEventPattern::setMousePattern (uint pattern, int button, int state = \fCQt::NoButton\fP)"
.PP
Change one mouse pattern
.PP
\fBParameters:\fP
.RS 4
\fIpattern\fP Index of the pattern 
.br
\fIbutton\fP Button 
.br
\fIstate\fP State
.RE
.PP
\fBSee also:\fP
.RS 4
QMouseEvent 
.RE
.PP
Definition at line 105 of file qwt_event_pattern.cpp.
.PP
Referenced by initMousePattern().

.SH "Author"
.PP 
Generated automatically by Doxygen for Qwt User's Guide from the source code.