QwtPlotMarker(3)

📦
version 6.3.0 · 6 versions
, in alpine 3.24

💅 QwtPlotMarker(3) — Library Functions Manual 💅

okay so bestie, welcome to the QwtPlotMarker(3) page. This is the manual for the QwtPlotMarker class, and it is lowkey iconic. Let’s unpack it together, no cap.

💖 NAME 💖

QwtPlotMarker — a class for drawing markers. Periodt.

✨ SYNOPSIS ✨

#include <qwt_plot_marker.h>

Inherits QwtPlotItem.

🎀 Public Types 🎀

  • enum LineStyle { NoLine, HLine, VLine, Cross } — the line styles, bestie.

🌈 Public Types inherited from QwtPlotItem 🌈

  • enum RttiValues { Rtti_PlotItem = 0, Rtti_PlotGrid, Rtti_PlotScale, Rtti_PlotLegend, Rtti_PlotMarker, Rtti_PlotCurve, Rtti_PlotSpectroCurve, Rtti_PlotIntervalCurve, Rtti_PlotHistogram, Rtti_PlotSpectrogram, Rtti_PlotGraphic, Rtti_PlotTradingCurve, Rtti_PlotBarChart, Rtti_PlotMultiBarChart, Rtti_PlotShape, Rtti_PlotTextLabel, Rtti_PlotZone, Rtti_PlotVectorField, Rtti_PlotUserItem = 1000 } — runtime type information.
  • enum ItemAttribute { Legend = 0x01, AutoScale = 0x02, Margins = 0x04 } — plot item attributes.
  • enum ItemInterest { ScaleInterest = 0x01, LegendInterest = 0x02 } — plot item interests.
  • enum RenderHint { RenderAntialiased = 0x1 } — render hints.
  • typedef QFlags< ItemAttribute > ItemAttributes
  • typedef QFlags< ItemInterest > ItemInterests
  • typedef QFlags< RenderHint > RenderHints

🦋 Public Member Functions 🦋

  • QwtPlotMarker () — sets alignment to Qt::AlignCenter, and style to QwtPlotMarker::NoLine.
  • QwtPlotMarker (const QString &title) — sets alignment to Qt::AlignCenter, and style to QwtPlotMarker::NoLine.
  • QwtPlotMarker (const QwtText &title) — sets alignment to Qt::AlignCenter, and style to QwtPlotMarker::NoLine.
  • virtual ~QwtPlotMarker () — destructor.
  • virtual int rtti () const override
  • double xValue () const — returns the x value.
  • double yValue () const — returns the y value.
  • QPointF value () const — returns the value.
  • void setXValue (double) — sets the X value.
  • void setYValue (double) — sets the Y value.
  • void setValue (double, double) — sets the value.
  • void setValue (const QPointF &) — sets the value.
  • void setLineStyle (LineStyle) — sets the line style.
  • LineStyle lineStyle () const
  • void setLinePen (const QColor &, qreal width=0.0, Qt::PenStyle=Qt::SolidLine)
  • void setLinePen (const QPen &)
  • const QPen & linePen () const
  • void setSymbol (const QwtSymbol *) — assigns a symbol.
  • const QwtSymbol * symbol () const
  • void setLabel (const QwtText &) — sets the label.
  • QwtText label () const
  • void setLabelAlignment (Qt::Alignment) — sets the alignment of the label.
  • Qt::Alignment labelAlignment () const
  • void setLabelOrientation (Qt::Orientation) — sets the orientation of the label.
  • Qt::Orientation labelOrientation () const
  • void setSpacing (int) — sets the spacing.
  • int spacing () const
  • virtual void draw (QPainter *, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &) const override
  • virtual QRectF boundingRect () const override
  • virtual QwtGraphic legendIcon (int index, const QSizeF &) const override

💜 Public Member Functions inherited from QwtPlotItem 💜

  • QwtPlotItem ()
  • QwtPlotItem (const QString &title)
  • QwtPlotItem (const QwtText &title)
  • virtual ~QwtPlotItem () — destroys the QwtPlotItem.
  • void attach (QwtPlot *plot) — attaches the item to a plot.
  • void detach () — this method detaches a QwtPlotItem from any QwtPlot it has been associated with.
  • QwtPlot * plot () const — returns the attached plot.
  • void setTitle (const QString &title)
  • void setTitle (const QwtText &title)
  • const QwtText & title () const
  • void setItemAttribute (ItemAttribute, bool on=true)
  • bool testItemAttribute (ItemAttribute) const
  • void setItemInterest (ItemInterest, bool on=true)
  • bool testItemInterest (ItemInterest) const
  • void setRenderHint (RenderHint, bool on=true)
  • bool testRenderHint (RenderHint) const
  • void setRenderThreadCount (uint numThreads)
  • uint renderThreadCount () const
  • void setLegendIconSize (const QSize &)
  • QSize legendIconSize () const
  • double z () const
  • void setZ (double z) — sets the z value.
  • void show () — shows the item.
  • void hide () — hides the item.
  • virtual void setVisible (bool)
  • bool isVisible () const
  • void setAxes (QwtAxisId xAxis, QwtAxisId yAxis)
  • void setXAxis (QwtAxisId)
  • QwtAxisId xAxis () const — returns xAxis.
  • void setYAxis (QwtAxisId)
  • QwtAxisId yAxis () const — returns yAxis.
  • virtual void itemChanged ()
  • virtual void legendChanged ()
  • virtual void getCanvasMarginHint (const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect, double &left, double &top, double &right, double &bottom) const — calculates a hint for the canvas margin.
  • virtual void updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &) — updates the item to changes of the axes scale division.
  • virtual void updateLegend (const QwtPlotItem *, const QList< QwtLegendData > &) — updates the item to changes of the legend info.
  • QRectF scaleRect (const QwtScaleMap &, const QwtScaleMap &) const — calculates the bounding scale rectangle of 2 maps.
  • QRectF paintRect (const QwtScaleMap &, const QwtScaleMap &) const — calculates the bounding paint rectangle of 2 maps.
  • virtual QList< QwtLegendData > legendData () const — returns all information that is needed to represent the item on the legend.

🌸 Protected Member Functions 🌸

  • virtual void drawLines (QPainter *, const QRectF &, const QPointF &) const
  • virtual void drawSymbol (QPainter *, const QRectF &, const QPointF &) const
  • virtual void drawLabel (QPainter *, const QRectF &, const QPointF &) const

🧚 Protected Member Functions inherited from QwtPlotItem 🧚

  • QwtGraphic defaultIcon (const QBrush &, const QSizeF &) const — returns a default icon from a brush.

🦋 Detailed Description 🦋

A class for drawing markers.

A marker can be a horizontal line, a vertical line, a symbol, a label or any combination of them, which can be drawn around a center point inside a bounding rectangle.

The setSymbol() member assigns a symbol to the marker. The symbol is drawn at the specified point.

With setLabel(), a label can be assigned to the marker. The setLabelAlignment() member specifies where the label is drawn. All the Align*-constants in Qt::AlignmentFlags (see Qt documentation) are valid. The interpretation of the alignment depends on the marker's line style. The alignment refers to the center point of the marker, which means, for example, that the label would be printed left above the center point if the alignment was set to Qt::AlignLeft | Qt::AlignTop.

Note: QwtPlotTextLabel is intended to align a text label according to the geometry of canvas ( unrelated to plot coordinates )

Definition at line 45 of file qwt_plot_marker.h.

🎀 Member Enumeration Documentation 🎀

enum QwtPlotMarker::LineStyle

Line styles, bestie.

See also setLineStyle(), lineStyle().

Enumerator:

  • NoLine — no line.
  • HLine — a horizontal line.
  • VLine — a vertical line.
  • Cross — a crosshair.

Definition at line 53 of file qwt_plot_marker.h.

🌟 Constructor & Destructor Documentation 🌟

QwtPlotMarker::QwtPlotMarker () [explicit]

Sets alignment to Qt::AlignCenter, and style to QwtPlotMarker::NoLine.

Definition at line 53 of file qwt_plot_marker.cpp.

QwtPlotMarker::QwtPlotMarker (const QString & title) [explicit]

Sets alignment to Qt::AlignCenter, and style to QwtPlotMarker::NoLine.

Definition at line 60 of file qwt_plot_marker.cpp.

QwtPlotMarker::QwtPlotMarker (const QwtText & title) [explicit]

Sets alignment to Qt::AlignCenter, and style to QwtPlotMarker::NoLine.

Definition at line 68 of file qwt_plot_marker.cpp.

QwtPlotMarker::~QwtPlotMarker () [virtual]

Destructor.

Definition at line 76 of file qwt_plot_marker.cpp.

💖 Member Function Documentation 💖

Okay bestie, this is the part where we meet every single member function. No skipping, no cap. 💅

✨ QRectF QwtPlotMarker::boundingRect () const [override], [virtual] ✨

Returns: an invalid bounding rect, literally QRectF(1.0, 1.0, -2.0, -2.0). It's giving “I have no box” energy.

Note: a width or height < 0.0 is ignored by the autoscaler.
  • Reimplemented from: QwtPlotItem.
  • Definition at line 572 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::draw (QPainter * painter, const QwtScaleMap & xMap, const QwtScaleMap & yMap, const QRectF & canvasRect) const [override], [virtual] ✨

Draw the marker. Main-character render call, fr fr.

  • Parameters:
    • painter — Painter.
    • xMap — x Scale Map.
    • yMap — y Scale Map.
    • canvasRect — Contents rectangle of the canvas in painter coordinates.
  • Implements: QwtPlotItem.
  • Definition at line 142 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::drawLabel (QPainter * painter, const QRectF & canvasRect, const QPointF & pos) const [protected], [virtual] ✨

Align and draw the text label of the marker.

  • Parameters:
    • painter — Painter.
    • canvasRect — Contents rectangle of the canvas in painter coordinates.
    • pos — Position of the marker, translated into widget coordinates.
  • See also: drawLabel(), drawSymbol().
  • Definition at line 232 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::drawLines (QPainter * painter, const QRectF & canvasRect, const QPointF & pos) const [protected], [virtual] ✨

Draw the lines marker.

  • Parameters:
    • painter — Painter.
    • canvasRect — Contents rectangle of the canvas in painter coordinates.
    • pos — Position of the marker, translated into widget coordinates.
  • See also: drawLabel(), drawSymbol().
  • Definition at line 163 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::drawSymbol (QPainter * painter, const QRectF & canvasRect, const QPointF & pos) const [protected], [virtual] ✨

Draw the symbol of the marker.

  • Parameters:
    • painter — Painter.
    • canvasRect — Contents rectangle of the canvas in painter coordinates.
    • pos — Position of the marker, translated into widget coordinates.
  • See also: drawLabel(), QwtSymbol::drawSymbol().
  • Definition at line 203 of file qwt_plot_marker.cpp.

✨ QwtText QwtPlotMarker::label () const ✨

  • Returns: the label.
  • See also: setLabel().
  • Definition at line 433 of file qwt_plot_marker.cpp.

✨ Qt::Alignment QwtPlotMarker::labelAlignment () const ✨

  • Returns: the label alignment.
  • See also: setLabelAlignment(), setLabelOrientation().
  • Definition at line 465 of file qwt_plot_marker.cpp.

✨ Qt::Orientation QwtPlotMarker::labelOrientation () const ✨

  • Returns: the label orientation.
  • See also: setLabelOrientation(), labelAlignment().
  • Definition at line 493 of file qwt_plot_marker.cpp.

✨ QwtGraphic QwtPlotMarker::legendIcon (int index, const QSizeF & size) const [override], [virtual] ✨

  • Returns: Icon representing the marker on the legend.
  • Parameters:
    • index — Index of the legend entry ( usually there is only one ).
    • size — Icon size.
  • See also: setLegendIconSize(), legendData().
  • Reimplemented from: QwtPlotItem.
  • Definition at line 598 of file qwt_plot_marker.cpp.

✨ const QPen & QwtPlotMarker::linePen () const ✨

  • Returns: the line pen.
  • See also: setLinePen().
  • Definition at line 567 of file qwt_plot_marker.cpp.

✨ QwtPlotMarker::LineStyle QwtPlotMarker::lineStyle () const ✨

  • Returns: the line style.
  • See also: setLineStyle().
  • Definition at line 381 of file qwt_plot_marker.cpp.

✨ int QwtPlotMarker::rtti () const [override], [virtual] ✨

  • Returns: QwtPlotItem::Rtti_PlotMarker.
  • Reimplemented from: QwtPlotItem.
  • Definition at line 82 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setLabel (const QwtText & label) ✨

Set the label.

  • Parameters:
    • label — Label text.
  • See also: label().
  • Definition at line 420 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setLabelAlignment (Qt::Alignment align) ✨

Set the alignment of the label. In case of QwtPlotMarker::HLine the alignment is relative to the y position of the marker, but the horizontal flags correspond to the canvas rectangle. In case of QwtPlotMarker::VLine the alignment is relative to the x position of the marker, but the vertical flags correspond to the canvas rectangle.

In all other styles the alignment is relative to the marker's position.

  • Parameters:
    • align — Alignment.
  • See also: labelAlignment(), labelOrientation().
  • Definition at line 452 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setLabelOrientation (Qt::Orientation orientation) ✨

Set the orientation of the label. When orientation is Qt::Vertical the label is rotated by 90.0 degrees ( from bottom to top ).

  • Parameters:
    • orientation — Orientation of the label.
  • See also: labelOrientation(), setLabelAlignment().
  • Definition at line 480 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setLinePen (const QColor & color, qreal width = 0.0, Qt::PenStyle style = Qt::SolidLine) ✨

Build and assign a line pen.

In Qt5 the default pen width is 1.0 ( 0.0 in Qt4 ) what makes it non cosmetic ( see QPen::isCosmetic() ). This method has been introduced to hide this incompatibility.

  • Parameters:
    • color — Pen color.
    • width — Pen width.
    • style — Pen style.
  • See also: pen(), brush().
  • Definition at line 541 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setLinePen (const QPen & pen) ✨

Specify a pen for the line.

  • Parameters:
    • pen — New pen.
  • See also: linePen().
  • Definition at line 552 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setLineStyle (LineStyle style) ✨

Set the line style.

  • Parameters:
    • style — Line style.
  • See also: lineStyle().
  • Definition at line 366 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setSpacing (int spacing) ✨

Set the spacing. When the label is not centered on the marker position, the spacing is the distance between the position and the label.

  • Parameters:
    • spacing — Spacing.
  • See also: spacing(), setLabelAlignment().
  • Definition at line 507 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setSymbol (const QwtSymbol * symbol) ✨

Assign a symbol.

  • Parameters:
    • symbol — New symbol.
  • See also: symbol().
  • Definition at line 391 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setValue (const QPointF & pos) ✨

Set Value.

  • Definition at line 106 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setValue (double x, double y) ✨

Set Value.

  • Definition at line 112 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setXValue (double x) ✨

Set X Value.

  • Definition at line 123 of file qwt_plot_marker.cpp.

✨ void QwtPlotMarker::setYValue (double y) ✨

Set Y Value.

  • Definition at line 129 of file qwt_plot_marker.cpp.

✨ int QwtPlotMarker::spacing () const ✨

  • Returns: the spacing.
  • See also: setSpacing().
  • Definition at line 523 of file qwt_plot_marker.cpp.

✨ const QwtSymbol * QwtPlotMarker::symbol () const ✨

  • Returns: the symbol.
  • See also: setSymbol(), QwtSymbol.
  • Definition at line 410 of file qwt_plot_marker.cpp.

✨ QPointF QwtPlotMarker::value () const ✨

Return Value.

  • Definition at line 88 of file qwt_plot_marker.cpp.

✨ double QwtPlotMarker::xValue () const ✨

Return x Value.

  • Definition at line 94 of file qwt_plot_marker.cpp.

✨ double QwtPlotMarker::yValue () const ✨

Return y Value.

  • Definition at line 100 of file qwt_plot_marker.cpp.

👑 Author 👑

Generated automatically by Doxygen for the Qwt User's Guide from the source code. That's the whole author vibe, bestie. 🫶

Signing off from the Qwt User's Guide, QwtPlotMarker(3) edition — Doxygen generated this from the source code, and there's no date on the footer, so we're just gonna vibe with that. 💅🎀✨

📦 where this page comes from