Qwt User's Guide 6.3.0
|
QwtPicker provides selections on a widget. More...
#include <qwt_picker.h>
Public Types | |
enum | RubberBand { NoRubberBand = 0 , HLineRubberBand , VLineRubberBand , CrossRubberBand , RectRubberBand , EllipseRubberBand , PolygonRubberBand , UserRubberBand = 100 } |
enum | DisplayMode { AlwaysOff , AlwaysOn , ActiveOnly } |
Display mode. More... | |
enum | ResizeMode { Stretch , KeepSize } |
Public Types inherited from QwtEventPattern | |
enum | MousePatternCode { MouseSelect1 , MouseSelect2 , MouseSelect3 , MouseSelect4 , MouseSelect5 , MouseSelect6 , MousePatternCount } |
Symbolic mouse input codes. More... | |
enum | KeyPatternCode { KeySelect1 , KeySelect2 , KeyAbort , KeyLeft , KeyRight , KeyUp , KeyDown , KeyRedo , KeyUndo , KeyHome , KeyPatternCount } |
Symbolic keyboard input codes. More... | |
Public Slots | |
void | setEnabled (bool) |
En/disable the picker. | |
Signals | |
void | activated (bool on) |
void | selected (const QPolygon &polygon) |
void | appended (const QPoint &pos) |
void | moved (const QPoint &pos) |
void | removed (const QPoint &pos) |
void | changed (const QPolygon &selection) |
Public Member Functions | |
QwtPicker (QWidget *parent) | |
QwtPicker (RubberBand rubberBand, DisplayMode trackerMode, QWidget *) | |
virtual | ~QwtPicker () |
Destructor. | |
void | setStateMachine (QwtPickerMachine *) |
const QwtPickerMachine * | stateMachine () const |
QwtPickerMachine * | stateMachine () |
void | setRubberBand (RubberBand) |
RubberBand | rubberBand () const |
void | setTrackerMode (DisplayMode) |
Set the display mode of the tracker. | |
DisplayMode | trackerMode () const |
void | setResizeMode (ResizeMode) |
Set the resize mode. | |
ResizeMode | resizeMode () const |
void | setRubberBandPen (const QPen &) |
QPen | rubberBandPen () const |
void | setTrackerPen (const QPen &) |
QPen | trackerPen () const |
void | setTrackerFont (const QFont &) |
QFont | trackerFont () const |
bool | isEnabled () const |
bool | isActive () const |
virtual bool | eventFilter (QObject *, QEvent *) override |
Event filter. | |
QWidget * | parentWidget () |
Return the parent widget, where the selection happens. | |
const QWidget * | parentWidget () const |
Return the parent widget, where the selection happens. | |
virtual QPainterPath | pickArea () const |
virtual void | drawRubberBand (QPainter *) const |
virtual void | drawTracker (QPainter *) const |
virtual QRegion | trackerMask () const |
virtual QRegion | rubberBandMask () const |
virtual QwtText | trackerText (const QPoint &pos) const |
Return the label for a position. | |
QPoint | trackerPosition () const |
virtual QRect | trackerRect (const QFont &) const |
QPolygon | selection () const |
Public Member Functions inherited from QwtEventPattern | |
QwtEventPattern () | |
virtual | ~QwtEventPattern () |
Destructor. | |
void | initMousePattern (int numButtons) |
void | initKeyPattern () |
void | setMousePattern (MousePatternCode, Qt::MouseButton button, Qt::KeyboardModifiers=Qt::NoModifier) |
void | setKeyPattern (KeyPatternCode, int key, Qt::KeyboardModifiers modifiers=Qt::NoModifier) |
void | setMousePattern (const QVector< MousePattern > &) |
Change the mouse event patterns. | |
void | setKeyPattern (const QVector< KeyPattern > &) |
Change the key event patterns. | |
const QVector< MousePattern > & | mousePattern () const |
const QVector< KeyPattern > & | keyPattern () const |
QVector< MousePattern > & | mousePattern () |
QVector< KeyPattern > & | keyPattern () |
bool | mouseMatch (MousePatternCode, const QMouseEvent *) const |
Compare a mouse event with an event pattern. | |
bool | keyMatch (KeyPatternCode, const QKeyEvent *) const |
Compare a key event with an event pattern. | |
Protected Member Functions | |
virtual QPolygon | adjustedPoints (const QPolygon &) const |
Map the pickedPoints() into a selection() | |
virtual void | transition (const QEvent *) |
virtual void | begin () |
virtual void | append (const QPoint &) |
virtual void | move (const QPoint &) |
virtual void | remove () |
virtual bool | end (bool ok=true) |
Close a selection setting the state to inactive. | |
virtual bool | accept (QPolygon &) const |
Validate and fix up the selection. | |
virtual void | reset () |
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 | widgetEnterEvent (QEvent *) |
virtual void | widgetLeaveEvent (QEvent *) |
virtual void | stretchSelection (const QSize &oldSize, const QSize &newSize) |
virtual void | updateDisplay () |
Update the state of rubber band and tracker label. | |
const QwtWidgetOverlay * | rubberBandOverlay () const |
const QwtWidgetOverlay * | trackerOverlay () const |
const QPolygon & | pickedPoints () const |
QRect | trackerRect (const QSize &) const |
Protected Member Functions inherited from QwtEventPattern | |
virtual bool | mouseMatch (const MousePattern &, const QMouseEvent *) const |
Compare a mouse event with an event pattern. | |
virtual bool | keyMatch (const KeyPattern &, const QKeyEvent *) const |
Compare a key event with an event pattern. | |
QwtPicker provides selections on a widget.
QwtPicker filters all enter, leave, mouse and keyboard events of a widget and translates them into an array of selected points.
The way how the points are collected depends on type of state machine that is connected to the picker. Qwt offers a couple of predefined state machines for selecting:
While these state machines cover the most common ways to collect points it is also possible to implement individual machines as well.
QwtPicker translates the picked points into a selection using the adjustedPoints() method. adjustedPoints() is intended to be reimplemented to fix up the selection according to application specific requirements. (F.e. when an application accepts rectangles of a fixed aspect ratio only.)
Optionally QwtPicker support the process of collecting points by a rubber band and tracker displaying a text for the current mouse position.
The state machine triggers the following commands:
The picker is active (isActive()), between begin() and end(). In active state the rubber band 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 103 of file qwt_picker.h.
Display mode.
Enumerator | |
---|---|
AlwaysOff | Display never. |
AlwaysOn | Display always. |
ActiveOnly | Display only when the selection is active. |
Definition at line 161 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 QwtPicker::Stretch.
Enumerator | |
---|---|
Stretch | All points are scaled according to the new size,. |
KeepSize | All points remain unchanged. |
Definition at line 181 of file qwt_picker.h.
Rubber band style
The default value is QwtPicker::NoRubberBand.
Enumerator | |
---|---|
NoRubberBand | No rubberband. |
HLineRubberBand | A horizontal line ( only for QwtPickerMachine::PointSelection ) |
VLineRubberBand | A vertical line ( only for QwtPickerMachine::PointSelection ) |
CrossRubberBand | A crosshair ( only for QwtPickerMachine::PointSelection ) |
RectRubberBand | A rectangle ( only for QwtPickerMachine::RectSelection ) |
EllipseRubberBand | An ellipse ( only for QwtPickerMachine::RectSelection ) |
PolygonRubberBand | A polygon ( only for QwtPickerMachine::PolygonSelection ) |
UserRubberBand | Values >= UserRubberBand can be used to define additional rubber bands. |
Definition at line 127 of file qwt_picker.h.
|
explicit |
Constructor
Creates an picker that is enabled, but without a state machine. rubber band and tracker are disabled.
parent | Parent widget, that will be observed |
Definition at line 169 of file qwt_picker.cpp.
|
explicit |
Constructor
rubberBand | Rubber band style |
trackerMode | Tracker mode |
parent | Parent widget, that will be observed |
Definition at line 182 of file qwt_picker.cpp.
|
virtual |
Destructor.
Definition at line 190 of file qwt_picker.cpp.
|
protectedvirtual |
Validate and fix up the selection.
Accepts all selections unmodified
selection | Selection to validate and fix up |
Reimplemented in QwtPlotZoomer.
Definition at line 1402 of file qwt_picker.cpp.
|
signal |
A signal indicating, when the picker has been activated. Together with setEnabled() it can be used to implement selections with more than one picker.
on | True, when the picker has been activated |
|
protectedvirtual |
Map the pickedPoints() into a selection()
adjustedPoints() maps the points, that have been collected on the parentWidget() into a selection(). The default implementation simply returns the points unmodified.
The reason, why a selection() differs from the picked points depends on the application requirements. F.e. :
The example below is for a rectangular selection, where the first point is the center of the selected rectangle.
points | Selected points |
Definition at line 783 of file qwt_picker.cpp.
|
protectedvirtual |
Append a point to the selection and update rubber band and tracker. The appended() signal is emitted.
pos | Additional point |
Reimplemented in QwtPlotPicker, and QwtPolarPicker.
Definition at line 1339 of file qwt_picker.cpp.
|
signal |
|
protectedvirtual |
Open a selection setting the state to active
Reimplemented in QwtPlotZoomer.
Definition at line 1258 of file qwt_picker.cpp.
|
signal |
A signal emitted when the active selection has been changed. This might happen when the observed widget is resized.
selection | Changed selection |
|
virtual |
Draw a rubber band, depending on rubberBand()
painter | Painter, initialized with a clip region |
Definition at line 637 of file qwt_picker.cpp.
|
virtual |
Draw the tracker
painter | Painter |
Definition at line 732 of file qwt_picker.cpp.
|
protectedvirtual |
Close a selection setting the state to inactive.
The selection is validated and maybe fixed by accept().
ok | If true, complete the selection and emit a selected signal otherwise discard the selection. |
Reimplemented in QwtPlotPicker, QwtPlotZoomer, and QwtPolarPicker.
Definition at line 1291 of file qwt_picker.cpp.
|
overridevirtual |
Event filter.
When isEnabled() is 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 rubber band and tracker up to date.
object | Object to be filtered |
event | Event |
Definition at line 912 of file qwt_picker.cpp.
bool QwtPicker::isActive | ( | ) | const |
A picker is active between begin() and end().
Definition at line 1412 of file qwt_picker.cpp.
bool QwtPicker::isEnabled | ( | ) | const |
Definition at line 400 of file qwt_picker.cpp.
|
protectedvirtual |
Move the last point of the selection The moved() signal is emitted.
pos | New position |
Reimplemented in QwtPlotPicker, and QwtPolarPicker.
Definition at line 1357 of file qwt_picker.cpp.
|
signal |
A signal emitted whenever the last appended point of the selection has been moved.
pos | Position of the moved last point of the selection. |
QWidget * QwtPicker::parentWidget | ( | ) |
Return the parent widget, where the selection happens.
Definition at line 263 of file qwt_picker.cpp.
const QWidget * QwtPicker::parentWidget | ( | ) | const |
Return the parent widget, where the selection happens.
Definition at line 273 of file qwt_picker.cpp.
|
virtual |
Find the area of the observed widget, where selection might happen.
Reimplemented in QwtPolarPicker.
Definition at line 1493 of file qwt_picker.cpp.
|
protected |
Return the points, that have been collected so far. The selection() is calculated from the pickedPoints() in adjustedPoints().
Definition at line 1422 of file qwt_picker.cpp.
|
protectedvirtual |
Remove the last point of the selection The removed() signal is emitted.
Definition at line 1378 of file qwt_picker.cpp.
|
signal |
A signal emitted whenever the last appended point of the selection has been removed.
pos | Position of the point, that has been removed |
|
protectedvirtual |
Reset the state machine and terminate ( end(false) ) the selection
Definition at line 1322 of file qwt_picker.cpp.
QwtPicker::ResizeMode QwtPicker::resizeMode | ( | ) | const |
Definition at line 362 of file qwt_picker.cpp.
QwtPicker::RubberBand QwtPicker::rubberBand | ( | ) | const |
Definition at line 299 of file qwt_picker.cpp.
|
virtual |
Calculate the mask for the rubber band overlay
Definition at line 526 of file qwt_picker.cpp.
|
protected |
Definition at line 1600 of file qwt_picker.cpp.
QPen QwtPicker::rubberBandPen | ( | ) | const |
Definition at line 473 of file qwt_picker.cpp.
|
signal |
A signal emitting the selected points, at the end of a selection.
polygon | Selected points |
QPolygon QwtPicker::selection | ( | ) | const |
Definition at line 792 of file qwt_picker.cpp.
|
slot |
En/disable the picker.
When enabled is true an event filter is installed for the observed widget, otherwise the event filter is removed.
enabled | true or false |
Definition at line 376 of file qwt_picker.cpp.
void QwtPicker::setResizeMode | ( | ResizeMode | mode | ) |
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.
mode | Resize mode |
Definition at line 352 of file qwt_picker.cpp.
void QwtPicker::setRubberBand | ( | RubberBand | rubberBand | ) |
Set the rubber band style
rubberBand | Rubber band style The default value is NoRubberBand. |
Definition at line 290 of file qwt_picker.cpp.
void QwtPicker::setRubberBandPen | ( | const QPen & | pen | ) |
Set the pen for the rubberband
pen | Rubber band pen |
Definition at line 460 of file qwt_picker.cpp.
void QwtPicker::setStateMachine | ( | QwtPickerMachine * | stateMachine | ) |
Set a state machine and delete the previous one
stateMachine | State machine |
Definition at line 230 of file qwt_picker.cpp.
void QwtPicker::setTrackerFont | ( | const QFont & | font | ) |
Set the font for the tracker
font | Tracker font |
Definition at line 411 of file qwt_picker.cpp.
void QwtPicker::setTrackerMode | ( | DisplayMode | mode | ) |
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).
mode | Tracker display mode |
Definition at line 320 of file qwt_picker.cpp.
void QwtPicker::setTrackerPen | ( | const QPen & | pen | ) |
Set the pen for the tracker
pen | Tracker pen |
Definition at line 436 of file qwt_picker.cpp.
QwtPickerMachine * QwtPicker::stateMachine | ( | ) |
Definition at line 248 of file qwt_picker.cpp.
const QwtPickerMachine * QwtPicker::stateMachine | ( | ) | const |
Definition at line 257 of file qwt_picker.cpp.
|
protectedvirtual |
Scale the selection by the ratios of oldSize and newSize The changed() signal is emitted.
oldSize | Previous size |
newSize | Current size |
Definition at line 1436 of file qwt_picker.cpp.
QFont QwtPicker::trackerFont | ( | ) | const |
Definition at line 425 of file qwt_picker.cpp.
|
virtual |
Calculate the mask for the tracker overlay
Definition at line 515 of file qwt_picker.cpp.
QwtPicker::DisplayMode QwtPicker::trackerMode | ( | ) | const |
Definition at line 333 of file qwt_picker.cpp.
|
protected |
Definition at line 1606 of file qwt_picker.cpp.
QPen QwtPicker::trackerPen | ( | ) | const |
Definition at line 449 of file qwt_picker.cpp.
QPoint QwtPicker::trackerPosition | ( | ) | const |
Definition at line 798 of file qwt_picker.cpp.
|
virtual |
Calculate the bounding rectangle for the tracker text from the current position of the tracker
font | Font of the tracker text |
Definition at line 812 of file qwt_picker.cpp.
|
protected |
Calculate the geometry of the tracker that is needed to display information of a specific size at the tracker position
size | Size |
Definition at line 844 of file qwt_picker.cpp.
|
virtual |
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".
pos | Position |
Reimplemented in QwtPlotPicker, and QwtPolarPicker.
Definition at line 491 of file qwt_picker.cpp.
|
protectedvirtual |
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() ).
event | Event |
Definition at line 1195 of file qwt_picker.cpp.
|
protectedvirtual |
Update the state of rubber band and tracker label.
Definition at line 1505 of file qwt_picker.cpp.
|
protectedvirtual |
Handle a enter event for the observed widget.
event | Qt event |
Definition at line 1037 of file qwt_picker.cpp.
|
protectedvirtual |
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.
keyEvent | Key event |
Reimplemented in QwtPlotZoomer.
Definition at line 1131 of file qwt_picker.cpp.
|
protectedvirtual |
Handle a key release event for the observed widget.
Passes the event to the state machine.
keyEvent | Key event |
Definition at line 1183 of file qwt_picker.cpp.
|
protectedvirtual |
Handle a leave event for the observed widget.
event | Qt event |
Definition at line 1051 of file qwt_picker.cpp.
|
protectedvirtual |
Handle mouse double click event for the observed widget.
mouseEvent | Mouse event |
Definition at line 1083 of file qwt_picker.cpp.
|
protectedvirtual |
Handle a mouse move event for the observed widget.
mouseEvent | Mouse event |
Definition at line 1015 of file qwt_picker.cpp.
|
protectedvirtual |
Handle a mouse press event for the observed widget.
mouseEvent | Mouse event |
Definition at line 1001 of file qwt_picker.cpp.
|
protectedvirtual |
Handle a mouse release event for the observed widget.
mouseEvent | Mouse event |
Reimplemented in QwtPlotZoomer.
Definition at line 1069 of file qwt_picker.cpp.
|
protectedvirtual |
Handle a wheel event for the observed widget.
Move the last point of the selection in case of isActive() == true
wheelEvent | Wheel event |
Definition at line 1100 of file qwt_picker.cpp.