Scribus
Open source desktop publishing at your fingertips
Public Types | Public Member Functions | Public Attributes | List of all members
PDFOptions Class Reference

PDF Options struture. Capable of verifying its self, but otherwise largely a dumb struct. More...

#include <pdfoptions.h>

Collaboration diagram for PDFOptions:
Collaboration graph
[legend]

Public Types

enum  VerifyResults { Verify_NoError = 0, Verify_OptionConflict, Verify_OptionOutOfRange, Verify_OtherError }
 
enum  PDFVersion {
  PDFVersion_13 = 13, PDFVersion_14 = 14, PDFVersion_15 = 15, PDFVersion_X1a = 11,
  PDFVersion_X3 = 12, PDFVersion_X4 = 10, PDFVersion_Min = 10, PDFVersion_Max = 15
}
 
enum  PDFPageLayout { SinglePage = 0, OneColumn, TwoColumnLeft, TwoColumnRight }
 
enum  PDFCompression { Compression_Auto = 0, Compression_JPEG = 1, Compression_ZIP = 2, Compression_None = 3 }
 
enum  PDFFontEmbedding { EmbedFonts = 0, OutlineFonts = 1, DontEmbed = 2 }
 

Public Member Functions

PDFOptions::VerifyResults verify (QString *problemDescription)
 Sanity check the options defined. More...
 
PDFOptions::VerifyResults verify ()
 

Public Attributes

bool firstUse
 
bool Thumbnails
 
bool Articles
 
bool useLayers
 
bool Compress
 
PDFCompression CompressMethod
 
int Quality
 
bool RecalcPic
 
bool Bookmarks
 
int PicRes
 
bool embedPDF
 
PDFVersion Version
 
int Resolution
 
int Binding
 
PDFFontEmbedding FontEmbedding
 
QList< QString > EmbedList
 
QList< QString > SubsetList
 
QList< QString > OutlineList
 
bool MirrorH
 
bool MirrorV
 
bool doClip
 
int RotateDeg
 
bool PresentMode
 
QString fileName
 
bool isGrayscale
 
bool UseRGB
 
bool UseProfiles
 
bool UseProfiles2
 
bool UseLPI
 
bool UseSpotColors
 
bool doMultiFile
 
bool openAfterExport
 
QMap< QString, LPIData > LPISettings
 
QString SolidProf
 
int SComp
 
QString ImageProf
 
bool EmbeddedI
 
int Intent2
 
QString PrintProf
 
QString Info
 
int Intent
 
MarginStruct bleeds
 
bool Encrypt
 
QString PassOwner
 
QString PassUser
 
int Permissions
 
int PageLayout
 
bool displayBookmarks
 
bool displayThumbs
 
bool displayLayers
 
bool displayFullscreen
 
bool hideToolBar
 
bool hideMenuBar
 
bool fitWindow
 
bool cropMarks
 
bool bleedMarks
 
bool registrationMarks
 
bool colorMarks
 
bool docInfoMarks
 
bool useDocBleeds
 
double markLength
 
double markOffset
 
QString openAction
 
int pageRangeSelection
 
QString pageRangeString
 

Detailed Description

PDF Options struture. Capable of verifying its self, but otherwise largely a dumb struct.

If you change this class, please ensure that PDFOptionsIO is updated to match and scribus/dtd/scribuspdfoptions.dtd is tweaked if required.

See also
PDFOptionsIO

Member Function Documentation

PDFOptions::VerifyResults PDFOptions::verify ( QString *  problemDescription)

Sanity check the options defined.

Author
Craig Ringer Unimplemented, always returns Verify_NoError

Checks the PDF option structure for conflicts between mututally exclusive options, ensures all options are within sane ranges, and that there are no nonsensical options values set. If nothing is wrong, returns Verify_NoError, otherwise returns error code from PDFOptions::VerifyResults. If problemDescription is not NULL, it will contain a human-readable description of the error on return.

Warning
DO NOT EVER TEST THE VALUE OF problemDescription. Rely on the return code instead. problemDescription is subject to translation and its contents may change without notice.
Parameters
problemDescriptionError description
Returns
Verify_NoError for sane options, otherwise error code.
The documentation for this class was generated from the following files: