prefsstructs.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 PREFSSTRUCTS_H
#define PREFSSTRUCTS_H

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

#include <cstring>

#include <QColor>
#include <QString>
#include <QList>
#include <QSet>
#include <QHash>

#include "documentinformation.h"
#include "pagestructs.h"
#include "pdfoptions.h"
#include "scfonts.h"
#include "scpattern.h"
#include "vgradient.h"

struct CheckerPrefs
{
    CheckerPrefs() { 
        memset(this, 0, sizeof(CheckerPrefs));
    }

    bool ignoreErrors;
    bool autoCheck;
    bool checkGlyphs;
    bool checkOverflow;
    bool checkOrphans;
    bool checkPictures;
    bool checkResolution;
    double minResolution;
    double maxResolution;
    bool checkTransparency;
    bool checkAnnotations;
    bool checkRasterPDF;
    bool checkForGIF;
    bool ignoreOffLayers;
    bool checkOffConflictLayers; //Check whether layers are marked as visible but not to be printed or vice versa
    bool checkNotCMYKOrSpot; // colors must be either CMYK or spot (PDF/X-1a)
    bool checkDeviceColorsAndOutputIntent; // unmanaged colors (device colors) must agree with output intend
    bool checkFontNotEmbedded; // embedded PDF might use fonts without embedding
    bool checkFontIsOpenType; // embedded PDF might use OpenType font program (only allowed in PDF/X-4 and PDF 1.6)
    bool checkPartFilledImageFrames;
    bool checkOppositePageMaster;
    bool checkAppliedMasterDifferentSide;
    bool checkEmptyTextFrames;
};

typedef QMap<QString, CheckerPrefs> CheckerPrefsList;

struct VerifierPrefs
{
    CheckerPrefsList checkerPrefsList;
    bool showPagesWithoutErrors;
    bool showNonPrintingLayerErrors;
    QString curCheckProfile;
};

struct TypoPrefs
{
    int valueSuperScript; 
    int scalingSuperScript; 
    int valueSubScript; 
    int scalingSubScript; 
    int valueSmallCaps; 
    int autoLineSpacing; 
    int valueUnderlinePos; 
    int valueUnderlineWidth; 
    int valueStrikeThruPos; 
    int valueStrikeThruWidth; 

    inline bool operator==(const TypoPrefs &other)
    {
        return (memcmp(this, &other, sizeof(TypoPrefs)) == 0);
    }
    inline bool operator!=(const TypoPrefs &other)
    {
        return (memcmp(this, &other, sizeof(TypoPrefs)) != 0);
    }
};

struct WindowPrefs
{
    WindowPrefs() {
        xPosition = 0;
        yPosition = 0;
        width   = 640;
        height  = 480;
        visible = true;
        docked  = false;
        maximized = false;
    }

    int xPosition;
    int yPosition;
    int width;
    int height;
    bool visible;
    bool docked;
    bool maximized;
};

//User Interface
struct UIPrefs
{
    UIPrefs() {
        mouseMoveTimeout = 150;
        wheelJump = 40;
        applicationFontSize = 12;
        paletteFontSize = 10;
        recentDocCount = 5;
        useSmallWidgets = false;
        useTabs = false;
        showStartupDialog = true;
        showSplashOnStartup = true;
        stickyTools = false;
        grayscaleIcons = false;
    }

    int mouseMoveTimeout; 
    int wheelJump; 
    int applicationFontSize; 
    int paletteFontSize; 
    QString style;  
    int recentDocCount; 
    QStringList RecentDocs; 
    QString language; 
    bool useSmallWidgets; 
    bool useTabs;        
    bool showStartupDialog; 
    bool showSplashOnStartup; 
    bool stickyTools; 
    bool grayscaleIcons; 
    QString iconSet; 
    WindowPrefs mainWinSettings;
    QByteArray mainWinState;
};

//Paths
struct PathPrefs
{
    QString documents; 
    QString colorProfiles; 
    QString scripts; 
    QString documentTemplates; 
};

//Document Setup
struct DocumentSetupPrefs
{
    QString pageSize; 
    int pageOrientation; 
    double pageWidth; 
    double pageHeight; 
    MarginStruct margins; 
    MarginStruct bleeds; 
    int marginPreset; 
    int pagePositioning; 
    int docUnitIndex; 
    bool AutoSave;
    int AutoSaveTime;
    bool saveCompressed;
};

//Guides
struct GuidesPrefs
{
    QList<int> renderStackOrder;
    // render stack id 0 = PageMargins
    // render stack id 1 = BaselineGrid
    // render stack id 2 = Grid
    // render stack id 3 = Guides
    // render stack id 4 = Items
    int gridType;
    // type 0 lines
    // type 1 crosses and dots

    int grabRadius;
    double guideRad;

    bool guidesShown; 
    bool marginsShown; 
    bool gridShown; 
    bool baselineGridShown; 
    bool framesShown; 
    bool colBordersShown; 
    bool layerMarkersShown; 
    bool linkShown; 
    bool rulersShown; 

    double majorGridSpacing; 
    double minorGridSpacing; 
    double valueBaselineGrid; 
    double offsetBaselineGrid; 

    bool showPic;
    bool showControls;
    bool showBleed;
    bool rulerMode;



    QColor guideColor; 
    QColor marginColor; 
    QColor majorGridColor; 
    QColor minorGridColor; 
    QColor baselineGridColor; 
};

struct ItemToolPrefs
{
    /* Texttool */
    QString textFont; 
    int textSize; 
    QString textColor; 
    int textShade; 
    QString textStrokeColor; 
    int textStrokeShade; 
    QString textFillColor; 
    QString textLineColor; 
    int textFillColorShade; 
    int textLineColorShade; 
    int textColumns; 
    double textColumnGap; 
    QString textTabFillChar; 
    MarginStruct textDistances; 
    double textTabWidth; 
    /* ShapeTool */
    QString shapeLineColor; 
    QString shapeFillColor; 
    int shapeFillColorShade; 
    int shapeLineColorShade; 
    int shapeLineStyle; 
    double shapeLineWidth; 
    /* Line Tool */
    QString lineColor; 
    int lineColorShade; 
    double lineWidth; 
    int lineStyle; 
    int lineStartArrow; 
    int lineEndArrow; 
    /* Regular Polygon Tool */
    int polyCorners;  
    double polyFactor; 
    bool polyUseFactor; 
    double polyRotation; 
    double polyInnerRot; 
    double polyCurvature; 
    double polyOuterCurvature; 
    /* Image Tool */
    QString imageFillColor; 
    int imageFillColorShade; 
    QString imageStrokeColor; 
    int imageStrokeColorShade; 
    double imageScaleX; 
    double imageScaleY; 
    bool imageScaleType; 
    bool imageAspectRatio; 
    int imageLowResType; 
    bool imageUseEmbeddedPath; 
    /* Calligraphic Pen Tool */
    QString calligraphicPenFillColor; 
    QString calligraphicPenLineColor; 
    int calligraphicPenFillColorShade; 
    int calligraphicPenLineColorShade; 
    double calligraphicPenLineWidth; 
    double calligraphicPenAngle;        
    double calligraphicPenWidth;        
    int calligraphicPenStyle; 
    /* Arc Tool */
    double arcStartAngle;   
    double arcSweepAngle;   
    /* Spiral Tool */
    double spiralStartAngle;    
    double spiralEndAngle;  
    double spiralFactor;    
};

struct OperatorToolPrefs
{
    /* Magnifier Tool */
    int magMin; 
    int magMax; 
    int magStep; 
    /* Item Duplicate Offset */
    double dispX;
    double dispY;
    /* Rotation Tool constrain value */
    double constrain; 
};

struct HyphenatorPrefs
{
    int MinWordLen; 
    int HyCount; 
    QString Language; 
    QHash<QString, QString> specialWords; 
    QSet<QString> ignoredWords; 
    bool Automatic;
    bool AutoCheck;
};

struct FontPrefs
{
    SCFonts AvailFonts; 
    bool askBeforeSubstitute; 
    QMap<QString,QString> GFontSub;
};

struct PrinterPrefs
{
    QString PrinterName; 
    QString PrinterFile; 
    QString PrinterCommand; 
    bool ClipMargin; 
    bool GCRMode;
};

struct ColorPrefs
{
    ColorList DColors;
    QString DColorSet;
    CMSData DCMSset;
};

struct ItemAttrPrefs
{
    ObjAttrVector defaultItemAttributes; 
};

struct TOCPrefs
{
    ToCSetupVector defaultToCSetups; 
};

struct KeyboardShortcutsPrefs
{
    QMap<QString,Keys> KeyActions; 
};

struct ScrapbookPrefs
{
    QStringList RecentScrapbooks; 
    int numScrapbookCopies;
    bool doCopyToScrapbook; 
    bool persistentScrapbook; 
    bool writePreviews;     
};

struct DisplayPrefs
{
    bool marginColored; 
    bool showPageShadow; 
    QColor paperColor; 
    QColor scratchColor; 
    QColor frameColor; 
    QColor frameNormColor; 
    QColor frameGroupColor; 
    QColor frameLinkColor; 
    QColor frameLockColor; 
    QColor frameAnnotationColor; 
    QColor pageBorderColor; 
    QColor controlCharColor; 
    bool showToolTips; 
    bool showMouseCoordinates; 
    MarginStruct scratch; 
    double pageGapHorizontal; 
    double pageGapVertical; 
    double displayScale; 
    bool showVerifierWarningsOnCanvas; 
    bool showAutosaveClockOnCanvas; 
};

struct ExternalToolsPrefs
{
    QString gs_exe; 
    bool gs_AntiAliasText; 
    bool gs_AntiAliasGraphics; 
    int gs_Resolution; 
    QString imageEditorExecutable; 
    QString extBrowserExecutable; 
    QString uniconvExecutable; 
    QStringList latexConfigs;
    QMap<QString, QString> latexCommands;
    QString latexEditorExecutable; 
    int latexResolution; 
    bool latexForceDpi;
    bool latexStartWithEmptyFrames;
    QString pdfViewerExecutable; 
};

struct MiscellaneousPrefs
{
    bool haveStylePreview; 

    // lorem ipsum
    bool useStandardLI; 
    int paragraphsLI; 
};

struct StoryEditorPrefs
{
    QColor guiFontColorBackground; 
    QString guiFont; 
    bool smartTextSelection; 
};

struct PrintPreviewPrefs
{
    bool PrPr_Mode;
    bool PrPr_AntiAliasing;
    bool PrPr_Transparency;
    bool PrPr_C;
    bool PrPr_M;
    bool PrPr_Y;
    bool PrPr_K;
    bool PrPr_InkCoverage;
    int PrPr_InkThreshold;
};

struct PluginPrefs
{
};

struct ShortWordPrefs
{
};

struct ScripterPrefs
{
};

// Image Cache
struct ImageCachePrefs
{
    bool cacheEnabled;  
    int maxCacheSizeMiB;  
    int maxCacheEntries;  
    int compressionLevel; 
};

struct ApplicationPrefs
{
    ColorPrefs colorPrefs;
    DisplayPrefs displayPrefs;
    DocumentSetupPrefs docSetupPrefs;
    ExternalToolsPrefs extToolPrefs;
    FontPrefs fontPrefs;
    GuidesPrefs guidesPrefs;
    HyphenatorPrefs hyphPrefs;
    ImageCachePrefs imageCachePrefs;
    ItemAttrPrefs itemAttrPrefs;
    ItemToolPrefs itemToolPrefs;
    KeyboardShortcutsPrefs keyShortcutPrefs;
    MiscellaneousPrefs miscPrefs;
    OperatorToolPrefs opToolPrefs;
    PDFOptions pdfPrefs;
    PathPrefs pathPrefs;
    PluginPrefs pluginPrefs;
    PrintPreviewPrefs printPreviewPrefs;
    PrinterPrefs printerPrefs;
    ScrapbookPrefs scrapbookPrefs;
    ScripterPrefs scripterPrefs;
    ShortWordPrefs shortwordPrefs;
    StoryEditorPrefs storyEditorPrefs;
    TOCPrefs tocPrefs;
    TypoPrefs typoPrefs;
    UIPrefs uiPrefs;
    VerifierPrefs verifierPrefs;

    QList<ArrowDesc> arrowStyles;
    QHash<QString, VGradient> defaultGradients;
    QHash<QString, ScPattern> defaultPatterns;
    QList<PageSet> pageSets;
    QStringList activePageSizes;



    //TODO : Remove these no longer used items
    QString ui_SystemTheme;
    //  bool Gcr_Mode;

    //Added for Doc Only
    DocumentInformation docInfo;
    DocumentSectionMap docSectionMap;
};

struct ScIconSetData
{
    QString path;
    QString baseName;
    QString license;
    QString author;
    QString activeversion;
    QMap<QString, QString> nameTranslations;
};


#endif