Scribus
Open source desktop publishing at your fingertips
PDFlib Class Reference

#include <pdflib.h>

Inheritance diagram for PDFlib:
Collaboration diagram for PDFlib:

Public Member Functions

 PDFlib (ScribusDoc &docu)
 
bool doExport (const QString &fn, const QString &nam, int Components, const std::vector< int > &pageNs, const QMap< int, QPixmap > &thumbs)
 
const QString & errorMessage (void)
 
bool exportAborted (void)
 

Detailed Description

PDFLib provides an interface to the core PDF export functionality of scribus. This class does not directly implement export; it's purpose is to isolate implementation details from the rest of the codebase.

The real implementation is in pdflib_core.cpp .

Constructor & Destructor Documentation

PDFlib::PDFlib ( ScribusDoc docu)
explicit

Instantiate a new PDFLib that will operate on `docu'.

Warning
current PDFLib implementations may not function correctly if re-used for multiple exports. Create a new object for each job.
Parameters
docuDocument to use in export process

Member Function Documentation

bool PDFlib::doExport ( const QString &  fn,
const QString &  nam,
int  Components,
const std::vector< int > &  pageNs,
const QMap< int, QPixmap > &  thumbs 
)

Perform an export.

Parameters
fnOutput file name
nam??
Components??
pageNsList of pages from document to be exported as sequential PDF pages
thumbsA mapping of input (document) page numbers to pre-rendered thumbnails.
const QString & PDFlib::errorMessage ( void  )

Return an error message in case export has failed.

bool PDFlib::exportAborted ( void  )

Return if export has been aborted


The documentation for this class was generated from the following files: