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 
2523 
2526  AnnotationKit & UnsetSource();
2527 
2530  AnnotationKit & UnsetFormat();
2531 
2534  AnnotationKit & UnsetPRCTessellationCompression();
2535 
2538  AnnotationKit & UnsetPRCBRepCompression();
2539 
2542  AnnotationKit & UnsetPRCBRepRemoval();
2543 
2546  AnnotationKit & UnsetPRCAttributeRemoval();
2547 
2550  AnnotationKit & UnsetU3DVersion();
2551 
2554  AnnotationKit & UnsetU3DCompression();
2555 
2558  AnnotationKit & UnsetName();
2559 
2562  AnnotationKit & UnsetArtwork();
2563 
2566  AnnotationKit & UnsetActivation();
2567 
2570  AnnotationKit & UnsetDeactivation();
2571 
2574  AnnotationKit & UnsetToolbarVisibility();
2575 
2578  AnnotationKit & UnsetModelTreeVisibility();
2579 
2582  AnnotationKit & UnsetInteractivity();
2583 
2586  AnnotationKit & UnsetBorderWidth();
2587 
2590  AnnotationKit & UnsetTransparentBackground();
2591 
2594  AnnotationKit & UnsetBackgroundColor();
2595 
2598  AnnotationKit & UnsetLighting();
2599 
2602  AnnotationKit & UnsetRendering();
2603 
2606  AnnotationKit & UnsetPosterImage();
2607 
2610  AnnotationKit & UnsetCarouselButtons();
2611 
2614  AnnotationKit & UnsetCarouselViews();
2615 
2618  AnnotationKit & UnsetEverything();
2619 
2620 
2626  bool ShowSource(Annotation::SourceType & out_source_type, CADModel & out_cad_model, KeyPathArray & out_key_paths) const;
2627 
2631  bool ShowFormat(Annotation::Format & out_format) const;
2632 
2636  bool ShowPRCTessellationCompression(bool & out_state) const;
2637 
2641  bool ShowPRCBRepCompression(PRC::BRepCompression & out_level) const;
2642 
2646  bool ShowPRCBRepRemoval(bool & out_state) const;
2647 
2651  bool ShowPRCAttributeRemoval(bool & out_state) const;
2652 
2656  bool ShowU3DVersion(U3D::Version & out_version) const;
2657 
2661  bool ShowU3DCompression(unsigned char & out_level) const;
2662 
2666  bool ShowName(UTF8 & out_name) const;
2667 
2671  bool ShowArtwork(ArtworkKit & out_artwork) const;
2672 
2676  bool ShowActivation(Activation::When & out_when) const;
2677 
2681  bool ShowDeactivation(Deactivation::When & out_when) const;
2682 
2686  bool ShowToolbarVisibility(bool & out_state) const;
2687 
2691  bool ShowModelTreeVisibility(bool & out_state) const;
2692 
2696  bool ShowInteractivity(bool & out_state) const;
2697 
2701  bool ShowBorderWidth(int & out_width) const;
2702 
2706  bool ShowTransparentBackground(bool & out_state) const;
2707 
2711  bool ShowBackgroundColor(RGBColor & out_color) const;
2712 
2716  bool ShowLighting(Lighting::Mode & out_mode) const;
2717 
2721  bool ShowRendering(Rendering::Mode & out_mode) const;
2722 
2726  bool ShowPosterImage(ImageKit & out_image) const;
2727 
2734  bool ShowCarouselButtons(UTF8Array & out_button_names, UTF8 & out_previous_button_name, UTF8 & out_next_button_name, size_t & out_scroll_size) const;
2735 
2740  bool ShowCarouselViews(SizeTArray & out_indices, ImageKitArray & out_images) const;
2741  };
2742 
2744  class PUBLISH_API ArtworkKit : public SprocketKit
2745  {
2746  public:
2748  ArtworkKit();
2749 
2752  ArtworkKit(ArtworkKit const & in_kit);
2753 
2756  ArtworkKit(ArtworkKit && in_kit);
2757 
2758  virtual ~ArtworkKit();
2759 
2760  HPS::Type ObjectType() const { return HPS::Type::PublishArtworkKit; }
2761 
2765  static ArtworkKit GetDefault();
2766 
2769  void Set(ArtworkKit const & in_kit);
2770 
2773  void Show(ArtworkKit & out_kit) const;
2774 
2778  ArtworkKit & operator=(ArtworkKit const & in_kit);
2779 
2783  ArtworkKit & operator=(ArtworkKit && in_kit);
2784 
2787  bool Empty() const;
2788 
2792  bool Equals(ArtworkKit const & in_kit) const;
2793 
2797  bool operator==(ArtworkKit const & in_kit) const;
2798 
2802  bool operator!=(ArtworkKit const & in_kit) const;
2803 
2804 
2808  ArtworkKit & SetAnimationStyle(Animation::Style in_style);
2809 
2814  ArtworkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
2815 
2819  ArtworkKit & SetPMICrossHighlighting(bool in_state);
2820 
2824  ArtworkKit & SetPMISemanticInformation(bool in_state);
2825 
2829  ArtworkKit & SetDefaultViewPreference(Artwork::View::Preference in_preference);
2830 
2834  ArtworkKit & SetDisplayPreference(Artwork::Display::Preference in_preference);
2835 
2839  ArtworkKit & SetView(ViewKit const & in_view);
2840 
2844  ArtworkKit & AddView(ViewKit const & in_view);
2845 
2850  ArtworkKit & SetViews(size_t in_count, ViewKit const in_views[]);
2851 
2855  ArtworkKit & SetViews(ViewKitArray const & in_views);
2856 
2861  ArtworkKit & AddViews(size_t in_count, ViewKit const in_views[]);
2862 
2866  ArtworkKit & AddViews(ViewKitArray const & in_views);
2867 
2871  ArtworkKit & SetPMIColor(HPS::RGBColor const & in_pmi_color);
2872 
2873 
2876  ArtworkKit & UnsetAnimationStyle();
2877 
2880  ArtworkKit & UnsetJavaScript();
2881 
2884  ArtworkKit & UnsetPMICrossHighlighting();
2885 
2888  ArtworkKit & UnsetPMISemanticInformation();
2889 
2892  ArtworkKit & UnsetDefaultViewPreference();
2893 
2896  ArtworkKit & UnsetDisplayPreference();
2897 
2901  ArtworkKit & UnsetView(size_t in_index);
2902 
2907  ArtworkKit & UnsetViews(size_t in_count, size_t const in_indices[]);
2908 
2912  ArtworkKit & UnsetViews(SizeTArray const & in_indices);
2913 
2916  ArtworkKit & UnsetViews();
2917 
2920  ArtworkKit & UnsetPMIColor();
2921 
2924  ArtworkKit & UnsetEverything();
2925 
2926 
2930  bool ShowAnimationStyle(Animation::Style & out_style) const;
2931 
2936  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
2937 
2941  bool ShowPMICrossHighlighting(bool & out_state) const;
2942 
2946  bool ShowPMISemanticInformation(bool & out_state) const;
2947 
2951  bool ShowDefaultViewPreference(Artwork::View::Preference & out_preference) const;
2952 
2956  bool ShowDisplayPreference(Artwork::Display::Preference & out_preference) const;
2957 
2961  bool ShowViews(ViewKitArray & out_views) const;
2962 
2966  bool ShowPMIColor(HPS::RGBColor & out_pmi_color) const;
2967  };
2968 
2970  class PUBLISH_API ViewKit : public SprocketKit
2971  {
2972  public:
2974  ViewKit();
2975 
2978  ViewKit(ViewKit const & in_kit);
2979 
2982  ViewKit(ViewKit && in_kit);
2983 
2984  virtual ~ViewKit();
2985 
2986  HPS::Type ObjectType() const { return HPS::Type::PublishViewKit; }
2987 
2991  static ViewKit GetDefault();
2992 
2995  void Set(ViewKit const & in_kit);
2996 
2999  void Show(ViewKit & out_kit) const;
3000 
3004  ViewKit & operator=(ViewKit const & in_kit);
3005 
3009  ViewKit & operator=(ViewKit && in_kit);
3010 
3013  bool Empty() const;
3014 
3018  bool Equals(ViewKit const & in_kit) const;
3019 
3023  bool operator==(ViewKit const & in_kit) const;
3024 
3028  bool operator!=(ViewKit const & in_kit) const;
3029 
3030 
3034  ViewKit & SetInternalName(char const * in_name);
3035 
3039  ViewKit & SetExternalName(char const * in_name);
3040 
3049  ViewKit & SetCamera(CameraKit const & in_camera);
3050 
3054  ViewKit & SetDefault(bool in_state);
3055 
3059  ViewKit & SetBackgroundColor(RGBColor const & in_color);
3060 
3064  ViewKit & SetLighting(Lighting::Mode in_mode);
3065 
3069  ViewKit & SetRendering(Rendering::Mode in_mode);
3070 
3071 
3074  ViewKit & UnsetInternalName();
3075 
3078  ViewKit & UnsetExternalName();
3079 
3082  ViewKit & UnsetCamera();
3083 
3086  ViewKit & UnsetDefault();
3087 
3090  ViewKit & UnsetBackgroundColor();
3091 
3094  ViewKit & UnsetLighting();
3095 
3098  ViewKit & UnsetRendering();
3099 
3102  ViewKit & UnsetEverything();
3103 
3104 
3108  bool ShowInternalName(UTF8 & out_name) const;
3109 
3113  bool ShowExternalName(UTF8 & out_name) const;
3114 
3118  bool ShowCamera(CameraKit & out_camera) const;
3119 
3123  bool ShowDefault(bool & out_state) const;
3124 
3128  bool ShowBackgroundColor(RGBColor & out_color) const;
3129 
3133  bool ShowLighting(Lighting::Mode & out_mode) const;
3134 
3138  bool ShowRendering(Rendering::Mode & out_mode) const;
3139  };
3140 
3142  class PUBLISH_API TextKit : public SprocketKit
3143  {
3144  public:
3146  TextKit();
3147 
3150  TextKit(TextKit const & in_kit);
3151 
3154  TextKit(TextKit && in_kit);
3155 
3156  virtual ~TextKit();
3157 
3158  HPS::Type ObjectType() const { return HPS::Type::PublishTextKit; }
3159 
3163  static TextKit GetDefault();
3164 
3167  void Set(TextKit const & in_kit);
3168 
3171  void Show(TextKit & out_kit) const;
3172 
3176  TextKit & operator=(TextKit const & in_kit);
3177 
3181  TextKit & operator=(TextKit && in_kit);
3182 
3185  bool Empty() const;
3186 
3190  bool Equals(TextKit const & in_kit) const;
3191 
3195  bool operator==(TextKit const & in_kit) const;
3196 
3200  bool operator!=(TextKit const & in_kit) const;
3201 
3202 
3207  TextKit & SetText(char const * in_text);
3208 
3212  TextKit & SetFont(Text::Font::Name in_font);
3213 
3219  TextKit & SetFont(char const * in_font_name, Text::Language in_language, bool in_embed_font);
3220 
3225  TextKit & SetSize(int in_size);
3226 
3231  TextKit & SetColor(RGBColor const & in_color);
3232 
3233 
3236  TextKit & UnsetText();
3237 
3240  TextKit & UnsetFont();
3241 
3244  TextKit & UnsetSize();
3245 
3248  TextKit & UnsetColor();
3249 
3252  TextKit & UnsetEverything();
3253 
3254 
3258  bool ShowText(UTF8 & out_text) const;
3259 
3267  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;
3268 
3272  bool ShowSize(int & out_size) const;
3273 
3277  bool ShowColor(RGBColor & out_color) const;
3278  };
3279 
3281  class PUBLISH_API ImageKit : public SprocketKit
3282  {
3283  public:
3285  ImageKit();
3286 
3289  ImageKit(ImageKit const & in_kit);
3290 
3293  ImageKit(ImageKit && in_kit);
3294 
3295  virtual ~ImageKit();
3296 
3297  HPS::Type ObjectType() const { return HPS::Type::PublishImageKit; }
3298 
3299  // no GetDefault() since function doesn't make sense for this class
3300 
3303  void Set(ImageKit const & in_kit);
3304 
3307  void Show(ImageKit & out_kit) const;
3308 
3312  ImageKit & operator=(ImageKit const & in_kit);
3313 
3317  ImageKit & operator=(ImageKit && in_kit);
3318 
3321  bool Empty() const;
3322 
3326  bool Equals(ImageKit const & in_kit) const;
3327 
3331  bool operator==(ImageKit const & in_kit) const;
3332 
3336  bool operator!=(ImageKit const & in_kit) const;
3337 
3338 
3342  ImageKit & SetFile(char const * in_filename);
3343 
3349  ImageKit & SetSize(int in_width, int in_height);
3350 
3354  ImageKit & SetFormat(Image::Format in_format);
3355 
3356 
3359  ImageKit & UnsetFile();
3360 
3363  ImageKit & UnsetSize();
3364 
3367  ImageKit & UnsetFormat();
3368 
3371  ImageKit & UnsetEverything();
3372 
3373 
3377  bool ShowFile(UTF8 & out_filename) const;
3378 
3383  bool ShowSize(int & out_width, int & out_height) const;
3384 
3388  bool ShowFormat(Image::Format & out_format) const;
3389  };
3390 
3393  class PUBLISH_API TableKit : public SprocketKit
3394  {
3395  public:
3397  TableKit();
3398 
3401  TableKit(TableKit const & in_kit);
3402 
3405  TableKit(TableKit && in_kit);
3406 
3407  virtual ~TableKit();
3408 
3409  HPS::Type ObjectType() const { return HPS::Type::PublishTableKit; }
3410 
3411  // no GetDefault() since function doesn't make sense for this class
3412 
3415  void Set(TableKit const & in_kit);
3416 
3419  void Show(TableKit & out_kit) const;
3420 
3424  TableKit & operator=(TableKit const & in_kit);
3425 
3429  TableKit & operator=(TableKit && in_kit);
3430 
3433  bool Empty() const;
3434 
3438  bool Equals(TableKit const & in_kit) const;
3439 
3443  bool operator==(TableKit const & in_kit) const;
3444 
3448  bool operator!=(TableKit const & in_kit) const;
3449 
3450 
3455  TableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3456 
3461  TableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3462 
3468  TableKit & SetLink(int in_row, int in_column, LinkKit const & in_link);
3469 
3475  TableKit & SetText(int in_row, int in_column, TextKit const & in_text);
3476 
3482  TableKit & SetButton(int in_row, int in_column, ButtonKit const & in_button);
3483 
3489  TableKit & SetTextField(int in_row, int in_column, TextFieldKit const & in_text_field);
3490 
3491 
3494  TableKit & UnsetHTML();
3495 
3498  TableKit & UnsetHTMLStyle();
3499 
3502  TableKit & UnsetLink(int in_row, int in_column);
3503 
3506  TableKit & UnsetText(int in_row, int in_column);
3507 
3510  TableKit & UnsetButton(int in_row, int in_column);
3511 
3514  TableKit & UnsetTextField(int in_row, int in_column);
3515 
3518  TableKit & UnsetEverything();
3519 
3520 
3525  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3526 
3531  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3532 
3538  bool ShowLink(int in_row, int in_column, LinkKit & out_link) const;
3539 
3545  bool ShowText(int in_row, int in_column, TextKit & out_text) const;
3546 
3552  bool ShowButton(int in_row, int in_column, ButtonKit & out_button) const;
3553 
3559  bool ShowTextField(int in_row, int in_column, TextFieldKit & out_text_field) const;
3560  };
3561 
3564  class PUBLISH_API SlideTableKit : public SprocketKit
3565  {
3566  public:
3568  SlideTableKit();
3569 
3572  SlideTableKit(SlideTableKit const & in_kit);
3573 
3576  SlideTableKit(SlideTableKit && in_kit);
3577 
3578  virtual ~SlideTableKit();
3579 
3580  HPS::Type ObjectType() const { return HPS::Type::PublishSlideTableKit; }
3581 
3582  // no GetDefault() since function doesn't make sense for this class
3583 
3586  void Set(SlideTableKit const & in_kit);
3587 
3590  void Show(SlideTableKit & out_kit) const;
3591 
3595  SlideTableKit & operator=(SlideTableKit const & in_kit);
3596 
3600  SlideTableKit & operator=(SlideTableKit && in_kit);
3601 
3604  bool Empty() const;
3605 
3609  bool Equals(SlideTableKit const & in_kit) const;
3610 
3614  bool operator==(SlideTableKit const & in_kit) const;
3615 
3619  bool operator!=(SlideTableKit const & in_kit) const;
3620 
3621 
3626  SlideTableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3627 
3632  SlideTableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3633 
3638  SlideTableKit & SetButtons(char const * in_previous_button_name, char const * in_next_button_name);
3639 
3645  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKit const in_text[]);
3646 
3652  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKitArray const & in_text);
3653 
3657  SlideTableKit & SetHeader(bool in_state);
3658 
3659 
3662  SlideTableKit & UnsetHTML();
3663 
3666  SlideTableKit & UnsetHTMLStyle();
3667 
3670  SlideTableKit & UnsetButtons();
3671 
3674  SlideTableKit & UnsetText();
3675 
3678  SlideTableKit & UnsetHeader();
3679 
3682  SlideTableKit & UnsetEverything();
3683 
3684 
3689  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3690 
3695  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3696 
3701  bool ShowButtons(UTF8 & out_previous_button_name, UTF8 & out_next_button_name) const;
3702 
3708  bool ShowText(size_t & out_rows, size_t & out_columns, TextFieldKitArray & out_text) const;
3709 
3713  bool ShowHeader(bool & out_state) const;
3714  };
3715 
3717  class PUBLISH_API LinkKit : public SprocketKit
3718  {
3719  public:
3721  LinkKit();
3722 
3725  LinkKit(LinkKit const & in_kit);
3726 
3729  LinkKit(LinkKit && in_kit);
3730 
3731  virtual ~LinkKit();
3732 
3733  HPS::Type ObjectType() const { return HPS::Type::PublishLinkKit; }
3734 
3735  // no GetDefault() since function doesn't make sense for this class
3736 
3739  void Set(LinkKit const & in_kit);
3740 
3743  void Show(LinkKit & out_kit) const;
3744 
3748  LinkKit & operator=(LinkKit const & in_kit);
3749 
3753  LinkKit & operator=(LinkKit && in_kit);
3754 
3757  bool Empty() const;
3758 
3762  bool Equals(LinkKit const & in_kit) const;
3763 
3767  bool operator==(LinkKit const & in_kit) const;
3768 
3772  bool operator!=(LinkKit const & in_kit) const;
3773 
3774 
3779  LinkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
3780 
3784  LinkKit & SetBorderWidth(int in_width);
3785 
3789  LinkKit & SetHighlighting(Highlighting::Mode in_mode);
3790 
3794  LinkKit & SetBorderColor(RGBColor const & in_color);
3795 
3796 
3799  LinkKit & UnsetJavaScript();
3800 
3803  LinkKit & UnsetBorderWidth();
3804 
3807  LinkKit & UnsetHighlighting();
3808 
3811  LinkKit & UnsetBorderColor();
3812 
3815  LinkKit & UnsetEverything();
3816 
3817 
3822  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
3823 
3827  bool ShowBorderWidth(int & out_width) const;
3828 
3832  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
3833 
3837  bool ShowBorderColor(RGBColor & out_color) const;
3838  };
3839 
3841  class PUBLISH_API ButtonKit : public SprocketKit
3842  {
3843  public:
3845  ButtonKit();
3846 
3849  ButtonKit(ButtonKit const & in_kit);
3850 
3853  ButtonKit(ButtonKit && in_kit);
3854 
3855  virtual ~ButtonKit();
3856 
3857  HPS::Type ObjectType() const { return HPS::Type::PublishButtonKit; }
3858 
3862  static ButtonKit GetDefault();
3863 
3866  void Set(ButtonKit const & in_kit);
3867 
3870  void Show(ButtonKit & out_kit) const;
3871 
3875  ButtonKit & operator=(ButtonKit const & in_kit);
3876 
3880  ButtonKit & operator=(ButtonKit && in_kit);
3881 
3884  bool Empty() const;
3885 
3889  bool Equals(ButtonKit const & in_kit) const;
3890 
3894  bool operator==(ButtonKit const & in_kit) const;
3895 
3899  bool operator!=(ButtonKit const & in_kit) const;
3900 
3901 
3905  ButtonKit & SetName(char const * in_name);
3906 
3910  ButtonKit & SetLabel(char const * in_label);
3911 
3915  ButtonKit & SetFont(Text::Font::Name in_name);
3916 
3921  ButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
3922 
3926  ButtonKit & SetFontSize(int in_size);
3927 
3931  ButtonKit & SetTextColor(RGBColor const & in_color);
3932 
3936  ButtonKit & SetTooltip(char const * in_tooltip);
3937 
3941  ButtonKit & SetVisibility(bool in_state);
3942 
3946  ButtonKit & SetPrintability(bool in_state);
3947 
3951  ButtonKit & SetTextRotation(Text::Rotation in_rotation);
3952 
3956  ButtonKit & SetLock(bool in_state);
3957 
3961  ButtonKit & SetBorder(bool in_state);
3962 
3966  ButtonKit & SetBorderColor(RGBColor const & in_color);
3967 
3971  ButtonKit & SetBorderThickness(Border::Thickness in_thickness);
3972 
3976  ButtonKit & SetBorderStyle(Border::Style in_style);
3977 
3982  ButtonKit & SetFillColor(RGBColor const & in_color);
3983 
3987  ButtonKit & SetLabelPosition(Label::Position in_position);
3988 
3992  ButtonKit & SetHighlighting(Highlighting::Mode in_mode);
3993 
3997  ButtonKit & SetIconImage(ImageKit const & in_image);
3998 
3999 
4002  ButtonKit & UnsetName();
4003 
4006  ButtonKit & UnsetLabel();
4007 
4010  ButtonKit & UnsetFont();
4011 
4014  ButtonKit & UnsetFontSize();
4015 
4018  ButtonKit & UnsetTextColor();
4019 
4022  ButtonKit & UnsetTooltip();
4023 
4026  ButtonKit & UnsetVisibility();
4027 
4030  ButtonKit & UnsetPrintability();
4031 
4034  ButtonKit & UnsetTextRotation();
4035 
4038  ButtonKit & UnsetLock();
4039 
4042  ButtonKit & UnsetBorder();
4043 
4046  ButtonKit & UnsetBorderColor();
4047 
4050  ButtonKit & UnsetBorderThickness();
4051 
4054  ButtonKit & UnsetBorderStyle();
4055 
4058  ButtonKit & UnsetFillColor();
4059 
4062  ButtonKit & UnsetLabelPosition();
4063 
4066  ButtonKit & UnsetHighlighting();
4067 
4070  ButtonKit & UnsetIconImage();
4071 
4074  ButtonKit & UnsetEverything();
4075 
4076 
4080  bool ShowName(UTF8 & out_name) const;
4081 
4085  bool ShowLabel(UTF8 & out_label) const;
4086 
4093  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4094 
4098  bool ShowFontSize(int & out_size) const;
4099 
4103  bool ShowTextColor(RGBColor & out_color) const;
4104 
4108  bool ShowTooltip(UTF8 & out_tooltip) const;
4109 
4113  bool ShowVisibility(bool & out_state) const;
4114 
4118  bool ShowPrintability(bool & out_state) const;
4119 
4123  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4124 
4128  bool ShowLock(bool & out_state) const;
4129 
4133  bool ShowBorder(bool & out_state) const;
4134 
4138  bool ShowBorderColor(RGBColor & out_color) const;
4139 
4143  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4144 
4148  bool ShowBorderStyle(Border::Style & out_style) const;
4149 
4153  bool ShowFillColor(RGBColor & out_color) const;
4154 
4158  bool ShowLabelPosition(Label::Position & out_position) const;
4159 
4163  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
4164 
4168  bool ShowIconImage(ImageKit & out_image) const;
4169  };
4170 
4172  class PUBLISH_API CheckBoxKit : public SprocketKit
4173  {
4174  public:
4176  CheckBoxKit();
4177 
4180  CheckBoxKit(CheckBoxKit const & in_kit);
4181 
4184  CheckBoxKit(CheckBoxKit && in_kit);
4185 
4186  virtual ~CheckBoxKit();
4187 
4188  HPS::Type ObjectType() const { return HPS::Type::PublishCheckBoxKit; }
4189 
4193  static CheckBoxKit GetDefault();
4194 
4197  void Set(CheckBoxKit const & in_kit);
4198 
4201  void Show(CheckBoxKit & out_kit) const;
4202 
4206  CheckBoxKit & operator=(CheckBoxKit const & in_kit);
4207 
4211  CheckBoxKit & operator=(CheckBoxKit && in_kit);
4212 
4215  bool Empty() const;
4216 
4220  bool Equals(CheckBoxKit const & in_kit) const;
4221 
4225  bool operator==(CheckBoxKit const & in_kit) const;
4226 
4230  bool operator!=(CheckBoxKit const & in_kit) const;
4231 
4232 
4236  CheckBoxKit & SetName(char const * in_name);
4237 
4241  CheckBoxKit & SetFont(Text::Font::Name in_name);
4242 
4247  CheckBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4248 
4252  CheckBoxKit & SetFontSize(int in_size);
4253 
4257  CheckBoxKit & SetTextColor(RGBColor const & in_color);
4258 
4262  CheckBoxKit & SetTooltip(char const * in_tooltip);
4263 
4267  CheckBoxKit & SetVisibility(bool in_state);
4268 
4272  CheckBoxKit & SetPrintability(bool in_state);
4273 
4277  CheckBoxKit & SetTextRotation(Text::Rotation in_rotation);
4278 
4282  CheckBoxKit & SetLock(bool in_state);
4283 
4287  CheckBoxKit & SetBorder(bool in_state);
4288 
4292  CheckBoxKit & SetBorderColor(RGBColor const & in_color);
4293 
4297  CheckBoxKit & SetBorderThickness(Border::Thickness in_thickness);
4298 
4302  CheckBoxKit & SetBorderStyle(Border::Style in_style);
4303 
4308  CheckBoxKit & SetFillColor(RGBColor const & in_color);
4309 
4313  CheckBoxKit & SetExportValue(char const * in_export_value);
4314 
4318  CheckBoxKit & SetDefaultState(bool in_state);
4319 
4320 
4323  CheckBoxKit & UnsetName();
4324 
4327  CheckBoxKit & UnsetFont();
4328 
4331  CheckBoxKit & UnsetFontSize();
4332 
4335  CheckBoxKit & UnsetTextColor();
4336 
4339  CheckBoxKit & UnsetTooltip();
4340 
4343  CheckBoxKit & UnsetVisibility();
4344 
4347  CheckBoxKit & UnsetPrintability();
4348 
4351  CheckBoxKit & UnsetTextRotation();
4352 
4355  CheckBoxKit & UnsetLock();
4356 
4359  CheckBoxKit & UnsetBorder();
4360 
4363  CheckBoxKit & UnsetBorderColor();
4364 
4367  CheckBoxKit & UnsetBorderThickness();
4368 
4371  CheckBoxKit & UnsetBorderStyle();
4372 
4375  CheckBoxKit & UnsetFillColor();
4376 
4379  CheckBoxKit & UnsetExportValue();
4380 
4383  CheckBoxKit & UnsetDefaultState();
4384 
4387  CheckBoxKit & UnsetEverything();
4388 
4389 
4393  bool ShowName(UTF8 & out_name) const;
4394 
4401  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4402 
4406  bool ShowFontSize(int & out_size) const;
4407 
4411  bool ShowTextColor(RGBColor & out_color) const;
4412 
4416  bool ShowTooltip(UTF8 & out_tooltip) const;
4417 
4421  bool ShowVisibility(bool & out_state) const;
4422 
4426  bool ShowPrintability(bool & out_state) const;
4427 
4431  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4432 
4436  bool ShowLock(bool & out_state) const;
4437 
4441  bool ShowBorder(bool & out_state) const;
4442 
4446  bool ShowBorderColor(RGBColor & out_color) const;
4447 
4451  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4452 
4456  bool ShowBorderStyle(Border::Style & out_style) const;
4457 
4461  bool ShowFillColor(RGBColor & out_color) const;
4462 
4466  bool ShowExportValue(UTF8 & out_export_value) const;
4467 
4471  bool ShowDefaultState(bool & out_default_state) const;
4472  };
4473 
4475  class PUBLISH_API RadioButtonKit : public SprocketKit
4476  {
4477  public:
4479  RadioButtonKit();
4480 
4483  RadioButtonKit(RadioButtonKit const & in_kit);
4484 
4487  RadioButtonKit(RadioButtonKit && in_kit);
4488 
4489  virtual ~RadioButtonKit();
4490 
4491  HPS::Type ObjectType() const { return HPS::Type::PublishRadioButtonKit; }
4492 
4496  static RadioButtonKit GetDefault();
4497 
4500  void Set(RadioButtonKit const & in_kit);
4501 
4504  void Show(RadioButtonKit & out_kit) const;
4505 
4509  RadioButtonKit & operator=(RadioButtonKit const & in_kit);
4510 
4514  RadioButtonKit & operator=(RadioButtonKit && in_kit);
4515 
4518  bool Empty() const;
4519 
4523  bool Equals(RadioButtonKit const & in_kit) const;
4524 
4528  bool operator==(RadioButtonKit const & in_kit) const;
4529 
4533  bool operator!=(RadioButtonKit const & in_kit) const;
4534 
4535 
4539  RadioButtonKit & SetName(char const * in_name);
4540 
4544  RadioButtonKit & SetFont(Text::Font::Name in_name);
4545 
4550  RadioButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4551 
4555  RadioButtonKit & SetFontSize(int in_size);
4556 
4560  RadioButtonKit & SetTextColor(RGBColor const & in_color);
4561 
4565  RadioButtonKit & SetTooltip(char const * in_tooltip);
4566 
4570  RadioButtonKit & SetVisibility(bool in_state);
4571 
4575  RadioButtonKit & SetPrintability(bool in_state);
4576 
4580  RadioButtonKit & SetTextRotation(Text::Rotation in_rotation);
4581 
4585  RadioButtonKit & SetLock(bool in_state);
4586 
4590  RadioButtonKit & SetBorder(bool in_state);
4591 
4595  RadioButtonKit & SetBorderColor(RGBColor const & in_color);
4596 
4600  RadioButtonKit & SetBorderThickness(Border::Thickness in_thickness);
4601 
4605  RadioButtonKit & SetBorderStyle(Border::Style in_style);
4606 
4611  RadioButtonKit & SetFillColor(RGBColor const & in_color);
4612 
4616  RadioButtonKit & SetExportValue(char const * in_export_value);
4617 
4621  RadioButtonKit & SetDefaultState(bool in_state);
4622 
4626  RadioButtonKit & SetGrouping(bool in_state);
4627 
4628 
4631  RadioButtonKit & UnsetName();
4632 
4635  RadioButtonKit & UnsetFont();
4636 
4639  RadioButtonKit & UnsetFontSize();
4640 
4643  RadioButtonKit & UnsetTextColor();
4644 
4647  RadioButtonKit & UnsetTooltip();
4648 
4651  RadioButtonKit & UnsetVisibility();
4652 
4655  RadioButtonKit & UnsetPrintability();
4656 
4659  RadioButtonKit & UnsetTextRotation();
4660 
4663  RadioButtonKit & UnsetLock();
4664 
4667  RadioButtonKit & UnsetBorder();
4668 
4671  RadioButtonKit & UnsetBorderColor();
4672 
4675  RadioButtonKit & UnsetBorderThickness();
4676 
4679  RadioButtonKit & UnsetBorderStyle();
4680 
4683  RadioButtonKit & UnsetFillColor();
4684 
4687  RadioButtonKit & UnsetExportValue();
4688 
4691  RadioButtonKit & UnsetDefaultState();
4692 
4695  RadioButtonKit & UnsetGrouping();
4696 
4699  RadioButtonKit & UnsetEverything();
4700 
4701 
4705  bool ShowName(UTF8 & out_name) const;
4706 
4713  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4714 
4718  bool ShowFontSize(int & out_size) const;
4719 
4723  bool ShowTextColor(RGBColor & out_color) const;
4724 
4728  bool ShowTooltip(UTF8 & out_tooltip) const;
4729 
4733  bool ShowVisibility(bool & out_state) const;
4734 
4738  bool ShowPrintability(bool & out_state) const;
4739 
4743  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4744 
4748  bool ShowLock(bool & out_state) const;
4749 
4753  bool ShowBorder(bool & out_state) const;
4754 
4758  bool ShowBorderColor(RGBColor & out_color) const;
4759 
4763  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4764 
4768  bool ShowBorderStyle(Border::Style & out_style) const;
4769 
4773  bool ShowFillColor(RGBColor & out_color) const;
4774 
4778  bool ShowExportValue(UTF8 & out_export_value) const;
4779 
4783  bool ShowDefaultState(bool & out_default_state) const;
4784 
4788  bool ShowGrouping(bool & out_grouping) const;
4789  };
4790 
4792  class PUBLISH_API ListBoxKit : public SprocketKit
4793  {
4794  public:
4796  ListBoxKit();
4797 
4800  ListBoxKit(ListBoxKit const & in_kit);
4801 
4804  ListBoxKit(ListBoxKit && in_kit);
4805 
4806  virtual ~ListBoxKit();
4807 
4808  HPS::Type ObjectType() const { return HPS::Type::PublishListBoxKit; }
4809 
4813  static ListBoxKit GetDefault();
4814 
4817  void Set(ListBoxKit const & in_kit);
4818 
4821  void Show(ListBoxKit & out_kit) const;
4822 
4826  ListBoxKit & operator=(ListBoxKit const & in_kit);
4827 
4831  ListBoxKit & operator=(ListBoxKit && in_kit);
4832 
4835  bool Empty() const;
4836 
4840  bool Equals(ListBoxKit const & in_kit) const;
4841 
4845  bool operator==(ListBoxKit const & in_kit) const;
4846 
4850  bool operator!=(ListBoxKit const & in_kit) const;
4851 
4852 
4856  ListBoxKit & SetName(char const * in_name);
4857 
4861  ListBoxKit & SetFont(Text::Font::Name in_name);
4862 
4867  ListBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4868 
4872  ListBoxKit & SetFontSize(int in_size);
4873 
4877  ListBoxKit & SetTextColor(RGBColor const & in_color);
4878 
4882  ListBoxKit & SetTooltip(char const * in_tooltip);
4883 
4887  ListBoxKit & SetVisibility(bool in_state);
4888 
4892  ListBoxKit & SetPrintability(bool in_state);
4893 
4897  ListBoxKit & SetTextRotation(Text::Rotation in_rotation);
4898 
4902  ListBoxKit & SetLock(bool in_state);
4903 
4907  ListBoxKit & SetBorder(bool in_state);
4908 
4912  ListBoxKit & SetBorderColor(RGBColor const & in_color);
4913 
4917  ListBoxKit & SetBorderThickness(Border::Thickness in_thickness);
4918 
4922  ListBoxKit & SetBorderStyle(Border::Style in_style);
4923 
4928  ListBoxKit & SetFillColor(RGBColor const & in_color);
4929 
4933  ListBoxKit & SetMultipleSelection(bool in_state);
4934 
4940  ListBoxKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
4941 
4947  ListBoxKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
4948 
4949 
4952  ListBoxKit & UnsetName();
4953 
4956  ListBoxKit & UnsetFont();
4957 
4960  ListBoxKit & UnsetFontSize();
4961 
4964  ListBoxKit & UnsetTextColor();
4965 
4968  ListBoxKit & UnsetTooltip();
4969 
4972  ListBoxKit & UnsetVisibility();
4973 
4976  ListBoxKit & UnsetPrintability();
4977 
4980  ListBoxKit & UnsetTextRotation();
4981 
4984  ListBoxKit & UnsetLock();
4985 
4988  ListBoxKit & UnsetBorder();
4989 
4992  ListBoxKit & UnsetBorderColor();
4993 
4996  ListBoxKit & UnsetBorderThickness();
4997 
5000  ListBoxKit & UnsetBorderStyle();
5001 
5004  ListBoxKit & UnsetFillColor();
5005 
5008  ListBoxKit & UnsetMultipleSelection();
5009 
5012  ListBoxKit & UnsetContents();
5013 
5016  ListBoxKit & UnsetEverything();
5017 
5018 
5022  bool ShowName(UTF8 & out_name) const;
5023 
5030  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5031 
5035  bool ShowFontSize(int & out_size) const;
5036 
5040  bool ShowTextColor(RGBColor & out_color) const;
5041 
5045  bool ShowTooltip(UTF8 & out_tooltip) const;
5046 
5050  bool ShowVisibility(bool & out_state) const;
5051 
5055  bool ShowPrintability(bool & out_state) const;
5056 
5060  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5061 
5065  bool ShowLock(bool & out_state) const;
5066 
5070  bool ShowBorder(bool & out_state) const;
5071 
5075  bool ShowBorderColor(RGBColor & out_color) const;
5076 
5080  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5081 
5085  bool ShowBorderStyle(Border::Style & out_style) const;
5086 
5090  bool ShowFillColor(RGBColor & out_color) const;
5091 
5095  bool ShowMultipleSelection(bool & out_state) const;
5096 
5101  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5102  };
5103 
5105  class PUBLISH_API DropDownListKit : public SprocketKit
5106  {
5107  public:
5109  DropDownListKit();
5110 
5113  DropDownListKit(DropDownListKit const & in_kit);
5114 
5117  DropDownListKit(DropDownListKit && in_kit);
5118 
5119  virtual ~DropDownListKit();
5120 
5121  HPS::Type ObjectType() const { return HPS::Type::PublishDropDownListKit; }
5122 
5126  static DropDownListKit GetDefault();
5127 
5130  void Set(DropDownListKit const & in_kit);
5131 
5134  void Show(DropDownListKit & out_kit) const;
5135 
5139  DropDownListKit & operator=(DropDownListKit const & in_kit);
5140 
5144  DropDownListKit & operator=(DropDownListKit && in_kit);
5145 
5148  bool Empty() const;
5149 
5153  bool Equals(DropDownListKit const & in_kit) const;
5154 
5158  bool operator==(DropDownListKit const & in_kit) const;
5159 
5163  bool operator!=(DropDownListKit const & in_kit) const;
5164 
5165 
5169  DropDownListKit & SetName(char const * in_name);
5170 
5174  DropDownListKit & SetFont(Text::Font::Name in_name);
5175 
5180  DropDownListKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5181 
5185  DropDownListKit & SetFontSize(int in_size);
5186 
5190  DropDownListKit & SetTextColor(RGBColor const & in_color);
5191 
5195  DropDownListKit & SetTooltip(char const * in_tooltip);
5196 
5200  DropDownListKit & SetVisibility(bool in_state);
5201 
5205  DropDownListKit & SetPrintability(bool in_state);
5206 
5210  DropDownListKit & SetTextRotation(Text::Rotation in_rotation);
5211 
5215  DropDownListKit & SetLock(bool in_state);
5216 
5220  DropDownListKit & SetBorder(bool in_state);
5221 
5225  DropDownListKit & SetBorderColor(RGBColor const & in_color);
5226 
5230  DropDownListKit & SetBorderThickness(Border::Thickness in_thickness);
5231 
5235  DropDownListKit & SetBorderStyle(Border::Style in_style);
5236 
5241  DropDownListKit & SetFillColor(RGBColor const & in_color);
5242 
5246  DropDownListKit & SetCustomText(bool in_state);
5247 
5251  DropDownListKit & SetSpellChecking(bool in_state);
5252 
5256  DropDownListKit & SetImmediateCommit(bool in_state);
5257 
5263  DropDownListKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
5264 
5270  DropDownListKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
5271 
5272 
5275  DropDownListKit & UnsetName();
5276 
5279  DropDownListKit & UnsetFont();
5280 
5283  DropDownListKit & UnsetFontSize();
5284 
5287  DropDownListKit & UnsetTextColor();
5288 
5291  DropDownListKit & UnsetTooltip();
5292 
5295  DropDownListKit & UnsetVisibility();
5296 
5299  DropDownListKit & UnsetPrintability();
5300 
5303  DropDownListKit & UnsetTextRotation();
5304 
5307  DropDownListKit & UnsetLock();
5308 
5311  DropDownListKit & UnsetBorder();
5312 
5315  DropDownListKit & UnsetBorderColor();
5316 
5319  DropDownListKit & UnsetBorderThickness();
5320 
5323  DropDownListKit & UnsetBorderStyle();
5324 
5327  DropDownListKit & UnsetFillColor();
5328 
5331  DropDownListKit & UnsetCustomText();
5332 
5335  DropDownListKit & UnsetSpellChecking();
5336 
5339  DropDownListKit & UnsetImmediateCommit();
5340 
5343  DropDownListKit & UnsetContents();
5344 
5347  DropDownListKit & UnsetEverything();
5348 
5349 
5353  bool ShowName(UTF8 & out_name) const;
5354 
5361  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5362 
5366  bool ShowFontSize(int & out_size) const;
5367 
5371  bool ShowTextColor(RGBColor & out_color) const;
5372 
5376  bool ShowTooltip(UTF8 & out_tooltip) const;
5377 
5381  bool ShowVisibility(bool & out_state) const;
5382 
5386  bool ShowPrintability(bool & out_state) const;
5387 
5391  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5392 
5396  bool ShowLock(bool & out_state) const;
5397 
5401  bool ShowBorder(bool & out_state) const;
5402 
5406  bool ShowBorderColor(RGBColor & out_color) const;
5407 
5411  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5412 
5416  bool ShowBorderStyle(Border::Style & out_style) const;
5417 
5421  bool ShowFillColor(RGBColor & out_color) const;
5422 
5426  bool ShowCustomText(bool & out_state) const;
5427 
5431  bool ShowSpellChecking(bool & out_state) const;
5432 
5436  bool ShowImmediateCommit(bool & out_state) const;
5437 
5442  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5443  };
5444 
5446  class PUBLISH_API SignatureFieldKit : public SprocketKit
5447  {
5448  public:
5451 
5454  SignatureFieldKit(SignatureFieldKit const & in_kit);
5455 
5459 
5460  virtual ~SignatureFieldKit();
5461 
5462  HPS::Type ObjectType() const { return HPS::Type::PublishSignatureFieldKit; }
5463 
5467  static SignatureFieldKit GetDefault();
5468 
5471  void Set(SignatureFieldKit const & in_kit);
5472 
5475  void Show(SignatureFieldKit & out_kit) const;
5476 
5480  SignatureFieldKit & operator=(SignatureFieldKit const & in_kit);
5481 
5485  SignatureFieldKit & operator=(SignatureFieldKit && in_kit);
5486 
5489  bool Empty() const;
5490 
5494  bool Equals(SignatureFieldKit const & in_kit) const;
5495 
5499  bool operator==(SignatureFieldKit const & in_kit) const;
5500 
5504  bool operator!=(SignatureFieldKit const & in_kit) const;
5505 
5506 
5510  SignatureFieldKit & SetName(char const * in_name);
5511 
5515  SignatureFieldKit & SetFont(Text::Font::Name in_name);
5516 
5521  SignatureFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5522 
5526  SignatureFieldKit & SetFontSize(int in_size);
5527 
5531  SignatureFieldKit & SetTextColor(RGBColor const & in_color);
5532 
5536  SignatureFieldKit & SetTooltip(char const * in_tooltip);
5537 
5541  SignatureFieldKit & SetVisibility(bool in_state);
5542 
5546  SignatureFieldKit & SetPrintability(bool in_state);
5547 
5551  SignatureFieldKit & SetTextRotation(Text::Rotation in_rotation);
5552 
5556  SignatureFieldKit & SetLock(bool in_state);
5557 
5561  SignatureFieldKit & SetBorder(bool in_state);
5562 
5566  SignatureFieldKit & SetBorderColor(RGBColor const & in_color);
5567 
5571  SignatureFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5572 
5576  SignatureFieldKit & SetBorderStyle(Border::Style in_style);
5577 
5582  SignatureFieldKit & SetFillColor(RGBColor const & in_color);
5583 
5584 
5587  SignatureFieldKit & UnsetName();
5588 
5591  SignatureFieldKit & UnsetFont();
5592 
5595  SignatureFieldKit & UnsetFontSize();
5596 
5599  SignatureFieldKit & UnsetTextColor();
5600 
5603  SignatureFieldKit & UnsetTooltip();
5604 
5607  SignatureFieldKit & UnsetVisibility();
5608 
5611  SignatureFieldKit & UnsetPrintability();
5612 
5615  SignatureFieldKit & UnsetTextRotation();
5616 
5619  SignatureFieldKit & UnsetLock();
5620 
5623  SignatureFieldKit & UnsetBorder();
5624 
5627  SignatureFieldKit & UnsetBorderColor();
5628 
5631  SignatureFieldKit & UnsetBorderThickness();
5632 
5635  SignatureFieldKit & UnsetBorderStyle();
5636 
5639  SignatureFieldKit & UnsetFillColor();
5640 
5643  SignatureFieldKit & UnsetEverything();
5644 
5645 
5649  bool ShowName(UTF8 & out_name) const;
5650 
5657  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5658 
5662  bool ShowFontSize(int & out_size) const;
5663 
5667  bool ShowTextColor(RGBColor & out_color) const;
5668 
5672  bool ShowTooltip(UTF8 & out_tooltip) const;
5673 
5677  bool ShowVisibility(bool & out_state) const;
5678 
5682  bool ShowPrintability(bool & out_state) const;
5683 
5687  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5688 
5692  bool ShowLock(bool & out_state) const;
5693 
5697  bool ShowBorder(bool & out_state) const;
5698 
5702  bool ShowBorderColor(RGBColor & out_color) const;
5703 
5707  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5708 
5712  bool ShowBorderStyle(Border::Style & out_style) const;
5713 
5717  bool ShowFillColor(RGBColor & out_color) const;
5718  };
5719 
5721  class PUBLISH_API TextFieldKit : public SprocketKit
5722  {
5723  public:
5725  TextFieldKit();
5726 
5729  TextFieldKit(TextFieldKit const & in_kit);
5730 
5733  TextFieldKit(TextFieldKit && in_kit);
5734 
5735  virtual ~TextFieldKit();
5736 
5737  HPS::Type ObjectType() const { return HPS::Type::PublishTextFieldKit; }
5738 
5742  static TextFieldKit GetDefault();
5743 
5746  void Set(TextFieldKit const & in_kit);
5747 
5750  void Show(TextFieldKit & out_kit) const;
5751 
5755  TextFieldKit & operator=(TextFieldKit const & in_kit);
5756 
5760  TextFieldKit & operator=(TextFieldKit && in_kit);
5761 
5764  bool Empty() const;
5765 
5769  bool Equals(TextFieldKit const & in_kit) const;
5770 
5774  bool operator==(TextFieldKit const & in_kit) const;
5775 
5779  bool operator!=(TextFieldKit const & in_kit) const;
5780 
5781 
5782 
5786  TextFieldKit & SetName(char const * in_name);
5787 
5791  TextFieldKit & SetFont(Text::Font::Name in_name);
5792 
5797  TextFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5798 
5802  TextFieldKit & SetFontSize(int in_size);
5803 
5807  TextFieldKit & SetTextColor(RGBColor const & in_color);
5808 
5812  TextFieldKit & SetTooltip(char const * in_tooltip);
5813 
5817  TextFieldKit & SetVisibility(bool in_state);
5818 
5822  TextFieldKit & SetPrintability(bool in_state);
5823 
5827  TextFieldKit & SetTextRotation(Text::Rotation in_rotation);
5828 
5832  TextFieldKit & SetLock(bool in_state);
5833 
5837  TextFieldKit & SetBorder(bool in_state);
5838 
5842  TextFieldKit & SetBorderColor(RGBColor const & in_color);
5843 
5847  TextFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5848 
5852  TextFieldKit & SetBorderStyle(Border::Style in_style);
5853 
5858  TextFieldKit & SetFillColor(RGBColor const & in_color);
5859 
5863  TextFieldKit & SetDefaultValue(char const * in_value);
5864 
5868  TextFieldKit & SetTextJustification(HPS::Text::Justification in_justification);
5869 
5873  TextFieldKit & SetMultiline(bool in_state);
5874 
5878  TextFieldKit & SetScrolling(bool in_state);
5879 
5883  TextFieldKit & SetReadOnly(bool in_state);
5884 
5885 
5888  TextFieldKit & UnsetName();
5889 
5892  TextFieldKit & UnsetFont();
5893 
5896  TextFieldKit & UnsetFontSize();
5897 
5900  TextFieldKit & UnsetTextColor();
5901 
5904  TextFieldKit & UnsetTooltip();
5905 
5908  TextFieldKit & UnsetVisibility();
5909 
5912  TextFieldKit & UnsetPrintability();
5913 
5916  TextFieldKit & UnsetTextRotation();
5917 
5920  TextFieldKit & UnsetLock();
5921 
5924  TextFieldKit & UnsetBorder();
5925 
5928  TextFieldKit & UnsetBorderColor();
5929 
5932  TextFieldKit & UnsetBorderThickness();
5933 
5936  TextFieldKit & UnsetBorderStyle();
5937 
5940  TextFieldKit & UnsetFillColor();
5941 
5944  TextFieldKit & UnsetDefaultValue();
5945 
5948  TextFieldKit & UnsetTextJustification();
5949 
5952  TextFieldKit & UnsetMultiline();
5953 
5956  TextFieldKit & UnsetScrolling();
5957 
5960  TextFieldKit & UnsetReadOnly();
5961 
5964  TextFieldKit & UnsetEverything();
5965 
5966 
5970  bool ShowName(UTF8 & out_name) const;
5971 
5978  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5979 
5983  bool ShowFontSize(int & out_size) const;
5984 
5988  bool ShowTextColor(RGBColor & out_color) const;
5989 
5993  bool ShowTooltip(UTF8 & out_tooltip) const;
5994 
5998  bool ShowVisibility(bool & out_state) const;
5999 
6003  bool ShowPrintability(bool & out_state) const;
6004 
6008  bool ShowTextRotation(Text::Rotation & out_rotation) const;
6009 
6013  bool ShowLock(bool & out_state) const;
6014 
6018  bool ShowBorder(bool & out_state) const;
6019 
6023  bool ShowBorderColor(RGBColor & out_color) const;
6024 
6028  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
6029 
6033  bool ShowBorderStyle(Border::Style & out_style) const;
6034 
6038  bool ShowFillColor(RGBColor & out_color) const;
6039 
6043  bool ShowDefaultValue(UTF8 & out_value) const;
6044 
6048  bool ShowTextJustification(HPS::Text::Justification & out_justification) const;
6049 
6053  bool ShowMultiline(bool & out_state) const;
6054 
6058  bool ShowScrolling(bool & out_state) const;
6059 
6063  bool ShowReadOnly(bool & out_state) const;
6064  };
6065 
6067  class PUBLISH_API DocumentKey : public Sprocket
6068  {
6069  public:
6071  DocumentKey();
6072 
6075  DocumentKey(DocumentKey const & in_that);
6076 
6079  DocumentKey(DocumentKey && in_that);
6080 
6083  virtual ~DocumentKey();
6084 
6085  HPS::Type ObjectType() const { return HPS::Type::PublishDocumentKey; }
6086 
6090  DocumentKey & operator=(DocumentKey const & in_that);
6091 
6095  DocumentKey & operator=(DocumentKey && in_that);
6096 
6100  virtual void Assign(DocumentKey const & in_that);
6101 
6105  bool Equals(DocumentKey const & in_that) const;
6106 
6110  bool operator!=(DocumentKey const & in_that) const;
6111 
6115  bool operator==(DocumentKey const & in_that) const;
6116 
6120  void Delete();
6121 
6122 
6127  DocumentKey & AddPage(PageKit const & in_page);
6128 
6134  DocumentKey & AddPages(size_t in_count, PageKit const in_pages[]);
6135 
6140  DocumentKey & AddPages(PageKitArray const & in_pages);
6141 
6151  DocumentKey & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
6152 
6157  DocumentKey & SetPasswords(char const * in_user_password, char const * in_owner_password);
6158 
6164  DocumentKey & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
6165 
6172  DocumentKey & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
6173 
6179  DocumentKey & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6180 
6185  DocumentKey & AddAttachment(char const * in_filename, char const * in_description);
6186 
6192  DocumentKey & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
6193 
6198  DocumentKey & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
6199 
6204  DocumentKey & AddIconImage(char const * in_name, ImageKit const & in_image);
6205 
6211  DocumentKey & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
6212 
6217  DocumentKey & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
6218 
6223  DocumentKey & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
6224 
6228  DocumentKey & SetPermissions(PermissionTypeArray const & in_permissions);
6229 
6230 
6232  size_t GetPageCount() const;
6233 
6237  DocumentKey & RemovePage(size_t in_index);
6238 
6243  DocumentKey & RemovePages(size_t in_start, size_t in_count);
6244 
6249  DocumentKey & RemovePages(size_t in_count, size_t const in_indices[]);
6250 
6254  DocumentKey & RemovePages(SizeTArray const & in_indices);
6255 
6258  DocumentKey & RemoveAllPages();
6259 
6263  PageControl GetPageControl(size_t in_index);
6264 
6268  PageControl const GetPageControl(size_t in_index) const;
6269  };
6270 
6272  class PUBLISH_API PageControl : public Sprocket
6273  {
6274  public:
6276  PageControl();
6277 
6280  PageControl(PageControl const & in_that);
6281 
6284  PageControl(PageControl && in_that);
6285 
6286  virtual ~PageControl();
6287 
6288  HPS::Type ObjectType() const { return HPS::Type::PublishPageControl; }
6289 
6293  PageControl & operator=(PageControl const & in_that);
6294 
6298  PageControl & operator=(PageControl && in_kit);
6299 
6300 
6305  PageControl & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
6306 
6312  PageControl & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
6313 
6318  PageControl & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
6319 
6324  PageControl & AddText(TextKit const & in_text, IntRectangle const & in_location);
6325 
6331  PageControl & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
6332 
6337  PageControl & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
6338 
6343  PageControl & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
6344 
6350  PageControl & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
6351 
6356  PageControl & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
6357 
6362  PageControl & AddTable(TableKit const & in_table, IntRectangle const & in_location);
6363 
6369  PageControl & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
6370 
6375  PageControl & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
6376 
6381  PageControl & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
6382 
6388  PageControl & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
6389 
6394  PageControl & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
6395 
6400  PageControl & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
6401 
6407  PageControl & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
6408 
6413  PageControl & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
6414 
6419  PageControl & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
6420 
6426  PageControl & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
6427 
6432  PageControl & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
6433 
6438  PageControl & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
6439 
6445  PageControl & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
6446 
6451  PageControl & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
6452 
6457  PageControl & AddCheckBox(CheckBoxKit const & in_check_box, IntRectangle const & in_location);
6458 
6464  PageControl & AddCheckBoxes(size_t in_count, CheckBoxKit const in_check_boxes[], IntRectangle const in_locations[]);
6465 
6470  PageControl & AddCheckBoxes(CheckBoxKitArray const & in_check_boxes, IntRectangleArray const & in_locations);
6471 
6476  PageControl & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
6477 
6483  PageControl & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
6484 
6489  PageControl & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
6490 
6495  PageControl & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
6496 
6502  PageControl & AddListBoxes(size_t in_count, ListBoxKit const in_list_boxes[], IntRectangle const in_locations[]);
6503 
6508  PageControl & AddListBoxes(ListBoxKitArray const & in_list_boxes, IntRectangleArray const & in_locations);
6509 
6514  PageControl & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
6515 
6521  PageControl & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_lists[], IntRectangle const in_locations[]);
6522 
6527  PageControl & AddDropDownLists(DropDownListKitArray const & in_drop_down_lists, IntRectangleArray const & in_locations);
6528 
6533  PageControl & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
6534 
6540  PageControl & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_fields[], IntRectangle const in_locations[]);
6541 
6546  PageControl & AddSignatureFields(SignatureFieldKitArray const & in_signature_fields, IntRectangleArray const & in_locations);
6547 
6548 
6554  PageControl & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
6555 
6562  PageControl & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
6563 
6569  PageControl & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
6570 
6576  PageControl & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
6577 
6584  PageControl & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
6585 
6591  PageControl & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
6592 
6598  PageControl & SetButtonLabelByField(char const * in_field, char const * in_label);
6599 
6606  PageControl & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
6607 
6613  PageControl & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
6614 
6621  PageControl & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
6622 
6630  PageControl & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
6631 
6638  PageControl & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
6639 
6647  PageControl & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
6648 
6657  PageControl & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
6658 
6666  PageControl & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6667 
6673  PageControl & SetVisibilityByField(char const * in_field, bool in_state);
6674 
6681  PageControl & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
6682 
6688  PageControl & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
6689 
6695  PageControl & SetTextValueByField(char const * in_field, char const * in_value);
6696 
6703  PageControl & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
6704 
6710  PageControl & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
6711 
6712 
6718  bool ShowFields(UTF8Array & out_names, IntRectangleArray & out_locations, FieldTypeArray & out_types) const;
6719  };
6720 
6721 
6722  class ExportOptionsKit;
6723 
6725  class PUBLISH_API File
6726  {
6727  public:
6733  static void Export(CADModel const & in_cad_model, char const * in_file_name, ExportOptionsKit const & in_options);
6734 
6740  static void Export(KeyPathArray const & in_key_paths, char const * in_file_name, ExportOptionsKit const & in_options);
6741 
6748  static void Export(size_t in_count, KeyPath const in_key_paths [], char const * in_file_name, ExportOptionsKit const & in_options);
6749 
6755  static void Export(KeyPath const & in_key_path, char const * in_file_name, ExportOptionsKit const & in_options);
6756 
6764  static void Export(CADModel const & in_cad_model, KeyPathArray const & in_additional_key_paths, char const * in_file_name, ExportOptionsKit const & in_options);
6765 
6774  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);
6775 
6782  static void Export(AnnotationKit const & in_annotation, char const * in_file_name, ExportOptionsKit const & in_options);
6783 
6790  static void Export(DocumentKit const & in_document, char const * in_file_name, ExportOptionsKit const & in_options);
6791 
6796  static DocumentKey CreateDocument(char const * in_file_name = nullptr);
6797 
6802  static void Export(DocumentKey const & in_document, char const * in_file_name);
6803 
6804  private:
6806  File();
6807  };
6808 
6810  class PUBLISH_API ExportOptionsKit : public SprocketKit
6811  {
6812  public:
6814  ExportOptionsKit();
6815 
6818  ExportOptionsKit(ExportOptionsKit const & in_kit);
6819 
6823 
6824  virtual ~ExportOptionsKit();
6825 
6826  HPS::Type ObjectType() const { return HPS::Type::PublishExportOptionsKit; }
6827 
6830  void Set(ExportOptionsKit const & in_kit);
6831 
6834  void Show(ExportOptionsKit & out_kit) const;
6835 
6839  ExportOptionsKit & operator=(ExportOptionsKit const & in_kit);
6840 
6844  ExportOptionsKit & operator=(ExportOptionsKit && in_kit);
6845 
6848  bool Empty() const;
6849 
6853  bool Equals(ExportOptionsKit const & in_kit) const;
6854 
6858  bool operator==(ExportOptionsKit const & in_kit) const;
6859 
6863  bool operator!=(ExportOptionsKit const & in_kit) const;
6864 
6865 
6869  ExportOptionsKit & SetDocumentToAppendTo(char const * in_filename);
6870 
6871 
6874  ExportOptionsKit & UnsetDocumentToAppendTo();
6875 
6878  ExportOptionsKit & UnsetEverything();
6879 
6880 
6884  bool ShowDocumentToAppendTo(UTF8 & out_filename) const;
6885  };
6886 
6887 private:
6889  Publish();
6890 };
6891 
6892 }
6893 
6894 #endif
Mode
Definition: sprk_publish.h:285
Definition: hps.h:3312
Definition: sprk_publish.h:3142
Definition: sprk_publish.h:2744
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:4475
HPS::Type ObjectType() const
Definition: sprk_publish.h:3409
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:5446
Mode
Definition: sprk_publish.h:258
Definition: sprk_publish.h:42
Definition: sprk_publish.h:2970
Type
Definition: sprk_publish.h:569
Style
Definition: sprk_publish.h:204
HPS::Type ObjectType() const
Definition: sprk_publish.h:6826
Definition: sprk_publish.h:4172
Definition: sprk_publish.h:235
HPS::Type ObjectType() const
Definition: sprk_publish.h:6085
HPS::Type ObjectType() const
Definition: sprk_publish.h:4188
Definition: sprk_publish.h:566
HPS::Type ObjectType() const
Definition: sprk_publish.h:4491
Definition: sprk_publish.h:6725
Rotation
Definition: sprk_publish.h:378
Definition: sprk_publish.h:3564
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:5721
Definition: sprk_publish.h:4792
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:3841
Definition: hps.h:4292
Definition: hps.h:7044
Definition: sprk_publish.h:139
Definition: sprk_publish.h:598
HPS::Type ObjectType() const
Definition: sprk_publish.h:5121
Definition: sprk_publish.h:6810
Style
Definition: sprk_publish.h:345
Definition: sprk_publish.h:199
Definition: sprk_publish.h:280
Definition: sprk_publish.h:6272
Definition: sprk_publish.h:6067
HPS::Type ObjectType() const
Definition: sprk_publish.h:614
Definition: sprk_publish.h:5105
HPS::Type ObjectType() const
Definition: sprk_publish.h:2760
HPS::Type ObjectType() const
Definition: sprk_publish.h:5737
Thickness
Definition: sprk_publish.h:519
Definition: sprk_publish.h:3281
Type
Definition: sprk_publish.h:90
HPS::Type ObjectType() const
Definition: sprk_publish.h:4808
SourceType
Definition: sprk_publish.h:150
Definition: sprk_publish.h:543
HPS::Type ObjectType() const
Definition: sprk_publish.h:6288
Format
Definition: sprk_publish.h:144
Definition: sprk_publish.h:310
Preference
Definition: sprk_publish.h:480
Justification
Definition: hps.h:1539
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:3857
HPS::Type ObjectType() const
Definition: sprk_publish.h:954
Definition: sprk_publish.h:253
HPS::Type ObjectType() const
Definition: sprk_publish.h:3158
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:9176
Definition: hps.h:10688
When
Definition: sprk_publish.h:240
Definition: sprk.h:2528
HPS::Type ObjectType() const
Definition: sprk_publish.h:2986
HPS::Type ObjectType() const
Definition: sprk_publish.h:5462
Definition: sprk_publish.h:2279
HPS::Type ObjectType() const
Definition: sprk_publish.h:3580
Version
Definition: sprk_publish.h:187
Definition: sprk_publish.h:3393
HPS::Type ObjectType() const
Definition: sprk_publish.h:3297