The PageKit class is a user space object. More...
#include <sprk_publish.h>
Public Member Functions | |
PageKit () | |
The default constructor creates an empty PageKit object. More... | |
PageKit (Page::Format in_format, Page::Orientation in_orientation) | |
This constructor creates a PageKit with the given format and orientation. More... | |
PageKit (char const *in_filename) | |
This constructor creates a PageKit from the given PDF template file. More... | |
PageKit (PageKit const &in_kit) | |
The copy constructor creates a new PageKit object that contains the same settings as the source PageKit. More... | |
PageKit (PageKit &&in_kit) | |
The move constructor creates a PageKit by transferring the underlying object of the rvalue reference to this PageKit. More... | |
virtual | ~PageKit () |
HPS::Type | ObjectType () const |
void | Set (PageKit const &in_kit) |
Copies the source PageKit into this PageKit. More... | |
void | Show (PageKit &out_kit) const |
Copies this PageKit into the given PageKit. More... | |
PageKit & | operator= (PageKit const &in_kit) |
Copies the source PageKit into this PageKit. More... | |
PageKit & | operator= (PageKit &&in_kit) |
The move assignment operator transfers the underlying object of the rvalue reference to this PageKit. More... | |
bool | Empty () const |
Indicates whether this PageKit has any values set on it. More... | |
bool | Equals (PageKit const &in_kit) const |
Check if the source PageKit is equivalent to this PageKit. More... | |
bool | operator== (PageKit const &in_kit) const |
Check if the source PageKit is equivalent to this PageKit. More... | |
bool | operator!= (PageKit const &in_kit) const |
Check if the source PageKit is not equivalent to this PageKit. More... | |
PageKit & | SetFormat (Page::Format in_format) |
Sets the format of the page. More... | |
PageKit & | SetOrientation (Page::Orientation in_orientation) |
Sets the orientation of the page. More... | |
PageKit & | SetAnnotation (AnnotationKit const &in_annotation, IntRectangle const &in_location) |
Adds an annotation to the page. More... | |
PageKit & | AddAnnotation (AnnotationKit const &in_annotation, IntRectangle const &in_location) |
Adds an annotation to the page. More... | |
PageKit & | SetAnnotations (size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]) |
Adds a list of annotations to the page. More... | |
PageKit & | SetAnnotations (AnnotationKitArray const &in_annotations, IntRectangleArray const &in_locations) |
Adds a list of annotations to the page. More... | |
PageKit & | AddAnnotations (size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]) |
Adds a list of annotations to the page. More... | |
PageKit & | AddAnnotations (AnnotationKitArray const &in_annotations, IntRectangleArray const &in_locations) |
Adds a list of annotations to the page. More... | |
PageKit & | SetText (TextKit const &in_text, IntRectangle const &in_location) |
Adds a text string to the page. More... | |
PageKit & | AddText (TextKit const &in_text, IntRectangle const &in_location) |
Adds a text string to the page. More... | |
PageKit & | SetText (size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]) |
Adds text strings to the page. More... | |
PageKit & | SetText (TextKitArray const &in_text, IntRectangleArray const &in_locations) |
Adds text strings to the page. More... | |
PageKit & | AddText (size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]) |
Adds text strings to the page. More... | |
PageKit & | AddText (TextKitArray const &in_text, IntRectangleArray const &in_locations) |
Adds text strings to the page. More... | |
PageKit & | SetImage (ImageKit const &in_image, IntRectangle const &in_location) |
Adds an image to the page. More... | |
PageKit & | AddImage (ImageKit const &in_image, IntRectangle const &in_location) |
Adds an image to the page. More... | |
PageKit & | SetImages (size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]) |
Adds a list of images to the page. More... | |
PageKit & | SetImages (ImageKitArray const &in_images, IntRectangleArray const &in_locations) |
Adds a list of images to the page. More... | |
PageKit & | AddImages (size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]) |
Adds a list of images to the page. More... | |
PageKit & | AddImages (ImageKitArray const &in_images, IntRectangleArray const &in_locations) |
Adds a list of images to the page. More... | |
PageKit & | SetTable (TableKit const &in_table, IntRectangle const &in_location) |
Adds a table to the page. More... | |
PageKit & | AddTable (TableKit const &in_table, IntRectangle const &in_location) |
Adds a table to the page. More... | |
PageKit & | SetTables (size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]) |
Adds a list of tables to the page. More... | |
PageKit & | SetTables (TableKitArray const &in_tables, IntRectangleArray const &in_locations) |
Adds a list of tables to the page. More... | |
PageKit & | AddTables (size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]) |
Adds a list of tables to the page. More... | |
PageKit & | AddTables (TableKitArray const &in_tables, IntRectangleArray const &in_locations) |
Adds a list of tables to the page. More... | |
PageKit & | SetLink (LinkKit const &in_link, IntRectangle const &in_location) |
Adds a link to the page. More... | |
PageKit & | AddLink (LinkKit const &in_link, IntRectangle const &in_location) |
Adds a link to the page. More... | |
PageKit & | SetLinks (size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]) |
Adds a list of links to the page. More... | |
PageKit & | SetLinks (LinkKitArray const &in_links, IntRectangleArray const &in_locations) |
Adds a list of links to the page. More... | |
PageKit & | AddLinks (size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]) |
Adds a list of links to the page. More... | |
PageKit & | AddLinks (LinkKitArray const &in_links, IntRectangleArray const &in_locations) |
Adds a list of links to the page. More... | |
PageKit & | SetButton (ButtonKit const &in_button, IntRectangle const &in_location) |
Adds a button to the page. More... | |
PageKit & | AddButton (ButtonKit const &in_button, IntRectangle const &in_location) |
Adds a button to the page. More... | |
PageKit & | SetButtons (size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]) |
Adds a list of buttons to the page. More... | |
PageKit & | SetButtons (ButtonKitArray const &in_buttons, IntRectangleArray const &in_locations) |
Adds a list of buttons to the page. More... | |
PageKit & | AddButtons (size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]) |
Adds a list of buttons to the page. More... | |
PageKit & | AddButtons (ButtonKitArray const &in_buttons, IntRectangleArray const &in_locations) |
Adds a list of buttons to the page. More... | |
PageKit & | SetTextField (TextFieldKit const &in_text_field, IntRectangle const &in_location) |
Adds a text field to the page. More... | |
PageKit & | AddTextField (TextFieldKit const &in_text_field, IntRectangle const &in_location) |
Adds a text field to the page. More... | |
PageKit & | SetTextFields (size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]) |
Adds a list of text fields to the page. More... | |
PageKit & | SetTextFields (TextFieldKitArray const &in_text_fields, IntRectangleArray const &in_locations) |
Adds a list of text fields to the page. More... | |
PageKit & | AddTextFields (size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]) |
Adds a list of text fields to the page. More... | |
PageKit & | AddTextFields (TextFieldKitArray const &in_text_fields, IntRectangleArray const &in_locations) |
Adds a list of text fields to the page. More... | |
PageKit & | SetSlideTable (SlideTableKit const &in_slide_table, IntRectangle const &in_location) |
Adds a slide table to the page. More... | |
PageKit & | AddSlideTable (SlideTableKit const &in_slide_table, IntRectangle const &in_location) |
Adds a slide table to the page. More... | |
PageKit & | SetSlideTables (size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]) |
Adds a list of slide tables to the page. More... | |
PageKit & | SetSlideTables (SlideTableKitArray const &in_slide_tables, IntRectangleArray const &in_locations) |
Adds a list of slide tables to the page. More... | |
PageKit & | AddSlideTables (size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]) |
Adds a list of slide tables to the page. More... | |
PageKit & | AddSlideTables (SlideTableKitArray const &in_slide_tables, IntRectangleArray const &in_locations) |
Adds a list of slide tables to the page. More... | |
PageKit & | SetCheckBox (CheckBoxKit const &in_checkbox, IntRectangle const &in_location) |
Adds a check box to the page. More... | |
PageKit & | AddCheckBox (CheckBoxKit const &in_checkbox, IntRectangle const &in_location) |
Adds a check box to the page. More... | |
PageKit & | SetCheckBoxes (size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]) |
Adds check boxes to the page. More... | |
PageKit & | SetCheckBoxes (CheckBoxKitArray const &in_checkbox, IntRectangleArray const &in_locations) |
Adds check boxes to the page. More... | |
PageKit & | AddCheckBoxes (size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]) |
Adds check boxes to the page. More... | |
PageKit & | AddCheckBoxes (CheckBoxKitArray const &in_checkbox, IntRectangleArray const &in_locations) |
Adds check boxes to the page. More... | |
PageKit & | SetRadioButton (RadioButtonKit const &in_radio_button, IntRectangle const &in_location) |
Adds a radio button to the page. More... | |
PageKit & | AddRadioButton (RadioButtonKit const &in_radio_button, IntRectangle const &in_location) |
Adds a radio button to the page. More... | |
PageKit & | SetRadioButtons (size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]) |
Adds a list of buttons to the page. More... | |
PageKit & | SetRadioButtons (RadioButtonKitArray const &in_radio_buttons, IntRectangleArray const &in_locations) |
Adds a list of buttons to the page. More... | |
PageKit & | AddRadioButtons (size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]) |
Adds a list of buttons to the page. More... | |
PageKit & | AddRadioButtons (RadioButtonKitArray const &in_radio_buttons, IntRectangleArray const &in_locations) |
Adds a list of buttons to the page. More... | |
PageKit & | SetListBox (ListBoxKit const &in_list_box, IntRectangle const &in_location) |
Adds a list box to the page. More... | |
PageKit & | AddListBox (ListBoxKit const &in_list_box, IntRectangle const &in_location) |
Adds a list box to the page. More... | |
PageKit & | SetListBoxes (size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]) |
Adds list boxes to the page. More... | |
PageKit & | SetListBoxes (ListBoxKitArray const &in_list_box, IntRectangleArray const &in_locations) |
Adds list boxes to the page. More... | |
PageKit & | AddListBoxes (size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]) |
Adds list boxes to the page. More... | |
PageKit & | AddListBoxes (ListBoxKitArray const &in_list_box, IntRectangleArray const &in_locations) |
Adds list boxes to the page. More... | |
PageKit & | SetDropDownList (DropDownListKit const &in_drop_down_list, IntRectangle const &in_location) |
Adds a drop down list to the page. More... | |
PageKit & | AddDropDownList (DropDownListKit const &in_drop_down_list, IntRectangle const &in_location) |
Adds a drop down list to the page. More... | |
PageKit & | SetDropDownLists (size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]) |
Adds drop down lists to the page. More... | |
PageKit & | SetDropDownLists (DropDownListKitArray const &in_drop_down_list, IntRectangleArray const &in_locations) |
Adds drop down lists to the page. More... | |
PageKit & | AddDropDownLists (size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]) |
Adds drop down lists to the page. More... | |
PageKit & | AddDropDownLists (DropDownListKitArray const &in_drop_down_list, IntRectangleArray const &in_locations) |
Adds drop down lists to the page. More... | |
PageKit & | SetSignatureField (SignatureFieldKit const &in_signature_field, IntRectangle const &in_location) |
Adds a signature field to the page. More... | |
PageKit & | AddSignatureField (SignatureFieldKit const &in_signature_field, IntRectangle const &in_location) |
Adds a signature field to the page. More... | |
PageKit & | SetSignatureFields (size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]) |
Adds signature fields to the page. More... | |
PageKit & | SetSignatureFields (SignatureFieldKitArray const &in_signature_field, IntRectangleArray const &in_locations) |
Adds signature fields to the page. More... | |
PageKit & | AddSignatureFields (size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]) |
Adds signature fields to the page. More... | |
PageKit & | AddSignatureFields (SignatureFieldKitArray const &in_signature_field, IntRectangleArray const &in_locations) |
Adds signature fields to the page. More... | |
PageKit & | SetTemplateFile (char const *in_filename) |
Sets the PDF file which will act as a template. More... | |
PageKit & | SetAnnotationByField (char const *in_field, AnnotationKit const &in_annotation) |
Sets an annotation on the given form field. More... | |
PageKit & | SetAnnotationsByField (size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]) |
Sets annotations on the given form fields. More... | |
PageKit & | SetAnnotationsByField (UTF8Array const &in_fields, AnnotationKitArray const &in_annotations) |
Sets annotations on the given form fields. More... | |
PageKit & | SetButtonIconByField (char const *in_field, ImageKit const &in_image) |
Sets an image on the icon at the given form field. More... | |
PageKit & | SetButtonIconsByField (size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]) |
Sets images on the icons at the given form fields. More... | |
PageKit & | SetButtonIconsByField (UTF8Array const &in_fields, ImageKitArray const &in_images) |
Sets images on the icons at the given form fields. More... | |
PageKit & | SetButtonLabelByField (char const *in_field, char const *in_label) |
Sets a label on the given form field. More... | |
PageKit & | SetButtonLabelsByField (size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]) |
Sets labels on the given form fields. More... | |
PageKit & | SetButtonLabelsByField (UTF8Array const &in_fields, UTF8Array const &in_labels) |
Sets labels on the given form fields. More... | |
PageKit & | SetListItemByField (char const *in_field, char const *in_value, char const *in_export_value) |
Adds an item to the list at the given form field. More... | |
PageKit & | 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. More... | |
PageKit & | SetListItemsByField (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. More... | |
PageKit & | SetListItemsByField (char const *in_field, UTF8Array const &in_values, UTF8Array const &in_export_values) |
Adds items to the list at the given form field. More... | |
PageKit & | 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. More... | |
PageKit & | AddListItemsByField (char const *in_field, UTF8Array const &in_values, UTF8Array const &in_export_values) |
Adds items to the list at the given form field. More... | |
PageKit & | 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. More... | |
PageKit & | 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. More... | |
PageKit & | SetJavaScriptActionsByField (UTF8Array const &in_fields, UTF8Array const &in_sources, SourceTypeArray const &in_types) |
Sets JavaScript sources and/or files on the given form fields. More... | |
PageKit & | SetVisibilityByField (char const *in_field, bool in_state) |
Sets whether the object at the given form field should be visible. More... | |
PageKit & | 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. More... | |
PageKit & | SetVisibilitiesByField (UTF8Array const &in_fields, BoolArray const &in_states) |
Sets whether the objects at the given form fields should be visible. More... | |
PageKit & | SetTextValueByField (char const *in_field, char const *in_value) |
Sets a text value on the given form field. More... | |
PageKit & | SetTextValuesByField (size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]) |
Sets text values on the given form fields. More... | |
PageKit & | SetTextValuesByField (UTF8Array const &in_fields, UTF8Array const &in_values) |
Sets text values on the given form fields. More... | |
PageKit & | UnsetFormat () |
Removes the format from the page. More... | |
PageKit & | UnsetOrientation () |
Removes the orientation from the page. More... | |
PageKit & | UnsetAnnotation (size_t in_index) |
Removes the annotation at the given index from the page. More... | |
PageKit & | UnsetAnnotations (size_t in_count, size_t const in_indices[]) |
Removes the annotations at the given indices from the page. More... | |
PageKit & | UnsetAnnotations (SizeTArray const &in_indices) |
Removes the annotations at the given indices from the page. More... | |
PageKit & | UnsetAnnotations () |
Removes all annotations from the page. More... | |
PageKit & | UnsetText (size_t in_index) |
Removes the text at the given index from the page. More... | |
PageKit & | UnsetText (size_t in_count, size_t const in_indices[]) |
Removes the text at the given indices from the page. More... | |
PageKit & | UnsetText (SizeTArray const &in_indices) |
Removes the text at the given indices from the page. More... | |
PageKit & | UnsetText () |
Removes all text from the page. More... | |
PageKit & | UnsetCheckBox (size_t in_index) |
Removes the check box at the given index from the page. More... | |
PageKit & | UnsetCheckBoxes (size_t in_count, size_t const in_indices[]) |
Removes the check box at the given indices from the page. More... | |
PageKit & | UnsetCheckBoxes (SizeTArray const &in_indices) |
Removes the check box at the given indices from the page. More... | |
PageKit & | UnsetCheckBoxes () |
Removes all check boxes from the page. More... | |
PageKit & | UnsetRadioButton (size_t in_index) |
Removes the radio button at the given index from the page. More... | |
PageKit & | UnsetRadioButtons (size_t in_count, size_t const in_indices[]) |
Removes the radio button at the given indices from the page. More... | |
PageKit & | UnsetRadioButtons (SizeTArray const &in_indices) |
Removes the radio button at the given indices from the page. More... | |
PageKit & | UnsetRadioButtons () |
Removes all radio buttons from the page. More... | |
PageKit & | UnsetListBox (size_t in_index) |
Removes the list box at the given index from the page. More... | |
PageKit & | UnsetListBoxes (size_t in_count, size_t const in_indices[]) |
Removes the list box at the given indices from the page. More... | |
PageKit & | UnsetListBoxes (SizeTArray const &in_indices) |
Removes the list box at the given indices from the page. More... | |
PageKit & | UnsetListBoxes () |
Removes all list boxes from the page. More... | |
PageKit & | UnsetDropDownList (size_t in_index) |
Removes the drop down list at the given index from the page. More... | |
PageKit & | UnsetDropDownLists (size_t in_count, size_t const in_indices[]) |
Removes the drop down list at the given indices from the page. More... | |
PageKit & | UnsetDropDownLists (SizeTArray const &in_indices) |
Removes the drop down list at the given indices from the page. More... | |
PageKit & | UnsetDropDownLists () |
Removes all drop down lists from the page. More... | |
PageKit & | UnsetSignatureField (size_t in_index) |
Removes the signature field at the given index from the page. More... | |
PageKit & | UnsetSignatureFields (size_t in_count, size_t const in_indices[]) |
Removes the signature field at the given indices from the page. More... | |
PageKit & | UnsetSignatureFields (SizeTArray const &in_indices) |
Removes the signature field at the given indices from the page. More... | |
PageKit & | UnsetSignatureFields () |
Removes all signature fields from the page. More... | |
PageKit & | UnsetImage (size_t in_index) |
Removes the image at the given index from the page. More... | |
PageKit & | UnsetImages (size_t in_count, size_t const in_indices[]) |
Removes the images at the given indices from the page. More... | |
PageKit & | UnsetImages (SizeTArray const &in_indices) |
Removes the images at the given indices from the page. More... | |
PageKit & | UnsetImages () |
Removes all images from the page. More... | |
PageKit & | UnsetTable (size_t in_index) |
Removes the table at the given index from the page. More... | |
PageKit & | UnsetTables (size_t in_count, size_t const in_indices[]) |
Removes the tables at the given indices from the page. More... | |
PageKit & | UnsetTables (SizeTArray const &in_indices) |
Removes the tables at the given indices from the page. More... | |
PageKit & | UnsetTables () |
Removes all tables from the page. More... | |
PageKit & | UnsetLink (size_t in_index) |
Removes the link at the given index from the page. More... | |
PageKit & | UnsetLinks (size_t in_count, size_t const in_indices[]) |
Removes the links at the given indices from the page. More... | |
PageKit & | UnsetLinks (SizeTArray const &in_indices) |
Removes the links at the given indices from the page. More... | |
PageKit & | UnsetLinks () |
Removes all links from the page. More... | |
PageKit & | UnsetButton (size_t in_index) |
Removes the button at the given index from the page. More... | |
PageKit & | UnsetButtons (size_t in_count, size_t const in_indices[]) |
Removes the buttons at the given indices from the page. More... | |
PageKit & | UnsetButtons (SizeTArray const &in_indices) |
Removes the buttons at the given indices from the page. More... | |
PageKit & | UnsetButtons () |
Removes all buttons from the page. More... | |
PageKit & | UnsetTextField (size_t in_index) |
Removes the text field at the given index from the page. More... | |
PageKit & | UnsetTextFields (size_t in_count, size_t const in_indices[]) |
Removes the text fields at the given indices from the page. More... | |
PageKit & | UnsetTextFields (SizeTArray const &in_indices) |
Removes the text fields at the given indices from the page. More... | |
PageKit & | UnsetTextFields () |
Removes all text fields from the page. More... | |
PageKit & | UnsetSlideTable (size_t in_index) |
Removes the slide table at the given index from the page. More... | |
PageKit & | UnsetSlideTables (size_t in_count, size_t const in_indices[]) |
Removes the slide tables at the given indices from the page. More... | |
PageKit & | UnsetSlideTables (SizeTArray const &in_indices) |
Removes the slide tables at the given indices from the page. More... | |
PageKit & | UnsetSlideTables () |
Removes all slide tables from the page. More... | |
PageKit & | UnsetTemplateFile () |
Removes the template file from the page. More... | |
PageKit & | UnsetAnnotationByField (char const *in_field) |
Removes the annotation at the given form field from the page. More... | |
PageKit & | UnsetAnnotationsByField (size_t in_count, UTF8 const in_fields[]) |
Removes the annotations at the given form fields from the page. More... | |
PageKit & | UnsetAnnotationsByField (UTF8Array const &in_fields) |
Removes the annotations at the given form fields from the page. More... | |
PageKit & | UnsetAnnotationsByField () |
Removes all annotation form fields from the page. More... | |
PageKit & | UnsetButtonIconByField (char const *in_field) |
Removes the image on the icon at the given form field from the page. More... | |
PageKit & | UnsetButtonIconsByField (size_t in_count, UTF8 const in_fields[]) |
Removes the images on the icons at the given form fields from the page. More... | |
PageKit & | UnsetButtonIconsByField (UTF8Array const &in_fields) |
Removes the images on the icons at the given form fields from the page. More... | |
PageKit & | UnsetButtonIconsByField () |
Removes all button icon form fields from the page. More... | |
PageKit & | UnsetButtonLabelByField (char const *in_field) |
Removes the label at the given form field from the page. More... | |
PageKit & | UnsetButtonLabelsByField (size_t in_count, UTF8 const in_fields[]) |
Removes the labels at the given form fields from the page. More... | |
PageKit & | UnsetButtonLabelsByField (UTF8Array const &in_fields) |
Removes the labels at the given form fields from the page. More... | |
PageKit & | UnsetButtonLabelsByField () |
Removes all button label form fields from the page. More... | |
PageKit & | UnsetListItemByField (char const *in_field, size_t in_index) |
Removes the item at the given index from the list at the given form field from the page. More... | |
PageKit & | UnsetListItemsByField (char const *in_field, size_t in_count, size_t const in_indices[]) |
Removes the items at the given indices from the list at the given form field from the page. More... | |
PageKit & | UnsetListItemsByField (char const *in_field, SizeTArray const &in_indices) |
Removes the items at the given indices from the list at the given form field from the page. More... | |
PageKit & | UnsetListItemsByField (char const *in_field) |
Removes all items from the list at the given form field from the page. More... | |
PageKit & | UnsetListItemsByField (size_t in_count, UTF8 const in_fields[]) |
Removes all items from the lists at the given form fields from the page. More... | |
PageKit & | UnsetListItemsByField (UTF8Array const &in_fields) |
Removes all items from the lists at the given form fields from the page. More... | |
PageKit & | UnsetListItemsByField () |
Removes all list item form fields from the page. More... | |
PageKit & | UnsetJavaScriptActionByField (char const *in_field) |
Removes the JavaScript action at the given form field from the page. More... | |
PageKit & | UnsetJavaScriptActionsByField (size_t in_count, UTF8 const in_fields[]) |
Removes the JavaScript actions at the given form fields from the page. More... | |
PageKit & | UnsetJavaScriptActionsByField (UTF8Array const &in_fields) |
Removes the JavaScript actions at the given form fields from the page. More... | |
PageKit & | UnsetJavaScriptActionsByField () |
Removes all JavaScript action form fields from the page. More... | |
PageKit & | UnsetVisibilityByField (char const *in_field) |
Removes the visibility setting at the given form field from the page. More... | |
PageKit & | UnsetVisibilitiesByField (size_t in_count, UTF8 const in_fields[]) |
Removes the visibility settings at the given form fields from the page. More... | |
PageKit & | UnsetVisibilitiesByField (UTF8Array const &in_fields) |
Removes the visibility settings at the given form fields from the page. More... | |
PageKit & | UnsetVisibilitiesByField () |
Removes all visibility settings on form fields from the page. More... | |
PageKit & | UnsetTextValueByField (char const *in_field) |
Removes the text value at the given form field from the page. More... | |
PageKit & | UnsetTextValuesByField (size_t in_count, UTF8 const in_fields[]) |
Removes the text values at the given form fields from the page. More... | |
PageKit & | UnsetTextValuesByField (UTF8Array const &in_fields) |
Removes the text values at the given form fields from the page. More... | |
PageKit & | UnsetTextValuesByField () |
Removes all text value form fields from the page. More... | |
PageKit & | UnsetEverything () |
Removes all data from the page. More... | |
bool | ShowFormat (Page::Format &out_format) const |
Shows the format of the page. More... | |
bool | ShowOrientation (Page::Orientation &out_orientation) const |
Shows the orientation of the page. More... | |
bool | ShowAnnotations (AnnotationKitArray &out_annotations, IntRectangleArray &out_locations) const |
Shows the annotations on the page. More... | |
bool | ShowText (TextKitArray &out_text, IntRectangleArray &out_locations) const |
Shows the text on the page. More... | |
bool | ShowImages (ImageKitArray &out_images, IntRectangleArray &out_locations) const |
Shows the images on the page. More... | |
bool | ShowTables (TableKitArray &out_tables, IntRectangleArray &out_locations) const |
Shows the tables on the page. More... | |
bool | ShowLinks (LinkKitArray &out_links, IntRectangleArray &out_locations) const |
Shows the links on the page. More... | |
bool | ShowButtons (ButtonKitArray &out_buttons, IntRectangleArray &out_locations) const |
Shows the buttons on the page. More... | |
bool | ShowCheckBoxes (CheckBoxKitArray &out_check_boxes, IntRectangleArray &out_locations) const |
Shows the check boxes on the page. More... | |
bool | ShowRadioButtons (RadioButtonKitArray &out_radio_buttons, IntRectangleArray &out_locations) const |
Shows the radio buttons on the page. More... | |
bool | ShowListBoxes (ListBoxKitArray &out_list_boxes, IntRectangleArray &out_locations) const |
Shows the list boxes on the page. More... | |
bool | ShowDropDownLists (DropDownListKitArray &out_drop_down_lists, IntRectangleArray &out_locations) const |
Shows the drop down lists on the page. More... | |
bool | ShowSignatureFields (SignatureFieldKitArray &out_signature_fields, IntRectangleArray &out_locations) const |
Shows the signature fields on the page. More... | |
bool | ShowTextFields (TextFieldKitArray &out_text_fields, IntRectangleArray &out_locations) const |
Shows the text fields on the page. More... | |
bool | ShowSlideTables (SlideTableKitArray &out_slide_tables, IntRectangleArray &out_locations) const |
Shows the slide tables on the page. More... | |
bool | ShowTemplateFile (UTF8 &out_filename) const |
Shows the template file. More... | |
bool | ShowAnnotationsByField (UTF8Array &out_fields, AnnotationKitArray &out_annotations) const |
Shows the annotations on form fields on the page. More... | |
bool | ShowButtonIconsByField (UTF8Array &out_fields, ImageKitArray &out_images) const |
Shows the images on icons on form fields on the page. More... | |
bool | ShowButtonLabelsByField (UTF8Array &out_fields, UTF8Array &out_labels) const |
Shows the labels on form fields on the page. More... | |
bool | ShowListItemFields (UTF8Array &out_fields) const |
Shows the list item form fields on the page. More... | |
bool | ShowListItemsByField (char const *in_field, UTF8Array &out_values, UTF8Array &out_export_values) const |
Shows the items in the list on the given field on the page. More... | |
bool | ShowJavaScriptActionsByField (UTF8Array &out_fields, UTF8Array &out_sources, SourceTypeArray &out_types) const |
Shows the JavaScript actions on form fields on the page. More... | |
bool | ShowVisibilitiesByField (UTF8Array &out_fields, BoolArray &out_states) const |
Shows the visibility settings on form fields on the page. More... | |
bool | ShowTextValuesByField (UTF8Array &out_fields, UTF8Array &out_values) const |
Shows the text values on form fields on the page. More... | |
virtual HPS::Type | Type () const |
This function returns the true type of the underlying object. 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 | |
static PageKit | GetDefault () |
Creates a PageKit which contains the default settings. More... | |
template<typename T > | |
static intptr_t | ClassID () |
Unique identifier for this class. More... | |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::PublishPageKit |
The PageKit class is a user space object.
It acts as the container for all data that can be on a page in a Publish PDF.
HPS::Publish::PageKit::PageKit | ( | ) |
The default constructor creates an empty PageKit object.
HPS::Publish::PageKit::PageKit | ( | Page::Format | in_format, |
Page::Orientation | in_orientation | ||
) |
This constructor creates a PageKit with the given format and orientation.
in_format | Format of the page. |
in_orientation | Orientation of the page. |
HPS::Publish::PageKit::PageKit | ( | char const * | in_filename | ) |
This constructor creates a PageKit from the given PDF template file.
in_filename | UTF8-encoded filename for the PDF file to act as a template. |
HPS::Publish::PageKit::PageKit | ( | PageKit const & | in_kit | ) |
HPS::Publish::PageKit::PageKit | ( | PageKit && | in_kit | ) |
|
virtual |
PageKit& HPS::Publish::PageKit::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.
in_annotation | Annotation to add to the page. |
in_location | Annotation location in points relative to bottom left of the page. All fields in the location will be used. |
PageKit& HPS::Publish::PageKit::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.
in_count | Size of the following arrays. |
in_annotations | Annotations to add to the page. |
in_locations | Annotation locations in points relative to bottom left of the page. |
PageKit& HPS::Publish::PageKit::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.
in_annotations | Annotations to add to the page. |
in_locations | Annotation locations in points relative to bottom left of the page. |
PageKit& HPS::Publish::PageKit::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.
in_button | Button to add to the page. |
in_location | Button location in points relative to bottom left of the page. All fields in the location will be used. |
PageKit& HPS::Publish::PageKit::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.
in_count | Size of the following arrays. |
in_buttons | Buttons to add to the page. |
in_locations | Button locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_buttons | Buttons to add to the page. |
in_locations | Button locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::AddCheckBox | ( | CheckBoxKit const & | in_checkbox, |
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.
in_checkbox | Check Box to add to the page. |
in_location | Check Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::AddCheckBoxes | ( | size_t | in_count, |
CheckBoxKit const | in_checkbox[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds 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.
in_count | Size of the following arrays. |
in_checkbox | Check Box to add to the page. |
in_locations | Check Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::AddCheckBoxes | ( | CheckBoxKitArray const & | in_checkbox, |
IntRectangleArray const & | in_locations | ||
) |
Adds 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.
in_checkbox | Check Box to add to the page. |
in_locations | Check Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_drop_down_list | Drop Down List to add to the page. |
in_location | Drop Down List location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::AddDropDownLists | ( | size_t | in_count, |
DropDownListKit const | in_drop_down_list[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds 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.
in_count | Size of the following arrays. |
in_drop_down_list | Drop Down List to add to the page. |
in_locations | Drop Down List locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::AddDropDownLists | ( | DropDownListKitArray const & | in_drop_down_list, |
IntRectangleArray const & | in_locations | ||
) |
Adds 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.
in_drop_down_list | Drop Down List to add to the page. |
in_locations | Drop Down List locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_image | Image to add to the page. |
in_location | Image location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::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.
in_count | Size of the following arrays. |
in_images | Images to add to the page. |
in_locations | Image locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_images | Images to add to the page. |
in_locations | Image locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_link | Link to add to the page. |
in_location | Link location in points relative to bottom left of the page. All fields in the location will be used. |
PageKit& HPS::Publish::PageKit::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.
in_count | Size of the following arrays. |
in_links | Links to add to the page. |
in_locations | Link locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_links | Links to add to the page. |
in_locations | Link locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_list_box | List Box to add to the page. |
in_location | List Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::AddListBoxes | ( | size_t | in_count, |
ListBoxKit const | in_list_box[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds 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.
in_count | Size of the following arrays. |
in_list_box | List Box to add to the page. |
in_locations | List Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::AddListBoxes | ( | ListBoxKitArray const & | in_list_box, |
IntRectangleArray const & | in_locations | ||
) |
Adds 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.
in_list_box | List Box to add to the page. |
in_locations | List Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_field | UTF8-encoded form field name for the list. |
in_value | UTF8-encoded value for the item to be added to the list at the given form field. |
in_export_value | UTF8-encoded export value for the item to be added to the list at the given form field. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_field | UTF8-encoded form field name for the list. |
in_count | Size of the following arrays. |
in_values | The values for the items to be added to the list at the given form field. |
in_export_values | The export values for the items to be added to the list at the given form field. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_field | UTF8-encoded form field name for the list. |
in_values | The values for the items to be added to the list at the given form field. |
in_export_values | The export values for the items to be added to the list at the given form field. |
PageKit& HPS::Publish::PageKit::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.
in_radio_button | Radio button to add to the page. |
in_location | Button location in points relative to bottom left of the page. All fields in the location will be used. |
PageKit& HPS::Publish::PageKit::AddRadioButtons | ( | size_t | in_count, |
RadioButtonKit const | in_radio_buttons[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of buttons to the page.
This will not replace any radio buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.
in_count | Size of the following arrays. |
in_radio_buttons | Radio buttons to add to the page. |
in_locations | Button locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::AddRadioButtons | ( | RadioButtonKitArray const & | in_radio_buttons, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of buttons to the page.
This will not replace any radio buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.
in_radio_buttons | Radio buttons to add to the page. |
in_locations | Button locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_signature_field | Signature Field to add to the page. |
in_location | Signature Field location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::AddSignatureFields | ( | size_t | in_count, |
SignatureFieldKit const | in_signature_field[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds 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.
in_count | Size of the following arrays. |
in_signature_field | Signature Field to add to the page. |
in_locations | Signature Field locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::AddSignatureFields | ( | SignatureFieldKitArray const & | in_signature_field, |
IntRectangleArray const & | in_locations | ||
) |
Adds 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.
in_signature_field | Signature Field to add to the page. |
in_locations | Signature Field locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_slide_table | Slide table to add to the page. |
in_location | Slide table location in points relative to upper left of the page. Only the left and top fields in the location will be used. |
PageKit& HPS::Publish::PageKit::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.
in_count | Size of the following arrays. |
in_slide_tables | Slide tables to add to the page. |
in_locations | Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_slide_tables | Slide tables to add to the page. |
in_locations | Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_table | Table to add to the page. |
in_location | Table location in points relative to upper left of the page. Only the left and top fields in the location will be used. |
PageKit& HPS::Publish::PageKit::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.
in_count | Size of the following arrays. |
in_tables | Tables to add to the page. |
in_locations | Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_tables | Tables to add to the page. |
in_locations | Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_text | Text to add to the page. |
in_location | Text location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::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.
in_count | Size of the following arrays. |
in_text | Text to add to the page. |
in_locations | Text locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_text | Text to add to the page. |
in_locations | Text locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_text_field | Text field to add to the page. |
in_location | Text field location in points relative to bottom left of the page. All fields in the location will be used. |
PageKit& HPS::Publish::PageKit::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.
in_count | Size of the following arrays. |
in_text_fields | Text fields to add to the page. |
in_locations | Text field locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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.
in_text_fields | Text fields to add to the page. |
in_locations | Text field locations in points relative to bottom left of the page. All fields in the locations will be used. |
|
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.
|
virtual |
Indicates whether this PageKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Publish::PageKit::Equals | ( | PageKit const & | in_kit | ) | const |
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
static |
Creates a PageKit 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 PageKit passed to File::Export.
|
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.
|
inherited |
|
inlinevirtual |
bool HPS::Publish::PageKit::operator!= | ( | PageKit const & | in_kit | ) | const |
bool HPS::Publish::PageKit::operator== | ( | PageKit const & | in_kit | ) | const |
|
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.
void HPS::Publish::PageKit::Set | ( | PageKit const & | in_kit | ) |
PageKit& HPS::Publish::PageKit::SetAnnotation | ( | AnnotationKit const & | in_annotation, |
IntRectangle const & | in_location | ||
) |
Adds an annotation to the page.
This will replace all annotations (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsert3DAnnot.
in_annotation | Annotation to add to the page. |
in_location | Annotation location in points relative to bottom left of the page. All fields in the location will be used. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_field | UTF8-encoded form field name for the annotation. |
in_annotation | The annotation to be set on the given form field. |
PageKit& HPS::Publish::PageKit::SetAnnotations | ( | size_t | in_count, |
AnnotationKit const | in_annotations[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of annotations to the page.
This will replace all annotations (if any) on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.
in_count | Size of the following arrays. |
in_annotations | Annotations to add to the page. |
in_locations | Annotation locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetAnnotations | ( | AnnotationKitArray const & | in_annotations, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of annotations to the page.
This will replace all annotations (if any) on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.
in_annotations | Annotations to add to the page. |
in_locations | Annotation locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_count | Size of the following arrays. |
in_fields | The form field names for the annotations. |
in_annotations | The annotations to be set on the corresponding form fields. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_fields | The form field names for the annotations. |
in_annotations | The annotations to be set on the corresponding form fields. |
PageKit& HPS::Publish::PageKit::SetButton | ( | ButtonKit const & | in_button, |
IntRectangle const & | in_location | ||
) |
Adds a button to the page.
This will replace all buttons (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertButton.
in_button | Button to add to the page. |
in_location | Button location in points relative to bottom left of the page. All fields in the location will be used. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_field | UTF8-encoded form field name for the icon. |
in_image | The image to be set on the icon at the given form field. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_count | Size of the following arrays. |
in_fields | The form field names for the icons. |
in_images | The images to be set on the icons at the corresponding form fields. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_fields | The form field names for the icons. |
in_images | The images to be set on the icons at the corresponding form fields. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_field | UTF8-encoded form field name for the label. |
in_label | UTF8-encoded label to be set on the given form field. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_count | Size of the following arrays. |
in_fields | The form field names for the labels. |
in_labels | The labels to be set on the corresponding form fields. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_fields | The form field names for the labels. |
in_labels | The labels to be set on the corresponding form fields. |
PageKit& HPS::Publish::PageKit::SetButtons | ( | size_t | in_count, |
ButtonKit const | in_buttons[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of buttons to the page.
This will replace all buttons (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.
in_count | Size of the following arrays. |
in_buttons | Buttons to add to the page. |
in_locations | Button locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetButtons | ( | ButtonKitArray const & | in_buttons, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of buttons to the page.
This will replace all buttons (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.
in_buttons | Buttons to add to the page. |
in_locations | Button locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetCheckBox | ( | CheckBoxKit const & | in_checkbox, |
IntRectangle const & | in_location | ||
) |
Adds a check box to the page.
This will replace all check box (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertCheckBox.
in_checkbox | Check Box to add to the page. |
in_location | Check Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetCheckBoxes | ( | size_t | in_count, |
CheckBoxKit const | in_checkbox[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds check boxes to the page.
This will replace all check boxes (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.
in_count | Size of the following arrays. |
in_checkbox | Check Box to add to the page. |
in_locations | Check Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetCheckBoxes | ( | CheckBoxKitArray const & | in_checkbox, |
IntRectangleArray const & | in_locations | ||
) |
Adds check boxes to the page.
This will replace all check boxes (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.
in_checkbox | Check Box to add to the page. |
in_locations | Check Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetDropDownList | ( | DropDownListKit const & | in_drop_down_list, |
IntRectangle const & | in_location | ||
) |
Adds a drop down list to the page.
This will replace all drop down list (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertDropDownList.
in_drop_down_list | Drop Down List to add to the page. |
in_location | Drop Down List location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetDropDownLists | ( | size_t | in_count, |
DropDownListKit const | in_drop_down_list[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds drop down lists to the page.
This will replace all drop down lists (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.
in_count | Size of the following arrays. |
in_drop_down_list | Drop Down List to add to the page. |
in_locations | Drop Down List locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetDropDownLists | ( | DropDownListKitArray const & | in_drop_down_list, |
IntRectangleArray const & | in_locations | ||
) |
Adds drop down lists to the page.
This will replace all drop down lists (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.
in_drop_down_list | Drop Down List to add to the page. |
in_locations | Drop Down List locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetFormat | ( | Page::Format | in_format | ) |
Sets the format of the page.
This corresponds to the value that will be passed to A3DPDFPageData::m_ePageSize. This has no effect if this page has a template file.
in_format | Format of the page. |
PageKit& HPS::Publish::PageKit::SetImage | ( | ImageKit const & | in_image, |
IntRectangle const & | in_location | ||
) |
Adds an image to the page.
This will replace all images (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertImage.
in_image | Image to add to the page. |
in_location | Image location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetImages | ( | size_t | in_count, |
ImageKit const | in_images[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of images to the page.
This will replace all images (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.
in_count | Size of the following arrays. |
in_images | Images to add to the page. |
in_locations | Image locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetImages | ( | ImageKitArray const & | in_images, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of images to the page.
This will replace all images (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.
in_images | Images to add to the page. |
in_locations | Image locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_field | UTF8-encoded form field name for the JavaScript action. |
in_source | UTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field. |
in_type | The type of the preceding argument. Defaults to Source::Type::Code. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_count | Size of the following arrays. |
in_fields | The form field names for the JavaScript actions. |
in_sources | The JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields. |
in_types | The types for each item in the preceding argument array. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_fields | The form field names for the JavaScript actions. |
in_sources | The JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields. |
in_types | The types for each item in the preceding argument array. |
PageKit& HPS::Publish::PageKit::SetLink | ( | LinkKit const & | in_link, |
IntRectangle const & | in_location | ||
) |
Adds a link to the page.
This will replace all links (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertLink.
in_link | Link to add to the page. |
in_location | Link location in points relative to bottom left of the page. All fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetLinks | ( | size_t | in_count, |
LinkKit const | in_links[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of links to the page.
This will replace all links (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.
in_count | Size of the following arrays. |
in_links | Links to add to the page. |
in_locations | Link locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetLinks | ( | LinkKitArray const & | in_links, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of links to the page.
This will replace all links (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.
in_links | Links to add to the page. |
in_locations | Link locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetListBox | ( | ListBoxKit const & | in_list_box, |
IntRectangle const & | in_location | ||
) |
Adds a list box to the page.
This will replace all list box (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertListBox.
in_list_box | List Box to add to the page. |
in_location | List Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetListBoxes | ( | size_t | in_count, |
ListBoxKit const | in_list_box[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds list boxes to the page.
This will replace all list boxes (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.
in_count | Size of the following arrays. |
in_list_box | List Box to add to the page. |
in_locations | List Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetListBoxes | ( | ListBoxKitArray const & | in_list_box, |
IntRectangleArray const & | in_locations | ||
) |
Adds list boxes to the page.
This will replace all list boxes (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.
in_list_box | List Box to add to the page. |
in_locations | List Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetListItemByField | ( | char const * | in_field, |
char const * | in_value, | ||
char const * | in_export_value | ||
) |
Adds an item to the list at the given form field.
If there are any existing items in the list at the given form field, they will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.
in_field | UTF8-encoded form field name for the list. |
in_value | UTF8-encoded value for the item to be added to the list at the given form field. |
in_export_value | UTF8-encoded export value for the item to be added to the list at the given form field. |
PageKit& HPS::Publish::PageKit::SetListItemsByField | ( | 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.
If there are any existing items in the list at the given form field, they will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.
in_field | UTF8-encoded form field name for the list. |
in_count | Size of the following arrays. |
in_values | The values for the items to be added to the list at the given form field. |
in_export_values | The export values for the items to be added to the list at the given form field. |
PageKit& HPS::Publish::PageKit::SetListItemsByField | ( | char const * | in_field, |
UTF8Array const & | in_values, | ||
UTF8Array const & | in_export_values | ||
) |
Adds items to the list at the given form field.
If there are any existing items in the list at the given form field, they will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.
in_field | UTF8-encoded form field name for the list. |
in_values | The values for the items to be added to the list at the given form field. |
in_export_values | The export values for the items to be added to the list at the given form field. |
PageKit& HPS::Publish::PageKit::SetOrientation | ( | Page::Orientation | in_orientation | ) |
Sets the orientation of the page.
This corresponds to the value that will be passed to A3DPDFPageData::m_ePageOrientation. This has no effect if this page has a template file.
in_orientation | Orientation of the page. |
PageKit& HPS::Publish::PageKit::SetRadioButton | ( | RadioButtonKit const & | in_radio_button, |
IntRectangle const & | in_location | ||
) |
Adds a radio button to the page.
This will replace all radio buttons (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertRadioButton.
in_radio_button | Radio button to add to the page. |
in_location | Button location in points relative to bottom left of the page. All fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetRadioButtons | ( | size_t | in_count, |
RadioButtonKit const | in_radio_buttons[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of buttons to the page.
This will replace all radio buttons (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.
in_count | Size of the following arrays. |
in_radio_buttons | Radio buttons to add to the page. |
in_locations | Button locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetRadioButtons | ( | RadioButtonKitArray const & | in_radio_buttons, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of buttons to the page.
This will replace all radio buttons (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.
in_radio_buttons | Radio buttons to add to the page. |
in_locations | Button locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetSignatureField | ( | SignatureFieldKit const & | in_signature_field, |
IntRectangle const & | in_location | ||
) |
Adds a signature field to the page.
This will replace all signature field (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertSignatureField.
in_signature_field | Signature Field to add to the page. |
in_location | Signature Field location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetSignatureFields | ( | size_t | in_count, |
SignatureFieldKit const | in_signature_field[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds signature fields to the page.
This will replace all signature fields (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.
in_count | Size of the following arrays. |
in_signature_field | Signature Field to add to the page. |
in_locations | Signature Field locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetSignatureFields | ( | SignatureFieldKitArray const & | in_signature_field, |
IntRectangleArray const & | in_locations | ||
) |
Adds signature fields to the page.
This will replace all signature fields (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.
in_signature_field | Signature Field to add to the page. |
in_locations | Signature Field locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetSlideTable | ( | SlideTableKit const & | in_slide_table, |
IntRectangle const & | in_location | ||
) |
Adds a slide table to the page.
This will replace all slide tables (if any) on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.
in_slide_table | Slide table to add to the page. |
in_location | Slide table location in points relative to upper left of the page. Only the left and top fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetSlideTables | ( | size_t | in_count, |
SlideTableKit const | in_slide_tables[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of slide tables to the page.
This will replace all slide tables (if any) on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.
in_count | Size of the following arrays. |
in_slide_tables | Slide tables to add to the page. |
in_locations | Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetSlideTables | ( | SlideTableKitArray const & | in_slide_tables, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of slide tables to the page.
This will replace all slide tables (if any) on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.
in_slide_tables | Slide tables to add to the page. |
in_locations | Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetTable | ( | TableKit const & | in_table, |
IntRectangle const & | in_location | ||
) |
Adds a table to the page.
This will replace all tables (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.
in_table | Table to add to the page. |
in_location | Table location in points relative to upper left of the page. Only the left and top fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetTables | ( | size_t | in_count, |
TableKit const | in_tables[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of tables to the page.
This will replace all tables (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.
in_count | Size of the following arrays. |
in_tables | Tables to add to the page. |
in_locations | Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetTables | ( | TableKitArray const & | in_tables, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of tables to the page.
This will replace all tables (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.
in_tables | Tables to add to the page. |
in_locations | Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetTemplateFile | ( | char const * | in_filename | ) |
Sets the PDF file which will act as a template.
in_filename | UTF8-encoded filename for the PDF file to act as a template. |
PageKit& HPS::Publish::PageKit::SetText | ( | TextKit const & | in_text, |
IntRectangle const & | in_location | ||
) |
Adds a text string to the page.
This will replace all text (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertText.
in_text | Text to add to the page. |
in_location | Text location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetText | ( | size_t | in_count, |
TextKit const | in_text[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds text strings to the page.
This will replace all text (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertText.
in_count | Size of the following arrays. |
in_text | Text to add to the page. |
in_locations | Text locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetText | ( | TextKitArray const & | in_text, |
IntRectangleArray const & | in_locations | ||
) |
Adds text strings to the page.
This will replace all text (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertText.
in_text | Text to add to the page. |
in_locations | Text locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetTextField | ( | TextFieldKit const & | in_text_field, |
IntRectangle const & | in_location | ||
) |
Adds a text field to the page.
This will replace all text fields (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTextField.
in_text_field | Text field to add to the page. |
in_location | Text field location in points relative to bottom left of the page. All fields in the location will be used. |
PageKit& HPS::Publish::PageKit::SetTextFields | ( | size_t | in_count, |
TextFieldKit const | in_text_fields[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of text fields to the page.
This will replace all text fields (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.
in_count | Size of the following arrays. |
in_text_fields | Text fields to add to the page. |
in_locations | Text field locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::SetTextFields | ( | TextFieldKitArray const & | in_text_fields, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of text fields to the page.
This will replace all text fields (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.
in_text_fields | Text fields to add to the page. |
in_locations | Text field locations in points relative to bottom left of the page. All fields in the locations will be used. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_field | UTF8-encoded form field name for the text value. |
in_value | UTF8-encoded text value to be set on the given form field. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_count | Size of the following arrays. |
in_fields | The form field names for the text values. |
in_values | The text values to be set on the corresponding form fields. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_fields | The form field names for the text values. |
in_values | The text values to be set on the corresponding form fields. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_count | Size of the following arrays. |
in_fields | The form field names on which to set visibility. |
in_states | Whether the objects at the at the corresponding form fields should be visible. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_fields | The form field names on which to set visibility. |
in_states | Whether the objects at the at the corresponding form fields should be visible. |
PageKit& HPS::Publish::PageKit::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 page has a template file.
in_field | UTF8-encoded form field name on which to set visibility. |
in_state | Whether the object at the at the given form field should be visible. |
void HPS::Publish::PageKit::Show | ( | PageKit & | out_kit | ) | const |
bool HPS::Publish::PageKit::ShowAnnotations | ( | AnnotationKitArray & | out_annotations, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the annotations on the page.
out_annotations | Annotations on the page. |
out_locations | Annotation locations on the page. |
bool HPS::Publish::PageKit::ShowAnnotationsByField | ( | UTF8Array & | out_fields, |
AnnotationKitArray & | out_annotations | ||
) | const |
Shows the annotations on form fields on the page.
out_fields | The annotation form field names on the page. |
out_annotations | The annotations on the corresponding form fields. |
bool HPS::Publish::PageKit::ShowButtonIconsByField | ( | UTF8Array & | out_fields, |
ImageKitArray & | out_images | ||
) | const |
Shows the images on icons on form fields on the page.
out_fields | The button icon form field names on the page. |
out_images | The images on the icons at the corresponding form fields. |
bool HPS::Publish::PageKit::ShowButtonLabelsByField | ( | UTF8Array & | out_fields, |
UTF8Array & | out_labels | ||
) | const |
Shows the labels on form fields on the page.
out_fields | The button label form field names on the page. |
out_labels | The labels on the corresponding form fields. |
bool HPS::Publish::PageKit::ShowButtons | ( | ButtonKitArray & | out_buttons, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the buttons on the page.
out_buttons | Buttons on the page. |
out_locations | Button locations on the page. |
bool HPS::Publish::PageKit::ShowCheckBoxes | ( | CheckBoxKitArray & | out_check_boxes, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the check boxes on the page.
out_check_boxes | Check boxes on the page. |
out_locations | Check box locations on the page. |
bool HPS::Publish::PageKit::ShowDropDownLists | ( | DropDownListKitArray & | out_drop_down_lists, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the drop down lists on the page.
out_drop_down_lists | Drop down lists on the page. |
out_locations | Drop drown list locations on the page. |
bool HPS::Publish::PageKit::ShowFormat | ( | Page::Format & | out_format | ) | const |
Shows the format of the page.
out_format | Format of the page. |
bool HPS::Publish::PageKit::ShowImages | ( | ImageKitArray & | out_images, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the images on the page.
out_images | Images on the page. |
out_locations | Image locations on the page. |
bool HPS::Publish::PageKit::ShowJavaScriptActionsByField | ( | UTF8Array & | out_fields, |
UTF8Array & | out_sources, | ||
SourceTypeArray & | out_types | ||
) | const |
Shows the JavaScript actions on form fields on the page.
out_fields | The form field names with JavaScript actions on the page. |
out_sources | The JavaScript sources and/or files (depending on the corresponding entry in the following argument) on the corresponding form fields. |
out_types | The types for each item in the preceding argument array. |
bool HPS::Publish::PageKit::ShowLinks | ( | LinkKitArray & | out_links, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the links on the page.
out_links | Links on the page. |
out_locations | Link locations on the page. |
bool HPS::Publish::PageKit::ShowListBoxes | ( | ListBoxKitArray & | out_list_boxes, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the list boxes on the page.
out_list_boxes | List boxes on the page. |
out_locations | List boxes locations on the page. |
bool HPS::Publish::PageKit::ShowListItemFields | ( | UTF8Array & | out_fields | ) | const |
Shows the list item form fields on the page.
out_fields | The list form field names on the page. |
bool HPS::Publish::PageKit::ShowListItemsByField | ( | char const * | in_field, |
UTF8Array & | out_values, | ||
UTF8Array & | out_export_values | ||
) | const |
Shows the items in the list on the given field on the page.
in_field | UTF8-encoded form field name of the list with the items to be shown. |
out_values | The values for the items in the list at the given form field. |
out_export_values | The export values for the items in the list at the given form field. |
bool HPS::Publish::PageKit::ShowOrientation | ( | Page::Orientation & | out_orientation | ) | const |
Shows the orientation of the page.
out_orientation | Orientation of the page. |
bool HPS::Publish::PageKit::ShowRadioButtons | ( | RadioButtonKitArray & | out_radio_buttons, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the radio buttons on the page.
out_radio_buttons | Radio buttons on the page. |
out_locations | Radio buttons locations on the page. |
bool HPS::Publish::PageKit::ShowSignatureFields | ( | SignatureFieldKitArray & | out_signature_fields, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the signature fields on the page.
out_signature_fields | Signature fields on the page. |
out_locations | Signature field locations on the page. |
bool HPS::Publish::PageKit::ShowSlideTables | ( | SlideTableKitArray & | out_slide_tables, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the slide tables on the page.
out_slide_tables | Slide tables on the page. |
out_locations | Slide table locations on the page. |
bool HPS::Publish::PageKit::ShowTables | ( | TableKitArray & | out_tables, |
IntRectangleArray & | out_locations | ||
) | const |
Shows the tables on the page.
out_tables | Tables on the page. |
out_locations | Table locations on the page. |
bool HPS::Publish::PageKit::ShowTemplateFile | ( | UTF8 & | out_filename | ) | const |
Shows the template file.
out_filename | The filename for the PDF file to act as a template. |
bool HPS::Publish::PageKit::ShowText | ( | TextKitArray & | out_text, |
IntRectangleArray & | out_locations | ||
) | const |
bool HPS::Publish::PageKit::ShowTextFields | ( | TextFieldKitArray & | out_text_fields, |
IntRectangleArray & | out_locations | ||
) | const |
bool HPS::Publish::PageKit::ShowTextValuesByField | ( | UTF8Array & | out_fields, |
UTF8Array & | out_values | ||
) | const |
Shows the text values on form fields on the page.
out_fields | The form field names with the text values on the template. |
out_values | The text values on the corresponding form fields. |
bool HPS::Publish::PageKit::ShowVisibilitiesByField | ( | UTF8Array & | out_fields, |
BoolArray & | out_states | ||
) | const |
Shows the visibility settings on form fields on the page.
out_fields | The form field names with visibility settings on the page. |
out_states | Whether the objects at the at the corresponding form fields should be visible. |
|
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.
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.
PageKit& HPS::Publish::PageKit::UnsetAnnotation | ( | size_t | in_index | ) |
Removes the annotation at the given index from the page.
in_index | Index of the annotation to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetAnnotationByField | ( | char const * | in_field | ) |
Removes the annotation at the given form field from the page.
in_field | UTF8-encoded form field name with the annotation to be removed. |
PageKit& HPS::Publish::PageKit::UnsetAnnotations | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the annotations at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the annotations to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetAnnotations | ( | SizeTArray const & | in_indices | ) |
Removes the annotations at the given indices from the page.
in_indices | Indices of the annotations to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetAnnotations | ( | ) |
Removes all annotations from the page.
Removes the annotations at the given form fields from the page.
in_count | Size of the following array. |
in_fields | Form field names with the annotations to be removed. |
Removes the annotations at the given form fields from the page.
in_fields | Form field names with the annotations to be removed. |
PageKit& HPS::Publish::PageKit::UnsetAnnotationsByField | ( | ) |
Removes all annotation form fields from the page.
PageKit& HPS::Publish::PageKit::UnsetButton | ( | size_t | in_index | ) |
Removes the button at the given index from the page.
in_index | Index of the button to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetButtonIconByField | ( | char const * | in_field | ) |
Removes the image on the icon at the given form field from the page.
in_field | UTF8-encoded form field name of the icon with the image to be removed. |
Removes the images on the icons at the given form fields from the page.
in_count | Size of the following array. |
in_fields | Form field names of icons with the images to be removed. |
Removes the images on the icons at the given form fields from the page.
in_fields | Form field names of icons with the images to be removed. |
PageKit& HPS::Publish::PageKit::UnsetButtonIconsByField | ( | ) |
Removes all button icon form fields from the page.
PageKit& HPS::Publish::PageKit::UnsetButtonLabelByField | ( | char const * | in_field | ) |
Removes the label at the given form field from the page.
in_field | UTF8-encoded form field name of the label to be removed. |
PageKit& HPS::Publish::PageKit::UnsetButtonLabelsByField | ( | size_t | in_count, |
UTF8 const | in_fields[] | ||
) |
Removes the labels at the given form fields from the page.
in_count | Size of the following array. |
in_fields | Form field names of the labels to be removed. |
Removes the labels at the given form fields from the page.
in_fields | Form field names of the labels to be removed. |
PageKit& HPS::Publish::PageKit::UnsetButtonLabelsByField | ( | ) |
Removes all button label form fields from the page.
PageKit& HPS::Publish::PageKit::UnsetButtons | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the buttons at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the buttons to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetButtons | ( | SizeTArray const & | in_indices | ) |
Removes the buttons at the given indices from the page.
in_indices | Indices of the buttons to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetButtons | ( | ) |
Removes all buttons from the page.
PageKit& HPS::Publish::PageKit::UnsetCheckBox | ( | size_t | in_index | ) |
Removes the check box at the given index from the page.
in_index | Index of the check box to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetCheckBoxes | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the check box at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the check box to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetCheckBoxes | ( | SizeTArray const & | in_indices | ) |
Removes the check box at the given indices from the page.
in_indices | Indices of the check box to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetCheckBoxes | ( | ) |
Removes all check boxes from the page.
PageKit& HPS::Publish::PageKit::UnsetDropDownList | ( | size_t | in_index | ) |
Removes the drop down list at the given index from the page.
in_index | Index of the drop down list to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetDropDownLists | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the drop down list at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the drop down list to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetDropDownLists | ( | SizeTArray const & | in_indices | ) |
Removes the drop down list at the given indices from the page.
in_indices | Indices of the drop down list to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetDropDownLists | ( | ) |
Removes all drop down lists from the page.
PageKit& HPS::Publish::PageKit::UnsetEverything | ( | ) |
Removes all data from the page.
PageKit& HPS::Publish::PageKit::UnsetFormat | ( | ) |
Removes the format from the page.
PageKit& HPS::Publish::PageKit::UnsetImage | ( | size_t | in_index | ) |
Removes the image at the given index from the page.
in_index | Index of the image to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetImages | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the images at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the images to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetImages | ( | SizeTArray const & | in_indices | ) |
Removes the images at the given indices from the page.
in_indices | Indices of the images to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetImages | ( | ) |
Removes all images from the page.
PageKit& HPS::Publish::PageKit::UnsetJavaScriptActionByField | ( | char const * | in_field | ) |
Removes the JavaScript action at the given form field from the page.
in_field | UTF8-encoded form field name of the action to be removed. |
PageKit& HPS::Publish::PageKit::UnsetJavaScriptActionsByField | ( | size_t | in_count, |
UTF8 const | in_fields[] | ||
) |
Removes the JavaScript actions at the given form fields from the page.
in_count | Size of the following array. |
in_fields | Form field names of the actions to be removed. |
Removes the JavaScript actions at the given form fields from the page.
in_fields | Form field names of the actions to be removed. |
PageKit& HPS::Publish::PageKit::UnsetJavaScriptActionsByField | ( | ) |
Removes all JavaScript action form fields from the page.
PageKit& HPS::Publish::PageKit::UnsetLink | ( | size_t | in_index | ) |
Removes the link at the given index from the page.
in_index | Index of the link to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetLinks | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the links at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the links to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetLinks | ( | SizeTArray const & | in_indices | ) |
Removes the links at the given indices from the page.
in_indices | Indices of the links to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetLinks | ( | ) |
Removes all links from the page.
PageKit& HPS::Publish::PageKit::UnsetListBox | ( | size_t | in_index | ) |
Removes the list box at the given index from the page.
in_index | Index of the list box to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetListBoxes | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the list box at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the list box to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetListBoxes | ( | SizeTArray const & | in_indices | ) |
Removes the list box at the given indices from the page.
in_indices | Indices of the list box to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetListBoxes | ( | ) |
Removes all list boxes from the page.
PageKit& HPS::Publish::PageKit::UnsetListItemByField | ( | char const * | in_field, |
size_t | in_index | ||
) |
Removes the item at the given index from the list at the given form field from the page.
in_field | UTF8-encoded form field name of the list with the item to be removed. |
in_index | Index of the item in the list at the given form field to be removed. |
PageKit& HPS::Publish::PageKit::UnsetListItemsByField | ( | char const * | in_field, |
size_t | in_count, | ||
size_t const | in_indices[] | ||
) |
Removes the items at the given indices from the list at the given form field from the page.
in_field | UTF8-encoded form field name of the list with the items to be removed. |
in_count | Size of the following array. |
in_indices | Indices of the items in the list at the form field to be removed. |
PageKit& HPS::Publish::PageKit::UnsetListItemsByField | ( | char const * | in_field, |
SizeTArray const & | in_indices | ||
) |
Removes the items at the given indices from the list at the given form field from the page.
in_field | UTF8-encoded form field name of the list with the items to be removed. |
in_indices | Indices of the items in the list at the form field to be removed. |
PageKit& HPS::Publish::PageKit::UnsetListItemsByField | ( | char const * | in_field | ) |
Removes all items from the list at the given form field from the page.
in_field | UTF8-encoded form field name of the list with the items to be removed. |
Removes all items from the lists at the given form fields from the page.
in_count | Size of the following array. |
in_fields | Form field names of the lists with the items to be removed. |
Removes all items from the lists at the given form fields from the page.
in_fields | Form field names of the lists with the items to be removed. |
PageKit& HPS::Publish::PageKit::UnsetListItemsByField | ( | ) |
Removes all list item form fields from the page.
PageKit& HPS::Publish::PageKit::UnsetOrientation | ( | ) |
Removes the orientation from the page.
PageKit& HPS::Publish::PageKit::UnsetRadioButton | ( | size_t | in_index | ) |
Removes the radio button at the given index from the page.
in_index | Index of the radio button to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetRadioButtons | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the radio button at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the radio button to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetRadioButtons | ( | SizeTArray const & | in_indices | ) |
Removes the radio button at the given indices from the page.
in_indices | Indices of the radio button to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetRadioButtons | ( | ) |
Removes all radio buttons from the page.
PageKit& HPS::Publish::PageKit::UnsetSignatureField | ( | size_t | in_index | ) |
Removes the signature field at the given index from the page.
in_index | Index of the signature field to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetSignatureFields | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the signature field at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the signature field to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetSignatureFields | ( | SizeTArray const & | in_indices | ) |
Removes the signature field at the given indices from the page.
in_indices | Indices of the signature field to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetSignatureFields | ( | ) |
Removes all signature fields from the page.
PageKit& HPS::Publish::PageKit::UnsetSlideTable | ( | size_t | in_index | ) |
Removes the slide table at the given index from the page.
in_index | Index of the slide table to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetSlideTables | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the slide tables at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the slide tables to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetSlideTables | ( | SizeTArray const & | in_indices | ) |
Removes the slide tables at the given indices from the page.
in_indices | Indices of the slide tables to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetSlideTables | ( | ) |
Removes all slide tables from the page.
PageKit& HPS::Publish::PageKit::UnsetTable | ( | size_t | in_index | ) |
Removes the table at the given index from the page.
in_index | Index of the table to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetTables | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the tables at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the tables to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetTables | ( | SizeTArray const & | in_indices | ) |
Removes the tables at the given indices from the page.
in_indices | Indices of the tables to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetTables | ( | ) |
Removes all tables from the page.
PageKit& HPS::Publish::PageKit::UnsetTemplateFile | ( | ) |
Removes the template file from the page.
PageKit& HPS::Publish::PageKit::UnsetText | ( | size_t | in_index | ) |
Removes the text at the given index from the page.
in_index | Index of the text to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetText | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the text at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the text to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetText | ( | SizeTArray const & | in_indices | ) |
Removes the text at the given indices from the page.
in_indices | Indices of the text to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetText | ( | ) |
Removes all text from the page.
PageKit& HPS::Publish::PageKit::UnsetTextField | ( | size_t | in_index | ) |
Removes the text field at the given index from the page.
in_index | Index of the text field to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetTextFields | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Removes the text fields at the given indices from the page.
in_count | Size of the following array. |
in_indices | Indices of the text fields to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetTextFields | ( | SizeTArray const & | in_indices | ) |
Removes the text fields at the given indices from the page.
in_indices | Indices of the text fields to remove from the page. |
PageKit& HPS::Publish::PageKit::UnsetTextFields | ( | ) |
Removes all text fields from the page.
PageKit& HPS::Publish::PageKit::UnsetTextValueByField | ( | char const * | in_field | ) |
Removes the text value at the given form field from the page.
in_field | UTF8-encoded form field name with the text value to be removed. |
Removes the text values at the given form fields from the page.
in_count | Size of the following array. |
in_fields | Form field names with the text values to be removed. |
Removes the text values at the given form fields from the page.
in_fields | Form field names with the text values to be removed. |
PageKit& HPS::Publish::PageKit::UnsetTextValuesByField | ( | ) |
Removes all text value form fields from the page.
PageKit& HPS::Publish::PageKit::UnsetVisibilitiesByField | ( | size_t | in_count, |
UTF8 const | in_fields[] | ||
) |
Removes the visibility settings at the given form fields from the page.
in_count | Size of the following array. |
in_fields | Form field names with the visibility settings to be removed. |
Removes the visibility settings at the given form fields from the page.
in_fields | Form field names with the visibility settings to be removed. |
PageKit& HPS::Publish::PageKit::UnsetVisibilitiesByField | ( | ) |
Removes all visibility settings on form fields from the page.
PageKit& HPS::Publish::PageKit::UnsetVisibilityByField | ( | char const * | in_field | ) |
Removes the visibility setting at the given form field from the page.
in_field | UTF8-encoded form field name with the visibility setting to be removed. |
|
static |