HPS::Publish::PageControl Class Reference

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::PageControl:
HPS::Sprocket HPS::Object

Public Member Functions

PageControlAddAnnotation (AnnotationKit const &in_annotation, IntRectangle const &in_location)
 
PageControlAddAnnotations (size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[])
 
PageControlAddAnnotations (AnnotationKitArray const &in_annotations, IntRectangleArray const &in_locations)
 
PageControlAddButton (ButtonKit const &in_button, IntRectangle const &in_location)
 
PageControlAddButtons (size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[])
 
PageControlAddButtons (ButtonKitArray const &in_buttons, IntRectangleArray const &in_locations)
 
PageControlAddCheckBox (CheckBoxKit const &in_check_box, IntRectangle const &in_location)
 
PageControlAddCheckBoxes (size_t in_count, CheckBoxKit const in_check_boxes[], IntRectangle const in_locations[])
 
PageControlAddCheckBoxes (CheckBoxKitArray const &in_check_boxes, IntRectangleArray const &in_locations)
 
PageControlAddDropDownList (DropDownListKit const &in_drop_down_list, IntRectangle const &in_location)
 
PageControlAddDropDownLists (size_t in_count, DropDownListKit const in_drop_down_lists[], IntRectangle const in_locations[])
 
PageControlAddDropDownLists (DropDownListKitArray const &in_drop_down_lists, IntRectangleArray const &in_locations)
 
PageControlAddImage (ImageKit const &in_image, IntRectangle const &in_location)
 
PageControlAddImages (size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[])
 
PageControlAddImages (ImageKitArray const &in_images, IntRectangleArray const &in_locations)
 
PageControlAddLink (LinkKit const &in_link, IntRectangle const &in_location)
 
PageControlAddLinks (size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[])
 
PageControlAddLinks (LinkKitArray const &in_links, IntRectangleArray const &in_locations)
 
PageControlAddListBox (ListBoxKit const &in_list_box, IntRectangle const &in_location)
 
PageControlAddListBoxes (size_t in_count, ListBoxKit const in_list_boxes[], IntRectangle const in_locations[])
 
PageControlAddListBoxes (ListBoxKitArray const &in_list_boxes, IntRectangleArray const &in_locations)
 
PageControlAddListItemByField (char const *in_field, char const *in_value, char const *in_export_value)
 
PageControlAddListItemsByField (char const *in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[])
 
PageControlAddListItemsByField (char const *in_field, UTF8Array const &in_values, UTF8Array const &in_export_values)
 
PageControlAddRadioButton (RadioButtonKit const &in_radio_button, IntRectangle const &in_location)
 
PageControlAddRadioButtons (size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[])
 
PageControlAddRadioButtons (RadioButtonKitArray const &in_radio_buttons, IntRectangleArray const &in_locations)
 
PageControlAddSignatureField (SignatureFieldKit const &in_signature_field, IntRectangle const &in_location)
 
PageControlAddSignatureFields (size_t in_count, SignatureFieldKit const in_signature_fields[], IntRectangle const in_locations[])
 
PageControlAddSignatureFields (SignatureFieldKitArray const &in_signature_fields, IntRectangleArray const &in_locations)
 
PageControlAddSlideTable (SlideTableKit const &in_slide_table, IntRectangle const &in_location)
 
PageControlAddSlideTables (size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[])
 
PageControlAddSlideTables (SlideTableKitArray const &in_slide_tables, IntRectangleArray const &in_locations)
 
PageControlAddTable (TableKit const &in_table, IntRectangle const &in_location)
 
PageControlAddTables (size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[])
 
PageControlAddTables (TableKitArray const &in_tables, IntRectangleArray const &in_locations)
 
PageControlAddText (TextKit const &in_text, IntRectangle const &in_location)
 
PageControlAddText (size_t in_count, TextKit const in_text[], IntRectangle const in_locations[])
 
PageControlAddText (TextKitArray const &in_text, IntRectangleArray const &in_locations)
 
PageControlAddTextField (TextFieldKit const &in_text_field, IntRectangle const &in_location)
 
PageControlAddTextFields (size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[])
 
PageControlAddTextFields (TextFieldKitArray const &in_text_fields, IntRectangleArray const &in_locations)
 
HPS::Type ObjectType () const
 
PageControloperator= (PageControl const &in_that)
 
PageControloperator= (PageControl &&in_kit)
 
 PageControl ()
 
 PageControl (PageControl const &in_that)
 
 PageControl (PageControl &&in_that)
 
PageControlSetAnnotationByField (char const *in_field, AnnotationKit const &in_annotation)
 
PageControlSetAnnotationsByField (size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[])
 
PageControlSetAnnotationsByField (UTF8Array const &in_fields, AnnotationKitArray const &in_annotations)
 
PageControlSetButtonIconByField (char const *in_field, ImageKit const &in_image)
 
PageControlSetButtonIconsByField (size_t in_count, UTF8 const in_fields[], ImageKit const in_images[])
 
PageControlSetButtonIconsByField (UTF8Array const &in_fields, ImageKitArray const &in_images)
 
PageControlSetButtonLabelByField (char const *in_field, char const *in_label)
 
PageControlSetButtonLabelsByField (size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[])
 
PageControlSetButtonLabelsByField (UTF8Array const &in_fields, UTF8Array const &in_labels)
 
PageControlSetJavaScriptActionByField (char const *in_field, char const *in_source, Source::Type in_type=Source::Type::Code)
 
PageControlSetJavaScriptActionsByField (size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[])
 
PageControlSetJavaScriptActionsByField (UTF8Array const &in_fields, UTF8Array const &in_sources, SourceTypeArray const &in_types)
 
PageControlSetTextValueByField (char const *in_field, char const *in_value)
 
PageControlSetTextValuesByField (size_t in_count, UTF8 const in_fields[], UTF8 const in_values[])
 
PageControlSetTextValuesByField (UTF8Array const &in_fields, UTF8Array const &in_values)
 
PageControlSetVisibilitiesByField (size_t in_count, UTF8 const in_fields[], bool const in_states[])
 
PageControlSetVisibilitiesByField (UTF8Array const &in_fields, BoolArray const &in_states)
 
PageControlSetVisibilityByField (char const *in_field, bool in_state)
 
bool ShowFields (UTF8Array &out_names, IntRectangleArray &out_locations, FieldTypeArray &out_types) const
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
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 Attributes

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

Additional Inherited Members

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

Detailed Description

The PageControl class is a smart pointer to a page within a Publish PDF document. It allows direct interaction with a PDF page.

Constructor & Destructor Documentation

◆ PageControl() [1/3]

HPS::Publish::PageControl::PageControl ( )

The default constructor creates an uninitialized PageControl object. The Type() function will return Type::None.

◆ PageControl() [2/3]

HPS::Publish::PageControl::PageControl ( PageControl const &  in_that)

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

Parameters
in_thatThe source PageControl to copy.

◆ PageControl() [3/3]

HPS::Publish::PageControl::PageControl ( PageControl &&  in_that)

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

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

Member Function Documentation

◆ AddAnnotation()

PageControl& HPS::Publish::PageControl::AddAnnotation ( AnnotationKit const &  in_annotation,
IntRectangle const &  in_location 
)

Adds an annotation to the page. This will not replace any existing annotations on the page. This corresponds to the value that will be passed to A3DPDFPageInsert3DAnnot.

Parameters
in_annotationAnnotation to add to the page.
in_locationAnnotation location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddAnnotations() [1/2]

PageControl& HPS::Publish::PageControl::AddAnnotations ( size_t  in_count,
AnnotationKit const  in_annotations[],
IntRectangle const  in_locations[] 
)

Adds a list of annotations to the page. This will not replace any existing annotations on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.

Parameters
in_countSize of the following arrays.
in_annotationsAnnotations to add to the page.
in_locationsAnnotation locations in points relative to bottom left of the page.
Returns
A reference to this PageControl.

◆ AddAnnotations() [2/2]

PageControl& HPS::Publish::PageControl::AddAnnotations ( AnnotationKitArray const &  in_annotations,
IntRectangleArray const &  in_locations 
)

Adds a list of annotations to the page. This will not replace any existing annotations on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.

Parameters
in_annotationsAnnotations to add to the page.
in_locationsAnnotation locations in points relative to bottom left of the page.
Returns
A reference to this PageControl.

◆ AddButton()

PageControl& HPS::Publish::PageControl::AddButton ( ButtonKit const &  in_button,
IntRectangle const &  in_location 
)

Adds a button to the page. This will not replace any buttons on the page. This corresponds to the value that will be passed to A3DPDFPageInsertButton.

Parameters
in_buttonButton to add to the page.
in_locationButton location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddButtons() [1/2]

PageControl& HPS::Publish::PageControl::AddButtons ( size_t  in_count,
ButtonKit const  in_buttons[],
IntRectangle const  in_locations[] 
)

Adds a list of buttons to the page. This will not replace any buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.

Parameters
in_countSize of the following arrays.
in_buttonsButtons to add to the page.
in_locationsButton locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddButtons() [2/2]

PageControl& HPS::Publish::PageControl::AddButtons ( ButtonKitArray const &  in_buttons,
IntRectangleArray const &  in_locations 
)

Adds a list of buttons to the page. This will not replace any buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.

Parameters
in_buttonsButtons to add to the page.
in_locationsButton locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddCheckBox()

PageControl& HPS::Publish::PageControl::AddCheckBox ( CheckBoxKit const &  in_check_box,
IntRectangle const &  in_location 
)

Adds a check box to the page. This will not replace any check boxes on the page. This corresponds to the value that will be passed to A3DPDFPageInsertCheckBox.

Parameters
in_check_boxCheck box to add to the page.
in_locationCheck box location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddCheckBoxes() [1/2]

PageControl& HPS::Publish::PageControl::AddCheckBoxes ( size_t  in_count,
CheckBoxKit const  in_check_boxes[],
IntRectangle const  in_locations[] 
)

Adds a list of check boxes to the page. This will not replace any check boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.

Parameters
in_countSize of the following arrays.
in_check_boxesCheck boxes to add to the page.
in_locationsCheck box locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddCheckBoxes() [2/2]

PageControl& HPS::Publish::PageControl::AddCheckBoxes ( CheckBoxKitArray const &  in_check_boxes,
IntRectangleArray const &  in_locations 
)

Adds a list of check boxes to the page. This will not replace any check boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.

Parameters
in_check_boxesCheck boxes to add to the page.
in_locationsCheck box locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddDropDownList()

PageControl& HPS::Publish::PageControl::AddDropDownList ( DropDownListKit const &  in_drop_down_list,
IntRectangle const &  in_location 
)

Adds a drop down list to the page. This will not replace any drop down lists on the page. This corresponds to the value that will be passed to A3DPDFPageInsertDropDownList.

Parameters
in_drop_down_listDrop down list to add to the page.
in_locationDrop down list location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddDropDownLists() [1/2]

PageControl& HPS::Publish::PageControl::AddDropDownLists ( size_t  in_count,
DropDownListKit const  in_drop_down_lists[],
IntRectangle const  in_locations[] 
)

Adds a list of drop down lists to the page. This will not replace any drop down lists on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.

Parameters
in_countSize of the following arrays.
in_drop_down_listsDrop down lists to add to the page.
in_locationsDrop down list locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddDropDownLists() [2/2]

PageControl& HPS::Publish::PageControl::AddDropDownLists ( DropDownListKitArray const &  in_drop_down_lists,
IntRectangleArray const &  in_locations 
)

Adds a list of drop down lists to the page. This will not replace any drop down lists on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.

Parameters
in_drop_down_listsDrop down lists to add to the page.
in_locationsDrop down list locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddImage()

PageControl& HPS::Publish::PageControl::AddImage ( ImageKit const &  in_image,
IntRectangle const &  in_location 
)

Adds an image to the page. This will not replace any images on the page. This corresponds to the value that will be passed to A3DPDFPageInsertImage.

Parameters
in_imageImage to add to the page.
in_locationImage location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddImages() [1/2]

PageControl& HPS::Publish::PageControl::AddImages ( size_t  in_count,
ImageKit const  in_images[],
IntRectangle const  in_locations[] 
)

Adds a list of images to the page. This will not replace any images on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.

Parameters
in_countSize of the following arrays.
in_imagesImages to add to the page.
in_locationsImage locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddImages() [2/2]

PageControl& HPS::Publish::PageControl::AddImages ( ImageKitArray const &  in_images,
IntRectangleArray const &  in_locations 
)

Adds a list of images to the page. This will not replace any images on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.

Parameters
in_imagesImages to add to the page.
in_locationsImage locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddLink()

PageControl& HPS::Publish::PageControl::AddLink ( LinkKit const &  in_link,
IntRectangle const &  in_location 
)

Adds a link to the page. This will not replace any links on the page. This corresponds to the value that will be passed to A3DPDFPageInsertLink.

Parameters
in_linkLink to add to the page.
in_locationLink location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddLinks() [1/2]

PageControl& HPS::Publish::PageControl::AddLinks ( size_t  in_count,
LinkKit const  in_links[],
IntRectangle const  in_locations[] 
)

Adds a list of links to the page. This will not replace any links on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.

Parameters
in_countSize of the following arrays.
in_linksLinks to add to the page.
in_locationsLink locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddLinks() [2/2]

PageControl& HPS::Publish::PageControl::AddLinks ( LinkKitArray const &  in_links,
IntRectangleArray const &  in_locations 
)

Adds a list of links to the page. This will not replace any links on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.

Parameters
in_linksLinks to add to the page.
in_locationsLink locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddListBox()

PageControl& HPS::Publish::PageControl::AddListBox ( ListBoxKit const &  in_list_box,
IntRectangle const &  in_location 
)

Adds a list box to the page. This will not replace any list boxes on the page. This corresponds to the value that will be passed to A3DPDFPageInsertListBox.

Parameters
in_list_boxList box to add to the page.
in_locationList box location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddListBoxes() [1/2]

PageControl& HPS::Publish::PageControl::AddListBoxes ( size_t  in_count,
ListBoxKit const  in_list_boxes[],
IntRectangle const  in_locations[] 
)

Adds a list of list boxes to the page. This will not replace any list boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.

Parameters
in_countSize of the following arrays.
in_list_boxesList boxes to add to the page.
in_locationsList box locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddListBoxes() [2/2]

PageControl& HPS::Publish::PageControl::AddListBoxes ( ListBoxKitArray const &  in_list_boxes,
IntRectangleArray const &  in_locations 
)

Adds a list of list boxes to the page. This will not replace any list boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.

Parameters
in_list_boxesList boxes to add to the page.
in_locationsList box locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddListItemByField()

PageControl& HPS::Publish::PageControl::AddListItemByField ( char const *  in_field,
char const *  in_value,
char const *  in_export_value 
)

Adds an item to the list at the given form field. The item to will be appended to any existing items in the list at the given form field. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the list.
in_valueUTF8-encoded value for the item to be added to the list at the given form field.
in_export_valueUTF8-encoded export value for the item to be added to the list at the given form field.
Returns
A reference to this PageControl.

◆ AddListItemsByField() [1/2]

PageControl& HPS::Publish::PageControl::AddListItemsByField ( char const *  in_field,
size_t  in_count,
UTF8 const  in_values[],
UTF8 const  in_export_values[] 
)

Adds items to the list at the given form field. The items to will be appended to any existing items in the list at the given form field. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the list.
in_countSize of the following arrays.
in_valuesThe values for the items to be added to the list at the given form field.
in_export_valuesThe export values for the items to be added to the list at the given form field.
Returns
A reference to this PageControl.

◆ AddListItemsByField() [2/2]

PageControl& HPS::Publish::PageControl::AddListItemsByField ( char const *  in_field,
UTF8Array const &  in_values,
UTF8Array const &  in_export_values 
)

Adds items to the list at the given form field. The items to will be appended to any existing items in the list at the given form field. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the list.
in_valuesThe values for the items to be added to the list at the given form field.
in_export_valuesThe export values for the items to be added to the list at the given form field.
Returns
A reference to this PageControl.

◆ AddRadioButton()

PageControl& HPS::Publish::PageControl::AddRadioButton ( RadioButtonKit const &  in_radio_button,
IntRectangle const &  in_location 
)

Adds a radio button to the page. This will not replace any radio buttons on the page. This corresponds to the value that will be passed to A3DPDFPageInsertRadioButton.

Parameters
in_radio_buttonRadio button to add to the page.
in_locationRadio button location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddRadioButtons() [1/2]

PageControl& HPS::Publish::PageControl::AddRadioButtons ( size_t  in_count,
RadioButtonKit const  in_radio_buttons[],
IntRectangle const  in_locations[] 
)

Adds a list of radio buttons to the page. This will not replace any radio buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.

Parameters
in_countSize of the following arrays.
in_radio_buttonsRadio buttons to add to the page.
in_locationsRadio button locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddRadioButtons() [2/2]

PageControl& HPS::Publish::PageControl::AddRadioButtons ( RadioButtonKitArray const &  in_radio_buttons,
IntRectangleArray const &  in_locations 
)

Adds a list of radio buttons to the page. This will not replace any radio buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.

Parameters
in_radio_buttonsRadio buttons to add to the page.
in_locationsRadio button locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddSignatureField()

PageControl& HPS::Publish::PageControl::AddSignatureField ( SignatureFieldKit const &  in_signature_field,
IntRectangle const &  in_location 
)

Adds a signature field to the page. This will not replace any signature fields on the page. This corresponds to the value that will be passed to A3DPDFPageInsertSignatureField.

Parameters
in_signature_fieldSignature field to add to the page.
in_locationSignature field location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddSignatureFields() [1/2]

PageControl& HPS::Publish::PageControl::AddSignatureFields ( size_t  in_count,
SignatureFieldKit const  in_signature_fields[],
IntRectangle const  in_locations[] 
)

Adds a list of signature fields to the page. This will not replace any signature fields on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.

Parameters
in_countSize of the following arrays.
in_signature_fieldsSignature fields to add to the page.
in_locationsSignature field locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddSignatureFields() [2/2]

PageControl& HPS::Publish::PageControl::AddSignatureFields ( SignatureFieldKitArray const &  in_signature_fields,
IntRectangleArray const &  in_locations 
)

Adds a list of signature fields to the page. This will not replace any signature fields on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.

Parameters
in_signature_fieldsSignature fields to add to the page.
in_locationsSignature field locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddSlideTable()

PageControl& HPS::Publish::PageControl::AddSlideTable ( SlideTableKit const &  in_slide_table,
IntRectangle const &  in_location 
)

Adds a slide table to the page. This will not replace any slide tables on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.

Parameters
in_slide_tableSlide table to add to the page.
in_locationSlide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddSlideTables() [1/2]

PageControl& HPS::Publish::PageControl::AddSlideTables ( size_t  in_count,
SlideTableKit const  in_slide_tables[],
IntRectangle const  in_locations[] 
)

Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Parameters
in_countSize of the following arrays.
in_slide_tablesSlide tables to add to the page.
in_locationsSlide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddSlideTables() [2/2]

PageControl& HPS::Publish::PageControl::AddSlideTables ( SlideTableKitArray const &  in_slide_tables,
IntRectangleArray const &  in_locations 
)

Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Parameters
in_slide_tablesSlide tables to add to the page.
in_locationsSlide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddTable()

PageControl& HPS::Publish::PageControl::AddTable ( TableKit const &  in_table,
IntRectangle const &  in_location 
)

Adds a table to the page. This will not replace any tables on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.

Parameters
in_tableTable to add to the page.
in_locationTable location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddTables() [1/2]

PageControl& HPS::Publish::PageControl::AddTables ( size_t  in_count,
TableKit const  in_tables[],
IntRectangle const  in_locations[] 
)

Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Parameters
in_countSize of the following arrays.
in_tablesTables to add to the page.
in_locationsTable locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddTables() [2/2]

PageControl& HPS::Publish::PageControl::AddTables ( TableKitArray const &  in_tables,
IntRectangleArray const &  in_locations 
)

Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Parameters
in_tablesTables to add to the page.
in_locationsTable locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddText() [1/3]

PageControl& HPS::Publish::PageControl::AddText ( TextKit const &  in_text,
IntRectangle const &  in_location 
)

Adds a text string to the page. This will not replace any text on the page. This corresponds to the value that will be passed to A3DPDFPageInsertText.

Parameters
in_textText to add to the page.
in_locationText location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddText() [2/3]

PageControl& HPS::Publish::PageControl::AddText ( size_t  in_count,
TextKit const  in_text[],
IntRectangle const  in_locations[] 
)

Adds text strings to the page. This will not replace any text on the page. These correspond to values that will be passed to A3DPDFPageInsertText.

Parameters
in_countSize of the following arrays.
in_textText to add to the page.
in_locationsText locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddText() [3/3]

PageControl& HPS::Publish::PageControl::AddText ( TextKitArray const &  in_text,
IntRectangleArray const &  in_locations 
)

Adds text strings to the page. This will not replace any text on the page. These correspond to values that will be passed to A3DPDFPageInsertText.

Parameters
in_textText to add to the page.
in_locationsText locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddTextField()

PageControl& HPS::Publish::PageControl::AddTextField ( TextFieldKit const &  in_text_field,
IntRectangle const &  in_location 
)

Adds a text field to the page. This will not replace any text fields on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTextField.

Parameters
in_text_fieldText field to add to the page.
in_locationText field location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddTextFields() [1/2]

PageControl& HPS::Publish::PageControl::AddTextFields ( size_t  in_count,
TextFieldKit const  in_text_fields[],
IntRectangle const  in_locations[] 
)

Adds a list of text fields to the page. This will not replace any text fields on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.

Parameters
in_countSize of the following arrays.
in_text_fieldsText fields to add to the page.
in_locationsText field locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ AddTextFields() [2/2]

PageControl& HPS::Publish::PageControl::AddTextFields ( TextFieldKitArray const &  in_text_fields,
IntRectangleArray const &  in_locations 
)

Adds a list of text fields to the page. This will not replace any text fields on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.

Parameters
in_text_fieldsText fields to add to the page.
in_locationsText field locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.

◆ ObjectType()

HPS::Type HPS::Publish::PageControl::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::Object.

◆ operator=() [1/2]

PageControl& HPS::Publish::PageControl::operator= ( PageControl const &  in_that)

Share the underlying smart-pointer of the PageControl source.

Parameters
in_thatThe PageControl source of the assignment.
Returns
A reference to this PageControl.

◆ operator=() [2/2]

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

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

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

◆ SetAnnotationByField()

PageControl& HPS::Publish::PageControl::SetAnnotationByField ( char const *  in_field,
AnnotationKit const &  in_annotation 
)

Sets an annotation on the given form field. If there is an existing annotation on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the annotation.
in_annotationThe annotation to be set on the given form field.
Returns
A reference to this PageControl.

◆ SetAnnotationsByField() [1/2]

PageControl& HPS::Publish::PageControl::SetAnnotationsByField ( size_t  in_count,
UTF8 const  in_fields[],
AnnotationKit const  in_annotations[] 
)

Sets annotations on the given form fields. If there is an existing annotation on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names for the annotations.
in_annotationsThe annotations to be set on the corresponding form fields.
Returns
A reference to this PageControl.

◆ SetAnnotationsByField() [2/2]

PageControl& HPS::Publish::PageControl::SetAnnotationsByField ( UTF8Array const &  in_fields,
AnnotationKitArray const &  in_annotations 
)

Sets annotations on the given form fields. If there is an existing annotation on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldsThe form field names for the annotations.
in_annotationsThe annotations to be set on the corresponding form fields.
Returns
A reference to this PageControl.

◆ SetButtonIconByField()

PageControl& HPS::Publish::PageControl::SetButtonIconByField ( char const *  in_field,
ImageKit const &  in_image 
)

Sets an image on the icon at the given form field. If there is an existing image on an icon at the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the icon.
in_imageThe image to be set on the icon at the given form field.
Returns
A reference to this PageControl.

◆ SetButtonIconsByField() [1/2]

PageControl& HPS::Publish::PageControl::SetButtonIconsByField ( size_t  in_count,
UTF8 const  in_fields[],
ImageKit const  in_images[] 
)

Sets images on the icons at the given form fields. If there is an existing image on an icon at a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names for the icons.
in_imagesThe images to be set on the icons at the corresponding form fields.
Returns
A reference to this PageControl.

◆ SetButtonIconsByField() [2/2]

PageControl& HPS::Publish::PageControl::SetButtonIconsByField ( UTF8Array const &  in_fields,
ImageKitArray const &  in_images 
)

Sets images on the icons at the given form fields. If there is an existing image on an icon at a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldsThe form field names for the icons.
in_imagesThe images to be set on the icons at the corresponding form fields.
Returns
A reference to this PageControl.

◆ SetButtonLabelByField()

PageControl& HPS::Publish::PageControl::SetButtonLabelByField ( char const *  in_field,
char const *  in_label 
)

Sets a label on the given form field. If there is an existing label on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the label.
in_labelUTF8-encoded label to be set on the given form field.
Returns
A reference to this PageControl.

◆ SetButtonLabelsByField() [1/2]

PageControl& HPS::Publish::PageControl::SetButtonLabelsByField ( size_t  in_count,
UTF8 const  in_fields[],
UTF8 const  in_labels[] 
)

Sets labels on the given form fields. If there is an existing label on a given form field, it will get overwritten. These correspond to the values that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names for the labels.
in_labelsThe labels to be set on the corresponding form fields.
Returns
A reference to this PageControl.

◆ SetButtonLabelsByField() [2/2]

PageControl& HPS::Publish::PageControl::SetButtonLabelsByField ( UTF8Array const &  in_fields,
UTF8Array const &  in_labels 
)

Sets labels on the given form fields. If there is an existing label on a given form field, it will get overwritten. These correspond to the values that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldsThe form field names for the labels.
in_labelsThe labels to be set on the corresponding form fields.
Returns
A reference to this PageControl.

◆ SetJavaScriptActionByField()

PageControl& HPS::Publish::PageControl::SetJavaScriptActionByField ( char const *  in_field,
char const *  in_source,
Source::Type  in_type = Source::Type::Code 
)

Sets a JavaScript source or file on the given form field. If there is any existing JavaScript source or file at the given form field, it will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the JavaScript action.
in_sourceUTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
in_typeThe type of the preceding argument. Defaults to Source::Type::Code.
Returns
A reference to this PageControl.

◆ SetJavaScriptActionsByField() [1/2]

PageControl& HPS::Publish::PageControl::SetJavaScriptActionsByField ( size_t  in_count,
UTF8 const  in_fields[],
UTF8 const  in_sources[],
Source::Type const  in_types[] 
)

Sets JavaScript sources and/or files on the given form fields. If there is any existing JavaScript source or file at a given form field, it will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names for the JavaScript actions.
in_sourcesThe JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields.
in_typesThe types for each item in the preceding argument array.
Returns
A reference to this PageControl.

◆ SetJavaScriptActionsByField() [2/2]

PageControl& HPS::Publish::PageControl::SetJavaScriptActionsByField ( UTF8Array const &  in_fields,
UTF8Array const &  in_sources,
SourceTypeArray const &  in_types 
)

Sets JavaScript sources and/or files on the given form fields. If there is any existing JavaScript source or file at a given form field, it will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldsThe form field names for the JavaScript actions.
in_sourcesThe JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields.
in_typesThe types for each item in the preceding argument array.
Returns
A reference to this PageControl.

◆ SetTextValueByField()

PageControl& HPS::Publish::PageControl::SetTextValueByField ( char const *  in_field,
char const *  in_value 
)

Sets a text value on the given form field. If there is an existing text value on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the text value.
in_valueUTF8-encoded text value to be set on the given form field.
Returns
A reference to this PageControl.

◆ SetTextValuesByField() [1/2]

PageControl& HPS::Publish::PageControl::SetTextValuesByField ( size_t  in_count,
UTF8 const  in_fields[],
UTF8 const  in_values[] 
)

Sets text values on the given form fields. If there is an existing text value on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names for the text values.
in_valuesThe text values to be set on the corresponding form fields.
Returns
A reference to this PageControl.

◆ SetTextValuesByField() [2/2]

PageControl& HPS::Publish::PageControl::SetTextValuesByField ( UTF8Array const &  in_fields,
UTF8Array const &  in_values 
)

Sets text values on the given form fields. If there is an existing text value on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldsThe form field names for the text values.
in_valuesThe text values to be set on the corresponding form fields.
Returns
A reference to this PageControl.

◆ SetVisibilitiesByField() [1/2]

PageControl& HPS::Publish::PageControl::SetVisibilitiesByField ( size_t  in_count,
UTF8 const  in_fields[],
bool const  in_states[] 
)

Sets whether the objects at the given form fields should be visible. If there is an existing visibility on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names on which to set visibility.
in_statesWhether the objects at the at the corresponding form fields should be visible.
Returns
A reference to this PageControl.

◆ SetVisibilitiesByField() [2/2]

PageControl& HPS::Publish::PageControl::SetVisibilitiesByField ( UTF8Array const &  in_fields,
BoolArray const &  in_states 
)

Sets whether the objects at the given form fields should be visible. If there is an existing visibility on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldsThe form field names on which to set visibility.
in_statesWhether the objects at the at the corresponding form fields should be visible.
Returns
A reference to this PageControl.

◆ SetVisibilityByField()

PageControl& HPS::Publish::PageControl::SetVisibilityByField ( char const *  in_field,
bool  in_state 
)

Sets whether the object at the given form field should be visible. If there is an existing visibility on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name on which to set visibility.
in_stateWhether the object at the at the given form field should be visible.
Returns
A reference to this PageControl.

◆ ShowFields()

bool HPS::Publish::PageControl::ShowFields ( UTF8Array out_names,
IntRectangleArray out_locations,
FieldTypeArray &  out_types 
) const

Shows the PDF form fields on the page associated with this PageControl.

Parameters
out_namesThe names of the PDF form fields on the associated page.
out_locationsThe locations of the PDF form fields on the associated page.
out_typesThe types of the PDF form fields on the associated page.
Returns
true if there are any PDF form fields on the associated page, false otherwise.

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