/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QPAINTER_H

#define QPAINTER_H

#include <QtCore/qnamespace.h>

#include <QtCore/qrect.h>

#include <QtCore/qpoint.h>

#include <QtCore/qscopedpointer.h>

#include <QtGui/qpixmap.h>

#include <QtGui/qimage.h>

#include <QtGui/qtextoption.h>

#include <QtGui/qdrawutil.h>

#ifndef QT_INCLUDE_COMPAT

#include <QtGui/qpolygon.h>

#include <QtGui/qpen.h>

#include <QtGui/qbrush.h>

#include <QtGui/qmatrix.h>

#include <QtGui/qtransform.h>

#include <QtGui/qfontinfo.h>

#include <QtGui/qfontmetrics.h>

#endif

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

class QBrush;

class QFontInfo;

class QFontMetrics;

class QPaintDevice;

class QPainterPath;

class QPainterPrivate;

class QPen;

class QPolygon;

class QTextItem;

class QMatrix;

class QTransform;

class QStaticText;

class QPainterPrivateDeleter;

class Q_GUI_EXPORT QPainter

{

    Q_DECLARE_PRIVATE(QPainter)

    Q_GADGET

    Q_FLAGS(RenderHint RenderHints)

public:

    enum RenderHint {

        Antialiasing = 0x01,

        TextAntialiasing = 0x02,

        SmoothPixmapTransform = 0x04,

        HighQualityAntialiasing = 0x08,

        NonCosmeticDefaultPen = 0x10

    };

    Q_DECLARE_FLAGS(RenderHints, RenderHint)

    class PixmapFragment {

    public:

        qreal x;

        qreal y;

        qreal sourceLeft;

        qreal sourceTop;

        qreal width;

        qreal height;

        qreal scaleX;

        qreal scaleY;

        qreal rotation;

        qreal opacity;

        static PixmapFragment Q_GUI_EXPORT create(const QPointF &pos, const QRectF &sourceRect,

                                            qreal scaleX = 1, qreal scaleY = 1,

                                            qreal rotation = 0, qreal opacity = 1);

    };

    enum PixmapFragmentHint {

        OpaqueHint = 0x01

    };

    Q_DECLARE_FLAGS(PixmapFragmentHints, PixmapFragmentHint)

    QPainter();

    explicit QPainter(QPaintDevice *);

    ~QPainter();

    QPaintDevice *device() const;

    bool begin(QPaintDevice *);

    bool end();

    bool isActive() const;

    void initFrom(const QWidget *widget);

    enum CompositionMode {

        CompositionMode_SourceOver,

        CompositionMode_DestinationOver,

        CompositionMode_Clear,

        CompositionMode_Source,

        CompositionMode_Destination,

        CompositionMode_SourceIn,

        CompositionMode_DestinationIn,

        CompositionMode_SourceOut,

        CompositionMode_DestinationOut,

        CompositionMode_SourceAtop,

        CompositionMode_DestinationAtop,

        CompositionMode_Xor,

        //svg 1.2 blend modes

        CompositionMode_Plus,

        CompositionMode_Multiply,

        CompositionMode_Screen,

        CompositionMode_Overlay,

        CompositionMode_Darken,

        CompositionMode_Lighten,

        CompositionMode_ColorDodge,

        CompositionMode_ColorBurn,

        CompositionMode_HardLight,

        CompositionMode_SoftLight,

        CompositionMode_Difference,

        CompositionMode_Exclusion,

        // ROPs

        RasterOp_SourceOrDestination,

        RasterOp_SourceAndDestination,

        RasterOp_SourceXorDestination,

        RasterOp_NotSourceAndNotDestination,

        RasterOp_NotSourceOrNotDestination,

        RasterOp_NotSourceXorDestination,

        RasterOp_NotSource,

        RasterOp_NotSourceAndDestination,

        RasterOp_SourceAndNotDestination

    };

    void setCompositionMode(CompositionMode mode);

    CompositionMode compositionMode() const;

    const QFont &font() const;

    void setFont(const QFont &f);

    QFontMetrics fontMetrics() const;

    QFontInfo fontInfo() const;

    void setPen(const QColor &color);

    void setPen(const QPen &pen);

    void setPen(Qt::PenStyle style);

    const QPen &pen() const;

    void setBrush(const QBrush &brush);

    void setBrush(Qt::BrushStyle style);

    const QBrush &brush() const;

    // attributes/modes

    void setBackgroundMode(Qt::BGMode mode);

    Qt::BGMode backgroundMode() const;

    QPoint brushOrigin() const;

    inline void setBrushOrigin(int x, int y);

    inline void setBrushOrigin(const QPoint &);

    void setBrushOrigin(const QPointF &);

    void setBackground(const QBrush &bg);

    const QBrush &background() const;

    qreal opacity() const;

    void setOpacity(qreal opacity);

    // Clip functions

    QRegion clipRegion() const;

    QPainterPath clipPath() const;

    void setClipRect(const QRectF &, Qt::ClipOperation op = Qt::ReplaceClip);

    void setClipRect(const QRect &, Qt::ClipOperation op = Qt::ReplaceClip);

    inline void setClipRect(int x, int y, int w, int h, Qt::ClipOperation op = Qt::ReplaceClip);

    void setClipRegion(const QRegion &, Qt::ClipOperation op = Qt::ReplaceClip);

    void setClipPath(const QPainterPath &path, Qt::ClipOperation op = Qt::ReplaceClip);

    void setClipping(bool enable);

    bool hasClipping() const;

    void save();

    void restore();

    // XForm functions

    void setMatrix(const QMatrix &matrix, bool combine = false);

    const QMatrix &matrix() const;

    const QMatrix &deviceMatrix() const;

    void resetMatrix();

    void setTransform(const QTransform &transform, bool combine = false);

    const QTransform &transform() const;

    const QTransform &deviceTransform() const;

    void resetTransform();

    void setWorldMatrix(const QMatrix &matrix, bool combine = false);

    const QMatrix &worldMatrix() const;

    void setWorldTransform(const QTransform &matrix, bool combine = false);

    const QTransform &worldTransform() const;

    QMatrix combinedMatrix() const;

    QTransform combinedTransform() const;

    void setMatrixEnabled(bool enabled);

    bool matrixEnabled() const;

    void setWorldMatrixEnabled(bool enabled);

    bool worldMatrixEnabled() const;

    void scale(qreal sx, qreal sy);

    void shear(qreal sh, qreal sv);

    void rotate(qreal a);

    void translate(const QPointF &offset);

    inline void translate(const QPoint &offset);

    inline void translate(qreal dx, qreal dy);

    QRect window() const;

    void setWindow(const QRect &window);

    inline void setWindow(int x, int y, int w, int h);

    QRect viewport() const;

    void setViewport(const QRect &viewport);

    inline void setViewport(int x, int y, int w, int h);

    void setViewTransformEnabled(bool enable);

    bool viewTransformEnabled() const;

    // drawing functions

    void strokePath(const QPainterPath &path, const QPen &pen);

    void fillPath(const QPainterPath &path, const QBrush &brush);

    void drawPath(const QPainterPath &path);

    inline void drawPoint(const QPointF &pt);

    inline void drawPoint(const QPoint &p);

    inline void drawPoint(int x, int y);

    void drawPoints(const QPointF *points, int pointCount);

    inline void drawPoints(const QPolygonF &points);

    void drawPoints(const QPoint *points, int pointCount);

    inline void drawPoints(const QPolygon &points);

    inline void drawLine(const QLineF &line);

    inline void drawLine(const QLine &line);

    inline void drawLine(int x1, int y1, int x2, int y2);

    inline void drawLine(const QPoint &p1, const QPoint &p2);

    inline void drawLine(const QPointF &p1, const QPointF &p2);

    void drawLines(const QLineF *lines, int lineCount);

    inline void drawLines(const QVector<QLineF> &lines);

    void drawLines(const QPointF *pointPairs, int lineCount);

    inline void drawLines(const QVector<QPointF> &pointPairs);

    void drawLines(const QLine *lines, int lineCount);

    inline void drawLines(const QVector<QLine> &lines);

    void drawLines(const QPoint *pointPairs, int lineCount);

    inline void drawLines(const QVector<QPoint> &pointPairs);

    inline void drawRect(const QRectF &rect);

    inline void drawRect(int x1, int y1, int w, int h);

    inline void drawRect(const QRect &rect);

    void drawRects(const QRectF *rects, int rectCount);

    inline void drawRects(const QVector<QRectF> &rectangles);

    void drawRects(const QRect *rects, int rectCount);

    inline void drawRects(const QVector<QRect> &rectangles);

    void drawEllipse(const QRectF &r);

    void drawEllipse(const QRect &r);

    inline void drawEllipse(int x, int y, int w, int h);

    inline void drawEllipse(const QPointF &center, qreal rx, qreal ry);

    inline void drawEllipse(const QPoint &center, int rx, int ry);

    void drawPolyline(const QPointF *points, int pointCount);

    inline void drawPolyline(const QPolygonF &polyline);

    void drawPolyline(const QPoint *points, int pointCount);

    inline void drawPolyline(const QPolygon &polygon);

    void drawPolygon(const QPointF *points, int pointCount, Qt::FillRule fillRule = Qt::OddEvenFill);

    inline void drawPolygon(const QPolygonF &polygon, Qt::FillRule fillRule = Qt::OddEvenFill);

    void drawPolygon(const QPoint *points, int pointCount, Qt::FillRule fillRule = Qt::OddEvenFill);

    inline void drawPolygon(const QPolygon &polygon, Qt::FillRule fillRule = Qt::OddEvenFill);

    void drawConvexPolygon(const QPointF *points, int pointCount);

    inline void drawConvexPolygon(const QPolygonF &polygon);

    void drawConvexPolygon(const QPoint *points, int pointCount);

    inline void drawConvexPolygon(const QPolygon &polygon);

    void drawArc(const QRectF &rect, int a, int alen);

    inline void drawArc(const QRect &, int a, int alen);

    inline void drawArc(int x, int y, int w, int h, int a, int alen);

    void drawPie(const QRectF &rect, int a, int alen);

    inline void drawPie(int x, int y, int w, int h, int a, int alen);

    inline void drawPie(const QRect &, int a, int alen);

    void drawChord(const QRectF &rect, int a, int alen);

    inline void drawChord(int x, int y, int w, int h, int a, int alen);

    inline void drawChord(const QRect &, int a, int alen);

    void drawRoundedRect(const QRectF &rect, qreal xRadius, qreal yRadius,

                         Qt::SizeMode mode = Qt::AbsoluteSize);

    inline void drawRoundedRect(int x, int y, int w, int h, qreal xRadius, qreal yRadius,

                                Qt::SizeMode mode = Qt::AbsoluteSize);

    inline void drawRoundedRect(const QRect &rect, qreal xRadius, qreal yRadius,

                                Qt::SizeMode mode = Qt::AbsoluteSize);

    void drawRoundRect(const QRectF &r, int xround = 25, int yround = 25);

    inline void drawRoundRect(int x, int y, int w, int h, int = 25, int = 25);

    inline void drawRoundRect(const QRect &r, int xround = 25, int yround = 25);

    void drawTiledPixmap(const QRectF &rect, const QPixmap &pm, const QPointF &offset = QPointF());

    inline void drawTiledPixmap(int x, int y, int w, int h, const QPixmap &, int sx=0, int sy=0);

    inline void drawTiledPixmap(const QRect &, const QPixmap &, const QPoint & = QPoint());

#ifndef QT_NO_PICTURE

    void drawPicture(const QPointF &p, const QPicture &picture);

    inline void drawPicture(int x, int y, const QPicture &picture);

    inline void drawPicture(const QPoint &p, const QPicture &picture);

#endif

    void drawPixmap(const QRectF &targetRect, const QPixmap &pixmap, const QRectF &sourceRect);

    inline void drawPixmap(const QRect &targetRect, const QPixmap &pixmap, const QRect &sourceRect);

    inline void drawPixmap(int x, int y, int w, int h, const QPixmap &pm,

                           int sx, int sy, int sw, int sh);

    inline void drawPixmap(int x, int y, const QPixmap &pm,

                           int sx, int sy, int sw, int sh);

    inline void drawPixmap(const QPointF &p, const QPixmap &pm, const QRectF &sr);

    inline void drawPixmap(const QPoint &p, const QPixmap &pm, const QRect &sr);

    void drawPixmap(const QPointF &p, const QPixmap &pm);

    inline void drawPixmap(const QPoint &p, const QPixmap &pm);

    inline void drawPixmap(int x, int y, const QPixmap &pm);

    inline void drawPixmap(const QRect &r, const QPixmap &pm);

    inline void drawPixmap(int x, int y, int w, int h, const QPixmap &pm);

    void drawPixmapFragments(const PixmapFragment *fragments, int fragmentCount,

                             const QPixmap &pixmap, PixmapFragmentHints hints = 0);

    void drawImage(const QRectF &targetRect, const QImage &image, const QRectF &sourceRect,

                   Qt::ImageConversionFlags flags = Qt::AutoColor);

    inline void drawImage(const QRect &targetRect, const QImage &image, const QRect &sourceRect,

                          Qt::ImageConversionFlags flags = Qt::AutoColor);

    inline void drawImage(const QPointF &p, const QImage &image, const QRectF &sr,

                          Qt::ImageConversionFlags flags = Qt::AutoColor);

    inline void drawImage(const QPoint &p, const QImage &image, const QRect &sr,

                          Qt::ImageConversionFlags flags = Qt::AutoColor);

    inline void drawImage(const QRectF &r, const QImage &image);

    inline void drawImage(const QRect &r, const QImage &image);

    void drawImage(const QPointF &p, const QImage &image);

    inline void drawImage(const QPoint &p, const QImage &image);

    inline void drawImage(int x, int y, const QImage &image, int sx = 0, int sy = 0,

                          int sw = -1, int sh = -1, Qt::ImageConversionFlags flags = Qt::AutoColor);

    void setLayoutDirection(Qt::LayoutDirection direction);

    Qt::LayoutDirection layoutDirection() const;

    void drawStaticText(const QPointF &topLeftPosition, const QStaticText &staticText);

    inline void drawStaticText(const QPoint &topLeftPosition, const QStaticText &staticText);

    inline void drawStaticText(int left, int top, const QStaticText &staticText);

    void drawText(const QPointF &p, const QString &s);

    inline void drawText(const QPoint &p, const QString &s);

    inline void drawText(int x, int y, const QString &s);

    void drawText(const QPointF &p, const QString &str, int tf, int justificationPadding);

    void drawText(const QRectF &r, int flags, const QString &text, QRectF *br=0);

    void drawText(const QRect &r, int flags, const QString &text, QRect *br=0);

    inline void drawText(int x, int y, int w, int h, int flags, const QString &text, QRect *br=0);

    void drawText(const QRectF &r, const QString &text, const QTextOption &o = QTextOption());

    QRectF boundingRect(const QRectF &rect, int flags, const QString &text);

    QRect boundingRect(const QRect &rect, int flags, const QString &text);

    inline QRect boundingRect(int x, int y, int w, int h, int flags, const QString &text);

    QRectF boundingRect(const QRectF &rect, const QString &text, const QTextOption &o = QTextOption());

    void drawTextItem(const QPointF &p, const QTextItem &ti);

    inline void drawTextItem(int x, int y, const QTextItem &ti);

    inline void drawTextItem(const QPoint &p, const QTextItem &ti);

    void fillRect(const QRectF &, const QBrush &);

    inline void fillRect(int x, int y, int w, int h, const QBrush &);

    void fillRect(const QRect &, const QBrush &);

    void fillRect(const QRectF &, const QColor &color);

    inline void fillRect(int x, int y, int w, int h, const QColor &color);

    void fillRect(const QRect &, const QColor &color);

    inline void fillRect(int x, int y, int w, int h, Qt::GlobalColor c);

    inline void fillRect(const QRect &r, Qt::GlobalColor c);

    inline void fillRect(const QRectF &r, Qt::GlobalColor c);

    inline void fillRect(int x, int y, int w, int h, Qt::BrushStyle style);

    inline void fillRect(const QRect &r, Qt::BrushStyle style);

    inline void fillRect(const QRectF &r, Qt::BrushStyle style);

    void eraseRect(const QRectF &);

    inline void eraseRect(int x, int y, int w, int h);

    inline void eraseRect(const QRect &);

    void setRenderHint(RenderHint hint, bool on = true);

    void setRenderHints(RenderHints hints, bool on = true);

    RenderHints renderHints() const;

    inline bool testRenderHint(RenderHint hint) const { return renderHints() & hint; }

    QPaintEngine *paintEngine() const;

    static void setRedirected(const QPaintDevice *device, QPaintDevice *replacement,

                              const QPoint& offset = QPoint());

    static QPaintDevice *redirected(const QPaintDevice *device, QPoint *offset = 0);

    static void restoreRedirected(const QPaintDevice *device);

    void beginNativePainting();

    void endNativePainting();

#ifdef QT3_SUPPORT

    inline QT3_SUPPORT void setBackgroundColor(const QColor &color) { setBackground(color); }

    inline QT3_SUPPORT const QColor &backgroundColor() const { return background().color(); }

    inline QT3_SUPPORT void drawText(int x, int y, const QString &s, int pos, int len)

        { drawText(x, y, s.mid(pos, len)); }

    inline QT3_SUPPORT void drawText(const QPoint &p, const QString &s, int pos, int len)

        { drawText(p, s.mid(pos, len)); }

    inline QT3_SUPPORT void drawText(int x, int y, const QString &s, int len)

        { drawText(x, y, s.left(len)); }

    inline QT3_SUPPORT void drawText(const QPoint &p, const QString &s, int len)

        { drawText(p, s.left(len)); }

    inline QT3_SUPPORT void drawText(const QRect &r, int flags, const QString &str, int len, QRect *br=0)

        { drawText(r, flags, str.left(len), br); }

    inline QT3_SUPPORT void drawText(int x, int y, int w, int h, int flags, const QString &text, int len, QRect *br=0)

        { drawText(QRect(x, y, w, h), flags, text.left(len), br); }

    inline QT3_SUPPORT QRect boundingRect(const QRect &rect, int flags, const QString &text, int len)

        { return boundingRect(rect, flags, text.left(len)); }

    inline QT3_SUPPORT QRect boundingRect(int x, int y, int w, int h, int flags, const QString &text, int len)

        { return boundingRect(QRect(x, y, w, h), flags, text.left(len)); }

    inline QT3_SUPPORT bool begin(QPaintDevice *pdev, const QWidget *init)

        { bool ret = begin(pdev); initFrom(init); return ret; }

    QT3_SUPPORT void drawPoints(const QPolygon &pa, int index, int npoints = -1)

    { drawPoints(pa.constData() + index, npoints == -1 ? pa.size() - index : npoints); }

    QT3_SUPPORT void drawCubicBezier(const QPolygon &pa, int index = 0);

    QT3_SUPPORT void drawLineSegments(const QPolygon &points, int index = 0, int nlines = -1);

    inline QT3_SUPPORT void drawPolyline(const QPolygon &pa, int index, int npoints = -1)

    { drawPolyline(pa.constData() + index, npoints == -1 ? pa.size() - index : npoints); }

    inline QT3_SUPPORT void drawPolygon(const QPolygon &pa, bool winding, int index = 0, int npoints = -1)

    { drawPolygon(pa.constData() + index, npoints == -1 ? pa.size() - index : npoints,

                  winding ? Qt::WindingFill : Qt::OddEvenFill); }

    inline QT3_SUPPORT void drawPolygon(const QPolygonF &polygon, bool winding, int index = 0,

                                      int npoints = -1)

    { drawPolygon(polygon.constData() + index, npoints == -1 ? polygon.size() - index : npoints,

                  winding ? Qt::WindingFill : Qt::OddEvenFill); }

    inline QT3_SUPPORT void drawConvexPolygon(const QPolygonF &polygon, int index, int npoints = -1)

    { drawConvexPolygon(polygon.constData() + index, npoints == -1 ? polygon.size() - index : npoints); }

    inline QT3_SUPPORT void drawConvexPolygon(const QPolygon &pa, int index, int npoints = -1)

    { drawConvexPolygon(pa.constData() + index, npoints == -1 ? pa.size() - index : npoints); }

    static inline QT3_SUPPORT void redirect(QPaintDevice *pdev, QPaintDevice *replacement)

    { setRedirected(pdev, replacement); }

    static inline QT3_SUPPORT QPaintDevice *redirect(QPaintDevice *pdev)

    { return const_cast<QPaintDevice*>(redirected(pdev)); }

    inline QT3_SUPPORT void setWorldXForm(bool enabled) { setMatrixEnabled(enabled); }

    inline QT3_SUPPORT bool hasWorldXForm() const { return matrixEnabled(); }

    inline QT3_SUPPORT void resetXForm() { resetTransform(); }

    inline QT3_SUPPORT void setViewXForm(bool enabled) { setViewTransformEnabled(enabled); }

    inline QT3_SUPPORT bool hasViewXForm() const { return viewTransformEnabled(); }

    QT3_SUPPORT void map(int x, int y, int *rx, int *ry) const;

    QT3_SUPPORT QPoint xForm(const QPoint &) const; // map virtual -> deviceb

    QT3_SUPPORT QRect xForm(const QRect &) const;

    QT3_SUPPORT QPolygon xForm(const QPolygon &) const;

    QT3_SUPPORT QPolygon xForm(const QPolygon &, int index, int npoints) const;

    QT3_SUPPORT QPoint xFormDev(const QPoint &) const; // map device -> virtual

    QT3_SUPPORT QRect xFormDev(const QRect &) const;