QwtPlotPanner(3)

💅 QwtPlotPanner(3) — Library Functions Manual ✨

okay bestie, buckle up 🫶 this is the QwtPlotPanner(3) page, and it’s lowkey iconic for anyone who wants to pan around a plot canvas like a main character.

🌸 NAME 🌸

QwtPlotPanner — QwtPlotPanner provides panning of a plot canvas.

---

✨ SYNOPSIS ✨

#include <qwt_plot_panner.h>

Inherits QwtPanner.

🎀 Public Slots 🎀

• virtual void moveCanvas (int dx, int dy) — public slot signature; the full tea is in the moveCanvas docs below 👇

👑 Public Member Functions 👑

• QwtPlotPanner (QWidget *) — A panner for the canvas of a QwtPlot.
• virtual ~QwtPlotPanner () — Destructor.
• QWidget * canvas () — Return observed plot canvas.
• const QWidget * canvas () const — Return Observed plot canvas.
• QwtPlot * plot () — Return plot widget, containing the observed plot canvas.
• const QwtPlot * plot () const — Return plot widget, containing the observed plot canvas.
• void setAxisEnabled (QwtAxisId axisId, bool on) — En/Disable an axis.
• bool isAxisEnabled (QwtAxisId) const — signature only in the source, no extra one-liner here.

👑 Public Member Functions inherited from QwtPanner 👑

• QwtPanner (QWidget *parent) — constructor signature; the source doesn’t add an extra description.
• virtual ~QwtPanner () — Destructor.
• void setEnabled (bool) — En/disable the panner.
• bool isEnabled () const — signature only in the source.
• void setMouseButton (Qt::MouseButton, Qt::KeyboardModifiers=Qt::NoModifier) — signature only in the source.
• void getMouseButton (Qt::MouseButton &button, Qt::KeyboardModifiers &) const — Get mouse button and modifiers used for panning.
• void setAbortKey (int key, Qt::KeyboardModifiers=Qt::NoModifier) — signature only in the source.
• void getAbortKey (int &key, Qt::KeyboardModifiers &) const — Get the abort key and modifiers.
• void setCursor (const QCursor &) — signature only in the source.
• const QCursor cursor () const — signature only in the source.
• void setOrientations (Qt::Orientations) — signature only in the source.
• Qt::Orientations orientations () const — Return the orientation, where panning is enabled.
• bool isOrientationEnabled (Qt::Orientation) const — signature only in the source.
• virtual bool eventFilter (QObject *, QEvent *) override — Event filter.

🛡️ Protected Member Functions 🛡️

• virtual QBitmap contentsMask () const override — protected override signature.
• virtual QPixmap grab () const override — protected override signature.

🔒 Protected Member Functions inherited from QwtPanner 🔒

• virtual void widgetMousePressEvent (QMouseEvent *) — signature only in the source.
• virtual void widgetMouseReleaseEvent (QMouseEvent *) — signature only in the source.
• virtual void widgetMouseMoveEvent (QMouseEvent *) — signature only in the source.
• virtual void widgetKeyPressEvent (QKeyEvent *) — signature only in the source.
• virtual void widgetKeyReleaseEvent (QKeyEvent *) — signature only in the source.
• virtual void paintEvent (QPaintEvent *) override — Paint event.

🌟 Additional Inherited Members 🌟

📡 Signals inherited from QwtPanner 📡

• void panned (int dx, int dy) — signal signature.
• void moved (int dx, int dy) — signal signature.

---

🌈 Detailed Description 🌈

QwtPlotPanner provides panning of a plot canvas.

QwtPlotPanner is a panner for a plot canvas that adjusts the scales of the axes after dropping the canvas on its new position. yes bestie, it’s doing the glow-up math for you ✨

Together with QwtPlotZoomer and QwtPlotMagnifier, powerful ways of navigating on a QwtPlot widget can be implemented easily. team-up energy fr fr 🫶

⚠️ Note: The axes are not updated, while dragging the canvas.

See also: QwtPlotZoomer, QwtPlotMagnifier

Definition at line 32 of file qwt_plot_panner.h.

---

🎀 Constructor & Destructor Documentation 🎀

QwtPlotPanner::QwtPlotPanner (QWidget * canvas) [explicit]

A panner for the canvas of a QwtPlot. The panner is enabled for all axes.

Parameters

• canvas — Plot canvas to pan, also the parent object.

See also: setAxisEnabled()

Definition at line 128 of file qwt_plot_panner.cpp.

QwtPlotPanner::~QwtPlotPanner () [virtual]

Destructor.

Definition at line 138 of file qwt_plot_panner.cpp.

---

💖 Member Function Documentation 💖

QWidget * QwtPlotPanner::canvas ()

Return observed plot canvas.

Definition at line 177 of file qwt_plot_panner.cpp.

const QWidget * QwtPlotPanner::canvas () const

Return Observed plot canvas.

Definition at line 183 of file qwt_plot_panner.cpp.

QBitmap QwtPlotPanner::contentsMask () const [override], [protected], [virtual]

Calculate a mask from the border path of the canvas.

Returns: Mask as bitmap.

See also: QwtPlotCanvas::borderPath()

Reimplemented from: QwtPanner.

Definition at line 267 of file qwt_plot_panner.cpp.

QPixmap QwtPlotPanner::grab () const [override], [protected], [virtual]

Returns: Pixmap with the content of the canvas.

Reimplemented from: QwtPanner.

Definition at line 278 of file qwt_plot_panner.cpp.

bool QwtPlotPanner::isAxisEnabled (QwtAxisId axisId) const

Test if an axis is enabled.

Parameters

• axisId — Axis.

Returns: True, if the axis is enabled.

See also: setAxisEnabled(), moveCanvas()

Definition at line 168 of file qwt_plot_panner.cpp.

void QwtPlotPanner::moveCanvas (int dx, int dy) [virtual], [slot]

Adjust the enabled axes according to dx/dy.

Parameters

• dx — Pixel offset in x direction.
• dy — Pixel offset in y direction.

See also: QwtPanner::panned()

Definition at line 216 of file qwt_plot_panner.cpp.

QwtPlot * QwtPlotPanner::plot ()

Return plot widget, containing the observed plot canvas.

Definition at line 189 of file qwt_plot_panner.cpp.

const QwtPlot * QwtPlotPanner::plot () const

Return plot widget, containing the observed plot canvas.

Definition at line 199 of file qwt_plot_panner.cpp.

void QwtPlotPanner::setAxisEnabled (QwtAxisId axisId, bool on)

En/Disable an axis. Axes that are enabled will be synchronized to the result of panning. All other axes will remain unchanged.

Parameters

• axisId — Axis id.
• on — On/Off.

See also: isAxisEnabled(), moveCanvas()

Definition at line 154 of file qwt_plot_panner.cpp.

---

🌟 Author 🌟

Generated automatically by Doxygen for Qwt User's Guide from the source code.

---

mwah 💋 that’s the whole page, bestie — the footer gives source/version <purple>Qwt User's Guide</purple> and page tag <pink>QwtPlotPanner(3)</pink> (no date in this footer, just those bits). periodt 🫶✨