QWT API (English) 7.3.0
Qt Widget Library for Technical Applications - English API Documentation
Loading...
Searching...
No Matches
Classes | Signals | Public Member Functions | Protected Member Functions | List of all members
QwtPolarPicker Class Reference

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

#include <qwt_polar_picker.h>

Inheritance diagram for QwtPolarPicker:
QwtPicker QwtEventPattern

Classes

class  PrivateData
 

Signals

void selected (const QwtPointPolar &pos)
 A signal emitted in case of selectionFlags() & PointSelection.
 
void selected (const QVector< QwtPointPolar > &points)
 A signal emitting the selected points, at the end of a selection.
 
void appended (const QwtPointPolar &pos)
 A signal emitted when a point has been appended to the selection.
 
void moved (const QwtPointPolar &pos)
 A 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

 QwtPolarPicker (QwtPolarCanvas *)
 Constructor.
 
 ~QwtPolarPicker () override
 Destructor.
 
 QwtPolarPicker (RubberBand rubberBand, DisplayMode trackerMode, QwtPolarCanvas *)
 Constructor with rubber band and tracker mode.
 
QwtPolarPlotplot ()
 Get the plot.
 
const QwtPolarPlotplot () const
 Get the plot (const version)
 
QwtPolarCanvascanvas ()
 Get the canvas.
 
const QwtPolarCanvascanvas () const
 Get the canvas (const version)
 
virtual QRect pickRect () const
 Get the pick rectangle.
 
- 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 QwtPickerMachinestateMachine () const
 Return the assigned state machine (const)
 
QwtPickerMachinestateMachine ()
 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 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

QwtPointPolar invTransform (const QPoint &) const
 Inverse transform a point.
 
virtual QwtText trackerText (const QPoint &) const override
 Get the tracker text.
 
virtual QwtText trackerTextPolar (const QwtPointPolar &) const
 Get the tracker text for a polar 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 QwtWidgetOverlayrubberBandOverlay () const
 Return the overlay displaying the rubber band.
 
const QwtWidgetOverlaytrackerOverlay () 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

QwtPolarPicker provides selections on a plot canvas.

QwtPolarPicker is a QwtPicker tailored for selections on a polar plot canvas.

Constructor & Destructor Documentation

◆ QwtPolarPicker()

QwtPolarPicker::QwtPolarPicker ( QwtPolarCanvas canvas)
explicit

Constructor.

Create a polar plot picker.

Parameters
canvasPlot canvas to observe, also the parent object

Create a plot picker with rubber band and tracker mode

Parameters
rubberBandRubberband style
trackerModeTracker mode
canvasPlot canvas to observe, also the parent object
See also
QwtPicker, QwtPicker::setSelectionFlags(), QwtPicker::setRubberBand(), QwtPicker::setTrackerMode, QwtPolarPlot::autoReplot(), QwtPolarPlot::replot()

Destructor

Member Function Documentation

◆ append()

void QwtPolarPicker::append ( const QPoint &  pos)
overrideprotectedvirtual

Append a point to the selection.

Append a point to the selection and update rubberband and tracker.

Parameters
posAdditional point
See also
isActive, begin(), end(), move(), appended()
Note
The appended(const QPoint &), appended(const QDoublePoint &) signals are emitted.

Reimplemented from QwtPicker.

◆ appended

void QwtPolarPicker::appended ( const QwtPointPolar pos)
signal

A signal emitted when a point has been appended to the selection.

Parameters
posPosition of the appended point
See also
append(), moved()

◆ canvas() [1/2]

QwtPolarCanvas * QwtPolarPicker::canvas ( )

Get the canvas.

Get the observed plot canvas.

Returns
Observed plot canvas

◆ canvas() [2/2]

const QwtPolarCanvas * QwtPolarPicker::canvas ( ) const

Get the canvas (const version)

Get the observed plot canvas (const version)

Returns
Observed plot canvas

◆ end()

bool QwtPolarPicker::end ( bool  ok = true)
overrideprotectedvirtual

End the selection.

Close a selection setting the state to inactive.

Parameters
okIf true, complete the selection and emit selected signals otherwise discard the selection.
Returns
true if the selection is accepted, false otherwise

Reimplemented from QwtPicker.

◆ invTransform()

QwtPointPolar QwtPolarPicker::invTransform ( const QPoint &  pos) const
protected

Inverse transform a point.

Translate a point from widget into plot coordinates.

Parameters
posPoint in widget coordinates of the plot canvas
Returns
Point in plot coordinates
See also
transform(), canvas()

◆ move()

void QwtPolarPicker::move ( const QPoint &  pos)
overrideprotectedvirtual

Move the selection.

Move the last point of the selection.

Parameters
posNew position
See also
isActive, begin(), end(), append()
Note
The moved(const QPoint &), moved(const QDoublePoint &) signals are emitted.

Reimplemented from QwtPicker.

◆ moved

void QwtPolarPicker::moved ( const QwtPointPolar pos)
signal

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

Parameters
posPosition of the moved last point of the selection
See also
move(), appended()

◆ pickRect()

QRect QwtPolarPicker::pickRect ( ) const
virtual

Get the pick rectangle.

Get the bounding rectangle of the region where picking is supported.

Returns
Bounding rectangle of the region, where picking is supported

◆ plot() [1/2]

QwtPolarPlot * QwtPolarPicker::plot ( )

Get the plot.

Get the plot widget containing the observed plot canvas.

Returns
Plot widget, containing the observed plot canvas

◆ plot() [2/2]

const QwtPolarPlot * QwtPolarPicker::plot ( ) const

Get the plot (const version)

Get the plot widget containing the observed plot canvas (const version)

Returns
Plot widget, containing the observed plot canvas

◆ selected [1/2]

void QwtPolarPicker::selected ( const QVector< QwtPointPolar > &  points)
signal

A signal emitting the selected points, at the end of a selection.

Parameters
pointsSelected points

◆ selected [2/2]

void QwtPolarPicker::selected ( const QwtPointPolar pos)
signal

A signal emitted in case of selectionFlags() & PointSelection.

Parameters
posSelected point

◆ trackerText()

QwtText QwtPolarPicker::trackerText ( const QPoint &  pos) const
overrideprotectedvirtual

Get the tracker text.

Translate a pixel position into a position string.

Parameters
posPosition in pixel coordinates
Returns
Position string

Reimplemented from QwtPicker.

◆ trackerTextPolar()

QwtText QwtPolarPicker::trackerTextPolar ( const QwtPointPolar pos) const
protectedvirtual

Get the tracker text for a polar 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
posPosition
Returns
Position string

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