kgamesvgdocument.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2007 Mark A. Taff <kde@marktaff.com>                    *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Library General Public License          *
 *   version 2 as published by the Free Software Foundation                *
 *                                                                         *
 *   This program 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 program; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
 ***************************************************************************/

#ifndef _KGAMESVGDOCUMENT_H_
#define _KGAMESVGDOCUMENT_H_

#include <QtCore/QHash>
#include <QtCore/QStringList>
#include <QtGui/QMatrix>
#include <QtXml/QDomDocument>
#include "libkdegamesprivate_export.h"


class KGameSvgDocumentPrivate;

class KDEGAMESPRIVATE_EXPORT KGameSvgDocument : public QDomDocument
{
public:
    explicit KGameSvgDocument();

    KGameSvgDocument(const KGameSvgDocument &doc);

    virtual ~KGameSvgDocument();

    KGameSvgDocument& operator=(const KGameSvgDocument &doc);

    enum MatrixOption {
        ApplyToCurrentMatrix = 0x01,
        ReplaceCurrentMatrix = 0x02
    };
    typedef QFlags<MatrixOption> MatrixOptions;

    enum StylePropertySortOption {
        Unsorted = 0x01,
        UseInkscapeOrder = 0x02
    };
    typedef QFlags<StylePropertySortOption> StylePropertySortOptions;

    QDomNode elementByUniqueAttributeValue(const QString& attributeName, const QString& attributeValue);

    QDomNode elementById(const QString& attributeValue);

    void load();

    void load(const QString& svgFilename);

    void rotate(double degrees, const MatrixOptions& options = ApplyToCurrentMatrix);

    void translate(int xPixels, int yPixels, const MatrixOptions& options = ApplyToCurrentMatrix);

    void shear(double xRadians, double yRadians, const MatrixOptions& options = ApplyToCurrentMatrix);

    void skew(double xDegrees, double yDegrees, const MatrixOptions& options = ApplyToCurrentMatrix);

    void scale(double xFactor, double yFactor, const MatrixOptions& options = ApplyToCurrentMatrix);

    QDomNode currentNode() const;

    void setCurrentNode(const QDomNode& node);

    QString svgFilename() const;

    void setSvgFilename(const QString& svgFilename);

    QString styleProperty(const QString& propertyName) const;

    void setStyleProperty(const QString& propertyName, const QString& propertyValue);

    QString nodeToSvg() const;

    QByteArray nodeToByteArray() const;

    QString style() const;

    void setStyle(const QString& styleAttribute);

    QDomNodeList patterns() const;

    QDomNodeList linearGradients() const;

    QDomNodeList radialGradients() const;

    QDomNodeList defs() const;

    QDomNode def() const;

    QString transform() const;

    void setTransform(const QString& transformAttribute);

    QHash<QString, QString> styleProperties() const;

    void setStyleProperties(const QHash<QString, QString>& _styleProperties, const StylePropertySortOptions& options = Unsorted);

    QMatrix transformMatrix() const;

    void setTransformMatrix(QMatrix& matrix, const MatrixOptions& options = ApplyToCurrentMatrix);

private:


    KGameSvgDocumentPrivate * const d;

};
Q_DECLARE_OPERATORS_FOR_FLAGS(KGameSvgDocument::MatrixOptions)
Q_DECLARE_OPERATORS_FOR_FLAGS(KGameSvgDocument::StylePropertySortOptions)

#endif // _KGAMESVGDOCUMENT_H_