sprk_publish.h
1 // Copyright (c) 1998-2014 by 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 SPROCKETS
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(SPROCKETS) 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  SprocketPath,
153  KeyPath,
154  };
155 
156  private:
158  Annotation();
159  };
160 
162  class PUBLISH_API PRC
163  {
164  public:
167  enum class BRepCompression
168  {
169  None,
170  Low,
171  Medium,
172  High
173  };
174 
175  private:
177  PRC();
178  };
179 
181  class PUBLISH_API U3D
182  {
183  public:
186  enum class Version
187  {
188  ECMA1,
189  ECMA3
190  };
191 
192  private:
194  U3D();
195  };
196 
198  class PUBLISH_API Animation
199  {
200  public:
203  enum class Style
204  {
205  None,
206  Loop,
207  Bounce
208  };
209 
210  private:
212  Animation();
213  };
214 
216  class PUBLISH_API Activation
217  {
218  public:
221  enum class When
222  {
223  Explicit,
224  Opened,
225  Visible
226  };
227 
228  private:
230  Activation();
231  };
232 
234  class PUBLISH_API Deactivation
235  {
236  public:
239  enum class When
240  {
241  Explicit,
242  Closed,
243  NotVisible
244  };
245 
246  private:
248  Deactivation();
249  };
250 
252  class PUBLISH_API Lighting
253  {
254  public:
257  enum class Mode
258  {
259  Artwork,
260  None,
261  White,
262  Day,
263  Bright,
264  PrimaryColor,
265  Night,
266  Blue,
267  Red,
268  Cube,
269  CADOptimized,
270  Headlamp
271  };
272 
273  private:
275  Lighting();
276  };
277 
279  class PUBLISH_API Rendering
280  {
281  public:
284  enum class Mode
285  {
286  Solid,
287  SolidWireframe,
288  SolidOutline,
289  BoundingBox,
290  Transparent,
291  TransparentWireframe,
292  TransparentBoundingBox,
293  TransparentBoundingBoxOutline,
294  Illustration,
295  ShadedIllustration,
296  Wireframe,
297  ShadedWireframe,
298  HiddenWireframe,
299  Vertices,
300  ShadedVertices
301  };
302 
303  private:
305  Rendering();
306  };
307 
309  class PUBLISH_API Text
310  {
311  public:
313  class PUBLISH_API Font
314  {
315  public:
318  enum class Type
319  {
320  BuiltIn,
321  Explicit
322  };
323 
326  enum class Name
327  {
328  TimesRoman,
329  TimesItalic,
330  TimesBold,
331  TimesBoldItalic,
332  Helvetica,
333  HelveticaOblique,
334  HelveticaBold,
335  HelveticaBoldOblique,
336  Courier,
337  CourierOblique,
338  CourierBold,
339  CourierBoldOblique
340  };
341 
344  enum class Style
345  {
346  Regular,
347  Bold,
348  Italic,
349  BoldItalic,
350  };
351 
352  private:
354  Font();
355  };
356 
359  enum class Language
360  {
361  ASCII,
362  EastEuropeanRoman,
363  Cyrillic,
364  Greek,
365  Turkish,
366  Hebrew,
367  Arabic,
368  Baltic,
369  ChineseTraditional,
370  ChineseSimplified,
371  Japanese,
372  Korean
373  };
374 
377  enum class Rotation
378  {
379  None,
380  CounterClockwise90Degrees,
381  CounterClockwise180Degrees,
382  CounterClockwise270Degrees,
383  };
384 
385  private:
387  Text();
388  };
389 
391  class PUBLISH_API Image
392  {
393  public:
396  enum class Format
397  {
398  Unknown,
399  BMP,
400  PNG,
401  JPEG,
402  RawRGB,
403  RawRGBA,
404  RawGrey,
405  RawGreyA,
406  EMF,
407  URL,
408  GIF,
409  TIFF,
410  PCX,
411  Targa,
412  PPM,
413  ILBM,
414  CEL,
415  RGB,
416  PSD,
417  PIC
418  };
419 
420  private:
422  Image();
423  };
424 
426  class PUBLISH_API Field
427  {
428  public:
431  enum class Type
432  {
433  Text,
434  Button,
435  DropDown,
436  ListBox,
437  CheckBox,
438  RadioButton,
439  DigitalSignature,
440  BarCode
441  };
442 
443  private:
445  Field();
446  };
447 
448  typedef std::vector<Field::Type, Allocator<Field::Type>> FieldTypeArray;
449 
451  class PUBLISH_API Highlighting
452  {
453  public:
456  enum class Mode
457  {
458  None,
459  Invert,
460  Outline,
461  Push
462  };
463 
464  private:
466  Highlighting();
467  };
468 
470  class PUBLISH_API Artwork
471  {
472  public:
474  class PUBLISH_API View
475  {
476  public:
479  enum class Preference
480  {
481  Native,
482  PDF
483  };
484 
485  private:
487  View();
488  };
489 
491  class PUBLISH_API Display
492  {
493  public:
496  enum class Preference
497  {
498  Defined,
499  Runtime
500  };
501 
502  private:
504  Display();
505  };
506 
507  private:
509  Artwork();
510  };
511 
513  class PUBLISH_API Border
514  {
515  public:
518  enum class Thickness
519  {
520  Thin,
521  Medium,
522  Wide,
523  };
524 
527  enum class Style
528  {
529  Solid,
530  Dashed,
531  Beveled,
532  Inset,
533  Underlined,
534  };
535 
536  private:
538  Border();
539  };
540 
542  class PUBLISH_API Label
543  {
544  public:
547  enum class Position
548  {
549  LabelOnly,
550  IconOnly,
551  Top,
552  Bottom,
553  Left,
554  Right,
555  OnTop,
556  };
557 
558  private:
560  Label();
561  };
562 
563 
565  class PUBLISH_API Permission
566  {
567  public:
568  enum class Type
569  {
570  Open,
571  Secure,
572  Print,
573  Edit,
574  Copy,
575  EditNotes,
576  SaveAs,
577  FillAndSign,
578  Accessible,
579  Assembly,
580  HighQualityPrint,
581  Owner,
582  FormSubmit,
583  SpawnTemplate,
584  All,
585  };
586 
587  private:
589  Permission();
590  };
591 
592  typedef std::vector<Permission::Type, HPS::Allocator<Permission::Type> > PermissionTypeArray;
593 
594 
596  class PUBLISH_API DocumentKit : public Sprocket
597  {
598  public:
600  DocumentKit();
601 
604  DocumentKit(DocumentKit const & in_kit);
605 
608  DocumentKit(DocumentKit && in_kit);
609 
610  virtual ~DocumentKit();
611 
612  HPS::Type ObjectType() const { return HPS::Type::PublishDocumentKit; }
613 
617  static DocumentKit GetDefault();
618 
621  void Set(DocumentKit const & in_kit);
622 
625  void Show(DocumentKit & out_kit) const;
626 
630  DocumentKit & operator=(DocumentKit const & in_kit);
631 
635  DocumentKit & operator=(DocumentKit && in_kit);
636 
639  bool Empty() const;
640 
644  bool Equals(DocumentKit const & in_kit) const;
645 
649  bool operator==(DocumentKit const & in_kit) const;
650 
654  bool operator!=(DocumentKit const & in_kit) const;
655 
656 
666  DocumentKit & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
667 
672  DocumentKit & SetPasswords(char const * in_user_password, char const * in_owner_password);
673 
679  DocumentKit & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
680 
687  DocumentKit & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
688 
694  DocumentKit & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
695 
700  DocumentKit & AddAttachment(char const * in_filename, char const * in_description);
701 
707  DocumentKit & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
708 
713  DocumentKit & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
714 
719  DocumentKit & AddIconImage(char const * in_name, ImageKit const & in_image);
720 
726  DocumentKit & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
727 
732  DocumentKit & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
733 
738  DocumentKit & SetPage(PageKit const & in_page);
739 
744  DocumentKit & AddPage(PageKit const & in_page);
745 
751  DocumentKit & SetPages(size_t in_count, PageKit const in_pages[]);
752 
757  DocumentKit & SetPages(PageKitArray const & in_pages);
758 
764  DocumentKit & AddPages(size_t in_count, PageKit const in_pages[]);
765 
770  DocumentKit & AddPages(PageKitArray const & in_pages);
771 
776  DocumentKit & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
777 
781  DocumentKit & SetPermissions(PermissionTypeArray const & in_permissions);
782 
783 
786  DocumentKit & UnsetInformation();
787 
790  DocumentKit & UnsetPasswords();
791 
795  DocumentKit & UnsetJavaScript(char const * in_script_name);
796 
801  DocumentKit & UnsetJavaScript(size_t in_count, UTF8 const in_script_names[]);
802 
806  DocumentKit & UnsetJavaScript(UTF8Array const & in_script_names);
807 
810  DocumentKit & UnsetJavaScript();
811 
815  DocumentKit & UnsetAttachment(char const * in_filename);
816 
821  DocumentKit & UnsetAttachments(size_t in_count, UTF8 const in_filenames[]);
822 
826  DocumentKit & UnsetAttachments(UTF8Array const & in_filenames);
827 
830  DocumentKit & UnsetAttachments();
831 
835  DocumentKit & UnsetIconImage(char const * in_name);
836 
841  DocumentKit & UnsetIconImages(size_t in_count, UTF8 const in_names[]);
842 
846  DocumentKit & UnsetIconImages(UTF8Array const & in_names);
847 
850  DocumentKit & UnsetIconImages();
851 
855  DocumentKit & UnsetPage(size_t in_index);
856 
861  DocumentKit & UnsetPages(size_t in_count, size_t const in_indices[]);
862 
866  DocumentKit & UnsetPages(SizeTArray const & in_indices);
867 
870  DocumentKit & UnsetPages();
871 
874  DocumentKit & UnsetPermissions();
875 
878  DocumentKit & UnsetEverything();
879 
880 
887  bool ShowInformation(UTF8 & out_title, UTF8 & out_author, UTF8 & out_subject, UTF8 & out_creator) const;
888 
893  bool ShowPasswords(UTF8 & out_user_password, UTF8 & out_owner_password) const;
894 
901  bool ShowJavaScript(UTF8Array & out_script_names, UTF8Array & out_sources, SourceTypeArray & out_types) const;
902 
907  bool ShowAttachments(UTF8Array & out_filenames, UTF8Array & out_descriptions) const;
908 
913  bool ShowIconImages(UTF8Array & out_names, ImageKitArray & out_images) const;
914 
918  bool ShowPages(PageKitArray & out_pages) const;
919 
923  bool ShowPermissions(PermissionTypeArray & out_permissions) const;
924  };
925 
927  class PUBLISH_API PageKit : public Sprocket
928  {
929  public:
931  PageKit();
932 
936  PageKit(Page::Format in_format, Page::Orientation in_orientation);
937 
940  PageKit(char const * in_filename);
941 
944  PageKit(PageKit const & in_kit);
945 
948  PageKit(PageKit && in_kit);
949 
950  virtual ~PageKit();
951 
952  HPS::Type ObjectType() const { return HPS::Type::PublishPageKit; }
953 
957  static PageKit GetDefault();
958 
961  void Set(PageKit const & in_kit);
962 
965  void Show(PageKit & out_kit) const;
966 
970  PageKit & operator=(PageKit const & in_kit);
971 
975  PageKit & operator=(PageKit && in_kit);
976 
979  bool Empty() const;
980 
984  bool Equals(PageKit const & in_kit) const;
985 
989  bool operator==(PageKit const & in_kit) const;
990 
994  bool operator!=(PageKit const & in_kit) const;
995 
996 
1001  PageKit & SetFormat(Page::Format in_format);
1002 
1007  PageKit & SetOrientation(Page::Orientation in_orientation);
1008 
1013  PageKit & SetAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
1014 
1019  PageKit & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
1020 
1026  PageKit & SetAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
1027 
1032  PageKit & SetAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
1033 
1039  PageKit & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
1040 
1045  PageKit & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
1046 
1051  PageKit & SetText(TextKit const & in_text, IntRectangle const & in_location);
1052 
1057  PageKit & AddText(TextKit const & in_text, IntRectangle const & in_location);
1058 
1064  PageKit & SetText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
1065 
1070  PageKit & SetText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
1071 
1077  PageKit & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
1078 
1083  PageKit & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
1084 
1089  PageKit & SetImage(ImageKit const & in_image, IntRectangle const & in_location);
1090 
1095  PageKit & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
1096 
1102  PageKit & SetImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
1103 
1108  PageKit & SetImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
1109 
1115  PageKit & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
1116 
1121  PageKit & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
1122 
1127  PageKit & SetTable(TableKit const & in_table, IntRectangle const & in_location);
1128 
1133  PageKit & AddTable(TableKit const & in_table, IntRectangle const & in_location);
1134 
1140  PageKit & SetTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
1141 
1146  PageKit & SetTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
1147 
1153  PageKit & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
1154 
1159  PageKit & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
1160 
1165  PageKit & SetLink(LinkKit const & in_link, IntRectangle const & in_location);
1166 
1171  PageKit & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
1172 
1178  PageKit & SetLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
1179 
1184  PageKit & SetLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
1185 
1191  PageKit & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
1192 
1197  PageKit & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
1198 
1203  PageKit & SetButton(ButtonKit const & in_button, IntRectangle const & in_location);
1204 
1209  PageKit & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
1210 
1216  PageKit & SetButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
1217 
1222  PageKit & SetButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
1223 
1229  PageKit & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
1230 
1235  PageKit & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
1236 
1241  PageKit & SetTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
1242 
1247  PageKit & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
1248 
1254  PageKit & SetTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
1255 
1260  PageKit & SetTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
1261 
1267  PageKit & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
1268 
1273  PageKit & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
1274 
1279  PageKit & SetSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
1280 
1285  PageKit & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
1286 
1292  PageKit & SetSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
1293 
1298  PageKit & SetSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
1299 
1305  PageKit & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
1306 
1311  PageKit & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
1312 
1317  PageKit & SetCheckBox(CheckBoxKit const & in_checkbox, IntRectangle const & in_location);
1318 
1323  PageKit & AddCheckBox(CheckBoxKit const & in_checkbox, IntRectangle const & in_location);
1324 
1330  PageKit & SetCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]);
1331 
1336  PageKit & SetCheckBoxes(CheckBoxKitArray const & in_checkbox, IntRectangleArray const & in_locations);
1337 
1343  PageKit & AddCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]);
1344 
1349  PageKit & AddCheckBoxes(CheckBoxKitArray const & in_checkbox, IntRectangleArray const & in_locations);
1350 
1355  PageKit & SetRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
1356 
1361  PageKit & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
1362 
1368  PageKit & SetRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
1369 
1374  PageKit & SetRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
1375 
1381  PageKit & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
1382 
1387  PageKit & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
1388 
1393  PageKit & SetListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
1394 
1399  PageKit & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
1400 
1406  PageKit & SetListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]);
1407 
1412  PageKit & SetListBoxes(ListBoxKitArray const & in_list_box, IntRectangleArray const & in_locations);
1413 
1419  PageKit & AddListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]);
1420 
1425  PageKit & AddListBoxes(ListBoxKitArray const & in_list_box, IntRectangleArray const & in_locations);
1426 
1431  PageKit & SetDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
1432 
1437  PageKit & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
1438 
1444  PageKit & SetDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]);
1445 
1450  PageKit & SetDropDownLists(DropDownListKitArray const & in_drop_down_list, IntRectangleArray const & in_locations);
1451 
1457  PageKit & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]);
1458 
1463  PageKit & AddDropDownLists(DropDownListKitArray const & in_drop_down_list, IntRectangleArray const & in_locations);
1464 
1469  PageKit & SetSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
1470 
1475  PageKit & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
1476 
1482  PageKit & SetSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]);
1483 
1488  PageKit & SetSignatureFields(SignatureFieldKitArray const & in_signature_field, IntRectangleArray const & in_locations);
1489 
1495  PageKit & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]);
1496 
1501  PageKit & AddSignatureFields(SignatureFieldKitArray const & in_signature_field, IntRectangleArray const & in_locations);
1502 
1506  PageKit & SetTemplateFile(char const * in_filename);
1507 
1513  PageKit & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
1514 
1521  PageKit & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
1522 
1528  PageKit & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
1529 
1535  PageKit & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
1536 
1543  PageKit & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
1544 
1550  PageKit & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
1551 
1557  PageKit & SetButtonLabelByField(char const * in_field, char const * in_label);
1558 
1565  PageKit & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
1566 
1572  PageKit & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
1573 
1580  PageKit & SetListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
1581 
1588  PageKit & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
1589 
1597  PageKit & SetListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
1598 
1605  PageKit & SetListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
1606 
1614  PageKit & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
1615 
1622  PageKit & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
1623 
1631  PageKit & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
1632 
1641  PageKit & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
1642 
1650  PageKit & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
1651 
1657  PageKit & SetVisibilityByField(char const * in_field, bool in_state);
1658 
1665  PageKit & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
1666 
1672  PageKit & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
1673 
1679  PageKit & SetTextValueByField(char const * in_field, char const * in_value);
1680 
1687  PageKit & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
1688 
1694  PageKit & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
1695 
1696 
1699  PageKit & UnsetFormat();
1700 
1703  PageKit & UnsetOrientation();
1704 
1708  PageKit & UnsetAnnotation(size_t in_index);
1709 
1714  PageKit & UnsetAnnotations(size_t in_count, size_t const in_indices[]);
1715 
1719  PageKit & UnsetAnnotations(SizeTArray const & in_indices);
1720 
1723  PageKit & UnsetAnnotations();
1724 
1728  PageKit & UnsetText(size_t in_index);
1729 
1734  PageKit & UnsetText(size_t in_count, size_t const in_indices[]);
1735 
1739  PageKit & UnsetText(SizeTArray const & in_indices);
1740 
1743  PageKit & UnsetText();
1744 
1748  PageKit & UnsetCheckBox(size_t in_index);
1749 
1754  PageKit & UnsetCheckBoxes(size_t in_count, size_t const in_indices[]);
1755 
1759  PageKit & UnsetCheckBoxes(SizeTArray const & in_indices);
1760 
1763  PageKit & UnsetCheckBoxes();
1764 
1768  PageKit & UnsetRadioButton(size_t in_index);
1769 
1774  PageKit & UnsetRadioButtons(size_t in_count, size_t const in_indices[]);
1775 
1779  PageKit & UnsetRadioButtons(SizeTArray const & in_indices);
1780 
1783  PageKit & UnsetRadioButtons();
1784 
1788  PageKit & UnsetListBox(size_t in_index);
1789 
1794  PageKit & UnsetListBoxes(size_t in_count, size_t const in_indices[]);
1795 
1799  PageKit & UnsetListBoxes(SizeTArray const & in_indices);
1800 
1803  PageKit & UnsetListBoxes();
1804 
1808  PageKit & UnsetDropDownList(size_t in_index);
1809 
1814  PageKit & UnsetDropDownLists(size_t in_count, size_t const in_indices[]);
1815 
1819  PageKit & UnsetDropDownLists(SizeTArray const & in_indices);
1820 
1823  PageKit & UnsetDropDownLists();
1824 
1828  PageKit & UnsetSignatureField(size_t in_index);
1829 
1834  PageKit & UnsetSignatureFields(size_t in_count, size_t const in_indices[]);
1835 
1839  PageKit & UnsetSignatureFields(SizeTArray const & in_indices);
1840 
1843  PageKit & UnsetSignatureFields();
1844 
1848  PageKit & UnsetImage(size_t in_index);
1849 
1854  PageKit & UnsetImages(size_t in_count, size_t const in_indices[]);
1855 
1859  PageKit & UnsetImages(SizeTArray const & in_indices);
1860 
1863  PageKit & UnsetImages();
1864 
1868  PageKit & UnsetTable(size_t in_index);
1869 
1874  PageKit & UnsetTables(size_t in_count, size_t const in_indices[]);
1875 
1879  PageKit & UnsetTables(SizeTArray const & in_indices);
1880 
1883  PageKit & UnsetTables();
1884 
1888  PageKit & UnsetLink(size_t in_index);
1889 
1894  PageKit & UnsetLinks(size_t in_count, size_t const in_indices[]);
1895 
1899  PageKit & UnsetLinks(SizeTArray const & in_indices);
1900 
1903  PageKit & UnsetLinks();
1904 
1908  PageKit & UnsetButton(size_t in_index);
1909 
1914  PageKit & UnsetButtons(size_t in_count, size_t const in_indices[]);
1915 
1919  PageKit & UnsetButtons(SizeTArray const & in_indices);
1920 
1923  PageKit & UnsetButtons();
1924 
1928  PageKit & UnsetTextField(size_t in_index);
1929 
1934  PageKit & UnsetTextFields(size_t in_count, size_t const in_indices[]);
1935 
1939  PageKit & UnsetTextFields(SizeTArray const & in_indices);
1940 
1943  PageKit & UnsetTextFields();
1944 
1948  PageKit & UnsetSlideTable(size_t in_index);
1949 
1954  PageKit & UnsetSlideTables(size_t in_count, size_t const in_indices[]);
1955 
1959  PageKit & UnsetSlideTables(SizeTArray const & in_indices);
1960 
1963  PageKit & UnsetSlideTables();
1964 
1967  PageKit & UnsetTemplateFile();
1968 
1972  PageKit & UnsetAnnotationByField(char const * in_field);
1973 
1978  PageKit & UnsetAnnotationsByField(size_t in_count, UTF8 const in_fields[]);
1979 
1983  PageKit & UnsetAnnotationsByField(UTF8Array const & in_fields);
1984 
1987  PageKit & UnsetAnnotationsByField();
1988 
1992  PageKit & UnsetButtonIconByField(char const * in_field);
1993 
1998  PageKit & UnsetButtonIconsByField(size_t in_count, UTF8 const in_fields[]);
1999 
2003  PageKit & UnsetButtonIconsByField(UTF8Array const & in_fields);
2004 
2007  PageKit & UnsetButtonIconsByField();
2008 
2012  PageKit & UnsetButtonLabelByField(char const * in_field);
2013 
2018  PageKit & UnsetButtonLabelsByField(size_t in_count, UTF8 const in_fields[]);
2019 
2023  PageKit & UnsetButtonLabelsByField(UTF8Array const & in_fields);
2024 
2027  PageKit & UnsetButtonLabelsByField();
2028 
2033  PageKit & UnsetListItemByField(char const * in_field, size_t in_index);
2034 
2040  PageKit & UnsetListItemsByField(char const * in_field, size_t in_count, size_t const in_indices[]);
2041 
2046  PageKit & UnsetListItemsByField(char const * in_field, SizeTArray const & in_indices);
2047 
2051  PageKit & UnsetListItemsByField(char const * in_field);
2052 
2057  PageKit & UnsetListItemsByField(size_t in_count, UTF8 const in_fields[]);
2058 
2062  PageKit & UnsetListItemsByField(UTF8Array const & in_fields);
2063 
2066  PageKit & UnsetListItemsByField();
2067 
2071  PageKit & UnsetJavaScriptActionByField(char const * in_field);
2072 
2077  PageKit & UnsetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[]);
2078 
2082  PageKit & UnsetJavaScriptActionsByField(UTF8Array const & in_fields);
2083 
2086  PageKit & UnsetJavaScriptActionsByField();
2087 
2091  PageKit & UnsetVisibilityByField(char const * in_field);
2092 
2097  PageKit & UnsetVisibilitiesByField(size_t in_count, UTF8 const in_fields[]);
2098 
2102  PageKit & UnsetVisibilitiesByField(UTF8Array const & in_fields);
2103 
2106  PageKit & UnsetVisibilitiesByField();
2107 
2111  PageKit & UnsetTextValueByField(char const * in_field);
2112 
2117  PageKit & UnsetTextValuesByField(size_t in_count, UTF8 const in_fields[]);
2118 
2122  PageKit & UnsetTextValuesByField(UTF8Array const & in_fields);
2123 
2126  PageKit & UnsetTextValuesByField();
2127 
2130  PageKit & UnsetEverything();
2131 
2132 
2136  bool ShowFormat(Page::Format & out_format) const;
2137 
2141  bool ShowOrientation(Page::Orientation & out_orientation) const;
2142 
2147  bool ShowAnnotations(AnnotationKitArray & out_annotations, IntRectangleArray & out_locations) const;
2148 
2153  bool ShowText(TextKitArray & out_text, IntRectangleArray & out_locations) const;
2154 
2159  bool ShowImages(ImageKitArray & out_images, IntRectangleArray & out_locations) const;
2160 
2165  bool ShowTables(TableKitArray & out_tables, IntRectangleArray & out_locations) const;
2166 
2171  bool ShowLinks(LinkKitArray & out_links, IntRectangleArray & out_locations) const;
2172 
2177  bool ShowButtons(ButtonKitArray & out_buttons, IntRectangleArray & out_locations) const;
2178 
2183  bool ShowCheckBoxes(CheckBoxKitArray & out_check_boxes, IntRectangleArray & out_locations) const;
2184 
2189  bool ShowRadioButtons(RadioButtonKitArray & out_radio_buttons, IntRectangleArray & out_locations) const;
2190 
2195  bool ShowListBoxes(ListBoxKitArray & out_list_boxes, IntRectangleArray & out_locations) const;
2196 
2201  bool ShowDropDownLists(DropDownListKitArray & out_drop_down_lists, IntRectangleArray & out_locations) const;
2202 
2207  bool ShowSignatureFields(SignatureFieldKitArray & out_signature_fields, IntRectangleArray & out_locations) const;
2208 
2213  bool ShowTextFields(TextFieldKitArray & out_text_fields, IntRectangleArray & out_locations) const;
2214 
2219  bool ShowSlideTables(SlideTableKitArray & out_slide_tables, IntRectangleArray & out_locations) const;
2220 
2224  bool ShowTemplateFile(UTF8 & out_filename) const;
2225 
2230  bool ShowAnnotationsByField(UTF8Array & out_fields, AnnotationKitArray & out_annotations) const;
2231 
2236  bool ShowButtonIconsByField(UTF8Array & out_fields, ImageKitArray & out_images) const;
2237 
2242  bool ShowButtonLabelsByField(UTF8Array & out_fields, UTF8Array & out_labels) const;
2243 
2247  bool ShowListItemFields(UTF8Array & out_fields) const;
2248 
2254  bool ShowListItemsByField(char const * in_field, UTF8Array & out_values, UTF8Array & out_export_values) const;
2255 
2261  bool ShowJavaScriptActionsByField(UTF8Array & out_fields, UTF8Array & out_sources, SourceTypeArray & out_types) const;
2262 
2267  bool ShowVisibilitiesByField(UTF8Array & out_fields, BoolArray & out_states) const;
2268 
2273  bool ShowTextValuesByField(UTF8Array & out_fields, UTF8Array & out_values) const;
2274  };
2275 
2277  class PUBLISH_API AnnotationKit : public Sprocket
2278  {
2279  public:
2281  AnnotationKit();
2282 
2285  AnnotationKit(SprocketPath const & in_source);
2286 
2289  AnnotationKit(AnnotationKit const & in_kit);
2290 
2293  AnnotationKit(AnnotationKit && in_kit);
2294 
2295  virtual ~AnnotationKit();
2296 
2297  HPS::Type ObjectType() const { return HPS::Type::PublishAnnotationKit; }
2298 
2302  static AnnotationKit GetDefault();
2303 
2306  void Set(AnnotationKit const & in_kit);
2307 
2310  void Show(AnnotationKit & out_kit) const;
2311 
2315  AnnotationKit & operator=(AnnotationKit const & in_kit);
2316 
2320  AnnotationKit & operator=(AnnotationKit && in_kit);
2321 
2324  bool Empty() const;
2325 
2329  bool Equals(AnnotationKit const & in_kit) const;
2330 
2334  bool operator==(AnnotationKit const & in_kit) const;
2335 
2339  bool operator!=(AnnotationKit const & in_kit) const;
2340 
2341 
2345  AnnotationKit & SetSource(SprocketPath const & in_source);
2346 
2350  AnnotationKit & SetSource(KeyPath const & in_source);
2351 
2355  AnnotationKit & SetSource(KeyPathArray const & in_sources);
2356 
2361  AnnotationKit & SetSource(size_t in_count, KeyPath const in_sources[]);
2362 
2366  AnnotationKit & SetFormat(Annotation::Format in_format);
2367 
2372  AnnotationKit & SetPRCTessellationCompression(bool in_state);
2373 
2378  AnnotationKit & SetPRCBRepCompression(PRC::BRepCompression in_level);
2379 
2384  AnnotationKit & SetPRCBRepRemoval(bool in_state);
2385 
2390  AnnotationKit & SetPRCAttributeRemoval(bool in_state);
2391 
2396  AnnotationKit & SetU3DVersion(U3D::Version in_version);
2397 
2402  AnnotationKit & SetU3DCompression(unsigned char in_level);
2403 
2407  AnnotationKit & SetName(char const * in_name);
2408 
2412  AnnotationKit & SetArtwork(ArtworkKit const & in_artwork);
2413 
2417  AnnotationKit & SetActivation(Activation::When in_when);
2418 
2422  AnnotationKit & SetDeactivation(Deactivation::When in_when);
2423 
2427  AnnotationKit & SetToolbarVisibility(bool in_state);
2428 
2432  AnnotationKit & SetModelTreeVisibility(bool in_state);
2433 
2437  AnnotationKit & SetInteractivity(bool in_state);
2438 
2442  AnnotationKit & SetBorderWidth(int in_width);
2443 
2448  AnnotationKit & SetTransparentBackground(bool in_state);
2449 
2453  AnnotationKit & SetBackgroundColor(RGBColor const & in_color);
2454 
2458  AnnotationKit & SetLighting(Lighting::Mode in_mode);
2459 
2463  AnnotationKit & SetRendering(Rendering::Mode in_mode);
2464 
2468  AnnotationKit & SetPosterImage(ImageKit const & in_image);
2469 
2477  AnnotationKit & SetCarouselButtons(size_t in_count, UTF8 const in_button_names[], char const * in_previous_button_name, char const * in_next_button_name, size_t in_scroll_size);
2478 
2485  AnnotationKit & SetCarouselButtons(UTF8Array const & in_button_names, char const * in_previous_button_name, char const * in_next_button_name, size_t in_scroll_size);
2486 
2494  AnnotationKit & SetCarouselViews(size_t in_count, size_t const in_indices[], ImageKit const in_images[] = nullptr);
2495 
2502  AnnotationKit & SetCarouselViews(SizeTArray const & in_indices, ImageKitArray const & in_images = ImageKitArray());
2503 
2504 
2507  AnnotationKit & UnsetSource();
2508 
2511  AnnotationKit & UnsetFormat();
2512 
2515  AnnotationKit & UnsetPRCTessellationCompression();
2516 
2519  AnnotationKit & UnsetPRCBRepCompression();
2520 
2523  AnnotationKit & UnsetPRCBRepRemoval();
2524 
2527  AnnotationKit & UnsetPRCAttributeRemoval();
2528 
2531  AnnotationKit & UnsetU3DVersion();
2532 
2535  AnnotationKit & UnsetU3DCompression();
2536 
2539  AnnotationKit & UnsetName();
2540 
2543  AnnotationKit & UnsetArtwork();
2544 
2547  AnnotationKit & UnsetActivation();
2548 
2551  AnnotationKit & UnsetDeactivation();
2552 
2555  AnnotationKit & UnsetToolbarVisibility();
2556 
2559  AnnotationKit & UnsetModelTreeVisibility();
2560 
2563  AnnotationKit & UnsetInteractivity();
2564 
2567  AnnotationKit & UnsetBorderWidth();
2568 
2571  AnnotationKit & UnsetTransparentBackground();
2572 
2575  AnnotationKit & UnsetBackgroundColor();
2576 
2579  AnnotationKit & UnsetLighting();
2580 
2583  AnnotationKit & UnsetRendering();
2584 
2587  AnnotationKit & UnsetPosterImage();
2588 
2591  AnnotationKit & UnsetCarouselButtons();
2592 
2595  AnnotationKit & UnsetCarouselViews();
2596 
2599  AnnotationKit & UnsetEverything();
2600 
2601 
2607  bool ShowSource(Annotation::SourceType & out_source_type, SprocketPath & out_sprocket_paths, KeyPathArray & out_key_paths) const;
2608 
2612  bool ShowFormat(Annotation::Format & out_format) const;
2613 
2617  bool ShowPRCTessellationCompression(bool & out_state) const;
2618 
2622  bool ShowPRCBRepCompression(PRC::BRepCompression & out_level) const;
2623 
2627  bool ShowPRCBRepRemoval(bool & out_state) const;
2628 
2632  bool ShowPRCAttributeRemoval(bool & out_state) const;
2633 
2637  bool ShowU3DVersion(U3D::Version & out_version) const;
2638 
2642  bool ShowU3DCompression(unsigned char & out_level) const;
2643 
2647  bool ShowName(UTF8 & out_name) const;
2648 
2652  bool ShowArtwork(ArtworkKit & out_artwork) const;
2653 
2657  bool ShowActivation(Activation::When & out_when) const;
2658 
2662  bool ShowDeactivation(Deactivation::When & out_when) const;
2663 
2667  bool ShowToolbarVisibility(bool & out_state) const;
2668 
2672  bool ShowModelTreeVisibility(bool & out_state) const;
2673 
2677  bool ShowInteractivity(bool & out_state) const;
2678 
2682  bool ShowBorderWidth(int & out_width) const;
2683 
2687  bool ShowTransparentBackground(bool & out_state) const;
2688 
2692  bool ShowBackgroundColor(RGBColor & out_color) const;
2693 
2697  bool ShowLighting(Lighting::Mode & out_mode) const;
2698 
2702  bool ShowRendering(Rendering::Mode & out_mode) const;
2703 
2707  bool ShowPosterImage(ImageKit & out_image) const;
2708 
2715  bool ShowCarouselButtons(UTF8Array & out_button_names, UTF8 & out_previous_button_name, UTF8 & out_next_button_name, size_t & out_scroll_size) const;
2716 
2721  bool ShowCarouselViews(SizeTArray & out_indices, ImageKitArray & out_images) const;
2722  };
2723 
2725  class PUBLISH_API ArtworkKit : public Sprocket
2726  {
2727  public:
2729  ArtworkKit();
2730 
2733  ArtworkKit(ArtworkKit const & in_kit);
2734 
2737  ArtworkKit(ArtworkKit && in_kit);
2738 
2739  virtual ~ArtworkKit();
2740 
2741  HPS::Type ObjectType() const { return HPS::Type::PublishArtworkKit; }
2742 
2746  static ArtworkKit GetDefault();
2747 
2750  void Set(ArtworkKit const & in_kit);
2751 
2754  void Show(ArtworkKit & out_kit) const;
2755 
2759  ArtworkKit & operator=(ArtworkKit const & in_kit);
2760 
2764  ArtworkKit & operator=(ArtworkKit && in_kit);
2765 
2768  bool Empty() const;
2769 
2773  bool Equals(ArtworkKit const & in_kit) const;
2774 
2778  bool operator==(ArtworkKit const & in_kit) const;
2779 
2783  bool operator!=(ArtworkKit const & in_kit) const;
2784 
2785 
2789  ArtworkKit & SetAnimationStyle(Animation::Style in_style);
2790 
2795  ArtworkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
2796 
2800  ArtworkKit & SetPMICrossHighlighting(bool in_state);
2801 
2805  ArtworkKit & SetPMISemanticInformation(bool in_state);
2806 
2810  ArtworkKit & SetDefaultViewPreference(Artwork::View::Preference in_preference);
2811 
2815  ArtworkKit & SetDisplayPreference(Artwork::Display::Preference in_preference);
2816 
2820  ArtworkKit & SetView(ViewKit const & in_view);
2821 
2825  ArtworkKit & AddView(ViewKit const & in_view);
2826 
2831  ArtworkKit & SetViews(size_t in_count, ViewKit const in_views[]);
2832 
2836  ArtworkKit & SetViews(ViewKitArray const & in_views);
2837 
2842  ArtworkKit & AddViews(size_t in_count, ViewKit const in_views[]);
2843 
2847  ArtworkKit & AddViews(ViewKitArray const & in_views);
2848 
2852  ArtworkKit & SetPMIColor(HPS::RGBColor const & in_pmi_color);
2853 
2854 
2857  ArtworkKit & UnsetAnimationStyle();
2858 
2861  ArtworkKit & UnsetJavaScript();
2862 
2865  ArtworkKit & UnsetPMICrossHighlighting();
2866 
2869  ArtworkKit & UnsetPMISemanticInformation();
2870 
2873  ArtworkKit & UnsetDefaultViewPreference();
2874 
2877  ArtworkKit & UnsetDisplayPreference();
2878 
2882  ArtworkKit & UnsetView(size_t in_index);
2883 
2888  ArtworkKit & UnsetViews(size_t in_count, size_t const in_indices[]);
2889 
2893  ArtworkKit & UnsetViews(SizeTArray const & in_indices);
2894 
2897  ArtworkKit & UnsetViews();
2898 
2901  ArtworkKit & UnsetPMIColor();
2902 
2905  ArtworkKit & UnsetEverything();
2906 
2907 
2911  bool ShowAnimationStyle(Animation::Style & out_style) const;
2912 
2917  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
2918 
2922  bool ShowPMICrossHighlighting(bool & out_state) const;
2923 
2927  bool ShowPMISemanticInformation(bool & out_state) const;
2928 
2932  bool ShowDefaultViewPreference(Artwork::View::Preference & out_preference) const;
2933 
2937  bool ShowDisplayPreference(Artwork::Display::Preference & out_preference) const;
2938 
2942  bool ShowViews(ViewKitArray & out_views) const;
2943 
2947  bool ShowPMIColor(HPS::RGBColor & out_pmi_color) const;
2948  };
2949 
2951  class PUBLISH_API ViewKit : public Sprocket
2952  {
2953  public:
2955  ViewKit();
2956 
2959  ViewKit(ViewKit const & in_kit);
2960 
2963  ViewKit(ViewKit && in_kit);
2964 
2965  virtual ~ViewKit();
2966 
2967  HPS::Type ObjectType() const { return HPS::Type::PublishViewKit; }
2968 
2972  static ViewKit GetDefault();
2973 
2976  void Set(ViewKit const & in_kit);
2977 
2980  void Show(ViewKit & out_kit) const;
2981 
2985  ViewKit & operator=(ViewKit const & in_kit);
2986 
2990  ViewKit & operator=(ViewKit && in_kit);
2991 
2994  bool Empty() const;
2995 
2999  bool Equals(ViewKit const & in_kit) const;
3000 
3004  bool operator==(ViewKit const & in_kit) const;
3005 
3009  bool operator!=(ViewKit const & in_kit) const;
3010 
3011 
3015  ViewKit & SetInternalName(char const * in_name);
3016 
3020  ViewKit & SetExternalName(char const * in_name);
3021 
3030  ViewKit & SetCamera(CameraKit const & in_camera);
3031 
3035  ViewKit & SetDefault(bool in_state);
3036 
3040  ViewKit & SetBackgroundColor(RGBColor const & in_color);
3041 
3045  ViewKit & SetLighting(Lighting::Mode in_mode);
3046 
3050  ViewKit & SetRendering(Rendering::Mode in_mode);
3051 
3052 
3055  ViewKit & UnsetInternalName();
3056 
3059  ViewKit & UnsetExternalName();
3060 
3063  ViewKit & UnsetCamera();
3064 
3067  ViewKit & UnsetDefault();
3068 
3071  ViewKit & UnsetBackgroundColor();
3072 
3075  ViewKit & UnsetLighting();
3076 
3079  ViewKit & UnsetRendering();
3080 
3083  ViewKit & UnsetEverything();
3084 
3085 
3089  bool ShowInternalName(UTF8 & out_name) const;
3090 
3094  bool ShowExternalName(UTF8 & out_name) const;
3095 
3099  bool ShowCamera(CameraKit & out_camera) const;
3100 
3104  bool ShowDefault(bool & out_state) const;
3105 
3109  bool ShowBackgroundColor(RGBColor & out_color) const;
3110 
3114  bool ShowLighting(Lighting::Mode & out_mode) const;
3115 
3119  bool ShowRendering(Rendering::Mode & out_mode) const;
3120  };
3121 
3123  class PUBLISH_API TextKit : public Sprocket
3124  {
3125  public:
3127  TextKit();
3128 
3131  TextKit(TextKit const & in_kit);
3132 
3135  TextKit(TextKit && in_kit);
3136 
3137  virtual ~TextKit();
3138 
3139  HPS::Type ObjectType() const { return HPS::Type::PublishTextKit; }
3140 
3144  static TextKit GetDefault();
3145 
3148  void Set(TextKit const & in_kit);
3149 
3152  void Show(TextKit & out_kit) const;
3153 
3157  TextKit & operator=(TextKit const & in_kit);
3158 
3162  TextKit & operator=(TextKit && in_kit);
3163 
3166  bool Empty() const;
3167 
3171  bool Equals(TextKit const & in_kit) const;
3172 
3176  bool operator==(TextKit const & in_kit) const;
3177 
3181  bool operator!=(TextKit const & in_kit) const;
3182 
3183 
3188  TextKit & SetText(char const * in_text);
3189 
3193  TextKit & SetFont(Text::Font::Name in_font);
3194 
3200  TextKit & SetFont(char const * in_font_name, Text::Language in_language, bool in_embed_font);
3201 
3206  TextKit & SetSize(int in_size);
3207 
3212  TextKit & SetColor(RGBColor const & in_color);
3213 
3214 
3217  TextKit & UnsetText();
3218 
3221  TextKit & UnsetFont();
3222 
3225  TextKit & UnsetSize();
3226 
3229  TextKit & UnsetColor();
3230 
3233  TextKit & UnsetEverything();
3234 
3235 
3239  bool ShowText(UTF8 & out_text) const;
3240 
3248  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;
3249 
3253  bool ShowSize(int & out_size) const;
3254 
3258  bool ShowColor(RGBColor & out_color) const;
3259  };
3260 
3262  class PUBLISH_API ImageKit : public Sprocket
3263  {
3264  public:
3266  ImageKit();
3267 
3270  ImageKit(ImageKit const & in_kit);
3271 
3274  ImageKit(ImageKit && in_kit);
3275 
3276  virtual ~ImageKit();
3277 
3278  HPS::Type ObjectType() const { return HPS::Type::PublishImageKit; }
3279 
3280  // no GetDefault() since function doesn't make sense for this class
3281 
3284  void Set(ImageKit const & in_kit);
3285 
3288  void Show(ImageKit & out_kit) const;
3289 
3293  ImageKit & operator=(ImageKit const & in_kit);
3294 
3298  ImageKit & operator=(ImageKit && in_kit);
3299 
3302  bool Empty() const;
3303 
3307  bool Equals(ImageKit const & in_kit) const;
3308 
3312  bool operator==(ImageKit const & in_kit) const;
3313 
3317  bool operator!=(ImageKit const & in_kit) const;
3318 
3319 
3323  ImageKit & SetFile(char const * in_filename);
3324 
3330  ImageKit & SetSize(int in_width, int in_height);
3331 
3335  ImageKit & SetFormat(Image::Format in_format);
3336 
3337 
3340  ImageKit & UnsetFile();
3341 
3344  ImageKit & UnsetSize();
3345 
3348  ImageKit & UnsetFormat();
3349 
3352  ImageKit & UnsetEverything();
3353 
3354 
3358  bool ShowFile(UTF8 & out_filename) const;
3359 
3364  bool ShowSize(int & out_width, int & out_height) const;
3365 
3369  bool ShowFormat(Image::Format & out_format) const;
3370  };
3371 
3374  class PUBLISH_API TableKit : public Sprocket
3375  {
3376  public:
3378  TableKit();
3379 
3382  TableKit(TableKit const & in_kit);
3383 
3386  TableKit(TableKit && in_kit);
3387 
3388  virtual ~TableKit();
3389 
3390  HPS::Type ObjectType() const { return HPS::Type::PublishTableKit; }
3391 
3392  // no GetDefault() since function doesn't make sense for this class
3393 
3396  void Set(TableKit const & in_kit);
3397 
3400  void Show(TableKit & out_kit) const;
3401 
3405  TableKit & operator=(TableKit const & in_kit);
3406 
3410  TableKit & operator=(TableKit && in_kit);
3411 
3414  bool Empty() const;
3415 
3419  bool Equals(TableKit const & in_kit) const;
3420 
3424  bool operator==(TableKit const & in_kit) const;
3425 
3429  bool operator!=(TableKit const & in_kit) const;
3430 
3431 
3436  TableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3437 
3442  TableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3443 
3449  TableKit & SetLink(int in_row, int in_column, LinkKit const & in_link);
3450 
3456  TableKit & SetText(int in_row, int in_column, TextKit const & in_text);
3457 
3463  TableKit & SetButton(int in_row, int in_column, ButtonKit const & in_button);
3464 
3470  TableKit & SetTextField(int in_row, int in_column, TextFieldKit const & in_text_field);
3471 
3472 
3475  TableKit & UnsetHTML();
3476 
3479  TableKit & UnsetHTMLStyle();
3480 
3483  TableKit & UnsetLink(int in_row, int in_column);
3484 
3487  TableKit & UnsetText(int in_row, int in_column);
3488 
3491  TableKit & UnsetButton(int in_row, int in_column);
3492 
3495  TableKit & UnsetTextField(int in_row, int in_column);
3496 
3499  TableKit & UnsetEverything();
3500 
3501 
3506  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3507 
3512  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3513 
3519  bool ShowLink(int in_row, int in_column, LinkKit & out_link) const;
3520 
3526  bool ShowText(int in_row, int in_column, TextKit & out_text) const;
3527 
3533  bool ShowButton(int in_row, int in_column, ButtonKit & out_button) const;
3534 
3540  bool ShowTextField(int in_row, int in_column, TextFieldKit & out_text_field) const;
3541  };
3542 
3545  class PUBLISH_API SlideTableKit : public Sprocket
3546  {
3547  public:
3549  SlideTableKit();
3550 
3553  SlideTableKit(SlideTableKit const & in_kit);
3554 
3557  SlideTableKit(SlideTableKit && in_kit);
3558 
3559  virtual ~SlideTableKit();
3560 
3561  HPS::Type ObjectType() const { return HPS::Type::PublishSlideTableKit; }
3562 
3563  // no GetDefault() since function doesn't make sense for this class
3564 
3567  void Set(SlideTableKit const & in_kit);
3568 
3571  void Show(SlideTableKit & out_kit) const;
3572 
3576  SlideTableKit & operator=(SlideTableKit const & in_kit);
3577 
3581  SlideTableKit & operator=(SlideTableKit && in_kit);
3582 
3585  bool Empty() const;
3586 
3590  bool Equals(SlideTableKit const & in_kit) const;
3591 
3595  bool operator==(SlideTableKit const & in_kit) const;
3596 
3600  bool operator!=(SlideTableKit const & in_kit) const;
3601 
3602 
3607  SlideTableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3608 
3613  SlideTableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3614 
3619  SlideTableKit & SetButtons(char const * in_previous_button_name, char const * in_next_button_name);
3620 
3626  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKit const in_text[]);
3627 
3633  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKitArray const & in_text);
3634 
3638  SlideTableKit & SetHeader(bool in_state);
3639 
3640 
3643  SlideTableKit & UnsetHTML();
3644 
3647  SlideTableKit & UnsetHTMLStyle();
3648 
3651  SlideTableKit & UnsetButtons();
3652 
3655  SlideTableKit & UnsetText();
3656 
3659  SlideTableKit & UnsetHeader();
3660 
3663  SlideTableKit & UnsetEverything();
3664 
3665 
3670  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3671 
3676  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3677 
3682  bool ShowButtons(UTF8 & out_previous_button_name, UTF8 & out_next_button_name) const;
3683 
3689  bool ShowText(size_t & out_rows, size_t & out_columns, TextFieldKitArray & out_text) const;
3690 
3694  bool ShowHeader(bool & out_state) const;
3695  };
3696 
3698  class PUBLISH_API LinkKit : public Sprocket
3699  {
3700  public:
3702  LinkKit();
3703 
3706  LinkKit(LinkKit const & in_kit);
3707 
3710  LinkKit(LinkKit && in_kit);
3711 
3712  virtual ~LinkKit();
3713 
3714  HPS::Type ObjectType() const { return HPS::Type::PublishLinkKit; }
3715 
3716  // no GetDefault() since function doesn't make sense for this class
3717 
3720  void Set(LinkKit const & in_kit);
3721 
3724  void Show(LinkKit & out_kit) const;
3725 
3729  LinkKit & operator=(LinkKit const & in_kit);
3730 
3734  LinkKit & operator=(LinkKit && in_kit);
3735 
3738  bool Empty() const;
3739 
3743  bool Equals(LinkKit const & in_kit) const;
3744 
3748  bool operator==(LinkKit const & in_kit) const;
3749 
3753  bool operator!=(LinkKit const & in_kit) const;
3754 
3755 
3760  LinkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
3761 
3765  LinkKit & SetBorderWidth(int in_width);
3766 
3770  LinkKit & SetHighlighting(Highlighting::Mode in_mode);
3771 
3775  LinkKit & SetBorderColor(RGBColor const & in_color);
3776 
3777 
3780  LinkKit & UnsetJavaScript();
3781 
3784  LinkKit & UnsetBorderWidth();
3785 
3788  LinkKit & UnsetHighlighting();
3789 
3792  LinkKit & UnsetBorderColor();
3793 
3796  LinkKit & UnsetEverything();
3797 
3798 
3803  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
3804 
3808  bool ShowBorderWidth(int & out_width) const;
3809 
3813  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
3814 
3818  bool ShowBorderColor(RGBColor & out_color) const;
3819  };
3820 
3822  class PUBLISH_API ButtonKit : public Sprocket
3823  {
3824  public:
3826  ButtonKit();
3827 
3830  ButtonKit(ButtonKit const & in_kit);
3831 
3834  ButtonKit(ButtonKit && in_kit);
3835 
3836  virtual ~ButtonKit();
3837 
3838  HPS::Type ObjectType() const { return HPS::Type::PublishButtonKit; }
3839 
3843  static ButtonKit GetDefault();
3844 
3847  void Set(ButtonKit const & in_kit);
3848 
3851  void Show(ButtonKit & out_kit) const;
3852 
3856  ButtonKit & operator=(ButtonKit const & in_kit);
3857 
3861  ButtonKit & operator=(ButtonKit && in_kit);
3862 
3865  bool Empty() const;
3866 
3870  bool Equals(ButtonKit const & in_kit) const;
3871 
3875  bool operator==(ButtonKit const & in_kit) const;
3876 
3880  bool operator!=(ButtonKit const & in_kit) const;
3881 
3882 
3886  ButtonKit & SetName(char const * in_name);
3887 
3891  ButtonKit & SetLabel(char const * in_label);
3892 
3896  ButtonKit & SetFont(Text::Font::Name in_name);
3897 
3902  ButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
3903 
3907  ButtonKit & SetFontSize(int in_size);
3908 
3912  ButtonKit & SetTextColor(RGBColor const & in_color);
3913 
3917  ButtonKit & SetTooltip(char const * in_tooltip);
3918 
3922  ButtonKit & SetVisibility(bool in_state);
3923 
3927  ButtonKit & SetPrintability(bool in_state);
3928 
3932  ButtonKit & SetTextRotation(Text::Rotation in_rotation);
3933 
3937  ButtonKit & SetLock(bool in_state);
3938 
3942  ButtonKit & SetBorder(bool in_state);
3943 
3947  ButtonKit & SetBorderColor(RGBColor const & in_color);
3948 
3952  ButtonKit & SetBorderThickness(Border::Thickness in_thickness);
3953 
3957  ButtonKit & SetBorderStyle(Border::Style in_style);
3958 
3963  ButtonKit & SetFillColor(RGBColor const & in_color);
3964 
3968  ButtonKit & SetLabelPosition(Label::Position in_position);
3969 
3973  ButtonKit & SetHighlighting(Highlighting::Mode in_mode);
3974 
3978  ButtonKit & SetIconImage(ImageKit const & in_image);
3979 
3980 
3983  ButtonKit & UnsetName();
3984 
3987  ButtonKit & UnsetLabel();
3988 
3991  ButtonKit & UnsetFont();
3992 
3995  ButtonKit & UnsetFontSize();
3996 
3999  ButtonKit & UnsetTextColor();
4000 
4003  ButtonKit & UnsetTooltip();
4004 
4007  ButtonKit & UnsetVisibility();
4008 
4011  ButtonKit & UnsetPrintability();
4012 
4015  ButtonKit & UnsetTextRotation();
4016 
4019  ButtonKit & UnsetLock();
4020 
4023  ButtonKit & UnsetBorder();
4024 
4027  ButtonKit & UnsetBorderColor();
4028 
4031  ButtonKit & UnsetBorderThickness();
4032 
4035  ButtonKit & UnsetBorderStyle();
4036 
4039  ButtonKit & UnsetFillColor();
4040 
4043  ButtonKit & UnsetLabelPosition();
4044 
4047  ButtonKit & UnsetHighlighting();
4048 
4051  ButtonKit & UnsetIconImage();
4052 
4055  ButtonKit & UnsetEverything();
4056 
4057 
4061  bool ShowName(UTF8 & out_name) const;
4062 
4066  bool ShowLabel(UTF8 & out_label) const;
4067 
4074  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4075 
4079  bool ShowFontSize(int & out_size) const;
4080 
4084  bool ShowTextColor(RGBColor & out_color) const;
4085 
4089  bool ShowTooltip(UTF8 & out_tooltip) const;
4090 
4094  bool ShowVisibility(bool & out_state) const;
4095 
4099  bool ShowPrintability(bool & out_state) const;
4100 
4104  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4105 
4109  bool ShowLock(bool & out_state) const;
4110 
4114  bool ShowBorder(bool & out_state) const;
4115 
4119  bool ShowBorderColor(RGBColor & out_color) const;
4120 
4124  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4125 
4129  bool ShowBorderStyle(Border::Style & out_style) const;
4130 
4134  bool ShowFillColor(RGBColor & out_color) const;
4135 
4139  bool ShowLabelPosition(Label::Position & out_position) const;
4140 
4144  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
4145 
4149  bool ShowIconImage(ImageKit & out_image) const;
4150  };
4151 
4153  class PUBLISH_API CheckBoxKit : public Sprocket
4154  {
4155  public:
4157  CheckBoxKit();
4158 
4161  CheckBoxKit(CheckBoxKit const & in_kit);
4162 
4165  CheckBoxKit(CheckBoxKit && in_kit);
4166 
4167  virtual ~CheckBoxKit();
4168 
4169  HPS::Type ObjectType() const { return HPS::Type::PublishCheckBoxKit; }
4170 
4174  static CheckBoxKit GetDefault();
4175 
4178  void Set(CheckBoxKit const & in_kit);
4179 
4182  void Show(CheckBoxKit & out_kit) const;
4183 
4187  CheckBoxKit & operator=(CheckBoxKit const & in_kit);
4188 
4192  CheckBoxKit & operator=(CheckBoxKit && in_kit);
4193 
4196  bool Empty() const;
4197 
4201  bool Equals(CheckBoxKit const & in_kit) const;
4202 
4206  bool operator==(CheckBoxKit const & in_kit) const;
4207 
4211  bool operator!=(CheckBoxKit const & in_kit) const;
4212 
4213 
4217  CheckBoxKit & SetName(char const * in_name);
4218 
4222  CheckBoxKit & SetFont(Text::Font::Name in_name);
4223 
4228  CheckBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4229 
4233  CheckBoxKit & SetFontSize(int in_size);
4234 
4238  CheckBoxKit & SetTextColor(RGBColor const & in_color);
4239 
4243  CheckBoxKit & SetTooltip(char const * in_tooltip);
4244 
4248  CheckBoxKit & SetVisibility(bool in_state);
4249 
4253  CheckBoxKit & SetPrintability(bool in_state);
4254 
4258  CheckBoxKit & SetTextRotation(Text::Rotation in_rotation);
4259 
4263  CheckBoxKit & SetLock(bool in_state);
4264 
4268  CheckBoxKit & SetBorder(bool in_state);
4269 
4273  CheckBoxKit & SetBorderColor(RGBColor const & in_color);
4274 
4278  CheckBoxKit & SetBorderThickness(Border::Thickness in_thickness);
4279 
4283  CheckBoxKit & SetBorderStyle(Border::Style in_style);
4284 
4289  CheckBoxKit & SetFillColor(RGBColor const & in_color);
4290 
4294  CheckBoxKit & SetExportValue(char const * in_export_value);
4295 
4299  CheckBoxKit & SetDefaultState(bool in_state);
4300 
4301 
4304  CheckBoxKit & UnsetName();
4305 
4308  CheckBoxKit & UnsetFont();
4309 
4312  CheckBoxKit & UnsetFontSize();
4313 
4316  CheckBoxKit & UnsetTextColor();
4317 
4320  CheckBoxKit & UnsetTooltip();
4321 
4324  CheckBoxKit & UnsetVisibility();
4325 
4328  CheckBoxKit & UnsetPrintability();
4329 
4332  CheckBoxKit & UnsetTextRotation();
4333 
4336  CheckBoxKit & UnsetLock();
4337 
4340  CheckBoxKit & UnsetBorder();
4341 
4344  CheckBoxKit & UnsetBorderColor();
4345 
4348  CheckBoxKit & UnsetBorderThickness();
4349 
4352  CheckBoxKit & UnsetBorderStyle();
4353 
4356  CheckBoxKit & UnsetFillColor();
4357 
4360  CheckBoxKit & UnsetExportValue();
4361 
4364  CheckBoxKit & UnsetDefaultState();
4365 
4368  CheckBoxKit & UnsetEverything();
4369 
4370 
4374  bool ShowName(UTF8 & out_name) const;
4375 
4382  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4383 
4387  bool ShowFontSize(int & out_size) const;
4388 
4392  bool ShowTextColor(RGBColor & out_color) const;
4393 
4397  bool ShowTooltip(UTF8 & out_tooltip) const;
4398 
4402  bool ShowVisibility(bool & out_state) const;
4403 
4407  bool ShowPrintability(bool & out_state) const;
4408 
4412  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4413 
4417  bool ShowLock(bool & out_state) const;
4418 
4422  bool ShowBorder(bool & out_state) const;
4423 
4427  bool ShowBorderColor(RGBColor & out_color) const;
4428 
4432  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4433 
4437  bool ShowBorderStyle(Border::Style & out_style) const;
4438 
4442  bool ShowFillColor(RGBColor & out_color) const;
4443 
4447  bool ShowExportValue(UTF8 & out_export_value) const;
4448 
4452  bool ShowDefaultState(bool & out_default_state) const;
4453  };
4454 
4456  class PUBLISH_API RadioButtonKit : public Sprocket
4457  {
4458  public:
4460  RadioButtonKit();
4461 
4464  RadioButtonKit(RadioButtonKit const & in_kit);
4465 
4468  RadioButtonKit(RadioButtonKit && in_kit);
4469 
4470  virtual ~RadioButtonKit();
4471 
4472  HPS::Type ObjectType() const { return HPS::Type::PublishRadioButtonKit; }
4473 
4477  static RadioButtonKit GetDefault();
4478 
4481  void Set(RadioButtonKit const & in_kit);
4482 
4485  void Show(RadioButtonKit & out_kit) const;
4486 
4490  RadioButtonKit & operator=(RadioButtonKit const & in_kit);
4491 
4495  RadioButtonKit & operator=(RadioButtonKit && in_kit);
4496 
4499  bool Empty() const;
4500 
4504  bool Equals(RadioButtonKit const & in_kit) const;
4505 
4509  bool operator==(RadioButtonKit const & in_kit) const;
4510 
4514  bool operator!=(RadioButtonKit const & in_kit) const;
4515 
4516 
4520  RadioButtonKit & SetName(char const * in_name);
4521 
4525  RadioButtonKit & SetFont(Text::Font::Name in_name);
4526 
4531  RadioButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4532 
4536  RadioButtonKit & SetFontSize(int in_size);
4537 
4541  RadioButtonKit & SetTextColor(RGBColor const & in_color);
4542 
4546  RadioButtonKit & SetTooltip(char const * in_tooltip);
4547 
4551  RadioButtonKit & SetVisibility(bool in_state);
4552 
4556  RadioButtonKit & SetPrintability(bool in_state);
4557 
4561  RadioButtonKit & SetTextRotation(Text::Rotation in_rotation);
4562 
4566  RadioButtonKit & SetLock(bool in_state);
4567 
4571  RadioButtonKit & SetBorder(bool in_state);
4572 
4576  RadioButtonKit & SetBorderColor(RGBColor const & in_color);
4577 
4581  RadioButtonKit & SetBorderThickness(Border::Thickness in_thickness);
4582 
4586  RadioButtonKit & SetBorderStyle(Border::Style in_style);
4587 
4592  RadioButtonKit & SetFillColor(RGBColor const & in_color);
4593 
4597  RadioButtonKit & SetExportValue(char const * in_export_value);
4598 
4602  RadioButtonKit & SetDefaultState(bool in_state);
4603 
4607  RadioButtonKit & SetGrouping(bool in_state);
4608 
4609 
4612  RadioButtonKit & UnsetName();
4613 
4616  RadioButtonKit & UnsetFont();
4617 
4620  RadioButtonKit & UnsetFontSize();
4621 
4624  RadioButtonKit & UnsetTextColor();
4625 
4628  RadioButtonKit & UnsetTooltip();
4629 
4632  RadioButtonKit & UnsetVisibility();
4633 
4636  RadioButtonKit & UnsetPrintability();
4637 
4640  RadioButtonKit & UnsetTextRotation();
4641 
4644  RadioButtonKit & UnsetLock();
4645 
4648  RadioButtonKit & UnsetBorder();
4649 
4652  RadioButtonKit & UnsetBorderColor();
4653 
4656  RadioButtonKit & UnsetBorderThickness();
4657 
4660  RadioButtonKit & UnsetBorderStyle();
4661 
4664  RadioButtonKit & UnsetFillColor();
4665 
4668  RadioButtonKit & UnsetExportValue();
4669 
4672  RadioButtonKit & UnsetDefaultState();
4673 
4676  RadioButtonKit & UnsetGrouping();
4677 
4680  RadioButtonKit & UnsetEverything();
4681 
4682 
4686  bool ShowName(UTF8 & out_name) const;
4687 
4694  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4695 
4699  bool ShowFontSize(int & out_size) const;
4700 
4704  bool ShowTextColor(RGBColor & out_color) const;
4705 
4709  bool ShowTooltip(UTF8 & out_tooltip) const;
4710 
4714  bool ShowVisibility(bool & out_state) const;
4715 
4719  bool ShowPrintability(bool & out_state) const;
4720 
4724  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4725 
4729  bool ShowLock(bool & out_state) const;
4730 
4734  bool ShowBorder(bool & out_state) const;
4735 
4739  bool ShowBorderColor(RGBColor & out_color) const;
4740 
4744  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4745 
4749  bool ShowBorderStyle(Border::Style & out_style) const;
4750 
4754  bool ShowFillColor(RGBColor & out_color) const;
4755 
4759  bool ShowExportValue(UTF8 & out_export_value) const;
4760 
4764  bool ShowDefaultState(bool & out_default_state) const;
4765 
4769  bool ShowGrouping(bool & out_grouping) const;
4770  };
4771 
4773  class PUBLISH_API ListBoxKit : public Sprocket
4774  {
4775  public:
4777  ListBoxKit();
4778 
4781  ListBoxKit(ListBoxKit const & in_kit);
4782 
4785  ListBoxKit(ListBoxKit && in_kit);
4786 
4787  virtual ~ListBoxKit();
4788 
4789  HPS::Type ObjectType() const { return HPS::Type::PublishListBoxKit; }
4790 
4794  static ListBoxKit GetDefault();
4795 
4798  void Set(ListBoxKit const & in_kit);
4799 
4802  void Show(ListBoxKit & out_kit) const;
4803 
4807  ListBoxKit & operator=(ListBoxKit const & in_kit);
4808 
4812  ListBoxKit & operator=(ListBoxKit && in_kit);
4813 
4816  bool Empty() const;
4817 
4821  bool Equals(ListBoxKit const & in_kit) const;
4822 
4826  bool operator==(ListBoxKit const & in_kit) const;
4827 
4831  bool operator!=(ListBoxKit const & in_kit) const;
4832 
4833 
4837  ListBoxKit & SetName(char const * in_name);
4838 
4842  ListBoxKit & SetFont(Text::Font::Name in_name);
4843 
4848  ListBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4849 
4853  ListBoxKit & SetFontSize(int in_size);
4854 
4858  ListBoxKit & SetTextColor(RGBColor const & in_color);
4859 
4863  ListBoxKit & SetTooltip(char const * in_tooltip);
4864 
4868  ListBoxKit & SetVisibility(bool in_state);
4869 
4873  ListBoxKit & SetPrintability(bool in_state);
4874 
4878  ListBoxKit & SetTextRotation(Text::Rotation in_rotation);
4879 
4883  ListBoxKit & SetLock(bool in_state);
4884 
4888  ListBoxKit & SetBorder(bool in_state);
4889 
4893  ListBoxKit & SetBorderColor(RGBColor const & in_color);
4894 
4898  ListBoxKit & SetBorderThickness(Border::Thickness in_thickness);
4899 
4903  ListBoxKit & SetBorderStyle(Border::Style in_style);
4904 
4909  ListBoxKit & SetFillColor(RGBColor const & in_color);
4910 
4914  ListBoxKit & SetMultipleSelection(bool in_state);
4915 
4921  ListBoxKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
4922 
4928  ListBoxKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
4929 
4930 
4933  ListBoxKit & UnsetName();
4934 
4937  ListBoxKit & UnsetFont();
4938 
4941  ListBoxKit & UnsetFontSize();
4942 
4945  ListBoxKit & UnsetTextColor();
4946 
4949  ListBoxKit & UnsetTooltip();
4950 
4953  ListBoxKit & UnsetVisibility();
4954 
4957  ListBoxKit & UnsetPrintability();
4958 
4961  ListBoxKit & UnsetTextRotation();
4962 
4965  ListBoxKit & UnsetLock();
4966 
4969  ListBoxKit & UnsetBorder();
4970 
4973  ListBoxKit & UnsetBorderColor();
4974 
4977  ListBoxKit & UnsetBorderThickness();
4978 
4981  ListBoxKit & UnsetBorderStyle();
4982 
4985  ListBoxKit & UnsetFillColor();
4986 
4989  ListBoxKit & UnsetMultipleSelection();
4990 
4993  ListBoxKit & UnsetContents();
4994 
4997  ListBoxKit & UnsetEverything();
4998 
4999 
5003  bool ShowName(UTF8 & out_name) const;
5004 
5011  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5012 
5016  bool ShowFontSize(int & out_size) const;
5017 
5021  bool ShowTextColor(RGBColor & out_color) const;
5022 
5026  bool ShowTooltip(UTF8 & out_tooltip) const;
5027 
5031  bool ShowVisibility(bool & out_state) const;
5032 
5036  bool ShowPrintability(bool & out_state) const;
5037 
5041  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5042 
5046  bool ShowLock(bool & out_state) const;
5047 
5051  bool ShowBorder(bool & out_state) const;
5052 
5056  bool ShowBorderColor(RGBColor & out_color) const;
5057 
5061  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5062 
5066  bool ShowBorderStyle(Border::Style & out_style) const;
5067 
5071  bool ShowFillColor(RGBColor & out_color) const;
5072 
5076  bool ShowMultipleSelection(bool & out_state) const;
5077 
5082  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5083  };
5084 
5086  class PUBLISH_API DropDownListKit : public Sprocket
5087  {
5088  public:
5090  DropDownListKit();
5091 
5094  DropDownListKit(DropDownListKit const & in_kit);
5095 
5098  DropDownListKit(DropDownListKit && in_kit);
5099 
5100  virtual ~DropDownListKit();
5101 
5102  HPS::Type ObjectType() const { return HPS::Type::PublishDropDownListKit; }
5103 
5107  static DropDownListKit GetDefault();
5108 
5111  void Set(DropDownListKit const & in_kit);
5112 
5115  void Show(DropDownListKit & out_kit) const;
5116 
5120  DropDownListKit & operator=(DropDownListKit const & in_kit);
5121 
5125  DropDownListKit & operator=(DropDownListKit && in_kit);
5126 
5129  bool Empty() const;
5130 
5134  bool Equals(DropDownListKit const & in_kit) const;
5135 
5139  bool operator==(DropDownListKit const & in_kit) const;
5140 
5144  bool operator!=(DropDownListKit const & in_kit) const;
5145 
5146 
5150  DropDownListKit & SetName(char const * in_name);
5151 
5155  DropDownListKit & SetFont(Text::Font::Name in_name);
5156 
5161  DropDownListKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5162 
5166  DropDownListKit & SetFontSize(int in_size);
5167 
5171  DropDownListKit & SetTextColor(RGBColor const & in_color);
5172 
5176  DropDownListKit & SetTooltip(char const * in_tooltip);
5177 
5181  DropDownListKit & SetVisibility(bool in_state);
5182 
5186  DropDownListKit & SetPrintability(bool in_state);
5187 
5191  DropDownListKit & SetTextRotation(Text::Rotation in_rotation);
5192 
5196  DropDownListKit & SetLock(bool in_state);
5197 
5201  DropDownListKit & SetBorder(bool in_state);
5202 
5206  DropDownListKit & SetBorderColor(RGBColor const & in_color);
5207 
5211  DropDownListKit & SetBorderThickness(Border::Thickness in_thickness);
5212 
5216  DropDownListKit & SetBorderStyle(Border::Style in_style);
5217 
5222  DropDownListKit & SetFillColor(RGBColor const & in_color);
5223 
5227  DropDownListKit & SetCustomText(bool in_state);
5228 
5232  DropDownListKit & SetSpellChecking(bool in_state);
5233 
5237  DropDownListKit & SetImmediateCommit(bool in_state);
5238 
5244  DropDownListKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
5245 
5251  DropDownListKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
5252 
5253 
5256  DropDownListKit & UnsetName();
5257 
5260  DropDownListKit & UnsetFont();
5261 
5264  DropDownListKit & UnsetFontSize();
5265 
5268  DropDownListKit & UnsetTextColor();
5269 
5272  DropDownListKit & UnsetTooltip();
5273 
5276  DropDownListKit & UnsetVisibility();
5277 
5280  DropDownListKit & UnsetPrintability();
5281 
5284  DropDownListKit & UnsetTextRotation();
5285 
5288  DropDownListKit & UnsetLock();
5289 
5292  DropDownListKit & UnsetBorder();
5293 
5296  DropDownListKit & UnsetBorderColor();
5297 
5300  DropDownListKit & UnsetBorderThickness();
5301 
5304  DropDownListKit & UnsetBorderStyle();
5305 
5308  DropDownListKit & UnsetFillColor();
5309 
5312  DropDownListKit & UnsetCustomText();
5313 
5316  DropDownListKit & UnsetSpellChecking();
5317 
5320  DropDownListKit & UnsetImmediateCommit();
5321 
5324  DropDownListKit & UnsetContents();
5325 
5328  DropDownListKit & UnsetEverything();
5329 
5330 
5334  bool ShowName(UTF8 & out_name) const;
5335 
5342  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5343 
5347  bool ShowFontSize(int & out_size) const;
5348 
5352  bool ShowTextColor(RGBColor & out_color) const;
5353 
5357  bool ShowTooltip(UTF8 & out_tooltip) const;
5358 
5362  bool ShowVisibility(bool & out_state) const;
5363 
5367  bool ShowPrintability(bool & out_state) const;
5368 
5372  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5373 
5377  bool ShowLock(bool & out_state) const;
5378 
5382  bool ShowBorder(bool & out_state) const;
5383 
5387  bool ShowBorderColor(RGBColor & out_color) const;
5388 
5392  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5393 
5397  bool ShowBorderStyle(Border::Style & out_style) const;
5398 
5402  bool ShowFillColor(RGBColor & out_color) const;
5403 
5407  bool ShowCustomText(bool & out_state) const;
5408 
5412  bool ShowSpellChecking(bool & out_state) const;
5413 
5417  bool ShowImmediateCommit(bool & out_state) const;
5418 
5423  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5424  };
5425 
5427  class PUBLISH_API SignatureFieldKit : public Sprocket
5428  {
5429  public:
5432 
5435  SignatureFieldKit(SignatureFieldKit const & in_kit);
5436 
5440 
5441  virtual ~SignatureFieldKit();
5442 
5443  HPS::Type ObjectType() const { return HPS::Type::PublishSignatureFieldKit; }
5444 
5448  static SignatureFieldKit GetDefault();
5449 
5452  void Set(SignatureFieldKit const & in_kit);
5453 
5456  void Show(SignatureFieldKit & out_kit) const;
5457 
5461  SignatureFieldKit & operator=(SignatureFieldKit const & in_kit);
5462 
5466  SignatureFieldKit & operator=(SignatureFieldKit && in_kit);
5467 
5470  bool Empty() const;
5471 
5475  bool Equals(SignatureFieldKit const & in_kit) const;
5476 
5480  bool operator==(SignatureFieldKit const & in_kit) const;
5481 
5485  bool operator!=(SignatureFieldKit const & in_kit) const;
5486 
5487 
5491  SignatureFieldKit & SetName(char const * in_name);
5492 
5496  SignatureFieldKit & SetFont(Text::Font::Name in_name);
5497 
5502  SignatureFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5503 
5507  SignatureFieldKit & SetFontSize(int in_size);
5508 
5512  SignatureFieldKit & SetTextColor(RGBColor const & in_color);
5513 
5517  SignatureFieldKit & SetTooltip(char const * in_tooltip);
5518 
5522  SignatureFieldKit & SetVisibility(bool in_state);
5523 
5527  SignatureFieldKit & SetPrintability(bool in_state);
5528 
5532  SignatureFieldKit & SetTextRotation(Text::Rotation in_rotation);
5533 
5537  SignatureFieldKit & SetLock(bool in_state);
5538 
5542  SignatureFieldKit & SetBorder(bool in_state);
5543 
5547  SignatureFieldKit & SetBorderColor(RGBColor const & in_color);
5548 
5552  SignatureFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5553 
5557  SignatureFieldKit & SetBorderStyle(Border::Style in_style);
5558 
5563  SignatureFieldKit & SetFillColor(RGBColor const & in_color);
5564 
5565 
5568  SignatureFieldKit & UnsetName();
5569 
5572  SignatureFieldKit & UnsetFont();
5573 
5576  SignatureFieldKit & UnsetFontSize();
5577 
5580  SignatureFieldKit & UnsetTextColor();
5581 
5584  SignatureFieldKit & UnsetTooltip();
5585 
5588  SignatureFieldKit & UnsetVisibility();
5589 
5592  SignatureFieldKit & UnsetPrintability();
5593 
5596  SignatureFieldKit & UnsetTextRotation();
5597 
5600  SignatureFieldKit & UnsetLock();
5601 
5604  SignatureFieldKit & UnsetBorder();
5605 
5608  SignatureFieldKit & UnsetBorderColor();
5609 
5612  SignatureFieldKit & UnsetBorderThickness();
5613 
5616  SignatureFieldKit & UnsetBorderStyle();
5617 
5620  SignatureFieldKit & UnsetFillColor();
5621 
5624  SignatureFieldKit & UnsetEverything();
5625 
5626 
5630  bool ShowName(UTF8 & out_name) const;
5631 
5638  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5639 
5643  bool ShowFontSize(int & out_size) const;
5644 
5648  bool ShowTextColor(RGBColor & out_color) const;
5649 
5653  bool ShowTooltip(UTF8 & out_tooltip) const;
5654 
5658  bool ShowVisibility(bool & out_state) const;
5659 
5663  bool ShowPrintability(bool & out_state) const;
5664 
5668  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5669 
5673  bool ShowLock(bool & out_state) const;
5674 
5678  bool ShowBorder(bool & out_state) const;
5679 
5683  bool ShowBorderColor(RGBColor & out_color) const;
5684 
5688  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5689 
5693  bool ShowBorderStyle(Border::Style & out_style) const;
5694 
5698  bool ShowFillColor(RGBColor & out_color) const;
5699  };
5700 
5702  class PUBLISH_API TextFieldKit : public Sprocket
5703  {
5704  public:
5706  TextFieldKit();
5707 
5710  TextFieldKit(TextFieldKit const & in_kit);
5711 
5714  TextFieldKit(TextFieldKit && in_kit);
5715 
5716  virtual ~TextFieldKit();
5717 
5718  HPS::Type ObjectType() const { return HPS::Type::PublishTextFieldKit; }
5719 
5723  static TextFieldKit GetDefault();
5724 
5727  void Set(TextFieldKit const & in_kit);
5728 
5731  void Show(TextFieldKit & out_kit) const;
5732 
5736  TextFieldKit & operator=(TextFieldKit const & in_kit);
5737 
5741  TextFieldKit & operator=(TextFieldKit && in_kit);
5742 
5745  bool Empty() const;
5746 
5750  bool Equals(TextFieldKit const & in_kit) const;
5751 
5755  bool operator==(TextFieldKit const & in_kit) const;
5756 
5760  bool operator!=(TextFieldKit const & in_kit) const;
5761 
5762 
5763 
5767  TextFieldKit & SetName(char const * in_name);
5768 
5772  TextFieldKit & SetFont(Text::Font::Name in_name);
5773 
5778  TextFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5779 
5783  TextFieldKit & SetFontSize(int in_size);
5784 
5788  TextFieldKit & SetTextColor(RGBColor const & in_color);
5789 
5793  TextFieldKit & SetTooltip(char const * in_tooltip);
5794 
5798  TextFieldKit & SetVisibility(bool in_state);
5799 
5803  TextFieldKit & SetPrintability(bool in_state);
5804 
5808  TextFieldKit & SetTextRotation(Text::Rotation in_rotation);
5809 
5813  TextFieldKit & SetLock(bool in_state);
5814 
5818  TextFieldKit & SetBorder(bool in_state);
5819 
5823  TextFieldKit & SetBorderColor(RGBColor const & in_color);
5824 
5828  TextFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5829 
5833  TextFieldKit & SetBorderStyle(Border::Style in_style);
5834 
5839  TextFieldKit & SetFillColor(RGBColor const & in_color);
5840 
5844  TextFieldKit & SetDefaultValue(char const * in_value);
5845 
5849  TextFieldKit & SetTextJustification(HPS::Text::Justification in_justification);
5850 
5854  TextFieldKit & SetMultiline(bool in_state);
5855 
5859  TextFieldKit & SetScrolling(bool in_state);
5860 
5864  TextFieldKit & SetReadOnly(bool in_state);
5865 
5866 
5869  TextFieldKit & UnsetName();
5870 
5873  TextFieldKit & UnsetFont();
5874 
5877  TextFieldKit & UnsetFontSize();
5878 
5881  TextFieldKit & UnsetTextColor();
5882 
5885  TextFieldKit & UnsetTooltip();
5886 
5889  TextFieldKit & UnsetVisibility();
5890 
5893  TextFieldKit & UnsetPrintability();
5894 
5897  TextFieldKit & UnsetTextRotation();
5898 
5901  TextFieldKit & UnsetLock();
5902 
5905  TextFieldKit & UnsetBorder();
5906 
5909  TextFieldKit & UnsetBorderColor();
5910 
5913  TextFieldKit & UnsetBorderThickness();
5914 
5917  TextFieldKit & UnsetBorderStyle();
5918 
5921  TextFieldKit & UnsetFillColor();
5922 
5925  TextFieldKit & UnsetDefaultValue();
5926 
5929  TextFieldKit & UnsetTextJustification();
5930 
5933  TextFieldKit & UnsetMultiline();
5934 
5937  TextFieldKit & UnsetScrolling();
5938 
5941  TextFieldKit & UnsetReadOnly();
5942 
5945  TextFieldKit & UnsetEverything();
5946 
5947 
5951  bool ShowName(UTF8 & out_name) const;
5952 
5959  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5960 
5964  bool ShowFontSize(int & out_size) const;
5965 
5969  bool ShowTextColor(RGBColor & out_color) const;
5970 
5974  bool ShowTooltip(UTF8 & out_tooltip) const;
5975 
5979  bool ShowVisibility(bool & out_state) const;
5980 
5984  bool ShowPrintability(bool & out_state) const;
5985 
5989  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5990 
5994  bool ShowLock(bool & out_state) const;
5995 
5999  bool ShowBorder(bool & out_state) const;
6000 
6004  bool ShowBorderColor(RGBColor & out_color) const;
6005 
6009  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
6010 
6014  bool ShowBorderStyle(Border::Style & out_style) const;
6015 
6019  bool ShowFillColor(RGBColor & out_color) const;
6020 
6024  bool ShowDefaultValue(UTF8 & out_value) const;
6025 
6029  bool ShowTextJustification(HPS::Text::Justification & out_justification) const;
6030 
6034  bool ShowMultiline(bool & out_state) const;
6035 
6039  bool ShowScrolling(bool & out_state) const;
6040 
6044  bool ShowReadOnly(bool & out_state) const;
6045  };
6046 
6048  class PUBLISH_API DocumentKey : public Sprocket
6049  {
6050  public:
6052  DocumentKey();
6053 
6056  DocumentKey(DocumentKey const & in_that);
6057 
6060  DocumentKey(DocumentKey && in_that);
6061 
6064  virtual ~DocumentKey();
6065 
6066  HPS::Type ObjectType() const { return HPS::Type::PublishDocumentKey; }
6067 
6071  DocumentKey & operator=(DocumentKey const & in_that);
6072 
6076  DocumentKey & operator=(DocumentKey && in_that);
6077 
6081  virtual void Assign(DocumentKey const & in_that);
6082 
6086  bool Equals(DocumentKey const & in_that) const;
6087 
6091  bool operator!=(DocumentKey const & in_that) const;
6092 
6096  bool operator==(DocumentKey const & in_that) const;
6097 
6101  void Delete();
6102 
6103 
6108  DocumentKey & AddPage(PageKit const & in_page);
6109 
6115  DocumentKey & AddPages(size_t in_count, PageKit const in_pages[]);
6116 
6121  DocumentKey & AddPages(PageKitArray const & in_pages);
6122 
6132  DocumentKey & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
6133 
6138  DocumentKey & SetPasswords(char const * in_user_password, char const * in_owner_password);
6139 
6145  DocumentKey & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
6146 
6153  DocumentKey & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
6154 
6160  DocumentKey & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6161 
6166  DocumentKey & AddAttachment(char const * in_filename, char const * in_description);
6167 
6173  DocumentKey & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
6174 
6179  DocumentKey & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
6180 
6185  DocumentKey & AddIconImage(char const * in_name, ImageKit const & in_image);
6186 
6192  DocumentKey & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
6193 
6198  DocumentKey & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
6199 
6204  DocumentKey & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
6205 
6209  DocumentKey & SetPermissions(PermissionTypeArray const & in_permissions);
6210 
6211 
6213  size_t GetPageCount() const;
6214 
6218  DocumentKey & RemovePage(size_t in_index);
6219 
6224  DocumentKey & RemovePages(size_t in_start, size_t in_count);
6225 
6230  DocumentKey & RemovePages(size_t in_count, size_t const in_indices[]);
6231 
6235  DocumentKey & RemovePages(SizeTArray const & in_indices);
6236 
6239  DocumentKey & RemoveAllPages();
6240 
6244  PageControl GetPageControl(size_t in_index);
6245 
6249  PageControl const GetPageControl(size_t in_index) const;
6250  };
6251 
6253  class PUBLISH_API PageControl : public Sprocket
6254  {
6255  public:
6257  PageControl();
6258 
6261  PageControl(PageControl const & in_that);
6262 
6265  PageControl(PageControl && in_that);
6266 
6267  virtual ~PageControl();
6268 
6269  HPS::Type ObjectType() const { return HPS::Type::PublishPageControl; }
6270 
6274  PageControl & operator=(PageControl const & in_that);
6275 
6279  PageControl & operator=(PageControl && in_kit);
6280 
6281 
6286  PageControl & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
6287 
6293  PageControl & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
6294 
6299  PageControl & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
6300 
6305  PageControl & AddText(TextKit const & in_text, IntRectangle const & in_location);
6306 
6312  PageControl & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
6313 
6318  PageControl & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
6319 
6324  PageControl & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
6325 
6331  PageControl & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
6332 
6337  PageControl & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
6338 
6343  PageControl & AddTable(TableKit const & in_table, IntRectangle const & in_location);
6344 
6350  PageControl & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
6351 
6356  PageControl & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
6357 
6362  PageControl & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
6363 
6369  PageControl & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
6370 
6375  PageControl & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
6376 
6381  PageControl & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
6382 
6388  PageControl & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
6389 
6394  PageControl & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
6395 
6400  PageControl & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
6401 
6407  PageControl & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
6408 
6413  PageControl & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
6414 
6419  PageControl & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
6420 
6426  PageControl & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
6427 
6432  PageControl & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
6433 
6438  PageControl & AddCheckBox(CheckBoxKit const & in_check_box, IntRectangle const & in_location);
6439 
6445  PageControl & AddCheckBoxes(size_t in_count, CheckBoxKit const in_check_boxes[], IntRectangle const in_locations[]);
6446 
6451  PageControl & AddCheckBoxes(CheckBoxKitArray const & in_check_boxes, IntRectangleArray const & in_locations);
6452 
6457  PageControl & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
6458 
6464  PageControl & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
6465 
6470  PageControl & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
6471 
6476  PageControl & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
6477 
6483  PageControl & AddListBoxes(size_t in_count, ListBoxKit const in_list_boxes[], IntRectangle const in_locations[]);
6484 
6489  PageControl & AddListBoxes(ListBoxKitArray const & in_list_boxes, IntRectangleArray const & in_locations);
6490 
6495  PageControl & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
6496 
6502  PageControl & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_lists[], IntRectangle const in_locations[]);
6503 
6508  PageControl & AddDropDownLists(DropDownListKitArray const & in_drop_down_lists, IntRectangleArray const & in_locations);
6509 
6514  PageControl & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
6515 
6521  PageControl & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_fields[], IntRectangle const in_locations[]);
6522 
6527  PageControl & AddSignatureFields(SignatureFieldKitArray const & in_signature_fields, IntRectangleArray const & in_locations);
6528 
6529 
6535  PageControl & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
6536 
6543  PageControl & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
6544 
6550  PageControl & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
6551 
6557  PageControl & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
6558 
6565  PageControl & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
6566 
6572  PageControl & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
6573 
6579  PageControl & SetButtonLabelByField(char const * in_field, char const * in_label);
6580 
6587  PageControl & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
6588 
6594  PageControl & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
6595 
6602  PageControl & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
6603 
6611  PageControl & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
6612 
6619  PageControl & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
6620 
6628  PageControl & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
6629 
6638  PageControl & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
6639 
6647  PageControl & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6648 
6654  PageControl & SetVisibilityByField(char const * in_field, bool in_state);
6655 
6662  PageControl & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
6663 
6669  PageControl & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
6670 
6676  PageControl & SetTextValueByField(char const * in_field, char const * in_value);
6677 
6684  PageControl & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
6685 
6691  PageControl & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
6692 
6693 
6699  bool ShowFields(UTF8Array & out_names, IntRectangleArray & out_locations, FieldTypeArray & out_types) const;
6700  };
6701 
6702 
6703  class ExportOptionsKit;
6704 
6706  class PUBLISH_API File
6707  {
6708  public:
6715  static void Export(SprocketPath const & in_source, char const * in_filename, ExportOptionsKit const & in_options);
6716 
6723  static void Export(AnnotationKit const & in_annotation, char const * in_filename, ExportOptionsKit const & in_options);
6724 
6731  static void Export(DocumentKit const & in_document, char const * in_filename, ExportOptionsKit const & in_options);
6732 
6737  static DocumentKey CreateDocument(char const * in_filename = nullptr);
6738 
6743  static void Export(DocumentKey const & in_document, char const * in_filename);
6744 
6745  private:
6747  File();
6748  };
6749 
6751  class PUBLISH_API ExportOptionsKit : public Sprocket
6752  {
6753  public:
6755  ExportOptionsKit();
6756 
6759  ExportOptionsKit(ExportOptionsKit const & in_kit);
6760 
6764 
6765  virtual ~ExportOptionsKit();
6766 
6767  HPS::Type ObjectType() const { return HPS::Type::PublishExportOptionsKit; }
6768 
6771  void Set(ExportOptionsKit const & in_kit);
6772 
6775  void Show(ExportOptionsKit & out_kit) const;
6776 
6780  ExportOptionsKit & operator=(ExportOptionsKit const & in_kit);
6781 
6785  ExportOptionsKit & operator=(ExportOptionsKit && in_kit);
6786 
6789  bool Empty() const;
6790 
6794  bool Equals(ExportOptionsKit const & in_kit) const;
6795 
6799  bool operator==(ExportOptionsKit const & in_kit) const;
6800 
6804  bool operator!=(ExportOptionsKit const & in_kit) const;
6805 
6806 
6810  ExportOptionsKit & SetDocumentToAppendTo(char const * in_filename);
6811 
6812 
6815  ExportOptionsKit & UnsetDocumentToAppendTo();
6816 
6819  ExportOptionsKit & UnsetEverything();
6820 
6821 
6825  bool ShowDocumentToAppendTo(UTF8 & out_filename) const;
6826  };
6827 
6828 private:
6830  Publish();
6831 };
6832 
6833 }
6834 
6835 #endif
Mode
Definition: sprk_publish.h:284
Definition: hps.h:3259
Definition: sprk_publish.h:3123
Definition: sprk_publish.h:2725
Mode
Definition: sprk_publish.h:456
Definition: sprk_publish.h:474
Preference
Definition: sprk_publish.h:496
Definition: sprk.h:69
HPS::Type ObjectType() const
Definition: sprk_publish.h:2297
Definition: sprk_publish.h:4456
HPS::Type ObjectType() const
Definition: sprk_publish.h:3390
Definition: sprk_publish.h:162
Orientation
Definition: sprk_publish.h:127
Definition: sprk_publish.h:313
Definition: sprk.h:928
Definition: sprk_publish.h:451
Format
Definition: sprk_publish.h:109
Definition: sprk_publish.h:181
Type
Definition: sprk_publish.h:318
Definition: sprk_publish.h:5427
Mode
Definition: sprk_publish.h:257
Definition: sprk_publish.h:42
Definition: sprk_publish.h:2951
Type
Definition: sprk_publish.h:568
Style
Definition: sprk_publish.h:203
HPS::Type ObjectType() const
Definition: sprk_publish.h:6767
Definition: sprk_publish.h:4153
Definition: sprk_publish.h:234
HPS::Type ObjectType() const
Definition: sprk_publish.h:6066
HPS::Type ObjectType() const
Definition: sprk_publish.h:4169
Definition: sprk_publish.h:565
HPS::Type ObjectType() const
Definition: sprk_publish.h:4472
Definition: sprk_publish.h:6706
Rotation
Definition: sprk_publish.h:377
Definition: sprk_publish.h:3545
Definition: sprk_publish.h:85
Position
Definition: sprk_publish.h:547
Definition: sprk_publish.h:391
Definition: sprk_publish.h:216
Definition: sprk_publish.h:5702
Definition: sprk_publish.h:4773
Type
Definition: sprk_publish.h:431
Definition: sprk_publish.h:491
Definition: sprk_publish.h:426
Justification
Definition: hps.h:1551
Definition: sprk_publish.h:104
BRepCompression
Definition: sprk_publish.h:167
Definition: sprk_publish.h:3822
Definition: hps.h:4223
Definition: hps.h:6763
Definition: sprk_publish.h:139
Definition: sprk_publish.h:596
HPS::Type ObjectType() const
Definition: sprk_publish.h:5102
Definition: sprk_publish.h:6751
Style
Definition: sprk_publish.h:344
Definition: sprk_publish.h:198
Definition: sprk_publish.h:279
Definition: sprk_publish.h:6253
Definition: sprk_publish.h:6048
HPS::Type ObjectType() const
Definition: sprk_publish.h:612
Definition: sprk_publish.h:5086
HPS::Type ObjectType() const
Definition: sprk_publish.h:2741
HPS::Type ObjectType() const
Definition: sprk_publish.h:5718
Thickness
Definition: sprk_publish.h:518
Definition: sprk_publish.h:3262
Type
Definition: sprk_publish.h:90
HPS::Type ObjectType() const
Definition: sprk_publish.h:4789
SourceType
Definition: sprk_publish.h:150
Definition: sprk_publish.h:542
HPS::Type ObjectType() const
Definition: sprk_publish.h:6269
Format
Definition: sprk_publish.h:144
Definition: sprk_publish.h:309
Preference
Definition: sprk_publish.h:479
Name
Definition: sprk_publish.h:326
Format
Definition: sprk_publish.h:396
Definition: sprk_publish.h:513
HPS::Type ObjectType() const
Definition: sprk_publish.h:3838
HPS::Type ObjectType() const
Definition: sprk_publish.h:952
Definition: sprk_publish.h:252
HPS::Type ObjectType() const
Definition: sprk_publish.h:3139
Language
Definition: sprk_publish.h:359
Definition: sprk_publish.h:927
Definition: sprk_publish.h:470
When
Definition: sprk_publish.h:221
Style
Definition: sprk_publish.h:527
Definition: hps.h:8916
Definition: hps.h:10311
When
Definition: sprk_publish.h:239
HPS::Type ObjectType() const
Definition: sprk_publish.h:2967
HPS::Type ObjectType() const
Definition: sprk_publish.h:5443
Definition: sprk_publish.h:2277
HPS::Type ObjectType() const
Definition: sprk_publish.h:3561
Version
Definition: sprk_publish.h:186
Definition: sprk_publish.h:3374
HPS::Type ObjectType() const
Definition: sprk_publish.h:3278