QwtPolarMagnifier(3)

📦
version 6.3.0 · 2 versions
, in alpine 3.24

💅 QwtPolarMagnifier(3) — like, the whole entire manual page, bestie

okay so first things first: this is a page from the Library Functions Manual, and it's all about QwtPolarMagnifier 🎀 — the little icon that lets you zoom a polar plot by magnifying in steps. Yes. Steps. Not vibes. Steps.

✨ NAME ✨

QwtPolarMagnifier — QwtPolarMagnifier provides zooming, by magnifying in steps.

Like, that's literally it. That's the whole assignment. 💅

🌸 SYNOPSIS 🌸

#include <qwt_polar_magnifier.h>

Inherits QwtMagnifier. Family tree, but make it fashion. 👑

🫶 Public Slots

  • virtual void rescale (double factor) override — the zooming happens here, bestie.
  • void unzoom () — Unzoom the plot widget. One tap and we're back, no cap.

💖 Public Member Functions

  • QwtPolarMagnifier (QwtPolarCanvas *) — constructor, we'll get to it.
  • virtual ~QwtPolarMagnifier () — Destructor. RIP to her, she did her job.
  • void setUnzoomKey (int key, int modifiers) — set the unzoom key combo.
  • void getUnzoomKey (int &key, int &modifiers) const — read back that unzoom key combo.
  • QwtPolarPlot * plot () — grab the plot.
  • const QwtPolarPlot * plot () const — grab the plot, but const. Same energy, different wrapper.
  • QwtPolarCanvas * canvas () — grab the canvas.
  • const QwtPolarCanvas * canvas () const — grab the canvas, const edition.

🌈 Public Member Functions inherited from QwtMagnifier

  • QwtMagnifier (QWidget *) — constructor of the parent class.
  • virtual ~QwtMagnifier () — Destructor. Again. Everybody gets one.
  • QWidget * parentWidget () — the parent widget, non-const.
  • const QWidget * parentWidget () const — the parent widget, const.
  • void setEnabled (bool) — En/disable the magnifier. On or off, no in-between.
  • bool isEnabled () const — is it enabled? enquiring minds.
  • void setMouseFactor (double) — Change the mouse factor. 🐭
  • double mouseFactor () const — read the mouse factor back.
  • void setMouseButton (Qt::MouseButton, Qt::KeyboardModifiers=Qt::NoModifier) — pick the mouse button (and, optionally, modifiers — default is Qt::NoModifier).
  • void getMouseButton (Qt::MouseButton &, Qt::KeyboardModifiers &) const — read the mouse button settings back out.
  • void setWheelFactor (double) — Change the wheel factor.
  • double wheelFactor () const — read the wheel factor back.
  • void setWheelModifiers (Qt::KeyboardModifiers) — set the modifiers for the wheel.
  • Qt::KeyboardModifiers wheelModifiers () const — read the wheel modifiers back.
  • void setKeyFactor (double) — Change the key factor.
  • double keyFactor () const — read the key factor back.
  • void setZoomInKey (int key, Qt::KeyboardModifiers=Qt::NoModifier) — set the zoom-in key (modifiers default to Qt::NoModifier).
  • void getZoomInKey (int &key, Qt::KeyboardModifiers &) const — Retrieve the settings of the zoom in key.
  • void setZoomOutKey (int key, Qt::KeyboardModifiers=Qt::NoModifier) — set the zoom-out key (modifiers default to Qt::NoModifier).
  • void getZoomOutKey (int &key, Qt::KeyboardModifiers &) const — Retrieve the settings of the zoom out key.
  • virtual bool eventFilter (QObject *, QEvent *) override — Event filter. She's watching. 👀

🦋 Protected Member Functions

  • virtual void widgetKeyPressEvent (QKeyEvent *) override — handle key presses on the observed widget.

💜 Protected Member Functions inherited from QwtMagnifier

  • virtual void rescale (double factor)=0 — pure virtual, you must implement it. no skipping.
  • virtual void widgetMousePressEvent (QMouseEvent *) — mouse press handler.
  • virtual void widgetMouseReleaseEvent (QMouseEvent *) — mouse release handler.
  • virtual void widgetMouseMoveEvent (QMouseEvent *) — mouse move handler.
  • virtual void widgetWheelEvent (QWheelEvent *) — wheel handler.
  • virtual void widgetKeyReleaseEvent (QKeyEvent *) — key release handler.

🧚 Detailed Description 🧚

QwtPolarMagnifier provides zooming, by magnifying in steps.

So like — using QwtPlotMagnifier a plot can be zoomed in/out in steps using keys, the mouse wheel or moving a mouse button in vertical direction. Three whole ways, pick your fighter. ⭐

Together with QwtPolarPanner it is possible to implement an individual navigation of the plot canvas. Cute duo, honestly. Main character energy from both of them. 🫶

See also: QwtPolarPanner, QwtPolarPlot, QwtPolarCanvas

Definition at line 30 of file qwt_polar_magnifier.h.

🔥 Constructor & Destructor Documentation 🔥

QwtPolarMagnifier::QwtPolarMagnifier (QwtPolarCanvas * canvas) [explicit]

Constructor. She's born. 🎀

Parameters:

  • canvas — Plot canvas to be magnified

Definition at line 34 of file qwt_polar_magnifier.cpp.

QwtPolarMagnifier::~QwtPolarMagnifier () [virtual]

Destructor. Saying goodbye. 😭

Definition at line 41 of file qwt_polar_magnifier.cpp.

👑 Member Function Documentation 👑

QwtPolarCanvas * QwtPolarMagnifier::canvas ()

Returns: Observed plot canvas

Definition at line 74 of file qwt_polar_magnifier.cpp.

const QwtPolarCanvas * QwtPolarMagnifier::canvas () const

Returns: Observed plot canvas

Definition at line 80 of file qwt_polar_magnifier.cpp.

void QwtPolarMagnifier::getUnzoomKey (int & key, int & modifiers) const

Return key, and modifiers that are used for unzooming. 📖

Parameters:

  • key — Key code
  • modifiers — Modifiers

See also: setUnzoomKey(), QwtPolarPlot::unzoom()

Definition at line 67 of file qwt_polar_magnifier.cpp.

QwtPolarPlot * QwtPolarMagnifier::plot ()

Returns: Observed plot

Definition at line 86 of file qwt_polar_magnifier.cpp.

const QwtPolarPlot * QwtPolarMagnifier::plot () const

Returns: observed plot

Definition at line 96 of file qwt_polar_magnifier.cpp.

void QwtPolarMagnifier::rescale (double factor) [override], [virtual], [slot]

Zoom in/out the zoomed area. 🔍✨

Parameters:

  • factor — A value < 1.0 zooms in, a value > 1.0 zooms out.
ok so this is the important one: small number = zoom IN, big number = zoom OUT. Do not flip these, bestie, I am begging. 🙈

Definition at line 129 of file qwt_polar_magnifier.cpp.

void QwtPolarMagnifier::setUnzoomKey (int key, int modifiers)

Assign key and modifiers, that are used for unzooming. The default combination is Qt::Key_Home + Qt::NoModifier. 🏠

Parameters:

  • key — Key code
  • modifiers — Modifiers

See also: getUnzoomKey(), QwtPolarPlot::unzoom()

Definition at line 54 of file qwt_polar_magnifier.cpp.

void QwtPolarMagnifier::unzoom () [slot]

Unzoom the plot widget. Snap back to reality, ope there goes gravity. 💀

Definition at line 157 of file qwt_polar_magnifier.cpp.

void QwtPolarMagnifier::widgetKeyPressEvent (QKeyEvent * event) [override], [protected], [virtual]

Handle a key press event for the observed widget. ⌨️

Parameters:

  • event — Key event

Reimplemented from QwtMagnifier.

Definition at line 110 of file qwt_polar_magnifier.cpp.

🌟 Author 🌟

Generated automatically by Doxygen for Qwt User's Guide from the source code. Not a human, not a vibe, just Doxygen doing its little thing. 🤖💖

<div align="center">— 🎀 —</div>

and that's the whole page, bestie! sign-off time: this lil masterpiece came from the Qwt User's Guide docs, page QwtPolarMagnifier(3), born from the source code by way of Doxygen. slay, read it, use it, periodt. 💅✨🦋

📦 where this page comes from