qgseffectstack.h

Go to the documentation of this file.

/***************************************************************************
                             qgseffectstack.h
                             ----------------
    begin                : December 2014
    copyright            : (C) 2014 Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSEFFECTSTACK_H
#define QGSEFFECTSTACK_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgspainteffect.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

 
class CORE_EXPORT QgsEffectStack : public QgsPaintEffect SIP_NODEFAULTCTORS
{
  public:
    static QgsPaintEffect *create( const QVariantMap &map ) SIP_FACTORY;
 
    QgsEffectStack() = default;
 
    QgsEffectStack( const QgsEffectStack &other );

    QgsEffectStack( QgsEffectStack &&other ) SIP_SKIP;

    explicit QgsEffectStack( const QgsPaintEffect &effect );
 
    ~QgsEffectStack() override;
 
    Qgis::PaintEffectFlags flags() const override;
    QString type() const override { return u"effectStack"_s; }
    QgsEffectStack *clone() const override SIP_FACTORY;
    bool saveProperties( QDomDocument &doc, QDomElement &element ) const override;
    bool readProperties( const QDomElement &element ) override;

    QVariantMap properties() const override;

    void readProperties( const QVariantMap &props ) override;

    void appendEffect( QgsPaintEffect *effect SIP_TRANSFER );

    bool insertEffect( int index, QgsPaintEffect *effect SIP_TRANSFER );

    bool changeEffect( int index, QgsPaintEffect *effect SIP_TRANSFER );

    QgsPaintEffect *takeEffect( int index SIP_TRANSFERBACK );

    QList< QgsPaintEffect * > *effectList();

    int count() const { return mEffectList.count(); }

    QgsPaintEffect *effect( int index ) const;
 
    QgsEffectStack &operator=( const QgsEffectStack &rhs );
 
    QgsEffectStack &operator=( QgsEffectStack &&other ) SIP_SKIP;
 
 
  protected:
    void draw( QgsRenderContext &context ) override;
 
  private:
    QList< QgsPaintEffect * > mEffectList;
 
    void clearStack();
};
 
#endif // QGSEFFECTSTACK_H