File indexing completed on 2024-05-12 04:44:32

 // SPDX-FileCopyrightText: Lukas Sommer <sommerluk@gmail.com>
 // SPDX-License-Identifier: BSD-2-Clause OR MIT
 
 #ifndef COLORWHEEL_H
 #define COLORWHEEL_H
 
 #include "abstractdiagram.h"
 #include "constpropagatinguniquepointer.h"
 #include "importexport.h"
 #include <qglobal.h>
 #include <qsharedpointer.h>
 #include <qsize.h>
 class QKeyEvent;
 class QMouseEvent;
 class QPaintEvent;
 class QResizeEvent;
 class QWheelEvent;
 class QWidget;
 
 #if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
 #include <qtmetamacros.h>
 #else
 #include <qobjectdefs.h>
 #include <qstring.h>
 class QObject;
 #endif
 
 namespace PerceptualColor
 {
 class ColorWheelPrivate;
 
 class RgbColorSpace;
 
 /** @brief A color wheel widget.
  *
  * This widget allows the user to choose the hue (as defined in the LCH
  * color space).
  *
  * @image html ColorWheel.png "ColorWheel" width=200
  *
  * @note This widget <em>always</em> accepts focus by a mouse click within
  * the circle. This happens regardless of the <tt>QWidget::focusPolicy</tt>
  * property:
  * - If you set the <tt>QWidget::focusPolicy</tt> property to a
  *   value that does not accept focus by mouse click, the focus
  *   will nevertheless be accepted for clicks within the actual circle.
  *   (This is the default behavior.)
  * - If you set the <tt>QWidget::focusPolicy</tt> property to a
  *   value that accepts focus by mouse click, the focus will not only be
  *   accepted for clicks within the actual circle, but also for clicks
  *   anywhere within the (rectangular) widget.
  *
  * @internal
  *
  * @todo Add support for Qt::MouseButton::BackButton?
  * (Typically present on the 'thumb' side of a mouse
  * with extra buttons. This is NOT the tilt wheel.)
  * Add support for Qt::MouseButton::ForwardButton?
  * (Typically present beside the 'Back' button, and
  * also pressed by the thumb.)
  *
  * @todo What when some of the wheel colors are out of gamut? How to handle
  * that? */
 class PERCEPTUALCOLOR_IMPORTEXPORT ColorWheel : public AbstractDiagram
 {
     Q_OBJECT
 
     /** @brief The currently selected hue.
      *
      * This is the hue angle, as defined in the LCH color model.
      *
      *
      * Measured in degree.
      *
      * Valid range: [0°, 360°[. The widget accepts initially also
      * out-of-range values, but once a user interaction has taken
      * place, it will hold a normalized value. So
      * \li 0 gets 0
      * \li 359.9 gets 359.9
      * \li 360 gets 0
      * \li 361.2 gets 1.2
      * \li 720 gets 0
      * \li -1 gets 359
      * \li -1.3 gets 358.7
      *
      * @sa READ @ref hue() const
      * @sa WRITE @ref setHue()
      * @sa NOTIFY @ref hueChanged()
      *
      * @internal
      *
      * The value gets normalized according
      * to @ref PolarPointF::normalizedAngle360() */
     Q_PROPERTY(qreal hue READ hue WRITE setHue NOTIFY hueChanged USER true)
 
 public:
     Q_INVOKABLE explicit ColorWheel(const QSharedPointer<PerceptualColor::RgbColorSpace> &colorSpace, QWidget *parent = nullptr);
     virtual ~ColorWheel() noexcept override;
     /** @brief Getter for property @ref hue
      *  @returns the property @ref hue */
     [[nodiscard]] qreal hue() const;
     [[nodiscard]] virtual QSize minimumSizeHint() const override;
     [[nodiscard]] virtual QSize sizeHint() const override;
 
 Q_SIGNALS:
     /** @brief Notify signal for property @ref hue.
      * @param newHue the new hue */
     void hueChanged(const qreal newHue);
 
 public Q_SLOTS:
     void setHue(const qreal newHue);
 
 protected:
     virtual void keyPressEvent(QKeyEvent *event) override;
     virtual void mouseMoveEvent(QMouseEvent *event) override;
     virtual void mousePressEvent(QMouseEvent *event) override;
     virtual void mouseReleaseEvent(QMouseEvent *event) override;
     virtual void paintEvent(QPaintEvent *event) override;
     virtual void resizeEvent(QResizeEvent *event) override;
     virtual void wheelEvent(QWheelEvent *event) override;
 
 private:
     Q_DISABLE_COPY(ColorWheel)
 
     /** @internal
      *
      * @brief Declare the private implementation as friend class.
      *
      * This allows the private class to access the protected members and
      * functions of instances of <em>this</em> class. */
     friend class ColorWheelPrivate;
     /** @brief Pointer to implementation (pimpl) */
     ConstPropagatingUniquePointer<ColorWheelPrivate> d_pointer;
 
     /** @internal @brief Only for unit tests. */
     friend class TestColorWheel;
 
     /** @internal
      * @brief Internal friend declaration.
      *
      * This class is used as child class in @ref WheelColorPicker.
      * There is a tight collaboration. */
     friend class WheelColorPicker;
     /** @internal
      * @brief Internal friend declaration.
      *
      * This class is used as child class in @ref WheelColorPicker.
      * There is a tight collaboration. */
     friend class WheelColorPickerPrivate;
 };
 
 } // namespace PerceptualColor
 
 #endif // COLORWHEEL_H