PdfPublishDocument.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 

//
// PdfPublishDocument.h
//
 
#ifndef _PDF_PUBLISH_DOCUMENT_INCLUDED_
#define _PDF_PUBLISH_DOCUMENT_INCLUDED_
 
#include "PdfPublishBaseObject.h"
#include "PdfPublishPage.h"
#include "PdfPublishBookmark.h"
#include "PdfPublishCollection.h"
 
#include "DbBaseHostAppServices.h"
#include "Pdf/PdfVersion.h"

namespace OdPdfPublish{

class PDFPUBLISH_TOOLKIT OdDocument : public OdObject
{
  //DOM-IGNORE-BEGIN
protected:
  OdDocument();
  //DOM-IGNORE-END
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdDocument);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END

  virtual ~OdDocument();

  void setVersion(const OdPDF::PDFFormatVersions version);

  void setInformation(const OdString& title, const OdString& author, const OdString& subject, const OdString& creator);
  
  void addJavaScript(const OdString& name, const OdString& source, const Source::Type source_type = Source::kCode);
  
  void addIconImage(const OdString& name, const OdImagePtr& image);
  
  void addPage(const OdPagePtr& page);

  void addAttachment(const OdAttachedFilePtr& file);

  void setCollection(const OdCollectionPtr& collection);

  void setUserPassword(const OdString& user_password);

  void setOwnerPassword(const OdString& owner_password);

  void setAccessPermissionFlags(const AccessPermissions::AccessPermissionsFlags flags);

  void appendRootBookmark(const OdBookmarkPtr bookmark);

  void setRootBookmarks(const OdBookmarkPtrArray& bookmarks);

  void getVersion(OdPDF::PDFFormatVersions& version) const;

  void getInformation(OdString& title, OdString& author, OdString& subject, OdString& creator) const;
  
  void getJavaScripts(OdStringArray& names, OdStringArray& sources, OdSourceTypeArray& source_types) const;
  
  void getIconImages(OdStringArray& names, OdImagePtrArray& images) const;

  void getPages(OdPagePtrArray& pages) const;

  void getAttachments(OdAttachedFilePtrArray& files) const;

  void getCollection(OdCollectionPtr& collection) const;

  void getUserPassword(OdString& user_password) const;

  void getOwnerPassword(OdString& owner_password) const;

  AccessPermissions::AccessPermissionsFlags getAccessPermissionFlags() const;

  void getRootBookmarks(OdBookmarkPtrArray& bookmarks) const;

  void setHostServices(OdDbBaseHostAppServices* pHostApp);

  OdDbBaseHostAppServices* appServices() const;
};

SMARTPTR(OdDocument);
 
}
#endif // _PDF_PUBLISH_DOCUMENT_INCLUDED_