#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::DocumentKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

DocumentKitAddAttachment (char const *in_filename, char const *in_description)
 
DocumentKitAddAttachments (size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[])
 
DocumentKitAddAttachments (UTF8Array const &in_filenames, UTF8Array const &in_descriptions)
 
DocumentKitAddDataTable (DataTableKit const &in_data_table)
 
DocumentKitAddDataTables (DataTableKitArray const in_data_table)
 
DocumentKitAddIconImage (char const *in_name, ImageKit const &in_image)
 
DocumentKitAddIconImages (size_t in_count, UTF8 const in_names[], ImageKit const in_images[])
 
DocumentKitAddIconImages (UTF8Array const &in_names, ImageKitArray const &in_images)
 
DocumentKitAddJavaScript (char const *in_script_name, char const *in_source, Source::Type in_type=Source::Type::Code)
 
DocumentKitAddJavaScript (size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[])
 
DocumentKitAddJavaScript (UTF8Array const &in_script_names, UTF8Array const &in_sources, SourceTypeArray const &in_types)
 
DocumentKitAddPage (PageKit const &in_page)
 
DocumentKitAddPages (size_t in_count, PageKit const in_pages[])
 
DocumentKitAddPages (PageKitArray const &in_pages)
 
 DocumentKit ()
 
 DocumentKit (DocumentKit const &in_kit)
 
 DocumentKit (DocumentKit &&in_kit)
 
bool Empty () const
 
bool Equals (DocumentKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (DocumentKit const &in_kit) const
 
DocumentKitoperator= (DocumentKit const &in_kit)
 
DocumentKitoperator= (DocumentKit &&in_kit)
 
bool operator== (DocumentKit const &in_kit) const
 
void Set (DocumentKit const &in_kit)
 
DocumentKitSetInformation (char const *in_title, char const *in_author, char const *in_subject, char const *in_creator)
 
DocumentKitSetPage (PageKit const &in_page)
 
DocumentKitSetPages (size_t in_count, PageKit const in_pages[])
 
DocumentKitSetPages (PageKitArray const &in_pages)
 
DocumentKitSetPasswords (char const *in_user_password, char const *in_owner_password)
 
DocumentKitSetPermissions (size_t in_count, Permission::Type const in_permissions[])
 
DocumentKitSetPermissions (PermissionTypeArray const &in_permissions)
 
void Show (DocumentKit &out_kit) const
 
bool ShowAttachments (UTF8Array &out_filenames, UTF8Array &out_descriptions) const
 
bool ShowDataTables (DataTableKitArray &out_data_tables) const
 
bool ShowIconImages (UTF8Array &out_names, ImageKitArray &out_images) const
 
bool ShowInformation (UTF8 &out_title, UTF8 &out_author, UTF8 &out_subject, UTF8 &out_creator) const
 
bool ShowJavaScript (UTF8Array &out_script_names, UTF8Array &out_sources, SourceTypeArray &out_types) const
 
bool ShowPages (PageKitArray &out_pages) const
 
bool ShowPasswords (UTF8 &out_user_password, UTF8 &out_owner_password) const
 
bool ShowPermissions (PermissionTypeArray &out_permissions) const
 
DocumentKitUnsetAttachment (char const *in_filename)
 
DocumentKitUnsetAttachments (size_t in_count, UTF8 const in_filenames[])
 
DocumentKitUnsetAttachments (UTF8Array const &in_filenames)
 
DocumentKitUnsetAttachments ()
 
DocumentKitUnsetDatatables ()
 
DocumentKitUnsetEverything ()
 
DocumentKitUnsetIconImage (char const *in_name)
 
DocumentKitUnsetIconImages (size_t in_count, UTF8 const in_names[])
 
DocumentKitUnsetIconImages (UTF8Array const &in_names)
 
DocumentKitUnsetIconImages ()
 
DocumentKitUnsetInformation ()
 
DocumentKitUnsetJavaScript (char const *in_script_name)
 
DocumentKitUnsetJavaScript (size_t in_count, UTF8 const in_script_names[])
 
DocumentKitUnsetJavaScript (UTF8Array const &in_script_names)
 
DocumentKitUnsetJavaScript ()
 
DocumentKitUnsetPage (size_t in_index)
 
DocumentKitUnsetPages (size_t in_count, size_t const in_indices[])
 
DocumentKitUnsetPages (SizeTArray const &in_indices)
 
DocumentKitUnsetPages ()
 
DocumentKitUnsetPasswords ()
 
DocumentKitUnsetPermissions ()
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Member Functions

static DocumentKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PublishDocumentKit
 
- Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type staticType = HPS::Type::SprocketKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::SprocketKit
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

Detailed Description

The DocumentKit class is a user space object. It acts as the root container for all pages in a Publish PDF.

Constructor & Destructor Documentation

◆ DocumentKit() [1/3]

HPS::Publish::DocumentKit::DocumentKit ( )

The default constructor creates an empty DocumentKit object.

◆ DocumentKit() [2/3]

HPS::Publish::DocumentKit::DocumentKit ( DocumentKit const &  in_kit)

The copy constructor creates a new DocumentKit object that contains the same settings as the source DocumentKit.

Parameters
in_kitThe source DocumentKit to copy.

◆ DocumentKit() [3/3]

HPS::Publish::DocumentKit::DocumentKit ( DocumentKit &&  in_kit)

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

Parameters
in_kitAn rvalue reference to a DocumentKit to take the underlying object from.

Member Function Documentation

◆ AddAttachment()

DocumentKit& HPS::Publish::DocumentKit::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_filenameUTF8-encoded filename of the file to be attached.
in_descriptionUTF8-encoded description of the file to be attached.
Returns
A reference to this DocumentKit.

◆ AddAttachments() [1/2]

DocumentKit& HPS::Publish::DocumentKit::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_countSize of the following arrays.
in_filenamesFilenames of the files to be attached.
in_descriptionsDescriptions of the files to be attached.
Returns
A reference to this DocumentKit.

◆ AddAttachments() [2/2]

DocumentKit& HPS::Publish::DocumentKit::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_filenamesFilenames of the files to be attached.
in_descriptionsDescriptions of the files to be attached.
Returns
A reference to this DocumentKit.

◆ AddDataTable()

DocumentKit& HPS::Publish::DocumentKit::AddDataTable ( DataTableKit const &  in_data_table)

Adds an data table to the document.

Parameters
in_data_tableData Table to be added into the document.
Returns
A reference to this DocumentKit.

◆ AddDataTables()

DocumentKit& HPS::Publish::DocumentKit::AddDataTables ( DataTableKitArray const  in_data_table)

Adds data tables to the document.

Parameters
in_data_tableData Tables to be added into the document.
Returns
A reference to this DocumentKit.

◆ AddIconImage()

DocumentKit& HPS::Publish::DocumentKit::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_nameUTF8-encoded name of the icon image to be attached.
in_imageImage to be attached as an icon.
Returns
A reference to this DocumentKit.

◆ AddIconImages() [1/2]

DocumentKit& HPS::Publish::DocumentKit::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_countSize of the following arrays.
in_namesNames of the icon images to be attached.
in_imagesImages to be attached as icons.
Returns
A reference to this DocumentKit.

◆ AddIconImages() [2/2]

DocumentKit& HPS::Publish::DocumentKit::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_namesNames of the icon images to be attached.
in_imagesImages to be attached as icons.
Returns
A reference to this DocumentKit.

◆ AddJavaScript() [1/3]

DocumentKit& HPS::Publish::DocumentKit::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_nameUTF8-encoded script name to be added to the document.
in_sourceUTF8-encoded JavaScript source or file (depending on the following argument) to be added to the document.
in_typeThe types of the preceding argument. Defaults to Source::Type::Code.
Returns
A reference to this DocumentKit.

◆ AddJavaScript() [2/3]

DocumentKit& HPS::Publish::DocumentKit::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_countSize of the following arrays.
in_script_namesScript names to be added to the document.
in_sourcesJavaScript sources and/or files (depending on the corresponding entry in the following argument) to be added to the document.
in_typesTypes for each item in the preceding argument array.
Returns
A reference to this DocumentKit.

◆ AddJavaScript() [3/3]

DocumentKit& HPS::Publish::DocumentKit::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_namesScript names to be added to the document.
in_sourcesJavaScript sources and/or files (depending on the corresponding entry in the following argument) to be added to the document.
in_typesTypes for each item in the preceding argument array.
Returns
A reference to this DocumentKit.

◆ AddPage()

DocumentKit& HPS::Publish::DocumentKit::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_pagePage to add to the document.
Returns
A reference to this DocumentKit.

◆ AddPages() [1/2]

DocumentKit& HPS::Publish::DocumentKit::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_countSize of the following array.
in_pagesPages to add to the document.
Returns
A reference to this DocumentKit.

◆ AddPages() [2/2]

DocumentKit& HPS::Publish::DocumentKit::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_pagesPages to add to the document.
Returns
A reference to this DocumentKit.

◆ Empty()

bool HPS::Publish::DocumentKit::Empty ( ) const
virtual

Indicates whether this DocumentKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Publish::DocumentKit::Equals ( DocumentKit const &  in_kit) const

Check if the source DocumentKit is equivalent to this DocumentKit.

Parameters
in_kitThe source DocumentKit to compare to this DocumentKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static DocumentKit HPS::Publish::DocumentKit::GetDefault ( )
static

Creates a DocumentKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the DocumentKit passed to File::Export.

Returns
A DocumentKit with the default settings.

◆ ObjectType()

HPS::Type HPS::Publish::DocumentKit::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::SprocketKit.

◆ operator!=()

bool HPS::Publish::DocumentKit::operator!= ( DocumentKit const &  in_kit) const

Check if the source DocumentKit is not equivalent to this DocumentKit.

Parameters
in_kitThe source DocumentKit to compare to this DocumentKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

DocumentKit& HPS::Publish::DocumentKit::operator= ( DocumentKit const &  in_kit)

Copies the source DocumentKit into this DocumentKit.

Parameters
in_kitThe source DocumentKit to copy.
Returns
A reference to this DocumentKit.

◆ operator=() [2/2]

DocumentKit& HPS::Publish::DocumentKit::operator= ( DocumentKit &&  in_kit)

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

Parameters
in_kitAn rvalue reference to a DocumentKit to take the underlying object from.
Returns
A reference to this DocumentKit.

◆ operator==()

bool HPS::Publish::DocumentKit::operator== ( DocumentKit const &  in_kit) const

Check if the source DocumentKit is equivalent to this DocumentKit.

Parameters
in_kitThe source DocumentKit to compare to this DocumentKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Publish::DocumentKit::Set ( DocumentKit const &  in_kit)

Copies the source DocumentKit into this DocumentKit.

Parameters
in_kitThe source DocumentKit to copy.

◆ SetInformation()

DocumentKit& HPS::Publish::DocumentKit::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_titleUTF8-encoded title string to set on the document.
in_authorUTF8-encoded author string to set on the document.
in_subjectUTF8-encoded subject string to set on the document.
in_creatorUTF8-encoded creator string to set on the document.
Returns
A reference to this DocumentKit.

◆ SetPage()

DocumentKit& HPS::Publish::DocumentKit::SetPage ( PageKit const &  in_page)

Adds the given page to the document. This will replace all pages (if any) which are already on the document. This corresponds to the value that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Parameters
in_pagePage to add to the document.
Returns
A reference to this DocumentKit.

◆ SetPages() [1/2]

DocumentKit& HPS::Publish::DocumentKit::SetPages ( size_t  in_count,
PageKit const  in_pages[] 
)

Adds the given pages to the document. This will replace all pages (if any) which are already on the document. These correspond to values that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Parameters
in_countSize of the following array.
in_pagesPages to add to the document.
Returns
A reference to this DocumentKit.

◆ SetPages() [2/2]

DocumentKit& HPS::Publish::DocumentKit::SetPages ( PageKitArray const &  in_pages)

Adds the given pages to the document. This will replace all pages (if any) which are already on the document. These correspond to values that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Parameters
in_pagesPages to add to the document.
Returns
A reference to this DocumentKit.

◆ SetPasswords()

DocumentKit& HPS::Publish::DocumentKit::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_passwordUTF8-encoded password string required when opening, modifying or printing the document. If an empty string is specified, no password will be required.
in_owner_passwordUTF8-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 DocumentKit.

◆ SetPermissions() [1/2]

DocumentKit& HPS::Publish::DocumentKit::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_countSize of the following array.
in_permissionsThe permissions to be set on the document.
Returns
A reference to this DocumentKit.

◆ SetPermissions() [2/2]

DocumentKit& HPS::Publish::DocumentKit::SetPermissions ( PermissionTypeArray const &  in_permissions)

Sets document permissions. This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.

Parameters
in_permissionsThe permissions to be set on the document.
Returns
A reference to this DocumentKit.

◆ Show()

void HPS::Publish::DocumentKit::Show ( DocumentKit out_kit) const

Copies this DocumentKit into the given DocumentKit.

Parameters
out_kitThe DocumentKit to populate with the contents of this DocumentKit.

◆ ShowAttachments()

bool HPS::Publish::DocumentKit::ShowAttachments ( UTF8Array out_filenames,
UTF8Array out_descriptions 
) const

Shows the attachments on the document.

Parameters
out_filenamesFilenames of the attachments on the document.
out_descriptionsDescriptions of the attachments on the document.
Returns
true if attachments were specified, false otherwise.

◆ ShowDataTables()

bool HPS::Publish::DocumentKit::ShowDataTables ( DataTableKitArray &  out_data_tables) const

Shows data tables on the document

Parameters
out_data_tablesData tables on the document.
Returns
true if data tables were set, false otherwise.

◆ ShowIconImages()

bool HPS::Publish::DocumentKit::ShowIconImages ( UTF8Array out_names,
ImageKitArray &  out_images 
) const

Shows the icon images on the document.

Parameters
out_namesNames of the icon images on the document.
out_imagesIcon images on the document.
Returns
true if icon images were specified, false otherwise.

◆ ShowInformation()

bool HPS::Publish::DocumentKit::ShowInformation ( UTF8 out_title,
UTF8 out_author,
UTF8 out_subject,
UTF8 out_creator 
) const

Shows the document title, author, subject and creator.

Parameters
out_titleTitle of the document
out_authorAuthor of the document
out_subjectSubject of the document
out_creatorCreator of the document
Returns
true if a title, author, subject and creator were specified, false otherwise.

◆ ShowJavaScript()

bool HPS::Publish::DocumentKit::ShowJavaScript ( UTF8Array out_script_names,
UTF8Array out_sources,
SourceTypeArray &  out_types 
) const

Shows the JavaScript sources and/or files on the document.

Parameters
out_script_namesScript names on the document.
out_sourcesJavaScript sources and/or files on the document.
out_typesTypes for each item in the preceding array.
Returns
True if this setting was specified, otherwise false.
true if scripts were specified, false otherwise.

◆ ShowPages()

bool HPS::Publish::DocumentKit::ShowPages ( PageKitArray &  out_pages) const

Shows the pages on the document.

Parameters
out_pagesPages on the document.
Returns
true if pages were specified, false otherwise.

◆ ShowPasswords()

bool HPS::Publish::DocumentKit::ShowPasswords ( UTF8 out_user_password,
UTF8 out_owner_password 
) const

Shows the document passwords.

Parameters
out_user_passwordUser password of the document.
out_owner_passwordOwner password of the document.
Returns
true if passwords were specified, false otherwise.

◆ ShowPermissions()

bool HPS::Publish::DocumentKit::ShowPermissions ( PermissionTypeArray &  out_permissions) const

Shows permissions on the document

Parameters
out_permissionsPermissions on the document.
Returns
true if permissions were specified, false otherwise.

◆ UnsetAttachment()

DocumentKit& HPS::Publish::DocumentKit::UnsetAttachment ( char const *  in_filename)

Removes the attachment with a given filename from the document.

Parameters
in_filenameUTF8-encoded filename of attachment to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetAttachments() [1/3]

DocumentKit& HPS::Publish::DocumentKit::UnsetAttachments ( size_t  in_count,
UTF8 const  in_filenames[] 
)

Removes the attachments with the given filenames from the document.

Parameters
in_countSize of the following array.
in_filenamesFilenames of attachments to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetAttachments() [2/3]

DocumentKit& HPS::Publish::DocumentKit::UnsetAttachments ( UTF8Array const &  in_filenames)

Removes the attachments with the given filenames from the document.

Parameters
in_filenamesFilenames of attachments to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetAttachments() [3/3]

DocumentKit& HPS::Publish::DocumentKit::UnsetAttachments ( )

Removes all attachments from the document.

Returns
A reference to this DocumentKit.

◆ UnsetDatatables()

DocumentKit& HPS::Publish::DocumentKit::UnsetDatatables ( )

Removes Data Table settings from the document.

Returns
A reference to this DocumentKit.

◆ UnsetEverything()

DocumentKit& HPS::Publish::DocumentKit::UnsetEverything ( )

Removes all data from the document.

Returns
A reference to this DocumentKit.

◆ UnsetIconImage()

DocumentKit& HPS::Publish::DocumentKit::UnsetIconImage ( char const *  in_name)

Removes the icon image with a given name from the document.

Parameters
in_nameUTF8-encoded name of icon image to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetIconImages() [1/3]

DocumentKit& HPS::Publish::DocumentKit::UnsetIconImages ( size_t  in_count,
UTF8 const  in_names[] 
)

Removes the icon images with the given names from the document.

Parameters
in_countSize of the following array.
in_namesNames of icon images to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetIconImages() [2/3]

DocumentKit& HPS::Publish::DocumentKit::UnsetIconImages ( UTF8Array const &  in_names)

Removes the icon images with the given names from the document.

Parameters
in_namesNames of icon images to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetIconImages() [3/3]

DocumentKit& HPS::Publish::DocumentKit::UnsetIconImages ( )

Removes all icon images from the document.

Returns
A reference to this DocumentKit.

◆ UnsetInformation()

DocumentKit& HPS::Publish::DocumentKit::UnsetInformation ( )

Removes the document title, author, subject and creator.

Returns
A reference to this DocumentKit.

◆ UnsetJavaScript() [1/4]

DocumentKit& HPS::Publish::DocumentKit::UnsetJavaScript ( char const *  in_script_name)

Removes the script with a given name from the document.

Parameters
in_script_nameUTF8-encoded script name to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetJavaScript() [2/4]

DocumentKit& HPS::Publish::DocumentKit::UnsetJavaScript ( size_t  in_count,
UTF8 const  in_script_names[] 
)

Removes the scripts with the given names from the document.

Parameters
in_countSize of the following array.
in_script_namesScript names to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetJavaScript() [3/4]

DocumentKit& HPS::Publish::DocumentKit::UnsetJavaScript ( UTF8Array const &  in_script_names)

Removes the scripts with the given names from the document.

Parameters
in_script_namesScript names to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetJavaScript() [4/4]

DocumentKit& HPS::Publish::DocumentKit::UnsetJavaScript ( )

Removes all scripts from the document.

Returns
A reference to this DocumentKit.

◆ UnsetPage()

DocumentKit& HPS::Publish::DocumentKit::UnsetPage ( size_t  in_index)

Removes the page at the given index from the document.

Parameters
in_indexIndex of the page to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetPages() [1/3]

DocumentKit& HPS::Publish::DocumentKit::UnsetPages ( size_t  in_count,
size_t const  in_indices[] 
)

Removes the pages at the given indices from the document.

Parameters
in_countSize of the following array.
in_indicesIndices of the pages to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetPages() [2/3]

DocumentKit& HPS::Publish::DocumentKit::UnsetPages ( SizeTArray const &  in_indices)

Removes the pages at the given indices from the document.

Parameters
in_indicesIndices of the pages to remove from the document.
Returns
A reference to this DocumentKit.

◆ UnsetPages() [3/3]

DocumentKit& HPS::Publish::DocumentKit::UnsetPages ( )

Removes all pages from the document.

Returns
A reference to this DocumentKit.

◆ UnsetPasswords()

DocumentKit& HPS::Publish::DocumentKit::UnsetPasswords ( )

Removes the document passwords.

Returns
A reference to this DocumentKit.

◆ UnsetPermissions()

DocumentKit& HPS::Publish::DocumentKit::UnsetPermissions ( )

Removes permission settings from the document.

Returns
A reference to this DocumentKit.

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