sclayer.h

/*
For general Scribus (>=1.3.2) copyright and licensing information please refer
to the COPYING file provided with the program. Following this notice may exist
a copyright and/or license notice that predates the release of Scribus 1.3.2
for which a new license (GPL+exception) is in place.
*/
#ifndef SCLAYER_H
#define SCLAYER_H

#include <QColor>
#include <QString>
#include <QList>
#include <QSet>    //necessary to avoid msvc warnings induced by SCRIBUS_API on ScLayers + early instanciation of templates

#include "scribusapi.h"

class SCRIBUS_API ScLayer
{
public:
    ScLayer(void);
    ScLayer(const QString& name, int level, int id);
    QString Name;
    int     ID;
    int     Level;
    bool    isPrintable;
    bool    isViewable;
    bool    isEditable;
    bool    isSelectable;
    bool    flowControl;
    bool    outlineMode;
    double  transparency;
    int     blendMode;
    QColor  markerColor;
    bool operator< (const ScLayer& other) const;
    bool operator== (const ScLayer& other) const;
};

class SCRIBUS_API ScLayers : public QList<ScLayer>
{
public:

    int getMaxID(void);

    const ScLayer* bottomLayer (void) const;

    const ScLayer* topLayer (void) const;

    void levelToLayer (ScLayer& layer, int level) const;

    ScLayer* bottom(void);

    ScLayer* top(void);

    ScLayer* byLevel(const int level);

    ScLayer* byID(const int nr);

    ScLayer* above (int nr);

    ScLayer* below (int nr);

    const ScLayer* layerByLevel (int level) const;

    const ScLayer* layerByID (int nr) const;

    const ScLayer* layerByName (const QString& name) const;

    const ScLayer* layerAbove (int level) const;

    const ScLayer* layerAbove (const ScLayer& layer) const;

    const ScLayer* layerBelow (int level) const;

    const ScLayer* layerBelow (const ScLayer& layer) const;

    int addLayer(const QString& layerName);

    int addLayer(const ScLayer& layer);

    ScLayer* newLayer(const QString& layerName);

    bool removeLayerByID(int id);

    bool removeLayerByLevel(int level);

    bool raiseLayer(int nr);

    bool lowerLayer(int nr);

    void sort(void);

    bool layerPrintable(const int layerID) const;

    bool setLayerPrintable(const int layerID, const bool isPrintable);

    bool layerVisible(const int layerID) const;

    bool setLayerVisible(const int layerID, const bool isViewable);

    bool layerLocked(const int layerID) const;

    bool setLayerLocked(const int layerID, const bool isViewable);

    bool layerFlow(const int layerID) const;

    bool setLayerFlow(const int layerID, const bool flow);

    bool layerOutline(const int layerID) const;

    bool setLayerOutline(const int layerID, const bool outline);

    double layerTransparency(const int layerID) const;

    bool setLayerTransparency(const int layerID, double trans);

    int layerBlendMode(const int layerID) const;

    bool setLayerBlendMode(const int layerID, int blend);

    QColor layerMarker(const int layerID) const;

     bool setLayerMarker(const int layerID, QColor color);

     bool layerSelectable(const int layerID) const;

     bool setLayerSelectable(const int layerID, const bool isSelectable);
};

uint qHash(const ScLayer& layer);

#endif