src/quick/items/qquickpainteditem.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQUICKPAINTEDITEM_P_H
  43 #define QQUICKPAINTEDITEM_P_H
  44
  45 #include <QtQuick/qquickitem.h>
  46 #include <QtGui/qcolor.h>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 class QQuickPaintedItemPrivate;
  53 class Q_QUICK_EXPORT QQuickPaintedItem : public QQuickItem
  54 {
  55     Q_OBJECT
  56     Q_ENUMS(RenderTarget)
  57
  58     Q_PROPERTY(QSize contentsSize READ contentsSize WRITE setContentsSize NOTIFY contentsSizeChanged)
  59     Q_PROPERTY(QColor fillColor READ fillColor WRITE setFillColor NOTIFY fillColorChanged)
  60     Q_PROPERTY(qreal contentsScale READ contentsScale WRITE setContentsScale NOTIFY contentsScaleChanged)
  61     Q_PROPERTY(RenderTarget renderTarget READ renderTarget WRITE setRenderTarget NOTIFY renderTargetChanged)
  62 public:
  63     QQuickPaintedItem(QQuickItem *parent = 0);
  64     virtual ~QQuickPaintedItem();
  65
  66     enum RenderTarget {
  67         Image,
  68         FramebufferObject,
  69         InvertedYFramebufferObject
  70     };
  71
  72     enum PerformanceHint {
  73         FastFBOResizing = 0x1
  74     };
  75     Q_DECLARE_FLAGS(PerformanceHints, PerformanceHint)
  76
  77     void update(const QRect &rect = QRect());
  78
  79     bool opaquePainting() const;
  80     void setOpaquePainting(bool opaque);
  81
  82     bool antialiasing() const;
  83     void setAntialiasing(bool enable);
  84
  85     bool mipmap() const;
  86     void setMipmap(bool enable);
  87
  88     PerformanceHints performanceHints() const;
  89     void setPerformanceHint(PerformanceHint hint, bool enabled = true);
  90     void setPerformanceHints(PerformanceHints hints);
  91
  92     QRectF contentsBoundingRect() const;
  93
  94     QSize contentsSize() const;
  95     void setContentsSize(const QSize &);
  96     void resetContentsSize();
  97
  98     qreal contentsScale() const;
  99     void setContentsScale(qreal);
 100
 101     QColor fillColor() const;
 102     void setFillColor(const QColor&);
 103
 104     RenderTarget renderTarget() const;
 105     void setRenderTarget(RenderTarget target);
 106
 107     virtual void paint(QPainter *painter) = 0;
 108
 109 Q_SIGNALS:
 110     void fillColorChanged();
 111     void contentsSizeChanged();
 112     void contentsScaleChanged();
 113     void renderTargetChanged();
 114
 115 protected:
 116     QQuickPaintedItem(QQuickPaintedItemPrivate &dd, QQuickItem *parent = 0);
 117     virtual QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *);
 118
 119 private:
 120     Q_DISABLE_COPY(QQuickPaintedItem)
 121     Q_DECLARE_PRIVATE(QQuickPaintedItem)
 122 };
 123
 124 Q_DECLARE_OPERATORS_FOR_FLAGS(QQuickPaintedItem::PerformanceHints)
 125
 126 QT_END_NAMESPACE
 127
 128 QT_END_HEADER
 129
 130 #endif // QQUICKPAINTEDITEM_P_H