scribusstructs.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 SCRIBUSSTRUCTS_H
#define SCRIBUSSTRUCTS_H

#ifdef HAVE_CONFIG_H
#include "scconfig.h"
#endif

#include <QAction>
#include <QByteArray>
#include <QDebug>
#include <QKeySequence>
#include <QList>
#include <QPolygon>
#include <QStack>
#include <QString>
#include <QMap>
#include <QVector>

#include <vector>

#include "scribusapi.h"

#include "annotation.h"
#include "fpointarray.h"
#include "pageitem.h"
#include "margins.h"
#include "scfonts.h"
#include "scimagestructs.h"
#include "sctextstruct.h"
#include "vgradient.h"
#include "colormgmt/sccolormgmtstructs.h"

extern bool SCRIBUS_API compareDouble(double, double);

typedef struct
{
    int r;
    int g;
    int b;
    void getValues(int& vr, int& vg, int& vb) {vr = r; vg = g; vb = b;}
} RGBColor;

typedef struct
{
    int c;
    int m;
    int y;
    int k;
    void getValues(int& vc, int& vm, int& vy, int& vk) {vc = c; vm = m; vy = y; vk = k;}
} CMYKColor;

struct CopyContentsBuffer
{
    PageItem::ItemType sourceType;
    QString contentsFileName;
    double LocalScX;
    double LocalScY;
    double LocalX;
    double LocalY;
    double LocalRot;
    double ItemX;
    double ItemY;
    ScImageEffectList effects;
    QString inputProfile;
    bool   useEmbedded;
    eRenderIntent renderingIntent;
};

struct DocPagesSetup
{
    DocPagesSetup() : pageArrangement(0), firstPageLocation(0), firstPageNumber(0), orientation(0), autoTextFrames(false), columnDistance(0), columnCount(1) {}
    DocPagesSetup(int pa, int fpl, int fpn, int o, bool atf, double cd, double cc) :
        pageArrangement(pa), firstPageLocation(fpl), firstPageNumber(fpn), orientation(o), autoTextFrames(atf),
        columnDistance(cd), columnCount(cc) {}
    int pageArrangement;
    int firstPageLocation;
    int firstPageNumber;
    int orientation;
    bool autoTextFrames;
    double columnDistance;
    double columnCount;
};

struct PageSet
{
    QString Name;
    int FirstPage;
    int Rows;
    int Columns;
//  double GapHorizontal;
//  double GapVertical;
//  double GapBelow;
    QStringList pageNames;
};

struct CMSData
{
    QString DefaultMonitorProfile;
    QString DefaultPrinterProfile;
    QString DefaultImageRGBProfile;
    QString DefaultImageCMYKProfile;
    QString DefaultSolidColorRGBProfile;
    QString DefaultSolidColorCMYKProfile;
    int ComponentsInput2;
    eRenderIntent DefaultIntentImages;
    eRenderIntent DefaultIntentColors;
    bool CMSinUse;
    bool SoftProofOn;
    bool SoftProofFullOn;
    bool GamutCheck;
    bool BlackPoint;
} ;

struct SingleLine
{
    double Width;
    int Dash;
    int LineEnd;
    int LineJoin;
    QString Color;
    int Shade;
    // setter necessary for use with serializer/digester
    void setLineWidth(double value) { Width = value; }
    void setDash(int value)         { Dash = value; }
    void setLineEnd(int value)      { LineEnd = value; }
    void setLineJoin(int value)     { LineJoin = value; }
    void setColor(const QString& name) { Color = name; }
    void setShade(int value)        { Shade = value; }
    bool operator==(const SingleLine& other) const
    {
        if (!compareDouble(Width, other.Width) )
            return false;
        if ((Dash != other.Dash)  || (LineEnd != other.LineEnd) || (LineJoin != other.LineJoin) ||
            (Color != other.Color)|| (Shade != other.Shade))
            return false;
        return true;
    }
    bool operator!=(const SingleLine& other) const
    {
        return !(*this == other);
    }
};

struct Bullet  //used by style reader while importing ODT files
{
    QString name;
    QString charStr;
    double indent;
    double firstLineIndent;
    double tabPosition;
    CharStyle* style;
    Bullet() : name(""), charStr(""), indent(0.0), firstLineIndent(0.0), tabPosition(0.0), style(NULL) {}
    Bullet(QString n, QString ch) : name(n), charStr(ch), indent(0.0), firstLineIndent(0.0), tabPosition(0.0), style(NULL) {}
    Bullet(QString n, QString ch, double first, double ind, double tab, CharStyle* chStyle)
        { name = n; charStr = ch, firstLineIndent = first; indent = ind; tabPosition = tab; style = chStyle; }
};

struct ArrowDesc
{
    QString name;
    bool userArrow;
    FPointArray points;
};

struct PDFPresentationData
{
    PDFPresentationData() {
        pageEffectDuration = 1;
        pageViewDuration = 1;
        effectType = 0;
        Dm = M = Di = 0;
    }
    int pageEffectDuration;
    int pageViewDuration;
    int effectType;
    int Dm;
    int M;
    int Di;
};

struct LPIData
{
    int Frequency;
    int Angle;
    int SpotFunc;
};

struct Keys
{
    QString actionName;
    QString cleanMenuText;
    QKeySequence keySequence;
    int tableRow;
    QString menuName;
    int menuPos;
};

enum PrintEngine
{
    PostScript1 = 1,
    PostScript2 = 2,
    PostScript3 = 3,
    WindowsGDI  = 4
};
typedef QMap<QString, PrintEngine> PrintEngineMap;

struct PrintOptions
{
    bool firstUse;
    bool toFile;
    bool useAltPrintCommand;
    bool outputSeparations;
    bool useSpotColors;
    bool useColor;
    bool mirrorH;
    bool mirrorV;
    bool doGCR;
    bool doClip;
    bool setDevParam;
    bool useDocBleeds;
    bool cropMarks;
    bool bleedMarks;
    bool registrationMarks;
    bool colorMarks;
    bool includePDFMarks;
    int  copies;
    PrintEngine prnEngine;
    double markLength;
    double markOffset;
    MarginStruct bleeds;
    std::vector<int> pageNumbers;
    QString printerOptions;
    QString printer;
    QString filename;
    QString separationName;
    QStringList allSeparations;
    QString printerCommand;
    QByteArray devMode; // printer specific options on Windows
};

typedef QMap<QString,QString> ProfilesL;
// typedef QValueVector<SingleLine> multiLine;

class multiLine : public QList<SingleLine> {
public:
    QString shortcut;
    bool operator!=(const multiLine& other) const
    {
        return !(this->operator ==(other));
    }
};

typedef enum {
    MissingGlyph = 1,
    TextOverflow = 2,
    ObjectNotOnPage = 3,
    MissingImage = 4,
    ImageDPITooLow = 5,
    Transparency = 6,
    PDFAnnotField = 7,
    PlacedPDF = 8,
    ImageDPITooHigh = 9,
    ImageIsGIF = 10,
    BlendMode = 11,
    WrongFontInAnnotation = 12,
    NotCMYKOrSpot = 13,
    DeviceColorsAndOutputIntent = 14,
    FontNotEmbedded = 15,
    EmbeddedFontIsOpenType = 16,
    OffConflictLayers = 17,
    PartFilledImageFrame = 18,
    MarksChanged = 19,
    AppliedMasterDifferentSide = 20,
    EmptyTextFrame = 21
} PreflightError;

typedef QMap<PreflightError, int> errorCodes;


struct AlignObjs
{
    int ObjNr;
    int Group;
    double x1;
    double y1;
    double x2;
    double y2;
    double width;
    double height;
    QList<PageItem*> Objects;
};

enum PageOrientation
{
    portraitPage = 0,
    landscapePage = 1,
    customPage = 30
};

enum UpdateRequests
{
    reqColorsUpdate = 1,
    reqCharStylesUpdate = 2,
    reqParaStylesUpdate = 4,
    reqTextStylesUpdate = 6,
    reqArrowStylesUpdate = 8,
    reqLineStylesUpdate  = 16,
    reqSymbolsUpdate     = 32,
    reqDefFontListUpdate = 64,
    reqDocFontListUpdate = 128,
    reqStyleComboDocUpdate = 256,
    reqCmsOptionsUpdate  = 512,
    reqCustomShapeUpdate = 1024,
    reqInlinePalUpdate   = 2048,
    reqMarksUpdate       = 4096,
    reqNumUpdate         = 8192,
    reqUpdateAll = 65535
};

typedef QList<double> Guides;

struct Linked
{
    int Start;
    int StPag;
};

// this is a quick hack to combine runs until I've thought of something better -- AV
class LastStyles {
public:
    CharStyle Style;
    int StyleStart;
    QString ParaStyle;
    LastStyles() {
        StyleStart = 0;
        ParaStyle = "";
    }
};

class AttributeValue
{
    public:
        AttributeValue() : valid(false),  value("")
        {
        }
        AttributeValue(QString val)
        {
            if (val.isEmpty() || (val == ""))
            {
                valid = false;
                value.clear();
            }
            else
            {
                valid = true;
                value = val;
            }
        }
        bool valid;
        QString value;
};

//TODO: Dict license showing, URL background unzipping, checksumming, pkg mgr platforms warning
struct DownloadItem
{
    QString lang;
    QString version;
    QString files;
    QString extractfiles;
    QString url;
    QString desc;
    QString license;
    QString filetype;
    QString type;
    QString movetofile;
    bool download;
};

struct DownloadData
{
    int id;
    QUrl url;
    QString name;
    QString downloadLocation;
    QString destinationLocation;
    QString destinationName;
    typedef enum {New, Started, Paused, Finished, Successful, Failed} DownloadState;
    DownloadState state;
};

enum
{
    GS_ALL,
    GS_MARGINS,
    GS_FRAMES,
    GS_GRID,
    GS_GUIDES,
    GS_BASELINE,
    GS_LINKS,
    GS_CONTROLS,
    GS_RULERMODE,
    GS_RULERS,
    GS_COLUMNBORDERS,
    GS_LAYERMARKERS,
    GS_BLEED,
    GS_MAX
};

enum
{
    PS_ALL,
    PS_PROPERTIES,
    PS_OUTLINE,
    PS_SCRAPBOOK,
    PS_LAYER,
    PS_PAGE,
    PS_BOOKMARK,
    PS_7_UNUSED,
    PS_UNDO,
    PS_VERIFIER,
    PS_DOWNLOADS,
    PS_MAX
};

#endif