sprk_publish.h
1 // Copyright (c) Tech Soft 3D, Inc.
2 //
3 // The information contained herein is confidential and proprietary to Tech Soft 3D, Inc.,
4 // and considered a trade secret as defined under civil and criminal statutes.
5 // Tech Soft 3D, Inc. shall pursue its civil and criminal remedies in the event of
6 // unauthorized use or misappropriation of its trade secrets. Use of this information
7 // by anyone other than authorized employees of Tech Soft 3D, Inc. is granted only under
8 // a written non-disclosure agreement, expressly prescribing the scope and manner of such use.
9 
10 #ifndef SPRK_PUBLISH_H
11 #define SPRK_PUBLISH_H
12 
13 #include "sprk.h"
14 
15 typedef void A3DEntity;
16 
17 #ifdef _MSC_VER
18 # ifndef STATIC_APP
19 # ifdef SPRK_PUBLISH
20 # define PUBLISH_API __declspec (dllexport)
21 # else
22 # define PUBLISH_API __declspec (dllimport)
23 # endif
24 # endif
25 #else
26 # include <stddef.h>
27 # if defined(SPRK_PUBLISH) and defined(LINUX_SYSTEM)
28 # ifndef STATIC_APP
29 # define PUBLISH_API __attribute__ ((visibility ("default")))
30 # endif
31 # endif
32 #endif
33 
34 #ifndef PUBLISH_API
35 # define PUBLISH_API
36 #endif
37 
38 namespace HPS
39 {
40 
42 class PUBLISH_API Publish
43 {
44 public:
45  class DocumentKit;
46  class PageKit;
47  class TemplateKit;
48  class AnnotationKit;
49  class ArtworkKit;
50  class ViewKit;
51  class TextKit;
52  class ImageKit;
53  class TableKit;
54  class LinkKit;
55  class ButtonKit;
56  class CheckBoxKit;
57  class RadioButtonKit;
58  class ListBoxKit;
59  class DropDownListKit;
60  class SignatureFieldKit;
61  class TextFieldKit;
62  class SlideTableKit;
63  class DocumentKey;
64  class PageControl;
65 
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;
81 
82 
83 
85  class PUBLISH_API Source
86  {
87  public:
90  enum class Type
91  {
92  Code,
93  File
94  };
95 
96  private:
98  Source();
99  };
100 
101  typedef std::vector<Source::Type, HPS::Allocator<Source::Type> > SourceTypeArray;
102 
104  class PUBLISH_API Page
105  {
106  public:
109  enum class Format
110  {
111  P11x17,
112  A3,
113  A4,
114  A5,
115  B4JIS,
116  B5JIS,
117  Executive,
118  Legal,
119  Letter,
120  Tabloid,
121  B4ISO,
122  B5ISO
123  };
124 
127  enum class Orientation
128  {
129  Portrait,
130  Landscape
131  };
132 
133  private:
135  Page();
136  };
137 
139  class PUBLISH_API Annotation
140  {
141  public:
144  enum class Format
145  {
146  PRC,
147  U3D
148  };
149 
150  enum class SourceType
151  {
152  CADModel,
153  KeyPath,
154  CADModelAndKeyPath
155  };
156 
157  private:
159  Annotation();
160  };
161 
163  class PUBLISH_API PRC
164  {
165  public:
168  enum class BRepCompression
169  {
170  None,
171  Low,
172  Medium,
173  High
174  };
175 
176  private:
178  PRC();
179  };
180 
182  class PUBLISH_API U3D
183  {
184  public:
187  enum class Version
188  {
189  ECMA1,
190  ECMA3
191  };
192 
193  private:
195  U3D();
196  };
197 
199  class PUBLISH_API Animation
200  {
201  public:
204  enum class Style
205  {
206  None,
207  Loop,
208  Bounce
209  };
210 
211  private:
213  Animation();
214  };
215 
217  class PUBLISH_API Activation
218  {
219  public:
222  enum class When
223  {
224  Explicit,
225  Opened,
226  Visible
227  };
228 
229  private:
231  Activation();
232  };
233 
235  class PUBLISH_API Deactivation
236  {
237  public:
240  enum class When
241  {
242  Explicit,
243  Closed,
244  NotVisible
245  };
246 
247  private:
249  Deactivation();
250  };
251 
253  class PUBLISH_API Lighting
254  {
255  public:
258  enum class Mode
259  {
260  Artwork,
261  None,
262  White,
263  Day,
264  Bright,
265  PrimaryColor,
266  Night,
267  Blue,
268  Red,
269  Cube,
270  CADOptimized,
271  Headlamp
272  };
273 
274  private:
276  Lighting();
277  };
278 
280  class PUBLISH_API Rendering
281  {
282  public:
285  enum class Mode
286  {
287  Solid,
288  SolidWireframe,
289  SolidOutline,
290  BoundingBox,
291  Transparent,
292  TransparentWireframe,
293  TransparentBoundingBox,
294  TransparentBoundingBoxOutline,
295  Illustration,
296  ShadedIllustration,
297  Wireframe,
298  ShadedWireframe,
299  HiddenWireframe,
300  Vertices,
301  ShadedVertices
302  };
303 
304  private:
306  Rendering();
307  };
308 
310  class PUBLISH_API Text
311  {
312  public:
314  class PUBLISH_API Font
315  {
316  public:
319  enum class Type
320  {
321  BuiltIn,
322  Explicit
323  };
324 
327  enum class Name
328  {
329  TimesRoman,
330  TimesItalic,
331  TimesBold,
332  TimesBoldItalic,
333  Helvetica,
334  HelveticaOblique,
335  HelveticaBold,
336  HelveticaBoldOblique,
337  Courier,
338  CourierOblique,
339  CourierBold,
340  CourierBoldOblique
341  };
342 
345  enum class Style
346  {
347  Regular,
348  Bold,
349  Italic,
350  BoldItalic,
351  };
352 
353  private:
355  Font();
356  };
357 
360  enum class Language
361  {
362  ASCII,
363  EastEuropeanRoman,
364  Cyrillic,
365  Greek,
366  Turkish,
367  Hebrew,
368  Arabic,
369  Baltic,
370  ChineseTraditional,
371  ChineseSimplified,
372  Japanese,
373  Korean
374  };
375 
378  enum class Rotation
379  {
380  None,
381  CounterClockwise90Degrees,
382  CounterClockwise180Degrees,
383  CounterClockwise270Degrees,
384  };
385 
386  private:
388  Text();
389  };
390 
392  class PUBLISH_API Image
393  {
394  public:
397  enum class Format
398  {
399  Unknown,
400  BMP,
401  PNG,
402  JPEG,
403  RawRGB,
404  RawRGBA,
405  RawGrey,
406  RawGreyA,
407  EMF,
408  URL,
409  GIF,
410  TIFF,
411  PCX,
412  Targa,
413  PPM,
414  ILBM,
415  CEL,
416  RGB,
417  PSD,
418  PIC
419  };
420 
421  private:
423  Image();
424  };
425 
427  class PUBLISH_API Field
428  {
429  public:
432  enum class Type
433  {
434  Text,
435  Button,
436  DropDown,
437  ListBox,
438  CheckBox,
439  RadioButton,
440  DigitalSignature,
441  BarCode
442  };
443 
444  private:
446  Field();
447  };
448 
449  typedef std::vector<Field::Type, Allocator<Field::Type>> FieldTypeArray;
450 
452  class PUBLISH_API Highlighting
453  {
454  public:
457  enum class Mode
458  {
459  None,
460  Invert,
461  Outline,
462  Push
463  };
464 
465  private:
467  Highlighting();
468  };
469 
471  class PUBLISH_API Artwork
472  {
473  public:
475  class PUBLISH_API View
476  {
477  public:
480  enum class Preference
481  {
482  Native,
483  PDF
484  };
485 
486  private:
488  View();
489  };
490 
492  class PUBLISH_API Display
493  {
494  public:
497  enum class Preference
498  {
499  Defined,
500  Runtime
501  };
502 
503  private:
505  Display();
506  };
507 
508  private:
510  Artwork();
511  };
512 
514  class PUBLISH_API Border
515  {
516  public:
519  enum class Thickness
520  {
521  Thin,
522  Medium,
523  Wide,
524  };
525 
528  enum class Style
529  {
530  Solid,
531  Dashed,
532  Beveled,
533  Inset,
534  Underlined,
535  };
536 
537  private:
539  Border();
540  };
541 
543  class PUBLISH_API Label
544  {
545  public:
548  enum class Position
549  {
550  LabelOnly,
551  IconOnly,
552  Top,
553  Bottom,
554  Left,
555  Right,
556  OnTop,
557  };
558 
559  private:
561  Label();
562  };
563 
564 
566  class PUBLISH_API Permission
567  {
568  public:
569  enum class Type
570  {
571  Open,
572  Secure,
573  Print,
574  Edit,
575  Copy,
576  EditNotes,
577  SaveAs,
578  FillAndSign,
579  Accessible,
580  Assembly,
581  HighQualityPrint,
582  Owner,
583  FormSubmit,
584  SpawnTemplate,
585  User,
586  All,
587  };
588 
589  private:
591  Permission();
592  };
593 
594  typedef std::vector<Permission::Type, HPS::Allocator<Permission::Type> > PermissionTypeArray;
595 
596 
598  class PUBLISH_API DocumentKit : public SprocketKit
599  {
600  public:
602  DocumentKit();
603 
606  DocumentKit(DocumentKit const & in_kit);
607 
610  DocumentKit(DocumentKit && in_kit);
611 
612  virtual ~DocumentKit();
613 
614  HPS::Type ObjectType() const { return HPS::Type::PublishDocumentKit; }
615 
619  static DocumentKit GetDefault();
620 
623  void Set(DocumentKit const & in_kit);
624 
627  void Show(DocumentKit & out_kit) const;
628 
632  DocumentKit & operator=(DocumentKit const & in_kit);
633 
637  DocumentKit & operator=(DocumentKit && in_kit);
638 
641  bool Empty() const;
642 
646  bool Equals(DocumentKit const & in_kit) const;
647 
651  bool operator==(DocumentKit const & in_kit) const;
652 
656  bool operator!=(DocumentKit const & in_kit) const;
657 
658 
668  DocumentKit & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
669 
674  DocumentKit & SetPasswords(char const * in_user_password, char const * in_owner_password);
675 
681  DocumentKit & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
682 
689  DocumentKit & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
690 
696  DocumentKit & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
697 
702  DocumentKit & AddAttachment(char const * in_filename, char const * in_description);
703 
709  DocumentKit & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
710 
715  DocumentKit & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
716 
721  DocumentKit & AddIconImage(char const * in_name, ImageKit const & in_image);
722 
728  DocumentKit & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
729 
734  DocumentKit & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
735 
740  DocumentKit & SetPage(PageKit const & in_page);
741 
746  DocumentKit & AddPage(PageKit const & in_page);
747 
753  DocumentKit & SetPages(size_t in_count, PageKit const in_pages[]);
754 
759  DocumentKit & SetPages(PageKitArray const & in_pages);
760 
766  DocumentKit & AddPages(size_t in_count, PageKit const in_pages[]);
767 
772  DocumentKit & AddPages(PageKitArray const & in_pages);
773 
778  DocumentKit & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
779 
783  DocumentKit & SetPermissions(PermissionTypeArray const & in_permissions);
784 
785 
788  DocumentKit & UnsetInformation();
789 
792  DocumentKit & UnsetPasswords();
793 
797  DocumentKit & UnsetJavaScript(char const * in_script_name);
798 
803  DocumentKit & UnsetJavaScript(size_t in_count, UTF8 const in_script_names[]);
804 
808  DocumentKit & UnsetJavaScript(UTF8Array const & in_script_names);
809 
812  DocumentKit & UnsetJavaScript();
813 
817  DocumentKit & UnsetAttachment(char const * in_filename);
818 
823  DocumentKit & UnsetAttachments(size_t in_count, UTF8 const in_filenames[]);
824 
828  DocumentKit & UnsetAttachments(UTF8Array const & in_filenames);
829 
832  DocumentKit & UnsetAttachments();
833 
837  DocumentKit & UnsetIconImage(char const * in_name);
838 
843  DocumentKit & UnsetIconImages(size_t in_count, UTF8 const in_names[]);
844 
848  DocumentKit & UnsetIconImages(UTF8Array const & in_names);
849 
852  DocumentKit & UnsetIconImages();
853 
857  DocumentKit & UnsetPage(size_t in_index);
858 
863  DocumentKit & UnsetPages(size_t in_count, size_t const in_indices[]);
864 
868  DocumentKit & UnsetPages(SizeTArray const & in_indices);
869 
872  DocumentKit & UnsetPages();
873 
876  DocumentKit & UnsetPermissions();
877 
880  DocumentKit & UnsetEverything();
881 
882 
889  bool ShowInformation(UTF8 & out_title, UTF8 & out_author, UTF8 & out_subject, UTF8 & out_creator) const;
890 
895  bool ShowPasswords(UTF8 & out_user_password, UTF8 & out_owner_password) const;
896 
903  bool ShowJavaScript(UTF8Array & out_script_names, UTF8Array & out_sources, SourceTypeArray & out_types) const;
904 
909  bool ShowAttachments(UTF8Array & out_filenames, UTF8Array & out_descriptions) const;
910 
915  bool ShowIconImages(UTF8Array & out_names, ImageKitArray & out_images) const;
916 
920  bool ShowPages(PageKitArray & out_pages) const;
921 
925  bool ShowPermissions(PermissionTypeArray & out_permissions) const;
926  };
927 
929  class PUBLISH_API PageKit : public SprocketKit
930  {
931  public:
933  PageKit();
934 
938  PageKit(Page::Format in_format, Page::Orientation in_orientation);
939 
942  PageKit(char const * in_filename);
943 
946  PageKit(PageKit const & in_kit);
947 
950  PageKit(PageKit && in_kit);
951 
952  virtual ~PageKit();
953 
954  HPS::Type ObjectType() const { return HPS::Type::PublishPageKit; }
955 
959  static PageKit GetDefault();
960 
963  void Set(PageKit const & in_kit);
964 
967  void Show(PageKit & out_kit) const;
968 
972  PageKit & operator=(PageKit const & in_kit);
973 
977  PageKit & operator=(PageKit && in_kit);
978 
981  bool Empty() const;
982 
986  bool Equals(PageKit const & in_kit) const;
987 
991  bool operator==(PageKit const & in_kit) const;
992 
996  bool operator!=(PageKit const & in_kit) const;
997 
998 
1003  PageKit & SetFormat(Page::Format in_format);
1004 
1009  PageKit & SetOrientation(Page::Orientation in_orientation);
1010 
1015  PageKit & SetAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
1016 
1021  PageKit & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
1022 
1028  PageKit & SetAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
1029 
1034  PageKit & SetAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
1035 
1041  PageKit & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
1042 
1047  PageKit & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
1048 
1053  PageKit & SetText(TextKit const & in_text, IntRectangle const & in_location);
1054 
1059  PageKit & AddText(TextKit const & in_text, IntRectangle const & in_location);
1060 
1066  PageKit & SetText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
1067 
1072  PageKit & SetText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
1073 
1079  PageKit & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
1080 
1085  PageKit & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
1086 
1091  PageKit & SetImage(ImageKit const & in_image, IntRectangle const & in_location);
1092 
1097  PageKit & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
1098 
1104  PageKit & SetImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
1105 
1110  PageKit & SetImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
1111 
1117  PageKit & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
1118 
1123  PageKit & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
1124 
1129  PageKit & SetTable(TableKit const & in_table, IntRectangle const & in_location);
1130 
1135  PageKit & AddTable(TableKit const & in_table, IntRectangle const & in_location);
1136 
1142  PageKit & SetTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
1143 
1148  PageKit & SetTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
1149 
1155  PageKit & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
1156 
1161  PageKit & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
1162 
1167  PageKit & SetLink(LinkKit const & in_link, IntRectangle const & in_location);
1168 
1173  PageKit & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
1174 
1180  PageKit & SetLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
1181 
1186  PageKit & SetLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
1187 
1193  PageKit & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
1194 
1199  PageKit & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
1200 
1205  PageKit & SetButton(ButtonKit const & in_button, IntRectangle const & in_location);
1206 
1211  PageKit & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
1212 
1218  PageKit & SetButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
1219 
1224  PageKit & SetButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
1225 
1231  PageKit & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
1232 
1237  PageKit & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
1238 
1243  PageKit & SetTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
1244 
1249  PageKit & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
1250 
1256  PageKit & SetTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
1257 
1262  PageKit & SetTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
1263 
1269  PageKit & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
1270 
1275  PageKit & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
1276 
1281  PageKit & SetSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
1282 
1287  PageKit & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
1288 
1294  PageKit & SetSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
1295 
1300  PageKit & SetSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
1301 
1307  PageKit & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
1308 
1313  PageKit & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
1314 
1319  PageKit & SetCheckBox(CheckBoxKit const & in_checkbox, IntRectangle const & in_location);
1320 
1325  PageKit & AddCheckBox(CheckBoxKit const & in_checkbox, IntRectangle const & in_location);
1326 
1332  PageKit & SetCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]);
1333 
1338  PageKit & SetCheckBoxes(CheckBoxKitArray const & in_checkbox, IntRectangleArray const & in_locations);
1339 
1345  PageKit & AddCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]);
1346 
1351  PageKit & AddCheckBoxes(CheckBoxKitArray const & in_checkbox, IntRectangleArray const & in_locations);
1352 
1357  PageKit & SetRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
1358 
1363  PageKit & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
1364 
1370  PageKit & SetRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
1371 
1376  PageKit & SetRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
1377 
1383  PageKit & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
1384 
1389  PageKit & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
1390 
1395  PageKit & SetListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
1396 
1401  PageKit & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
1402 
1408  PageKit & SetListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]);
1409 
1414  PageKit & SetListBoxes(ListBoxKitArray const & in_list_box, IntRectangleArray const & in_locations);
1415 
1421  PageKit & AddListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]);
1422 
1427  PageKit & AddListBoxes(ListBoxKitArray const & in_list_box, IntRectangleArray const & in_locations);
1428 
1433  PageKit & SetDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
1434 
1439  PageKit & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
1440 
1446  PageKit & SetDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]);
1447 
1452  PageKit & SetDropDownLists(DropDownListKitArray const & in_drop_down_list, IntRectangleArray const & in_locations);
1453 
1459  PageKit & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]);
1460 
1465  PageKit & AddDropDownLists(DropDownListKitArray const & in_drop_down_list, IntRectangleArray const & in_locations);
1466 
1471  PageKit & SetSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
1472 
1477  PageKit & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
1478 
1484  PageKit & SetSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]);
1485 
1490  PageKit & SetSignatureFields(SignatureFieldKitArray const & in_signature_field, IntRectangleArray const & in_locations);
1491 
1497  PageKit & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]);
1498 
1503  PageKit & AddSignatureFields(SignatureFieldKitArray const & in_signature_field, IntRectangleArray const & in_locations);
1504 
1508  PageKit & SetTemplateFile(char const * in_filename);
1509 
1515  PageKit & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
1516 
1523  PageKit & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
1524 
1530  PageKit & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
1531 
1537  PageKit & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
1538 
1545  PageKit & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
1546 
1552  PageKit & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
1553 
1559  PageKit & SetButtonLabelByField(char const * in_field, char const * in_label);
1560 
1567  PageKit & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
1568 
1574  PageKit & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
1575 
1582  PageKit & SetListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
1583 
1590  PageKit & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
1591 
1599  PageKit & SetListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
1600 
1607  PageKit & SetListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
1608 
1616  PageKit & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
1617 
1624  PageKit & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
1625 
1633  PageKit & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
1634 
1643  PageKit & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
1644 
1652  PageKit & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
1653 
1659  PageKit & SetVisibilityByField(char const * in_field, bool in_state);
1660 
1667  PageKit & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
1668 
1674  PageKit & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
1675 
1681  PageKit & SetTextValueByField(char const * in_field, char const * in_value);
1682 
1689  PageKit & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
1690 
1696  PageKit & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
1697 
1698 
1701  PageKit & UnsetFormat();
1702 
1705  PageKit & UnsetOrientation();
1706 
1710  PageKit & UnsetAnnotation(size_t in_index);
1711 
1716  PageKit & UnsetAnnotations(size_t in_count, size_t const in_indices[]);
1717 
1721  PageKit & UnsetAnnotations(SizeTArray const & in_indices);
1722 
1725  PageKit & UnsetAnnotations();
1726 
1730  PageKit & UnsetText(size_t in_index);
1731 
1736  PageKit & UnsetText(size_t in_count, size_t const in_indices[]);
1737 
1741  PageKit & UnsetText(SizeTArray const & in_indices);
1742 
1745  PageKit & UnsetText();
1746 
1750  PageKit & UnsetCheckBox(size_t in_index);
1751 
1756  PageKit & UnsetCheckBoxes(size_t in_count, size_t const in_indices[]);
1757 
1761  PageKit & UnsetCheckBoxes(SizeTArray const & in_indices);
1762 
1765  PageKit & UnsetCheckBoxes();
1766 
1770  PageKit & UnsetRadioButton(size_t in_index);
1771 
1776  PageKit & UnsetRadioButtons(size_t in_count, size_t const in_indices[]);
1777 
1781  PageKit & UnsetRadioButtons(SizeTArray const & in_indices);
1782 
1785  PageKit & UnsetRadioButtons();
1786 
1790  PageKit & UnsetListBox(size_t in_index);
1791 
1796  PageKit & UnsetListBoxes(size_t in_count, size_t const in_indices[]);
1797 
1801  PageKit & UnsetListBoxes(SizeTArray const & in_indices);
1802 
1805  PageKit & UnsetListBoxes();
1806 
1810  PageKit & UnsetDropDownList(size_t in_index);
1811 
1816  PageKit & UnsetDropDownLists(size_t in_count, size_t const in_indices[]);
1817 
1821  PageKit & UnsetDropDownLists(SizeTArray const & in_indices);
1822 
1825  PageKit & UnsetDropDownLists();
1826 
1830  PageKit & UnsetSignatureField(size_t in_index);
1831 
1836  PageKit & UnsetSignatureFields(size_t in_count, size_t const in_indices[]);
1837 
1841  PageKit & UnsetSignatureFields(SizeTArray const & in_indices);
1842 
1845  PageKit & UnsetSignatureFields();
1846 
1850  PageKit & UnsetImage(size_t in_index);
1851 
1856  PageKit & UnsetImages(size_t in_count, size_t const in_indices[]);
1857 
1861  PageKit & UnsetImages(SizeTArray const & in_indices);
1862 
1865  PageKit & UnsetImages();
1866 
1870  PageKit & UnsetTable(size_t in_index);
1871 
1876  PageKit & UnsetTables(size_t in_count, size_t const in_indices[]);
1877 
1881  PageKit & UnsetTables(SizeTArray const & in_indices);
1882 
1885  PageKit & UnsetTables();
1886 
1890  PageKit & UnsetLink(size_t in_index);
1891 
1896  PageKit & UnsetLinks(size_t in_count, size_t const in_indices[]);
1897 
1901  PageKit & UnsetLinks(SizeTArray const & in_indices);
1902 
1905  PageKit & UnsetLinks();
1906 
1910  PageKit & UnsetButton(size_t in_index);
1911 
1916  PageKit & UnsetButtons(size_t in_count, size_t const in_indices[]);
1917 
1921  PageKit & UnsetButtons(SizeTArray const & in_indices);
1922 
1925  PageKit & UnsetButtons();
1926 
1930  PageKit & UnsetTextField(size_t in_index);
1931 
1936  PageKit & UnsetTextFields(size_t in_count, size_t const in_indices[]);
1937 
1941  PageKit & UnsetTextFields(SizeTArray const & in_indices);
1942 
1945  PageKit & UnsetTextFields();
1946 
1950  PageKit & UnsetSlideTable(size_t in_index);
1951 
1956  PageKit & UnsetSlideTables(size_t in_count, size_t const in_indices[]);
1957 
1961  PageKit & UnsetSlideTables(SizeTArray const & in_indices);
1962 
1965  PageKit & UnsetSlideTables();
1966 
1969  PageKit & UnsetTemplateFile();
1970 
1974  PageKit & UnsetAnnotationByField(char const * in_field);
1975 
1980  PageKit & UnsetAnnotationsByField(size_t in_count, UTF8 const in_fields[]);
1981 
1985  PageKit & UnsetAnnotationsByField(UTF8Array const & in_fields);
1986 
1989  PageKit & UnsetAnnotationsByField();
1990 
1994  PageKit & UnsetButtonIconByField(char const * in_field);
1995 
2000  PageKit & UnsetButtonIconsByField(size_t in_count, UTF8 const in_fields[]);
2001 
2005  PageKit & UnsetButtonIconsByField(UTF8Array const & in_fields);
2006 
2009  PageKit & UnsetButtonIconsByField();
2010 
2014  PageKit & UnsetButtonLabelByField(char const * in_field);
2015 
2020  PageKit & UnsetButtonLabelsByField(size_t in_count, UTF8 const in_fields[]);
2021 
2025  PageKit & UnsetButtonLabelsByField(UTF8Array const & in_fields);
2026 
2029  PageKit & UnsetButtonLabelsByField();
2030 
2035  PageKit & UnsetListItemByField(char const * in_field, size_t in_index);
2036 
2042  PageKit & UnsetListItemsByField(char const * in_field, size_t in_count, size_t const in_indices[]);
2043 
2048  PageKit & UnsetListItemsByField(char const * in_field, SizeTArray const & in_indices);
2049 
2053  PageKit & UnsetListItemsByField(char const * in_field);
2054 
2059  PageKit & UnsetListItemsByField(size_t in_count, UTF8 const in_fields[]);
2060 
2064  PageKit & UnsetListItemsByField(UTF8Array const & in_fields);
2065 
2068  PageKit & UnsetListItemsByField();
2069 
2073  PageKit & UnsetJavaScriptActionByField(char const * in_field);
2074 
2079  PageKit & UnsetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[]);
2080 
2084  PageKit & UnsetJavaScriptActionsByField(UTF8Array const & in_fields);
2085 
2088  PageKit & UnsetJavaScriptActionsByField();
2089 
2093  PageKit & UnsetVisibilityByField(char const * in_field);
2094 
2099  PageKit & UnsetVisibilitiesByField(size_t in_count, UTF8 const in_fields[]);
2100 
2104  PageKit & UnsetVisibilitiesByField(UTF8Array const & in_fields);
2105 
2108  PageKit & UnsetVisibilitiesByField();
2109 
2113  PageKit & UnsetTextValueByField(char const * in_field);
2114 
2119  PageKit & UnsetTextValuesByField(size_t in_count, UTF8 const in_fields[]);
2120 
2124  PageKit & UnsetTextValuesByField(UTF8Array const & in_fields);
2125 
2128  PageKit & UnsetTextValuesByField();
2129 
2132  PageKit & UnsetEverything();
2133 
2134 
2138  bool ShowFormat(Page::Format & out_format) const;
2139 
2143  bool ShowOrientation(Page::Orientation & out_orientation) const;
2144 
2149  bool ShowAnnotations(AnnotationKitArray & out_annotations, IntRectangleArray & out_locations) const;
2150 
2155  bool ShowText(TextKitArray & out_text, IntRectangleArray & out_locations) const;
2156 
2161  bool ShowImages(ImageKitArray & out_images, IntRectangleArray & out_locations) const;
2162 
2167  bool ShowTables(TableKitArray & out_tables, IntRectangleArray & out_locations) const;
2168 
2173  bool ShowLinks(LinkKitArray & out_links, IntRectangleArray & out_locations) const;
2174 
2179  bool ShowButtons(ButtonKitArray & out_buttons, IntRectangleArray & out_locations) const;
2180 
2185  bool ShowCheckBoxes(CheckBoxKitArray & out_check_boxes, IntRectangleArray & out_locations) const;
2186 
2191  bool ShowRadioButtons(RadioButtonKitArray & out_radio_buttons, IntRectangleArray & out_locations) const;
2192 
2197  bool ShowListBoxes(ListBoxKitArray & out_list_boxes, IntRectangleArray & out_locations) const;
2198 
2203  bool ShowDropDownLists(DropDownListKitArray & out_drop_down_lists, IntRectangleArray & out_locations) const;
2204 
2209  bool ShowSignatureFields(SignatureFieldKitArray & out_signature_fields, IntRectangleArray & out_locations) const;
2210 
2215  bool ShowTextFields(TextFieldKitArray & out_text_fields, IntRectangleArray & out_locations) const;
2216 
2221  bool ShowSlideTables(SlideTableKitArray & out_slide_tables, IntRectangleArray & out_locations) const;
2222 
2226  bool ShowTemplateFile(UTF8 & out_filename) const;
2227 
2232  bool ShowAnnotationsByField(UTF8Array & out_fields, AnnotationKitArray & out_annotations) const;
2233 
2238  bool ShowButtonIconsByField(UTF8Array & out_fields, ImageKitArray & out_images) const;
2239 
2244  bool ShowButtonLabelsByField(UTF8Array & out_fields, UTF8Array & out_labels) const;
2245 
2249  bool ShowListItemFields(UTF8Array & out_fields) const;
2250 
2256  bool ShowListItemsByField(char const * in_field, UTF8Array & out_values, UTF8Array & out_export_values) const;
2257 
2263  bool ShowJavaScriptActionsByField(UTF8Array & out_fields, UTF8Array & out_sources, SourceTypeArray & out_types) const;
2264 
2269  bool ShowVisibilitiesByField(UTF8Array & out_fields, BoolArray & out_states) const;
2270 
2275  bool ShowTextValuesByField(UTF8Array & out_fields, UTF8Array & out_values) const;
2276  };
2277 
2279  class PUBLISH_API AnnotationKit : public SprocketKit
2280  {
2281  public:
2283  AnnotationKit();
2284 
2287  AnnotationKit(AnnotationKit const & in_kit);
2288 
2291  AnnotationKit(AnnotationKit && in_kit);
2292 
2293  virtual ~AnnotationKit();
2294 
2295  HPS::Type ObjectType() const { return HPS::Type::PublishAnnotationKit; }
2296 
2300  static AnnotationKit GetDefault();
2301 
2304  void Set(AnnotationKit const & in_kit);
2305 
2308  void Show(AnnotationKit & out_kit) const;
2309 
2313  AnnotationKit & operator=(AnnotationKit const & in_kit);
2314 
2318  AnnotationKit & operator=(AnnotationKit && in_kit);
2319 
2322  bool Empty() const;
2323 
2327  bool Equals(AnnotationKit const & in_kit) const;
2328 
2332  bool operator==(AnnotationKit const & in_kit) const;
2333 
2337  bool operator!=(AnnotationKit const & in_kit) const;
2338 
2339 
2344  AnnotationKit & SetSource(CADModel const & in_cad_model);
2345 
2350  AnnotationKit & SetSource(KeyPathArray const & in_sources);
2351 
2357  AnnotationKit & SetSource(size_t in_count, KeyPath const in_sources[]);
2358 
2363  AnnotationKit & SetSource(KeyPath const & in_source);
2364 
2371  AnnotationKit & SetSource(CADModel const & in_cad_model, KeyPathArray const & in_additional_sources);
2372 
2380  AnnotationKit & SetSource(CADModel const & in_cad_model, size_t in_count, KeyPath const in_additional_sources []);
2381 
2385  AnnotationKit & SetFormat(Annotation::Format in_format);
2386 
2391  AnnotationKit & SetPRCTessellationCompression(bool in_state);
2392 
2397  AnnotationKit & SetPRCBRepCompression(PRC::BRepCompression in_level);
2398 
2403  AnnotationKit & SetPRCBRepRemoval(bool in_state);
2404 
2409  AnnotationKit & SetPRCAttributeRemoval(bool in_state);
2410 
2415  AnnotationKit & SetU3DVersion(U3D::Version in_version);
2416 
2421  AnnotationKit & SetU3DCompression(unsigned char in_level);
2422 
2426  AnnotationKit & SetName(char const * in_name);
2427 
2431  AnnotationKit & SetArtwork(ArtworkKit const & in_artwork);
2432 
2436  AnnotationKit & SetActivation(Activation::When in_when);
2437 
2441  AnnotationKit & SetDeactivation(Deactivation::When in_when);
2442 
2446  AnnotationKit & SetToolbarVisibility(bool in_state);
2447 
2451  AnnotationKit & SetModelTreeVisibility(bool in_state);
2452 
2456  AnnotationKit & SetInteractivity(bool in_state);
2457 
2461  AnnotationKit & SetBorderWidth(int in_width);
2462 
2467  AnnotationKit & SetTransparentBackground(bool in_state);
2468 
2472  AnnotationKit & SetBackgroundColor(RGBColor const & in_color);
2473 
2477  AnnotationKit & SetLighting(Lighting::Mode in_mode);
2478 
2482  AnnotationKit & SetRendering(Rendering::Mode in_mode);
2483 
2487  AnnotationKit & SetPosterImage(ImageKit const & in_image);
2488 
2496  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);
2497 
2504  AnnotationKit & SetCarouselButtons(UTF8Array const & in_button_names, char const * in_previous_button_name, char const * in_next_button_name, size_t in_scroll_size);
2505 
2513  AnnotationKit & SetCarouselViews(size_t in_count, size_t const in_indices[], ImageKit const in_images[] = nullptr);
2514 
2521  AnnotationKit & SetCarouselViews(SizeTArray const & in_indices, ImageKitArray const & in_images = ImageKitArray());
2522 
2539  AnnotationKit & SetPartsList(size_t in_rows, IntRectangle const & in_location, UTF8Array const & in_headers = UTF8Array(), FloatArray const & in_columns = FloatArray(), TextFieldKit const & in_text_style = TextFieldKit(), TextFieldKit const & in_header_text_style = TextFieldKit());
2540 
2541 #ifndef HPS_GULP_CLANG
2542 
2558  AnnotationKit & SetPartsList(size_t in_rows, IntRectangle const & in_location, char const * in_headers[3], float const in_columns[3], TextFieldKit const & in_text_style = TextFieldKit(), TextFieldKit const & in_header_text_style = TextFieldKit());
2559 #endif
2560 
2565  AnnotationKit & SetViewListByField(char const * in_field);
2566 
2573  AnnotationKit & SetViewList(IntRectangle const & in_location, HPS::Publish::ListBoxKit const & in_list);
2574 
2581  AnnotationKit & SetPMIListByField(char const * in_field);
2582 
2590  AnnotationKit & SetPMIList(IntRectangle const & in_location, HPS::Publish::ListBoxKit const & in_list);
2591 
2594  AnnotationKit & UnsetSource();
2595 
2598  AnnotationKit & UnsetFormat();
2599 
2602  AnnotationKit & UnsetPRCTessellationCompression();
2603 
2606  AnnotationKit & UnsetPRCBRepCompression();
2607 
2610  AnnotationKit & UnsetPRCBRepRemoval();
2611 
2614  AnnotationKit & UnsetPRCAttributeRemoval();
2615 
2618  AnnotationKit & UnsetU3DVersion();
2619 
2622  AnnotationKit & UnsetU3DCompression();
2623 
2626  AnnotationKit & UnsetName();
2627 
2630  AnnotationKit & UnsetArtwork();
2631 
2634  AnnotationKit & UnsetActivation();
2635 
2638  AnnotationKit & UnsetDeactivation();
2639 
2642  AnnotationKit & UnsetToolbarVisibility();
2643 
2646  AnnotationKit & UnsetModelTreeVisibility();
2647 
2650  AnnotationKit & UnsetInteractivity();
2651 
2654  AnnotationKit & UnsetBorderWidth();
2655 
2658  AnnotationKit & UnsetTransparentBackground();
2659 
2662  AnnotationKit & UnsetBackgroundColor();
2663 
2666  AnnotationKit & UnsetLighting();
2667 
2670  AnnotationKit & UnsetRendering();
2671 
2674  AnnotationKit & UnsetPosterImage();
2675 
2678  AnnotationKit & UnsetCarouselButtons();
2679 
2682  AnnotationKit & UnsetCarouselViews();
2683 
2686  AnnotationKit & UnsetPartsList();
2687 
2690  AnnotationKit & UnsetViewList();
2691 
2694  AnnotationKit & UnsetPMIList();
2695 
2698  AnnotationKit & UnsetEverything();
2699 
2700 
2706  bool ShowSource(Annotation::SourceType & out_source_type, CADModel & out_cad_model, KeyPathArray & out_key_paths) const;
2707 
2711  bool ShowFormat(Annotation::Format & out_format) const;
2712 
2716  bool ShowPRCTessellationCompression(bool & out_state) const;
2717 
2721  bool ShowPRCBRepCompression(PRC::BRepCompression & out_level) const;
2722 
2726  bool ShowPRCBRepRemoval(bool & out_state) const;
2727 
2731  bool ShowPRCAttributeRemoval(bool & out_state) const;
2732 
2736  bool ShowU3DVersion(U3D::Version & out_version) const;
2737 
2741  bool ShowU3DCompression(unsigned char & out_level) const;
2742 
2746  bool ShowName(UTF8 & out_name) const;
2747 
2751  bool ShowArtwork(ArtworkKit & out_artwork) const;
2752 
2756  bool ShowActivation(Activation::When & out_when) const;
2757 
2761  bool ShowDeactivation(Deactivation::When & out_when) const;
2762 
2766  bool ShowToolbarVisibility(bool & out_state) const;
2767 
2771  bool ShowModelTreeVisibility(bool & out_state) const;
2772 
2776  bool ShowInteractivity(bool & out_state) const;
2777 
2781  bool ShowBorderWidth(int & out_width) const;
2782 
2786  bool ShowTransparentBackground(bool & out_state) const;
2787 
2791  bool ShowBackgroundColor(RGBColor & out_color) const;
2792 
2796  bool ShowLighting(Lighting::Mode & out_mode) const;
2797 
2801  bool ShowRendering(Rendering::Mode & out_mode) const;
2802 
2806  bool ShowPosterImage(ImageKit & out_image) const;
2807 
2814  bool ShowCarouselButtons(UTF8Array & out_button_names, UTF8 & out_previous_button_name, UTF8 & out_next_button_name, size_t & out_scroll_size) const;
2815 
2820  bool ShowCarouselViews(SizeTArray & out_indices, ImageKitArray & out_images) const;
2821 
2830  bool ShowPartsList(size_t & out_rows, IntRectangle & out_location, UTF8Array & out_headers, FloatArray & out_columns, TextFieldKit & out_text_style, TextFieldKit & out_header_text_style) const;
2831 
2835  bool ShowViewListField(UTF8 & out_field) const;
2836 
2841  bool ShowViewList(IntRectangle & out_location, Publish::ListBoxKit & out_list) const;
2842 
2846  bool ShowPMIListField(UTF8 & out_field) const;
2847 
2852  bool ShowPMIList(IntRectangle & out_location, Publish::ListBoxKit & out_list) const;
2853  };
2854 
2856  class PUBLISH_API ArtworkKit : public SprocketKit
2857  {
2858  public:
2860  ArtworkKit();
2861 
2864  ArtworkKit(ArtworkKit const & in_kit);
2865 
2868  ArtworkKit(ArtworkKit && in_kit);
2869 
2870  virtual ~ArtworkKit();
2871 
2872  HPS::Type ObjectType() const { return HPS::Type::PublishArtworkKit; }
2873 
2877  static ArtworkKit GetDefault();
2878 
2881  void Set(ArtworkKit const & in_kit);
2882 
2885  void Show(ArtworkKit & out_kit) const;
2886 
2890  ArtworkKit & operator=(ArtworkKit const & in_kit);
2891 
2895  ArtworkKit & operator=(ArtworkKit && in_kit);
2896 
2899  bool Empty() const;
2900 
2904  bool Equals(ArtworkKit const & in_kit) const;
2905 
2909  bool operator==(ArtworkKit const & in_kit) const;
2910 
2914  bool operator!=(ArtworkKit const & in_kit) const;
2915 
2916 
2920  ArtworkKit & SetAnimationStyle(Animation::Style in_style);
2921 
2926  ArtworkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
2927 
2931  ArtworkKit & SetPMICrossHighlighting(bool in_state);
2932 
2936  ArtworkKit & SetPMISemanticInformation(bool in_state);
2937 
2941  ArtworkKit & SetDefaultViewPreference(Artwork::View::Preference in_preference);
2942 
2946  ArtworkKit & SetDisplayPreference(Artwork::Display::Preference in_preference);
2947 
2951  ArtworkKit & SetView(ViewKit const & in_view);
2952 
2956  ArtworkKit & AddView(ViewKit const & in_view);
2957 
2962  ArtworkKit & SetViews(size_t in_count, ViewKit const in_views[]);
2963 
2967  ArtworkKit & SetViews(ViewKitArray const & in_views);
2968 
2973  ArtworkKit & AddViews(size_t in_count, ViewKit const in_views[]);
2974 
2978  ArtworkKit & AddViews(ViewKitArray const & in_views);
2979 
2983  ArtworkKit & SetPMIColor(HPS::RGBColor const & in_pmi_color);
2984 
2985 
2988  ArtworkKit & UnsetAnimationStyle();
2989 
2992  ArtworkKit & UnsetJavaScript();
2993 
2996  ArtworkKit & UnsetPMICrossHighlighting();
2997 
3000  ArtworkKit & UnsetPMISemanticInformation();
3001 
3004  ArtworkKit & UnsetDefaultViewPreference();
3005 
3008  ArtworkKit & UnsetDisplayPreference();
3009 
3013  ArtworkKit & UnsetView(size_t in_index);
3014 
3019  ArtworkKit & UnsetViews(size_t in_count, size_t const in_indices[]);
3020 
3024  ArtworkKit & UnsetViews(SizeTArray const & in_indices);
3025 
3028  ArtworkKit & UnsetViews();
3029 
3032  ArtworkKit & UnsetPMIColor();
3033 
3036  ArtworkKit & UnsetEverything();
3037 
3038 
3042  bool ShowAnimationStyle(Animation::Style & out_style) const;
3043 
3048  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
3049 
3053  bool ShowPMICrossHighlighting(bool & out_state) const;
3054 
3058  bool ShowPMISemanticInformation(bool & out_state) const;
3059 
3063  bool ShowDefaultViewPreference(Artwork::View::Preference & out_preference) const;
3064 
3068  bool ShowDisplayPreference(Artwork::Display::Preference & out_preference) const;
3069 
3073  bool ShowViews(ViewKitArray & out_views) const;
3074 
3078  bool ShowPMIColor(HPS::RGBColor & out_pmi_color) const;
3079  };
3080 
3082  class PUBLISH_API ViewKit : public SprocketKit
3083  {
3084  public:
3086  ViewKit();
3087 
3090  ViewKit(ViewKit const & in_kit);
3091 
3094  ViewKit(ViewKit && in_kit);
3095 
3096  virtual ~ViewKit();
3097 
3098  HPS::Type ObjectType() const { return HPS::Type::PublishViewKit; }
3099 
3103  static ViewKit GetDefault();
3104 
3107  void Set(ViewKit const & in_kit);
3108 
3111  void Show(ViewKit & out_kit) const;
3112 
3116  ViewKit & operator=(ViewKit const & in_kit);
3117 
3121  ViewKit & operator=(ViewKit && in_kit);
3122 
3125  bool Empty() const;
3126 
3130  bool Equals(ViewKit const & in_kit) const;
3131 
3135  bool operator==(ViewKit const & in_kit) const;
3136 
3140  bool operator!=(ViewKit const & in_kit) const;
3141 
3142 
3146  ViewKit & SetInternalName(char const * in_name);
3147 
3151  ViewKit & SetExternalName(char const * in_name);
3152 
3161  ViewKit & SetCamera(CameraKit const & in_camera);
3162 
3166  ViewKit & SetDefault(bool in_state);
3167 
3171  ViewKit & SetBackgroundColor(RGBColor const & in_color);
3172 
3176  ViewKit & SetLighting(Lighting::Mode in_mode);
3177 
3181  ViewKit & SetRendering(Rendering::Mode in_mode);
3182 
3183 
3186  ViewKit & UnsetInternalName();
3187 
3190  ViewKit & UnsetExternalName();
3191 
3194  ViewKit & UnsetCamera();
3195 
3198  ViewKit & UnsetDefault();
3199 
3202  ViewKit & UnsetBackgroundColor();
3203 
3206  ViewKit & UnsetLighting();
3207 
3210  ViewKit & UnsetRendering();
3211 
3214  ViewKit & UnsetEverything();
3215 
3216 
3220  bool ShowInternalName(UTF8 & out_name) const;
3221 
3225  bool ShowExternalName(UTF8 & out_name) const;
3226 
3230  bool ShowCamera(CameraKit & out_camera) const;
3231 
3235  bool ShowDefault(bool & out_state) const;
3236 
3240  bool ShowBackgroundColor(RGBColor & out_color) const;
3241 
3245  bool ShowLighting(Lighting::Mode & out_mode) const;
3246 
3250  bool ShowRendering(Rendering::Mode & out_mode) const;
3251  };
3252 
3254  class PUBLISH_API TextKit : public SprocketKit
3255  {
3256  public:
3258  TextKit();
3259 
3262  TextKit(TextKit const & in_kit);
3263 
3266  TextKit(TextKit && in_kit);
3267 
3268  virtual ~TextKit();
3269 
3270  HPS::Type ObjectType() const { return HPS::Type::PublishTextKit; }
3271 
3275  static TextKit GetDefault();
3276 
3279  void Set(TextKit const & in_kit);
3280 
3283  void Show(TextKit & out_kit) const;
3284 
3288  TextKit & operator=(TextKit const & in_kit);
3289 
3293  TextKit & operator=(TextKit && in_kit);
3294 
3297  bool Empty() const;
3298 
3302  bool Equals(TextKit const & in_kit) const;
3303 
3307  bool operator==(TextKit const & in_kit) const;
3308 
3312  bool operator!=(TextKit const & in_kit) const;
3313 
3314 
3319  TextKit & SetText(char const * in_text);
3320 
3324  TextKit & SetFont(Text::Font::Name in_font);
3325 
3331  TextKit & SetFont(char const * in_font_name, Text::Language in_language, bool in_embed_font);
3332 
3337  TextKit & SetSize(int in_size);
3338 
3343  TextKit & SetColor(RGBColor const & in_color);
3344 
3345 
3348  TextKit & UnsetText();
3349 
3352  TextKit & UnsetFont();
3353 
3356  TextKit & UnsetSize();
3357 
3360  TextKit & UnsetColor();
3361 
3364  TextKit & UnsetEverything();
3365 
3366 
3370  bool ShowText(UTF8 & out_text) const;
3371 
3379  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Language & out_language, bool & out_embed_font) const;
3380 
3384  bool ShowSize(int & out_size) const;
3385 
3389  bool ShowColor(RGBColor & out_color) const;
3390  };
3391 
3393  class PUBLISH_API ImageKit : public SprocketKit
3394  {
3395  public:
3397  ImageKit();
3398 
3401  ImageKit(ImageKit const & in_kit);
3402 
3405  ImageKit(ImageKit && in_kit);
3406 
3407  virtual ~ImageKit();
3408 
3409  HPS::Type ObjectType() const { return HPS::Type::PublishImageKit; }
3410 
3411  // no GetDefault() since function doesn't make sense for this class
3412 
3415  void Set(ImageKit const & in_kit);
3416 
3419  void Show(ImageKit & out_kit) const;
3420 
3424  ImageKit & operator=(ImageKit const & in_kit);
3425 
3429  ImageKit & operator=(ImageKit && in_kit);
3430 
3433  bool Empty() const;
3434 
3438  bool Equals(ImageKit const & in_kit) const;
3439 
3443  bool operator==(ImageKit const & in_kit) const;
3444 
3448  bool operator!=(ImageKit const & in_kit) const;
3449 
3450 
3454  ImageKit & SetFile(char const * in_filename);
3455 
3461  ImageKit & SetSize(int in_width, int in_height);
3462 
3466  ImageKit & SetFormat(Image::Format in_format);
3467 
3468 
3471  ImageKit & UnsetFile();
3472 
3475  ImageKit & UnsetSize();
3476 
3479  ImageKit & UnsetFormat();
3480 
3483  ImageKit & UnsetEverything();
3484 
3485 
3489  bool ShowFile(UTF8 & out_filename) const;
3490 
3495  bool ShowSize(int & out_width, int & out_height) const;
3496 
3500  bool ShowFormat(Image::Format & out_format) const;
3501  };
3502 
3505  class PUBLISH_API TableKit : public SprocketKit
3506  {
3507  public:
3509  TableKit();
3510 
3513  TableKit(TableKit const & in_kit);
3514 
3517  TableKit(TableKit && in_kit);
3518 
3519  virtual ~TableKit();
3520 
3521  HPS::Type ObjectType() const { return HPS::Type::PublishTableKit; }
3522 
3523  // no GetDefault() since function doesn't make sense for this class
3524 
3527  void Set(TableKit const & in_kit);
3528 
3531  void Show(TableKit & out_kit) const;
3532 
3536  TableKit & operator=(TableKit const & in_kit);
3537 
3541  TableKit & operator=(TableKit && in_kit);
3542 
3545  bool Empty() const;
3546 
3550  bool Equals(TableKit const & in_kit) const;
3551 
3555  bool operator==(TableKit const & in_kit) const;
3556 
3560  bool operator!=(TableKit const & in_kit) const;
3561 
3562 
3567  TableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3568 
3573  TableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3574 
3580  TableKit & SetLink(int in_row, int in_column, LinkKit const & in_link);
3581 
3587  TableKit & SetText(int in_row, int in_column, TextKit const & in_text);
3588 
3594  TableKit & SetButton(int in_row, int in_column, ButtonKit const & in_button);
3595 
3601  TableKit & SetTextField(int in_row, int in_column, TextFieldKit const & in_text_field);
3602 
3603 
3606  TableKit & UnsetHTML();
3607 
3610  TableKit & UnsetHTMLStyle();
3611 
3614  TableKit & UnsetLink(int in_row, int in_column);
3615 
3618  TableKit & UnsetText(int in_row, int in_column);
3619 
3622  TableKit & UnsetButton(int in_row, int in_column);
3623 
3626  TableKit & UnsetTextField(int in_row, int in_column);
3627 
3630  TableKit & UnsetEverything();
3631 
3632 
3637  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3638 
3643  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3644 
3650  bool ShowLink(int in_row, int in_column, LinkKit & out_link) const;
3651 
3657  bool ShowText(int in_row, int in_column, TextKit & out_text) const;
3658 
3664  bool ShowButton(int in_row, int in_column, ButtonKit & out_button) const;
3665 
3671  bool ShowTextField(int in_row, int in_column, TextFieldKit & out_text_field) const;
3672  };
3673 
3676  class PUBLISH_API SlideTableKit : public SprocketKit
3677  {
3678  public:
3680  SlideTableKit();
3681 
3684  SlideTableKit(SlideTableKit const & in_kit);
3685 
3688  SlideTableKit(SlideTableKit && in_kit);
3689 
3690  virtual ~SlideTableKit();
3691 
3692  HPS::Type ObjectType() const { return HPS::Type::PublishSlideTableKit; }
3693 
3694  // no GetDefault() since function doesn't make sense for this class
3695 
3698  void Set(SlideTableKit const & in_kit);
3699 
3702  void Show(SlideTableKit & out_kit) const;
3703 
3707  SlideTableKit & operator=(SlideTableKit const & in_kit);
3708 
3712  SlideTableKit & operator=(SlideTableKit && in_kit);
3713 
3716  bool Empty() const;
3717 
3721  bool Equals(SlideTableKit const & in_kit) const;
3722 
3726  bool operator==(SlideTableKit const & in_kit) const;
3727 
3731  bool operator!=(SlideTableKit const & in_kit) const;
3732 
3733 
3738  SlideTableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3739 
3744  SlideTableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3745 
3750  SlideTableKit & SetButtons(char const * in_previous_button_name, char const * in_next_button_name);
3751 
3757  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKit const in_text[]);
3758 
3764  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKitArray const & in_text);
3765 
3769  SlideTableKit & SetHeader(bool in_state);
3770 
3771 
3774  SlideTableKit & UnsetHTML();
3775 
3778  SlideTableKit & UnsetHTMLStyle();
3779 
3782  SlideTableKit & UnsetButtons();
3783 
3786  SlideTableKit & UnsetText();
3787 
3790  SlideTableKit & UnsetHeader();
3791 
3794  SlideTableKit & UnsetEverything();
3795 
3796 
3801  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3802 
3807  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3808 
3813  bool ShowButtons(UTF8 & out_previous_button_name, UTF8 & out_next_button_name) const;
3814 
3820  bool ShowText(size_t & out_rows, size_t & out_columns, TextFieldKitArray & out_text) const;
3821 
3825  bool ShowHeader(bool & out_state) const;
3826  };
3827 
3829  class PUBLISH_API LinkKit : public SprocketKit
3830  {
3831  public:
3833  LinkKit();
3834 
3837  LinkKit(LinkKit const & in_kit);
3838 
3841  LinkKit(LinkKit && in_kit);
3842 
3843  virtual ~LinkKit();
3844 
3845  HPS::Type ObjectType() const { return HPS::Type::PublishLinkKit; }
3846 
3847  // no GetDefault() since function doesn't make sense for this class
3848 
3851  void Set(LinkKit const & in_kit);
3852 
3855  void Show(LinkKit & out_kit) const;
3856 
3860  LinkKit & operator=(LinkKit const & in_kit);
3861 
3865  LinkKit & operator=(LinkKit && in_kit);
3866 
3869  bool Empty() const;
3870 
3874  bool Equals(LinkKit const & in_kit) const;
3875 
3879  bool operator==(LinkKit const & in_kit) const;
3880 
3884  bool operator!=(LinkKit const & in_kit) const;
3885 
3886 
3891  LinkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
3892 
3896  LinkKit & SetBorderWidth(int in_width);
3897 
3901  LinkKit & SetHighlighting(Highlighting::Mode in_mode);
3902 
3906  LinkKit & SetBorderColor(RGBColor const & in_color);
3907 
3908 
3911  LinkKit & UnsetJavaScript();
3912 
3915  LinkKit & UnsetBorderWidth();
3916 
3919  LinkKit & UnsetHighlighting();
3920 
3923  LinkKit & UnsetBorderColor();
3924 
3927  LinkKit & UnsetEverything();
3928 
3929 
3934  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
3935 
3939  bool ShowBorderWidth(int & out_width) const;
3940 
3944  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
3945 
3949  bool ShowBorderColor(RGBColor & out_color) const;
3950  };
3951 
3953  class PUBLISH_API ButtonKit : public SprocketKit
3954  {
3955  public:
3957  ButtonKit();
3958 
3961  ButtonKit(ButtonKit const & in_kit);
3962 
3965  ButtonKit(ButtonKit && in_kit);
3966 
3967  virtual ~ButtonKit();
3968 
3969  HPS::Type ObjectType() const { return HPS::Type::PublishButtonKit; }
3970 
3974  static ButtonKit GetDefault();
3975 
3978  void Set(ButtonKit const & in_kit);
3979 
3982  void Show(ButtonKit & out_kit) const;
3983 
3987  ButtonKit & operator=(ButtonKit const & in_kit);
3988 
3992  ButtonKit & operator=(ButtonKit && in_kit);
3993 
3996  bool Empty() const;
3997 
4001  bool Equals(ButtonKit const & in_kit) const;
4002 
4006  bool operator==(ButtonKit const & in_kit) const;
4007 
4011  bool operator!=(ButtonKit const & in_kit) const;
4012 
4013 
4017  ButtonKit & SetName(char const * in_name);
4018 
4022  ButtonKit & SetLabel(char const * in_label);
4023 
4027  ButtonKit & SetFont(Text::Font::Name in_name);
4028 
4033  ButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4034 
4038  ButtonKit & SetFontSize(int in_size);
4039 
4043  ButtonKit & SetTextColor(RGBColor const & in_color);
4044 
4048  ButtonKit & SetTooltip(char const * in_tooltip);
4049 
4053  ButtonKit & SetVisibility(bool in_state);
4054 
4058  ButtonKit & SetPrintability(bool in_state);
4059 
4063  ButtonKit & SetTextRotation(Text::Rotation in_rotation);
4064 
4068  ButtonKit & SetLock(bool in_state);
4069 
4073  ButtonKit & SetBorder(bool in_state);
4074 
4078  ButtonKit & SetBorderColor(RGBColor const & in_color);
4079 
4083  ButtonKit & SetBorderThickness(Border::Thickness in_thickness);
4084 
4088  ButtonKit & SetBorderStyle(Border::Style in_style);
4089 
4094  ButtonKit & SetFillColor(RGBColor const & in_color);
4095 
4099  ButtonKit & SetLabelPosition(Label::Position in_position);
4100 
4104  ButtonKit & SetHighlighting(Highlighting::Mode in_mode);
4105 
4109  ButtonKit & SetIconImage(ImageKit const & in_image);
4110 
4111 
4114  ButtonKit & UnsetName();
4115 
4118  ButtonKit & UnsetLabel();
4119 
4122  ButtonKit & UnsetFont();
4123 
4126  ButtonKit & UnsetFontSize();
4127 
4130  ButtonKit & UnsetTextColor();
4131 
4134  ButtonKit & UnsetTooltip();
4135 
4138  ButtonKit & UnsetVisibility();
4139 
4142  ButtonKit & UnsetPrintability();
4143 
4146  ButtonKit & UnsetTextRotation();
4147 
4150  ButtonKit & UnsetLock();
4151 
4154  ButtonKit & UnsetBorder();
4155 
4158  ButtonKit & UnsetBorderColor();
4159 
4162  ButtonKit & UnsetBorderThickness();
4163 
4166  ButtonKit & UnsetBorderStyle();
4167 
4170  ButtonKit & UnsetFillColor();
4171 
4174  ButtonKit & UnsetLabelPosition();
4175 
4178  ButtonKit & UnsetHighlighting();
4179 
4182  ButtonKit & UnsetIconImage();
4183 
4186  ButtonKit & UnsetEverything();
4187 
4188 
4192  bool ShowName(UTF8 & out_name) const;
4193 
4197  bool ShowLabel(UTF8 & out_label) const;
4198 
4205  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4206 
4210  bool ShowFontSize(int & out_size) const;
4211 
4215  bool ShowTextColor(RGBColor & out_color) const;
4216 
4220  bool ShowTooltip(UTF8 & out_tooltip) const;
4221 
4225  bool ShowVisibility(bool & out_state) const;
4226 
4230  bool ShowPrintability(bool & out_state) const;
4231 
4235  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4236 
4240  bool ShowLock(bool & out_state) const;
4241 
4245  bool ShowBorder(bool & out_state) const;
4246 
4250  bool ShowBorderColor(RGBColor & out_color) const;
4251 
4255  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4256 
4260  bool ShowBorderStyle(Border::Style & out_style) const;
4261 
4265  bool ShowFillColor(RGBColor & out_color) const;
4266 
4270  bool ShowLabelPosition(Label::Position & out_position) const;
4271 
4275  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
4276 
4280  bool ShowIconImage(ImageKit & out_image) const;
4281  };
4282 
4284  class PUBLISH_API CheckBoxKit : public SprocketKit
4285  {
4286  public:
4288  CheckBoxKit();
4289 
4292  CheckBoxKit(CheckBoxKit const & in_kit);
4293 
4296  CheckBoxKit(CheckBoxKit && in_kit);
4297 
4298  virtual ~CheckBoxKit();
4299 
4300  HPS::Type ObjectType() const { return HPS::Type::PublishCheckBoxKit; }
4301 
4305  static CheckBoxKit GetDefault();
4306 
4309  void Set(CheckBoxKit const & in_kit);
4310 
4313  void Show(CheckBoxKit & out_kit) const;
4314 
4318  CheckBoxKit & operator=(CheckBoxKit const & in_kit);
4319 
4323  CheckBoxKit & operator=(CheckBoxKit && in_kit);
4324 
4327  bool Empty() const;
4328 
4332  bool Equals(CheckBoxKit const & in_kit) const;
4333 
4337  bool operator==(CheckBoxKit const & in_kit) const;
4338 
4342  bool operator!=(CheckBoxKit const & in_kit) const;
4343 
4344 
4348  CheckBoxKit & SetName(char const * in_name);
4349 
4353  CheckBoxKit & SetFont(Text::Font::Name in_name);
4354 
4359  CheckBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4360 
4364  CheckBoxKit & SetFontSize(int in_size);
4365 
4369  CheckBoxKit & SetTextColor(RGBColor const & in_color);
4370 
4374  CheckBoxKit & SetTooltip(char const * in_tooltip);
4375 
4379  CheckBoxKit & SetVisibility(bool in_state);
4380 
4384  CheckBoxKit & SetPrintability(bool in_state);
4385 
4389  CheckBoxKit & SetTextRotation(Text::Rotation in_rotation);
4390 
4394  CheckBoxKit & SetLock(bool in_state);
4395 
4399  CheckBoxKit & SetBorder(bool in_state);
4400 
4404  CheckBoxKit & SetBorderColor(RGBColor const & in_color);
4405 
4409  CheckBoxKit & SetBorderThickness(Border::Thickness in_thickness);
4410 
4414  CheckBoxKit & SetBorderStyle(Border::Style in_style);
4415 
4420  CheckBoxKit & SetFillColor(RGBColor const & in_color);
4421 
4425  CheckBoxKit & SetExportValue(char const * in_export_value);
4426 
4430  CheckBoxKit & SetDefaultState(bool in_state);
4431 
4432 
4435  CheckBoxKit & UnsetName();
4436 
4439  CheckBoxKit & UnsetFont();
4440 
4443  CheckBoxKit & UnsetFontSize();
4444 
4447  CheckBoxKit & UnsetTextColor();
4448 
4451  CheckBoxKit & UnsetTooltip();
4452 
4455  CheckBoxKit & UnsetVisibility();
4456 
4459  CheckBoxKit & UnsetPrintability();
4460 
4463  CheckBoxKit & UnsetTextRotation();
4464 
4467  CheckBoxKit & UnsetLock();
4468 
4471  CheckBoxKit & UnsetBorder();
4472 
4475  CheckBoxKit & UnsetBorderColor();
4476 
4479  CheckBoxKit & UnsetBorderThickness();
4480 
4483  CheckBoxKit & UnsetBorderStyle();
4484 
4487  CheckBoxKit & UnsetFillColor();
4488 
4491  CheckBoxKit & UnsetExportValue();
4492 
4495  CheckBoxKit & UnsetDefaultState();
4496 
4499  CheckBoxKit & UnsetEverything();
4500 
4501 
4505  bool ShowName(UTF8 & out_name) const;
4506 
4513  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4514 
4518  bool ShowFontSize(int & out_size) const;
4519 
4523  bool ShowTextColor(RGBColor & out_color) const;
4524 
4528  bool ShowTooltip(UTF8 & out_tooltip) const;
4529 
4533  bool ShowVisibility(bool & out_state) const;
4534 
4538  bool ShowPrintability(bool & out_state) const;
4539 
4543  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4544 
4548  bool ShowLock(bool & out_state) const;
4549 
4553  bool ShowBorder(bool & out_state) const;
4554 
4558  bool ShowBorderColor(RGBColor & out_color) const;
4559 
4563  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4564 
4568  bool ShowBorderStyle(Border::Style & out_style) const;
4569 
4573  bool ShowFillColor(RGBColor & out_color) const;
4574 
4578  bool ShowExportValue(UTF8 & out_export_value) const;
4579 
4583  bool ShowDefaultState(bool & out_default_state) const;
4584  };
4585 
4587  class PUBLISH_API RadioButtonKit : public SprocketKit
4588  {
4589  public:
4591  RadioButtonKit();
4592 
4595  RadioButtonKit(RadioButtonKit const & in_kit);
4596 
4599  RadioButtonKit(RadioButtonKit && in_kit);
4600 
4601  virtual ~RadioButtonKit();
4602 
4603  HPS::Type ObjectType() const { return HPS::Type::PublishRadioButtonKit; }
4604 
4608  static RadioButtonKit GetDefault();
4609 
4612  void Set(RadioButtonKit const & in_kit);
4613 
4616  void Show(RadioButtonKit & out_kit) const;
4617 
4621  RadioButtonKit & operator=(RadioButtonKit const & in_kit);
4622 
4626  RadioButtonKit & operator=(RadioButtonKit && in_kit);
4627 
4630  bool Empty() const;
4631 
4635  bool Equals(RadioButtonKit const & in_kit) const;
4636 
4640  bool operator==(RadioButtonKit const & in_kit) const;
4641 
4645  bool operator!=(RadioButtonKit const & in_kit) const;
4646 
4647 
4651  RadioButtonKit & SetName(char const * in_name);
4652 
4656  RadioButtonKit & SetFont(Text::Font::Name in_name);
4657 
4662  RadioButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4663 
4667  RadioButtonKit & SetFontSize(int in_size);
4668 
4672  RadioButtonKit & SetTextColor(RGBColor const & in_color);
4673 
4677  RadioButtonKit & SetTooltip(char const * in_tooltip);
4678 
4682  RadioButtonKit & SetVisibility(bool in_state);
4683 
4687  RadioButtonKit & SetPrintability(bool in_state);
4688 
4692  RadioButtonKit & SetTextRotation(Text::Rotation in_rotation);
4693 
4697  RadioButtonKit & SetLock(bool in_state);
4698 
4702  RadioButtonKit & SetBorder(bool in_state);
4703 
4707  RadioButtonKit & SetBorderColor(RGBColor const & in_color);
4708 
4712  RadioButtonKit & SetBorderThickness(Border::Thickness in_thickness);
4713 
4717  RadioButtonKit & SetBorderStyle(Border::Style in_style);
4718 
4723  RadioButtonKit & SetFillColor(RGBColor const & in_color);
4724 
4728  RadioButtonKit & SetExportValue(char const * in_export_value);
4729 
4733  RadioButtonKit & SetDefaultState(bool in_state);
4734 
4738  RadioButtonKit & SetGrouping(bool in_state);
4739 
4740 
4743  RadioButtonKit & UnsetName();
4744 
4747  RadioButtonKit & UnsetFont();
4748 
4751  RadioButtonKit & UnsetFontSize();
4752 
4755  RadioButtonKit & UnsetTextColor();
4756 
4759  RadioButtonKit & UnsetTooltip();
4760 
4763  RadioButtonKit & UnsetVisibility();
4764 
4767  RadioButtonKit & UnsetPrintability();
4768 
4771  RadioButtonKit & UnsetTextRotation();
4772 
4775  RadioButtonKit & UnsetLock();
4776 
4779  RadioButtonKit & UnsetBorder();
4780 
4783  RadioButtonKit & UnsetBorderColor();
4784 
4787  RadioButtonKit & UnsetBorderThickness();
4788 
4791  RadioButtonKit & UnsetBorderStyle();
4792 
4795  RadioButtonKit & UnsetFillColor();
4796 
4799  RadioButtonKit & UnsetExportValue();
4800 
4803  RadioButtonKit & UnsetDefaultState();
4804 
4807  RadioButtonKit & UnsetGrouping();
4808 
4811  RadioButtonKit & UnsetEverything();
4812 
4813 
4817  bool ShowName(UTF8 & out_name) const;
4818 
4825  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4826 
4830  bool ShowFontSize(int & out_size) const;
4831 
4835  bool ShowTextColor(RGBColor & out_color) const;
4836 
4840  bool ShowTooltip(UTF8 & out_tooltip) const;
4841 
4845  bool ShowVisibility(bool & out_state) const;
4846 
4850  bool ShowPrintability(bool & out_state) const;
4851 
4855  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4856 
4860  bool ShowLock(bool & out_state) const;
4861 
4865  bool ShowBorder(bool & out_state) const;
4866 
4870  bool ShowBorderColor(RGBColor & out_color) const;
4871 
4875  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4876 
4880  bool ShowBorderStyle(Border::Style & out_style) const;
4881 
4885  bool ShowFillColor(RGBColor & out_color) const;
4886 
4890  bool ShowExportValue(UTF8 & out_export_value) const;
4891 
4895  bool ShowDefaultState(bool & out_default_state) const;
4896 
4900  bool ShowGrouping(bool & out_grouping) const;
4901  };
4902 
4904  class PUBLISH_API ListBoxKit : public SprocketKit
4905  {
4906  public:
4908  ListBoxKit();
4909 
4912  ListBoxKit(ListBoxKit const & in_kit);
4913 
4916  ListBoxKit(ListBoxKit && in_kit);
4917 
4918  virtual ~ListBoxKit();
4919 
4920  HPS::Type ObjectType() const { return HPS::Type::PublishListBoxKit; }
4921 
4925  static ListBoxKit GetDefault();
4926 
4929  void Set(ListBoxKit const & in_kit);
4930 
4933  void Show(ListBoxKit & out_kit) const;
4934 
4938  ListBoxKit & operator=(ListBoxKit const & in_kit);
4939 
4943  ListBoxKit & operator=(ListBoxKit && in_kit);
4944 
4947  bool Empty() const;
4948 
4952  bool Equals(ListBoxKit const & in_kit) const;
4953 
4957  bool operator==(ListBoxKit const & in_kit) const;
4958 
4962  bool operator!=(ListBoxKit const & in_kit) const;
4963 
4964 
4968  ListBoxKit & SetName(char const * in_name);
4969 
4973  ListBoxKit & SetFont(Text::Font::Name in_name);
4974 
4979  ListBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4980 
4984  ListBoxKit & SetFontSize(int in_size);
4985 
4989  ListBoxKit & SetTextColor(RGBColor const & in_color);
4990 
4994  ListBoxKit & SetTooltip(char const * in_tooltip);
4995 
4999  ListBoxKit & SetVisibility(bool in_state);
5000 
5004  ListBoxKit & SetPrintability(bool in_state);
5005 
5009  ListBoxKit & SetTextRotation(Text::Rotation in_rotation);
5010 
5014  ListBoxKit & SetLock(bool in_state);
5015 
5019  ListBoxKit & SetBorder(bool in_state);
5020 
5024  ListBoxKit & SetBorderColor(RGBColor const & in_color);
5025 
5029  ListBoxKit & SetBorderThickness(Border::Thickness in_thickness);
5030 
5034  ListBoxKit & SetBorderStyle(Border::Style in_style);
5035 
5040  ListBoxKit & SetFillColor(RGBColor const & in_color);
5041 
5045  ListBoxKit & SetMultipleSelection(bool in_state);
5046 
5052  ListBoxKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
5053 
5059  ListBoxKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
5060 
5061 
5064  ListBoxKit & UnsetName();
5065 
5068  ListBoxKit & UnsetFont();
5069 
5072  ListBoxKit & UnsetFontSize();
5073 
5076  ListBoxKit & UnsetTextColor();
5077 
5080  ListBoxKit & UnsetTooltip();
5081 
5084  ListBoxKit & UnsetVisibility();
5085 
5088  ListBoxKit & UnsetPrintability();
5089 
5092  ListBoxKit & UnsetTextRotation();
5093 
5096  ListBoxKit & UnsetLock();
5097 
5100  ListBoxKit & UnsetBorder();
5101 
5104  ListBoxKit & UnsetBorderColor();
5105 
5108  ListBoxKit & UnsetBorderThickness();
5109 
5112  ListBoxKit & UnsetBorderStyle();
5113 
5116  ListBoxKit & UnsetFillColor();
5117 
5120  ListBoxKit & UnsetMultipleSelection();
5121 
5124  ListBoxKit & UnsetContents();
5125 
5128  ListBoxKit & UnsetEverything();
5129 
5130 
5134  bool ShowName(UTF8 & out_name) const;
5135 
5142  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5143 
5147  bool ShowFontSize(int & out_size) const;
5148 
5152  bool ShowTextColor(RGBColor & out_color) const;
5153 
5157  bool ShowTooltip(UTF8 & out_tooltip) const;
5158 
5162  bool ShowVisibility(bool & out_state) const;
5163 
5167  bool ShowPrintability(bool & out_state) const;
5168 
5172  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5173 
5177  bool ShowLock(bool & out_state) const;
5178 
5182  bool ShowBorder(bool & out_state) const;
5183 
5187  bool ShowBorderColor(RGBColor & out_color) const;
5188 
5192  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5193 
5197  bool ShowBorderStyle(Border::Style & out_style) const;
5198 
5202  bool ShowFillColor(RGBColor & out_color) const;
5203 
5207  bool ShowMultipleSelection(bool & out_state) const;
5208 
5213  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5214  };
5215 
5217  class PUBLISH_API DropDownListKit : public SprocketKit
5218  {
5219  public:
5221  DropDownListKit();
5222 
5225  DropDownListKit(DropDownListKit const & in_kit);
5226 
5229  DropDownListKit(DropDownListKit && in_kit);
5230 
5231  virtual ~DropDownListKit();
5232 
5233  HPS::Type ObjectType() const { return HPS::Type::PublishDropDownListKit; }
5234 
5238  static DropDownListKit GetDefault();
5239 
5242  void Set(DropDownListKit const & in_kit);
5243 
5246  void Show(DropDownListKit & out_kit) const;
5247 
5251  DropDownListKit & operator=(DropDownListKit const & in_kit);
5252 
5256  DropDownListKit & operator=(DropDownListKit && in_kit);
5257 
5260  bool Empty() const;
5261 
5265  bool Equals(DropDownListKit const & in_kit) const;
5266 
5270  bool operator==(DropDownListKit const & in_kit) const;
5271 
5275  bool operator!=(DropDownListKit const & in_kit) const;
5276 
5277 
5281  DropDownListKit & SetName(char const * in_name);
5282 
5286  DropDownListKit & SetFont(Text::Font::Name in_name);
5287 
5292  DropDownListKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5293 
5297  DropDownListKit & SetFontSize(int in_size);
5298 
5302  DropDownListKit & SetTextColor(RGBColor const & in_color);
5303 
5307  DropDownListKit & SetTooltip(char const * in_tooltip);
5308 
5312  DropDownListKit & SetVisibility(bool in_state);
5313 
5317  DropDownListKit & SetPrintability(bool in_state);
5318 
5322  DropDownListKit & SetTextRotation(Text::Rotation in_rotation);
5323 
5327  DropDownListKit & SetLock(bool in_state);
5328 
5332  DropDownListKit & SetBorder(bool in_state);
5333 
5337  DropDownListKit & SetBorderColor(RGBColor const & in_color);
5338 
5342  DropDownListKit & SetBorderThickness(Border::Thickness in_thickness);
5343 
5347  DropDownListKit & SetBorderStyle(Border::Style in_style);
5348 
5353  DropDownListKit & SetFillColor(RGBColor const & in_color);
5354 
5358  DropDownListKit & SetCustomText(bool in_state);
5359 
5363  DropDownListKit & SetSpellChecking(bool in_state);
5364 
5368  DropDownListKit & SetImmediateCommit(bool in_state);
5369 
5375  DropDownListKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
5376 
5382  DropDownListKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
5383 
5384 
5387  DropDownListKit & UnsetName();
5388 
5391  DropDownListKit & UnsetFont();
5392 
5395  DropDownListKit & UnsetFontSize();
5396 
5399  DropDownListKit & UnsetTextColor();
5400 
5403  DropDownListKit & UnsetTooltip();
5404 
5407  DropDownListKit & UnsetVisibility();
5408 
5411  DropDownListKit & UnsetPrintability();
5412 
5415  DropDownListKit & UnsetTextRotation();
5416 
5419  DropDownListKit & UnsetLock();
5420 
5423  DropDownListKit & UnsetBorder();
5424 
5427  DropDownListKit & UnsetBorderColor();
5428 
5431  DropDownListKit & UnsetBorderThickness();
5432 
5435  DropDownListKit & UnsetBorderStyle();
5436 
5439  DropDownListKit & UnsetFillColor();
5440 
5443  DropDownListKit & UnsetCustomText();
5444 
5447  DropDownListKit & UnsetSpellChecking();
5448 
5451  DropDownListKit & UnsetImmediateCommit();
5452 
5455  DropDownListKit & UnsetContents();
5456 
5459  DropDownListKit & UnsetEverything();
5460 
5461 
5465  bool ShowName(UTF8 & out_name) const;
5466 
5473  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5474 
5478  bool ShowFontSize(int & out_size) const;
5479 
5483  bool ShowTextColor(RGBColor & out_color) const;
5484 
5488  bool ShowTooltip(UTF8 & out_tooltip) const;
5489 
5493  bool ShowVisibility(bool & out_state) const;
5494 
5498  bool ShowPrintability(bool & out_state) const;
5499 
5503  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5504 
5508  bool ShowLock(bool & out_state) const;
5509 
5513  bool ShowBorder(bool & out_state) const;
5514 
5518  bool ShowBorderColor(RGBColor & out_color) const;
5519 
5523  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5524 
5528  bool ShowBorderStyle(Border::Style & out_style) const;
5529 
5533  bool ShowFillColor(RGBColor & out_color) const;
5534 
5538  bool ShowCustomText(bool & out_state) const;
5539 
5543  bool ShowSpellChecking(bool & out_state) const;
5544 
5548  bool ShowImmediateCommit(bool & out_state) const;
5549 
5554  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5555  };
5556 
5558  class PUBLISH_API SignatureFieldKit : public SprocketKit
5559  {
5560  public:
5563 
5566  SignatureFieldKit(SignatureFieldKit const & in_kit);
5567 
5571 
5572  virtual ~SignatureFieldKit();
5573 
5574  HPS::Type ObjectType() const { return HPS::Type::PublishSignatureFieldKit; }
5575 
5579  static SignatureFieldKit GetDefault();
5580 
5583  void Set(SignatureFieldKit const & in_kit);
5584 
5587  void Show(SignatureFieldKit & out_kit) const;
5588 
5592  SignatureFieldKit & operator=(SignatureFieldKit const & in_kit);
5593 
5597  SignatureFieldKit & operator=(SignatureFieldKit && in_kit);
5598 
5601  bool Empty() const;
5602 
5606  bool Equals(SignatureFieldKit const & in_kit) const;
5607 
5611  bool operator==(SignatureFieldKit const & in_kit) const;
5612 
5616  bool operator!=(SignatureFieldKit const & in_kit) const;
5617 
5618 
5622  SignatureFieldKit & SetName(char const * in_name);
5623 
5627  SignatureFieldKit & SetFont(Text::Font::Name in_name);
5628 
5633  SignatureFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5634 
5638  SignatureFieldKit & SetFontSize(int in_size);
5639 
5643  SignatureFieldKit & SetTextColor(RGBColor const & in_color);
5644 
5648  SignatureFieldKit & SetTooltip(char const * in_tooltip);
5649 
5653  SignatureFieldKit & SetVisibility(bool in_state);
5654 
5658  SignatureFieldKit & SetPrintability(bool in_state);
5659 
5663  SignatureFieldKit & SetTextRotation(Text::Rotation in_rotation);
5664 
5668  SignatureFieldKit & SetLock(bool in_state);
5669 
5673  SignatureFieldKit & SetBorder(bool in_state);
5674 
5678  SignatureFieldKit & SetBorderColor(RGBColor const & in_color);
5679 
5683  SignatureFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5684 
5688  SignatureFieldKit & SetBorderStyle(Border::Style in_style);
5689 
5694  SignatureFieldKit & SetFillColor(RGBColor const & in_color);
5695 
5696 
5699  SignatureFieldKit & UnsetName();
5700 
5703  SignatureFieldKit & UnsetFont();
5704 
5707  SignatureFieldKit & UnsetFontSize();
5708 
5711  SignatureFieldKit & UnsetTextColor();
5712 
5715  SignatureFieldKit & UnsetTooltip();
5716 
5719  SignatureFieldKit & UnsetVisibility();
5720 
5723  SignatureFieldKit & UnsetPrintability();
5724 
5727  SignatureFieldKit & UnsetTextRotation();
5728 
5731  SignatureFieldKit & UnsetLock();
5732 
5735  SignatureFieldKit & UnsetBorder();
5736 
5739  SignatureFieldKit & UnsetBorderColor();
5740 
5743  SignatureFieldKit & UnsetBorderThickness();
5744 
5747  SignatureFieldKit & UnsetBorderStyle();
5748 
5751  SignatureFieldKit & UnsetFillColor();
5752 
5755  SignatureFieldKit & UnsetEverything();
5756 
5757 
5761  bool ShowName(UTF8 & out_name) const;
5762 
5769  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5770 
5774  bool ShowFontSize(int & out_size) const;
5775 
5779  bool ShowTextColor(RGBColor & out_color) const;
5780 
5784  bool ShowTooltip(UTF8 & out_tooltip) const;
5785 
5789  bool ShowVisibility(bool & out_state) const;
5790 
5794  bool ShowPrintability(bool & out_state) const;
5795 
5799  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5800 
5804  bool ShowLock(bool & out_state) const;
5805 
5809  bool ShowBorder(bool & out_state) const;
5810 
5814  bool ShowBorderColor(RGBColor & out_color) const;
5815 
5819  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5820 
5824  bool ShowBorderStyle(Border::Style & out_style) const;
5825 
5829  bool ShowFillColor(RGBColor & out_color) const;
5830  };
5831 
5833  class PUBLISH_API TextFieldKit : public SprocketKit
5834  {
5835  public:
5837  TextFieldKit();
5838 
5841  TextFieldKit(TextFieldKit const & in_kit);
5842 
5845  TextFieldKit(TextFieldKit && in_kit);
5846 
5847  virtual ~TextFieldKit();
5848 
5849  HPS::Type ObjectType() const { return HPS::Type::PublishTextFieldKit; }
5850 
5854  static TextFieldKit GetDefault();
5855 
5858  void Set(TextFieldKit const & in_kit);
5859 
5862  void Show(TextFieldKit & out_kit) const;
5863 
5867  TextFieldKit & operator=(TextFieldKit const & in_kit);
5868 
5872  TextFieldKit & operator=(TextFieldKit && in_kit);
5873 
5876  bool Empty() const;
5877 
5881  bool Equals(TextFieldKit const & in_kit) const;
5882 
5886  bool operator==(TextFieldKit const & in_kit) const;
5887 
5891  bool operator!=(TextFieldKit const & in_kit) const;
5892 
5893 
5894 
5898  TextFieldKit & SetName(char const * in_name);
5899 
5903  TextFieldKit & SetFont(Text::Font::Name in_name);
5904 
5909  TextFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5910 
5914  TextFieldKit & SetFontSize(int in_size);
5915 
5919  TextFieldKit & SetTextColor(RGBColor const & in_color);
5920 
5924  TextFieldKit & SetTooltip(char const * in_tooltip);
5925 
5929  TextFieldKit & SetVisibility(bool in_state);
5930 
5934  TextFieldKit & SetPrintability(bool in_state);
5935 
5939  TextFieldKit & SetTextRotation(Text::Rotation in_rotation);
5940 
5944  TextFieldKit & SetLock(bool in_state);
5945 
5949  TextFieldKit & SetBorder(bool in_state);
5950 
5954  TextFieldKit & SetBorderColor(RGBColor const & in_color);
5955 
5959  TextFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5960 
5964  TextFieldKit & SetBorderStyle(Border::Style in_style);
5965 
5970  TextFieldKit & SetFillColor(RGBColor const & in_color);
5971 
5975  TextFieldKit & SetDefaultValue(char const * in_value);
5976 
5980  TextFieldKit & SetTextJustification(HPS::Text::Justification in_justification);
5981 
5985  TextFieldKit & SetMultiline(bool in_state);
5986 
5990  TextFieldKit & SetScrolling(bool in_state);
5991 
5995  TextFieldKit & SetReadOnly(bool in_state);
5996 
5997 
6000  TextFieldKit & UnsetName();
6001 
6004  TextFieldKit & UnsetFont();
6005 
6008  TextFieldKit & UnsetFontSize();
6009 
6012  TextFieldKit & UnsetTextColor();
6013 
6016  TextFieldKit & UnsetTooltip();
6017 
6020  TextFieldKit & UnsetVisibility();
6021 
6024  TextFieldKit & UnsetPrintability();
6025 
6028  TextFieldKit & UnsetTextRotation();
6029 
6032  TextFieldKit & UnsetLock();
6033 
6036  TextFieldKit & UnsetBorder();
6037 
6040  TextFieldKit & UnsetBorderColor();
6041 
6044  TextFieldKit & UnsetBorderThickness();
6045 
6048  TextFieldKit & UnsetBorderStyle();
6049 
6052  TextFieldKit & UnsetFillColor();
6053 
6056  TextFieldKit & UnsetDefaultValue();
6057 
6060  TextFieldKit & UnsetTextJustification();
6061 
6064  TextFieldKit & UnsetMultiline();
6065 
6068  TextFieldKit & UnsetScrolling();
6069 
6072  TextFieldKit & UnsetReadOnly();
6073 
6076  TextFieldKit & UnsetEverything();
6077 
6078 
6082  bool ShowName(UTF8 & out_name) const;
6083 
6090  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
6091 
6095  bool ShowFontSize(int & out_size) const;
6096 
6100  bool ShowTextColor(RGBColor & out_color) const;
6101 
6105  bool ShowTooltip(UTF8 & out_tooltip) const;
6106 
6110  bool ShowVisibility(bool & out_state) const;
6111 
6115  bool ShowPrintability(bool & out_state) const;
6116 
6120  bool ShowTextRotation(Text::Rotation & out_rotation) const;
6121 
6125  bool ShowLock(bool & out_state) const;
6126 
6130  bool ShowBorder(bool & out_state) const;
6131 
6135  bool ShowBorderColor(RGBColor & out_color) const;
6136 
6140  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
6141 
6145  bool ShowBorderStyle(Border::Style & out_style) const;
6146 
6150  bool ShowFillColor(RGBColor & out_color) const;
6151 
6155  bool ShowDefaultValue(UTF8 & out_value) const;
6156 
6160  bool ShowTextJustification(HPS::Text::Justification & out_justification) const;
6161 
6165  bool ShowMultiline(bool & out_state) const;
6166 
6170  bool ShowScrolling(bool & out_state) const;
6171 
6175  bool ShowReadOnly(bool & out_state) const;
6176  };
6177 
6179  class PUBLISH_API DocumentKey : public Sprocket
6180  {
6181  public:
6183  DocumentKey();
6184 
6187  DocumentKey(DocumentKey const & in_that);
6188 
6191  DocumentKey(DocumentKey && in_that);
6192 
6195  virtual ~DocumentKey();
6196 
6197  HPS::Type ObjectType() const { return HPS::Type::PublishDocumentKey; }
6198 
6202  DocumentKey & operator=(DocumentKey const & in_that);
6203 
6207  DocumentKey & operator=(DocumentKey && in_that);
6208 
6212  virtual void Assign(DocumentKey const & in_that);
6213 
6217  bool Equals(DocumentKey const & in_that) const;
6218 
6222  bool operator!=(DocumentKey const & in_that) const;
6223 
6227  bool operator==(DocumentKey const & in_that) const;
6228 
6232  void Delete();
6233 
6234 
6239  DocumentKey & AddPage(PageKit const & in_page);
6240 
6246  DocumentKey & AddPages(size_t in_count, PageKit const in_pages[]);
6247 
6252  DocumentKey & AddPages(PageKitArray const & in_pages);
6253 
6263  DocumentKey & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
6264 
6269  DocumentKey & SetPasswords(char const * in_user_password, char const * in_owner_password);
6270 
6276  DocumentKey & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
6277 
6284  DocumentKey & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
6285 
6291  DocumentKey & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6292 
6297  DocumentKey & AddAttachment(char const * in_filename, char const * in_description);
6298 
6304  DocumentKey & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
6305 
6310  DocumentKey & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
6311 
6316  DocumentKey & AddIconImage(char const * in_name, ImageKit const & in_image);
6317 
6323  DocumentKey & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
6324 
6329  DocumentKey & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
6330 
6335  DocumentKey & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
6336 
6340  DocumentKey & SetPermissions(PermissionTypeArray const & in_permissions);
6341 
6342 
6344  size_t GetPageCount() const;
6345 
6349  DocumentKey & RemovePage(size_t in_index);
6350 
6355  DocumentKey & RemovePages(size_t in_start, size_t in_count);
6356 
6361  DocumentKey & RemovePages(size_t in_count, size_t const in_indices[]);
6362 
6366  DocumentKey & RemovePages(SizeTArray const & in_indices);
6367 
6370  DocumentKey & RemoveAllPages();
6371 
6375  PageControl GetPageControl(size_t in_index);
6376 
6380  PageControl const GetPageControl(size_t in_index) const;
6381  };
6382 
6384  class PUBLISH_API PageControl : public Sprocket
6385  {
6386  public:
6388  PageControl();
6389 
6392  PageControl(PageControl const & in_that);
6393 
6396  PageControl(PageControl && in_that);
6397 
6398  virtual ~PageControl();
6399 
6400  HPS::Type ObjectType() const { return HPS::Type::PublishPageControl; }
6401 
6405  PageControl & operator=(PageControl const & in_that);
6406 
6410  PageControl & operator=(PageControl && in_kit);
6411 
6412 
6417  PageControl & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
6418 
6424  PageControl & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
6425 
6430  PageControl & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
6431 
6436  PageControl & AddText(TextKit const & in_text, IntRectangle const & in_location);
6437 
6443  PageControl & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
6444 
6449  PageControl & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
6450 
6455  PageControl & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
6456 
6462  PageControl & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
6463 
6468  PageControl & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
6469 
6474  PageControl & AddTable(TableKit const & in_table, IntRectangle const & in_location);
6475 
6481  PageControl & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
6482 
6487  PageControl & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
6488 
6493  PageControl & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
6494 
6500  PageControl & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
6501 
6506  PageControl & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
6507 
6512  PageControl & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
6513 
6519  PageControl & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
6520 
6525  PageControl & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
6526 
6531  PageControl & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
6532 
6538  PageControl & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
6539 
6544  PageControl & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
6545 
6550  PageControl & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
6551 
6557  PageControl & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
6558 
6563  PageControl & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
6564 
6569  PageControl & AddCheckBox(CheckBoxKit const & in_check_box, IntRectangle const & in_location);
6570 
6576  PageControl & AddCheckBoxes(size_t in_count, CheckBoxKit const in_check_boxes[], IntRectangle const in_locations[]);
6577 
6582  PageControl & AddCheckBoxes(CheckBoxKitArray const & in_check_boxes, IntRectangleArray const & in_locations);
6583 
6588  PageControl & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
6589 
6595  PageControl & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
6596 
6601  PageControl & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
6602 
6607  PageControl & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
6608 
6614  PageControl & AddListBoxes(size_t in_count, ListBoxKit const in_list_boxes[], IntRectangle const in_locations[]);
6615 
6620  PageControl & AddListBoxes(ListBoxKitArray const & in_list_boxes, IntRectangleArray const & in_locations);
6621 
6626  PageControl & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
6627 
6633  PageControl & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_lists[], IntRectangle const in_locations[]);
6634 
6639  PageControl & AddDropDownLists(DropDownListKitArray const & in_drop_down_lists, IntRectangleArray const & in_locations);
6640 
6645  PageControl & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
6646 
6652  PageControl & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_fields[], IntRectangle const in_locations[]);
6653 
6658  PageControl & AddSignatureFields(SignatureFieldKitArray const & in_signature_fields, IntRectangleArray const & in_locations);
6659 
6660 
6666  PageControl & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
6667 
6674  PageControl & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
6675 
6681  PageControl & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
6682 
6688  PageControl & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
6689 
6696  PageControl & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
6697 
6703  PageControl & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
6704 
6710  PageControl & SetButtonLabelByField(char const * in_field, char const * in_label);
6711 
6718  PageControl & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
6719 
6725  PageControl & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
6726 
6733  PageControl & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
6734 
6742  PageControl & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
6743 
6750  PageControl & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
6751 
6759  PageControl & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
6760 
6769  PageControl & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
6770 
6778  PageControl & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6779 
6785  PageControl & SetVisibilityByField(char const * in_field, bool in_state);
6786 
6793  PageControl & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
6794 
6800  PageControl & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
6801 
6807  PageControl & SetTextValueByField(char const * in_field, char const * in_value);
6808 
6815  PageControl & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
6816 
6822  PageControl & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
6823 
6824 
6830  bool ShowFields(UTF8Array & out_names, IntRectangleArray & out_locations, FieldTypeArray & out_types) const;
6831  };
6832 
6833 
6834  class ExportOptionsKit;
6835 
6837  class PUBLISH_API File
6838  {
6839  public:
6846  static void Export(CADModel const & in_cad_model, char const * in_file_name, ExportOptionsKit const & in_options);
6847 
6854  static void Export(KeyPathArray const & in_key_paths, char const * in_file_name, ExportOptionsKit const & in_options);
6855 
6863  static void Export(size_t in_count, KeyPath const in_key_paths [], char const * in_file_name, ExportOptionsKit const & in_options);
6864 
6871  static void Export(KeyPath const & in_key_path, char const * in_file_name, ExportOptionsKit const & in_options);
6872 
6881  static void Export(CADModel const & in_cad_model, KeyPathArray const & in_additional_key_paths, char const * in_file_name, ExportOptionsKit const & in_options);
6882 
6892  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);
6893 
6901  static void Export(AnnotationKit const & in_annotation, char const * in_file_name, ExportOptionsKit const & in_options);
6902 
6910  static void Export(DocumentKit const & in_document, char const * in_file_name, ExportOptionsKit const & in_options);
6911 
6916  static DocumentKey CreateDocument(char const * in_file_name = nullptr);
6917 
6923  static void Export(DocumentKey const & in_document, char const * in_file_name);
6924 
6925 
6931  static void ExportPDF(CADModel const & in_cad_model, char const * in_file_name, ExportOptionsKit const & in_options);
6932 
6938  static void ExportPDF(KeyPathArray const & in_key_paths, char const * in_file_name, ExportOptionsKit const & in_options);
6939 
6946  static void ExportPDF(size_t in_count, KeyPath const in_key_paths[], char const * in_file_name, ExportOptionsKit const & in_options);
6947 
6953  static void ExportPDF(KeyPath const & in_key_path, char const * in_file_name, ExportOptionsKit const & in_options);
6954 
6962  static void ExportPDF(CADModel const & in_cad_model, KeyPathArray const & in_additional_key_paths, char const * in_file_name, ExportOptionsKit const & in_options);
6963 
6972  static void ExportPDF(CADModel const & in_cad_model, size_t in_count, KeyPath const in_additional_key_paths[], char const * in_file_name, ExportOptionsKit const & in_options);
6973 
6980  static void ExportPDF(AnnotationKit const & in_annotation, char const * in_file_name, ExportOptionsKit const & in_options);
6981 
6988  static void ExportPDF(DocumentKit const & in_document, char const * in_file_name, ExportOptionsKit const & in_options);
6989 
6994  static void ExportPDF(DocumentKey const & in_document, char const * in_file_name);
6995 
6996 
7005  static void ExportHTML(CADModel const & in_cad_model, char const * in_file_name, char const * in_template_name, bool in_include_measurement_information);
7006 
7014  static void ExportHTML(KeyPathArray const & in_key_paths, char const * in_file_name, char const * in_template_name);
7015 
7024  static void ExportHTML(size_t in_count, KeyPath const in_key_paths[], char const * in_file_name, char const * in_template_name);
7025 
7033  static void ExportHTML(KeyPath const & in_key_path, char const * in_file_name, char const * in_template_name);
7034 
7045  static void ExportHTML(CADModel const & in_cad_model, KeyPathArray const & in_additional_key_paths, char const * in_file_name, char const * in_template_name, bool in_include_measurement_information);
7046 
7058  static void ExportHTML(CADModel const & in_cad_model, size_t in_count, KeyPath const in_additional_key_paths[], char const * in_file_name, char const * in_template_name, bool in_include_measurement_information);
7059 
7060  private:
7062  File();
7063  };
7064 
7066  class PUBLISH_API ExportOptionsKit : public SprocketKit
7067  {
7068  public:
7070  ExportOptionsKit();
7071 
7074  ExportOptionsKit(ExportOptionsKit const & in_kit);
7075 
7079 
7080  virtual ~ExportOptionsKit();
7081 
7082  HPS::Type ObjectType() const { return HPS::Type::PublishExportOptionsKit; }
7083 
7086  void Set(ExportOptionsKit const & in_kit);
7087 
7090  void Show(ExportOptionsKit & out_kit) const;
7091 
7095  ExportOptionsKit & operator=(ExportOptionsKit const & in_kit);
7096 
7100  ExportOptionsKit & operator=(ExportOptionsKit && in_kit);
7101 
7104  bool Empty() const;
7105 
7109  bool Equals(ExportOptionsKit const & in_kit) const;
7110 
7114  bool operator==(ExportOptionsKit const & in_kit) const;
7115 
7119  bool operator!=(ExportOptionsKit const & in_kit) const;
7120 
7121 
7125  ExportOptionsKit & SetDocumentToAppendTo(char const * in_filename);
7126 
7127 
7130  ExportOptionsKit & UnsetDocumentToAppendTo();
7131 
7134  ExportOptionsKit & UnsetEverything();
7135 
7136 
7140  bool ShowDocumentToAppendTo(UTF8 & out_filename) const;
7141  };
7142 
7143 private:
7145  Publish();
7146 };
7147 
7148 }
7149 
7150 #endif
Mode
Definition: sprk_publish.h:285
Definition: hps.h:3326
Definition: sprk_publish.h:3254
Definition: sprk_publish.h:2856
Mode
Definition: sprk_publish.h:457
Definition: sprk_publish.h:475
Preference
Definition: sprk_publish.h:497
Definition: sprk.h:66
HPS::Type ObjectType() const
Definition: sprk_publish.h:2295
Definition: sprk_publish.h:4587
HPS::Type ObjectType() const
Definition: sprk_publish.h:3521
Definition: sprk_publish.h:163
Orientation
Definition: sprk_publish.h:127
Definition: sprk_publish.h:314
Definition: sprk.h:234
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:5558
Mode
Definition: sprk_publish.h:258
Definition: sprk_publish.h:42
Definition: sprk_publish.h:3082
Type
Definition: sprk_publish.h:569
Style
Definition: sprk_publish.h:204
HPS::Type ObjectType() const
Definition: sprk_publish.h:7082
Definition: sprk_publish.h:4284
Definition: sprk_publish.h:235
HPS::Type ObjectType() const
Definition: sprk_publish.h:6197
HPS::Type ObjectType() const
Definition: sprk_publish.h:4300
Definition: sprk_publish.h:566
HPS::Type ObjectType() const
Definition: sprk_publish.h:4603
Definition: sprk_publish.h:6837
Rotation
Definition: sprk_publish.h:378
Definition: sprk_publish.h:3676
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:5833
Definition: sprk_publish.h:4904
Type
Definition: sprk_publish.h:432
Definition: sprk_publish.h:492
Definition: sprk_publish.h:427
Definition: sprk_publish.h:104
BRepCompression
Definition: sprk_publish.h:168
Definition: sprk_publish.h:3953
Definition: hps.h:4317
Definition: hps.h:7076
Definition: sprk_publish.h:139
Definition: sprk_publish.h:598
HPS::Type ObjectType() const
Definition: sprk_publish.h:5233
Definition: sprk_publish.h:7066
Style
Definition: sprk_publish.h:345
Definition: sprk_publish.h:199
Definition: sprk_publish.h:280
Definition: sprk_publish.h:6384
Definition: sprk_publish.h:6179
HPS::Type ObjectType() const
Definition: sprk_publish.h:614
Definition: sprk_publish.h:5217
HPS::Type ObjectType() const
Definition: sprk_publish.h:2872
HPS::Type ObjectType() const
Definition: sprk_publish.h:5849
Thickness
Definition: sprk_publish.h:519
Definition: sprk_publish.h:3393
Type
Definition: sprk_publish.h:90
HPS::Type ObjectType() const
Definition: sprk_publish.h:4920
SourceType
Definition: sprk_publish.h:150
Definition: sprk_publish.h:543
HPS::Type ObjectType() const
Definition: sprk_publish.h:6400
Format
Definition: sprk_publish.h:144
Definition: sprk_publish.h:310
Preference
Definition: sprk_publish.h:480
Justification
Definition: hps.h:1543
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:3969
HPS::Type ObjectType() const
Definition: sprk_publish.h:954
Definition: sprk_publish.h:253
HPS::Type ObjectType() const
Definition: sprk_publish.h:3270
Language
Definition: sprk_publish.h:360
Definition: sprk_publish.h:929
Definition: sprk_publish.h:471
When
Definition: sprk_publish.h:222
Style
Definition: sprk_publish.h:528
Definition: hps.h:9229
Definition: hps.h:10773
When
Definition: sprk_publish.h:240
Definition: sprk.h:2528
HPS::Type ObjectType() const
Definition: sprk_publish.h:3098
HPS::Type ObjectType() const
Definition: sprk_publish.h:5574
Definition: sprk_publish.h:2279
HPS::Type ObjectType() const
Definition: sprk_publish.h:3692
Version
Definition: sprk_publish.h:187
Definition: sprk_publish.h:3505
HPS::Type ObjectType() const
Definition: sprk_publish.h:3409