#include <sprk_publish.h>

Public Member Functions | |
PageControl & | AddAnnotation (AnnotationKit const &in_annotation, IntRectangle const &in_location) |
PageControl & | AddAnnotations (size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]) |
PageControl & | AddAnnotations (AnnotationKitArray const &in_annotations, IntRectangleArray const &in_locations) |
PageControl & | AddButton (ButtonKit const &in_button, IntRectangle const &in_location) |
PageControl & | AddButtons (size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]) |
PageControl & | AddButtons (ButtonKitArray const &in_buttons, IntRectangleArray const &in_locations) |
PageControl & | AddCheckBox (CheckBoxKit const &in_check_box, IntRectangle const &in_location) |
PageControl & | AddCheckBoxes (size_t in_count, CheckBoxKit const in_check_boxes[], IntRectangle const in_locations[]) |
PageControl & | AddCheckBoxes (CheckBoxKitArray const &in_check_boxes, IntRectangleArray const &in_locations) |
PageControl & | AddDropDownList (DropDownListKit const &in_drop_down_list, IntRectangle const &in_location) |
PageControl & | AddDropDownLists (size_t in_count, DropDownListKit const in_drop_down_lists[], IntRectangle const in_locations[]) |
PageControl & | AddDropDownLists (DropDownListKitArray const &in_drop_down_lists, IntRectangleArray const &in_locations) |
PageControl & | AddImage (ImageKit const &in_image, IntRectangle const &in_location) |
PageControl & | AddImages (size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]) |
PageControl & | AddImages (ImageKitArray const &in_images, IntRectangleArray const &in_locations) |
PageControl & | AddLink (LinkKit const &in_link, IntRectangle const &in_location) |
PageControl & | AddLinks (size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]) |
PageControl & | AddLinks (LinkKitArray const &in_links, IntRectangleArray const &in_locations) |
PageControl & | AddListBox (ListBoxKit const &in_list_box, IntRectangle const &in_location) |
PageControl & | AddListBoxes (size_t in_count, ListBoxKit const in_list_boxes[], IntRectangle const in_locations[]) |
PageControl & | AddListBoxes (ListBoxKitArray const &in_list_boxes, IntRectangleArray const &in_locations) |
PageControl & | AddListItemByField (char const *in_field, char const *in_value, char const *in_export_value) |
PageControl & | AddListItemsByField (char const *in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]) |
PageControl & | AddListItemsByField (char const *in_field, UTF8Array const &in_values, UTF8Array const &in_export_values) |
PageControl & | AddRadioButton (RadioButtonKit const &in_radio_button, IntRectangle const &in_location) |
PageControl & | AddRadioButtons (size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]) |
PageControl & | AddRadioButtons (RadioButtonKitArray const &in_radio_buttons, IntRectangleArray const &in_locations) |
PageControl & | AddSignatureField (SignatureFieldKit const &in_signature_field, IntRectangle const &in_location) |
PageControl & | AddSignatureFields (size_t in_count, SignatureFieldKit const in_signature_fields[], IntRectangle const in_locations[]) |
PageControl & | AddSignatureFields (SignatureFieldKitArray const &in_signature_fields, IntRectangleArray const &in_locations) |
PageControl & | AddSlideTable (SlideTableKit const &in_slide_table, IntRectangle const &in_location) |
PageControl & | AddSlideTables (size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]) |
PageControl & | AddSlideTables (SlideTableKitArray const &in_slide_tables, IntRectangleArray const &in_locations) |
PageControl & | AddTable (TableKit const &in_table, IntRectangle const &in_location) |
PageControl & | AddTables (size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]) |
PageControl & | AddTables (TableKitArray const &in_tables, IntRectangleArray const &in_locations) |
PageControl & | AddText (TextKit const &in_text, IntRectangle const &in_location) |
PageControl & | AddText (size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]) |
PageControl & | AddText (TextKitArray const &in_text, IntRectangleArray const &in_locations) |
PageControl & | AddTextField (TextFieldKit const &in_text_field, IntRectangle const &in_location) |
PageControl & | AddTextFields (size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]) |
PageControl & | AddTextFields (TextFieldKitArray const &in_text_fields, IntRectangleArray const &in_locations) |
HPS::Type | ObjectType () const |
PageControl & | operator= (PageControl const &in_that) |
PageControl & | operator= (PageControl &&in_kit) |
PageControl () | |
PageControl (PageControl const &in_that) | |
PageControl (PageControl &&in_that) | |
PageControl & | SetAnnotationByField (char const *in_field, AnnotationKit const &in_annotation) |
PageControl & | SetAnnotationsByField (size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]) |
PageControl & | SetAnnotationsByField (UTF8Array const &in_fields, AnnotationKitArray const &in_annotations) |
PageControl & | SetButtonIconByField (char const *in_field, ImageKit const &in_image) |
PageControl & | SetButtonIconsByField (size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]) |
PageControl & | SetButtonIconsByField (UTF8Array const &in_fields, ImageKitArray const &in_images) |
PageControl & | SetButtonLabelByField (char const *in_field, char const *in_label) |
PageControl & | SetButtonLabelsByField (size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]) |
PageControl & | SetButtonLabelsByField (UTF8Array const &in_fields, UTF8Array const &in_labels) |
PageControl & | SetJavaScriptActionByField (char const *in_field, char const *in_source, Source::Type in_type=Source::Type::Code) |
PageControl & | SetJavaScriptActionsByField (size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]) |
PageControl & | SetJavaScriptActionsByField (UTF8Array const &in_fields, UTF8Array const &in_sources, SourceTypeArray const &in_types) |
PageControl & | SetTextValueByField (char const *in_field, char const *in_value) |
PageControl & | SetTextValuesByField (size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]) |
PageControl & | SetTextValuesByField (UTF8Array const &in_fields, UTF8Array const &in_values) |
PageControl & | SetVisibilitiesByField (size_t in_count, UTF8 const in_fields[], bool const in_states[]) |
PageControl & | SetVisibilitiesByField (UTF8Array const &in_fields, BoolArray const &in_states) |
PageControl & | SetVisibilityByField (char const *in_field, bool in_state) |
bool | ShowFields (UTF8Array &out_names, IntRectangleArray &out_locations, FieldTypeArray &out_types) const |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The PageControl class is a smart pointer to a page within a Publish PDF document. It allows direct interaction with a PDF page.
Constructor & Destructor Documentation
HPS::Publish::PageControl::PageControl | ( | ) |
The default constructor creates an uninitialized PageControl object. The Type() function will return Type::None.
HPS::Publish::PageControl::PageControl | ( | PageControl const & | in_that | ) |
The copy constructor creates a PageControl object that shares the underlying smart-pointer of the source PageControl.
- Parameters
-
in_that The source PageControl to copy.
HPS::Publish::PageControl::PageControl | ( | PageControl && | in_that | ) |
The move constructor creates a PageControl by transferring the underlying object of the rvalue reference to this PageControl.
- Parameters
-
in_kit An rvalue reference to a PageControl to take the underlying object from.
Member Function Documentation
PageControl& HPS::Publish::PageControl::AddAnnotation | ( | AnnotationKit const & | in_annotation, |
IntRectangle const & | in_location | ||
) |
Adds an annotation to the page. This will not replace any existing annotations on the page. This corresponds to the value that will be passed to A3DPDFPageInsert3DAnnot.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddAnnotations | ( | size_t | in_count, |
AnnotationKit const | in_annotations[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of annotations to the page. This will not replace any existing annotations on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddAnnotations | ( | AnnotationKitArray const & | in_annotations, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of annotations to the page. This will not replace any existing annotations on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.
- Parameters
-
in_annotations Annotations to add to the page. in_locations Annotation locations in points relative to bottom left of the page.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddButton | ( | ButtonKit const & | in_button, |
IntRectangle const & | in_location | ||
) |
Adds a button to the page. This will not replace any buttons on the page. This corresponds to the value that will be passed to A3DPDFPageInsertButton.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddButtons | ( | size_t | in_count, |
ButtonKit const | in_buttons[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of buttons to the page. This will not replace any buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddButtons | ( | ButtonKitArray const & | in_buttons, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of buttons to the page. This will not replace any buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddCheckBox | ( | CheckBoxKit const & | in_check_box, |
IntRectangle const & | in_location | ||
) |
Adds a check box to the page. This will not replace any check boxes on the page. This corresponds to the value that will be passed to A3DPDFPageInsertCheckBox.
- Parameters
-
in_check_box Check box to add to the page. in_location Check box location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddCheckBoxes | ( | size_t | in_count, |
CheckBoxKit const | in_check_boxes[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of check boxes to the page. This will not replace any check boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.
- Parameters
-
in_count Size of the following arrays. in_check_boxes Check boxes to add to the page. in_locations Check box locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddCheckBoxes | ( | CheckBoxKitArray const & | in_check_boxes, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of check boxes to the page. This will not replace any check boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.
- Parameters
-
in_check_boxes Check boxes to add to the page. in_locations Check box locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddDropDownList | ( | DropDownListKit const & | in_drop_down_list, |
IntRectangle const & | in_location | ||
) |
Adds a drop down list to the page. This will not replace any drop down lists on the page. This corresponds to the value that will be passed to A3DPDFPageInsertDropDownList.
- Parameters
-
in_drop_down_list Drop down list to add to the page. in_location Drop down list location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddDropDownLists | ( | size_t | in_count, |
DropDownListKit const | in_drop_down_lists[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of drop down lists to the page. This will not replace any drop down lists on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.
- Parameters
-
in_count Size of the following arrays. in_drop_down_lists Drop down lists to add to the page. in_locations Drop down list locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddDropDownLists | ( | DropDownListKitArray const & | in_drop_down_lists, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of drop down lists to the page. This will not replace any drop down lists on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.
- Parameters
-
in_drop_down_lists Drop down lists to add to the page. in_locations Drop down list locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddImage | ( | ImageKit const & | in_image, |
IntRectangle const & | in_location | ||
) |
Adds an image to the page. This will not replace any images on the page. This corresponds to the value that will be passed to A3DPDFPageInsertImage.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddImages | ( | size_t | in_count, |
ImageKit const | in_images[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of images to the page. This will not replace any images on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddImages | ( | ImageKitArray const & | in_images, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of images to the page. This will not replace any images on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddLink | ( | LinkKit const & | in_link, |
IntRectangle const & | in_location | ||
) |
Adds a link to the page. This will not replace any links on the page. This corresponds to the value that will be passed to A3DPDFPageInsertLink.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddLinks | ( | size_t | in_count, |
LinkKit const | in_links[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of links to the page. This will not replace any links on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddLinks | ( | LinkKitArray const & | in_links, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of links to the page. This will not replace any links on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddListBox | ( | ListBoxKit const & | in_list_box, |
IntRectangle const & | in_location | ||
) |
Adds a list box to the page. This will not replace any list boxes on the page. This corresponds to the value that will be passed to A3DPDFPageInsertListBox.
- Parameters
-
in_list_box List box to add to the page. in_location List box location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddListBoxes | ( | size_t | in_count, |
ListBoxKit const | in_list_boxes[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of list boxes to the page. This will not replace any list boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.
- Parameters
-
in_count Size of the following arrays. in_list_boxes List boxes to add to the page. in_locations List box locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddListBoxes | ( | ListBoxKitArray const & | in_list_boxes, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of list boxes to the page. This will not replace any list boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.
- Parameters
-
in_list_boxes List boxes to add to the page. in_locations List box locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddListItemByField | ( | char const * | in_field, |
char const * | in_value, | ||
char const * | in_export_value | ||
) |
Adds an item to the list at the given form field. The item to will be appended to any existing items in the list at the given form field. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddListItemsByField | ( | char const * | in_field, |
size_t | in_count, | ||
UTF8 const | in_values[], | ||
UTF8 const | in_export_values[] | ||
) |
Adds items to the list at the given form field. The items to will be appended to any existing items in the list at the given form field. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddListItemsByField | ( | char const * | in_field, |
UTF8Array const & | in_values, | ||
UTF8Array const & | in_export_values | ||
) |
Adds items to the list at the given form field. The items to will be appended to any existing items in the list at the given form field. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddRadioButton | ( | RadioButtonKit const & | in_radio_button, |
IntRectangle const & | in_location | ||
) |
Adds a radio button to the page. This will not replace any radio buttons on the page. This corresponds to the value that will be passed to A3DPDFPageInsertRadioButton.
- Parameters
-
in_radio_button Radio button to add to the page. in_location Radio button location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddRadioButtons | ( | size_t | in_count, |
RadioButtonKit const | in_radio_buttons[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of radio buttons to the page. This will not replace any radio buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.
- Parameters
-
in_count Size of the following arrays. in_radio_buttons Radio buttons to add to the page. in_locations Radio button locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddRadioButtons | ( | RadioButtonKitArray const & | in_radio_buttons, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of radio buttons to the page. This will not replace any radio buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.
- Parameters
-
in_radio_buttons Radio buttons to add to the page. in_locations Radio button locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddSignatureField | ( | SignatureFieldKit const & | in_signature_field, |
IntRectangle const & | in_location | ||
) |
Adds a signature field to the page. This will not replace any signature fields on the page. This corresponds to the value that will be passed to A3DPDFPageInsertSignatureField.
- Parameters
-
in_signature_field Signature field to add to the page. in_location Signature field location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddSignatureFields | ( | size_t | in_count, |
SignatureFieldKit const | in_signature_fields[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of signature fields to the page. This will not replace any signature fields on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.
- Parameters
-
in_count Size of the following arrays. in_signature_fields Signature fields to add to the page. in_locations Signature field locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddSignatureFields | ( | SignatureFieldKitArray const & | in_signature_fields, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of signature fields to the page. This will not replace any signature fields on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.
- Parameters
-
in_signature_fields Signature fields to add to the page. in_locations Signature field locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddSlideTable | ( | SlideTableKit const & | in_slide_table, |
IntRectangle const & | in_location | ||
) |
Adds a slide table to the page. This will not replace any slide tables on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.
- Parameters
-
in_slide_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddSlideTables | ( | size_t | in_count, |
SlideTableKit const | in_slide_tables[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddSlideTables | ( | SlideTableKitArray const & | in_slide_tables, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.
- Parameters
-
in_slide_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddTable | ( | TableKit const & | in_table, |
IntRectangle const & | in_location | ||
) |
Adds a table to the page. This will not replace any tables on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddTables | ( | size_t | in_count, |
TableKit const | in_tables[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddTables | ( | TableKitArray const & | in_tables, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddText | ( | TextKit const & | in_text, |
IntRectangle const & | in_location | ||
) |
Adds a text string to the page. This will not replace any text on the page. This corresponds to the value that will be passed to A3DPDFPageInsertText.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddText | ( | size_t | in_count, |
TextKit const | in_text[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds text strings to the page. This will not replace any text on the page. These correspond to values that will be passed to A3DPDFPageInsertText.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddText | ( | TextKitArray const & | in_text, |
IntRectangleArray const & | in_locations | ||
) |
Adds text strings to the page. This will not replace any text on the page. These correspond to values that will be passed to A3DPDFPageInsertText.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddTextField | ( | TextFieldKit const & | in_text_field, |
IntRectangle const & | in_location | ||
) |
Adds a text field to the page. This will not replace any text fields on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTextField.
- Parameters
-
in_text_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddTextFields | ( | size_t | in_count, |
TextFieldKit const | in_text_fields[], | ||
IntRectangle const | in_locations[] | ||
) |
Adds a list of text fields to the page. This will not replace any text fields on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::AddTextFields | ( | TextFieldKitArray const & | in_text_fields, |
IntRectangleArray const & | in_locations | ||
) |
Adds a list of text fields to the page. This will not replace any text fields on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.
- Parameters
-
in_text_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.
- Returns
- A reference to this PageControl.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
PageControl& HPS::Publish::PageControl::operator= | ( | PageControl const & | in_that | ) |
Share the underlying smart-pointer of the PageControl source.
- Parameters
-
in_that The PageControl source of the assignment.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::operator= | ( | PageControl && | in_kit | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this PageControl.
- Parameters
-
in_kit An rvalue reference to a PageControl to take the underlying object from.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetAnnotationByField | ( | char const * | in_field, |
AnnotationKit const & | in_annotation | ||
) |
Sets an annotation on the given form field. If there is an existing annotation on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_field UTF8-encoded form field name for the annotation. in_annotation The annotation to be set on the given form field.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetAnnotationsByField | ( | size_t | in_count, |
UTF8 const | in_fields[], | ||
AnnotationKit const | in_annotations[] | ||
) |
Sets annotations on the given form fields. If there is an existing annotation on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetAnnotationsByField | ( | UTF8Array const & | in_fields, |
AnnotationKitArray const & | in_annotations | ||
) |
Sets annotations on the given form fields. If there is an existing annotation on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_fields The form field names for the annotations. in_annotations The annotations to be set on the corresponding form fields.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetButtonIconByField | ( | char const * | in_field, |
ImageKit const & | in_image | ||
) |
Sets an image on the icon at the given form field. If there is an existing image on an icon at the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_field UTF8-encoded form field name for the icon. in_image The image to be set on the icon at the given form field.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetButtonIconsByField | ( | size_t | in_count, |
UTF8 const | in_fields[], | ||
ImageKit const | in_images[] | ||
) |
Sets images on the icons at the given form fields. If there is an existing image on an icon at a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetButtonIconsByField | ( | UTF8Array const & | in_fields, |
ImageKitArray const & | in_images | ||
) |
Sets images on the icons at the given form fields. If there is an existing image on an icon at a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_fields The form field names for the icons. in_images The images to be set on the icons at the corresponding form fields.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetButtonLabelByField | ( | char const * | in_field, |
char const * | in_label | ||
) |
Sets a label on the given form field. If there is an existing label on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_field UTF8-encoded form field name for the label. in_label UTF8-encoded label to be set on the given form field.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetButtonLabelsByField | ( | size_t | in_count, |
UTF8 const | in_fields[], | ||
UTF8 const | in_labels[] | ||
) |
Sets labels on the given form fields. If there is an existing label on a given form field, it will get overwritten. These correspond to the values that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetButtonLabelsByField | ( | UTF8Array const & | in_fields, |
UTF8Array const & | in_labels | ||
) |
Sets labels on the given form fields. If there is an existing label on a given form field, it will get overwritten. These correspond to the values that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_fields The form field names for the labels. in_labels The labels to be set on the corresponding form fields.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetJavaScriptActionByField | ( | char const * | in_field, |
char const * | in_source, | ||
Source::Type | in_type = Source::Type::Code |
||
) |
Sets a JavaScript source or file on the given form field. If there is any existing JavaScript source or file at the given form field, it will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetJavaScriptActionsByField | ( | size_t | in_count, |
UTF8 const | in_fields[], | ||
UTF8 const | in_sources[], | ||
Source::Type const | in_types[] | ||
) |
Sets JavaScript sources and/or files on the given form fields. If there is any existing JavaScript source or file at a given form field, it will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetJavaScriptActionsByField | ( | UTF8Array const & | in_fields, |
UTF8Array const & | in_sources, | ||
SourceTypeArray const & | in_types | ||
) |
Sets JavaScript sources and/or files on the given form fields. If there is any existing JavaScript source or file at a given form field, it will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetTextValueByField | ( | char const * | in_field, |
char const * | in_value | ||
) |
Sets a text value on the given form field. If there is an existing text value on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_field UTF8-encoded form field name for the text value. in_value UTF8-encoded text value to be set on the given form field.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetTextValuesByField | ( | size_t | in_count, |
UTF8 const | in_fields[], | ||
UTF8 const | in_values[] | ||
) |
Sets text values on the given form fields. If there is an existing text value on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetTextValuesByField | ( | UTF8Array const & | in_fields, |
UTF8Array const & | in_values | ||
) |
Sets text values on the given form fields. If there is an existing text value on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_fields The form field names for the text values. in_values The text values to be set on the corresponding form fields.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetVisibilitiesByField | ( | size_t | in_count, |
UTF8 const | in_fields[], | ||
bool const | in_states[] | ||
) |
Sets whether the objects at the given form fields should be visible. If there is an existing visibility on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetVisibilitiesByField | ( | UTF8Array const & | in_fields, |
BoolArray const & | in_states | ||
) |
Sets whether the objects at the given form fields should be visible. If there is an existing visibility on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
PageControl& HPS::Publish::PageControl::SetVisibilityByField | ( | char const * | in_field, |
bool | in_state | ||
) |
Sets whether the object at the given form field should be visible. If there is an existing visibility on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.
- Parameters
-
in_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.
- Returns
- A reference to this PageControl.
bool HPS::Publish::PageControl::ShowFields | ( | UTF8Array & | out_names, |
IntRectangleArray & | out_locations, | ||
FieldTypeArray & | out_types | ||
) | const |
Shows the PDF form fields on the page associated with this PageControl.
- Parameters
-
out_names The names of the PDF form fields on the associated page. out_locations The locations of the PDF form fields on the associated page. out_types The types of the PDF form fields on the associated page.
- Returns
- true if there are any PDF form fields on the associated page, false otherwise.
The documentation for this class was generated from the following file:
- include/sprk_publish.h