QwtPicker filters all mouse and keyboard events of a widget and translates them into an array of selected points. Depending on the QwtPicker::SelectionType the selection might be a single point, a rectangle or a polygon. The selection process is supported by optional rubberbands (rubberband selection) and position trackers.
QwtPicker is useful for widgets where the event handlers canīt be overloaded, like for components of composite widgets. It offers alternative handlers for mouse and key events.
#include <qwt_picker.h> QwtPicker *picker = new QwtPicker(widget); picker->setTrackerMode(QwtPicker::ActiveOnly); connect(picker, SIGNAL(selected(const QwtPolygon &)), ...); // emit the position of clicks on widget picker->setSelectionFlags(QwtPicker::PointSelection | QwtPicker::ClickSelection); ... // now select rectangles picker->setSelectionFlags(QwtPicker::RectSelection | QwtPicker::DragSelection); picker->setRubberBand(QwtPicker::RectRubberBand);
The commands are initiated from a small state machine (QwtPickerMachine) that translates mouse and key events. There are a couple of predefined state machines for point, rect and polygon selections. The selectionFlags() control which one should be used. It is possible to use other machines by overloading stateMachine().
The picker is active (isActive()), between begin() and end(). In active state the rubberband is displayed, and the tracker is visible in case of trackerMode is ActiveOnly or AlwaysOn.
The cursor can be moved using the arrow keys. All selections can be aborted using the abort key. (QwtEventPattern::KeyPatternCode)
Definition at line 80 of file qwt_picker.h.
Public Types | |
enum | SelectionType { NoSelection = 0, PointSelection = 1, RectSelection = 2, PolygonSelection = 4 } |
enum | RectSelectionType { CornerToCorner = 64, CenterToCorner = 128, CenterToRadius = 256 } |
enum | SelectionMode { ClickSelection = 1024, DragSelection = 2048 } |
enum | RubberBand { NoRubberBand = 0, HLineRubberBand, VLineRubberBand, CrossRubberBand, RectRubberBand, EllipseRubberBand, PolygonRubberBand, UserRubberBand = 100 } |
enum | DisplayMode { AlwaysOff, AlwaysOn, ActiveOnly } |
enum | ResizeMode { Stretch, KeepSize } |
Signals | |
void | selected (const QwtPolygon &pa) |
void | appended (const QPoint &pos) |
void | moved (const QPoint &pos) |
void | changed (const QwtPolygon &pa) |
Public Member Functions | |
QwtPicker (QWidget *parent) | |
QwtPicker (int selectionFlags, RubberBand rubberBand, DisplayMode trackerMode, QWidget *) | |
virtual | ~QwtPicker () |
virtual void | setSelectionFlags (int) |
int | selectionFlags () const |
virtual void | setRubberBand (RubberBand) |
RubberBand | rubberBand () const |
virtual void | setTrackerMode (DisplayMode) |
DisplayMode | trackerMode () const |
virtual void | setResizeMode (ResizeMode) |
ResizeMode | resizeMode () const |
virtual void | setRubberBandPen (const QPen &) |
QPen | rubberBandPen () const |
virtual void | setTrackerPen (const QPen &) |
QPen | trackerPen () const |
virtual void | setTrackerFont (const QFont &) |
QFont | trackerFont () const |
bool | isEnabled () const |
virtual void | setEnabled (bool) |
bool | isActive () const |
virtual bool | eventFilter (QObject *, QEvent *) |
QWidget * | parentWidget () |
const QWidget * | parentWidget () const |
virtual QRect | pickRect () const |
const QwtPolygon & | selection () const |
virtual void | drawRubberBand (QPainter *) const |
virtual void | drawTracker (QPainter *) const |
Protected Member Functions | |
virtual bool | accept (QwtPolygon &selection) const |
virtual void | transition (const QEvent *) |
virtual void | begin () |
virtual void | append (const QPoint &) |
virtual void | move (const QPoint &) |
virtual bool | end (bool ok=true) |
virtual void | widgetMousePressEvent (QMouseEvent *) |
virtual void | widgetMouseReleaseEvent (QMouseEvent *) |
virtual void | widgetMouseDoubleClickEvent (QMouseEvent *) |
virtual void | widgetMouseMoveEvent (QMouseEvent *) |
virtual void | widgetWheelEvent (QWheelEvent *) |
virtual void | widgetKeyPressEvent (QKeyEvent *) |
virtual void | widgetKeyReleaseEvent (QKeyEvent *) |
virtual void | widgetLeaveEvent (QEvent *) |
QRect | trackerRect (QPainter *painter) const |
virtual void | stretchSelection (const QSize &oldSize, const QSize &newSize) |
virtual QwtText | trackerText (const QPoint &pos) const |
virtual QwtPickerMachine * | stateMachine (int) const |
virtual void | updateDisplay () |
const QWidget * | rubberBandWidget () const |
const QWidget * | trackerWidget () const |
|
Definition at line 217 of file qwt_picker.h. |
|
Selection subtype for RectSelection This enum type describes the type of rectangle selections. It can be orīd with QwtPicker::RectSelectionType and QwtPicker::SelectionMode and passed to QwtPicker::setSelectionFlags().
The default value is CornerToCorner. Definition at line 143 of file qwt_picker.h. |
|
Controls what to do with the selected points of an active selection when the observed widget is resized.
The default value is Stretch.
Definition at line 236 of file qwt_picker.h. |
|
Rubberband style
The default value is NoRubberBand. Definition at line 187 of file qwt_picker.h. |
|
Values of this enum type orīd together with a SelectionType value identifies which state machine should be used for the selection. The default value is ClickSelection.
Definition at line 157 of file qwt_picker.h. |
|
This enum type describes the type of a selection. It can be orīd with QwtPicker::RectSelectionType and QwtPicker::SelectionMode and passed to QwtPicker::setSelectionFlags()
The default value is NoSelection. Definition at line 117 of file qwt_picker.h. |
|
Constructor Creates an picker that is enabled, but where selection flag is set to NoSelection, rubberband and tracker are disabled.
Definition at line 185 of file qwt_picker.cpp. |
|
Constructor
Definition at line 200 of file qwt_picker.cpp. |
|
Destructor.
Definition at line 208 of file qwt_picker.cpp. |
|
Validate and fixup the selection. Accepts all selections unmodified
Reimplemented in QwtPlotZoomer. Definition at line 1184 of file qwt_picker.cpp. Referenced by end(). |
|
Append a point to the selection and update rubberband and tracker. The appended() signal is emitted.
Reimplemented in QwtPlotPicker. Definition at line 1143 of file qwt_picker.cpp. References appended(), and updateDisplay(). Referenced by QwtPlotPicker::append(). |
|
A signal emitted when a point has been appended to the selection
Referenced by append(). |
|
Open a selection setting the state to active
Reimplemented in QwtPlotZoomer. Definition at line 1076 of file qwt_picker.cpp. References parentWidget(), and trackerMode(). |
|
A signal emitted when the active selection has been changed. This might happen when the observed widget is resized.
Referenced by stretchSelection(). |
|
Draw a rubberband , depending on rubberBand() and selectionFlags()
Definition at line 591 of file qwt_picker.cpp. References QwtPainter::drawEllipse(), QwtPainter::drawLine(), QwtPainter::drawRect(), isActive(), pickRect(), rubberBand(), rubberBandPen(), and selectionFlags(). |
|
Draw the tracker
Definition at line 686 of file qwt_picker.cpp. References trackerRect(), trackerText(), and QwtText::usedFont(). |
|
Close a selection setting the state to inactive. The selection is validated and maybe fixed by QwtPicker::accept().
Reimplemented in QwtPlotPicker, and QwtPlotZoomer. Definition at line 1108 of file qwt_picker.cpp. References accept(), selected(), trackerMode(), and updateDisplay(). Referenced by QwtPlotPicker::end(), and widgetKeyPressEvent(). |
|
Event filter. When isEnabled() == true all events of the observed widget are filtered. Mouse and keyboard events are translated into widgetMouse- and widgetKey- and widgetWheel-events. Paint and Resize events are handled to keep rubberband and tracker up to date.
Definition at line 788 of file qwt_picker.cpp. References parentWidget(), stretchSelection(), widgetKeyPressEvent(), widgetKeyReleaseEvent(), widgetLeaveEvent(), widgetMouseDoubleClickEvent(), widgetMouseMoveEvent(), widgetMousePressEvent(), widgetMouseReleaseEvent(), and widgetWheelEvent(). |
|
A picker is active between begin() and end().
Definition at line 1193 of file qwt_picker.cpp. Referenced by drawRubberBand(), trackerRect(), updateDisplay(), QwtPlotZoomer::widgetKeyPressEvent(), widgetKeyPressEvent(), widgetLeaveEvent(), and widgetMouseMoveEvent(). |
|
Definition at line 474 of file qwt_picker.cpp. |
|
Move the last point of the selection The moved() signal is emitted.
Reimplemented in QwtPlotPicker. Definition at line 1165 of file qwt_picker.cpp. References moved(), and updateDisplay(). Referenced by QwtPlotPicker::move(). |
|
A signal emitted whenever the last appended point of the selection has been moved.
Referenced by move(). |
|
Return the parent widget, where the selection happens.
Definition at line 322 of file qwt_picker.cpp. |
|
Return the parent widget, where the selection happens.
Definition at line 312 of file qwt_picker.cpp. Referenced by begin(), QwtPlotPicker::canvas(), eventFilter(), pickRect(), setEnabled(), updateDisplay(), and widgetKeyPressEvent(). |
|
Find the area of the observed widget, where selection might happen.
Definition at line 1265 of file qwt_picker.cpp. References parentWidget(). Referenced by drawRubberBand(), widgetKeyPressEvent(), widgetMouseMoveEvent(), and widgetWheelEvent(). |
|
Definition at line 436 of file qwt_picker.cpp. |
|
Definition at line 373 of file qwt_picker.cpp. Referenced by drawRubberBand(), trackerRect(), QwtPlotPicker::trackerText(), trackerText(), and updateDisplay(). |
|
Definition at line 547 of file qwt_picker.cpp. Referenced by drawRubberBand(), and updateDisplay(). |
|
A signal emitting the selected points, at the end of a selection.
Referenced by end(). |
|
Return Selected points.
Definition at line 1199 of file qwt_picker.cpp. Referenced by QwtPlotZoomer::end(), and QwtPlotPicker::end(). |
|
Definition at line 351 of file qwt_picker.cpp. Referenced by drawRubberBand(), and QwtPlotPicker::end(). |
|
En/disable the picker. When enabled is true an event filter is installed for the observed widget, otherwise the event filter is removed.
Definition at line 450 of file qwt_picker.cpp. References parentWidget(), and updateDisplay(). |
|
Set the resize mode. The resize mode controls what to do with the selected points of an active selection when the observed widget is resized. Stretch means the points are scaled according to the new size, KeepSize means the points remain unchanged. The default mode is Stretch.
Definition at line 426 of file qwt_picker.cpp. |
|
Set the rubberband style
Definition at line 364 of file qwt_picker.cpp. |
|
Set the pen for the rubberband
Definition at line 534 of file qwt_picker.cpp. References updateDisplay(). |
|
Set the selection flags
Reimplemented in QwtPlotZoomer. Definition at line 340 of file qwt_picker.cpp. References stateMachine(). Referenced by QwtPlotZoomer::setSelectionFlags(). |
|
Set the font for the tracker
Definition at line 485 of file qwt_picker.cpp. References updateDisplay(). |
|
Set the display mode of the tracker. A tracker displays information about current position of the cursor as a string. The display mode controls if the tracker has to be displayed whenever the observed widget has focus and cursor (AlwaysOn), never (AlwaysOff), or only when the selection is active (ActiveOnly).
Definition at line 394 of file qwt_picker.cpp. |
|
Set the pen for the tracker
Definition at line 510 of file qwt_picker.cpp. References updateDisplay(). |
|
Create a state machine depending on the selection flags.
Definition at line 288 of file qwt_picker.cpp. Referenced by setSelectionFlags(). |
|
Scale the selection by the ratios of oldSize and newSize The changed() signal is emitted.
Definition at line 1213 of file qwt_picker.cpp. References changed(). Referenced by eventFilter(). |
|
Definition at line 499 of file qwt_picker.cpp. |
|
Definition at line 407 of file qwt_picker.cpp. Referenced by begin(), end(), trackerRect(), and updateDisplay(). |
|
Definition at line 523 of file qwt_picker.cpp. Referenced by updateDisplay(). |
|
Return the label for a position. In case of HLineRubberBand the label is the value of the y position, in case of VLineRubberBand the value of the x position. Otherwise the label contains x and y position separated by a ',' . The format for the string conversion is "%d".
Reimplemented in QwtPlotPicker. Definition at line 565 of file qwt_picker.cpp. References rubberBand(). Referenced by drawTracker(), and trackerRect(). |
|
Passes an event to the state machine and executes the resulting commands. Append and Move commands use the current position of the cursor (QCursor::pos()).
Definition at line 1019 of file qwt_picker.cpp. Referenced by widgetKeyPressEvent(), widgetKeyReleaseEvent(), widgetMouseDoubleClickEvent(), widgetMouseMoveEvent(), widgetMousePressEvent(), widgetMouseReleaseEvent(), and widgetWheelEvent(). |
|
Handle a key press event for the observed widget. Selections can be completely done by the keyboard. The arrow keys move the cursor, the abort key aborts a selection. All other keys are handled by the current state machine.
Reimplemented in QwtPlotZoomer. Definition at line 953 of file qwt_picker.cpp. References end(), isActive(), QwtEventPattern::keyMatch(), parentWidget(), pickRect(), and transition(). Referenced by eventFilter(), and QwtPlotZoomer::widgetKeyPressEvent(). |
|
Handle a key release event for the observed widget. Passes the event to the state machine.
Definition at line 1007 of file qwt_picker.cpp. References transition(). Referenced by eventFilter(). |
|
Handle a leave event for the observed widget.
Definition at line 882 of file qwt_picker.cpp. References isActive(), and updateDisplay(). Referenced by eventFilter(). |
|
Handle mouse double click event for the observed widget. Empty implementation, does nothing.
Definition at line 913 of file qwt_picker.cpp. References transition(). Referenced by eventFilter(). |
|
Handle a mouse move event for the observed widget. Move the last point of the selection in case of isActive() == true
Definition at line 862 of file qwt_picker.cpp. References isActive(), pickRect(), transition(), and updateDisplay(). Referenced by eventFilter(). |
|
Handle a mouse press event for the observed widget. Begin and/or end a selection depending on the selection flags.
Definition at line 848 of file qwt_picker.cpp. References transition(). Referenced by eventFilter(). |
|
Handle a mouse relase event for the observed widget. End a selection depending on the selection flags.
Reimplemented in QwtPlotZoomer. Definition at line 899 of file qwt_picker.cpp. References transition(). Referenced by eventFilter(), and QwtPlotZoomer::widgetMouseReleaseEvent(). |
|
Handle a wheel event for the observed widget. Move the last point of the selection in case of isActive() == true
Definition at line 928 of file qwt_picker.cpp. References pickRect(), transition(), and updateDisplay(). Referenced by eventFilter(). |