QwtCompass(3)

📦
version 6.3.0 · 6 versions
, in alpine 3.24

💫 QwtCompass(3) 💫

okay bestie, welcome to the Library Functions Manual page for QwtCompass — and yes, it's literally as cute as it sounds 🧭✨

🌸 NAME 🌸

QwtCompass — a Compass Widget, no cap 🧭💅

🦋 SYNOPSIS 🦋

#include <qwt_compass.h>

It inherits QwtDial — so everything the dial can do, the compass gets to do too, inherited bestie privileges fr fr 👑

✨ Public Member Functions ✨

  • QwtCompass (QWidget *parent=NULL) — Constructor 🎀
  • virtual ~QwtCompass () — Destructor 💀
  • void setRose (QwtCompassRose *rose) — sets the rose, more on this below 🌹
  • const QwtCompassRose * rose () const — the const-flavored getter
  • QwtCompassRose * rose () — the regular getter

🫶 Public Member Functions inherited from QwtDial 🫶

  • QwtDial (QWidget *parent=NULL) — Constructor
  • virtual ~QwtDial () — Destructor
  • void setFrameShadow (Shadow)
  • Shadow frameShadow () const
  • void setLineWidth (int)
  • int lineWidth () const
  • void setMode (Mode) — change the mode of the dial
  • Mode mode () const
  • void setScaleArc (double minArc, double maxArc)
  • void setMinScaleArc (double)
  • double minScaleArc () const
  • void setMaxScaleArc (double)
  • double maxScaleArc () const
  • virtual void setOrigin (double) — change the origin
  • double origin () const
  • void setNeedle (QwtDialNeedle *)
  • const QwtDialNeedle * needle () const
  • QwtDialNeedle * needle ()
  • QRect boundingRect () const
  • QRect innerRect () const
  • virtual QRect scaleInnerRect () const
  • virtual QSize sizeHint () const override
  • virtual QSize minimumSizeHint () const override
  • void setScaleDraw (QwtRoundScaleDraw *)
  • QwtRoundScaleDraw * scaleDraw ()
  • const QwtRoundScaleDraw * scaleDraw () const

💜 Public Member Functions inherited from QwtAbstractSlider 💜

  • QwtAbstractSlider (QWidget *parent=NULL) — Constructor
  • virtual ~QwtAbstractSlider () — Destructor
  • void setValid (bool)
  • bool isValid () const
  • double value () const — returns the current value
  • void setWrapping (bool)
  • bool wrapping () const
  • void setTotalSteps (uint) — set the number of steps
  • uint totalSteps () const
  • void setSingleSteps (uint) — set the number of steps for a single increment
  • uint singleSteps () const
  • void setPageSteps (uint) — set the number of steps for a page increment
  • uint pageSteps () const
  • void setStepAlignment (bool) — enable step alignment
  • bool stepAlignment () const
  • void setTracking (bool) — enables or disables tracking
  • bool isTracking () const
  • void setReadOnly (bool)
  • bool isReadOnly () const
  • void setInvertedControls (bool)
  • bool invertedControls () const

🌈 Public Member Functions inherited from QwtAbstractScale 🌈

  • QwtAbstractScale (QWidget *parent=NULL)
  • virtual ~QwtAbstractScale () — Destructor
  • void setScale (double lowerBound, double upperBound) — specify a scale
  • void setScale (const QwtInterval &) — specify a scale
  • void setScale (const QwtScaleDiv &) — specify a scale
  • const QwtScaleDiv & scaleDiv () const
  • void setLowerBound (double value)
  • double lowerBound () const
  • void setUpperBound (double value)
  • double upperBound () const
  • void setScaleStepSize (double stepSize) — set the step size used for calculating a scale division
  • double scaleStepSize () const
  • void setScaleMaxMajor (int ticks) — set the maximum number of major tick intervals
  • int scaleMaxMinor () const
  • void setScaleMaxMinor (int ticks) — set the maximum number of minor tick intervals
  • int scaleMaxMajor () const
  • void setScaleEngine (QwtScaleEngine *) — set a scale engine
  • const QwtScaleEngine * scaleEngine () const
  • QwtScaleEngine * scaleEngine ()
  • int transform (double) const
  • double invTransform (int) const
  • bool isInverted () const
  • double minimum () const
  • double maximum () const
  • const QwtScaleMap & scaleMap () const

🎀 Protected Member Functions 🎀

  • virtual void drawRose (QPainter *, const QPointF &center, double radius, double north, QPalette::ColorGroup) const
  • virtual void drawScaleContents (QPainter *, const QPointF &center, double radius) const override
  • virtual void keyPressEvent (QKeyEvent *) override

💖 Protected Member Functions inherited from QwtDial 💖

  • virtual void wheelEvent (QWheelEvent *) override
  • virtual void paintEvent (QPaintEvent *) override
  • virtual void changeEvent (QEvent *) override
  • virtual void drawFrame (QPainter *)
  • virtual void drawContents (QPainter *) const — draw the contents inside the frame
  • virtual void drawFocusIndicator (QPainter *) const
  • void invalidateCache ()
  • virtual void drawScale (QPainter *, const QPointF &center, double radius) const
  • virtual void drawNeedle (QPainter *, const QPointF &, double radius, double direction, QPalette::ColorGroup) const
  • virtual double scrolledTo (const QPoint &) const override — determine the value for a new position of the slider handle
  • virtual bool isScrollPosition (const QPoint &) const override — determine what to do when the user presses a mouse button
  • virtual void sliderChange () override — calling update()
  • virtual void scaleChange () override

⭐ Protected Member Functions inherited from QwtAbstractSlider ⭐

  • virtual void mousePressEvent (QMouseEvent *) override
  • virtual void mouseReleaseEvent (QMouseEvent *) override
  • virtual void mouseMoveEvent (QMouseEvent *) override
  • void incrementValue (int stepCount)
  • double incrementedValue (double value, int stepCount) const

🍓 Protected Member Functions inherited from QwtAbstractScale 🍓

  • void rescale (double lowerBound, double upperBound, double stepSize)
  • void setAbstractScaleDraw (QwtAbstractScaleDraw *) — set a scale draw
  • const QwtAbstractScaleDraw * abstractScaleDraw () const
  • QwtAbstractScaleDraw * abstractScaleDraw ()
  • void updateScaleDraw ()

🧚 Additional Inherited Members 🧚

👑 Public Types inherited from QwtDial 👑

  • enum Shadow { Plain = QFrame::Plain, Raised = QFrame::Raised, Sunken = QFrame::Sunken } — frame shadow
  • enum Mode { RotateNeedle, RotateScale } — mode controlling whether the needle or the scale is rotating

🌸 Public Slots inherited from QwtAbstractSlider 🌸

  • void setValue (double value)

🔥 Signals inherited from QwtAbstractSlider 🔥

  • void valueChanged (double value) — notify a change of value
  • void sliderPressed ()
  • void sliderReleased ()
  • void sliderMoved (double value)

💅 Detailed Description 💅

A Compass Widget. That's the whole vibe 🧭

QwtCompass is a widget to display and enter directions — main character energy honestly. It consists of a scale, an optional needle and rose 🌹

Note — the examples/dials example shows how to use QwtCompass. go look at it bestie, it's giving tutorial 🎀

Definition at line 61 of file qwt_compass.h.

🎀 Constructor & Destructor Documentation 🎀

QwtCompass::QwtCompass (QWidget * parent = NULL) [explicit]

Constructor ✨

Parameters

  • parent — parent widget

Create a compass widget with a scale, no needle and no rose. The default origin is 270.0 with no valid value. It accepts mouse and keyboard inputs and has no step size. The default mode is QwtDial::RotateNeedle.

Definition at line 158 of file qwt_compass.cpp.

QwtCompass::~QwtCompass () [virtual]

Destructor 💀 rip little compass, slay while you were here.

Definition at line 176 of file qwt_compass.cpp.

🌟 Member Function Documentation 🌟

void QwtCompass::drawRose (QPainter * painter, const QPointF & center, double radius, double north, QPalette::ColorGroup cg) const [protected], [virtual]

Draw the compass rose 🌹 — literal art moment.

Parameters

  • painter — painter
  • center — center of the compass
  • radius — radius of the circle, where to paint the rose
  • north — direction pointing north, in degrees counter clockwise
  • cg — color group

Definition at line 218 of file qwt_compass.cpp.

void QwtCompass::drawScaleContents (QPainter * painter, const QPointF & center, double radius) const [override], [protected], [virtual]

Draw the contents of the scale 🎨

Parameters

  • painter — painter
  • center — center of the content circle
  • radius — radius of the content circle

Reimplemented from QwtDial.

Definition at line 189 of file qwt_compass.cpp.

void QwtCompass::keyPressEvent (QKeyEvent * kev) [override], [protected], [virtual]

Handles key events ⌨️ — she listens, and she responds.

Beside the keys described in QwtDial::keyPressEvent, numbers from 1-9 (without 5) set the direction according to their position on the num pad. iykyk 🔢

See also isReadOnly()

Reimplemented from QwtAbstractSlider.

Definition at line 271 of file qwt_compass.cpp.

QwtCompassRose * QwtCompass::rose ()

Returns — rose 🌹

See also setRose()

Definition at line 257 of file qwt_compass.cpp.

const QwtCompassRose * QwtCompass::rose () const

Returns — rose 🌹 (the const one, equally iconic)

See also setRose()

Definition at line 248 of file qwt_compass.cpp.

void QwtCompass::setRose (QwtCompassRose * rose)

Set a rose for the compass 🌹✨

Parameters

  • rose — compass rose
Warning ⚠️ — the rose will be deleted when a different rose is set or in ~QwtCompass. so like, don't hold onto that pointer and then act surprised, bestie 😭

See also rose()

Definition at line 232 of file qwt_compass.cpp.

🫶 Author 🫶

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

aaaand that's the page! this was QwtCompass(3) from the Qwt User's Guide, and the footer date is literally just the guide label itself, so consider this your official sign-off: Qwt User's Guide — QwtCompass(3) — stay compass-y, bestie 🧭💜🦋

📦 where this page comes from