|
QWT API (中文) 7.3.0
Qt绘图库 - 中文API文档
|
QwtPicker provides selections on a widget 更多...
#include <qwt_picker.h>
类 | |
| class | PrivateData |
Public 类型 | |
| enum | RubberBand { NoRubberBand = 0 , HLineRubberBand , VLineRubberBand , CrossRubberBand , RectRubberBand , EllipseRubberBand , PolygonRubberBand , UserRubberBand = 100 } |
| Rubber band style 更多... | |
| enum | DisplayMode { AlwaysOff , AlwaysOn , ActiveOnly } |
| Display mode 更多... | |
| enum | ResizeMode { Stretch , KeepSize } |
| Controls what to do with the selected points when the observed widget is resized 更多... | |
Public 类型 继承自 QwtEventPattern | |
| enum | MousePatternCode { MouseSelect1 , MouseSelect2 , MouseSelect3 , MouseSelect4 , MouseSelect5 , MouseSelect6 , MousePatternCount } |
| Symbolic mouse input codes 更多... | |
| enum | KeyPatternCode { KeySelect1 , KeySelect2 , KeyAbort , KeyLeft , KeyRight , KeyUp , KeyDown , KeyRedo , KeyUndo , KeyHome , KeyPatternCount } |
| Symbolic keyboard input codes 更多... | |
Public 槽 | |
| void | setEnabled (bool) |
| Enable or disable the picker | |
信号 | |
| void | activated (bool on) |
| Signal indicating when the picker has been activated | |
| void | selected (const QPolygon &polygon) |
| Signal emitting the selected points at the end of a selection | |
| void | appended (const QPoint &pos) |
| Signal emitted when a point has been appended to the selection | |
| void | moved (const QPoint &pos) |
| Signal emitted whenever the last appended point of the selection has been moved | |
| void | removed (const QPoint &pos) |
| Signal emitted whenever the last appended point of the selection has been removed | |
| void | changed (const QPolygon &selection) |
| Signal emitted when the active selection has been changed | |
Public 成员函数 | |
| QwtPicker (QWidget *parent) | |
| Constructor | |
| QwtPicker (RubberBand rubberBand, DisplayMode trackerMode, QWidget *) | |
| void | setStateMachine (QwtPickerMachine *) |
| Set a state machine and delete the previous one | |
| const QwtPickerMachine * | stateMachine () const |
| Return the assigned state machine (const) | |
| QwtPickerMachine * | stateMachine () |
| Return the assigned state machine | |
| void | setRubberBand (RubberBand) |
| Set the rubber band style | |
| RubberBand | rubberBand () const |
| Return the rubber band style | |
| void | setTrackerMode (DisplayMode) |
| Set the display mode of the tracker | |
| DisplayMode | trackerMode () const |
| Return the tracker display mode | |
| void | setResizeMode (ResizeMode) |
| Set the resize mode | |
| ResizeMode | resizeMode () const |
| Return the resize mode | |
| void | setRubberBandPen (const QPen &) |
| Set the pen for the rubber band | |
| QPen | rubberBandPen () const |
| Return the rubber band pen | |
| void | setTrackerPen (const QPen &) |
| Set the pen for the tracker | |
| QPen | trackerPen () const |
| Return the tracker pen | |
| void | setTrackerFont (const QFont &) |
| Set the font for the tracker | |
| QFont | trackerFont () const |
| Return the tracker font | |
| bool | isEnabled () const |
| Return true when enabled, false otherwise | |
| bool | isActive () const |
| A picker is active between begin() and end() | |
| virtual bool | eventFilter (QObject *, QEvent *) override |
| Event filter for handling events | |
| QWidget * | parentWidget () |
| Return the parent widget, where the selection happens | |
| const QWidget * | parentWidget () const |
| Return the parent widget, where the selection happens (const) | |
| virtual QPainterPath | pickArea () const |
| Find the area of the observed widget, where selection might happen | |
| virtual void | drawRubberBand (QPainter *) const |
| Draw a rubber band, depending on rubberBand() | |
| virtual void | drawTracker (QPainter *) const |
| Draw the tracker | |
| virtual QRegion | trackerMask () const |
| Calculate the mask for the tracker overlay | |
| virtual QRegion | rubberBandMask () const |
| Calculate the mask for the rubber band overlay | |
| virtual QwtText | trackerText (const QPoint &pos) const |
| Return the label for a position | |
| virtual QRect | trackerRect (const QFont &) const |
| Calculate the bounding rectangle for the tracker text from the current position of the tracker | |
| virtual void | setTrackerPosition (const QPoint &pos) |
| Set the tracker position manually | |
| QPoint | trackerPosition () const |
| Return the current position of the tracker | |
| QPolygon | selection () const |
| Return the selected points | |
| void | update () |
| void | setActive (bool on) |
Public 成员函数 继承自 QwtEventPattern | |
| QwtEventPattern () | |
| Constructor | |
| virtual | ~QwtEventPattern () |
| Destructor | |
| void | initMousePattern (int numButtons) |
| Set default mouse patterns depending on the number of mouse buttons | |
| void | initKeyPattern () |
| Set default key patterns | |
| void | setMousePattern (MousePatternCode, Qt::MouseButton button, Qt::KeyboardModifiers=Qt::NoModifier) |
| Change one mouse pattern | |
| void | setKeyPattern (KeyPatternCode, int key, Qt::KeyboardModifiers modifiers=Qt::NoModifier) |
| Change one key pattern | |
| 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 |
| Return the mouse pattern vector | |
| const QVector< KeyPattern > & | keyPattern () const |
| Return the key pattern vector | |
| QVector< MousePattern > & | mousePattern () |
| Return the mouse pattern vector | |
| QVector< KeyPattern > & | keyPattern () |
| Return the key pattern vector | |
| 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 成员函数 | |
| virtual QPolygon | adjustedPoints (const QPolygon &) const |
| Map the pickedPoints() into a selection() | |
| virtual void | transition (const QEvent *) |
| Passes an event to the state machine and executes the resulting commands. | |
| virtual void | begin () |
| Open a selection setting the state to active | |
| virtual void | append (const QPoint &) |
| Append a point to the selection and update rubber band and tracker. | |
| virtual void | move (const QPoint &) |
| Move the last point of the selection The moved() signal is emitted. | |
| virtual void | remove () |
| Remove the last point of the selection The removed() signal is emitted. | |
| 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 () |
| Reset the state machine and terminate ( end(false) ) the selection | |
| virtual void | widgetMousePressEvent (QMouseEvent *) |
| Handle a mouse press event for the observed widget. | |
| virtual void | widgetMouseReleaseEvent (QMouseEvent *) |
| Handle a mouse release event for the observed widget. | |
| virtual void | widgetMouseDoubleClickEvent (QMouseEvent *) |
| Handle mouse double click event for the observed widget. | |
| virtual void | widgetMouseMoveEvent (QMouseEvent *) |
| Handle a mouse move event for the observed widget. | |
| virtual void | widgetWheelEvent (QWheelEvent *) |
| Handle a wheel event for the observed widget. | |
| virtual void | widgetKeyPressEvent (QKeyEvent *) |
| Handle a key press event for the observed widget. | |
| virtual void | widgetKeyReleaseEvent (QKeyEvent *) |
| Handle a key release event for the observed widget. | |
| virtual void | widgetEnterEvent (QEvent *) |
| Handle a enter event for the observed widget. | |
| virtual void | widgetLeaveEvent (QEvent *) |
| Handle a leave event for the observed widget. | |
| virtual void | stretchSelection (const QSize &oldSize, const QSize &newSize) |
| Scale the selection by the ratios of oldSize and newSize The changed() signal is emitted. | |
| virtual void | updateDisplay () |
| Update the state of rubber band and tracker label | |
| const QwtWidgetOverlay * | rubberBandOverlay () const |
| Return the overlay displaying the rubber band | |
| const QwtWidgetOverlay * | trackerOverlay () const |
| Return the overlay displaying the tracker text | |
| const QPolygon & | pickedPoints () const |
| Return the points that have been collected so far | |
Protected 成员函数 继承自 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. | |
属性 | |
| bool | isEnabled |
| ResizeMode | resizeMode |
| DisplayMode | trackerMode |
| QPen | trackerPen |
| QFont | trackerFont |
| RubberBand | rubberBand |
| QPen | rubberBandPen |
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)
Display mode
| 枚举值 | |
|---|---|
| AlwaysOff | Display never |
| AlwaysOn | Display always |
| ActiveOnly | Display only when the selection is active |
Controls what to do with the selected points when the observed widget is resized
The default value is QwtPicker::Stretch.
| 枚举值 | |
|---|---|
| Stretch | All points are scaled according to the new size, |
| KeepSize | All points remain unchanged. |
Rubber band style
The default value is QwtPicker::NoRubberBand.
| 枚举值 | |
|---|---|
| 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 |
|
explicit |
Constructor
Creates a picker that is enabled, but without a state machine. Rubber band and tracker are disabled.
| parent | Parent widget, that will be observed |
Constructor
| rubberBand | Rubber band style |
| trackerMode | Tracker mode |
| parent | Parent widget, that will be observed |
Destructor
|
protectedvirtual |
Validate and fix up the selection
Accepts all selections unmodified
| selection | Selection to validate and fix up |
被 QwtPlotAxisZoomer , 以及 QwtPlotCanvasZoomer 重载.
|
signal |
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.:
| points | Selected points |
|
protectedvirtual |
Append a point to the selection and update rubber band and tracker.
The appended() signal is emitted.
| pos | Additional point |
被 QwtPlotPicker , 以及 QwtPolarPicker 重载.
|
signal |
|
protectedvirtual |
Open a selection setting the state to active
被 QwtPlotAxisZoomer , 以及 QwtPlotCanvasZoomer 重载.
|
signal |
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 |
被 QwtPlotSeriesDataPicker 重载.
|
virtual |
|
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. |
被 QwtPlotAxisZoomer, QwtPlotCanvasZoomer, QwtPlotPanner, QwtPlotPicker , 以及 QwtPolarPicker 重载.
|
overridevirtual |
Event filter for handling events
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 |
| bool QwtPicker::isActive | ( | ) | const |
| bool QwtPicker::isEnabled | ( | ) | const |
|
protectedvirtual |
Move the last point of the selection The moved() signal is emitted.
| pos | New position |
被 QwtPlotPanner, QwtPlotPicker, QwtPolarPicker , 以及 QwtPlotSeriesDataPicker 重载.
|
signal |
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
| const QWidget * QwtPicker::parentWidget | ( | ) | const |
Return the parent widget, where the selection happens (const)
|
virtual |
Find the area of the observed widget, where selection might happen
|
protected |
Return the points that have been collected so far
The selection() is calculated from the pickedPoints() in adjustedPoints().
|
protectedvirtual |
|
signal |
Signal emitted whenever the last appended point of the selection has been removed
| pos | Position of the point that has been removed |
| QwtPicker::ResizeMode QwtPicker::resizeMode | ( | ) | const |
| QwtPicker::RubberBand QwtPicker::rubberBand | ( | ) | const |
|
virtual |
Calculate the mask for the rubber band overlay
|
protected |
Return the overlay displaying the rubber band
| QPen QwtPicker::rubberBandPen | ( | ) | const |
|
signal |
Signal emitting the selected points at the end of a selection
| polygon | Selected points |
| QPolygon QwtPicker::selection | ( | ) | const |
|
slot |
Enable or 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 |
| 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 |
| void QwtPicker::setRubberBand | ( | RubberBand | rubberBand | ) |
Set the rubber band style
The default value is NoRubberBand.
| rubberBand | Rubber band style |
| void QwtPicker::setRubberBandPen | ( | const QPen & | pen | ) |
| void QwtPicker::setStateMachine | ( | QwtPickerMachine * | stateMachine | ) |
| void QwtPicker::setTrackerFont | ( | const QFont & | font | ) |
| 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 |
| void QwtPicker::setTrackerPen | ( | const QPen & | pen | ) |
|
virtual |
Set the tracker position manually
Normally this does not need to be called, but sometimes you may want to display the picker without a mouse.
| pos | Position to set |
被 QwtPlotSeriesDataPicker 重载.
| QwtPickerMachine * QwtPicker::stateMachine | ( | ) |
| const QwtPickerMachine * QwtPicker::stateMachine | ( | ) | const |
|
protectedvirtual |
Scale the selection by the ratios of oldSize and newSize The changed() signal is emitted.
| oldSize | Previous size |
| newSize | Current size |
| QFont QwtPicker::trackerFont | ( | ) | const |
|
virtual |
Calculate the mask for the tracker overlay
| QwtPicker::DisplayMode QwtPicker::trackerMode | ( | ) | const |
|
protected |
Return the overlay displaying the tracker text
| QPen QwtPicker::trackerPen | ( | ) | const |
| QPoint QwtPicker::trackerPosition | ( | ) | const |
Return the current position of the tracker
|
virtual |
Calculate the bounding rectangle for the tracker text from the current position of the tracker
| font | Font of the tracker text |
被 QwtPlotSeriesDataPicker 重载.
|
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 |
被 QwtPlotPicker, QwtPolarPicker , 以及 QwtPlotSeriesDataPicker 重载.
|
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 |
|
protectedvirtual |
Handle a enter event for the observed widget.
| event | Qt event |
|
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 |
被 QwtPlotAxisZoomer , 以及 QwtPlotCanvasZoomer 重载.
|
protectedvirtual |
Handle a key release event for the observed widget.
Passes the event to the state machine.
| keyEvent | Key event |
|
protectedvirtual |
Handle a leave event for the observed widget.
| event | Qt event |
|
protectedvirtual |
Handle mouse double click event for the observed widget.
| mouseEvent | Mouse event |
被 QwtPlotSeriesDataPicker 重载.
|
protectedvirtual |
Handle a mouse move event for the observed widget.
| mouseEvent | Mouse event |
|
protectedvirtual |
Handle a mouse press event for the observed widget.
| mouseEvent | Mouse event |
被 QwtPlotSeriesDataPicker , 以及 QwtPlotPanner 重载.
|
protectedvirtual |
Handle a mouse release event for the observed widget.
| mouseEvent | Mouse event |
被 QwtPlotAxisZoomer , 以及 QwtPlotCanvasZoomer 重载.
|
protectedvirtual |
Handle a wheel event for the observed widget.
Move the last point of the selection in case of isActive() == true
| wheelEvent | Wheel event |