/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/symbology-ng/qgssvgcache.h                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/






class QgsSvgCacheEntry
{

%TypeHeaderCode
#include "qgssvgcache.h"
%End
  public:
    QgsSvgCacheEntry();

    QgsSvgCacheEntry( const QString &path, double size, double strokeWidth, double widthScaleFactor, const QColor &fill, const QColor &stroke );
%Docstring
 Constructor.
 \param path Absolute path to SVG file (relative paths are not resolved).
 \param size
 \param strokeWidth width of stroke
 \param widthScaleFactor width scale factor
 \param fill color of fill
 \param stroke color of stroke
%End
    ~QgsSvgCacheEntry();


    QString path;
%Docstring
Absolute path to SVG file
%End
    double size; //size in pixels (cast to int for QImage)
    double strokeWidth;
    double widthScaleFactor;

    QSizeF viewboxSize;
%Docstring
 SVG viewbox size.
.. versionadded:: 2.14
%End

    QColor fill;
    QColor stroke;
    QImage *image;
    QPicture *picture;
    QByteArray svgContent;

    QgsSvgCacheEntry *nextEntry;
    QgsSvgCacheEntry *previousEntry;

    bool operator==( const QgsSvgCacheEntry &other ) const;
    int dataSize() const;
%Docstring
Return memory usage in bytes
 :rtype: int
%End

  private:
    QgsSvgCacheEntry( const QgsSvgCacheEntry &rh );
};

class QgsSvgCache : QObject
{
%Docstring
 A cache for images / pictures derived from svg files. This class supports parameter replacement in svg files
according to the svg params specification (http://www.w3.org/TR/2009/WD-SVGParamPrimer-20090616/). Supported are
the parameters 'fill-color', 'pen-color', 'outline-width', 'stroke-width'. E.g. <circle fill="param(fill-color red)" stroke="param(pen-color black)" stroke-width="param(outline-width 1)"

 QgsSvgCache is not usually directly created, but rather accessed through
 QgsApplication.svgCache().
%End

%TypeHeaderCode
#include "qgssvgcache.h"
%End
  public:

    QgsSvgCache( QObject *parent /TransferThis/ = 0 );
%Docstring
 Constructor for QgsSvgCache.
%End

    ~QgsSvgCache();

    QImage svgAsImage( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
                       double widthScaleFactor, bool &fitsInCache );
%Docstring
 Get SVG as QImage.
 \param path Absolute path to SVG file.
 \param size size of cached image
 \param fill color of fill
 \param stroke color of stroke
 \param strokeWidth width of stroke
 \param widthScaleFactor width scale factor
 \param fitsInCache
 :rtype: QImage
%End

    QPicture svgAsPicture( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
                           double widthScaleFactor, bool forceVectorOutput = false );
%Docstring
 Get SVG  as QPicture&.
 \param path Absolute path to SVG file.
 \param size size of cached image
 \param fill color of fill
 \param stroke color of stroke
 \param strokeWidth width of stroke
 \param widthScaleFactor width scale factor
 \param forceVectorOutput
 :rtype: QPicture
%End

    QSizeF svgViewboxSize( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
                           double widthScaleFactor );
%Docstring
 Calculates the viewbox size of a (possibly cached) SVG file.
 \param path Absolute path to SVG file.
 \param size size of cached image
 \param fill color of fill
 \param stroke color of stroke
 \param strokeWidth width of stroke
 \param widthScaleFactor width scale factor
 :return: viewbox size set in SVG file
.. versionadded:: 2.14
 :rtype: QSizeF
%End

    void containsParams( const QString &path, bool &hasFillParam, QColor &defaultFillColor, bool &hasStrokeParam, QColor &defaultStrokeColor, bool &hasStrokeWidthParam,
                         double &defaultStrokeWidth ) const;
%Docstring
 Tests if an svg file contains parameters for fill, stroke color, stroke width. If yes, possible default values are returned. If there are several
default values in the svg file, only the first one is considered*
%End

    void containsParams( const QString &path, bool &hasFillParam, bool &hasDefaultFillParam, QColor &defaultFillColor,
                         bool &hasFillOpacityParam, bool &hasDefaultFillOpacity, double &defaultFillOpacity,
                         bool &hasStrokeParam, bool &hasDefaultStrokeColor, QColor &defaultStrokeColor,
                         bool &hasStrokeWidthParam, bool &hasDefaultStrokeWidth, double &defaultStrokeWidth,
                         bool &hasStrokeOpacityParam, bool &hasDefaultStrokeOpacity, double &defaultStrokeOpacity ) const /PyName=containsParamsV3/;
%Docstring
 Tests if an svg file contains parameters for fill, stroke color, stroke width. If yes, possible default values are returned. If there are several
 default values in the svg file, only the first one is considered.
 \param path path to SVG file
 \param hasFillParam will be true if fill param present in SVG
 \param hasDefaultFillParam will be true if fill param has a default value specified
 \param defaultFillColor will be set to default fill color specified in SVG, if present
 \param hasFillOpacityParam will be true if fill opacity param present in SVG
 \param hasDefaultFillOpacity will be true if fill opacity param has a default value specified
 \param defaultFillOpacity will be set to default fill opacity specified in SVG, if present
 \param hasStrokeParam will be true if stroke param present in SVG
 \param hasDefaultStrokeColor will be true if stroke param has a default value specified
 \param defaultStrokeColor will be set to default stroke color specified in SVG, if present
 \param hasStrokeWidthParam will be true if stroke width param present in SVG
 \param hasDefaultStrokeWidth will be true if stroke width param has a default value specified
 \param defaultStrokeWidth will be set to default stroke width specified in SVG, if present
 \param hasStrokeOpacityParam will be true if stroke opacity param present in SVG
 \param hasDefaultStrokeOpacity will be true if stroke opacity param has a default value specified
 \param defaultStrokeOpacity will be set to default stroke opacity specified in SVG, if present
.. note::

   available in Python bindings as containsParamsV3
.. versionadded:: 2.14
%End

    QByteArray getImageData( const QString &path ) const;
%Docstring
Get image data
 :rtype: QByteArray
%End

    QByteArray svgContent( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
                           double widthScaleFactor );
%Docstring
Get SVG content
 :rtype: QByteArray
%End

  signals:
    void statusChanged( const QString  &statusQString );
%Docstring
Emit a signal to be caught by qgisapp and display a msg on status bar
%End

  protected:

    QgsSvgCacheEntry *insertSvg( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
                                 double widthScaleFactor );
%Docstring
 Creates new cache entry and returns pointer to it
 \param path Absolute path to SVG file
 \param size size of cached image
 \param fill color of fill
 \param stroke color of stroke
 \param strokeWidth width of stroke
 \param widthScaleFactor width scale factor
 :rtype: QgsSvgCacheEntry
%End

    void replaceParamsAndCacheSvg( QgsSvgCacheEntry *entry );
    void cacheImage( QgsSvgCacheEntry *entry );
    void cachePicture( QgsSvgCacheEntry *entry, bool forceVectorOutput = false );
    QgsSvgCacheEntry *cacheEntry( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
                                  double widthScaleFactor );
%Docstring
Returns entry from cache or creates a new entry if it does not exist already
 :rtype: QgsSvgCacheEntry
%End

    void trimToMaximumSize();
%Docstring
Removes the least used items until the maximum size is under the limit
%End

    void takeEntryFromList( QgsSvgCacheEntry *entry );

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/symbology-ng/qgssvgcache.h                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/