10 #ifndef SPRK_PUBLISH_H
11 #define SPRK_PUBLISH_H
15 typedef void A3DEntity;
20 # define PUBLISH_API __declspec (dllexport)
22 # define PUBLISH_API __declspec (dllimport)
27 # if defined(SPROCKETS) and defined(LINUX_SYSTEM)
29 # define PUBLISH_API __attribute__ ((visibility ("default")))
66 typedef std::vector<PageKit, HPS::Allocator<PageKit>> PageKitArray;
67 typedef std::vector<AnnotationKit, HPS::Allocator<AnnotationKit>> AnnotationKitArray;
68 typedef std::vector<ViewKit, HPS::Allocator<ViewKit>> ViewKitArray;
69 typedef std::vector<TextKit, HPS::Allocator<TextKit>> TextKitArray;
70 typedef std::vector<ImageKit, HPS::Allocator<ImageKit>> ImageKitArray;
71 typedef std::vector<TableKit, HPS::Allocator<TableKit>> TableKitArray;
72 typedef std::vector<LinkKit, HPS::Allocator<LinkKit>> LinkKitArray;
73 typedef std::vector<ButtonKit, HPS::Allocator<ButtonKit>> ButtonKitArray;
74 typedef std::vector<CheckBoxKit, HPS::Allocator<CheckBoxKit>> CheckBoxKitArray;
75 typedef std::vector<RadioButtonKit, HPS::Allocator<RadioButtonKit>> RadioButtonKitArray;
76 typedef std::vector<ListBoxKit, HPS::Allocator<ListBoxKit>> ListBoxKitArray;
77 typedef std::vector<DropDownListKit, HPS::Allocator<DropDownListKit>> DropDownListKitArray;
78 typedef std::vector<SignatureFieldKit, HPS::Allocator<SignatureFieldKit>> SignatureFieldKitArray;
79 typedef std::vector<TextFieldKit, HPS::Allocator<TextFieldKit>> TextFieldKitArray;
80 typedef std::vector<SlideTableKit, HPS::Allocator<SlideTableKit>> SlideTableKitArray;
101 typedef std::vector<Source::Type, HPS::Allocator<Source::Type> > SourceTypeArray;
291 TransparentWireframe,
292 TransparentBoundingBox,
293 TransparentBoundingBoxOutline,
335 HelveticaBoldOblique,
380 CounterClockwise90Degrees,
381 CounterClockwise180Degrees,
382 CounterClockwise270Degrees,
448 typedef std::vector<Field::Type, Allocator<Field::Type>> FieldTypeArray;
592 typedef std::vector<Permission::Type, HPS::Allocator<Permission::Type> > PermissionTypeArray;
612 HPS::Type
ObjectType()
const {
return HPS::Type::PublishDocumentKit; }
666 DocumentKit & SetInformation(
char const * in_title,
char const * in_author,
char const * in_subject,
char const * in_creator);
672 DocumentKit & SetPasswords(
char const * in_user_password,
char const * in_owner_password);
679 DocumentKit & AddJavaScript(
char const * in_script_name,
char const * in_source,
Source::Type in_type = Source::Type::Code);
694 DocumentKit & AddJavaScript(UTF8Array
const & in_script_names, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
700 DocumentKit & AddAttachment(
char const * in_filename,
char const * in_description);
707 DocumentKit & AddAttachments(
size_t in_count,
UTF8 const in_filenames[],
UTF8 const in_descriptions[]);
713 DocumentKit & AddAttachments(UTF8Array
const & in_filenames, UTF8Array
const & in_descriptions);
732 DocumentKit & AddIconImages(UTF8Array
const & in_names, ImageKitArray
const & in_images);
757 DocumentKit & SetPages(PageKitArray
const & in_pages);
770 DocumentKit & AddPages(PageKitArray
const & in_pages);
781 DocumentKit & SetPermissions(PermissionTypeArray
const & in_permissions);
795 DocumentKit & UnsetJavaScript(
char const * in_script_name);
801 DocumentKit & UnsetJavaScript(
size_t in_count,
UTF8 const in_script_names[]);
806 DocumentKit & UnsetJavaScript(UTF8Array
const & in_script_names);
815 DocumentKit & UnsetAttachment(
char const * in_filename);
821 DocumentKit & UnsetAttachments(
size_t in_count,
UTF8 const in_filenames[]);
826 DocumentKit & UnsetAttachments(UTF8Array
const & in_filenames);
835 DocumentKit & UnsetIconImage(
char const * in_name);
846 DocumentKit & UnsetIconImages(UTF8Array
const & in_names);
861 DocumentKit & UnsetPages(
size_t in_count,
size_t const in_indices[]);
866 DocumentKit & UnsetPages(SizeTArray
const & in_indices);
887 bool ShowInformation(
UTF8 & out_title,
UTF8 & out_author,
UTF8 & out_subject,
UTF8 & out_creator)
const;
893 bool ShowPasswords(
UTF8 & out_user_password,
UTF8 & out_owner_password)
const;
901 bool ShowJavaScript(UTF8Array & out_script_names, UTF8Array & out_sources, SourceTypeArray & out_types)
const;
907 bool ShowAttachments(UTF8Array & out_filenames, UTF8Array & out_descriptions)
const;
913 bool ShowIconImages(UTF8Array & out_names, ImageKitArray & out_images)
const;
918 bool ShowPages(PageKitArray & out_pages)
const;
923 bool ShowPermissions(PermissionTypeArray & out_permissions)
const;
940 PageKit(
char const * in_filename);
952 HPS::Type
ObjectType()
const {
return HPS::Type::PublishPageKit; }
961 void Set(
PageKit const & in_kit);
965 void Show(
PageKit & out_kit)
const;
984 bool Equals(
PageKit const & in_kit)
const;
989 bool operator==(
PageKit const & in_kit)
const;
994 bool operator!=(
PageKit const & in_kit)
const;
1032 PageKit & SetAnnotations(AnnotationKitArray
const & in_annotations, IntRectangleArray
const & in_locations);
1045 PageKit & AddAnnotations(AnnotationKitArray
const & in_annotations, IntRectangleArray
const & in_locations);
1070 PageKit & SetText(TextKitArray
const & in_text, IntRectangleArray
const & in_locations);
1083 PageKit & AddText(TextKitArray
const & in_text, IntRectangleArray
const & in_locations);
1108 PageKit & SetImages(ImageKitArray
const & in_images, IntRectangleArray
const & in_locations);
1121 PageKit & AddImages(ImageKitArray
const & in_images, IntRectangleArray
const & in_locations);
1146 PageKit & SetTables(TableKitArray
const & in_tables, IntRectangleArray
const & in_locations);
1159 PageKit & AddTables(TableKitArray
const & in_tables, IntRectangleArray
const & in_locations);
1184 PageKit & SetLinks(LinkKitArray
const & in_links, IntRectangleArray
const & in_locations);
1197 PageKit & AddLinks(LinkKitArray
const & in_links, IntRectangleArray
const & in_locations);
1222 PageKit & SetButtons(ButtonKitArray
const & in_buttons, IntRectangleArray
const & in_locations);
1235 PageKit & AddButtons(ButtonKitArray
const & in_buttons, IntRectangleArray
const & in_locations);
1260 PageKit & SetTextFields(TextFieldKitArray
const & in_text_fields, IntRectangleArray
const & in_locations);
1273 PageKit & AddTextFields(TextFieldKitArray
const & in_text_fields, IntRectangleArray
const & in_locations);
1298 PageKit & SetSlideTables(SlideTableKitArray
const & in_slide_tables, IntRectangleArray
const & in_locations);
1311 PageKit & AddSlideTables(SlideTableKitArray
const & in_slide_tables, IntRectangleArray
const & in_locations);
1336 PageKit & SetCheckBoxes(CheckBoxKitArray
const & in_checkbox, IntRectangleArray
const & in_locations);
1349 PageKit & AddCheckBoxes(CheckBoxKitArray
const & in_checkbox, IntRectangleArray
const & in_locations);
1374 PageKit & SetRadioButtons(RadioButtonKitArray
const & in_radio_buttons, IntRectangleArray
const & in_locations);
1387 PageKit & AddRadioButtons(RadioButtonKitArray
const & in_radio_buttons, IntRectangleArray
const & in_locations);
1412 PageKit & SetListBoxes(ListBoxKitArray
const & in_list_box, IntRectangleArray
const & in_locations);
1425 PageKit & AddListBoxes(ListBoxKitArray
const & in_list_box, IntRectangleArray
const & in_locations);
1450 PageKit & SetDropDownLists(DropDownListKitArray
const & in_drop_down_list, IntRectangleArray
const & in_locations);
1463 PageKit & AddDropDownLists(DropDownListKitArray
const & in_drop_down_list, IntRectangleArray
const & in_locations);
1488 PageKit & SetSignatureFields(SignatureFieldKitArray
const & in_signature_field, IntRectangleArray
const & in_locations);
1501 PageKit & AddSignatureFields(SignatureFieldKitArray
const & in_signature_field, IntRectangleArray
const & in_locations);
1506 PageKit & SetTemplateFile(
char const * in_filename);
1528 PageKit & SetAnnotationsByField(UTF8Array
const & in_fields, AnnotationKitArray
const & in_annotations);
1535 PageKit & SetButtonIconByField(
char const * in_field,
ImageKit const & in_image);
1543 PageKit & SetButtonIconsByField(
size_t in_count,
UTF8 const in_fields[],
ImageKit const in_images[]);
1550 PageKit & SetButtonIconsByField(UTF8Array
const & in_fields, ImageKitArray
const & in_images);
1557 PageKit & SetButtonLabelByField(
char const * in_field,
char const * in_label);
1565 PageKit & SetButtonLabelsByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_labels[]);
1572 PageKit & SetButtonLabelsByField(UTF8Array
const & in_fields, UTF8Array
const & in_labels);
1580 PageKit & SetListItemByField(
char const * in_field,
char const * in_value,
char const * in_export_value);
1588 PageKit & AddListItemByField(
char const * in_field,
char const * in_value,
char const * in_export_value);
1597 PageKit & SetListItemsByField(
char const * in_field,
size_t in_count,
UTF8 const in_values[],
UTF8 const in_export_values[]);
1605 PageKit & SetListItemsByField(
char const * in_field, UTF8Array
const & in_values, UTF8Array
const & in_export_values);
1614 PageKit & AddListItemsByField(
char const * in_field,
size_t in_count,
UTF8 const in_values[],
UTF8 const in_export_values[]);
1622 PageKit & AddListItemsByField(
char const * in_field, UTF8Array
const & in_values, UTF8Array
const & in_export_values);
1631 PageKit & SetJavaScriptActionByField(
char const * in_field,
char const * in_source,
Source::Type in_type = Source::Type::Code);
1641 PageKit & SetJavaScriptActionsByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_sources[],
Source::Type const in_types[]);
1650 PageKit & SetJavaScriptActionsByField(UTF8Array
const & in_fields, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
1657 PageKit & SetVisibilityByField(
char const * in_field,
bool in_state);
1665 PageKit & SetVisibilitiesByField(
size_t in_count,
UTF8 const in_fields[],
bool const in_states[]);
1672 PageKit & SetVisibilitiesByField(UTF8Array
const & in_fields, BoolArray
const & in_states);
1679 PageKit & SetTextValueByField(
char const * in_field,
char const * in_value);
1687 PageKit & SetTextValuesByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_values[]);
1694 PageKit & SetTextValuesByField(UTF8Array
const & in_fields, UTF8Array
const & in_values);
1708 PageKit & UnsetAnnotation(
size_t in_index);
1714 PageKit & UnsetAnnotations(
size_t in_count,
size_t const in_indices[]);
1719 PageKit & UnsetAnnotations(SizeTArray
const & in_indices);
1728 PageKit & UnsetText(
size_t in_index);
1734 PageKit & UnsetText(
size_t in_count,
size_t const in_indices[]);
1739 PageKit & UnsetText(SizeTArray
const & in_indices);
1748 PageKit & UnsetCheckBox(
size_t in_index);
1754 PageKit & UnsetCheckBoxes(
size_t in_count,
size_t const in_indices[]);
1759 PageKit & UnsetCheckBoxes(SizeTArray
const & in_indices);
1768 PageKit & UnsetRadioButton(
size_t in_index);
1774 PageKit & UnsetRadioButtons(
size_t in_count,
size_t const in_indices[]);
1779 PageKit & UnsetRadioButtons(SizeTArray
const & in_indices);
1783 PageKit & UnsetRadioButtons();
1788 PageKit & UnsetListBox(
size_t in_index);
1794 PageKit & UnsetListBoxes(
size_t in_count,
size_t const in_indices[]);
1799 PageKit & UnsetListBoxes(SizeTArray
const & in_indices);
1808 PageKit & UnsetDropDownList(
size_t in_index);
1814 PageKit & UnsetDropDownLists(
size_t in_count,
size_t const in_indices[]);
1819 PageKit & UnsetDropDownLists(SizeTArray
const & in_indices);
1823 PageKit & UnsetDropDownLists();
1828 PageKit & UnsetSignatureField(
size_t in_index);
1834 PageKit & UnsetSignatureFields(
size_t in_count,
size_t const in_indices[]);
1839 PageKit & UnsetSignatureFields(SizeTArray
const & in_indices);
1843 PageKit & UnsetSignatureFields();
1848 PageKit & UnsetImage(
size_t in_index);
1854 PageKit & UnsetImages(
size_t in_count,
size_t const in_indices[]);
1859 PageKit & UnsetImages(SizeTArray
const & in_indices);
1868 PageKit & UnsetTable(
size_t in_index);
1874 PageKit & UnsetTables(
size_t in_count,
size_t const in_indices[]);
1879 PageKit & UnsetTables(SizeTArray
const & in_indices);
1888 PageKit & UnsetLink(
size_t in_index);
1894 PageKit & UnsetLinks(
size_t in_count,
size_t const in_indices[]);
1899 PageKit & UnsetLinks(SizeTArray
const & in_indices);
1908 PageKit & UnsetButton(
size_t in_index);
1914 PageKit & UnsetButtons(
size_t in_count,
size_t const in_indices[]);
1919 PageKit & UnsetButtons(SizeTArray
const & in_indices);
1928 PageKit & UnsetTextField(
size_t in_index);
1934 PageKit & UnsetTextFields(
size_t in_count,
size_t const in_indices[]);
1939 PageKit & UnsetTextFields(SizeTArray
const & in_indices);
1948 PageKit & UnsetSlideTable(
size_t in_index);
1954 PageKit & UnsetSlideTables(
size_t in_count,
size_t const in_indices[]);
1959 PageKit & UnsetSlideTables(SizeTArray
const & in_indices);
1967 PageKit & UnsetTemplateFile();
1972 PageKit & UnsetAnnotationByField(
char const * in_field);
1978 PageKit & UnsetAnnotationsByField(
size_t in_count,
UTF8 const in_fields[]);
1983 PageKit & UnsetAnnotationsByField(UTF8Array
const & in_fields);
1987 PageKit & UnsetAnnotationsByField();
1992 PageKit & UnsetButtonIconByField(
char const * in_field);
1998 PageKit & UnsetButtonIconsByField(
size_t in_count,
UTF8 const in_fields[]);
2003 PageKit & UnsetButtonIconsByField(UTF8Array
const & in_fields);
2007 PageKit & UnsetButtonIconsByField();
2012 PageKit & UnsetButtonLabelByField(
char const * in_field);
2018 PageKit & UnsetButtonLabelsByField(
size_t in_count,
UTF8 const in_fields[]);
2023 PageKit & UnsetButtonLabelsByField(UTF8Array
const & in_fields);
2027 PageKit & UnsetButtonLabelsByField();
2033 PageKit & UnsetListItemByField(
char const * in_field,
size_t in_index);
2040 PageKit & UnsetListItemsByField(
char const * in_field,
size_t in_count,
size_t const in_indices[]);
2046 PageKit & UnsetListItemsByField(
char const * in_field, SizeTArray
const & in_indices);
2051 PageKit & UnsetListItemsByField(
char const * in_field);
2057 PageKit & UnsetListItemsByField(
size_t in_count,
UTF8 const in_fields[]);
2062 PageKit & UnsetListItemsByField(UTF8Array
const & in_fields);
2066 PageKit & UnsetListItemsByField();
2071 PageKit & UnsetJavaScriptActionByField(
char const * in_field);
2077 PageKit & UnsetJavaScriptActionsByField(
size_t in_count,
UTF8 const in_fields[]);
2082 PageKit & UnsetJavaScriptActionsByField(UTF8Array
const & in_fields);
2086 PageKit & UnsetJavaScriptActionsByField();
2091 PageKit & UnsetVisibilityByField(
char const * in_field);
2097 PageKit & UnsetVisibilitiesByField(
size_t in_count,
UTF8 const in_fields[]);
2102 PageKit & UnsetVisibilitiesByField(UTF8Array
const & in_fields);
2106 PageKit & UnsetVisibilitiesByField();
2111 PageKit & UnsetTextValueByField(
char const * in_field);
2117 PageKit & UnsetTextValuesByField(
size_t in_count,
UTF8 const in_fields[]);
2122 PageKit & UnsetTextValuesByField(UTF8Array
const & in_fields);
2126 PageKit & UnsetTextValuesByField();
2147 bool ShowAnnotations(AnnotationKitArray & out_annotations, IntRectangleArray & out_locations)
const;
2153 bool ShowText(TextKitArray & out_text, IntRectangleArray & out_locations)
const;
2159 bool ShowImages(ImageKitArray & out_images, IntRectangleArray & out_locations)
const;
2165 bool ShowTables(TableKitArray & out_tables, IntRectangleArray & out_locations)
const;
2171 bool ShowLinks(LinkKitArray & out_links, IntRectangleArray & out_locations)
const;
2177 bool ShowButtons(ButtonKitArray & out_buttons, IntRectangleArray & out_locations)
const;
2183 bool ShowCheckBoxes(CheckBoxKitArray & out_check_boxes, IntRectangleArray & out_locations)
const;
2189 bool ShowRadioButtons(RadioButtonKitArray & out_radio_buttons, IntRectangleArray & out_locations)
const;
2195 bool ShowListBoxes(ListBoxKitArray & out_list_boxes, IntRectangleArray & out_locations)
const;
2201 bool ShowDropDownLists(DropDownListKitArray & out_drop_down_lists, IntRectangleArray & out_locations)
const;
2207 bool ShowSignatureFields(SignatureFieldKitArray & out_signature_fields, IntRectangleArray & out_locations)
const;
2213 bool ShowTextFields(TextFieldKitArray & out_text_fields, IntRectangleArray & out_locations)
const;
2219 bool ShowSlideTables(SlideTableKitArray & out_slide_tables, IntRectangleArray & out_locations)
const;
2224 bool ShowTemplateFile(
UTF8 & out_filename)
const;
2230 bool ShowAnnotationsByField(UTF8Array & out_fields, AnnotationKitArray & out_annotations)
const;
2236 bool ShowButtonIconsByField(UTF8Array & out_fields, ImageKitArray & out_images)
const;
2242 bool ShowButtonLabelsByField(UTF8Array & out_fields, UTF8Array & out_labels)
const;
2247 bool ShowListItemFields(UTF8Array & out_fields)
const;
2254 bool ShowListItemsByField(
char const * in_field, UTF8Array & out_values, UTF8Array & out_export_values)
const;
2261 bool ShowJavaScriptActionsByField(UTF8Array & out_fields, UTF8Array & out_sources, SourceTypeArray & out_types)
const;
2267 bool ShowVisibilitiesByField(UTF8Array & out_fields, BoolArray & out_states)
const;
2273 bool ShowTextValuesByField(UTF8Array & out_fields, UTF8Array & out_values)
const;
2297 HPS::Type
ObjectType()
const {
return HPS::Type::PublishAnnotationKit; }
2372 AnnotationKit & SetPRCTessellationCompression(
bool in_state);
2477 AnnotationKit & SetCarouselButtons(
size_t in_count,
UTF8 const in_button_names[],
char const * in_previous_button_name,
char const * in_next_button_name,
size_t in_scroll_size);
2485 AnnotationKit & SetCarouselButtons(UTF8Array
const & in_button_names,
char const * in_previous_button_name,
char const * in_next_button_name,
size_t in_scroll_size);
2494 AnnotationKit & SetCarouselViews(
size_t in_count,
size_t const in_indices[],
ImageKit const in_images[] =
nullptr);
2502 AnnotationKit & SetCarouselViews(SizeTArray
const & in_indices, ImageKitArray
const & in_images = ImageKitArray());
2617 bool ShowPRCTessellationCompression(
bool & out_state)
const;
2627 bool ShowPRCBRepRemoval(
bool & out_state)
const;
2632 bool ShowPRCAttributeRemoval(
bool & out_state)
const;
2642 bool ShowU3DCompression(
unsigned char & out_level)
const;
2647 bool ShowName(
UTF8 & out_name)
const;
2652 bool ShowArtwork(
ArtworkKit & out_artwork)
const;
2667 bool ShowToolbarVisibility(
bool & out_state)
const;
2672 bool ShowModelTreeVisibility(
bool & out_state)
const;
2677 bool ShowInteractivity(
bool & out_state)
const;
2682 bool ShowBorderWidth(
int & out_width)
const;
2687 bool ShowTransparentBackground(
bool & out_state)
const;
2692 bool ShowBackgroundColor(
RGBColor & out_color)
const;
2707 bool ShowPosterImage(
ImageKit & out_image)
const;
2715 bool ShowCarouselButtons(UTF8Array & out_button_names,
UTF8 & out_previous_button_name,
UTF8 & out_next_button_name,
size_t & out_scroll_size)
const;
2721 bool ShowCarouselViews(SizeTArray & out_indices, ImageKitArray & out_images)
const;
2741 HPS::Type
ObjectType()
const {
return HPS::Type::PublishArtworkKit; }
2773 bool Equals(
ArtworkKit const & in_kit)
const;
2778 bool operator==(
ArtworkKit const & in_kit)
const;
2783 bool operator!=(
ArtworkKit const & in_kit)
const;
2800 ArtworkKit & SetPMICrossHighlighting(
bool in_state);
2805 ArtworkKit & SetPMISemanticInformation(
bool in_state);
2836 ArtworkKit & SetViews(ViewKitArray
const & in_views);
2847 ArtworkKit & AddViews(ViewKitArray
const & in_views);
2888 ArtworkKit & UnsetViews(
size_t in_count,
size_t const in_indices[]);
2893 ArtworkKit & UnsetViews(SizeTArray
const & in_indices);
2922 bool ShowPMICrossHighlighting(
bool & out_state)
const;
2927 bool ShowPMISemanticInformation(
bool & out_state)
const;
2942 bool ShowViews(ViewKitArray & out_views)
const;
2967 HPS::Type
ObjectType()
const {
return HPS::Type::PublishViewKit; }
2976 void Set(
ViewKit const & in_kit);
2980 void Show(
ViewKit & out_kit)
const;
2999 bool Equals(
ViewKit const & in_kit)
const;
3004 bool operator==(
ViewKit const & in_kit)
const;
3009 bool operator!=(
ViewKit const & in_kit)
const;
3015 ViewKit & SetInternalName(
char const * in_name);
3020 ViewKit & SetExternalName(
char const * in_name);
3035 ViewKit & SetDefault(
bool in_state);
3055 ViewKit & UnsetInternalName();
3059 ViewKit & UnsetExternalName();
3071 ViewKit & UnsetBackgroundColor();
3089 bool ShowInternalName(
UTF8 & out_name)
const;
3094 bool ShowExternalName(
UTF8 & out_name)
const;
3099 bool ShowCamera(
CameraKit & out_camera)
const;
3104 bool ShowDefault(
bool & out_state)
const;
3109 bool ShowBackgroundColor(
RGBColor & out_color)
const;
3139 HPS::Type
ObjectType()
const {
return HPS::Type::PublishTextKit; }
3148 void Set(
TextKit const & in_kit);
3152 void Show(
TextKit & out_kit)
const;
3171 bool Equals(
TextKit const & in_kit)
const;
3176 bool operator==(
TextKit const & in_kit)
const;
3181 bool operator!=(
TextKit const & in_kit)
const;
3188 TextKit & SetText(
char const * in_text);
3206 TextKit & SetSize(
int in_size);
3239 bool ShowText(
UTF8 & out_text)
const;
3253 bool ShowSize(
int & out_size)
const;
3258 bool ShowColor(
RGBColor & out_color)
const;
3278 HPS::Type
ObjectType()
const {
return HPS::Type::PublishImageKit; }
3288 void Show(
ImageKit & out_kit)
const;
3307 bool Equals(
ImageKit const & in_kit)
const;
3312 bool operator==(
ImageKit const & in_kit)
const;
3317 bool operator!=(
ImageKit const & in_kit)
const;
3323 ImageKit & SetFile(
char const * in_filename);
3330 ImageKit & SetSize(
int in_width,
int in_height);
3358 bool ShowFile(
UTF8 & out_filename)
const;
3364 bool ShowSize(
int & out_width,
int & out_height)
const;
3390 HPS::Type
ObjectType()
const {
return HPS::Type::PublishTableKit; }
3400 void Show(
TableKit & out_kit)
const;
3419 bool Equals(
TableKit const & in_kit)
const;
3424 bool operator==(
TableKit const & in_kit)
const;
3429 bool operator!=(
TableKit const & in_kit)
const;
3449 TableKit & SetLink(
int in_row,
int in_column,
LinkKit const & in_link);
3456 TableKit & SetText(
int in_row,
int in_column,
TextKit const & in_text);
3483 TableKit & UnsetLink(
int in_row,
int in_column);
3487 TableKit & UnsetText(
int in_row,
int in_column);
3491 TableKit & UnsetButton(
int in_row,
int in_column);
3495 TableKit & UnsetTextField(
int in_row,
int in_column);
3519 bool ShowLink(
int in_row,
int in_column,
LinkKit & out_link)
const;
3526 bool ShowText(
int in_row,
int in_column,
TextKit & out_text)
const;
3533 bool ShowButton(
int in_row,
int in_column,
ButtonKit & out_button)
const;
3540 bool ShowTextField(
int in_row,
int in_column,
TextFieldKit & out_text_field)
const;
3561 HPS::Type
ObjectType()
const {
return HPS::Type::PublishSlideTableKit; }
3619 SlideTableKit & SetButtons(
char const * in_previous_button_name,
char const * in_next_button_name);
3633 SlideTableKit & SetText(
size_t in_rows,
size_t in_columns, TextFieldKitArray
const & in_text);
3682 bool ShowButtons(
UTF8 & out_previous_button_name,
UTF8 & out_next_button_name)
const;
3689 bool ShowText(
size_t & out_rows,
size_t & out_columns, TextFieldKitArray & out_text)
const;
3694 bool ShowHeader(
bool & out_state)
const;
3714 HPS::Type
ObjectType()
const {
return HPS::Type::PublishLinkKit; }
3720 void Set(
LinkKit const & in_kit);
3724 void Show(
LinkKit & out_kit)
const;
3743 bool Equals(
LinkKit const & in_kit)
const;
3748 bool operator==(
LinkKit const & in_kit)
const;
3753 bool operator!=(
LinkKit const & in_kit)
const;
3760 LinkKit & SetJavaScript(
char const * in_source,
Source::Type in_type = Source::Type::Code);
3765 LinkKit & SetBorderWidth(
int in_width);
3788 LinkKit & UnsetHighlighting();
3808 bool ShowBorderWidth(
int & out_width)
const;
3818 bool ShowBorderColor(
RGBColor & out_color)
const;
3838 HPS::Type
ObjectType()
const {
return HPS::Type::PublishButtonKit; }
3870 bool Equals(
ButtonKit const & in_kit)
const;
3875 bool operator==(
ButtonKit const & in_kit)
const;
3880 bool operator!=(
ButtonKit const & in_kit)
const;
3886 ButtonKit & SetName(
char const * in_name);
3891 ButtonKit & SetLabel(
char const * in_label);
3917 ButtonKit & SetTooltip(
char const * in_tooltip);
3922 ButtonKit & SetVisibility(
bool in_state);
3927 ButtonKit & SetPrintability(
bool in_state);
4061 bool ShowName(
UTF8 & out_name)
const;
4066 bool ShowLabel(
UTF8 & out_label)
const;
4079 bool ShowFontSize(
int & out_size)
const;
4084 bool ShowTextColor(
RGBColor & out_color)
const;
4089 bool ShowTooltip(
UTF8 & out_tooltip)
const;
4094 bool ShowVisibility(
bool & out_state)
const;
4099 bool ShowPrintability(
bool & out_state)
const;
4109 bool ShowLock(
bool & out_state)
const;
4114 bool ShowBorder(
bool & out_state)
const;
4119 bool ShowBorderColor(
RGBColor & out_color)
const;
4134 bool ShowFillColor(
RGBColor & out_color)
const;
4149 bool ShowIconImage(
ImageKit & out_image)
const;
4169 HPS::Type
ObjectType()
const {
return HPS::Type::PublishCheckBoxKit; }
4206 bool operator==(
CheckBoxKit const & in_kit)
const;
4211 bool operator!=(
CheckBoxKit const & in_kit)
const;
4243 CheckBoxKit & SetTooltip(
char const * in_tooltip);
4294 CheckBoxKit & SetExportValue(
char const * in_export_value);
4374 bool ShowName(
UTF8 & out_name)
const;
4387 bool ShowFontSize(
int & out_size)
const;
4392 bool ShowTextColor(
RGBColor & out_color)
const;
4397 bool ShowTooltip(
UTF8 & out_tooltip)
const;
4402 bool ShowVisibility(
bool & out_state)
const;
4407 bool ShowPrintability(
bool & out_state)
const;
4417 bool ShowLock(
bool & out_state)
const;
4422 bool ShowBorder(
bool & out_state)
const;
4427 bool ShowBorderColor(
RGBColor & out_color)
const;
4442 bool ShowFillColor(
RGBColor & out_color)
const;
4447 bool ShowExportValue(
UTF8 & out_export_value)
const;
4452 bool ShowDefaultState(
bool & out_default_state)
const;
4472 HPS::Type
ObjectType()
const {
return HPS::Type::PublishRadioButtonKit; }
4686 bool ShowName(
UTF8 & out_name)
const;
4699 bool ShowFontSize(
int & out_size)
const;
4704 bool ShowTextColor(
RGBColor & out_color)
const;
4709 bool ShowTooltip(
UTF8 & out_tooltip)
const;
4714 bool ShowVisibility(
bool & out_state)
const;
4719 bool ShowPrintability(
bool & out_state)
const;
4729 bool ShowLock(
bool & out_state)
const;
4734 bool ShowBorder(
bool & out_state)
const;
4739 bool ShowBorderColor(
RGBColor & out_color)
const;
4754 bool ShowFillColor(
RGBColor & out_color)
const;
4759 bool ShowExportValue(
UTF8 & out_export_value)
const;
4764 bool ShowDefaultState(
bool & out_default_state)
const;
4769 bool ShowGrouping(
bool & out_grouping)
const;
4789 HPS::Type
ObjectType()
const {
return HPS::Type::PublishListBoxKit; }
4821 bool Equals(
ListBoxKit const & in_kit)
const;
4826 bool operator==(
ListBoxKit const & in_kit)
const;
4831 bool operator!=(
ListBoxKit const & in_kit)
const;
4863 ListBoxKit & SetTooltip(
char const * in_tooltip);
4914 ListBoxKit & SetMultipleSelection(
bool in_state);
4921 ListBoxKit & SetContents(UTF8Array
const & in_displayed_values, UTF8Array
const & in_export_values);
4928 ListBoxKit & SetContents(
size_t in_count,
UTF8 const in_displayed_values[],
UTF8 const in_export_values[]);
5003 bool ShowName(
UTF8 & out_name)
const;
5016 bool ShowFontSize(
int & out_size)
const;
5021 bool ShowTextColor(
RGBColor & out_color)
const;
5026 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5031 bool ShowVisibility(
bool & out_state)
const;
5036 bool ShowPrintability(
bool & out_state)
const;
5046 bool ShowLock(
bool & out_state)
const;
5051 bool ShowBorder(
bool & out_state)
const;
5056 bool ShowBorderColor(
RGBColor & out_color)
const;
5071 bool ShowFillColor(
RGBColor & out_color)
const;
5076 bool ShowMultipleSelection(
bool & out_state)
const;
5082 bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values)
const;
5102 HPS::Type
ObjectType()
const {
return HPS::Type::PublishDropDownListKit; }
5244 DropDownListKit & SetContents(UTF8Array
const & in_displayed_values, UTF8Array
const & in_export_values);
5251 DropDownListKit & SetContents(
size_t in_count,
UTF8 const in_displayed_values[],
UTF8 const in_export_values[]);
5334 bool ShowName(
UTF8 & out_name)
const;
5347 bool ShowFontSize(
int & out_size)
const;
5352 bool ShowTextColor(
RGBColor & out_color)
const;
5357 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5362 bool ShowVisibility(
bool & out_state)
const;
5367 bool ShowPrintability(
bool & out_state)
const;
5377 bool ShowLock(
bool & out_state)
const;
5382 bool ShowBorder(
bool & out_state)
const;
5387 bool ShowBorderColor(
RGBColor & out_color)
const;
5402 bool ShowFillColor(
RGBColor & out_color)
const;
5407 bool ShowCustomText(
bool & out_state)
const;
5412 bool ShowSpellChecking(
bool & out_state)
const;
5417 bool ShowImmediateCommit(
bool & out_state)
const;
5423 bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values)
const;
5443 HPS::Type
ObjectType()
const {
return HPS::Type::PublishSignatureFieldKit; }
5630 bool ShowName(
UTF8 & out_name)
const;
5643 bool ShowFontSize(
int & out_size)
const;
5648 bool ShowTextColor(
RGBColor & out_color)
const;
5653 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5658 bool ShowVisibility(
bool & out_state)
const;
5663 bool ShowPrintability(
bool & out_state)
const;
5673 bool ShowLock(
bool & out_state)
const;
5678 bool ShowBorder(
bool & out_state)
const;
5683 bool ShowBorderColor(
RGBColor & out_color)
const;
5698 bool ShowFillColor(
RGBColor & out_color)
const;
5718 HPS::Type
ObjectType()
const {
return HPS::Type::PublishTextFieldKit; }
5951 bool ShowName(
UTF8 & out_name)
const;
5964 bool ShowFontSize(
int & out_size)
const;
5969 bool ShowTextColor(
RGBColor & out_color)
const;
5974 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5979 bool ShowVisibility(
bool & out_state)
const;
5984 bool ShowPrintability(
bool & out_state)
const;
5994 bool ShowLock(
bool & out_state)
const;
5999 bool ShowBorder(
bool & out_state)
const;
6004 bool ShowBorderColor(
RGBColor & out_color)
const;
6019 bool ShowFillColor(
RGBColor & out_color)
const;
6024 bool ShowDefaultValue(
UTF8 & out_value)
const;
6034 bool ShowMultiline(
bool & out_state)
const;
6039 bool ShowScrolling(
bool & out_state)
const;
6044 bool ShowReadOnly(
bool & out_state)
const;
6066 HPS::Type
ObjectType()
const {
return HPS::Type::PublishDocumentKey; }
6091 bool operator!=(
DocumentKey const & in_that)
const;
6096 bool operator==(
DocumentKey const & in_that)
const;
6121 DocumentKey & AddPages(PageKitArray
const & in_pages);
6132 DocumentKey & SetInformation(
char const * in_title,
char const * in_author,
char const * in_subject,
char const * in_creator);
6138 DocumentKey & SetPasswords(
char const * in_user_password,
char const * in_owner_password);
6145 DocumentKey & AddJavaScript(
char const * in_script_name,
char const * in_source,
Source::Type in_type = Source::Type::Code);
6160 DocumentKey & AddJavaScript(UTF8Array
const & in_script_names, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
6166 DocumentKey & AddAttachment(
char const * in_filename,
char const * in_description);
6173 DocumentKey & AddAttachments(
size_t in_count,
UTF8 const in_filenames[],
UTF8 const in_descriptions[]);
6179 DocumentKey & AddAttachments(UTF8Array
const & in_filenames, UTF8Array
const & in_descriptions);
6198 DocumentKey & AddIconImages(UTF8Array
const & in_names, ImageKitArray
const & in_images);
6209 DocumentKey & SetPermissions(PermissionTypeArray
const & in_permissions);
6213 size_t GetPageCount()
const;
6224 DocumentKey & RemovePages(
size_t in_start,
size_t in_count);
6230 DocumentKey & RemovePages(
size_t in_count,
size_t const in_indices[]);
6235 DocumentKey & RemovePages(SizeTArray
const & in_indices);
6249 PageControl const GetPageControl(
size_t in_index)
const;
6269 HPS::Type
ObjectType()
const {
return HPS::Type::PublishPageControl; }
6299 PageControl & AddAnnotations(AnnotationKitArray
const & in_annotations, IntRectangleArray
const & in_locations);
6318 PageControl & AddText(TextKitArray
const & in_text, IntRectangleArray
const & in_locations);
6337 PageControl & AddImages(ImageKitArray
const & in_images, IntRectangleArray
const & in_locations);
6356 PageControl & AddTables(TableKitArray
const & in_tables, IntRectangleArray
const & in_locations);
6375 PageControl & AddLinks(LinkKitArray
const & in_links, IntRectangleArray
const & in_locations);
6394 PageControl & AddButtons(ButtonKitArray
const & in_buttons, IntRectangleArray
const & in_locations);
6413 PageControl & AddTextFields(TextFieldKitArray
const & in_text_fields, IntRectangleArray
const & in_locations);
6432 PageControl & AddSlideTables(SlideTableKitArray
const & in_slide_tables, IntRectangleArray
const & in_locations);
6451 PageControl & AddCheckBoxes(CheckBoxKitArray
const & in_check_boxes, IntRectangleArray
const & in_locations);
6470 PageControl & AddRadioButtons(RadioButtonKitArray
const & in_radio_buttons, IntRectangleArray
const & in_locations);
6489 PageControl & AddListBoxes(ListBoxKitArray
const & in_list_boxes, IntRectangleArray
const & in_locations);
6508 PageControl & AddDropDownLists(DropDownListKitArray
const & in_drop_down_lists, IntRectangleArray
const & in_locations);
6527 PageControl & AddSignatureFields(SignatureFieldKitArray
const & in_signature_fields, IntRectangleArray
const & in_locations);
6550 PageControl & SetAnnotationsByField(UTF8Array
const & in_fields, AnnotationKitArray
const & in_annotations);
6572 PageControl & SetButtonIconsByField(UTF8Array
const & in_fields, ImageKitArray
const & in_images);
6579 PageControl & SetButtonLabelByField(
char const * in_field,
char const * in_label);
6587 PageControl & SetButtonLabelsByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_labels[]);
6594 PageControl & SetButtonLabelsByField(UTF8Array
const & in_fields, UTF8Array
const & in_labels);
6602 PageControl & AddListItemByField(
char const * in_field,
char const * in_value,
char const * in_export_value);
6611 PageControl & AddListItemsByField(
char const * in_field,
size_t in_count,
UTF8 const in_values[],
UTF8 const in_export_values[]);
6619 PageControl & AddListItemsByField(
char const * in_field, UTF8Array
const & in_values, UTF8Array
const & in_export_values);
6628 PageControl & SetJavaScriptActionByField(
char const * in_field,
char const * in_source,
Source::Type in_type = Source::Type::Code);
6647 PageControl & SetJavaScriptActionsByField(UTF8Array
const & in_fields, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
6654 PageControl & SetVisibilityByField(
char const * in_field,
bool in_state);
6662 PageControl & SetVisibilitiesByField(
size_t in_count,
UTF8 const in_fields[],
bool const in_states[]);
6669 PageControl & SetVisibilitiesByField(UTF8Array
const & in_fields, BoolArray
const & in_states);
6676 PageControl & SetTextValueByField(
char const * in_field,
char const * in_value);
6684 PageControl & SetTextValuesByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_values[]);
6691 PageControl & SetTextValuesByField(UTF8Array
const & in_fields, UTF8Array
const & in_values);
6699 bool ShowFields(UTF8Array & out_names, IntRectangleArray & out_locations, FieldTypeArray & out_types)
const;
6703 class ExportOptionsKit;
6737 static DocumentKey CreateDocument(
char const * in_filename =
nullptr);
6743 static void Export(
DocumentKey const & in_document,
char const * in_filename);
6767 HPS::Type
ObjectType()
const {
return HPS::Type::PublishExportOptionsKit; }
6825 bool ShowDocumentToAppendTo(
UTF8 & out_filename)
const;
Mode
Definition: sprk_publish.h:284
Definition: sprk_publish.h:3123
Definition: sprk_publish.h:2725
Mode
Definition: sprk_publish.h:456
Definition: sprk_publish.h:474
Preference
Definition: sprk_publish.h:496
HPS::Type ObjectType() const
Definition: sprk_publish.h:2297
HPS::Type ObjectType() const
Definition: sprk_publish.h:3390
Definition: sprk_publish.h:162
Orientation
Definition: sprk_publish.h:127
Definition: sprk_publish.h:313
Definition: sprk_publish.h:451
Format
Definition: sprk_publish.h:109
Definition: sprk_publish.h:181
Type
Definition: sprk_publish.h:318
Definition: sprk_publish.h:5427
Mode
Definition: sprk_publish.h:257
Definition: sprk_publish.h:42
Definition: sprk_publish.h:2951
Type
Definition: sprk_publish.h:568
Style
Definition: sprk_publish.h:203
HPS::Type ObjectType() const
Definition: sprk_publish.h:6767
Definition: sprk_publish.h:4153
Definition: sprk_publish.h:234
HPS::Type ObjectType() const
Definition: sprk_publish.h:6066
HPS::Type ObjectType() const
Definition: sprk_publish.h:4169
Definition: sprk_publish.h:565
Definition: sprk_publish.h:3698
Definition: sprk_publish.h:6706
Rotation
Definition: sprk_publish.h:377
Definition: sprk_publish.h:3545
Definition: sprk_publish.h:85
Position
Definition: sprk_publish.h:547
Definition: sprk_publish.h:391
Definition: sprk_publish.h:216
Definition: sprk_publish.h:5702
Definition: sprk_publish.h:4773
Type
Definition: sprk_publish.h:431
Definition: sprk_publish.h:491
Definition: sprk_publish.h:426
Justification
Definition: hps.h:1544
Definition: sprk_publish.h:104
BRepCompression
Definition: sprk_publish.h:167
Definition: sprk_publish.h:139
Definition: sprk_publish.h:596
HPS::Type ObjectType() const
Definition: sprk_publish.h:5102
Definition: sprk_publish.h:6751
Style
Definition: sprk_publish.h:344
Definition: sprk_publish.h:198
Definition: sprk_publish.h:279
Definition: sprk_publish.h:6253
Definition: sprk_publish.h:6048
HPS::Type ObjectType() const
Definition: sprk_publish.h:612
Definition: sprk_publish.h:5086
HPS::Type ObjectType() const
Definition: sprk_publish.h:2741
HPS::Type ObjectType() const
Definition: sprk_publish.h:5718
Thickness
Definition: sprk_publish.h:518
Definition: sprk_publish.h:3262
HPS::Type ObjectType() const
Definition: sprk_publish.h:3714
Type
Definition: sprk_publish.h:90
HPS::Type ObjectType() const
Definition: sprk_publish.h:4789
SourceType
Definition: sprk_publish.h:150
Definition: sprk_publish.h:542
HPS::Type ObjectType() const
Definition: sprk_publish.h:6269
Format
Definition: sprk_publish.h:144
Definition: sprk_publish.h:309
Preference
Definition: sprk_publish.h:479
Name
Definition: sprk_publish.h:326
Format
Definition: sprk_publish.h:396
Definition: sprk_publish.h:513
HPS::Type ObjectType() const
Definition: sprk_publish.h:952
Definition: sprk_publish.h:252
HPS::Type ObjectType() const
Definition: sprk_publish.h:3139
Language
Definition: sprk_publish.h:359
Definition: sprk_publish.h:927
Definition: sprk_publish.h:470
When
Definition: sprk_publish.h:221
Style
Definition: sprk_publish.h:527
When
Definition: sprk_publish.h:239
HPS::Type ObjectType() const
Definition: sprk_publish.h:2967
HPS::Type ObjectType() const
Definition: sprk_publish.h:5443
Definition: sprk_publish.h:2277
HPS::Type ObjectType() const
Definition: sprk_publish.h:3561
Version
Definition: sprk_publish.h:186
Definition: sprk_publish.h:3374
HPS::Type ObjectType() const
Definition: sprk_publish.h:3278