IPDFLibraryUtilsPublic Class Reference

#include <IPDFLibraryUtilsPublic.h>

Inheritance diagram for IPDFLibraryUtilsPublic:

Public Types
enum	{ kDefaultIID = IID_IPDFLIBRARYUTILSPUBLIC }

Public Member Functions
virtual bool16	IsPDFExportPort (IPMUnknown const *port) const =0
virtual void	AcquirePDFLibrary () const =0
virtual void	ReleasePDFLibrary () const =0
virtual bool16	IsLibraryAvailable () const =0
virtual bool	GetPDDocForPDFExportPort (IPMUnknown *port, PDDoc &document) const =0
virtual bool	GetPDPageForPDFExportPort (IPMUnknown *port, PDPage &page) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

A collection of PDF-specific utilities. These replace and extend functionality found in IPDFLibrary and IPDFDocPort.

Member Function Documentation

virtual void IPDFLibraryUtilsPublic::AcquirePDFLibrary ( ) const

pure virtual

Acquires the PDF library, ensuring that it is initialized.

Note: Call IsLibraryAvailable() to determine if the library is available for use.

Note: This call must be matched with a call to ReleasePDFLibrary(), even when IsLibraryAvailable() returns kFalse.

See Also

IsLibraryAvailable

ReleasePDFLibrary

virtual bool IPDFLibraryUtilsPublic::GetPDDocForPDFExportPort ( IPMUnknown *  port, PDDoc &  document  ) const

pure virtual

Retrieves PDDoc object stored by the specified port, which is assumed to be a PDF export port (ie., that a call to IsPDFExportPort() for the port would return kTrue).

Parameters

port	[IN] The port object from which to retrieve a PDDoc
document	[OUT] The PDDoc stored by the port

Returns

true if the port was a PDF export port and the port was successfully retrieved; otherwise false

See Also

IsPDFExportPort

virtual bool IPDFLibraryUtilsPublic::GetPDPageForPDFExportPort ( IPMUnknown *  port, PDPage &  page  ) const

pure virtual

Retrieves the current PDPage object stored by the specified port, which is assumed to be a PDF export port (ie., that a call to IsPDFExportPort() for the port would return kTrue).

Parameters

port	[IN] The port object from which to retrieve a PDPage
page	[OUT] The current PDPage stored by the port

Returns

true if the port was a PDF export port and the port was successfully retrieved; otherwise false

See Also

IsPDFExportPort

virtual bool16 IPDFLibraryUtilsPublic::IsLibraryAvailable ( ) const

pure virtual

Determines whether the PDF library is available for use.

Returns

kTrue if the library is available, or kFalse if not.

virtual bool16 IPDFLibraryUtilsPublic::IsPDFExportPort ( IPMUnknown const *  port ) const

pure virtual

Determines whether the specified object is a PDF export port.

Parameters

port	The object to test

Returns

kTrue if the viewport is a PDF export port, or kFalse if not.

virtual void IPDFLibraryUtilsPublic::ReleasePDFLibrary ( ) const

pure virtual

Releases the PDF library, ensuring that it is terminated when no longer needed.

See Also

AcquirePDFLibrary