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(SPRK_PUBLISH) 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;
292 TransparentWireframe,
293 TransparentBoundingBox,
294 TransparentBoundingBoxOutline,
336 HelveticaBoldOblique,
381 CounterClockwise90Degrees,
382 CounterClockwise180Degrees,
383 CounterClockwise270Degrees,
449 typedef std::vector<Field::Type, Allocator<Field::Type>> FieldTypeArray;
593 typedef std::vector<Permission::Type, HPS::Allocator<Permission::Type> > PermissionTypeArray;
613 HPS::Type
ObjectType()
const {
return HPS::Type::PublishDocumentKit; }
667 DocumentKit & SetInformation(
char const * in_title,
char const * in_author,
char const * in_subject,
char const * in_creator);
673 DocumentKit & SetPasswords(
char const * in_user_password,
char const * in_owner_password);
680 DocumentKit & AddJavaScript(
char const * in_script_name,
char const * in_source,
Source::Type in_type = Source::Type::Code);
695 DocumentKit & AddJavaScript(UTF8Array
const & in_script_names, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
701 DocumentKit & AddAttachment(
char const * in_filename,
char const * in_description);
708 DocumentKit & AddAttachments(
size_t in_count,
UTF8 const in_filenames[],
UTF8 const in_descriptions[]);
714 DocumentKit & AddAttachments(UTF8Array
const & in_filenames, UTF8Array
const & in_descriptions);
733 DocumentKit & AddIconImages(UTF8Array
const & in_names, ImageKitArray
const & in_images);
758 DocumentKit & SetPages(PageKitArray
const & in_pages);
771 DocumentKit & AddPages(PageKitArray
const & in_pages);
782 DocumentKit & SetPermissions(PermissionTypeArray
const & in_permissions);
796 DocumentKit & UnsetJavaScript(
char const * in_script_name);
802 DocumentKit & UnsetJavaScript(
size_t in_count,
UTF8 const in_script_names[]);
807 DocumentKit & UnsetJavaScript(UTF8Array
const & in_script_names);
816 DocumentKit & UnsetAttachment(
char const * in_filename);
822 DocumentKit & UnsetAttachments(
size_t in_count,
UTF8 const in_filenames[]);
827 DocumentKit & UnsetAttachments(UTF8Array
const & in_filenames);
836 DocumentKit & UnsetIconImage(
char const * in_name);
847 DocumentKit & UnsetIconImages(UTF8Array
const & in_names);
862 DocumentKit & UnsetPages(
size_t in_count,
size_t const in_indices[]);
867 DocumentKit & UnsetPages(SizeTArray
const & in_indices);
888 bool ShowInformation(
UTF8 & out_title,
UTF8 & out_author,
UTF8 & out_subject,
UTF8 & out_creator)
const;
894 bool ShowPasswords(
UTF8 & out_user_password,
UTF8 & out_owner_password)
const;
902 bool ShowJavaScript(UTF8Array & out_script_names, UTF8Array & out_sources, SourceTypeArray & out_types)
const;
908 bool ShowAttachments(UTF8Array & out_filenames, UTF8Array & out_descriptions)
const;
914 bool ShowIconImages(UTF8Array & out_names, ImageKitArray & out_images)
const;
919 bool ShowPages(PageKitArray & out_pages)
const;
924 bool ShowPermissions(PermissionTypeArray & out_permissions)
const;
941 PageKit(
char const * in_filename);
953 HPS::Type
ObjectType()
const {
return HPS::Type::PublishPageKit; }
962 void Set(
PageKit const & in_kit);
966 void Show(
PageKit & out_kit)
const;
985 bool Equals(
PageKit const & in_kit)
const;
990 bool operator==(
PageKit const & in_kit)
const;
995 bool operator!=(
PageKit const & in_kit)
const;
1033 PageKit & SetAnnotations(AnnotationKitArray
const & in_annotations, IntRectangleArray
const & in_locations);
1046 PageKit & AddAnnotations(AnnotationKitArray
const & in_annotations, IntRectangleArray
const & in_locations);
1071 PageKit & SetText(TextKitArray
const & in_text, IntRectangleArray
const & in_locations);
1084 PageKit & AddText(TextKitArray
const & in_text, IntRectangleArray
const & in_locations);
1109 PageKit & SetImages(ImageKitArray
const & in_images, IntRectangleArray
const & in_locations);
1122 PageKit & AddImages(ImageKitArray
const & in_images, IntRectangleArray
const & in_locations);
1147 PageKit & SetTables(TableKitArray
const & in_tables, IntRectangleArray
const & in_locations);
1160 PageKit & AddTables(TableKitArray
const & in_tables, IntRectangleArray
const & in_locations);
1185 PageKit & SetLinks(LinkKitArray
const & in_links, IntRectangleArray
const & in_locations);
1198 PageKit & AddLinks(LinkKitArray
const & in_links, IntRectangleArray
const & in_locations);
1223 PageKit & SetButtons(ButtonKitArray
const & in_buttons, IntRectangleArray
const & in_locations);
1236 PageKit & AddButtons(ButtonKitArray
const & in_buttons, IntRectangleArray
const & in_locations);
1261 PageKit & SetTextFields(TextFieldKitArray
const & in_text_fields, IntRectangleArray
const & in_locations);
1274 PageKit & AddTextFields(TextFieldKitArray
const & in_text_fields, IntRectangleArray
const & in_locations);
1299 PageKit & SetSlideTables(SlideTableKitArray
const & in_slide_tables, IntRectangleArray
const & in_locations);
1312 PageKit & AddSlideTables(SlideTableKitArray
const & in_slide_tables, IntRectangleArray
const & in_locations);
1337 PageKit & SetCheckBoxes(CheckBoxKitArray
const & in_checkbox, IntRectangleArray
const & in_locations);
1350 PageKit & AddCheckBoxes(CheckBoxKitArray
const & in_checkbox, IntRectangleArray
const & in_locations);
1375 PageKit & SetRadioButtons(RadioButtonKitArray
const & in_radio_buttons, IntRectangleArray
const & in_locations);
1388 PageKit & AddRadioButtons(RadioButtonKitArray
const & in_radio_buttons, IntRectangleArray
const & in_locations);
1413 PageKit & SetListBoxes(ListBoxKitArray
const & in_list_box, IntRectangleArray
const & in_locations);
1426 PageKit & AddListBoxes(ListBoxKitArray
const & in_list_box, IntRectangleArray
const & in_locations);
1451 PageKit & SetDropDownLists(DropDownListKitArray
const & in_drop_down_list, IntRectangleArray
const & in_locations);
1464 PageKit & AddDropDownLists(DropDownListKitArray
const & in_drop_down_list, IntRectangleArray
const & in_locations);
1489 PageKit & SetSignatureFields(SignatureFieldKitArray
const & in_signature_field, IntRectangleArray
const & in_locations);
1502 PageKit & AddSignatureFields(SignatureFieldKitArray
const & in_signature_field, IntRectangleArray
const & in_locations);
1507 PageKit & SetTemplateFile(
char const * in_filename);
1529 PageKit & SetAnnotationsByField(UTF8Array
const & in_fields, AnnotationKitArray
const & in_annotations);
1536 PageKit & SetButtonIconByField(
char const * in_field,
ImageKit const & in_image);
1544 PageKit & SetButtonIconsByField(
size_t in_count,
UTF8 const in_fields[],
ImageKit const in_images[]);
1551 PageKit & SetButtonIconsByField(UTF8Array
const & in_fields, ImageKitArray
const & in_images);
1558 PageKit & SetButtonLabelByField(
char const * in_field,
char const * in_label);
1566 PageKit & SetButtonLabelsByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_labels[]);
1573 PageKit & SetButtonLabelsByField(UTF8Array
const & in_fields, UTF8Array
const & in_labels);
1581 PageKit & SetListItemByField(
char const * in_field,
char const * in_value,
char const * in_export_value);
1589 PageKit & AddListItemByField(
char const * in_field,
char const * in_value,
char const * in_export_value);
1598 PageKit & SetListItemsByField(
char const * in_field,
size_t in_count,
UTF8 const in_values[],
UTF8 const in_export_values[]);
1606 PageKit & SetListItemsByField(
char const * in_field, UTF8Array
const & in_values, UTF8Array
const & in_export_values);
1615 PageKit & AddListItemsByField(
char const * in_field,
size_t in_count,
UTF8 const in_values[],
UTF8 const in_export_values[]);
1623 PageKit & AddListItemsByField(
char const * in_field, UTF8Array
const & in_values, UTF8Array
const & in_export_values);
1632 PageKit & SetJavaScriptActionByField(
char const * in_field,
char const * in_source,
Source::Type in_type = Source::Type::Code);
1642 PageKit & SetJavaScriptActionsByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_sources[],
Source::Type const in_types[]);
1651 PageKit & SetJavaScriptActionsByField(UTF8Array
const & in_fields, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
1658 PageKit & SetVisibilityByField(
char const * in_field,
bool in_state);
1666 PageKit & SetVisibilitiesByField(
size_t in_count,
UTF8 const in_fields[],
bool const in_states[]);
1673 PageKit & SetVisibilitiesByField(UTF8Array
const & in_fields, BoolArray
const & in_states);
1680 PageKit & SetTextValueByField(
char const * in_field,
char const * in_value);
1688 PageKit & SetTextValuesByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_values[]);
1695 PageKit & SetTextValuesByField(UTF8Array
const & in_fields, UTF8Array
const & in_values);
1709 PageKit & UnsetAnnotation(
size_t in_index);
1715 PageKit & UnsetAnnotations(
size_t in_count,
size_t const in_indices[]);
1720 PageKit & UnsetAnnotations(SizeTArray
const & in_indices);
1729 PageKit & UnsetText(
size_t in_index);
1735 PageKit & UnsetText(
size_t in_count,
size_t const in_indices[]);
1740 PageKit & UnsetText(SizeTArray
const & in_indices);
1749 PageKit & UnsetCheckBox(
size_t in_index);
1755 PageKit & UnsetCheckBoxes(
size_t in_count,
size_t const in_indices[]);
1760 PageKit & UnsetCheckBoxes(SizeTArray
const & in_indices);
1769 PageKit & UnsetRadioButton(
size_t in_index);
1775 PageKit & UnsetRadioButtons(
size_t in_count,
size_t const in_indices[]);
1780 PageKit & UnsetRadioButtons(SizeTArray
const & in_indices);
1784 PageKit & UnsetRadioButtons();
1789 PageKit & UnsetListBox(
size_t in_index);
1795 PageKit & UnsetListBoxes(
size_t in_count,
size_t const in_indices[]);
1800 PageKit & UnsetListBoxes(SizeTArray
const & in_indices);
1809 PageKit & UnsetDropDownList(
size_t in_index);
1815 PageKit & UnsetDropDownLists(
size_t in_count,
size_t const in_indices[]);
1820 PageKit & UnsetDropDownLists(SizeTArray
const & in_indices);
1824 PageKit & UnsetDropDownLists();
1829 PageKit & UnsetSignatureField(
size_t in_index);
1835 PageKit & UnsetSignatureFields(
size_t in_count,
size_t const in_indices[]);
1840 PageKit & UnsetSignatureFields(SizeTArray
const & in_indices);
1844 PageKit & UnsetSignatureFields();
1849 PageKit & UnsetImage(
size_t in_index);
1855 PageKit & UnsetImages(
size_t in_count,
size_t const in_indices[]);
1860 PageKit & UnsetImages(SizeTArray
const & in_indices);
1869 PageKit & UnsetTable(
size_t in_index);
1875 PageKit & UnsetTables(
size_t in_count,
size_t const in_indices[]);
1880 PageKit & UnsetTables(SizeTArray
const & in_indices);
1889 PageKit & UnsetLink(
size_t in_index);
1895 PageKit & UnsetLinks(
size_t in_count,
size_t const in_indices[]);
1900 PageKit & UnsetLinks(SizeTArray
const & in_indices);
1909 PageKit & UnsetButton(
size_t in_index);
1915 PageKit & UnsetButtons(
size_t in_count,
size_t const in_indices[]);
1920 PageKit & UnsetButtons(SizeTArray
const & in_indices);
1929 PageKit & UnsetTextField(
size_t in_index);
1935 PageKit & UnsetTextFields(
size_t in_count,
size_t const in_indices[]);
1940 PageKit & UnsetTextFields(SizeTArray
const & in_indices);
1949 PageKit & UnsetSlideTable(
size_t in_index);
1955 PageKit & UnsetSlideTables(
size_t in_count,
size_t const in_indices[]);
1960 PageKit & UnsetSlideTables(SizeTArray
const & in_indices);
1968 PageKit & UnsetTemplateFile();
1973 PageKit & UnsetAnnotationByField(
char const * in_field);
1979 PageKit & UnsetAnnotationsByField(
size_t in_count,
UTF8 const in_fields[]);
1984 PageKit & UnsetAnnotationsByField(UTF8Array
const & in_fields);
1988 PageKit & UnsetAnnotationsByField();
1993 PageKit & UnsetButtonIconByField(
char const * in_field);
1999 PageKit & UnsetButtonIconsByField(
size_t in_count,
UTF8 const in_fields[]);
2004 PageKit & UnsetButtonIconsByField(UTF8Array
const & in_fields);
2008 PageKit & UnsetButtonIconsByField();
2013 PageKit & UnsetButtonLabelByField(
char const * in_field);
2019 PageKit & UnsetButtonLabelsByField(
size_t in_count,
UTF8 const in_fields[]);
2024 PageKit & UnsetButtonLabelsByField(UTF8Array
const & in_fields);
2028 PageKit & UnsetButtonLabelsByField();
2034 PageKit & UnsetListItemByField(
char const * in_field,
size_t in_index);
2041 PageKit & UnsetListItemsByField(
char const * in_field,
size_t in_count,
size_t const in_indices[]);
2047 PageKit & UnsetListItemsByField(
char const * in_field, SizeTArray
const & in_indices);
2052 PageKit & UnsetListItemsByField(
char const * in_field);
2058 PageKit & UnsetListItemsByField(
size_t in_count,
UTF8 const in_fields[]);
2063 PageKit & UnsetListItemsByField(UTF8Array
const & in_fields);
2067 PageKit & UnsetListItemsByField();
2072 PageKit & UnsetJavaScriptActionByField(
char const * in_field);
2078 PageKit & UnsetJavaScriptActionsByField(
size_t in_count,
UTF8 const in_fields[]);
2083 PageKit & UnsetJavaScriptActionsByField(UTF8Array
const & in_fields);
2087 PageKit & UnsetJavaScriptActionsByField();
2092 PageKit & UnsetVisibilityByField(
char const * in_field);
2098 PageKit & UnsetVisibilitiesByField(
size_t in_count,
UTF8 const in_fields[]);
2103 PageKit & UnsetVisibilitiesByField(UTF8Array
const & in_fields);
2107 PageKit & UnsetVisibilitiesByField();
2112 PageKit & UnsetTextValueByField(
char const * in_field);
2118 PageKit & UnsetTextValuesByField(
size_t in_count,
UTF8 const in_fields[]);
2123 PageKit & UnsetTextValuesByField(UTF8Array
const & in_fields);
2127 PageKit & UnsetTextValuesByField();
2148 bool ShowAnnotations(AnnotationKitArray & out_annotations, IntRectangleArray & out_locations)
const;
2154 bool ShowText(TextKitArray & out_text, IntRectangleArray & out_locations)
const;
2160 bool ShowImages(ImageKitArray & out_images, IntRectangleArray & out_locations)
const;
2166 bool ShowTables(TableKitArray & out_tables, IntRectangleArray & out_locations)
const;
2172 bool ShowLinks(LinkKitArray & out_links, IntRectangleArray & out_locations)
const;
2178 bool ShowButtons(ButtonKitArray & out_buttons, IntRectangleArray & out_locations)
const;
2184 bool ShowCheckBoxes(CheckBoxKitArray & out_check_boxes, IntRectangleArray & out_locations)
const;
2190 bool ShowRadioButtons(RadioButtonKitArray & out_radio_buttons, IntRectangleArray & out_locations)
const;
2196 bool ShowListBoxes(ListBoxKitArray & out_list_boxes, IntRectangleArray & out_locations)
const;
2202 bool ShowDropDownLists(DropDownListKitArray & out_drop_down_lists, IntRectangleArray & out_locations)
const;
2208 bool ShowSignatureFields(SignatureFieldKitArray & out_signature_fields, IntRectangleArray & out_locations)
const;
2214 bool ShowTextFields(TextFieldKitArray & out_text_fields, IntRectangleArray & out_locations)
const;
2220 bool ShowSlideTables(SlideTableKitArray & out_slide_tables, IntRectangleArray & out_locations)
const;
2225 bool ShowTemplateFile(
UTF8 & out_filename)
const;
2231 bool ShowAnnotationsByField(UTF8Array & out_fields, AnnotationKitArray & out_annotations)
const;
2237 bool ShowButtonIconsByField(UTF8Array & out_fields, ImageKitArray & out_images)
const;
2243 bool ShowButtonLabelsByField(UTF8Array & out_fields, UTF8Array & out_labels)
const;
2248 bool ShowListItemFields(UTF8Array & out_fields)
const;
2255 bool ShowListItemsByField(
char const * in_field, UTF8Array & out_values, UTF8Array & out_export_values)
const;
2262 bool ShowJavaScriptActionsByField(UTF8Array & out_fields, UTF8Array & out_sources, SourceTypeArray & out_types)
const;
2268 bool ShowVisibilitiesByField(UTF8Array & out_fields, BoolArray & out_states)
const;
2274 bool ShowTextValuesByField(UTF8Array & out_fields, UTF8Array & out_values)
const;
2294 HPS::Type
ObjectType()
const {
return HPS::Type::PublishAnnotationKit; }
2370 AnnotationKit & SetSource(
CADModel const & in_cad_model, KeyPathArray
const & in_additional_sources);
2390 AnnotationKit & SetPRCTessellationCompression(
bool in_state);
2495 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);
2503 AnnotationKit & SetCarouselButtons(UTF8Array
const & in_button_names,
char const * in_previous_button_name,
char const * in_next_button_name,
size_t in_scroll_size);
2512 AnnotationKit & SetCarouselViews(
size_t in_count,
size_t const in_indices[],
ImageKit const in_images[] =
nullptr);
2520 AnnotationKit & SetCarouselViews(SizeTArray
const & in_indices, ImageKitArray
const & in_images = ImageKitArray());
2635 bool ShowPRCTessellationCompression(
bool & out_state)
const;
2645 bool ShowPRCBRepRemoval(
bool & out_state)
const;
2650 bool ShowPRCAttributeRemoval(
bool & out_state)
const;
2660 bool ShowU3DCompression(
unsigned char & out_level)
const;
2665 bool ShowName(
UTF8 & out_name)
const;
2670 bool ShowArtwork(
ArtworkKit & out_artwork)
const;
2685 bool ShowToolbarVisibility(
bool & out_state)
const;
2690 bool ShowModelTreeVisibility(
bool & out_state)
const;
2695 bool ShowInteractivity(
bool & out_state)
const;
2700 bool ShowBorderWidth(
int & out_width)
const;
2705 bool ShowTransparentBackground(
bool & out_state)
const;
2710 bool ShowBackgroundColor(
RGBColor & out_color)
const;
2725 bool ShowPosterImage(
ImageKit & out_image)
const;
2733 bool ShowCarouselButtons(UTF8Array & out_button_names,
UTF8 & out_previous_button_name,
UTF8 & out_next_button_name,
size_t & out_scroll_size)
const;
2739 bool ShowCarouselViews(SizeTArray & out_indices, ImageKitArray & out_images)
const;
2759 HPS::Type
ObjectType()
const {
return HPS::Type::PublishArtworkKit; }
2791 bool Equals(
ArtworkKit const & in_kit)
const;
2796 bool operator==(
ArtworkKit const & in_kit)
const;
2801 bool operator!=(
ArtworkKit const & in_kit)
const;
2818 ArtworkKit & SetPMICrossHighlighting(
bool in_state);
2823 ArtworkKit & SetPMISemanticInformation(
bool in_state);
2854 ArtworkKit & SetViews(ViewKitArray
const & in_views);
2865 ArtworkKit & AddViews(ViewKitArray
const & in_views);
2906 ArtworkKit & UnsetViews(
size_t in_count,
size_t const in_indices[]);
2911 ArtworkKit & UnsetViews(SizeTArray
const & in_indices);
2940 bool ShowPMICrossHighlighting(
bool & out_state)
const;
2945 bool ShowPMISemanticInformation(
bool & out_state)
const;
2960 bool ShowViews(ViewKitArray & out_views)
const;
2985 HPS::Type
ObjectType()
const {
return HPS::Type::PublishViewKit; }
2994 void Set(
ViewKit const & in_kit);
2998 void Show(
ViewKit & out_kit)
const;
3017 bool Equals(
ViewKit const & in_kit)
const;
3022 bool operator==(
ViewKit const & in_kit)
const;
3027 bool operator!=(
ViewKit const & in_kit)
const;
3033 ViewKit & SetInternalName(
char const * in_name);
3038 ViewKit & SetExternalName(
char const * in_name);
3053 ViewKit & SetDefault(
bool in_state);
3073 ViewKit & UnsetInternalName();
3077 ViewKit & UnsetExternalName();
3089 ViewKit & UnsetBackgroundColor();
3107 bool ShowInternalName(
UTF8 & out_name)
const;
3112 bool ShowExternalName(
UTF8 & out_name)
const;
3117 bool ShowCamera(
CameraKit & out_camera)
const;
3122 bool ShowDefault(
bool & out_state)
const;
3127 bool ShowBackgroundColor(
RGBColor & out_color)
const;
3157 HPS::Type
ObjectType()
const {
return HPS::Type::PublishTextKit; }
3166 void Set(
TextKit const & in_kit);
3170 void Show(
TextKit & out_kit)
const;
3189 bool Equals(
TextKit const & in_kit)
const;
3194 bool operator==(
TextKit const & in_kit)
const;
3199 bool operator!=(
TextKit const & in_kit)
const;
3206 TextKit & SetText(
char const * in_text);
3224 TextKit & SetSize(
int in_size);
3257 bool ShowText(
UTF8 & out_text)
const;
3271 bool ShowSize(
int & out_size)
const;
3276 bool ShowColor(
RGBColor & out_color)
const;
3296 HPS::Type
ObjectType()
const {
return HPS::Type::PublishImageKit; }
3306 void Show(
ImageKit & out_kit)
const;
3325 bool Equals(
ImageKit const & in_kit)
const;
3330 bool operator==(
ImageKit const & in_kit)
const;
3335 bool operator!=(
ImageKit const & in_kit)
const;
3341 ImageKit & SetFile(
char const * in_filename);
3348 ImageKit & SetSize(
int in_width,
int in_height);
3376 bool ShowFile(
UTF8 & out_filename)
const;
3382 bool ShowSize(
int & out_width,
int & out_height)
const;
3408 HPS::Type
ObjectType()
const {
return HPS::Type::PublishTableKit; }
3418 void Show(
TableKit & out_kit)
const;
3437 bool Equals(
TableKit const & in_kit)
const;
3442 bool operator==(
TableKit const & in_kit)
const;
3447 bool operator!=(
TableKit const & in_kit)
const;
3467 TableKit & SetLink(
int in_row,
int in_column,
LinkKit const & in_link);
3474 TableKit & SetText(
int in_row,
int in_column,
TextKit const & in_text);
3501 TableKit & UnsetLink(
int in_row,
int in_column);
3505 TableKit & UnsetText(
int in_row,
int in_column);
3509 TableKit & UnsetButton(
int in_row,
int in_column);
3513 TableKit & UnsetTextField(
int in_row,
int in_column);
3537 bool ShowLink(
int in_row,
int in_column,
LinkKit & out_link)
const;
3544 bool ShowText(
int in_row,
int in_column,
TextKit & out_text)
const;
3551 bool ShowButton(
int in_row,
int in_column,
ButtonKit & out_button)
const;
3558 bool ShowTextField(
int in_row,
int in_column,
TextFieldKit & out_text_field)
const;
3579 HPS::Type
ObjectType()
const {
return HPS::Type::PublishSlideTableKit; }
3637 SlideTableKit & SetButtons(
char const * in_previous_button_name,
char const * in_next_button_name);
3651 SlideTableKit & SetText(
size_t in_rows,
size_t in_columns, TextFieldKitArray
const & in_text);
3700 bool ShowButtons(
UTF8 & out_previous_button_name,
UTF8 & out_next_button_name)
const;
3707 bool ShowText(
size_t & out_rows,
size_t & out_columns, TextFieldKitArray & out_text)
const;
3712 bool ShowHeader(
bool & out_state)
const;
3732 HPS::Type
ObjectType()
const {
return HPS::Type::PublishLinkKit; }
3738 void Set(
LinkKit const & in_kit);
3742 void Show(
LinkKit & out_kit)
const;
3761 bool Equals(
LinkKit const & in_kit)
const;
3766 bool operator==(
LinkKit const & in_kit)
const;
3771 bool operator!=(
LinkKit const & in_kit)
const;
3778 LinkKit & SetJavaScript(
char const * in_source,
Source::Type in_type = Source::Type::Code);
3783 LinkKit & SetBorderWidth(
int in_width);
3806 LinkKit & UnsetHighlighting();
3826 bool ShowBorderWidth(
int & out_width)
const;
3836 bool ShowBorderColor(
RGBColor & out_color)
const;
3856 HPS::Type
ObjectType()
const {
return HPS::Type::PublishButtonKit; }
3888 bool Equals(
ButtonKit const & in_kit)
const;
3893 bool operator==(
ButtonKit const & in_kit)
const;
3898 bool operator!=(
ButtonKit const & in_kit)
const;
3904 ButtonKit & SetName(
char const * in_name);
3909 ButtonKit & SetLabel(
char const * in_label);
3935 ButtonKit & SetTooltip(
char const * in_tooltip);
3940 ButtonKit & SetVisibility(
bool in_state);
3945 ButtonKit & SetPrintability(
bool in_state);
4079 bool ShowName(
UTF8 & out_name)
const;
4084 bool ShowLabel(
UTF8 & out_label)
const;
4097 bool ShowFontSize(
int & out_size)
const;
4102 bool ShowTextColor(
RGBColor & out_color)
const;
4107 bool ShowTooltip(
UTF8 & out_tooltip)
const;
4112 bool ShowVisibility(
bool & out_state)
const;
4117 bool ShowPrintability(
bool & out_state)
const;
4127 bool ShowLock(
bool & out_state)
const;
4132 bool ShowBorder(
bool & out_state)
const;
4137 bool ShowBorderColor(
RGBColor & out_color)
const;
4152 bool ShowFillColor(
RGBColor & out_color)
const;
4167 bool ShowIconImage(
ImageKit & out_image)
const;
4187 HPS::Type
ObjectType()
const {
return HPS::Type::PublishCheckBoxKit; }
4224 bool operator==(
CheckBoxKit const & in_kit)
const;
4229 bool operator!=(
CheckBoxKit const & in_kit)
const;
4261 CheckBoxKit & SetTooltip(
char const * in_tooltip);
4312 CheckBoxKit & SetExportValue(
char const * in_export_value);
4392 bool ShowName(
UTF8 & out_name)
const;
4405 bool ShowFontSize(
int & out_size)
const;
4410 bool ShowTextColor(
RGBColor & out_color)
const;
4415 bool ShowTooltip(
UTF8 & out_tooltip)
const;
4420 bool ShowVisibility(
bool & out_state)
const;
4425 bool ShowPrintability(
bool & out_state)
const;
4435 bool ShowLock(
bool & out_state)
const;
4440 bool ShowBorder(
bool & out_state)
const;
4445 bool ShowBorderColor(
RGBColor & out_color)
const;
4460 bool ShowFillColor(
RGBColor & out_color)
const;
4465 bool ShowExportValue(
UTF8 & out_export_value)
const;
4470 bool ShowDefaultState(
bool & out_default_state)
const;
4490 HPS::Type
ObjectType()
const {
return HPS::Type::PublishRadioButtonKit; }
4704 bool ShowName(
UTF8 & out_name)
const;
4717 bool ShowFontSize(
int & out_size)
const;
4722 bool ShowTextColor(
RGBColor & out_color)
const;
4727 bool ShowTooltip(
UTF8 & out_tooltip)
const;
4732 bool ShowVisibility(
bool & out_state)
const;
4737 bool ShowPrintability(
bool & out_state)
const;
4747 bool ShowLock(
bool & out_state)
const;
4752 bool ShowBorder(
bool & out_state)
const;
4757 bool ShowBorderColor(
RGBColor & out_color)
const;
4772 bool ShowFillColor(
RGBColor & out_color)
const;
4777 bool ShowExportValue(
UTF8 & out_export_value)
const;
4782 bool ShowDefaultState(
bool & out_default_state)
const;
4787 bool ShowGrouping(
bool & out_grouping)
const;
4807 HPS::Type
ObjectType()
const {
return HPS::Type::PublishListBoxKit; }
4839 bool Equals(
ListBoxKit const & in_kit)
const;
4844 bool operator==(
ListBoxKit const & in_kit)
const;
4849 bool operator!=(
ListBoxKit const & in_kit)
const;
4881 ListBoxKit & SetTooltip(
char const * in_tooltip);
4932 ListBoxKit & SetMultipleSelection(
bool in_state);
4939 ListBoxKit & SetContents(UTF8Array
const & in_displayed_values, UTF8Array
const & in_export_values);
4946 ListBoxKit & SetContents(
size_t in_count,
UTF8 const in_displayed_values[],
UTF8 const in_export_values[]);
5021 bool ShowName(
UTF8 & out_name)
const;
5034 bool ShowFontSize(
int & out_size)
const;
5039 bool ShowTextColor(
RGBColor & out_color)
const;
5044 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5049 bool ShowVisibility(
bool & out_state)
const;
5054 bool ShowPrintability(
bool & out_state)
const;
5064 bool ShowLock(
bool & out_state)
const;
5069 bool ShowBorder(
bool & out_state)
const;
5074 bool ShowBorderColor(
RGBColor & out_color)
const;
5089 bool ShowFillColor(
RGBColor & out_color)
const;
5094 bool ShowMultipleSelection(
bool & out_state)
const;
5100 bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values)
const;
5120 HPS::Type
ObjectType()
const {
return HPS::Type::PublishDropDownListKit; }
5262 DropDownListKit & SetContents(UTF8Array
const & in_displayed_values, UTF8Array
const & in_export_values);
5269 DropDownListKit & SetContents(
size_t in_count,
UTF8 const in_displayed_values[],
UTF8 const in_export_values[]);
5352 bool ShowName(
UTF8 & out_name)
const;
5365 bool ShowFontSize(
int & out_size)
const;
5370 bool ShowTextColor(
RGBColor & out_color)
const;
5375 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5380 bool ShowVisibility(
bool & out_state)
const;
5385 bool ShowPrintability(
bool & out_state)
const;
5395 bool ShowLock(
bool & out_state)
const;
5400 bool ShowBorder(
bool & out_state)
const;
5405 bool ShowBorderColor(
RGBColor & out_color)
const;
5420 bool ShowFillColor(
RGBColor & out_color)
const;
5425 bool ShowCustomText(
bool & out_state)
const;
5430 bool ShowSpellChecking(
bool & out_state)
const;
5435 bool ShowImmediateCommit(
bool & out_state)
const;
5441 bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values)
const;
5461 HPS::Type
ObjectType()
const {
return HPS::Type::PublishSignatureFieldKit; }
5648 bool ShowName(
UTF8 & out_name)
const;
5661 bool ShowFontSize(
int & out_size)
const;
5666 bool ShowTextColor(
RGBColor & out_color)
const;
5671 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5676 bool ShowVisibility(
bool & out_state)
const;
5681 bool ShowPrintability(
bool & out_state)
const;
5691 bool ShowLock(
bool & out_state)
const;
5696 bool ShowBorder(
bool & out_state)
const;
5701 bool ShowBorderColor(
RGBColor & out_color)
const;
5716 bool ShowFillColor(
RGBColor & out_color)
const;
5736 HPS::Type
ObjectType()
const {
return HPS::Type::PublishTextFieldKit; }
5969 bool ShowName(
UTF8 & out_name)
const;
5982 bool ShowFontSize(
int & out_size)
const;
5987 bool ShowTextColor(
RGBColor & out_color)
const;
5992 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5997 bool ShowVisibility(
bool & out_state)
const;
6002 bool ShowPrintability(
bool & out_state)
const;
6012 bool ShowLock(
bool & out_state)
const;
6017 bool ShowBorder(
bool & out_state)
const;
6022 bool ShowBorderColor(
RGBColor & out_color)
const;
6037 bool ShowFillColor(
RGBColor & out_color)
const;
6042 bool ShowDefaultValue(
UTF8 & out_value)
const;
6052 bool ShowMultiline(
bool & out_state)
const;
6057 bool ShowScrolling(
bool & out_state)
const;
6062 bool ShowReadOnly(
bool & out_state)
const;
6084 HPS::Type
ObjectType()
const {
return HPS::Type::PublishDocumentKey; }
6109 bool operator!=(
DocumentKey const & in_that)
const;
6114 bool operator==(
DocumentKey const & in_that)
const;
6139 DocumentKey & AddPages(PageKitArray
const & in_pages);
6150 DocumentKey & SetInformation(
char const * in_title,
char const * in_author,
char const * in_subject,
char const * in_creator);
6156 DocumentKey & SetPasswords(
char const * in_user_password,
char const * in_owner_password);
6163 DocumentKey & AddJavaScript(
char const * in_script_name,
char const * in_source,
Source::Type in_type = Source::Type::Code);
6178 DocumentKey & AddJavaScript(UTF8Array
const & in_script_names, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
6184 DocumentKey & AddAttachment(
char const * in_filename,
char const * in_description);
6191 DocumentKey & AddAttachments(
size_t in_count,
UTF8 const in_filenames[],
UTF8 const in_descriptions[]);
6197 DocumentKey & AddAttachments(UTF8Array
const & in_filenames, UTF8Array
const & in_descriptions);
6216 DocumentKey & AddIconImages(UTF8Array
const & in_names, ImageKitArray
const & in_images);
6227 DocumentKey & SetPermissions(PermissionTypeArray
const & in_permissions);
6231 size_t GetPageCount()
const;
6242 DocumentKey & RemovePages(
size_t in_start,
size_t in_count);
6248 DocumentKey & RemovePages(
size_t in_count,
size_t const in_indices[]);
6253 DocumentKey & RemovePages(SizeTArray
const & in_indices);
6267 PageControl const GetPageControl(
size_t in_index)
const;
6287 HPS::Type
ObjectType()
const {
return HPS::Type::PublishPageControl; }
6317 PageControl & AddAnnotations(AnnotationKitArray
const & in_annotations, IntRectangleArray
const & in_locations);
6336 PageControl & AddText(TextKitArray
const & in_text, IntRectangleArray
const & in_locations);
6355 PageControl & AddImages(ImageKitArray
const & in_images, IntRectangleArray
const & in_locations);
6374 PageControl & AddTables(TableKitArray
const & in_tables, IntRectangleArray
const & in_locations);
6393 PageControl & AddLinks(LinkKitArray
const & in_links, IntRectangleArray
const & in_locations);
6412 PageControl & AddButtons(ButtonKitArray
const & in_buttons, IntRectangleArray
const & in_locations);
6431 PageControl & AddTextFields(TextFieldKitArray
const & in_text_fields, IntRectangleArray
const & in_locations);
6450 PageControl & AddSlideTables(SlideTableKitArray
const & in_slide_tables, IntRectangleArray
const & in_locations);
6469 PageControl & AddCheckBoxes(CheckBoxKitArray
const & in_check_boxes, IntRectangleArray
const & in_locations);
6488 PageControl & AddRadioButtons(RadioButtonKitArray
const & in_radio_buttons, IntRectangleArray
const & in_locations);
6507 PageControl & AddListBoxes(ListBoxKitArray
const & in_list_boxes, IntRectangleArray
const & in_locations);
6526 PageControl & AddDropDownLists(DropDownListKitArray
const & in_drop_down_lists, IntRectangleArray
const & in_locations);
6545 PageControl & AddSignatureFields(SignatureFieldKitArray
const & in_signature_fields, IntRectangleArray
const & in_locations);
6568 PageControl & SetAnnotationsByField(UTF8Array
const & in_fields, AnnotationKitArray
const & in_annotations);
6590 PageControl & SetButtonIconsByField(UTF8Array
const & in_fields, ImageKitArray
const & in_images);
6597 PageControl & SetButtonLabelByField(
char const * in_field,
char const * in_label);
6605 PageControl & SetButtonLabelsByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_labels[]);
6612 PageControl & SetButtonLabelsByField(UTF8Array
const & in_fields, UTF8Array
const & in_labels);
6620 PageControl & AddListItemByField(
char const * in_field,
char const * in_value,
char const * in_export_value);
6629 PageControl & AddListItemsByField(
char const * in_field,
size_t in_count,
UTF8 const in_values[],
UTF8 const in_export_values[]);
6637 PageControl & AddListItemsByField(
char const * in_field, UTF8Array
const & in_values, UTF8Array
const & in_export_values);
6646 PageControl & SetJavaScriptActionByField(
char const * in_field,
char const * in_source,
Source::Type in_type = Source::Type::Code);
6665 PageControl & SetJavaScriptActionsByField(UTF8Array
const & in_fields, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
6672 PageControl & SetVisibilityByField(
char const * in_field,
bool in_state);
6680 PageControl & SetVisibilitiesByField(
size_t in_count,
UTF8 const in_fields[],
bool const in_states[]);
6687 PageControl & SetVisibilitiesByField(UTF8Array
const & in_fields, BoolArray
const & in_states);
6694 PageControl & SetTextValueByField(
char const * in_field,
char const * in_value);
6702 PageControl & SetTextValuesByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_values[]);
6709 PageControl & SetTextValuesByField(UTF8Array
const & in_fields, UTF8Array
const & in_values);
6717 bool ShowFields(UTF8Array & out_names, IntRectangleArray & out_locations, FieldTypeArray & out_types)
const;
6721 class ExportOptionsKit;
6739 static void Export(KeyPathArray
const & in_key_paths,
char const * in_file_name,
ExportOptionsKit const & in_options);
6747 static void Export(
size_t in_count,
KeyPath const in_key_paths [],
char const * in_file_name,
ExportOptionsKit const & in_options);
6754 static void Export(
KeyPath const & in_key_path,
char const * in_file_name,
ExportOptionsKit const & in_options);
6763 static void Export(
CADModel const & in_cad_model, KeyPathArray
const & in_additional_key_paths,
char const * in_file_name,
ExportOptionsKit const & in_options);
6773 static void Export(
CADModel const & in_cad_model,
size_t in_count,
KeyPath const in_additional_key_paths [],
char const * in_file_name,
ExportOptionsKit const & in_options);
6795 static DocumentKey CreateDocument(
char const * in_file_name =
nullptr);
6801 static void Export(
DocumentKey const & in_document,
char const * in_file_name);
6825 HPS::Type
ObjectType()
const {
return HPS::Type::PublishExportOptionsKit; }
6883 bool ShowDocumentToAppendTo(
UTF8 & out_filename)
const;
Mode
Definition: sprk_publish.h:285
Definition: sprk_publish.h:3141
Definition: sprk_publish.h:2743
Mode
Definition: sprk_publish.h:457
Definition: sprk_publish.h:475
Preference
Definition: sprk_publish.h:497
HPS::Type ObjectType() const
Definition: sprk_publish.h:2294
HPS::Type ObjectType() const
Definition: sprk_publish.h:3408
Definition: sprk_publish.h:163
Orientation
Definition: sprk_publish.h:127
Definition: sprk_publish.h:314
Definition: sprk_publish.h:452
Format
Definition: sprk_publish.h:109
Definition: sprk_publish.h:182
Type
Definition: sprk_publish.h:319
Definition: sprk_publish.h:5445
Mode
Definition: sprk_publish.h:258
Definition: sprk_publish.h:42
Definition: sprk_publish.h:2969
Type
Definition: sprk_publish.h:569
Style
Definition: sprk_publish.h:204
HPS::Type ObjectType() const
Definition: sprk_publish.h:6825
Definition: sprk_publish.h:4171
Definition: sprk_publish.h:235
HPS::Type ObjectType() const
Definition: sprk_publish.h:6084
HPS::Type ObjectType() const
Definition: sprk_publish.h:4187
Definition: sprk_publish.h:566
Definition: sprk_publish.h:3716
Definition: sprk_publish.h:6724
Rotation
Definition: sprk_publish.h:378
Definition: sprk_publish.h:3563
Definition: sprk_publish.h:85
Position
Definition: sprk_publish.h:548
Definition: sprk_publish.h:392
Definition: sprk_publish.h:217
Definition: sprk_publish.h:5720
Definition: sprk_publish.h:4791
Type
Definition: sprk_publish.h:432
Definition: sprk_publish.h:492
Definition: sprk_publish.h:427
Justification
Definition: hps.h:1525
Definition: sprk_publish.h:104
BRepCompression
Definition: sprk_publish.h:168
Definition: sprk_publish.h:139
Definition: sprk_publish.h:597
HPS::Type ObjectType() const
Definition: sprk_publish.h:5120
Definition: sprk_publish.h:6809
Style
Definition: sprk_publish.h:345
Definition: sprk_publish.h:199
Definition: sprk_publish.h:280
Definition: sprk_publish.h:6271
Definition: sprk_publish.h:6066
HPS::Type ObjectType() const
Definition: sprk_publish.h:613
Definition: sprk_publish.h:5104
HPS::Type ObjectType() const
Definition: sprk_publish.h:2759
HPS::Type ObjectType() const
Definition: sprk_publish.h:5736
Thickness
Definition: sprk_publish.h:519
Definition: sprk_publish.h:3280
HPS::Type ObjectType() const
Definition: sprk_publish.h:3732
Type
Definition: sprk_publish.h:90
HPS::Type ObjectType() const
Definition: sprk_publish.h:4807
SourceType
Definition: sprk_publish.h:150
Definition: sprk_publish.h:543
HPS::Type ObjectType() const
Definition: sprk_publish.h:6287
Format
Definition: sprk_publish.h:144
Definition: sprk_publish.h:310
Preference
Definition: sprk_publish.h:480
Name
Definition: sprk_publish.h:327
Format
Definition: sprk_publish.h:397
Definition: sprk_publish.h:514
HPS::Type ObjectType() const
Definition: sprk_publish.h:953
Definition: sprk_publish.h:253
HPS::Type ObjectType() const
Definition: sprk_publish.h:3157
Language
Definition: sprk_publish.h:360
Definition: sprk_publish.h:928
Definition: sprk_publish.h:471
When
Definition: sprk_publish.h:222
Style
Definition: sprk_publish.h:528
When
Definition: sprk_publish.h:240
HPS::Type ObjectType() const
Definition: sprk_publish.h:2985
HPS::Type ObjectType() const
Definition: sprk_publish.h:5461
Definition: sprk_publish.h:2278
HPS::Type ObjectType() const
Definition: sprk_publish.h:3579
Version
Definition: sprk_publish.h:187
Definition: sprk_publish.h:3392
HPS::Type ObjectType() const
Definition: sprk_publish.h:3296