CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdPdfPublish::OdFile Class Reference

#include <PdfPublish.h>

Inheritance diagram for OdPdfPublish::OdFile:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdFile)
 
 ODRX_HEAP_OPERATORS ()
 
 OdFile ()
 
virtual ~OdFile ()
 
OdUInt32 exportPdf (OdDocumentPtr &doc, const OdString &file)
 
OdUInt32 exportPdf (OdDocumentPtr &doc, OdStreamBufPtr &output)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class implements file level operations for publishing drawings in .pdf format.

Definition at line 47 of file PdfPublish.h.

Constructor & Destructor Documentation

◆ OdFile()

OdPdfPublish::OdFile::OdFile ( )

Creates a file object for publishing.

◆ ~OdFile()

virtual OdPdfPublish::OdFile::~OdFile ( )
virtual

Destroys the file object for publishing.

Member Function Documentation

◆ exportPdf() [1/2]

OdUInt32 OdPdfPublish::OdFile::exportPdf ( OdDocumentPtr &  doc,
const OdString file 
)

Writes a specified document content to a specified file.

Parameters
doc[in] A smart pointer to the <link OdPdfPublish::OdDocument, document> instance.
file[in] A full path to the output file.
Returns
Returns the result of the write operation. If data has been written successfully, returns eOk, otherwise returns an error code.
Remarks
In case when a PDFToolkit exception occurs, method returns error code from PDFToolkit level. In case when other exception occurs, method returns particular error code. In case of unknown exception, method returns eInternalError value.

◆ exportPdf() [2/2]

OdUInt32 OdPdfPublish::OdFile::exportPdf ( OdDocumentPtr &  doc,
OdStreamBufPtr output 
)

Writes a specified document content to a specified data stream.

Parameters
doc[in] A smart pointer to the <link OdPdfPublish::OdDocument, document> instance.
output[in] A smart pointer to the output data stream buffer.
Returns
Returns the result of the write operation. If data has been written successfully, returns eOk, otherwise returns an error code.
Remarks
In case when a PDFToolkit exception occurs, method returns error code from PDFToolkit level. In case when other exception occurs, method returns particular error code. In case of unknown exception, method returns eInternalError value.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdFile::ODRX_DECLARE_MEMBERS ( OdFile  )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::OdFile::ODRX_HEAP_OPERATORS ( )

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