HPS::Publish::DocumentKey Class Reference

The DocumentKey class is a smart pointer to a Publish PDF document. More...

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::DocumentKey:

Collaboration diagram for HPS::Publish::DocumentKey:

Public Member Functions
	DocumentKey ()
	The default constructor creates an uninitialized DocumentKey object. More...
	DocumentKey (DocumentKey const &in_that)
	The copy constructor creates a DocumentKey object that shares the underlying smart-pointer of the source DocumentKey. More...
	DocumentKey (DocumentKey &&in_that)
	The move constructor creates a DocumentKey by transferring the underlying object of the rvalue reference to this DocumentKey. More...
virtual	~DocumentKey ()
	Releases a reference to this DocumentKey. More...
HPS::Type	ObjectType () const
DocumentKey &	operator= (DocumentKey const &in_that)
	Share the underlying smart-pointer of the DocumentKey source. More...
DocumentKey &	operator= (DocumentKey &&in_that)
	The move assignment operator transfers the underlying object of the rvalue reference to this DocumentKey. More...
virtual void	Assign (DocumentKey const &in_that)
	Share the underlying smart-pointer of the DocumentKey source. More...
bool	Equals (DocumentKey const &in_that) const
	Check if the source DocumentKey points to the same underlying impl as this DocumentKey. More...
bool	operator!= (DocumentKey const &in_that) const
	Check if the source DocumentKey points to a different impl than this DocumentKey. More...
bool	operator== (DocumentKey const &in_that) const
	Check if the source DocumentKey points to the same underlying impl as this DocumentKey. More...
void	Delete ()
	Closes the PDF document underlying this DocumentKey and frees the associated memory in Publish. More...
DocumentKey &	AddPage (PageKit const &in_page)
	Adds the given page to the document. More...
DocumentKey &	AddPages (size_t in_count, PageKit const in_pages[])
	Adds the given pages to the document. More...
DocumentKey &	AddPages (PageKitArray const &in_pages)
	Adds the given pages to the document. More...
DocumentKey &	SetInformation (char const *in_title, char const *in_author, char const *in_subject, char const *in_creator)
	Sets the title, author, subject and creator for this document. More...
DocumentKey &	SetPasswords (char const *in_user_password, char const *in_owner_password)
	Sets the passwords for this document. More...
DocumentKey &	AddJavaScript (char const *in_script_name, char const *in_source, Source::Type in_type=Source::Type::Code)
	Adds a named JavaScript source or file to the document. More...
DocumentKey &	AddJavaScript (size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[])
	Adds a list of named JavaScript sources or files to the document. More...
DocumentKey &	AddJavaScript (UTF8Array const &in_script_names, UTF8Array const &in_sources, SourceTypeArray const &in_types)
	Adds a list of named JavaScript sources or files to the document. More...
DocumentKey &	AddAttachment (char const *in_filename, char const *in_description)
	Adds an attachment to the document. More...
DocumentKey &	AddAttachments (size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[])
	Adds a list of attachments to the document. More...
DocumentKey &	AddAttachments (UTF8Array const &in_filenames, UTF8Array const &in_descriptions)
	Adds a list of attachments to the document. More...
DocumentKey &	AddIconImage (char const *in_name, ImageKit const &in_image)
	Adds an icon image to the document. More...
DocumentKey &	AddIconImages (size_t in_count, UTF8 const in_names[], ImageKit const in_images[])
	Adds icon images to the document. More...
DocumentKey &	AddIconImages (UTF8Array const &in_names, ImageKitArray const &in_images)
	Adds icon images to the document. More...
DocumentKey &	SetPermissions (size_t in_count, Permission::Type const in_permissions[])
	Sets document permissions. More...
DocumentKey &	SetPermissions (PermissionTypeArray const &in_permissions)
	Sets document permissions. More...
size_t	GetPageCount () const
	Gets the number of pages in the underlying PDF document. More...
DocumentKey &	RemovePage (size_t in_index)
	Removes the page at the given index from the underlying PDF document. More...
DocumentKey &	RemovePages (size_t in_start, size_t in_count)
	Removes the specified number of pages starting at the given index from the underlying PDF document. More...
DocumentKey &	RemovePages (size_t in_count, size_t const in_indices[])
	Removes the pages at the given indices from the underlying PDF document. More...
DocumentKey &	RemovePages (SizeTArray const &in_indices)
	Removes the pages at the given indices from the underlying PDF document. More...
DocumentKey &	RemoveAllPages ()
	Removes all pages from the underlying PDF document. More...
PageControl	GetPageControl (size_t in_index)
	Returns a control that allows the user to manipulate and query details of a page at the given index in the underlying PDF document. More...
PageControl const	GetPageControl (size_t in_index) const
	Returns a control that allows the user to manipulate and query details of a page at the given index in the underlying PDF document. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual bool	Empty () const
	Indicates whether this object has any values set on it. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::PublishDocumentKey

Detailed Description

The DocumentKey class is a smart pointer to a Publish PDF document.

It allows direct interaction with a PDF document.

Constructor & Destructor Documentation

DocumentKey() [1/3]

HPS::Publish::DocumentKey::DocumentKey

(

)

The default constructor creates an uninitialized DocumentKey object.

The Type() function will return Type::None.

DocumentKey() [2/3]

HPS::Publish::DocumentKey::DocumentKey

(

DocumentKey const &

in_that

)

The copy constructor creates a DocumentKey object that shares the underlying smart-pointer of the source DocumentKey.

Parameters

in_that

The source DocumentKey to copy.

DocumentKey() [3/3]

HPS::Publish::DocumentKey::DocumentKey

(

DocumentKey &&

in_that

)

The move constructor creates a DocumentKey by transferring the underlying object of the rvalue reference to this DocumentKey.

Parameters

in_kit

An rvalue reference to a DocumentKey to take the underlying object from.

~DocumentKey()

virtual HPS::Publish::DocumentKey::~DocumentKey ( )

virtual

Releases a reference to this DocumentKey.

When the last reference goes out of scope, the underlying PDF document will be closed and any associated memory will be released by Publish if necessary. This will not write the underlying PDF document out to disk.

Member Function Documentation

AddAttachment()

DocumentKey& HPS::Publish::DocumentKey::AddAttachment	(	char const *	in_filename,
		char const *	in_description
	)

Adds an attachment to the document.

If there is an existing attachment on the document with the given filename, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddFileAttachment.

Parameters

in_filename	UTF8-encoded filename of the file to be attached.
in_description	UTF8-encoded description of the file to be attached.

Returns

A reference to this DocumentKey.

AddAttachments() [1/2]

DocumentKey& HPS::Publish::DocumentKey::AddAttachments	(	size_t	in_count,
		UTF8 const	in_filenames[],
		UTF8 const	in_descriptions[]
	)

Adds a list of attachments to the document.

If there is an existing attachment on the document with a filename which is in the given list, it will get overwritten. These correspond to values that will be passed to A3DPDFDocumentAddFileAttachment.

Parameters

in_count	Size of the following arrays.
in_filenames	Filenames of the files to be attached.
in_descriptions	Descriptions of the files to be attached.

Returns

A reference to this DocumentKey.

AddAttachments() [2/2]

DocumentKey& HPS::Publish::DocumentKey::AddAttachments	(	UTF8Array const &	in_filenames,
		UTF8Array const &	in_descriptions
	)

Adds a list of attachments to the document.

If there is an existing attachment on the document with a filename which is in the given list, it will get overwritten. These correspond to values that will be passed to A3DPDFDocumentAddFileAttachment.

Parameters

in_filenames	Filenames of the files to be attached.
in_descriptions	Descriptions of the files to be attached.

Returns

A reference to this DocumentKey.

AddIconImage()

DocumentKey& HPS::Publish::DocumentKey::AddIconImage	(	char const *	in_name,
		ImageKit const &	in_image
	)

Adds an icon image to the document.

If there is an existing icon image on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddImageAsIcon.

Parameters

in_name	UTF8-encoded name of the icon image to be attached.
in_image	Image to be attached as an icon.

Returns

A reference to this DocumentKey.

AddIconImages() [1/2]

DocumentKey& HPS::Publish::DocumentKey::AddIconImages	(	size_t	in_count,
		UTF8 const	in_names[],
		ImageKit const	in_images[]
	)

Adds icon images to the document.

If there is an existing icon image on the document with a name which is in the given list, it will get overwritten. These correspond to the values that will be passed to A3DPDFDocumentAddImageAsIcon.

Parameters

in_count	Size of the following arrays.
in_names	Names of the icon images to be attached.
in_images	Images to be attached as icons.

Returns

A reference to this DocumentKey.

AddIconImages() [2/2]

DocumentKey& HPS::Publish::DocumentKey::AddIconImages	(	UTF8Array const &	in_names,
		ImageKitArray const &	in_images
	)

Adds icon images to the document.

If there is an existing icon image on the document with a name which is in the given list, it will get overwritten. These correspond to the values that will be passed to A3DPDFDocumentAddImageAsIcon.

Parameters

in_names	Names of the icon images to be attached.
in_images	Images to be attached as icons.

Returns

A reference to this DocumentKey.

AddJavaScript() [1/3]

DocumentKey& HPS::Publish::DocumentKey::AddJavaScript	(	char const *	in_script_name,
		char const *	in_source,
		Source::Type	in_type = Source::Type::Code
	)

Adds a named JavaScript source or file to the document.

If there is an existing script on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddJavascriptFromString.

Parameters

in_script_name	UTF8-encoded script name to be added to the document.
in_source	UTF8-encoded JavaScript source or file (depending on the following argument) to be added to the document.
in_type	The types of the preceding argument. Defaults to Source::Type::Code.

Returns

A reference to this DocumentKey.

AddJavaScript() [2/3]

DocumentKey& HPS::Publish::DocumentKey::AddJavaScript	(	size_t	in_count,
		UTF8 const	in_script_names[],
		UTF8 const	in_sources[],
		Source::Type const	in_types[]
	)

Adds a list of named JavaScript sources or files to the document.

If there is an existing script on the document with a name which is in the given list, it will get overwritten. These correspond to values that will be passed to A3DPDFDocumentAddJavascriptFromString.

Parameters

in_count	Size of the following arrays.
in_script_names	Script names to be added to the document.
in_sources	JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be added to the document.
in_types	Types for each item in the preceding argument array.

Returns

A reference to this DocumentKey.

AddJavaScript() [3/3]

DocumentKey& HPS::Publish::DocumentKey::AddJavaScript	(	UTF8Array const &	in_script_names,
		UTF8Array const &	in_sources,
		SourceTypeArray const &	in_types
	)

Adds a list of named JavaScript sources or files to the document.

If there is an existing script on the document with a name which is in the given list, it will get overwritten. These correspond to values that will be passed to A3DPDFDocumentAddJavascriptFromString.

Parameters

in_script_names	Script names to be added to the document.
in_sources	JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be added to the document.
in_types	Types for each item in the preceding argument array.

Returns

A reference to this DocumentKey.

AddPage()

DocumentKey& HPS::Publish::DocumentKey::AddPage

(

PageKit const &

in_page

)

Adds the given page to the document.

This will append the page after any existing pages on the document. This corresponds to the value that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Parameters

in_page

Page to add to the document.

Returns

A reference to this DocumentKey.

AddPages() [1/2]

DocumentKey& HPS::Publish::DocumentKey::AddPages	(	size_t	in_count,
		PageKit const	in_pages[]
	)

Adds the given pages to the document.

This will append the pages after any existing pages on the document. These correspond to values that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Parameters

in_count	Size of the Following array.
in_pages	Pages to add to the document.

Returns

A reference to this DocumentKey.

AddPages() [2/2]

DocumentKey& HPS::Publish::DocumentKey::AddPages

(

PageKitArray const &

in_pages

)

Adds the given pages to the document.

This will append the pages after any existing pages on the document. These correspond to values that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Parameters

in_pages

Pages to add to the document.

Returns

A reference to this DocumentKey.

Assign()

virtual void HPS::Publish::DocumentKey::Assign ( DocumentKey const &  in_that )

virtual

Share the underlying smart-pointer of the DocumentKey source.

Parameters

in_that

The DocumentKey source of the assignment.

Returns

A reference to this DocumentKey.

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

Delete()

void HPS::Publish::DocumentKey::Delete

(

)

Closes the PDF document underlying this DocumentKey and frees the associated memory in Publish.

This will effectively invalidate all references to the underlying PDF document (including other DocumentKey or PageControl objects which refer to the same document). This will not write the underlying PDF document out to disk.

Empty()

virtual bool HPS::Object::Empty ( ) const

inlinevirtualinherited

Indicates whether this object has any values set on it.

Returns

true if no values are set on this object, false otherwise.

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

Equals()

bool HPS::Publish::DocumentKey::Equals

(

DocumentKey const &

in_that

)

const

Check if the source DocumentKey points to the same underlying impl as this DocumentKey.

Parameters

in_that

The source DocumentKey to compare to this DocumentKey.

Returns

true if the objects reference the same impl, false otherwise.

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

GetPageControl() [1/2]

PageControl HPS::Publish::DocumentKey::GetPageControl

(

size_t

in_index

)

Returns a control that allows the user to manipulate and query details of a page at the given index in the underlying PDF document.

Parameters

in_index

The index of the page for which to create a PageControl. The index of the first page is 0.

Returns

A PageControl object for the specified page.

GetPageControl() [2/2]

PageControl const HPS::Publish::DocumentKey::GetPageControl

(

size_t

in_index

)

const

Returns a control that allows the user to manipulate and query details of a page at the given index in the underlying PDF document.

Parameters

in_index

The index of the page for which to create a PageControl. The index of the first page is 0.

Returns

A PageControl object for the specified page.

GetPageCount()

size_t HPS::Publish::DocumentKey::GetPageCount

(

)

const

Gets the number of pages in the underlying PDF document.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

ObjectType()

HPS::Type HPS::Publish::DocumentKey::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

operator!=()

bool HPS::Publish::DocumentKey::operator!=

(

DocumentKey const &

in_that

)

const

Check if the source DocumentKey points to a different impl than this DocumentKey.

Parameters

in_that

The source DocumentKey to compare to this DocumentKey.

Returns

true if the objects reference different impls, false otherwise.

operator=() [1/2]

DocumentKey& HPS::Publish::DocumentKey::operator=

(

DocumentKey const &

in_that

)

Share the underlying smart-pointer of the DocumentKey source.

Parameters

in_that

The DocumentKey source of the assignment.

Returns

A reference to this DocumentKey.

operator=() [2/2]

DocumentKey& HPS::Publish::DocumentKey::operator=

(

DocumentKey &&

in_that

)

The move assignment operator transfers the underlying object of the rvalue reference to this DocumentKey.

Parameters

in_kit

An rvalue reference to a DocumentKey to take the underlying object from.

Returns

A reference to this DocumentKey.

operator==()

bool HPS::Publish::DocumentKey::operator==

(

DocumentKey const &

in_that

)

const

Check if the source DocumentKey points to the same underlying impl as this DocumentKey.

Parameters

in_that

The source DocumentKey to compare to this DocumentKey.

Returns

true if the objects reference the same impl, false otherwise.

RemoveAllPages()

DocumentKey& HPS::Publish::DocumentKey::RemoveAllPages

(

)

Removes all pages from the underlying PDF document.

Returns

A reference to this DocumentKey.

RemovePage()

DocumentKey& HPS::Publish::DocumentKey::RemovePage

(

size_t

in_index

)

Removes the page at the given index from the underlying PDF document.

Parameters

in_index

The index of the page to remove from the underlying PDF document. The index of the first page is 0.

Returns

A reference to this DocumentKey.

RemovePages() [1/3]

DocumentKey& HPS::Publish::DocumentKey::RemovePages	(	size_t	in_start,
		size_t	in_count
	)

Removes the specified number of pages starting at the given index from the underlying PDF document.

Parameters

in_start	The first index at which to start to removing pages from the underlying PDF document. The index of the first page is 0.
in_count	The number of pages to remove from the underlying PDF document.

Returns

A reference to this DocumentKey.

RemovePages() [2/3]

DocumentKey& HPS::Publish::DocumentKey::RemovePages	(	size_t	in_count,
		size_t const	in_indices[]
	)

Removes the pages at the given indices from the underlying PDF document.

Parameters

in_count	Size of the following array.
in_indices	The indices of pages to remove from the underlying PDF document. The index of the first page is 0.

Returns

A reference to this DocumentKey.

RemovePages() [3/3]

DocumentKey& HPS::Publish::DocumentKey::RemovePages

(

SizeTArray const &

in_indices

)

Removes the pages at the given indices from the underlying PDF document.

Parameters

in_indices

The indices of pages to remove from the underlying PDF document. The index of the first page is 0.

Returns

A reference to this DocumentKey.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

SetInformation()

DocumentKey& HPS::Publish::DocumentKey::SetInformation	(	char const *	in_title,
		char const *	in_author,
		char const *	in_subject,
		char const *	in_creator
	)

Sets the title, author, subject and creator for this document.

These corresponds to the values that will be passed to A3DPDFDocumentInformationData::m_pcTitle, A3DPDFDocumentInformationData::m_pcAuthor, A3DPDFDocumentInformationData::m_pcSubject, and A3DPDFDocumentInformationData::m_pcCreator (respectively).

Parameters

in_title	UTF8-encoded title string to set on the document.
in_author	UTF8-encoded author string to set on the document.
in_subject	UTF8-encoded subject string to set on the document.
in_creator	UTF8-encoded creator string to set on the document.

Returns

A reference to this DocumentKey.

SetPasswords()

DocumentKey& HPS::Publish::DocumentKey::SetPasswords	(	char const *	in_user_password,
		char const *	in_owner_password
	)

Sets the passwords for this document.

This corresponds to the value that will be passed to A3DPDFDocumentSetPassword.

Parameters

in_user_password	UTF8-encoded password string required when opening, modifying or printing the document. If an empty string is specified, no password will be required.
in_owner_password	UTF8-encoded password string required when changing security features of document. If an empty string is specified, no password will be required.

Returns

A reference to this DocumentKey.

SetPermissions() [1/2]

DocumentKey& HPS::Publish::DocumentKey::SetPermissions	(	size_t	in_count,
		Permission::Type const	in_permissions[]
	)

Sets document permissions.

This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.

Parameters

in_count	Size of the following array.
in_permissions	The permissions to be set on the document.

Returns

A reference to this DocumentKey.

SetPermissions() [2/2]

DocumentKey& HPS::Publish::DocumentKey::SetPermissions

(

PermissionTypeArray const &

in_permissions

)

Sets document permissions.

This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.

Parameters

in_permissions

The permissions to be set on the document.

Returns

A reference to this DocumentKey.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns

The true type of the object in question.

Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

Member Data Documentation

staticType

const HPS::Type HPS::Publish::DocumentKey::staticType = HPS::Type::PublishDocumentKey

static

---

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

• sprk_publish.h