source/libs/poppler/poppler-src/poppler/PDFDocBuilder.h

   1 //========================================================================
   2 //
   3 // PDFDocBuilder.h
   4 //
   5 // This file is licensed under the GPLv2 or later
   6 //
   7 // Copyright 2010 Hib Eris <hib@hiberis.nl>
   8 // Copyright 2010 Albert Astals Cid <aacid@kde.org>
   9 //
  10 //========================================================================
  11
  12 #ifndef PDFDOCBUILDER_H
  13 #define PDFDOCBUILDER_H
  14
  15 #include "PDFDoc.h"
  16 class GooString;
  17
  18 //------------------------------------------------------------------------
  19 // PDFDocBuilder
  20 //
  21 // PDFDocBuilder is an abstract class that specifies the interface for
  22 // constructing PDFDocs.
  23 //------------------------------------------------------------------------
  24
  25 class PDFDocBuilder {
  26
  27 public:
  28
  29   virtual ~PDFDocBuilder() {};
  30
  31   // Builds a new PDFDoc. Returns a PDFDoc. You should check this PDFDoc
  32   // with PDFDoc::isOk() for failures.
  33   // The caller is responsible for deleting ownerPassword, userPassWord and guiData.
  34   virtual PDFDoc *buildPDFDoc(const GooString &uri, GooString *ownerPassword = NULL,
  35       GooString *userPassword = NULL, void *guiDataA = NULL) = 0;
  36
  37   // Returns gTrue if the builder supports building a PDFDoc from the URI.
  38   virtual GBool supports(const GooString &uri) = 0;
  39
  40 };
  41
  42 #endif /* PDFDOCBUILDER_H */