QwtPlotPicker provides selections on a plot canvas. More...

#include <qwt_plot_picker.h>

Inheritance diagram for QwtPlotPicker:

Classes
class	PrivateData

Signals
void	selected (const QPointF &pos)
	Signal emitted in case of QwtPickerMachine::PointSelection.

void	selected (const QRectF &rect)
	Signal emitted in case of QwtPickerMachine::RectSelection.

void	selected (const QVector< QPointF > &pa)
	Signal emitting the selected points at the end of a selection.

void	appended (const QPointF &pos)
	Signal emitted when a point has been appended to the selection.

void	moved (const QPointF &pos)
	Signal emitted whenever the last appended point of the selection has been moved.

Signals inherited from QwtPicker
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 Member Functions
	QwtPlotPicker (QWidget *canvas)
	Constructor.

virtual	~QwtPlotPicker ()
	Destructor.

	QwtPlotPicker (QwtAxisId xAxisId, QwtAxisId yAxisId, QWidget *)
	Constructor with axes.

	QwtPlotPicker (QwtAxisId xAxisId, QwtAxisId yAxisId, RubberBand rubberBand, DisplayMode trackerMode, QWidget *)
	Constructor with axes, rubber band and tracker mode.

virtual void	setAxes (QwtAxisId xAxisId, QwtAxisId yAxisId)
	Set the x and y axes.

QwtAxisId	xAxis () const
	Get the x axis.

QwtAxisId	yAxis () const
	Get the y axis.

QwtPlot *	plot ()
	Get the plot widget.

const QwtPlot *	plot () const
	Get the plot widget (const version)

QWidget *	canvas ()
	Get the canvas widget.

const QWidget *	canvas () const
	Get the canvas widget (const version)

Public Member Functions inherited from QwtPicker
	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 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 Member Functions inherited from 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 Member Functions
QRectF	scaleRect () const
	Get the scale rectangle.

QRectF	invTransform (const QRect &) const
	Inverse transform a rectangle.

QRect	transform (const QRectF &) const
	Transform a rectangle.

QPointF	invTransform (const QPoint &) const
	Inverse transform a point.

QPoint	transform (const QPointF &) const
	Transform a point.

virtual QwtText	trackerText (const QPoint &) const override
	Get the tracker text for a point.

virtual QwtText	trackerTextF (const QPointF &) const
	Get the tracker text for a point (floating point)

virtual void	move (const QPoint &) override
	Move the selection.

virtual void	append (const QPoint &) override
	Append a point to the selection.

virtual bool	end (bool ok=true) override
	End the selection.

Protected Member Functions inherited from QwtPicker
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	remove ()
	Remove the last point of the selection The removed() signal is emitted.

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 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.

Additional Inherited Members
Public Types inherited from QwtPicker
enum	RubberBand { NoRubberBand = 0 , HLineRubberBand , VLineRubberBand , CrossRubberBand , RectRubberBand , EllipseRubberBand , PolygonRubberBand , UserRubberBand = 100 }
	Rubber band style. More...

enum	DisplayMode { AlwaysOff , AlwaysOn , ActiveOnly }
	Display mode. More...

enum	ResizeMode { Stretch , KeepSize }
	Controls what to do with the selected points when the observed widget is resized. More...

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 inherited from QwtPicker
void	setEnabled (bool)
	Enable or disable the picker.

Properties inherited from QwtPicker
bool	isEnabled

ResizeMode	resizeMode

DisplayMode	trackerMode

QPen	trackerPen

QFont	trackerFont

RubberBand	rubberBand

QPen	rubberBandPen

Detailed Description

QwtPlotPicker provides selections on a plot canvas.

Constructor & Destructor Documentation

◆ QwtPlotPicker() [1/3]

QwtPlotPicker::QwtPlotPicker ( QWidget * canvas )

explicit

Constructor.

◆ ~QwtPlotPicker()

QwtPlotPicker::~QwtPlotPicker ( )

virtual

Destructor.

◆ QwtPlotPicker() [2/3]

QwtPlotPicker::QwtPlotPicker	(	QwtAxisId	xAxisId,
		QwtAxisId	yAxisId,
		QWidget *	canvas
	)

explicit

Constructor with axes.

◆ QwtPlotPicker() [3/3]

QwtPlotPicker::QwtPlotPicker	(	QwtAxisId	xAxisId,
		QwtAxisId	yAxisId,
		RubberBand	rubberBand,
		DisplayMode	trackerMode,
		QWidget *	canvas
	)

explicit

Constructor with axes, rubber band and tracker mode.

Member Function Documentation

◆ append()

void QwtPlotPicker::append ( const QPoint & pos )

overrideprotectedvirtual

Append a point to the selection.

Append a point to the selection and update rubber band and tracker.

Parameters

pos	Additional point

See also: isActive, begin(), end(), move(), appended()

Note: The appended(const QPoint &), appended(const QDoublePoint &) signals are emitted.

Reimplemented from QwtPicker.

◆ appended

void QwtPlotPicker::appended ( const QPointF & pos )

signal

Signal emitted when a point has been appended to the selection.

◆ canvas() [1/2]

QWidget * QwtPlotPicker::canvas ( )

Get the canvas widget.

◆ canvas() [2/2]

const QWidget * QwtPlotPicker::canvas ( ) const

Get the canvas widget (const version)

◆ end()

bool QwtPlotPicker::end ( bool ok = true )

overrideprotectedvirtual

End the selection.

Close a selection setting the state to inactive.

Parameters

ok	If true, complete the selection and emit selected signals otherwise discard the selection.

Returns: True if the selection has been accepted, false otherwise

Reimplemented from QwtPicker.

Reimplemented in QwtPlotAxisZoomer.

◆ invTransform() [1/2]

QPointF QwtPlotPicker::invTransform ( const QPoint & pos ) const

protected

Inverse transform a point.

Translate a point from pixel into plot coordinates.

Returns: Point in plot coordinates

See also: transform()

◆ invTransform() [2/2]

QRectF QwtPlotPicker::invTransform ( const QRect & rect ) const

protected

Inverse transform a rectangle.

Translate a rectangle from pixel into plot coordinates.

Returns: Rectangle in plot coordinates

See also: transform()

◆ move()

void QwtPlotPicker::move ( const QPoint & pos )

overrideprotectedvirtual

Move the selection.

Move the last point of the selection.

Parameters

pos	New position

See also: isActive, begin(), end(), append()

Note: The moved(const QPoint &), moved(const QDoublePoint &) signals are emitted.

Reimplemented from QwtPicker.

◆ moved

void QwtPlotPicker::moved ( const QPointF & pos )

signal

Signal emitted whenever the last appended point of the selection has been moved.

◆ plot() [1/2]

QwtPlot * QwtPlotPicker::plot ( )

Get the plot widget.

◆ plot() [2/2]

const QwtPlot * QwtPlotPicker::plot ( ) const

Get the plot widget (const version)

◆ scaleRect()

QRectF QwtPlotPicker::scaleRect ( ) const

protected

Get the scale rectangle.

Returns: Normalized bounding rectangle of the axes

See also: QwtPlot::autoReplot(), QwtPlot::replot().

◆ selected [1/3]

void QwtPlotPicker::selected ( const QPointF & pos )

signal

Signal emitted in case of QwtPickerMachine::PointSelection.

◆ selected [2/3]

void QwtPlotPicker::selected ( const QRectF & rect )

signal

Signal emitted in case of QwtPickerMachine::RectSelection.

◆ selected [3/3]

void QwtPlotPicker::selected ( const QVector< QPointF > & pa )

signal

Signal emitting the selected points at the end of a selection.

◆ setAxes()

void QwtPlotPicker::setAxes	(	QwtAxisId	xAxisId,
		QwtAxisId	yAxisId
	)

virtual

Set the x and y axes.

Reimplemented in QwtPlotAxisZoomer.

◆ trackerText()

QwtText QwtPlotPicker::trackerText ( const QPoint & pos ) const

overrideprotectedvirtual

Get the tracker text for a point.

Translate a pixel position into a position string.

Parameters

pos	Position in pixel coordinates

Returns: Position string

Reimplemented from QwtPicker.

◆ trackerTextF()

QwtText QwtPlotPicker::trackerTextF ( const QPointF & pos ) const

protectedvirtual

Get the tracker text for a point (floating point)

Translate a position into a position string.

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 double to string conversion is "%.4f".

Parameters

pos Position

Returns: Position string

◆ transform() [1/2]

QPoint QwtPlotPicker::transform ( const QPointF & pos ) const

protected

Transform a point.

Translate a point from plot into pixel coordinates.

Returns: Point in pixel coordinates

See also: invTransform()

◆ transform() [2/2]

QRect QwtPlotPicker::transform ( const QRectF & rect ) const

protected

Transform a rectangle.

Translate a rectangle from plot into pixel coordinates.

Returns: Rectangle in pixel coordinates

See also: invTransform()

◆ xAxis()

QwtAxisId QwtPlotPicker::xAxis ( ) const

Get the x axis.

◆ yAxis()

QwtAxisId QwtPlotPicker::yAxis ( ) const

Get the y axis.

The documentation for this class was generated from the following files:

/home/runner/work/QWT/QWT/src/plot/qwt_plot_picker.h
/home/runner/work/QWT/QWT/src/plot/qwt_plot_picker.cpp

Classes

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QwtPlotPicker() [1/3]

◆ ~QwtPlotPicker()

◆ QwtPlotPicker() [2/3]

◆ QwtPlotPicker() [3/3]

Member Function Documentation

◆ append()

◆ appended

◆ canvas() [1/2]

◆ canvas() [2/2]

◆ end()

◆ invTransform() [1/2]

◆ invTransform() [2/2]

◆ move()

◆ moved

◆ plot() [1/2]

◆ plot() [2/2]

◆ scaleRect()

◆ selected [1/3]

◆ selected [2/3]

◆ selected [3/3]

◆ setAxes()

◆ trackerText()

◆ trackerTextF()

◆ transform() [1/2]

◆ transform() [2/2]

◆ xAxis()

◆ yAxis()