## Python: class PDFfile

class PDFfile(object)

For examples on how to implement these commands in a script, check the bottom section of this page.

Methods defined here:

Save(...)

  This method is deprecated - use save() instead.

__init__(...)

  x.__init__(...) initializes x; see x.__class__.__doc__ for signature

save(...)

  Save selected pages to pdf file

Data and other attributes defined here:

__new__ = <built-in method __new__ of type object>

  T.__new__(S, ...) -> a new object with type S, a subtype of T

allowAnnots = <member 'allowAnnots' of 'PDFfile' objects>

  Allow adding annotations and fields. Bool value

allowChange = <member 'allowChange' of 'PDFfile' objects>

  Allow changing the Document. Bool value

allowCopy = <member 'allowCopy' of 'PDFfile' objects>

  Allow copying text and graphics. Bool value

allowPrinting = <member 'allowPrinting' of 'PDFfile' objects>

  Allow printing the Document. Bool value

article = <member 'article' of 'PDFfile' objects>

  Save linked text frames as PDF articles
  Bool value

binding = <member 'binding' of 'PDFfile' objects>

  Choose binding.
  0 - Left binding
  1 - Right binding

bleedMarks = <attribute 'bleedMarks' of 'PDFfile' objects>

  Create marks delimiting the bleed area.

bleedb = <member 'bleedb' of 'PDFfile' objects>

  Bleed Bottom
  Distance for bleed from the bottom of the physical page

bleedl = <member 'bleedl' of 'PDFfile' objects>

  Bleed Left
  Distance for bleed from the left of the physical page

bleedr = <member 'bleedr' of 'PDFfile' objects>

  Bleed Right
  Distance for bleed from the right of the physical page

bleedt = <member 'bleedt' of 'PDFfile' objects>

  Bleed Top
  Distance for bleed from the top of the physical page

bookmarks = <member 'bookmarks' of 'PDFfile' objects>

  Embed the bookmarks you created in your document.
  These are useful for navigating long PDF documents.
  Bool value

colorMarks = <member 'colorMarks' of 'PDFfile' objects>

  Add color calibration bars.

compress = <member 'compress' of 'PDFfile' objects>

  Compression switch. Bool value.

compressmtd = <member 'compressmtd' of 'PDFfile' objects>

  Compression method.
  0 - Automatic
  1 - JPEG
  2 - zip
  3 - None.

cropMarks = <attribute 'cropMarks' of 'PDFfile' objects>

  Create crop marks in the PDF indicating where the paper should be cut or trimmed after printing.

displayBookmarks = <attribute 'displayBookmarks' of 'PDFfile' objects>

  Display the bookmarks upon opening.

displayFullscreen = <attribute 'displayFullscreen' of 'PDFfile' objects>

  Display the document in full screen mode upon opening.

displayLayers = <attribute 'displayLayers' of 'PDFfile' objects>

  Display the layer list upon opening. Useful only for PDF 1.5+.

displayThumbs = <attribute 'displayThumbs' of 'PDFfile' objects>

  Display the page thumbnails upon opening.

docInfoMarks = <member 'docInfoMarks' of 'PDFfile' objects>

  Add document information which includes the document title and page numbers.

doClip = <attribute 'doClip' of 'PDFfile' objects>

  Do not show objects outside the margins in the exported file.

downsample = <attribute 'downsample' of 'PDFfile' objects>

  Downsample image resolusion to this value. Values from 35 to 4000
  Set 0 for not to downsample

effval = <attribute 'effval' of 'PDFfile' objects>

  List of effection values for each saved page.

      It is list of list of six integers. Those int have the following meaning:
              - Length of time the page is shown before the presentation
              starts on the selected page. (1-3600)
              - Length of time the effect runs. (1 - 3600)
                      A shorter time will speed up the effect, a longer one will slow it down
              - Type of the display effect
                      0 - No Effect
                      1 - Blinds
                      2 - Box
                      3 - Dissolve
                      4 - Glitter
                      5 - Split
                      6 - Wipe
              - Direction of the effect of moving lines for the split and blind effects.
                      0 - Horizontal
                      1 - Vertical
              - Starting position for the box and split effects.
                      0 - Inside
                      1 - Outside
              - Direction of the glitter or wipe effects.
                      0 - Left to Right
                      1 - Top to Bottom
                      2 - Bottom to Top
                      3 - Right to Left
                      4 - Top-left to Bottom-Right

embedPDF = <member 'embedPDF' of 'PDFfile' objects>

  Export PDFs in image frames as embedded PDFs.
  This does *not* yet take care of colorspaces, so you should know what you are doing before setting this to 'true'.
  Bool value.

encrypt = <member 'encrypt' of 'PDFfile' objects>

  Use Encryption. Bool value

file = <attribute 'file' of 'PDFfile' objects>

  Name of file to save into

fitWindow = <attribute 'fitWindow' of 'PDFfile' objects>

  Fit the document page or pages to the available space in the viewer window.

fontEmbedding = <attribute 'fontEmbedding' of 'PDFfile' objects>

  Choose the font embedding mode :
  0 - Embed fonts fully or as subset depending on 'fonts' attribute
  1 - Outline fonts: fonts will be converted to vector
  2 - No embedding: no font will be embedded.

fonts = <attribute 'fonts' of 'PDFfile' objects>

  List of fonts to embed.

hideMenuBar = <attribute 'hideMenuBar' of 'PDFfile' objects>

  Hides the viewer menu bar, the PDF will display in a plain window.

hideToolBar = <attribute 'hideToolBar' of 'PDFfile' objects>

  Hides the viewer toolbar. The toolbar has usually selection and other editing capabilities.

imagepr = <attribute 'imagepr' of 'PDFfile' objects>

  Color profile for images

info = <attribute 'info' of 'PDFfile' objects>

  Mandatory string for PDF/X-3 or the PDF will fail PDF/X-3 conformance. We recommend you use the title of the document.

intenti = <member 'intenti' of 'PDFfile' objects>

  Rendering intent for images
  0 - Perceptual
  1 - Relative Colorimetric
  2 - Saturation
  3 - Absolute Colorimetric

intents = <member 'intents' of 'PDFfile' objects>

  Rendering intent for solid colors
  0 - Perceptual
  1 - Relative Colorimetric
  2 - Saturation
  3 - Absolute Colorimetric

isGrayscale = <attribute 'isGrayscale' of 'PDFfile' objects>

  Export PDF in grayscale.

lpival = <attribute 'lpival' of 'PDFfile' objects>

  Rendering Settings for individual colors.

      This is list of values for each color.
      Color values have structure [siii] which stand for:
              s - Color name ('Black', 'Cyan', 'Magenta', 'Yellow')
              i - Frequency (10 to 1000)
              i - Angle (-180 to 180)
              i - Spot Function
                      0 - Simple Dot
                      1 - Line
                      2 - Round
                      3 - Ellipse

  Be careful when supplying these values as they are not checked for validity.
markOffset = <member 'markOffset' of 'PDFfile' objects>

  Indicate the distance offset between mark and page area.

markLength = <member 'markLength' of 'PDFfile' objects>

  Indicate the length of crop and bleed marks.

mirrorH = <member 'mirrorH' of 'PDFfile' objects>

  Mirror Page(s) horizontally. Bool value.

mirrorV = <member 'mirrorV' of 'PDFfile' objects>

  Mirror Page(s) vertically. Bool value.

noembicc = <member 'noembicc' of 'PDFfile' objects>

  Don't use embedded ICC profiles. Bool value

outdst = <member 'outdst' of 'PDFfile' objects>

  Output destination.
  0 - screen
  1 - printer

owner = <attribute 'owner' of 'PDFfile' objects>

  Owner's password

pageLayout = <attribute 'pageLayout' of 'PDFfile' objects>

  Document layout in PDF viewer:
  0 - Show the document in single page mode
  1 - Show the document in single page mode with the pages displayed continuously end to end like a scroll
  2 - Show the document with facing pages, starting with the first page displayed on the left
  3 - Show the document with facing pages, starting with the first page displayed on the right

pages = <attribute 'pages' of 'PDFfile' objects>

  List of pages to print

presentation = <member 'presentation' of 'PDFfile' objects>

  Enable Presentation Effects.Bool value

printprofc = <attribute 'printprofc' of 'PDFfile' objects>

  Output profile for printing. If possible, get some guidance from your printer on profile selection.

profilei = <member 'profilei' of 'PDFfile' objects>

  Embed a color profile for images. Bool value.

profiles = <member 'profiles' of 'PDFfile' objects>

  Embed a color profile for solid colors. Bool value.

quality = <member 'quality' of 'PDFfile' objects>

  Image quality
  0 - Maximum
  1 - High
  2 - Medium
  3 - Low
  4 - Minimum

registrationMarks = <attribute 'registrationMarks' of 'PDFfile' objects>

  Add registration marks to each separation.

resolution = <attribute 'resolution' of 'PDFfile' objects>

  Resolution of output file. Values from 35 to 4000.

solidpr = <attribute 'solidpr' of 'PDFfile' objects>

  Color profile for solid colors

thumbnails = <member 'thumbnails' of 'PDFfile' objects>

  Generate thumbnails. Bool value.

useDocBleeds = <attribute 'useDocBleeds' of 'PDFfile' objects>

  Use the existing bleed settings from the document preferences. Bool value.

useLayers = <attribute 'useLayers' of 'PDFfile' objects>

  Layers in your document are exported to the PDF. Only available with PDF >= 1.5.

uselpi = <member 'uselpi' of 'PDFfile' objects>

  Use Custom Rendering Settings. Bool value

user = <attribute 'user' of 'PDFfile' objects>

  User's password

version = <member 'version' of 'PDFfile' objects>

  Choose PDF version to use:
  11 = PDF/X-1a
  12 = PDF/X-3
  13 = PDF 1.3 (Acrobat 4)
  14 = PDF 1.4 (Acrobat 5)
  15 = PDF 1.5 (Acrobat 6)

#### Examples of Usage

The simplest usage of these commands would be the following:

    pdf = scribus.PDFfile()
    pdf.file = 'MyFile.pdf'
    pdf.save()

which would save your file under the name MyFile.pdf to the current working directory. It would probably be better to specify a full pathname for your file to be sure where you have saved it. This sequence of commands would save the file using all of your default settings for PDF export.

Realistically, there are a number of commands you might want to specify, depending on your project, to ensure certain aspects, for example:

    pdf = scribus.PDFfile()
    pdf.file = 'MyFile.pdf'
    pdf.quality = 1
    pdf.fontEmbedding = 0
    pdf.version = 13
    pdf.pages = [2, 3, 4, 8]
    pdf.save()

This would add specifications for the quality of images, ensure font or subset embedding, PDF 1.3 version, and include only pages 2, 3, 4, and 8 from the document.

If you wish to save another document in the same script, it would need a new specification, such as:

    pdf2 = scribus.PDFfile()
    pdf2.file = 'MySecondFile.pdf'

and so on.