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, Allocator<PageKit>> PageKitArray;
67 typedef std::vector<AnnotationKit, Allocator<AnnotationKit>> AnnotationKitArray;
68 typedef std::vector<ViewKit, Allocator<ViewKit>> ViewKitArray;
69 typedef std::vector<TextKit, Allocator<TextKit>> TextKitArray;
70 typedef std::vector<ImageKit, Allocator<ImageKit>> ImageKitArray;
71 typedef std::vector<TableKit, Allocator<TableKit>> TableKitArray;
72 typedef std::vector<LinkKit, Allocator<LinkKit>> LinkKitArray;
73 typedef std::vector<ButtonKit, Allocator<ButtonKit>> ButtonKitArray;
74 typedef std::vector<CheckBoxKit, Allocator<CheckBoxKit>> CheckBoxKitArray;
75 typedef std::vector<RadioButtonKit, Allocator<RadioButtonKit>> RadioButtonKitArray;
76 typedef std::vector<ListBoxKit, Allocator<ListBoxKit>> ListBoxKitArray;
77 typedef std::vector<DropDownListKit, Allocator<DropDownListKit>> DropDownListKitArray;
78 typedef std::vector<SignatureFieldKit, Allocator<SignatureFieldKit>> SignatureFieldKitArray;
79 typedef std::vector<TextFieldKit, Allocator<TextFieldKit>> TextFieldKitArray;
80 typedef std::vector<SlideTableKit, Allocator<SlideTableKit>> SlideTableKitArray;
101 typedef std::vector<Source::Type, Allocator<Source::Type> > SourceTypeArray;
285 TransparentWireframe,
286 TransparentBoundingBox,
287 TransparentBoundingBoxOutline,
329 HelveticaBoldOblique,
374 CounterClockwise90Degrees,
375 CounterClockwise180Degrees,
376 CounterClockwise270Degrees,
442 typedef std::vector<Field::Type, Allocator<Field::Type>> FieldTypeArray;
586 typedef std::vector<Permission::Type, Allocator<Permission::Type> > PermissionTypeArray;
660 DocumentKit & SetInformation(
char const * in_title,
char const * in_author,
char const * in_subject,
char const * in_creator);
666 DocumentKit & SetPasswords(
char const * in_user_password,
char const * in_owner_password);
673 DocumentKit & AddJavaScript(
char const * in_script_name,
char const * in_source,
Source::Type in_type = Source::Type::Code);
688 DocumentKit & AddJavaScript(UTF8Array
const & in_script_names, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
694 DocumentKit & AddAttachment(
char const * in_filename,
char const * in_description);
701 DocumentKit & AddAttachments(
size_t in_count,
UTF8 const in_filenames[],
UTF8 const in_descriptions[]);
707 DocumentKit & AddAttachments(UTF8Array
const & in_filenames, UTF8Array
const & in_descriptions);
726 DocumentKit & AddIconImages(UTF8Array
const & in_names, ImageKitArray
const & in_images);
751 DocumentKit & SetPages(PageKitArray
const & in_pages);
764 DocumentKit & AddPages(PageKitArray
const & in_pages);
775 DocumentKit & SetPermissions(PermissionTypeArray
const & in_permissions);
789 DocumentKit & UnsetJavaScript(
char const * in_script_name);
795 DocumentKit & UnsetJavaScript(
size_t in_count,
UTF8 const in_script_names[]);
800 DocumentKit & UnsetJavaScript(UTF8Array
const & in_script_names);
809 DocumentKit & UnsetAttachment(
char const * in_filename);
815 DocumentKit & UnsetAttachments(
size_t in_count,
UTF8 const in_filenames[]);
820 DocumentKit & UnsetAttachments(UTF8Array
const & in_filenames);
829 DocumentKit & UnsetIconImage(
char const * in_name);
840 DocumentKit & UnsetIconImages(UTF8Array
const & in_names);
855 DocumentKit & UnsetPages(
size_t in_count,
size_t const in_indices[]);
860 DocumentKit & UnsetPages(SizeTArray
const & in_indices);
881 bool ShowInformation(
UTF8 & out_title,
UTF8 & out_author,
UTF8 & out_subject,
UTF8 & out_creator)
const;
887 bool ShowPasswords(
UTF8 & out_user_password,
UTF8 & out_owner_password)
const;
895 bool ShowJavaScript(UTF8Array & out_script_names, UTF8Array & out_sources, SourceTypeArray & out_types)
const;
901 bool ShowAttachments(UTF8Array & out_filenames, UTF8Array & out_descriptions)
const;
907 bool ShowIconImages(UTF8Array & out_names, ImageKitArray & out_images)
const;
912 bool ShowPages(PageKitArray & out_pages)
const;
917 bool ShowPermissions(PermissionTypeArray & out_permissions)
const;
934 PageKit(
char const * in_filename);
955 void Set(
PageKit const & in_kit);
959 void Show(
PageKit & out_kit)
const;
978 bool Equals(
PageKit const & in_kit)
const;
983 bool operator==(
PageKit const & in_kit)
const;
988 bool operator!=(
PageKit const & in_kit)
const;
1026 PageKit & SetAnnotations(AnnotationKitArray
const & in_annotations, IntRectangleArray
const & in_locations);
1039 PageKit & AddAnnotations(AnnotationKitArray
const & in_annotations, IntRectangleArray
const & in_locations);
1064 PageKit & SetText(TextKitArray
const & in_text, IntRectangleArray
const & in_locations);
1077 PageKit & AddText(TextKitArray
const & in_text, IntRectangleArray
const & in_locations);
1102 PageKit & SetImages(ImageKitArray
const & in_images, IntRectangleArray
const & in_locations);
1115 PageKit & AddImages(ImageKitArray
const & in_images, IntRectangleArray
const & in_locations);
1140 PageKit & SetTables(TableKitArray
const & in_tables, IntRectangleArray
const & in_locations);
1153 PageKit & AddTables(TableKitArray
const & in_tables, IntRectangleArray
const & in_locations);
1178 PageKit & SetLinks(LinkKitArray
const & in_links, IntRectangleArray
const & in_locations);
1191 PageKit & AddLinks(LinkKitArray
const & in_links, IntRectangleArray
const & in_locations);
1216 PageKit & SetButtons(ButtonKitArray
const & in_buttons, IntRectangleArray
const & in_locations);
1229 PageKit & AddButtons(ButtonKitArray
const & in_buttons, IntRectangleArray
const & in_locations);
1254 PageKit & SetTextFields(TextFieldKitArray
const & in_text_fields, IntRectangleArray
const & in_locations);
1267 PageKit & AddTextFields(TextFieldKitArray
const & in_text_fields, IntRectangleArray
const & in_locations);
1292 PageKit & SetSlideTables(SlideTableKitArray
const & in_slide_tables, IntRectangleArray
const & in_locations);
1305 PageKit & AddSlideTables(SlideTableKitArray
const & in_slide_tables, IntRectangleArray
const & in_locations);
1330 PageKit & SetCheckBoxes(CheckBoxKitArray
const & in_checkbox, IntRectangleArray
const & in_locations);
1343 PageKit & AddCheckBoxes(CheckBoxKitArray
const & in_checkbox, IntRectangleArray
const & in_locations);
1368 PageKit & SetRadioButtons(RadioButtonKitArray
const & in_radio_buttons, IntRectangleArray
const & in_locations);
1381 PageKit & AddRadioButtons(RadioButtonKitArray
const & in_radio_buttons, IntRectangleArray
const & in_locations);
1406 PageKit & SetListBoxes(ListBoxKitArray
const & in_list_box, IntRectangleArray
const & in_locations);
1419 PageKit & AddListBoxes(ListBoxKitArray
const & in_list_box, IntRectangleArray
const & in_locations);
1444 PageKit & SetDropDownLists(DropDownListKitArray
const & in_drop_down_list, IntRectangleArray
const & in_locations);
1457 PageKit & AddDropDownLists(DropDownListKitArray
const & in_drop_down_list, IntRectangleArray
const & in_locations);
1482 PageKit & SetSignatureFields(SignatureFieldKitArray
const & in_signature_field, IntRectangleArray
const & in_locations);
1495 PageKit & AddSignatureFields(SignatureFieldKitArray
const & in_signature_field, IntRectangleArray
const & in_locations);
1500 PageKit & SetTemplateFile(
char const * in_filename);
1522 PageKit & SetAnnotationsByField(UTF8Array
const & in_fields, AnnotationKitArray
const & in_annotations);
1529 PageKit & SetButtonIconByField(
char const * in_field,
ImageKit const & in_image);
1537 PageKit & SetButtonIconsByField(
size_t in_count,
UTF8 const in_fields[],
ImageKit const in_images[]);
1544 PageKit & SetButtonIconsByField(UTF8Array
const & in_fields, ImageKitArray
const & in_images);
1551 PageKit & SetButtonLabelByField(
char const * in_field,
char const * in_label);
1559 PageKit & SetButtonLabelsByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_labels[]);
1566 PageKit & SetButtonLabelsByField(UTF8Array
const & in_fields, UTF8Array
const & in_labels);
1574 PageKit & SetListItemByField(
char const * in_field,
char const * in_value,
char const * in_export_value);
1582 PageKit & AddListItemByField(
char const * in_field,
char const * in_value,
char const * in_export_value);
1591 PageKit & SetListItemsByField(
char const * in_field,
size_t in_count,
UTF8 const in_values[],
UTF8 const in_export_values[]);
1599 PageKit & SetListItemsByField(
char const * in_field, UTF8Array
const & in_values, UTF8Array
const & in_export_values);
1608 PageKit & AddListItemsByField(
char const * in_field,
size_t in_count,
UTF8 const in_values[],
UTF8 const in_export_values[]);
1616 PageKit & AddListItemsByField(
char const * in_field, UTF8Array
const & in_values, UTF8Array
const & in_export_values);
1625 PageKit & SetJavaScriptActionByField(
char const * in_field,
char const * in_source,
Source::Type in_type = Source::Type::Code);
1635 PageKit & SetJavaScriptActionsByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_sources[],
Source::Type const in_types[]);
1644 PageKit & SetJavaScriptActionsByField(UTF8Array
const & in_fields, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
1651 PageKit & SetVisibilityByField(
char const * in_field,
bool in_state);
1659 PageKit & SetVisibilitiesByField(
size_t in_count,
UTF8 const in_fields[],
bool const in_states[]);
1666 PageKit & SetVisibilitiesByField(UTF8Array
const & in_fields, BoolArray
const & in_states);
1673 PageKit & SetTextValueByField(
char const * in_field,
char const * in_value);
1681 PageKit & SetTextValuesByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_values[]);
1688 PageKit & SetTextValuesByField(UTF8Array
const & in_fields, UTF8Array
const & in_values);
1702 PageKit & UnsetAnnotation(
size_t in_index);
1708 PageKit & UnsetAnnotations(
size_t in_count,
size_t const in_indices[]);
1713 PageKit & UnsetAnnotations(SizeTArray
const & in_indices);
1722 PageKit & UnsetText(
size_t in_index);
1728 PageKit & UnsetText(
size_t in_count,
size_t const in_indices[]);
1733 PageKit & UnsetText(SizeTArray
const & in_indices);
1742 PageKit & UnsetCheckBox(
size_t in_index);
1748 PageKit & UnsetCheckBoxes(
size_t in_count,
size_t const in_indices[]);
1753 PageKit & UnsetCheckBoxes(SizeTArray
const & in_indices);
1762 PageKit & UnsetRadioButton(
size_t in_index);
1768 PageKit & UnsetRadioButtons(
size_t in_count,
size_t const in_indices[]);
1773 PageKit & UnsetRadioButtons(SizeTArray
const & in_indices);
1777 PageKit & UnsetRadioButtons();
1782 PageKit & UnsetListBox(
size_t in_index);
1788 PageKit & UnsetListBoxes(
size_t in_count,
size_t const in_indices[]);
1793 PageKit & UnsetListBoxes(SizeTArray
const & in_indices);
1802 PageKit & UnsetDropDownList(
size_t in_index);
1808 PageKit & UnsetDropDownLists(
size_t in_count,
size_t const in_indices[]);
1813 PageKit & UnsetDropDownLists(SizeTArray
const & in_indices);
1817 PageKit & UnsetDropDownLists();
1822 PageKit & UnsetSignatureField(
size_t in_index);
1828 PageKit & UnsetSignatureFields(
size_t in_count,
size_t const in_indices[]);
1833 PageKit & UnsetSignatureFields(SizeTArray
const & in_indices);
1837 PageKit & UnsetSignatureFields();
1842 PageKit & UnsetImage(
size_t in_index);
1848 PageKit & UnsetImages(
size_t in_count,
size_t const in_indices[]);
1853 PageKit & UnsetImages(SizeTArray
const & in_indices);
1862 PageKit & UnsetTable(
size_t in_index);
1868 PageKit & UnsetTables(
size_t in_count,
size_t const in_indices[]);
1873 PageKit & UnsetTables(SizeTArray
const & in_indices);
1882 PageKit & UnsetLink(
size_t in_index);
1888 PageKit & UnsetLinks(
size_t in_count,
size_t const in_indices[]);
1893 PageKit & UnsetLinks(SizeTArray
const & in_indices);
1902 PageKit & UnsetButton(
size_t in_index);
1908 PageKit & UnsetButtons(
size_t in_count,
size_t const in_indices[]);
1913 PageKit & UnsetButtons(SizeTArray
const & in_indices);
1922 PageKit & UnsetTextField(
size_t in_index);
1928 PageKit & UnsetTextFields(
size_t in_count,
size_t const in_indices[]);
1933 PageKit & UnsetTextFields(SizeTArray
const & in_indices);
1942 PageKit & UnsetSlideTable(
size_t in_index);
1948 PageKit & UnsetSlideTables(
size_t in_count,
size_t const in_indices[]);
1953 PageKit & UnsetSlideTables(SizeTArray
const & in_indices);
1961 PageKit & UnsetTemplateFile();
1966 PageKit & UnsetAnnotationByField(
char const * in_field);
1972 PageKit & UnsetAnnotationsByField(
size_t in_count,
UTF8 const in_fields[]);
1977 PageKit & UnsetAnnotationsByField(UTF8Array
const & in_fields);
1981 PageKit & UnsetAnnotationsByField();
1986 PageKit & UnsetButtonIconByField(
char const * in_field);
1992 PageKit & UnsetButtonIconsByField(
size_t in_count,
UTF8 const in_fields[]);
1997 PageKit & UnsetButtonIconsByField(UTF8Array
const & in_fields);
2001 PageKit & UnsetButtonIconsByField();
2006 PageKit & UnsetButtonLabelByField(
char const * in_field);
2012 PageKit & UnsetButtonLabelsByField(
size_t in_count,
UTF8 const in_fields[]);
2017 PageKit & UnsetButtonLabelsByField(UTF8Array
const & in_fields);
2021 PageKit & UnsetButtonLabelsByField();
2027 PageKit & UnsetListItemByField(
char const * in_field,
size_t in_index);
2034 PageKit & UnsetListItemsByField(
char const * in_field,
size_t in_count,
size_t const in_indices[]);
2040 PageKit & UnsetListItemsByField(
char const * in_field, SizeTArray
const & in_indices);
2045 PageKit & UnsetListItemsByField(
char const * in_field);
2051 PageKit & UnsetListItemsByField(
size_t in_count,
UTF8 const in_fields[]);
2056 PageKit & UnsetListItemsByField(UTF8Array
const & in_fields);
2060 PageKit & UnsetListItemsByField();
2065 PageKit & UnsetJavaScriptActionByField(
char const * in_field);
2071 PageKit & UnsetJavaScriptActionsByField(
size_t in_count,
UTF8 const in_fields[]);
2076 PageKit & UnsetJavaScriptActionsByField(UTF8Array
const & in_fields);
2080 PageKit & UnsetJavaScriptActionsByField();
2085 PageKit & UnsetVisibilityByField(
char const * in_field);
2091 PageKit & UnsetVisibilitiesByField(
size_t in_count,
UTF8 const in_fields[]);
2096 PageKit & UnsetVisibilitiesByField(UTF8Array
const & in_fields);
2100 PageKit & UnsetVisibilitiesByField();
2105 PageKit & UnsetTextValueByField(
char const * in_field);
2111 PageKit & UnsetTextValuesByField(
size_t in_count,
UTF8 const in_fields[]);
2116 PageKit & UnsetTextValuesByField(UTF8Array
const & in_fields);
2120 PageKit & UnsetTextValuesByField();
2141 bool ShowAnnotations(AnnotationKitArray & out_annotations, IntRectangleArray & out_locations)
const;
2147 bool ShowText(TextKitArray & out_text, IntRectangleArray & out_locations)
const;
2153 bool ShowImages(ImageKitArray & out_images, IntRectangleArray & out_locations)
const;
2159 bool ShowTables(TableKitArray & out_tables, IntRectangleArray & out_locations)
const;
2165 bool ShowLinks(LinkKitArray & out_links, IntRectangleArray & out_locations)
const;
2171 bool ShowButtons(ButtonKitArray & out_buttons, IntRectangleArray & out_locations)
const;
2177 bool ShowCheckBoxes(CheckBoxKitArray & out_check_boxes, IntRectangleArray & out_locations)
const;
2183 bool ShowRadioButtons(RadioButtonKitArray & out_radio_buttons, IntRectangleArray & out_locations)
const;
2189 bool ShowListBoxes(ListBoxKitArray & out_list_boxes, IntRectangleArray & out_locations)
const;
2195 bool ShowDropDownLists(DropDownListKitArray & out_drop_down_lists, IntRectangleArray & out_locations)
const;
2201 bool ShowSignatureFields(SignatureFieldKitArray & out_signature_fields, IntRectangleArray & out_locations)
const;
2207 bool ShowTextFields(TextFieldKitArray & out_text_fields, IntRectangleArray & out_locations)
const;
2213 bool ShowSlideTables(SlideTableKitArray & out_slide_tables, IntRectangleArray & out_locations)
const;
2218 bool ShowTemplateFile(
UTF8 & out_filename)
const;
2224 bool ShowAnnotationsByField(UTF8Array & out_fields, AnnotationKitArray & out_annotations)
const;
2230 bool ShowButtonIconsByField(UTF8Array & out_fields, ImageKitArray & out_images)
const;
2236 bool ShowButtonLabelsByField(UTF8Array & out_fields, UTF8Array & out_labels)
const;
2241 bool ShowListItemFields(UTF8Array & out_fields)
const;
2248 bool ShowListItemsByField(
char const * in_field, UTF8Array & out_values, UTF8Array & out_export_values)
const;
2255 bool ShowJavaScriptActionsByField(UTF8Array & out_fields, UTF8Array & out_sources, SourceTypeArray & out_types)
const;
2261 bool ShowVisibilitiesByField(UTF8Array & out_fields, BoolArray & out_states)
const;
2267 bool ShowTextValuesByField(UTF8Array & out_fields, UTF8Array & out_values)
const;
2350 AnnotationKit & SetPRCTessellationCompression(
bool in_state);
2455 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);
2463 AnnotationKit & SetCarouselButtons(UTF8Array
const & in_button_names,
char const * in_previous_button_name,
char const * in_next_button_name,
size_t in_scroll_size);
2472 AnnotationKit & SetCarouselViews(
size_t in_count,
size_t const in_indices[],
ImageKit const in_images[] =
nullptr);
2480 AnnotationKit & SetCarouselViews(SizeTArray
const & in_indices, ImageKitArray
const & in_images = ImageKitArray());
2593 bool ShowPRCTessellationCompression(
bool & out_state)
const;
2603 bool ShowPRCBRepRemoval(
bool & out_state)
const;
2608 bool ShowPRCAttributeRemoval(
bool & out_state)
const;
2618 bool ShowU3DCompression(
unsigned char & out_level)
const;
2623 bool ShowName(
UTF8 & out_name)
const;
2628 bool ShowArtwork(
ArtworkKit & out_artwork)
const;
2643 bool ShowToolbarVisibility(
bool & out_state)
const;
2648 bool ShowModelTreeVisibility(
bool & out_state)
const;
2653 bool ShowInteractivity(
bool & out_state)
const;
2658 bool ShowBorderWidth(
int & out_width)
const;
2663 bool ShowTransparentBackground(
bool & out_state)
const;
2668 bool ShowBackgroundColor(
RGBColor & out_color)
const;
2683 bool ShowPosterImage(
ImageKit & out_image)
const;
2691 bool ShowCarouselButtons(UTF8Array & out_button_names,
UTF8 & out_previous_button_name,
UTF8 & out_next_button_name,
size_t & out_scroll_size)
const;
2697 bool ShowCarouselViews(SizeTArray & out_indices, ImageKitArray & out_images)
const;
2749 bool Equals(
ArtworkKit const & in_kit)
const;
2754 bool operator==(
ArtworkKit const & in_kit)
const;
2759 bool operator!=(
ArtworkKit const & in_kit)
const;
2776 ArtworkKit & SetPMICrossHighlighting(
bool in_state);
2781 ArtworkKit & SetPMISemanticInformation(
bool in_state);
2812 ArtworkKit & SetViews(ViewKitArray
const & in_views);
2823 ArtworkKit & AddViews(ViewKitArray
const & in_views);
2864 ArtworkKit & UnsetViews(
size_t in_count,
size_t const in_indices[]);
2869 ArtworkKit & UnsetViews(SizeTArray
const & in_indices);
2898 bool ShowPMICrossHighlighting(
bool & out_state)
const;
2903 bool ShowPMISemanticInformation(
bool & out_state)
const;
2918 bool ShowViews(ViewKitArray & out_views)
const;
2923 bool ShowPMIColor(
RGBColor & out_pmi_color)
const;
2952 void Set(
ViewKit const & in_kit);
2956 void Show(
ViewKit & out_kit)
const;
2975 bool Equals(
ViewKit const & in_kit)
const;
2980 bool operator==(
ViewKit const & in_kit)
const;
2985 bool operator!=(
ViewKit const & in_kit)
const;
2991 ViewKit & SetInternalName(
char const * in_name);
2996 ViewKit & SetExternalName(
char const * in_name);
3011 ViewKit & SetDefault(
bool in_state);
3031 ViewKit & UnsetInternalName();
3035 ViewKit & UnsetExternalName();
3047 ViewKit & UnsetBackgroundColor();
3065 bool ShowInternalName(
UTF8 & out_name)
const;
3070 bool ShowExternalName(
UTF8 & out_name)
const;
3075 bool ShowCamera(
CameraKit & out_camera)
const;
3080 bool ShowDefault(
bool & out_state)
const;
3085 bool ShowBackgroundColor(
RGBColor & out_color)
const;
3124 void Set(
TextKit const & in_kit);
3128 void Show(
TextKit & out_kit)
const;
3147 bool Equals(
TextKit const & in_kit)
const;
3152 bool operator==(
TextKit const & in_kit)
const;
3157 bool operator!=(
TextKit const & in_kit)
const;
3164 TextKit & SetText(
char const * in_text);
3182 TextKit & SetSize(
int in_size);
3215 bool ShowText(
UTF8 & out_text)
const;
3229 bool ShowSize(
int & out_size)
const;
3234 bool ShowColor(
RGBColor & out_color)
const;
3264 void Show(
ImageKit & out_kit)
const;
3283 bool Equals(
ImageKit const & in_kit)
const;
3288 bool operator==(
ImageKit const & in_kit)
const;
3293 bool operator!=(
ImageKit const & in_kit)
const;
3299 ImageKit & SetFile(
char const * in_filename);
3306 ImageKit & SetSize(
int in_width,
int in_height);
3334 bool ShowFile(
UTF8 & out_filename)
const;
3340 bool ShowSize(
int & out_width,
int & out_height)
const;
3376 void Show(
TableKit & out_kit)
const;
3395 bool Equals(
TableKit const & in_kit)
const;
3400 bool operator==(
TableKit const & in_kit)
const;
3405 bool operator!=(
TableKit const & in_kit)
const;
3425 TableKit & SetLink(
int in_row,
int in_column,
LinkKit const & in_link);
3432 TableKit & SetText(
int in_row,
int in_column,
TextKit const & in_text);
3459 TableKit & UnsetLink(
int in_row,
int in_column);
3463 TableKit & UnsetText(
int in_row,
int in_column);
3467 TableKit & UnsetButton(
int in_row,
int in_column);
3471 TableKit & UnsetTextField(
int in_row,
int in_column);
3495 bool ShowLink(
int in_row,
int in_column,
LinkKit & out_link)
const;
3502 bool ShowText(
int in_row,
int in_column,
TextKit & out_text)
const;
3509 bool ShowButton(
int in_row,
int in_column,
ButtonKit & out_button)
const;
3516 bool ShowTextField(
int in_row,
int in_column,
TextFieldKit & out_text_field)
const;
3595 SlideTableKit & SetButtons(
char const * in_previous_button_name,
char const * in_next_button_name);
3609 SlideTableKit & SetText(
size_t in_rows,
size_t in_columns, TextFieldKitArray
const & in_text);
3658 bool ShowButtons(
UTF8 & out_previous_button_name,
UTF8 & out_next_button_name)
const;
3665 bool ShowText(
size_t & out_rows,
size_t & out_columns, TextFieldKitArray & out_text)
const;
3670 bool ShowHeader(
bool & out_state)
const;
3696 void Set(
LinkKit const & in_kit);
3700 void Show(
LinkKit & out_kit)
const;
3719 bool Equals(
LinkKit const & in_kit)
const;
3724 bool operator==(
LinkKit const & in_kit)
const;
3729 bool operator!=(
LinkKit const & in_kit)
const;
3736 LinkKit & SetJavaScript(
char const * in_source,
Source::Type in_type = Source::Type::Code);
3741 LinkKit & SetBorderWidth(
int in_width);
3764 LinkKit & UnsetHighlighting();
3784 bool ShowBorderWidth(
int & out_width)
const;
3794 bool ShowBorderColor(
RGBColor & out_color)
const;
3846 bool Equals(
ButtonKit const & in_kit)
const;
3851 bool operator==(
ButtonKit const & in_kit)
const;
3856 bool operator!=(
ButtonKit const & in_kit)
const;
3862 ButtonKit & SetName(
char const * in_name);
3867 ButtonKit & SetLabel(
char const * in_label);
3893 ButtonKit & SetTooltip(
char const * in_tooltip);
3898 ButtonKit & SetVisibility(
bool in_state);
3903 ButtonKit & SetPrintability(
bool in_state);
4037 bool ShowName(
UTF8 & out_name)
const;
4042 bool ShowLabel(
UTF8 & out_label)
const;
4055 bool ShowFontSize(
int & out_size)
const;
4060 bool ShowTextColor(
RGBColor & out_color)
const;
4065 bool ShowTooltip(
UTF8 & out_tooltip)
const;
4070 bool ShowVisibility(
bool & out_state)
const;
4075 bool ShowPrintability(
bool & out_state)
const;
4085 bool ShowLock(
bool & out_state)
const;
4090 bool ShowBorder(
bool & out_state)
const;
4095 bool ShowBorderColor(
RGBColor & out_color)
const;
4110 bool ShowFillColor(
RGBColor & out_color)
const;
4125 bool ShowIconImage(
ImageKit & out_image)
const;
4182 bool operator==(
CheckBoxKit const & in_kit)
const;
4187 bool operator!=(
CheckBoxKit const & in_kit)
const;
4219 CheckBoxKit & SetTooltip(
char const * in_tooltip);
4270 CheckBoxKit & SetExportValue(
char const * in_export_value);
4350 bool ShowName(
UTF8 & out_name)
const;
4363 bool ShowFontSize(
int & out_size)
const;
4368 bool ShowTextColor(
RGBColor & out_color)
const;
4373 bool ShowTooltip(
UTF8 & out_tooltip)
const;
4378 bool ShowVisibility(
bool & out_state)
const;
4383 bool ShowPrintability(
bool & out_state)
const;
4393 bool ShowLock(
bool & out_state)
const;
4398 bool ShowBorder(
bool & out_state)
const;
4403 bool ShowBorderColor(
RGBColor & out_color)
const;
4418 bool ShowFillColor(
RGBColor & out_color)
const;
4423 bool ShowExportValue(
UTF8 & out_export_value)
const;
4428 bool ShowDefaultState(
bool & out_default_state)
const;
4662 bool ShowName(
UTF8 & out_name)
const;
4675 bool ShowFontSize(
int & out_size)
const;
4680 bool ShowTextColor(
RGBColor & out_color)
const;
4685 bool ShowTooltip(
UTF8 & out_tooltip)
const;
4690 bool ShowVisibility(
bool & out_state)
const;
4695 bool ShowPrintability(
bool & out_state)
const;
4705 bool ShowLock(
bool & out_state)
const;
4710 bool ShowBorder(
bool & out_state)
const;
4715 bool ShowBorderColor(
RGBColor & out_color)
const;
4730 bool ShowFillColor(
RGBColor & out_color)
const;
4735 bool ShowExportValue(
UTF8 & out_export_value)
const;
4740 bool ShowDefaultState(
bool & out_default_state)
const;
4745 bool ShowGrouping(
bool & out_grouping)
const;
4797 bool Equals(
ListBoxKit const & in_kit)
const;
4802 bool operator==(
ListBoxKit const & in_kit)
const;
4807 bool operator!=(
ListBoxKit const & in_kit)
const;
4839 ListBoxKit & SetTooltip(
char const * in_tooltip);
4890 ListBoxKit & SetMultipleSelection(
bool in_state);
4897 ListBoxKit & SetContents(UTF8Array
const & in_displayed_values, UTF8Array
const & in_export_values);
4904 ListBoxKit & SetContents(
size_t in_count,
UTF8 const in_displayed_values[],
UTF8 const in_export_values[]);
4979 bool ShowName(
UTF8 & out_name)
const;
4992 bool ShowFontSize(
int & out_size)
const;
4997 bool ShowTextColor(
RGBColor & out_color)
const;
5002 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5007 bool ShowVisibility(
bool & out_state)
const;
5012 bool ShowPrintability(
bool & out_state)
const;
5022 bool ShowLock(
bool & out_state)
const;
5027 bool ShowBorder(
bool & out_state)
const;
5032 bool ShowBorderColor(
RGBColor & out_color)
const;
5047 bool ShowFillColor(
RGBColor & out_color)
const;
5052 bool ShowMultipleSelection(
bool & out_state)
const;
5058 bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values)
const;
5220 DropDownListKit & SetContents(UTF8Array
const & in_displayed_values, UTF8Array
const & in_export_values);
5227 DropDownListKit & SetContents(
size_t in_count,
UTF8 const in_displayed_values[],
UTF8 const in_export_values[]);
5310 bool ShowName(
UTF8 & out_name)
const;
5323 bool ShowFontSize(
int & out_size)
const;
5328 bool ShowTextColor(
RGBColor & out_color)
const;
5333 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5338 bool ShowVisibility(
bool & out_state)
const;
5343 bool ShowPrintability(
bool & out_state)
const;
5353 bool ShowLock(
bool & out_state)
const;
5358 bool ShowBorder(
bool & out_state)
const;
5363 bool ShowBorderColor(
RGBColor & out_color)
const;
5378 bool ShowFillColor(
RGBColor & out_color)
const;
5383 bool ShowCustomText(
bool & out_state)
const;
5388 bool ShowSpellChecking(
bool & out_state)
const;
5393 bool ShowImmediateCommit(
bool & out_state)
const;
5399 bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values)
const;
5419 Type
ObjectType()
const {
return Type::PublishSignatureFieldKit; }
5606 bool ShowName(
UTF8 & out_name)
const;
5619 bool ShowFontSize(
int & out_size)
const;
5624 bool ShowTextColor(
RGBColor & out_color)
const;
5629 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5634 bool ShowVisibility(
bool & out_state)
const;
5639 bool ShowPrintability(
bool & out_state)
const;
5649 bool ShowLock(
bool & out_state)
const;
5654 bool ShowBorder(
bool & out_state)
const;
5659 bool ShowBorderColor(
RGBColor & out_color)
const;
5674 bool ShowFillColor(
RGBColor & out_color)
const;
5927 bool ShowName(
UTF8 & out_name)
const;
5940 bool ShowFontSize(
int & out_size)
const;
5945 bool ShowTextColor(
RGBColor & out_color)
const;
5950 bool ShowTooltip(
UTF8 & out_tooltip)
const;
5955 bool ShowVisibility(
bool & out_state)
const;
5960 bool ShowPrintability(
bool & out_state)
const;
5970 bool ShowLock(
bool & out_state)
const;
5975 bool ShowBorder(
bool & out_state)
const;
5980 bool ShowBorderColor(
RGBColor & out_color)
const;
5995 bool ShowFillColor(
RGBColor & out_color)
const;
6000 bool ShowDefaultValue(
UTF8 & out_value)
const;
6010 bool ShowMultiline(
bool & out_state)
const;
6015 bool ShowScrolling(
bool & out_state)
const;
6020 bool ShowReadOnly(
bool & out_state)
const;
6067 bool operator!=(
DocumentKey const & in_that)
const;
6072 bool operator==(
DocumentKey const & in_that)
const;
6097 DocumentKey & AddPages(PageKitArray
const & in_pages);
6108 DocumentKey & SetInformation(
char const * in_title,
char const * in_author,
char const * in_subject,
char const * in_creator);
6114 DocumentKey & SetPasswords(
char const * in_user_password,
char const * in_owner_password);
6121 DocumentKey & AddJavaScript(
char const * in_script_name,
char const * in_source,
Source::Type in_type = Source::Type::Code);
6136 DocumentKey & AddJavaScript(UTF8Array
const & in_script_names, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
6142 DocumentKey & AddAttachment(
char const * in_filename,
char const * in_description);
6149 DocumentKey & AddAttachments(
size_t in_count,
UTF8 const in_filenames[],
UTF8 const in_descriptions[]);
6155 DocumentKey & AddAttachments(UTF8Array
const & in_filenames, UTF8Array
const & in_descriptions);
6174 DocumentKey & AddIconImages(UTF8Array
const & in_names, ImageKitArray
const & in_images);
6185 DocumentKey & SetPermissions(PermissionTypeArray
const & in_permissions);
6189 size_t GetPageCount()
const;
6200 DocumentKey & RemovePages(
size_t in_start,
size_t in_count);
6206 DocumentKey & RemovePages(
size_t in_count,
size_t const in_indices[]);
6211 DocumentKey & RemovePages(SizeTArray
const & in_indices);
6225 PageControl const GetPageControl(
size_t in_index)
const;
6275 PageControl & AddAnnotations(AnnotationKitArray
const & in_annotations, IntRectangleArray
const & in_locations);
6294 PageControl & AddText(TextKitArray
const & in_text, IntRectangleArray
const & in_locations);
6313 PageControl & AddImages(ImageKitArray
const & in_images, IntRectangleArray
const & in_locations);
6332 PageControl & AddTables(TableKitArray
const & in_tables, IntRectangleArray
const & in_locations);
6351 PageControl & AddLinks(LinkKitArray
const & in_links, IntRectangleArray
const & in_locations);
6370 PageControl & AddButtons(ButtonKitArray
const & in_buttons, IntRectangleArray
const & in_locations);
6389 PageControl & AddTextFields(TextFieldKitArray
const & in_text_fields, IntRectangleArray
const & in_locations);
6408 PageControl & AddSlideTables(SlideTableKitArray
const & in_slide_tables, IntRectangleArray
const & in_locations);
6427 PageControl & AddCheckBoxes(CheckBoxKitArray
const & in_check_boxes, IntRectangleArray
const & in_locations);
6446 PageControl & AddRadioButtons(RadioButtonKitArray
const & in_radio_buttons, IntRectangleArray
const & in_locations);
6465 PageControl & AddListBoxes(ListBoxKitArray
const & in_list_boxes, IntRectangleArray
const & in_locations);
6484 PageControl & AddDropDownLists(DropDownListKitArray
const & in_drop_down_lists, IntRectangleArray
const & in_locations);
6503 PageControl & AddSignatureFields(SignatureFieldKitArray
const & in_signature_fields, IntRectangleArray
const & in_locations);
6526 PageControl & SetAnnotationsByField(UTF8Array
const & in_fields, AnnotationKitArray
const & in_annotations);
6548 PageControl & SetButtonIconsByField(UTF8Array
const & in_fields, ImageKitArray
const & in_images);
6555 PageControl & SetButtonLabelByField(
char const * in_field,
char const * in_label);
6563 PageControl & SetButtonLabelsByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_labels[]);
6570 PageControl & SetButtonLabelsByField(UTF8Array
const & in_fields, UTF8Array
const & in_labels);
6578 PageControl & AddListItemByField(
char const * in_field,
char const * in_value,
char const * in_export_value);
6587 PageControl & AddListItemsByField(
char const * in_field,
size_t in_count,
UTF8 const in_values[],
UTF8 const in_export_values[]);
6595 PageControl & AddListItemsByField(
char const * in_field, UTF8Array
const & in_values, UTF8Array
const & in_export_values);
6604 PageControl & SetJavaScriptActionByField(
char const * in_field,
char const * in_source,
Source::Type in_type = Source::Type::Code);
6623 PageControl & SetJavaScriptActionsByField(UTF8Array
const & in_fields, UTF8Array
const & in_sources, SourceTypeArray
const & in_types);
6630 PageControl & SetVisibilityByField(
char const * in_field,
bool in_state);
6638 PageControl & SetVisibilitiesByField(
size_t in_count,
UTF8 const in_fields[],
bool const in_states[]);
6645 PageControl & SetVisibilitiesByField(UTF8Array
const & in_fields, BoolArray
const & in_states);
6652 PageControl & SetTextValueByField(
char const * in_field,
char const * in_value);
6660 PageControl & SetTextValuesByField(
size_t in_count,
UTF8 const in_fields[],
UTF8 const in_values[]);
6667 PageControl & SetTextValuesByField(UTF8Array
const & in_fields, UTF8Array
const & in_values);
6675 bool ShowFields(UTF8Array & out_names, IntRectangleArray & out_locations, FieldTypeArray & out_types)
const;
6679 class ExportOptionsKit;
6713 static DocumentKey CreateDocument(
char const * in_filename =
nullptr);
6719 static void Export(
DocumentKey const & in_document,
char const * in_filename);
6743 Type
ObjectType()
const {
return Type::PublishExportOptionsKit; }
6801 bool ShowDocumentToAppendTo(
UTF8 & out_filename)
const;
Mode
Definition: sprk_publish.h:278
Definition: sprk_publish.h:3099
Definition: sprk_publish.h:2701
Mode
Definition: sprk_publish.h:450
Definition: sprk_publish.h:468
Preference
Definition: sprk_publish.h:490
Type ObjectType() const
Definition: sprk_publish.h:2291
Type ObjectType() const
Definition: sprk_publish.h:3366
Definition: sprk_publish.h:156
Orientation
Definition: sprk_publish.h:127
Definition: sprk_publish.h:307
Definition: sprk_publish.h:445
Format
Definition: sprk_publish.h:109
Definition: sprk_publish.h:175
Type
Definition: sprk_publish.h:312
Definition: sprk_publish.h:5403
Mode
Definition: sprk_publish.h:251
Definition: sprk_publish.h:42
Definition: sprk_publish.h:2927
Type
Definition: sprk_publish.h:562
Style
Definition: sprk_publish.h:197
Type ObjectType() const
Definition: sprk_publish.h:6743
Definition: sprk_publish.h:4129
Definition: sprk_publish.h:228
Type ObjectType() const
Definition: sprk_publish.h:6042
Type ObjectType() const
Definition: sprk_publish.h:4145
Definition: sprk_publish.h:559
Definition: sprk_publish.h:3674
Definition: sprk_publish.h:6682
Rotation
Definition: sprk_publish.h:371
Definition: sprk_publish.h:3521
Definition: sprk_publish.h:85
Position
Definition: sprk_publish.h:541
Definition: sprk_publish.h:385
Definition: sprk_publish.h:210
Definition: sprk_publish.h:5678
Definition: sprk_publish.h:4749
Type
Definition: sprk_publish.h:425
Definition: sprk_publish.h:485
Definition: sprk_publish.h:420
Justification
Definition: hps.h:1536
Definition: sprk_publish.h:104
BRepCompression
Definition: sprk_publish.h:161
Definition: sprk_publish.h:139
Definition: sprk_publish.h:590
Type ObjectType() const
Definition: sprk_publish.h:5078
Definition: sprk_publish.h:6727
Style
Definition: sprk_publish.h:338
Definition: sprk_publish.h:192
Definition: sprk_publish.h:273
Definition: sprk_publish.h:6229
Definition: sprk_publish.h:6024
Type ObjectType() const
Definition: sprk_publish.h:606
Definition: sprk_publish.h:5062
Type ObjectType() const
Definition: sprk_publish.h:2717
Type ObjectType() const
Definition: sprk_publish.h:5694
Thickness
Definition: sprk_publish.h:512
Definition: sprk_publish.h:3238
Type ObjectType() const
Definition: sprk_publish.h:3690
Type
Definition: sprk_publish.h:90
Type ObjectType() const
Definition: sprk_publish.h:4765
Definition: sprk_publish.h:536
Type ObjectType() const
Definition: sprk_publish.h:6245
Format
Definition: sprk_publish.h:144
Definition: sprk_publish.h:303
Preference
Definition: sprk_publish.h:473
Name
Definition: sprk_publish.h:320
Format
Definition: sprk_publish.h:390
Definition: sprk_publish.h:507
Type ObjectType() const
Definition: sprk_publish.h:946
Definition: sprk_publish.h:246
Type ObjectType() const
Definition: sprk_publish.h:3115
Language
Definition: sprk_publish.h:353
Definition: sprk_publish.h:921
Definition: sprk_publish.h:464
When
Definition: sprk_publish.h:215
Style
Definition: sprk_publish.h:521
When
Definition: sprk_publish.h:233
Type ObjectType() const
Definition: sprk_publish.h:2943
Type ObjectType() const
Definition: sprk_publish.h:5419
Definition: sprk_publish.h:2271
Type ObjectType() const
Definition: sprk_publish.h:3537
Version
Definition: sprk_publish.h:180
Definition: sprk_publish.h:3350
Type ObjectType() const
Definition: sprk_publish.h:3254