File indexing completed on 2025-02-23 04:08:58

 /*
  * SPDX-FileCopyrightText: 2008 Cyrille Berger <cberger@cberger.net>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef _KIS_CANVAS_DECORATION_H_
 #define _KIS_CANVAS_DECORATION_H_
 
 #include <QObject>
 #include <QPointer>
 
 #include <kritaui_export.h>
 #include <kis_image.h>
 #include "KisView.h"
 #include <kis_shared.h>
 
 class KisCanvas2;
 class QRectF;
 class QPainter;
 class KisCoordinatesConverter;
 
 class KisCanvasDecoration;
 typedef KisSharedPtr<KisCanvasDecoration> KisCanvasDecorationSP;
 
 /**
  * This class is the base class for object that draw a decoration on the canvas,
  * for instance, selections, grids, tools, ...
  */
 class KRITAUI_EXPORT KisCanvasDecoration : public QObject, public KisShared
 {
     Q_OBJECT
 public:
     KisCanvasDecoration(const QString& id, QPointer<KisView>parent);
 
     ~KisCanvasDecoration() override;
 
     void setView(QPointer<KisView> imageView);
 
     const QString& id() const;
 
     /**
      * @return whether the decoration is visible.
      */
     bool visible() const;
 
     /**
      * Will paint the decoration on the QPainter, if the visible is set to @c true.
      *
      * @param gc the painter
      * @param updateRect dirty rect in document pixels
      * @param converter coordinate converter
      * @param canvas the canvas
      */
     void paint(QPainter& gc, const QRectF& updateRect, const KisCoordinatesConverter *converter,KisCanvas2* canvas);
 
     /**
      * Return z-order priority of the decoration. The higher the priority, the higher
      * the decoration is painted.
      */
     int priority() const;
 
     static bool comparePriority(KisCanvasDecorationSP decoration1, KisCanvasDecorationSP decoration2);
 
     virtual void notifyWindowMinimized(bool minimized);
 
 public Q_SLOTS:
     /**
      * Set if the decoration is visible or not.
      */
     virtual void setVisible(bool v);
     /**
      * If decoration is visible, hide it, if not show it.
      */
     void toggleVisibility();
 protected:
     virtual void drawDecoration(QPainter& gc, const QRectF& updateArea, const KisCoordinatesConverter *converter,KisCanvas2* canvas) = 0;
 
     /**
      * @return the parent KisView
      */
     QPointer<KisView> view() const;
 
     /**
      * Set the priority of the decoration. The higher the priority, the higher
      * the decoration is painted.
      */
     void setPriority(int value);
 
     // returns the minimum decoration thickness, somewhat equivelant to the display scaling.
     int decorationThickness() const;
 
 private:
     struct Private;
     Private* const d;
 };
 
 #endif