/* This file is part of the KDE project
 * Copyright (C) 2009 Jan Hambrecht <jaham@gmx.net>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef SVGPATTERNHELPER_H
#define SVGPATTERNHELPER_H

#include <QtGui/QImage>
#include <QtGui/QMatrix>
#include <QtXml/QDomElement>

class KoShape;

class SvgPatternHelper
{
public:
    enum Units { UserSpaceOnUse, ObjectBoundingBox };

    SvgPatternHelper();
    ~SvgPatternHelper();

    /// Set pattern units type (affects pattern x, y, width and height)
    void setPatternUnits( Units units );
    /// Return pattern units type
    Units patternUnits() const;

    /// Set pattern content units type (affects coordinates/length of pattern child shapes)
    void setPatternContentUnits( Units units );
    /// Returns pattern content units type
    Units patternContentUnits() const;

    /// Sets the pattern transformation found in attribute "patternTransform"
    void setTransform( const QMatrix &transform );
    /// Returns the pattern transform
    QMatrix transform() const;

    /// Sets pattern tile position
    void setPosition( const QPointF & position );
    /// Returns pattern tile position (objectBound is used when patternUnits == ObjectBoundingBox)
    QPointF position( const QRectF & objectBound ) const;

    /// Sets pattern tile size
    void setSize( const QSizeF & size );
    /// Returns pattern tile size (objectBound is used when patternUnits == ObjectBoundingBox)
    QSizeF size( const QRectF & objectBound ) const;

    /// Sets the dom element containing the pattern content
    void setContent( const QDomElement &content );
    /// Return the pattern content element
    QDomElement content() const;

    /// copies the content from the given pattern helper
    void copyContent( const SvgPatternHelper &other );

    /// Sets the pattern view box (the view box content is fitted into the pattern tile)
    void setPatternContentViewbox( const QRectF &viewBox );

    /// generates the pattern image from the given shapes and using the specified bounding box
    QImage generateImage( const QRectF &objectBound, const QList<KoShape*> content );

private:

    Units m_patternUnits;
    Units m_patternContentUnits;
    QMatrix m_transform;
    QPointF m_position;
    QSizeF m_size;
    QDomElement m_patternContent;
    QRectF m_patternContentViewbox;
};

#endif // SVGPATTERNHELPER_H
