sprk_publish.h
1 // Copyright (c) Tech Soft 3D, Inc.
2 //
3 // The information contained herein is confidential and proprietary to Tech Soft 3D, Inc.,
4 // and considered a trade secret as defined under civil and criminal statutes.
5 // Tech Soft 3D, Inc. shall pursue its civil and criminal remedies in the event of
6 // unauthorized use or misappropriation of its trade secrets. Use of this information
7 // by anyone other than authorized employees of Tech Soft 3D, Inc. is granted only under
8 // a written non-disclosure agreement, expressly prescribing the scope and manner of such use.
9 
10 #ifndef SPRK_PUBLISH_H
11 #define SPRK_PUBLISH_H
12 
13 #include "sprk.h"
14 
15 typedef void A3DEntity;
16 
17 #ifdef _MSC_VER
18 # ifndef STATIC_APP
19 # ifdef SPRK_PUBLISH
20 # define PUBLISH_API __declspec (dllexport)
21 # else
22 # define PUBLISH_API __declspec (dllimport)
23 # endif
24 # endif
25 #else
26 # include <stddef.h>
27 # if defined(SPRK_PUBLISH) and defined(LINUX_SYSTEM)
28 # ifndef STATIC_APP
29 # define PUBLISH_API __attribute__ ((visibility ("default")))
30 # endif
31 # endif
32 #endif
33 
34 #ifndef PUBLISH_API
35 # define PUBLISH_API
36 #endif
37 
38 namespace HPS
39 {
40 
42 class PUBLISH_API Publish
43 {
44 public:
45  class DocumentKit;
46  class PageKit;
47  class TemplateKit;
48  class AnnotationKit;
49  class ArtworkKit;
50  class ViewKit;
51  class TextKit;
52  class ImageKit;
53  class TableKit;
54  class LinkKit;
55  class ButtonKit;
56  class CheckBoxKit;
57  class RadioButtonKit;
58  class ListBoxKit;
59  class DropDownListKit;
60  class SignatureFieldKit;
61  class TextFieldKit;
62  class SlideTableKit;
63  class DocumentKey;
64  class PageControl;
65 
66  typedef std::vector<PageKit, HPS::Allocator<PageKit>> PageKitArray;
67  typedef std::vector<AnnotationKit, HPS::Allocator<AnnotationKit>> AnnotationKitArray;
68  typedef std::vector<ViewKit, HPS::Allocator<ViewKit>> ViewKitArray;
69  typedef std::vector<TextKit, HPS::Allocator<TextKit>> TextKitArray;
70  typedef std::vector<ImageKit, HPS::Allocator<ImageKit>> ImageKitArray;
71  typedef std::vector<TableKit, HPS::Allocator<TableKit>> TableKitArray;
72  typedef std::vector<LinkKit, HPS::Allocator<LinkKit>> LinkKitArray;
73  typedef std::vector<ButtonKit, HPS::Allocator<ButtonKit>> ButtonKitArray;
74  typedef std::vector<CheckBoxKit, HPS::Allocator<CheckBoxKit>> CheckBoxKitArray;
75  typedef std::vector<RadioButtonKit, HPS::Allocator<RadioButtonKit>> RadioButtonKitArray;
76  typedef std::vector<ListBoxKit, HPS::Allocator<ListBoxKit>> ListBoxKitArray;
77  typedef std::vector<DropDownListKit, HPS::Allocator<DropDownListKit>> DropDownListKitArray;
78  typedef std::vector<SignatureFieldKit, HPS::Allocator<SignatureFieldKit>> SignatureFieldKitArray;
79  typedef std::vector<TextFieldKit, HPS::Allocator<TextFieldKit>> TextFieldKitArray;
80  typedef std::vector<SlideTableKit, HPS::Allocator<SlideTableKit>> SlideTableKitArray;
81 
82 
83 
85  class PUBLISH_API Source
86  {
87  public:
90  enum class Type
91  {
92  Code,
93  File
94  };
95 
96  private:
98  Source();
99  };
100 
101  typedef std::vector<Source::Type, HPS::Allocator<Source::Type> > SourceTypeArray;
102 
104  class PUBLISH_API Page
105  {
106  public:
109  enum class Format
110  {
111  P11x17,
112  A3,
113  A4,
114  A5,
115  B4JIS,
116  B5JIS,
117  Executive,
118  Legal,
119  Letter,
120  Tabloid,
121  B4ISO,
122  B5ISO
123  };
124 
127  enum class Orientation
128  {
129  Portrait,
130  Landscape
131  };
132 
133  private:
135  Page();
136  };
137 
139  class PUBLISH_API Annotation
140  {
141  public:
144  enum class Format
145  {
146  PRC,
147  U3D
148  };
149 
150  enum class SourceType
151  {
152  CADModel,
153  KeyPath,
154  CADModelAndKeyPath
155  };
156 
157  private:
159  Annotation();
160  };
161 
163  class PUBLISH_API PRC
164  {
165  public:
168  enum class BRepCompression
169  {
170  None,
171  Low,
172  Medium,
173  High
174  };
175 
176  private:
178  PRC();
179  };
180 
182  class PUBLISH_API U3D
183  {
184  public:
187  enum class Version
188  {
189  ECMA1,
190  ECMA3
191  };
192 
193  private:
195  U3D();
196  };
197 
199  class PUBLISH_API Animation
200  {
201  public:
204  enum class Style
205  {
206  None,
207  Loop,
208  Bounce
209  };
210 
211  private:
213  Animation();
214  };
215 
217  class PUBLISH_API Activation
218  {
219  public:
222  enum class When
223  {
224  Explicit,
225  Opened,
226  Visible
227  };
228 
229  private:
231  Activation();
232  };
233 
235  class PUBLISH_API Deactivation
236  {
237  public:
240  enum class When
241  {
242  Explicit,
243  Closed,
244  NotVisible
245  };
246 
247  private:
249  Deactivation();
250  };
251 
253  class PUBLISH_API Lighting
254  {
255  public:
258  enum class Mode
259  {
260  Artwork,
261  None,
262  White,
263  Day,
264  Bright,
265  PrimaryColor,
266  Night,
267  Blue,
268  Red,
269  Cube,
270  CADOptimized,
271  Headlamp
272  };
273 
274  private:
276  Lighting();
277  };
278 
280  class PUBLISH_API Rendering
281  {
282  public:
285  enum class Mode
286  {
287  Solid,
288  SolidWireframe,
289  SolidOutline,
290  BoundingBox,
291  Transparent,
292  TransparentWireframe,
293  TransparentBoundingBox,
294  TransparentBoundingBoxOutline,
295  Illustration,
296  ShadedIllustration,
297  Wireframe,
298  ShadedWireframe,
299  HiddenWireframe,
300  Vertices,
301  ShadedVertices
302  };
303 
304  private:
306  Rendering();
307  };
308 
310  class PUBLISH_API Text
311  {
312  public:
314  class PUBLISH_API Font
315  {
316  public:
319  enum class Type
320  {
321  BuiltIn,
322  Explicit
323  };
324 
327  enum class Name
328  {
329  TimesRoman,
330  TimesItalic,
331  TimesBold,
332  TimesBoldItalic,
333  Helvetica,
334  HelveticaOblique,
335  HelveticaBold,
336  HelveticaBoldOblique,
337  Courier,
338  CourierOblique,
339  CourierBold,
340  CourierBoldOblique
341  };
342 
345  enum class Style
346  {
347  Regular,
348  Bold,
349  Italic,
350  BoldItalic,
351  };
352 
353  private:
355  Font();
356  };
357 
360  enum class Language
361  {
362  ASCII,
363  EastEuropeanRoman,
364  Cyrillic,
365  Greek,
366  Turkish,
367  Hebrew,
368  Arabic,
369  Baltic,
370  ChineseTraditional,
371  ChineseSimplified,
372  Japanese,
373  Korean
374  };
375 
378  enum class Rotation
379  {
380  None,
381  CounterClockwise90Degrees,
382  CounterClockwise180Degrees,
383  CounterClockwise270Degrees,
384  };
385 
386  private:
388  Text();
389  };
390 
392  class PUBLISH_API Image
393  {
394  public:
397  enum class Format
398  {
399  Unknown,
400  BMP,
401  PNG,
402  JPEG,
403  RawRGB,
404  RawRGBA,
405  RawGrey,
406  RawGreyA,
407  EMF,
408  URL,
409  GIF,
410  TIFF,
411  PCX,
412  Targa,
413  PPM,
414  ILBM,
415  CEL,
416  RGB,
417  PSD,
418  PIC
419  };
420 
421  private:
423  Image();
424  };
425 
427  class PUBLISH_API Field
428  {
429  public:
432  enum class Type
433  {
434  Text,
435  Button,
436  DropDown,
437  ListBox,
438  CheckBox,
439  RadioButton,
440  DigitalSignature,
441  BarCode
442  };
443 
444  private:
446  Field();
447  };
448 
449  typedef std::vector<Field::Type, Allocator<Field::Type>> FieldTypeArray;
450 
452  class PUBLISH_API Highlighting
453  {
454  public:
457  enum class Mode
458  {
459  None,
460  Invert,
461  Outline,
462  Push
463  };
464 
465  private:
467  Highlighting();
468  };
469 
471  class PUBLISH_API Artwork
472  {
473  public:
475  class PUBLISH_API View
476  {
477  public:
480  enum class Preference
481  {
482  Native,
483  PDF
484  };
485 
486  private:
488  View();
489  };
490 
492  class PUBLISH_API Display
493  {
494  public:
497  enum class Preference
498  {
499  Defined,
500  Runtime
501  };
502 
503  private:
505  Display();
506  };
507 
508  private:
510  Artwork();
511  };
512 
514  class PUBLISH_API Border
515  {
516  public:
519  enum class Thickness
520  {
521  Thin,
522  Medium,
523  Wide,
524  };
525 
528  enum class Style
529  {
530  Solid,
531  Dashed,
532  Beveled,
533  Inset,
534  Underlined,
535  };
536 
537  private:
539  Border();
540  };
541 
543  class PUBLISH_API Label
544  {
545  public:
548  enum class Position
549  {
550  LabelOnly,
551  IconOnly,
552  Top,
553  Bottom,
554  Left,
555  Right,
556  OnTop,
557  };
558 
559  private:
561  Label();
562  };
563 
564 
566  class PUBLISH_API Permission
567  {
568  public:
569  enum class Type
570  {
571  Open,
572  Secure,
573  Print,
574  Edit,
575  Copy,
576  EditNotes,
577  SaveAs,
578  FillAndSign,
579  Accessible,
580  Assembly,
581  HighQualityPrint,
582  Owner,
583  FormSubmit,
584  SpawnTemplate,
585  User,
586  All,
587  };
588 
589  private:
591  Permission();
592  };
593 
594  typedef std::vector<Permission::Type, HPS::Allocator<Permission::Type> > PermissionTypeArray;
595 
596 
598  class PUBLISH_API DocumentKit : public SprocketKit
599  {
600  public:
602  DocumentKit();
603 
606  DocumentKit(DocumentKit const & in_kit);
607 
610  DocumentKit(DocumentKit && in_kit);
611 
612  virtual ~DocumentKit();
613 
614  static const HPS::Type staticType = HPS::Type::PublishDocumentKit;
615  HPS::Type ObjectType() const { return staticType; }
616 
620  static DocumentKit GetDefault();
621 
624  void Set(DocumentKit const & in_kit);
625 
628  void Show(DocumentKit & out_kit) const;
629 
633  DocumentKit & operator=(DocumentKit const & in_kit);
634 
638  DocumentKit & operator=(DocumentKit && in_kit);
639 
642  bool Empty() const;
643 
647  bool Equals(DocumentKit const & in_kit) const;
648 
652  bool operator==(DocumentKit const & in_kit) const;
653 
657  bool operator!=(DocumentKit const & in_kit) const;
658 
659 
669  DocumentKit & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
670 
675  DocumentKit & SetPasswords(char const * in_user_password, char const * in_owner_password);
676 
682  DocumentKit & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
683 
690  DocumentKit & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
691 
697  DocumentKit & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
698 
703  DocumentKit & AddAttachment(char const * in_filename, char const * in_description);
704 
710  DocumentKit & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
711 
716  DocumentKit & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
717 
722  DocumentKit & AddIconImage(char const * in_name, ImageKit const & in_image);
723 
729  DocumentKit & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
730 
735  DocumentKit & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
736 
741  DocumentKit & SetPage(PageKit const & in_page);
742 
747  DocumentKit & AddPage(PageKit const & in_page);
748 
754  DocumentKit & SetPages(size_t in_count, PageKit const in_pages[]);
755 
760  DocumentKit & SetPages(PageKitArray const & in_pages);
761 
767  DocumentKit & AddPages(size_t in_count, PageKit const in_pages[]);
768 
773  DocumentKit & AddPages(PageKitArray const & in_pages);
774 
779  DocumentKit & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
780 
784  DocumentKit & SetPermissions(PermissionTypeArray const & in_permissions);
785 
786 
789  DocumentKit & UnsetInformation();
790 
793  DocumentKit & UnsetPasswords();
794 
798  DocumentKit & UnsetJavaScript(char const * in_script_name);
799 
804  DocumentKit & UnsetJavaScript(size_t in_count, UTF8 const in_script_names[]);
805 
809  DocumentKit & UnsetJavaScript(UTF8Array const & in_script_names);
810 
813  DocumentKit & UnsetJavaScript();
814 
818  DocumentKit & UnsetAttachment(char const * in_filename);
819 
824  DocumentKit & UnsetAttachments(size_t in_count, UTF8 const in_filenames[]);
825 
829  DocumentKit & UnsetAttachments(UTF8Array const & in_filenames);
830 
833  DocumentKit & UnsetAttachments();
834 
838  DocumentKit & UnsetIconImage(char const * in_name);
839 
844  DocumentKit & UnsetIconImages(size_t in_count, UTF8 const in_names[]);
845 
849  DocumentKit & UnsetIconImages(UTF8Array const & in_names);
850 
853  DocumentKit & UnsetIconImages();
854 
858  DocumentKit & UnsetPage(size_t in_index);
859 
864  DocumentKit & UnsetPages(size_t in_count, size_t const in_indices[]);
865 
869  DocumentKit & UnsetPages(SizeTArray const & in_indices);
870 
873  DocumentKit & UnsetPages();
874 
877  DocumentKit & UnsetPermissions();
878 
881  DocumentKit & UnsetEverything();
882 
883 
890  bool ShowInformation(UTF8 & out_title, UTF8 & out_author, UTF8 & out_subject, UTF8 & out_creator) const;
891 
896  bool ShowPasswords(UTF8 & out_user_password, UTF8 & out_owner_password) const;
897 
904  bool ShowJavaScript(UTF8Array & out_script_names, UTF8Array & out_sources, SourceTypeArray & out_types) const;
905 
910  bool ShowAttachments(UTF8Array & out_filenames, UTF8Array & out_descriptions) const;
911 
916  bool ShowIconImages(UTF8Array & out_names, ImageKitArray & out_images) const;
917 
921  bool ShowPages(PageKitArray & out_pages) const;
922 
926  bool ShowPermissions(PermissionTypeArray & out_permissions) const;
927  };
928 
930  class PUBLISH_API PageKit : public SprocketKit
931  {
932  public:
934  PageKit();
935 
939  PageKit(Page::Format in_format, Page::Orientation in_orientation);
940 
943  PageKit(char const * in_filename);
944 
947  PageKit(PageKit const & in_kit);
948 
951  PageKit(PageKit && in_kit);
952 
953  virtual ~PageKit();
954 
955  static const HPS::Type staticType = HPS::Type::PublishPageKit;
956  HPS::Type ObjectType() const { return staticType; }
957 
961  static PageKit GetDefault();
962 
965  void Set(PageKit const & in_kit);
966 
969  void Show(PageKit & out_kit) const;
970 
974  PageKit & operator=(PageKit const & in_kit);
975 
979  PageKit & operator=(PageKit && in_kit);
980 
983  bool Empty() const;
984 
988  bool Equals(PageKit const & in_kit) const;
989 
993  bool operator==(PageKit const & in_kit) const;
994 
998  bool operator!=(PageKit const & in_kit) const;
999 
1000 
1005  PageKit & SetFormat(Page::Format in_format);
1006 
1011  PageKit & SetOrientation(Page::Orientation in_orientation);
1012 
1017  PageKit & SetAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
1018 
1023  PageKit & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
1024 
1030  PageKit & SetAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
1031 
1036  PageKit & SetAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
1037 
1043  PageKit & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
1044 
1049  PageKit & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
1050 
1055  PageKit & SetText(TextKit const & in_text, IntRectangle const & in_location);
1056 
1061  PageKit & AddText(TextKit const & in_text, IntRectangle const & in_location);
1062 
1068  PageKit & SetText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
1069 
1074  PageKit & SetText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
1075 
1081  PageKit & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
1082 
1087  PageKit & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
1088 
1093  PageKit & SetImage(ImageKit const & in_image, IntRectangle const & in_location);
1094 
1099  PageKit & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
1100 
1106  PageKit & SetImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
1107 
1112  PageKit & SetImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
1113 
1119  PageKit & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
1120 
1125  PageKit & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
1126 
1131  PageKit & SetTable(TableKit const & in_table, IntRectangle const & in_location);
1132 
1137  PageKit & AddTable(TableKit const & in_table, IntRectangle const & in_location);
1138 
1144  PageKit & SetTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
1145 
1150  PageKit & SetTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
1151 
1157  PageKit & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
1158 
1163  PageKit & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
1164 
1169  PageKit & SetLink(LinkKit const & in_link, IntRectangle const & in_location);
1170 
1175  PageKit & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
1176 
1182  PageKit & SetLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
1183 
1188  PageKit & SetLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
1189 
1195  PageKit & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
1196 
1201  PageKit & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
1202 
1207  PageKit & SetButton(ButtonKit const & in_button, IntRectangle const & in_location);
1208 
1213  PageKit & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
1214 
1220  PageKit & SetButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
1221 
1226  PageKit & SetButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
1227 
1233  PageKit & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
1234 
1239  PageKit & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
1240 
1245  PageKit & SetTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
1246 
1251  PageKit & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
1252 
1258  PageKit & SetTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
1259 
1264  PageKit & SetTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
1265 
1271  PageKit & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
1272 
1277  PageKit & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
1278 
1283  PageKit & SetSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
1284 
1289  PageKit & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
1290 
1296  PageKit & SetSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
1297 
1302  PageKit & SetSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
1303 
1309  PageKit & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
1310 
1315  PageKit & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
1316 
1321  PageKit & SetCheckBox(CheckBoxKit const & in_checkbox, IntRectangle const & in_location);
1322 
1327  PageKit & AddCheckBox(CheckBoxKit const & in_checkbox, IntRectangle const & in_location);
1328 
1334  PageKit & SetCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]);
1335 
1340  PageKit & SetCheckBoxes(CheckBoxKitArray const & in_checkbox, IntRectangleArray const & in_locations);
1341 
1347  PageKit & AddCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]);
1348 
1353  PageKit & AddCheckBoxes(CheckBoxKitArray const & in_checkbox, IntRectangleArray const & in_locations);
1354 
1359  PageKit & SetRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
1360 
1365  PageKit & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
1366 
1372  PageKit & SetRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
1373 
1378  PageKit & SetRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
1379 
1385  PageKit & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
1386 
1391  PageKit & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
1392 
1397  PageKit & SetListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
1398 
1403  PageKit & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
1404 
1410  PageKit & SetListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]);
1411 
1416  PageKit & SetListBoxes(ListBoxKitArray const & in_list_box, IntRectangleArray const & in_locations);
1417 
1423  PageKit & AddListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]);
1424 
1429  PageKit & AddListBoxes(ListBoxKitArray const & in_list_box, IntRectangleArray const & in_locations);
1430 
1435  PageKit & SetDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
1436 
1441  PageKit & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
1442 
1448  PageKit & SetDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]);
1449 
1454  PageKit & SetDropDownLists(DropDownListKitArray const & in_drop_down_list, IntRectangleArray const & in_locations);
1455 
1461  PageKit & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]);
1462 
1467  PageKit & AddDropDownLists(DropDownListKitArray const & in_drop_down_list, IntRectangleArray const & in_locations);
1468 
1473  PageKit & SetSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
1474 
1479  PageKit & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
1480 
1486  PageKit & SetSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]);
1487 
1492  PageKit & SetSignatureFields(SignatureFieldKitArray const & in_signature_field, IntRectangleArray const & in_locations);
1493 
1499  PageKit & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]);
1500 
1505  PageKit & AddSignatureFields(SignatureFieldKitArray const & in_signature_field, IntRectangleArray const & in_locations);
1506 
1510  PageKit & SetTemplateFile(char const * in_filename);
1511 
1517  PageKit & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
1518 
1525  PageKit & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
1526 
1532  PageKit & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
1533 
1539  PageKit & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
1540 
1547  PageKit & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
1548 
1554  PageKit & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
1555 
1561  PageKit & SetButtonLabelByField(char const * in_field, char const * in_label);
1562 
1569  PageKit & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
1570 
1576  PageKit & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
1577 
1584  PageKit & SetListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
1585 
1592  PageKit & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
1593 
1601  PageKit & SetListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
1602 
1609  PageKit & SetListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
1610 
1618  PageKit & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
1619 
1626  PageKit & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
1627 
1635  PageKit & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
1636 
1645  PageKit & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
1646 
1654  PageKit & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
1655 
1661  PageKit & SetVisibilityByField(char const * in_field, bool in_state);
1662 
1669  PageKit & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
1670 
1676  PageKit & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
1677 
1683  PageKit & SetTextValueByField(char const * in_field, char const * in_value);
1684 
1691  PageKit & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
1692 
1698  PageKit & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
1699 
1700 
1703  PageKit & UnsetFormat();
1704 
1707  PageKit & UnsetOrientation();
1708 
1712  PageKit & UnsetAnnotation(size_t in_index);
1713 
1718  PageKit & UnsetAnnotations(size_t in_count, size_t const in_indices[]);
1719 
1723  PageKit & UnsetAnnotations(SizeTArray const & in_indices);
1724 
1727  PageKit & UnsetAnnotations();
1728 
1732  PageKit & UnsetText(size_t in_index);
1733 
1738  PageKit & UnsetText(size_t in_count, size_t const in_indices[]);
1739 
1743  PageKit & UnsetText(SizeTArray const & in_indices);
1744 
1747  PageKit & UnsetText();
1748 
1752  PageKit & UnsetCheckBox(size_t in_index);
1753 
1758  PageKit & UnsetCheckBoxes(size_t in_count, size_t const in_indices[]);
1759 
1763  PageKit & UnsetCheckBoxes(SizeTArray const & in_indices);
1764 
1767  PageKit & UnsetCheckBoxes();
1768 
1772  PageKit & UnsetRadioButton(size_t in_index);
1773 
1778  PageKit & UnsetRadioButtons(size_t in_count, size_t const in_indices[]);
1779 
1783  PageKit & UnsetRadioButtons(SizeTArray const & in_indices);
1784 
1787  PageKit & UnsetRadioButtons();
1788 
1792  PageKit & UnsetListBox(size_t in_index);
1793 
1798  PageKit & UnsetListBoxes(size_t in_count, size_t const in_indices[]);
1799 
1803  PageKit & UnsetListBoxes(SizeTArray const & in_indices);
1804 
1807  PageKit & UnsetListBoxes();
1808 
1812  PageKit & UnsetDropDownList(size_t in_index);
1813 
1818  PageKit & UnsetDropDownLists(size_t in_count, size_t const in_indices[]);
1819 
1823  PageKit & UnsetDropDownLists(SizeTArray const & in_indices);
1824 
1827  PageKit & UnsetDropDownLists();
1828 
1832  PageKit & UnsetSignatureField(size_t in_index);
1833 
1838  PageKit & UnsetSignatureFields(size_t in_count, size_t const in_indices[]);
1839 
1843  PageKit & UnsetSignatureFields(SizeTArray const & in_indices);
1844 
1847  PageKit & UnsetSignatureFields();
1848 
1852  PageKit & UnsetImage(size_t in_index);
1853 
1858  PageKit & UnsetImages(size_t in_count, size_t const in_indices[]);
1859 
1863  PageKit & UnsetImages(SizeTArray const & in_indices);
1864 
1867  PageKit & UnsetImages();
1868 
1872  PageKit & UnsetTable(size_t in_index);
1873 
1878  PageKit & UnsetTables(size_t in_count, size_t const in_indices[]);
1879 
1883  PageKit & UnsetTables(SizeTArray const & in_indices);
1884 
1887  PageKit & UnsetTables();
1888 
1892  PageKit & UnsetLink(size_t in_index);
1893 
1898  PageKit & UnsetLinks(size_t in_count, size_t const in_indices[]);
1899 
1903  PageKit & UnsetLinks(SizeTArray const & in_indices);
1904 
1907  PageKit & UnsetLinks();
1908 
1912  PageKit & UnsetButton(size_t in_index);
1913 
1918  PageKit & UnsetButtons(size_t in_count, size_t const in_indices[]);
1919 
1923  PageKit & UnsetButtons(SizeTArray const & in_indices);
1924 
1927  PageKit & UnsetButtons();
1928 
1932  PageKit & UnsetTextField(size_t in_index);
1933 
1938  PageKit & UnsetTextFields(size_t in_count, size_t const in_indices[]);
1939 
1943  PageKit & UnsetTextFields(SizeTArray const & in_indices);
1944 
1947  PageKit & UnsetTextFields();
1948 
1952  PageKit & UnsetSlideTable(size_t in_index);
1953 
1958  PageKit & UnsetSlideTables(size_t in_count, size_t const in_indices[]);
1959 
1963  PageKit & UnsetSlideTables(SizeTArray const & in_indices);
1964 
1967  PageKit & UnsetSlideTables();
1968 
1971  PageKit & UnsetTemplateFile();
1972 
1976  PageKit & UnsetAnnotationByField(char const * in_field);
1977 
1982  PageKit & UnsetAnnotationsByField(size_t in_count, UTF8 const in_fields[]);
1983 
1987  PageKit & UnsetAnnotationsByField(UTF8Array const & in_fields);
1988 
1991  PageKit & UnsetAnnotationsByField();
1992 
1996  PageKit & UnsetButtonIconByField(char const * in_field);
1997 
2002  PageKit & UnsetButtonIconsByField(size_t in_count, UTF8 const in_fields[]);
2003 
2007  PageKit & UnsetButtonIconsByField(UTF8Array const & in_fields);
2008 
2011  PageKit & UnsetButtonIconsByField();
2012 
2016  PageKit & UnsetButtonLabelByField(char const * in_field);
2017 
2022  PageKit & UnsetButtonLabelsByField(size_t in_count, UTF8 const in_fields[]);
2023 
2027  PageKit & UnsetButtonLabelsByField(UTF8Array const & in_fields);
2028 
2031  PageKit & UnsetButtonLabelsByField();
2032 
2037  PageKit & UnsetListItemByField(char const * in_field, size_t in_index);
2038 
2044  PageKit & UnsetListItemsByField(char const * in_field, size_t in_count, size_t const in_indices[]);
2045 
2050  PageKit & UnsetListItemsByField(char const * in_field, SizeTArray const & in_indices);
2051 
2055  PageKit & UnsetListItemsByField(char const * in_field);
2056 
2061  PageKit & UnsetListItemsByField(size_t in_count, UTF8 const in_fields[]);
2062 
2066  PageKit & UnsetListItemsByField(UTF8Array const & in_fields);
2067 
2070  PageKit & UnsetListItemsByField();
2071 
2075  PageKit & UnsetJavaScriptActionByField(char const * in_field);
2076 
2081  PageKit & UnsetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[]);
2082 
2086  PageKit & UnsetJavaScriptActionsByField(UTF8Array const & in_fields);
2087 
2090  PageKit & UnsetJavaScriptActionsByField();
2091 
2095  PageKit & UnsetVisibilityByField(char const * in_field);
2096 
2101  PageKit & UnsetVisibilitiesByField(size_t in_count, UTF8 const in_fields[]);
2102 
2106  PageKit & UnsetVisibilitiesByField(UTF8Array const & in_fields);
2107 
2110  PageKit & UnsetVisibilitiesByField();
2111 
2115  PageKit & UnsetTextValueByField(char const * in_field);
2116 
2121  PageKit & UnsetTextValuesByField(size_t in_count, UTF8 const in_fields[]);
2122 
2126  PageKit & UnsetTextValuesByField(UTF8Array const & in_fields);
2127 
2130  PageKit & UnsetTextValuesByField();
2131 
2134  PageKit & UnsetEverything();
2135 
2136 
2140  bool ShowFormat(Page::Format & out_format) const;
2141 
2145  bool ShowOrientation(Page::Orientation & out_orientation) const;
2146 
2151  bool ShowAnnotations(AnnotationKitArray & out_annotations, IntRectangleArray & out_locations) const;
2152 
2157  bool ShowText(TextKitArray & out_text, IntRectangleArray & out_locations) const;
2158 
2163  bool ShowImages(ImageKitArray & out_images, IntRectangleArray & out_locations) const;
2164 
2169  bool ShowTables(TableKitArray & out_tables, IntRectangleArray & out_locations) const;
2170 
2175  bool ShowLinks(LinkKitArray & out_links, IntRectangleArray & out_locations) const;
2176 
2181  bool ShowButtons(ButtonKitArray & out_buttons, IntRectangleArray & out_locations) const;
2182 
2187  bool ShowCheckBoxes(CheckBoxKitArray & out_check_boxes, IntRectangleArray & out_locations) const;
2188 
2193  bool ShowRadioButtons(RadioButtonKitArray & out_radio_buttons, IntRectangleArray & out_locations) const;
2194 
2199  bool ShowListBoxes(ListBoxKitArray & out_list_boxes, IntRectangleArray & out_locations) const;
2200 
2205  bool ShowDropDownLists(DropDownListKitArray & out_drop_down_lists, IntRectangleArray & out_locations) const;
2206 
2211  bool ShowSignatureFields(SignatureFieldKitArray & out_signature_fields, IntRectangleArray & out_locations) const;
2212 
2217  bool ShowTextFields(TextFieldKitArray & out_text_fields, IntRectangleArray & out_locations) const;
2218 
2223  bool ShowSlideTables(SlideTableKitArray & out_slide_tables, IntRectangleArray & out_locations) const;
2224 
2228  bool ShowTemplateFile(UTF8 & out_filename) const;
2229 
2234  bool ShowAnnotationsByField(UTF8Array & out_fields, AnnotationKitArray & out_annotations) const;
2235 
2240  bool ShowButtonIconsByField(UTF8Array & out_fields, ImageKitArray & out_images) const;
2241 
2246  bool ShowButtonLabelsByField(UTF8Array & out_fields, UTF8Array & out_labels) const;
2247 
2251  bool ShowListItemFields(UTF8Array & out_fields) const;
2252 
2258  bool ShowListItemsByField(char const * in_field, UTF8Array & out_values, UTF8Array & out_export_values) const;
2259 
2265  bool ShowJavaScriptActionsByField(UTF8Array & out_fields, UTF8Array & out_sources, SourceTypeArray & out_types) const;
2266 
2271  bool ShowVisibilitiesByField(UTF8Array & out_fields, BoolArray & out_states) const;
2272 
2277  bool ShowTextValuesByField(UTF8Array & out_fields, UTF8Array & out_values) const;
2278  };
2279 
2281  class PUBLISH_API AnnotationKit : public SprocketKit
2282  {
2283  public:
2285  AnnotationKit();
2286 
2289  AnnotationKit(AnnotationKit const & in_kit);
2290 
2293  AnnotationKit(AnnotationKit && in_kit);
2294 
2295  virtual ~AnnotationKit();
2296 
2297  static const HPS::Type staticType = HPS::Type::PublishAnnotationKit;
2298  HPS::Type ObjectType() const { return staticType; }
2299 
2303  static AnnotationKit GetDefault();
2304 
2307  void Set(AnnotationKit const & in_kit);
2308 
2311  void Show(AnnotationKit & out_kit) const;
2312 
2316  AnnotationKit & operator=(AnnotationKit const & in_kit);
2317 
2321  AnnotationKit & operator=(AnnotationKit && in_kit);
2322 
2325  bool Empty() const;
2326 
2330  bool Equals(AnnotationKit const & in_kit) const;
2331 
2335  bool operator==(AnnotationKit const & in_kit) const;
2336 
2340  bool operator!=(AnnotationKit const & in_kit) const;
2341 
2342 
2347  AnnotationKit & SetSource(CADModel const & in_cad_model);
2348 
2353  AnnotationKit & SetSource(KeyPathArray const & in_sources);
2354 
2360  AnnotationKit & SetSource(size_t in_count, KeyPath const in_sources[]);
2361 
2366  AnnotationKit & SetSource(KeyPath const & in_source);
2367 
2374  AnnotationKit & SetSource(CADModel const & in_cad_model, KeyPathArray const & in_additional_sources);
2375 
2383  AnnotationKit & SetSource(CADModel const & in_cad_model, size_t in_count, KeyPath const in_additional_sources []);
2384 
2388  AnnotationKit & SetFormat(Annotation::Format in_format);
2389 
2394  AnnotationKit & SetPRCTessellationCompression(bool in_state);
2395 
2400  AnnotationKit & SetPRCBRepCompression(PRC::BRepCompression in_level);
2401 
2406  AnnotationKit & SetPRCBRepRemoval(bool in_state);
2407 
2412  AnnotationKit & SetPRCAttributeRemoval(bool in_state);
2413 
2418  AnnotationKit & SetU3DVersion(U3D::Version in_version);
2419 
2424  AnnotationKit & SetU3DCompression(unsigned char in_level);
2425 
2429  AnnotationKit & SetName(char const * in_name);
2430 
2434  AnnotationKit & SetArtwork(ArtworkKit const & in_artwork);
2435 
2439  AnnotationKit & SetActivation(Activation::When in_when);
2440 
2444  AnnotationKit & SetDeactivation(Deactivation::When in_when);
2445 
2449  AnnotationKit & SetToolbarVisibility(bool in_state);
2450 
2454  AnnotationKit & SetModelTreeVisibility(bool in_state);
2455 
2459  AnnotationKit & SetInteractivity(bool in_state);
2460 
2464  AnnotationKit & SetBorderWidth(int in_width);
2465 
2470  AnnotationKit & SetTransparentBackground(bool in_state);
2471 
2475  AnnotationKit & SetBackgroundColor(RGBColor const & in_color);
2476 
2480  AnnotationKit & SetLighting(Lighting::Mode in_mode);
2481 
2485  AnnotationKit & SetRendering(Rendering::Mode in_mode);
2486 
2490  AnnotationKit & SetPosterImage(ImageKit const & in_image);
2491 
2499  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);
2500 
2507  AnnotationKit & SetCarouselButtons(UTF8Array const & in_button_names, char const * in_previous_button_name, char const * in_next_button_name, size_t in_scroll_size);
2508 
2516  AnnotationKit & SetCarouselViews(size_t in_count, size_t const in_indices[], ImageKit const in_images[] = nullptr);
2517 
2524  AnnotationKit & SetCarouselViews(SizeTArray const & in_indices, ImageKitArray const & in_images = ImageKitArray());
2525 
2542  AnnotationKit & SetPartsList(size_t in_rows, IntRectangle const & in_location, UTF8Array const & in_headers = UTF8Array(), FloatArray const & in_columns = FloatArray(), TextFieldKit const & in_text_style = TextFieldKit(), TextFieldKit const & in_header_text_style = TextFieldKit());
2543 
2544 #ifndef HPS_GULP_CLANG
2545 
2561  AnnotationKit & SetPartsList(size_t in_rows, IntRectangle const & in_location, char const * in_headers[3], float const in_columns[3], TextFieldKit const & in_text_style = TextFieldKit(), TextFieldKit const & in_header_text_style = TextFieldKit());
2562 #endif
2563 
2568  AnnotationKit & SetViewListByField(char const * in_field);
2569 
2576  AnnotationKit & SetViewList(IntRectangle const & in_location, HPS::Publish::ListBoxKit const & in_list);
2577 
2584  AnnotationKit & SetPMIListByField(char const * in_field);
2585 
2593  AnnotationKit & SetPMIList(IntRectangle const & in_location, HPS::Publish::ListBoxKit const & in_list);
2594 
2597  AnnotationKit & UnsetSource();
2598 
2601  AnnotationKit & UnsetFormat();
2602 
2605  AnnotationKit & UnsetPRCTessellationCompression();
2606 
2609  AnnotationKit & UnsetPRCBRepCompression();
2610 
2613  AnnotationKit & UnsetPRCBRepRemoval();
2614 
2617  AnnotationKit & UnsetPRCAttributeRemoval();
2618 
2621  AnnotationKit & UnsetU3DVersion();
2622 
2625  AnnotationKit & UnsetU3DCompression();
2626 
2629  AnnotationKit & UnsetName();
2630 
2633  AnnotationKit & UnsetArtwork();
2634 
2637  AnnotationKit & UnsetActivation();
2638 
2641  AnnotationKit & UnsetDeactivation();
2642 
2645  AnnotationKit & UnsetToolbarVisibility();
2646 
2649  AnnotationKit & UnsetModelTreeVisibility();
2650 
2653  AnnotationKit & UnsetInteractivity();
2654 
2657  AnnotationKit & UnsetBorderWidth();
2658 
2661  AnnotationKit & UnsetTransparentBackground();
2662 
2665  AnnotationKit & UnsetBackgroundColor();
2666 
2669  AnnotationKit & UnsetLighting();
2670 
2673  AnnotationKit & UnsetRendering();
2674 
2677  AnnotationKit & UnsetPosterImage();
2678 
2681  AnnotationKit & UnsetCarouselButtons();
2682 
2685  AnnotationKit & UnsetCarouselViews();
2686 
2689  AnnotationKit & UnsetPartsList();
2690 
2693  AnnotationKit & UnsetViewList();
2694 
2697  AnnotationKit & UnsetPMIList();
2698 
2701  AnnotationKit & UnsetEverything();
2702 
2703 
2709  bool ShowSource(Annotation::SourceType & out_source_type, CADModel & out_cad_model, KeyPathArray & out_key_paths) const;
2710 
2714  bool ShowFormat(Annotation::Format & out_format) const;
2715 
2719  bool ShowPRCTessellationCompression(bool & out_state) const;
2720 
2724  bool ShowPRCBRepCompression(PRC::BRepCompression & out_level) const;
2725 
2729  bool ShowPRCBRepRemoval(bool & out_state) const;
2730 
2734  bool ShowPRCAttributeRemoval(bool & out_state) const;
2735 
2739  bool ShowU3DVersion(U3D::Version & out_version) const;
2740 
2744  bool ShowU3DCompression(unsigned char & out_level) const;
2745 
2749  bool ShowName(UTF8 & out_name) const;
2750 
2754  bool ShowArtwork(ArtworkKit & out_artwork) const;
2755 
2759  bool ShowActivation(Activation::When & out_when) const;
2760 
2764  bool ShowDeactivation(Deactivation::When & out_when) const;
2765 
2769  bool ShowToolbarVisibility(bool & out_state) const;
2770 
2774  bool ShowModelTreeVisibility(bool & out_state) const;
2775 
2779  bool ShowInteractivity(bool & out_state) const;
2780 
2784  bool ShowBorderWidth(int & out_width) const;
2785 
2789  bool ShowTransparentBackground(bool & out_state) const;
2790 
2794  bool ShowBackgroundColor(RGBColor & out_color) const;
2795 
2799  bool ShowLighting(Lighting::Mode & out_mode) const;
2800 
2804  bool ShowRendering(Rendering::Mode & out_mode) const;
2805 
2809  bool ShowPosterImage(ImageKit & out_image) const;
2810 
2817  bool ShowCarouselButtons(UTF8Array & out_button_names, UTF8 & out_previous_button_name, UTF8 & out_next_button_name, size_t & out_scroll_size) const;
2818 
2823  bool ShowCarouselViews(SizeTArray & out_indices, ImageKitArray & out_images) const;
2824 
2833  bool ShowPartsList(size_t & out_rows, IntRectangle & out_location, UTF8Array & out_headers, FloatArray & out_columns, TextFieldKit & out_text_style, TextFieldKit & out_header_text_style) const;
2834 
2838  bool ShowViewListField(UTF8 & out_field) const;
2839 
2844  bool ShowViewList(IntRectangle & out_location, Publish::ListBoxKit & out_list) const;
2845 
2849  bool ShowPMIListField(UTF8 & out_field) const;
2850 
2855  bool ShowPMIList(IntRectangle & out_location, Publish::ListBoxKit & out_list) const;
2856  };
2857 
2859  class PUBLISH_API ArtworkKit : public SprocketKit
2860  {
2861  public:
2863  ArtworkKit();
2864 
2867  ArtworkKit(ArtworkKit const & in_kit);
2868 
2871  ArtworkKit(ArtworkKit && in_kit);
2872 
2873  virtual ~ArtworkKit();
2874 
2875  static const HPS::Type staticType = HPS::Type::PublishArtworkKit;
2876  HPS::Type ObjectType() const { return staticType; }
2877 
2881  static ArtworkKit GetDefault();
2882 
2885  void Set(ArtworkKit const & in_kit);
2886 
2889  void Show(ArtworkKit & out_kit) const;
2890 
2894  ArtworkKit & operator=(ArtworkKit const & in_kit);
2895 
2899  ArtworkKit & operator=(ArtworkKit && in_kit);
2900 
2903  bool Empty() const;
2904 
2908  bool Equals(ArtworkKit const & in_kit) const;
2909 
2913  bool operator==(ArtworkKit const & in_kit) const;
2914 
2918  bool operator!=(ArtworkKit const & in_kit) const;
2919 
2920 
2924  ArtworkKit & SetAnimationStyle(Animation::Style in_style);
2925 
2930  ArtworkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
2931 
2935  ArtworkKit & SetPMICrossHighlighting(bool in_state);
2936 
2940  ArtworkKit & SetPMISemanticInformation(bool in_state);
2941 
2945  ArtworkKit & SetDefaultViewPreference(Artwork::View::Preference in_preference);
2946 
2950  ArtworkKit & SetDisplayPreference(Artwork::Display::Preference in_preference);
2951 
2955  ArtworkKit & SetView(ViewKit const & in_view);
2956 
2960  ArtworkKit & AddView(ViewKit const & in_view);
2961 
2966  ArtworkKit & SetViews(size_t in_count, ViewKit const in_views[]);
2967 
2971  ArtworkKit & SetViews(ViewKitArray const & in_views);
2972 
2977  ArtworkKit & AddViews(size_t in_count, ViewKit const in_views[]);
2978 
2982  ArtworkKit & AddViews(ViewKitArray const & in_views);
2983 
2987  ArtworkKit & SetPMIColor(HPS::RGBColor const & in_pmi_color);
2988 
2989 
2992  ArtworkKit & UnsetAnimationStyle();
2993 
2996  ArtworkKit & UnsetJavaScript();
2997 
3000  ArtworkKit & UnsetPMICrossHighlighting();
3001 
3004  ArtworkKit & UnsetPMISemanticInformation();
3005 
3008  ArtworkKit & UnsetDefaultViewPreference();
3009 
3012  ArtworkKit & UnsetDisplayPreference();
3013 
3017  ArtworkKit & UnsetView(size_t in_index);
3018 
3023  ArtworkKit & UnsetViews(size_t in_count, size_t const in_indices[]);
3024 
3028  ArtworkKit & UnsetViews(SizeTArray const & in_indices);
3029 
3032  ArtworkKit & UnsetViews();
3033 
3036  ArtworkKit & UnsetPMIColor();
3037 
3040  ArtworkKit & UnsetEverything();
3041 
3042 
3046  bool ShowAnimationStyle(Animation::Style & out_style) const;
3047 
3052  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
3053 
3057  bool ShowPMICrossHighlighting(bool & out_state) const;
3058 
3062  bool ShowPMISemanticInformation(bool & out_state) const;
3063 
3067  bool ShowDefaultViewPreference(Artwork::View::Preference & out_preference) const;
3068 
3072  bool ShowDisplayPreference(Artwork::Display::Preference & out_preference) const;
3073 
3077  bool ShowViews(ViewKitArray & out_views) const;
3078 
3082  bool ShowPMIColor(HPS::RGBColor & out_pmi_color) const;
3083  };
3084 
3086  class PUBLISH_API ViewKit : public SprocketKit
3087  {
3088  public:
3090  ViewKit();
3091 
3094  ViewKit(ViewKit const & in_kit);
3095 
3098  ViewKit(ViewKit && in_kit);
3099 
3100  virtual ~ViewKit();
3101 
3102  static const HPS::Type staticType = HPS::Type::PublishViewKit;
3103  HPS::Type ObjectType() const { return staticType; }
3104 
3108  static ViewKit GetDefault();
3109 
3112  void Set(ViewKit const & in_kit);
3113 
3116  void Show(ViewKit & out_kit) const;
3117 
3121  ViewKit & operator=(ViewKit const & in_kit);
3122 
3126  ViewKit & operator=(ViewKit && in_kit);
3127 
3130  bool Empty() const;
3131 
3135  bool Equals(ViewKit const & in_kit) const;
3136 
3140  bool operator==(ViewKit const & in_kit) const;
3141 
3145  bool operator!=(ViewKit const & in_kit) const;
3146 
3147 
3151  ViewKit & SetInternalName(char const * in_name);
3152 
3156  ViewKit & SetExternalName(char const * in_name);
3157 
3166  ViewKit & SetCamera(CameraKit const & in_camera);
3167 
3171  ViewKit & SetDefault(bool in_state);
3172 
3176  ViewKit & SetBackgroundColor(RGBColor const & in_color);
3177 
3181  ViewKit & SetLighting(Lighting::Mode in_mode);
3182 
3186  ViewKit & SetRendering(Rendering::Mode in_mode);
3187 
3188 
3191  ViewKit & UnsetInternalName();
3192 
3195  ViewKit & UnsetExternalName();
3196 
3199  ViewKit & UnsetCamera();
3200 
3203  ViewKit & UnsetDefault();
3204 
3207  ViewKit & UnsetBackgroundColor();
3208 
3211  ViewKit & UnsetLighting();
3212 
3215  ViewKit & UnsetRendering();
3216 
3219  ViewKit & UnsetEverything();
3220 
3221 
3225  bool ShowInternalName(UTF8 & out_name) const;
3226 
3230  bool ShowExternalName(UTF8 & out_name) const;
3231 
3235  bool ShowCamera(CameraKit & out_camera) const;
3236 
3240  bool ShowDefault(bool & out_state) const;
3241 
3245  bool ShowBackgroundColor(RGBColor & out_color) const;
3246 
3250  bool ShowLighting(Lighting::Mode & out_mode) const;
3251 
3255  bool ShowRendering(Rendering::Mode & out_mode) const;
3256  };
3257 
3259  class PUBLISH_API TextKit : public SprocketKit
3260  {
3261  public:
3263  TextKit();
3264 
3267  TextKit(TextKit const & in_kit);
3268 
3271  TextKit(TextKit && in_kit);
3272 
3273  virtual ~TextKit();
3274 
3275  static const HPS::Type staticType = HPS::Type::PublishTextKit;
3276  HPS::Type ObjectType() const { return staticType; }
3277 
3281  static TextKit GetDefault();
3282 
3285  void Set(TextKit const & in_kit);
3286 
3289  void Show(TextKit & out_kit) const;
3290 
3294  TextKit & operator=(TextKit const & in_kit);
3295 
3299  TextKit & operator=(TextKit && in_kit);
3300 
3303  bool Empty() const;
3304 
3308  bool Equals(TextKit const & in_kit) const;
3309 
3313  bool operator==(TextKit const & in_kit) const;
3314 
3318  bool operator!=(TextKit const & in_kit) const;
3319 
3320 
3325  TextKit & SetText(char const * in_text);
3326 
3330  TextKit & SetFont(Text::Font::Name in_font);
3331 
3337  TextKit & SetFont(char const * in_font_name, Text::Language in_language, bool in_embed_font);
3338 
3343  TextKit & SetSize(int in_size);
3344 
3349  TextKit & SetColor(RGBColor const & in_color);
3350 
3351 
3354  TextKit & UnsetText();
3355 
3358  TextKit & UnsetFont();
3359 
3362  TextKit & UnsetSize();
3363 
3366  TextKit & UnsetColor();
3367 
3370  TextKit & UnsetEverything();
3371 
3372 
3376  bool ShowText(UTF8 & out_text) const;
3377 
3385  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;
3386 
3390  bool ShowSize(int & out_size) const;
3391 
3395  bool ShowColor(RGBColor & out_color) const;
3396  };
3397 
3399  class PUBLISH_API ImageKit : public SprocketKit
3400  {
3401  public:
3403  ImageKit();
3404 
3407  ImageKit(ImageKit const & in_kit);
3408 
3411  ImageKit(ImageKit && in_kit);
3412 
3413  virtual ~ImageKit();
3414 
3415  static const HPS::Type staticType = HPS::Type::PublishImageKit;
3416  HPS::Type ObjectType() const { return staticType; }
3417 
3418  // no GetDefault() since function doesn't make sense for this class
3419 
3422  void Set(ImageKit const & in_kit);
3423 
3426  void Show(ImageKit & out_kit) const;
3427 
3431  ImageKit & operator=(ImageKit const & in_kit);
3432 
3436  ImageKit & operator=(ImageKit && in_kit);
3437 
3440  bool Empty() const;
3441 
3445  bool Equals(ImageKit const & in_kit) const;
3446 
3450  bool operator==(ImageKit const & in_kit) const;
3451 
3455  bool operator!=(ImageKit const & in_kit) const;
3456 
3457 
3461  ImageKit & SetFile(char const * in_filename);
3462 
3468  ImageKit & SetSize(int in_width, int in_height);
3469 
3473  ImageKit & SetFormat(Image::Format in_format);
3474 
3475 
3478  ImageKit & UnsetFile();
3479 
3482  ImageKit & UnsetSize();
3483 
3486  ImageKit & UnsetFormat();
3487 
3490  ImageKit & UnsetEverything();
3491 
3492 
3496  bool ShowFile(UTF8 & out_filename) const;
3497 
3502  bool ShowSize(int & out_width, int & out_height) const;
3503 
3507  bool ShowFormat(Image::Format & out_format) const;
3508  };
3509 
3512  class PUBLISH_API TableKit : public SprocketKit
3513  {
3514  public:
3516  TableKit();
3517 
3520  TableKit(TableKit const & in_kit);
3521 
3524  TableKit(TableKit && in_kit);
3525 
3526  virtual ~TableKit();
3527 
3528  static const HPS::Type staticType = HPS::Type::PublishTableKit;
3529  HPS::Type ObjectType() const { return staticType; }
3530 
3531  // no GetDefault() since function doesn't make sense for this class
3532 
3535  void Set(TableKit const & in_kit);
3536 
3539  void Show(TableKit & out_kit) const;
3540 
3544  TableKit & operator=(TableKit const & in_kit);
3545 
3549  TableKit & operator=(TableKit && in_kit);
3550 
3553  bool Empty() const;
3554 
3558  bool Equals(TableKit const & in_kit) const;
3559 
3563  bool operator==(TableKit const & in_kit) const;
3564 
3568  bool operator!=(TableKit const & in_kit) const;
3569 
3570 
3575  TableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3576 
3581  TableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3582 
3588  TableKit & SetLink(int in_row, int in_column, LinkKit const & in_link);
3589 
3595  TableKit & SetText(int in_row, int in_column, TextKit const & in_text);
3596 
3602  TableKit & SetButton(int in_row, int in_column, ButtonKit const & in_button);
3603 
3609  TableKit & SetTextField(int in_row, int in_column, TextFieldKit const & in_text_field);
3610 
3611 
3614  TableKit & UnsetHTML();
3615 
3618  TableKit & UnsetHTMLStyle();
3619 
3622  TableKit & UnsetLink(int in_row, int in_column);
3623 
3626  TableKit & UnsetText(int in_row, int in_column);
3627 
3630  TableKit & UnsetButton(int in_row, int in_column);
3631 
3634  TableKit & UnsetTextField(int in_row, int in_column);
3635 
3638  TableKit & UnsetEverything();
3639 
3640 
3645  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3646 
3651  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3652 
3658  bool ShowLink(int in_row, int in_column, LinkKit & out_link) const;
3659 
3665  bool ShowText(int in_row, int in_column, TextKit & out_text) const;
3666 
3672  bool ShowButton(int in_row, int in_column, ButtonKit & out_button) const;
3673 
3679  bool ShowTextField(int in_row, int in_column, TextFieldKit & out_text_field) const;
3680  };
3681 
3684  class PUBLISH_API SlideTableKit : public SprocketKit
3685  {
3686  public:
3688  SlideTableKit();
3689 
3692  SlideTableKit(SlideTableKit const & in_kit);
3693 
3696  SlideTableKit(SlideTableKit && in_kit);
3697 
3698  virtual ~SlideTableKit();
3699 
3700  static const HPS::Type staticType = HPS::Type::PublishSlideTableKit;
3701  HPS::Type ObjectType() const { return staticType; }
3702 
3703  // no GetDefault() since function doesn't make sense for this class
3704 
3707  void Set(SlideTableKit const & in_kit);
3708 
3711  void Show(SlideTableKit & out_kit) const;
3712 
3716  SlideTableKit & operator=(SlideTableKit const & in_kit);
3717 
3721  SlideTableKit & operator=(SlideTableKit && in_kit);
3722 
3725  bool Empty() const;
3726 
3730  bool Equals(SlideTableKit const & in_kit) const;
3731 
3735  bool operator==(SlideTableKit const & in_kit) const;
3736 
3740  bool operator!=(SlideTableKit const & in_kit) const;
3741 
3742 
3747  SlideTableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3748 
3753  SlideTableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3754 
3759  SlideTableKit & SetButtons(char const * in_previous_button_name, char const * in_next_button_name);
3760 
3766  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKit const in_text[]);
3767 
3773  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKitArray const & in_text);
3774 
3778  SlideTableKit & SetHeader(bool in_state);
3779 
3780 
3783  SlideTableKit & UnsetHTML();
3784 
3787  SlideTableKit & UnsetHTMLStyle();
3788 
3791  SlideTableKit & UnsetButtons();
3792 
3795  SlideTableKit & UnsetText();
3796 
3799  SlideTableKit & UnsetHeader();
3800 
3803  SlideTableKit & UnsetEverything();
3804 
3805 
3810  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3811 
3816  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3817 
3822  bool ShowButtons(UTF8 & out_previous_button_name, UTF8 & out_next_button_name) const;
3823 
3829  bool ShowText(size_t & out_rows, size_t & out_columns, TextFieldKitArray & out_text) const;
3830 
3834  bool ShowHeader(bool & out_state) const;
3835  };
3836 
3838  class PUBLISH_API LinkKit : public SprocketKit
3839  {
3840  public:
3842  LinkKit();
3843 
3846  LinkKit(LinkKit const & in_kit);
3847 
3850  LinkKit(LinkKit && in_kit);
3851 
3852  virtual ~LinkKit();
3853 
3854  static const HPS::Type staticType = HPS::Type::PublishLinkKit;
3855  HPS::Type ObjectType() const { return staticType; }
3856 
3857  // no GetDefault() since function doesn't make sense for this class
3858 
3861  void Set(LinkKit const & in_kit);
3862 
3865  void Show(LinkKit & out_kit) const;
3866 
3870  LinkKit & operator=(LinkKit const & in_kit);
3871 
3875  LinkKit & operator=(LinkKit && in_kit);
3876 
3879  bool Empty() const;
3880 
3884  bool Equals(LinkKit const & in_kit) const;
3885 
3889  bool operator==(LinkKit const & in_kit) const;
3890 
3894  bool operator!=(LinkKit const & in_kit) const;
3895 
3896 
3901  LinkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
3902 
3906  LinkKit & SetBorderWidth(int in_width);
3907 
3911  LinkKit & SetHighlighting(Highlighting::Mode in_mode);
3912 
3916  LinkKit & SetBorderColor(RGBColor const & in_color);
3917 
3918 
3921  LinkKit & UnsetJavaScript();
3922 
3925  LinkKit & UnsetBorderWidth();
3926 
3929  LinkKit & UnsetHighlighting();
3930 
3933  LinkKit & UnsetBorderColor();
3934 
3937  LinkKit & UnsetEverything();
3938 
3939 
3944  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
3945 
3949  bool ShowBorderWidth(int & out_width) const;
3950 
3954  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
3955 
3959  bool ShowBorderColor(RGBColor & out_color) const;
3960  };
3961 
3963  class PUBLISH_API ButtonKit : public SprocketKit
3964  {
3965  public:
3967  ButtonKit();
3968 
3971  ButtonKit(ButtonKit const & in_kit);
3972 
3975  ButtonKit(ButtonKit && in_kit);
3976 
3977  virtual ~ButtonKit();
3978 
3979  static const HPS::Type staticType = HPS::Type::PublishButtonKit;
3980  HPS::Type ObjectType() const { return staticType; }
3981 
3985  static ButtonKit GetDefault();
3986 
3989  void Set(ButtonKit const & in_kit);
3990 
3993  void Show(ButtonKit & out_kit) const;
3994 
3998  ButtonKit & operator=(ButtonKit const & in_kit);
3999 
4003  ButtonKit & operator=(ButtonKit && in_kit);
4004 
4007  bool Empty() const;
4008 
4012  bool Equals(ButtonKit const & in_kit) const;
4013 
4017  bool operator==(ButtonKit const & in_kit) const;
4018 
4022  bool operator!=(ButtonKit const & in_kit) const;
4023 
4024 
4028  ButtonKit & SetName(char const * in_name);
4029 
4033  ButtonKit & SetLabel(char const * in_label);
4034 
4038  ButtonKit & SetFont(Text::Font::Name in_name);
4039 
4044  ButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4045 
4049  ButtonKit & SetFontSize(int in_size);
4050 
4054  ButtonKit & SetTextColor(RGBColor const & in_color);
4055 
4059  ButtonKit & SetTooltip(char const * in_tooltip);
4060 
4064  ButtonKit & SetVisibility(bool in_state);
4065 
4069  ButtonKit & SetPrintability(bool in_state);
4070 
4074  ButtonKit & SetTextRotation(Text::Rotation in_rotation);
4075 
4079  ButtonKit & SetLock(bool in_state);
4080 
4084  ButtonKit & SetBorder(bool in_state);
4085 
4089  ButtonKit & SetBorderColor(RGBColor const & in_color);
4090 
4094  ButtonKit & SetBorderThickness(Border::Thickness in_thickness);
4095 
4099  ButtonKit & SetBorderStyle(Border::Style in_style);
4100 
4105  ButtonKit & SetFillColor(RGBColor const & in_color);
4106 
4110  ButtonKit & SetLabelPosition(Label::Position in_position);
4111 
4115  ButtonKit & SetHighlighting(Highlighting::Mode in_mode);
4116 
4120  ButtonKit & SetIconImage(ImageKit const & in_image);
4121 
4122 
4125  ButtonKit & UnsetName();
4126 
4129  ButtonKit & UnsetLabel();
4130 
4133  ButtonKit & UnsetFont();
4134 
4137  ButtonKit & UnsetFontSize();
4138 
4141  ButtonKit & UnsetTextColor();
4142 
4145  ButtonKit & UnsetTooltip();
4146 
4149  ButtonKit & UnsetVisibility();
4150 
4153  ButtonKit & UnsetPrintability();
4154 
4157  ButtonKit & UnsetTextRotation();
4158 
4161  ButtonKit & UnsetLock();
4162 
4165  ButtonKit & UnsetBorder();
4166 
4169  ButtonKit & UnsetBorderColor();
4170 
4173  ButtonKit & UnsetBorderThickness();
4174 
4177  ButtonKit & UnsetBorderStyle();
4178 
4181  ButtonKit & UnsetFillColor();
4182 
4185  ButtonKit & UnsetLabelPosition();
4186 
4189  ButtonKit & UnsetHighlighting();
4190 
4193  ButtonKit & UnsetIconImage();
4194 
4197  ButtonKit & UnsetEverything();
4198 
4199 
4203  bool ShowName(UTF8 & out_name) const;
4204 
4208  bool ShowLabel(UTF8 & out_label) const;
4209 
4216  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4217 
4221  bool ShowFontSize(int & out_size) const;
4222 
4226  bool ShowTextColor(RGBColor & out_color) const;
4227 
4231  bool ShowTooltip(UTF8 & out_tooltip) const;
4232 
4236  bool ShowVisibility(bool & out_state) const;
4237 
4241  bool ShowPrintability(bool & out_state) const;
4242 
4246  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4247 
4251  bool ShowLock(bool & out_state) const;
4252 
4256  bool ShowBorder(bool & out_state) const;
4257 
4261  bool ShowBorderColor(RGBColor & out_color) const;
4262 
4266  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4267 
4271  bool ShowBorderStyle(Border::Style & out_style) const;
4272 
4276  bool ShowFillColor(RGBColor & out_color) const;
4277 
4281  bool ShowLabelPosition(Label::Position & out_position) const;
4282 
4286  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
4287 
4291  bool ShowIconImage(ImageKit & out_image) const;
4292  };
4293 
4295  class PUBLISH_API CheckBoxKit : public SprocketKit
4296  {
4297  public:
4299  CheckBoxKit();
4300 
4303  CheckBoxKit(CheckBoxKit const & in_kit);
4304 
4307  CheckBoxKit(CheckBoxKit && in_kit);
4308 
4309  virtual ~CheckBoxKit();
4310 
4311  static const HPS::Type staticType = HPS::Type::PublishCheckBoxKit;
4312  HPS::Type ObjectType() const { return staticType; }
4313 
4317  static CheckBoxKit GetDefault();
4318 
4321  void Set(CheckBoxKit const & in_kit);
4322 
4325  void Show(CheckBoxKit & out_kit) const;
4326 
4330  CheckBoxKit & operator=(CheckBoxKit const & in_kit);
4331 
4335  CheckBoxKit & operator=(CheckBoxKit && in_kit);
4336 
4339  bool Empty() const;
4340 
4344  bool Equals(CheckBoxKit const & in_kit) const;
4345 
4349  bool operator==(CheckBoxKit const & in_kit) const;
4350 
4354  bool operator!=(CheckBoxKit const & in_kit) const;
4355 
4356 
4360  CheckBoxKit & SetName(char const * in_name);
4361 
4365  CheckBoxKit & SetFont(Text::Font::Name in_name);
4366 
4371  CheckBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4372 
4376  CheckBoxKit & SetFontSize(int in_size);
4377 
4381  CheckBoxKit & SetTextColor(RGBColor const & in_color);
4382 
4386  CheckBoxKit & SetTooltip(char const * in_tooltip);
4387 
4391  CheckBoxKit & SetVisibility(bool in_state);
4392 
4396  CheckBoxKit & SetPrintability(bool in_state);
4397 
4401  CheckBoxKit & SetTextRotation(Text::Rotation in_rotation);
4402 
4406  CheckBoxKit & SetLock(bool in_state);
4407 
4411  CheckBoxKit & SetBorder(bool in_state);
4412 
4416  CheckBoxKit & SetBorderColor(RGBColor const & in_color);
4417 
4421  CheckBoxKit & SetBorderThickness(Border::Thickness in_thickness);
4422 
4426  CheckBoxKit & SetBorderStyle(Border::Style in_style);
4427 
4432  CheckBoxKit & SetFillColor(RGBColor const & in_color);
4433 
4437  CheckBoxKit & SetExportValue(char const * in_export_value);
4438 
4442  CheckBoxKit & SetDefaultState(bool in_state);
4443 
4444 
4447  CheckBoxKit & UnsetName();
4448 
4451  CheckBoxKit & UnsetFont();
4452 
4455  CheckBoxKit & UnsetFontSize();
4456 
4459  CheckBoxKit & UnsetTextColor();
4460 
4463  CheckBoxKit & UnsetTooltip();
4464 
4467  CheckBoxKit & UnsetVisibility();
4468 
4471  CheckBoxKit & UnsetPrintability();
4472 
4475  CheckBoxKit & UnsetTextRotation();
4476 
4479  CheckBoxKit & UnsetLock();
4480 
4483  CheckBoxKit & UnsetBorder();
4484 
4487  CheckBoxKit & UnsetBorderColor();
4488 
4491  CheckBoxKit & UnsetBorderThickness();
4492 
4495  CheckBoxKit & UnsetBorderStyle();
4496 
4499  CheckBoxKit & UnsetFillColor();
4500 
4503  CheckBoxKit & UnsetExportValue();
4504 
4507  CheckBoxKit & UnsetDefaultState();
4508 
4511  CheckBoxKit & UnsetEverything();
4512 
4513 
4517  bool ShowName(UTF8 & out_name) const;
4518 
4525  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4526 
4530  bool ShowFontSize(int & out_size) const;
4531 
4535  bool ShowTextColor(RGBColor & out_color) const;
4536 
4540  bool ShowTooltip(UTF8 & out_tooltip) const;
4541 
4545  bool ShowVisibility(bool & out_state) const;
4546 
4550  bool ShowPrintability(bool & out_state) const;
4551 
4555  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4556 
4560  bool ShowLock(bool & out_state) const;
4561 
4565  bool ShowBorder(bool & out_state) const;
4566 
4570  bool ShowBorderColor(RGBColor & out_color) const;
4571 
4575  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4576 
4580  bool ShowBorderStyle(Border::Style & out_style) const;
4581 
4585  bool ShowFillColor(RGBColor & out_color) const;
4586 
4590  bool ShowExportValue(UTF8 & out_export_value) const;
4591 
4595  bool ShowDefaultState(bool & out_default_state) const;
4596  };
4597 
4599  class PUBLISH_API RadioButtonKit : public SprocketKit
4600  {
4601  public:
4603  RadioButtonKit();
4604 
4607  RadioButtonKit(RadioButtonKit const & in_kit);
4608 
4611  RadioButtonKit(RadioButtonKit && in_kit);
4612 
4613  virtual ~RadioButtonKit();
4614 
4615  static const HPS::Type staticType = HPS::Type::PublishRadioButtonKit;
4616  HPS::Type ObjectType() const { return staticType; }
4617 
4621  static RadioButtonKit GetDefault();
4622 
4625  void Set(RadioButtonKit const & in_kit);
4626 
4629  void Show(RadioButtonKit & out_kit) const;
4630 
4634  RadioButtonKit & operator=(RadioButtonKit const & in_kit);
4635 
4639  RadioButtonKit & operator=(RadioButtonKit && in_kit);
4640 
4643  bool Empty() const;
4644 
4648  bool Equals(RadioButtonKit const & in_kit) const;
4649 
4653  bool operator==(RadioButtonKit const & in_kit) const;
4654 
4658  bool operator!=(RadioButtonKit const & in_kit) const;
4659 
4660 
4664  RadioButtonKit & SetName(char const * in_name);
4665 
4669  RadioButtonKit & SetFont(Text::Font::Name in_name);
4670 
4675  RadioButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4676 
4680  RadioButtonKit & SetFontSize(int in_size);
4681 
4685  RadioButtonKit & SetTextColor(RGBColor const & in_color);
4686 
4690  RadioButtonKit & SetTooltip(char const * in_tooltip);
4691 
4695  RadioButtonKit & SetVisibility(bool in_state);
4696 
4700  RadioButtonKit & SetPrintability(bool in_state);
4701 
4705  RadioButtonKit & SetTextRotation(Text::Rotation in_rotation);
4706 
4710  RadioButtonKit & SetLock(bool in_state);
4711 
4715  RadioButtonKit & SetBorder(bool in_state);
4716 
4720  RadioButtonKit & SetBorderColor(RGBColor const & in_color);
4721 
4725  RadioButtonKit & SetBorderThickness(Border::Thickness in_thickness);
4726 
4730  RadioButtonKit & SetBorderStyle(Border::Style in_style);
4731 
4736  RadioButtonKit & SetFillColor(RGBColor const & in_color);
4737 
4741  RadioButtonKit & SetExportValue(char const * in_export_value);
4742 
4746  RadioButtonKit & SetDefaultState(bool in_state);
4747 
4751  RadioButtonKit & SetGrouping(bool in_state);
4752 
4753 
4756  RadioButtonKit & UnsetName();
4757 
4760  RadioButtonKit & UnsetFont();
4761 
4764  RadioButtonKit & UnsetFontSize();
4765 
4768  RadioButtonKit & UnsetTextColor();
4769 
4772  RadioButtonKit & UnsetTooltip();
4773 
4776  RadioButtonKit & UnsetVisibility();
4777 
4780  RadioButtonKit & UnsetPrintability();
4781 
4784  RadioButtonKit & UnsetTextRotation();
4785 
4788  RadioButtonKit & UnsetLock();
4789 
4792  RadioButtonKit & UnsetBorder();
4793 
4796  RadioButtonKit & UnsetBorderColor();
4797 
4800  RadioButtonKit & UnsetBorderThickness();
4801 
4804  RadioButtonKit & UnsetBorderStyle();
4805 
4808  RadioButtonKit & UnsetFillColor();
4809 
4812  RadioButtonKit & UnsetExportValue();
4813 
4816  RadioButtonKit & UnsetDefaultState();
4817 
4820  RadioButtonKit & UnsetGrouping();
4821 
4824  RadioButtonKit & UnsetEverything();
4825 
4826 
4830  bool ShowName(UTF8 & out_name) const;
4831 
4838  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4839 
4843  bool ShowFontSize(int & out_size) const;
4844 
4848  bool ShowTextColor(RGBColor & out_color) const;
4849 
4853  bool ShowTooltip(UTF8 & out_tooltip) const;
4854 
4858  bool ShowVisibility(bool & out_state) const;
4859 
4863  bool ShowPrintability(bool & out_state) const;
4864 
4868  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4869 
4873  bool ShowLock(bool & out_state) const;
4874 
4878  bool ShowBorder(bool & out_state) const;
4879 
4883  bool ShowBorderColor(RGBColor & out_color) const;
4884 
4888  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4889 
4893  bool ShowBorderStyle(Border::Style & out_style) const;
4894 
4898  bool ShowFillColor(RGBColor & out_color) const;
4899 
4903  bool ShowExportValue(UTF8 & out_export_value) const;
4904 
4908  bool ShowDefaultState(bool & out_default_state) const;
4909 
4913  bool ShowGrouping(bool & out_grouping) const;
4914  };
4915 
4917  class PUBLISH_API ListBoxKit : public SprocketKit
4918  {
4919  public:
4921  ListBoxKit();
4922 
4925  ListBoxKit(ListBoxKit const & in_kit);
4926 
4929  ListBoxKit(ListBoxKit && in_kit);
4930 
4931  virtual ~ListBoxKit();
4932 
4933  static const HPS::Type staticType = HPS::Type::PublishListBoxKit;
4934  HPS::Type ObjectType() const { return staticType; }
4935 
4939  static ListBoxKit GetDefault();
4940 
4943  void Set(ListBoxKit const & in_kit);
4944 
4947  void Show(ListBoxKit & out_kit) const;
4948 
4952  ListBoxKit & operator=(ListBoxKit const & in_kit);
4953 
4957  ListBoxKit & operator=(ListBoxKit && in_kit);
4958 
4961  bool Empty() const;
4962 
4966  bool Equals(ListBoxKit const & in_kit) const;
4967 
4971  bool operator==(ListBoxKit const & in_kit) const;
4972 
4976  bool operator!=(ListBoxKit const & in_kit) const;
4977 
4978 
4982  ListBoxKit & SetName(char const * in_name);
4983 
4987  ListBoxKit & SetFont(Text::Font::Name in_name);
4988 
4993  ListBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4994 
4998  ListBoxKit & SetFontSize(int in_size);
4999 
5003  ListBoxKit & SetTextColor(RGBColor const & in_color);
5004 
5008  ListBoxKit & SetTooltip(char const * in_tooltip);
5009 
5013  ListBoxKit & SetVisibility(bool in_state);
5014 
5018  ListBoxKit & SetPrintability(bool in_state);
5019 
5023  ListBoxKit & SetTextRotation(Text::Rotation in_rotation);
5024 
5028  ListBoxKit & SetLock(bool in_state);
5029 
5033  ListBoxKit & SetBorder(bool in_state);
5034 
5038  ListBoxKit & SetBorderColor(RGBColor const & in_color);
5039 
5043  ListBoxKit & SetBorderThickness(Border::Thickness in_thickness);
5044 
5048  ListBoxKit & SetBorderStyle(Border::Style in_style);
5049 
5054  ListBoxKit & SetFillColor(RGBColor const & in_color);
5055 
5059  ListBoxKit & SetMultipleSelection(bool in_state);
5060 
5066  ListBoxKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
5067 
5073  ListBoxKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
5074 
5075 
5078  ListBoxKit & UnsetName();
5079 
5082  ListBoxKit & UnsetFont();
5083 
5086  ListBoxKit & UnsetFontSize();
5087 
5090  ListBoxKit & UnsetTextColor();
5091 
5094  ListBoxKit & UnsetTooltip();
5095 
5098  ListBoxKit & UnsetVisibility();
5099 
5102  ListBoxKit & UnsetPrintability();
5103 
5106  ListBoxKit & UnsetTextRotation();
5107 
5110  ListBoxKit & UnsetLock();
5111 
5114  ListBoxKit & UnsetBorder();
5115 
5118  ListBoxKit & UnsetBorderColor();
5119 
5122  ListBoxKit & UnsetBorderThickness();
5123 
5126  ListBoxKit & UnsetBorderStyle();
5127 
5130  ListBoxKit & UnsetFillColor();
5131 
5134  ListBoxKit & UnsetMultipleSelection();
5135 
5138  ListBoxKit & UnsetContents();
5139 
5142  ListBoxKit & UnsetEverything();
5143 
5144 
5148  bool ShowName(UTF8 & out_name) const;
5149 
5156  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5157 
5161  bool ShowFontSize(int & out_size) const;
5162 
5166  bool ShowTextColor(RGBColor & out_color) const;
5167 
5171  bool ShowTooltip(UTF8 & out_tooltip) const;
5172 
5176  bool ShowVisibility(bool & out_state) const;
5177 
5181  bool ShowPrintability(bool & out_state) const;
5182 
5186  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5187 
5191  bool ShowLock(bool & out_state) const;
5192 
5196  bool ShowBorder(bool & out_state) const;
5197 
5201  bool ShowBorderColor(RGBColor & out_color) const;
5202 
5206  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5207 
5211  bool ShowBorderStyle(Border::Style & out_style) const;
5212 
5216  bool ShowFillColor(RGBColor & out_color) const;
5217 
5221  bool ShowMultipleSelection(bool & out_state) const;
5222 
5227  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5228  };
5229 
5231  class PUBLISH_API DropDownListKit : public SprocketKit
5232  {
5233  public:
5235  DropDownListKit();
5236 
5239  DropDownListKit(DropDownListKit const & in_kit);
5240 
5243  DropDownListKit(DropDownListKit && in_kit);
5244 
5245  virtual ~DropDownListKit();
5246 
5247  static const HPS::Type staticType = HPS::Type::PublishDropDownListKit;
5248  HPS::Type ObjectType() const { return staticType; }
5249 
5253  static DropDownListKit GetDefault();
5254 
5257  void Set(DropDownListKit const & in_kit);
5258 
5261  void Show(DropDownListKit & out_kit) const;
5262 
5266  DropDownListKit & operator=(DropDownListKit const & in_kit);
5267 
5271  DropDownListKit & operator=(DropDownListKit && in_kit);
5272 
5275  bool Empty() const;
5276 
5280  bool Equals(DropDownListKit const & in_kit) const;
5281 
5285  bool operator==(DropDownListKit const & in_kit) const;
5286 
5290  bool operator!=(DropDownListKit const & in_kit) const;
5291 
5292 
5296  DropDownListKit & SetName(char const * in_name);
5297 
5301  DropDownListKit & SetFont(Text::Font::Name in_name);
5302 
5307  DropDownListKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5308 
5312  DropDownListKit & SetFontSize(int in_size);
5313 
5317  DropDownListKit & SetTextColor(RGBColor const & in_color);
5318 
5322  DropDownListKit & SetTooltip(char const * in_tooltip);
5323 
5327  DropDownListKit & SetVisibility(bool in_state);
5328 
5332  DropDownListKit & SetPrintability(bool in_state);
5333 
5337  DropDownListKit & SetTextRotation(Text::Rotation in_rotation);
5338 
5342  DropDownListKit & SetLock(bool in_state);
5343 
5347  DropDownListKit & SetBorder(bool in_state);
5348 
5352  DropDownListKit & SetBorderColor(RGBColor const & in_color);
5353 
5357  DropDownListKit & SetBorderThickness(Border::Thickness in_thickness);
5358 
5362  DropDownListKit & SetBorderStyle(Border::Style in_style);
5363 
5368  DropDownListKit & SetFillColor(RGBColor const & in_color);
5369 
5373  DropDownListKit & SetCustomText(bool in_state);
5374 
5378  DropDownListKit & SetSpellChecking(bool in_state);
5379 
5383  DropDownListKit & SetImmediateCommit(bool in_state);
5384 
5390  DropDownListKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
5391 
5397  DropDownListKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
5398 
5399 
5402  DropDownListKit & UnsetName();
5403 
5406  DropDownListKit & UnsetFont();
5407 
5410  DropDownListKit & UnsetFontSize();
5411 
5414  DropDownListKit & UnsetTextColor();
5415 
5418  DropDownListKit & UnsetTooltip();
5419 
5422  DropDownListKit & UnsetVisibility();
5423 
5426  DropDownListKit & UnsetPrintability();
5427 
5430  DropDownListKit & UnsetTextRotation();
5431 
5434  DropDownListKit & UnsetLock();
5435 
5438  DropDownListKit & UnsetBorder();
5439 
5442  DropDownListKit & UnsetBorderColor();
5443 
5446  DropDownListKit & UnsetBorderThickness();
5447 
5450  DropDownListKit & UnsetBorderStyle();
5451 
5454  DropDownListKit & UnsetFillColor();
5455 
5458  DropDownListKit & UnsetCustomText();
5459 
5462  DropDownListKit & UnsetSpellChecking();
5463 
5466  DropDownListKit & UnsetImmediateCommit();
5467 
5470  DropDownListKit & UnsetContents();
5471 
5474  DropDownListKit & UnsetEverything();
5475 
5476 
5480  bool ShowName(UTF8 & out_name) const;
5481 
5488  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5489 
5493  bool ShowFontSize(int & out_size) const;
5494 
5498  bool ShowTextColor(RGBColor & out_color) const;
5499 
5503  bool ShowTooltip(UTF8 & out_tooltip) const;
5504 
5508  bool ShowVisibility(bool & out_state) const;
5509 
5513  bool ShowPrintability(bool & out_state) const;
5514 
5518  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5519 
5523  bool ShowLock(bool & out_state) const;
5524 
5528  bool ShowBorder(bool & out_state) const;
5529 
5533  bool ShowBorderColor(RGBColor & out_color) const;
5534 
5538  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5539 
5543  bool ShowBorderStyle(Border::Style & out_style) const;
5544 
5548  bool ShowFillColor(RGBColor & out_color) const;
5549 
5553  bool ShowCustomText(bool & out_state) const;
5554 
5558  bool ShowSpellChecking(bool & out_state) const;
5559 
5563  bool ShowImmediateCommit(bool & out_state) const;
5564 
5569  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5570  };
5571 
5573  class PUBLISH_API SignatureFieldKit : public SprocketKit
5574  {
5575  public:
5578 
5581  SignatureFieldKit(SignatureFieldKit const & in_kit);
5582 
5586 
5587  virtual ~SignatureFieldKit();
5588 
5589  static const HPS::Type staticType = HPS::Type::PublishSignatureFieldKit;
5590  HPS::Type ObjectType() const { return staticType; }
5591 
5595  static SignatureFieldKit GetDefault();
5596 
5599  void Set(SignatureFieldKit const & in_kit);
5600 
5603  void Show(SignatureFieldKit & out_kit) const;
5604 
5608  SignatureFieldKit & operator=(SignatureFieldKit const & in_kit);
5609 
5613  SignatureFieldKit & operator=(SignatureFieldKit && in_kit);
5614 
5617  bool Empty() const;
5618 
5622  bool Equals(SignatureFieldKit const & in_kit) const;
5623 
5627  bool operator==(SignatureFieldKit const & in_kit) const;
5628 
5632  bool operator!=(SignatureFieldKit const & in_kit) const;
5633 
5634 
5638  SignatureFieldKit & SetName(char const * in_name);
5639 
5643  SignatureFieldKit & SetFont(Text::Font::Name in_name);
5644 
5649  SignatureFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5650 
5654  SignatureFieldKit & SetFontSize(int in_size);
5655 
5659  SignatureFieldKit & SetTextColor(RGBColor const & in_color);
5660 
5664  SignatureFieldKit & SetTooltip(char const * in_tooltip);
5665 
5669  SignatureFieldKit & SetVisibility(bool in_state);
5670 
5674  SignatureFieldKit & SetPrintability(bool in_state);
5675 
5679  SignatureFieldKit & SetTextRotation(Text::Rotation in_rotation);
5680 
5684  SignatureFieldKit & SetLock(bool in_state);
5685 
5689  SignatureFieldKit & SetBorder(bool in_state);
5690 
5694  SignatureFieldKit & SetBorderColor(RGBColor const & in_color);
5695 
5699  SignatureFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5700 
5704  SignatureFieldKit & SetBorderStyle(Border::Style in_style);
5705 
5710  SignatureFieldKit & SetFillColor(RGBColor const & in_color);
5711 
5712 
5715  SignatureFieldKit & UnsetName();
5716 
5719  SignatureFieldKit & UnsetFont();
5720 
5723  SignatureFieldKit & UnsetFontSize();
5724 
5727  SignatureFieldKit & UnsetTextColor();
5728 
5731  SignatureFieldKit & UnsetTooltip();
5732 
5735  SignatureFieldKit & UnsetVisibility();
5736 
5739  SignatureFieldKit & UnsetPrintability();
5740 
5743  SignatureFieldKit & UnsetTextRotation();
5744 
5747  SignatureFieldKit & UnsetLock();
5748 
5751  SignatureFieldKit & UnsetBorder();
5752 
5755  SignatureFieldKit & UnsetBorderColor();
5756 
5759  SignatureFieldKit & UnsetBorderThickness();
5760 
5763  SignatureFieldKit & UnsetBorderStyle();
5764 
5767  SignatureFieldKit & UnsetFillColor();
5768 
5771  SignatureFieldKit & UnsetEverything();
5772 
5773 
5777  bool ShowName(UTF8 & out_name) const;
5778 
5785  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5786 
5790  bool ShowFontSize(int & out_size) const;
5791 
5795  bool ShowTextColor(RGBColor & out_color) const;
5796 
5800  bool ShowTooltip(UTF8 & out_tooltip) const;
5801 
5805  bool ShowVisibility(bool & out_state) const;
5806 
5810  bool ShowPrintability(bool & out_state) const;
5811 
5815  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5816 
5820  bool ShowLock(bool & out_state) const;
5821 
5825  bool ShowBorder(bool & out_state) const;
5826 
5830  bool ShowBorderColor(RGBColor & out_color) const;
5831 
5835  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5836 
5840  bool ShowBorderStyle(Border::Style & out_style) const;
5841 
5845  bool ShowFillColor(RGBColor & out_color) const;
5846  };
5847 
5849  class PUBLISH_API TextFieldKit : public SprocketKit
5850  {
5851  public:
5853  TextFieldKit();
5854 
5857  TextFieldKit(TextFieldKit const & in_kit);
5858 
5861  TextFieldKit(TextFieldKit && in_kit);
5862 
5863  virtual ~TextFieldKit();
5864 
5865  static const HPS::Type staticType = HPS::Type::PublishTextFieldKit;
5866  HPS::Type ObjectType() const { return staticType; }
5867 
5871  static TextFieldKit GetDefault();
5872 
5875  void Set(TextFieldKit const & in_kit);
5876 
5879  void Show(TextFieldKit & out_kit) const;
5880 
5884  TextFieldKit & operator=(TextFieldKit const & in_kit);
5885 
5889  TextFieldKit & operator=(TextFieldKit && in_kit);
5890 
5893  bool Empty() const;
5894 
5898  bool Equals(TextFieldKit const & in_kit) const;
5899 
5903  bool operator==(TextFieldKit const & in_kit) const;
5904 
5908  bool operator!=(TextFieldKit const & in_kit) const;
5909 
5910 
5911 
5915  TextFieldKit & SetName(char const * in_name);
5916 
5920  TextFieldKit & SetFont(Text::Font::Name in_name);
5921 
5926  TextFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5927 
5931  TextFieldKit & SetFontSize(int in_size);
5932 
5936  TextFieldKit & SetTextColor(RGBColor const & in_color);
5937 
5941  TextFieldKit & SetTooltip(char const * in_tooltip);
5942 
5946  TextFieldKit & SetVisibility(bool in_state);
5947 
5951  TextFieldKit & SetPrintability(bool in_state);
5952 
5956  TextFieldKit & SetTextRotation(Text::Rotation in_rotation);
5957 
5961  TextFieldKit & SetLock(bool in_state);
5962 
5966  TextFieldKit & SetBorder(bool in_state);
5967 
5971  TextFieldKit & SetBorderColor(RGBColor const & in_color);
5972 
5976  TextFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5977 
5981  TextFieldKit & SetBorderStyle(Border::Style in_style);
5982 
5987  TextFieldKit & SetFillColor(RGBColor const & in_color);
5988 
5992  TextFieldKit & SetDefaultValue(char const * in_value);
5993 
5997  TextFieldKit & SetTextJustification(HPS::Text::Justification in_justification);
5998 
6002  TextFieldKit & SetMultiline(bool in_state);
6003 
6007  TextFieldKit & SetScrolling(bool in_state);
6008 
6012  TextFieldKit & SetReadOnly(bool in_state);
6013 
6014 
6017  TextFieldKit & UnsetName();
6018 
6021  TextFieldKit & UnsetFont();
6022 
6025  TextFieldKit & UnsetFontSize();
6026 
6029  TextFieldKit & UnsetTextColor();
6030 
6033  TextFieldKit & UnsetTooltip();
6034 
6037  TextFieldKit & UnsetVisibility();
6038 
6041  TextFieldKit & UnsetPrintability();
6042 
6045  TextFieldKit & UnsetTextRotation();
6046 
6049  TextFieldKit & UnsetLock();
6050 
6053  TextFieldKit & UnsetBorder();
6054 
6057  TextFieldKit & UnsetBorderColor();
6058 
6061  TextFieldKit & UnsetBorderThickness();
6062 
6065  TextFieldKit & UnsetBorderStyle();
6066 
6069  TextFieldKit & UnsetFillColor();
6070 
6073  TextFieldKit & UnsetDefaultValue();
6074 
6077  TextFieldKit & UnsetTextJustification();
6078 
6081  TextFieldKit & UnsetMultiline();
6082 
6085  TextFieldKit & UnsetScrolling();
6086 
6089  TextFieldKit & UnsetReadOnly();
6090 
6093  TextFieldKit & UnsetEverything();
6094 
6095 
6099  bool ShowName(UTF8 & out_name) const;
6100 
6107  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
6108 
6112  bool ShowFontSize(int & out_size) const;
6113 
6117  bool ShowTextColor(RGBColor & out_color) const;
6118 
6122  bool ShowTooltip(UTF8 & out_tooltip) const;
6123 
6127  bool ShowVisibility(bool & out_state) const;
6128 
6132  bool ShowPrintability(bool & out_state) const;
6133 
6137  bool ShowTextRotation(Text::Rotation & out_rotation) const;
6138 
6142  bool ShowLock(bool & out_state) const;
6143 
6147  bool ShowBorder(bool & out_state) const;
6148 
6152  bool ShowBorderColor(RGBColor & out_color) const;
6153 
6157  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
6158 
6162  bool ShowBorderStyle(Border::Style & out_style) const;
6163 
6167  bool ShowFillColor(RGBColor & out_color) const;
6168 
6172  bool ShowDefaultValue(UTF8 & out_value) const;
6173 
6177  bool ShowTextJustification(HPS::Text::Justification & out_justification) const;
6178 
6182  bool ShowMultiline(bool & out_state) const;
6183 
6187  bool ShowScrolling(bool & out_state) const;
6188 
6192  bool ShowReadOnly(bool & out_state) const;
6193  };
6194 
6196  class PUBLISH_API DocumentKey : public Sprocket
6197  {
6198  public:
6200  DocumentKey();
6201 
6204  DocumentKey(DocumentKey const & in_that);
6205 
6208  DocumentKey(DocumentKey && in_that);
6209 
6212  virtual ~DocumentKey();
6213 
6214  static const HPS::Type staticType = HPS::Type::PublishDocumentKey;
6215  HPS::Type ObjectType() const { return staticType; }
6216 
6220  DocumentKey & operator=(DocumentKey const & in_that);
6221 
6225  DocumentKey & operator=(DocumentKey && in_that);
6226 
6230  virtual void Assign(DocumentKey const & in_that);
6231 
6235  bool Equals(DocumentKey const & in_that) const;
6236 
6240  bool operator!=(DocumentKey const & in_that) const;
6241 
6245  bool operator==(DocumentKey const & in_that) const;
6246 
6250  void Delete();
6251 
6252 
6257  DocumentKey & AddPage(PageKit const & in_page);
6258 
6264  DocumentKey & AddPages(size_t in_count, PageKit const in_pages[]);
6265 
6270  DocumentKey & AddPages(PageKitArray const & in_pages);
6271 
6281  DocumentKey & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
6282 
6287  DocumentKey & SetPasswords(char const * in_user_password, char const * in_owner_password);
6288 
6294  DocumentKey & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
6295 
6302  DocumentKey & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
6303 
6309  DocumentKey & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6310 
6315  DocumentKey & AddAttachment(char const * in_filename, char const * in_description);
6316 
6322  DocumentKey & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
6323 
6328  DocumentKey & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
6329 
6334  DocumentKey & AddIconImage(char const * in_name, ImageKit const & in_image);
6335 
6341  DocumentKey & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
6342 
6347  DocumentKey & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
6348 
6353  DocumentKey & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
6354 
6358  DocumentKey & SetPermissions(PermissionTypeArray const & in_permissions);
6359 
6360 
6362  size_t GetPageCount() const;
6363 
6367  DocumentKey & RemovePage(size_t in_index);
6368 
6373  DocumentKey & RemovePages(size_t in_start, size_t in_count);
6374 
6379  DocumentKey & RemovePages(size_t in_count, size_t const in_indices[]);
6380 
6384  DocumentKey & RemovePages(SizeTArray const & in_indices);
6385 
6388  DocumentKey & RemoveAllPages();
6389 
6393  PageControl GetPageControl(size_t in_index);
6394 
6398  PageControl const GetPageControl(size_t in_index) const;
6399  };
6400 
6402  class PUBLISH_API PageControl : public Sprocket
6403  {
6404  public:
6406  PageControl();
6407 
6410  PageControl(PageControl const & in_that);
6411 
6414  PageControl(PageControl && in_that);
6415 
6416  virtual ~PageControl();
6417 
6418  static const HPS::Type staticType = HPS::Type::PublishPageControl;
6419  HPS::Type ObjectType() const { return staticType; }
6420 
6424  PageControl & operator=(PageControl const & in_that);
6425 
6429  PageControl & operator=(PageControl && in_kit);
6430 
6431 
6436  PageControl & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
6437 
6443  PageControl & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
6444 
6449  PageControl & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
6450 
6455  PageControl & AddText(TextKit const & in_text, IntRectangle const & in_location);
6456 
6462  PageControl & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
6463 
6468  PageControl & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
6469 
6474  PageControl & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
6475 
6481  PageControl & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
6482 
6487  PageControl & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
6488 
6493  PageControl & AddTable(TableKit const & in_table, IntRectangle const & in_location);
6494 
6500  PageControl & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
6501 
6506  PageControl & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
6507 
6512  PageControl & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
6513 
6519  PageControl & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
6520 
6525  PageControl & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
6526 
6531  PageControl & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
6532 
6538  PageControl & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
6539 
6544  PageControl & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
6545 
6550  PageControl & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
6551 
6557  PageControl & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
6558 
6563  PageControl & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
6564 
6569  PageControl & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
6570 
6576  PageControl & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
6577 
6582  PageControl & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
6583 
6588  PageControl & AddCheckBox(CheckBoxKit const & in_check_box, IntRectangle const & in_location);
6589 
6595  PageControl & AddCheckBoxes(size_t in_count, CheckBoxKit const in_check_boxes[], IntRectangle const in_locations[]);
6596 
6601  PageControl & AddCheckBoxes(CheckBoxKitArray const & in_check_boxes, IntRectangleArray const & in_locations);
6602 
6607  PageControl & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
6608 
6614  PageControl & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
6615 
6620  PageControl & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
6621 
6626  PageControl & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
6627 
6633  PageControl & AddListBoxes(size_t in_count, ListBoxKit const in_list_boxes[], IntRectangle const in_locations[]);
6634 
6639  PageControl & AddListBoxes(ListBoxKitArray const & in_list_boxes, IntRectangleArray const & in_locations);
6640 
6645  PageControl & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
6646 
6652  PageControl & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_lists[], IntRectangle const in_locations[]);
6653 
6658  PageControl & AddDropDownLists(DropDownListKitArray const & in_drop_down_lists, IntRectangleArray const & in_locations);
6659 
6664  PageControl & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
6665 
6671  PageControl & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_fields[], IntRectangle const in_locations[]);
6672 
6677  PageControl & AddSignatureFields(SignatureFieldKitArray const & in_signature_fields, IntRectangleArray const & in_locations);
6678 
6679 
6685  PageControl & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
6686 
6693  PageControl & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
6694 
6700  PageControl & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
6701 
6707  PageControl & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
6708 
6715  PageControl & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
6716 
6722  PageControl & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
6723 
6729  PageControl & SetButtonLabelByField(char const * in_field, char const * in_label);
6730 
6737  PageControl & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
6738 
6744  PageControl & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
6745 
6752  PageControl & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
6753 
6761  PageControl & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
6762 
6769  PageControl & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
6770 
6778  PageControl & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
6779 
6788  PageControl & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
6789 
6797  PageControl & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6798 
6804  PageControl & SetVisibilityByField(char const * in_field, bool in_state);
6805 
6812  PageControl & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
6813 
6819  PageControl & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
6820 
6826  PageControl & SetTextValueByField(char const * in_field, char const * in_value);
6827 
6834  PageControl & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
6835 
6841  PageControl & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
6842 
6843 
6849  bool ShowFields(UTF8Array & out_names, IntRectangleArray & out_locations, FieldTypeArray & out_types) const;
6850  };
6851 
6852 
6853  class ExportOptionsKit;
6854 
6856  class PUBLISH_API File
6857  {
6858  public:
6863  static DocumentKey CreateDocument(char const * in_file_name = nullptr);
6864 
6870  static void ExportPDF(CADModel const & in_cad_model, char const * in_file_name, ExportOptionsKit const & in_options);
6871 
6877  static void ExportPDF(KeyPathArray const & in_key_paths, char const * in_file_name, ExportOptionsKit const & in_options);
6878 
6885  static void ExportPDF(size_t in_count, KeyPath const in_key_paths[], char const * in_file_name, ExportOptionsKit const & in_options);
6886 
6892  static void ExportPDF(KeyPath const & in_key_path, char const * in_file_name, ExportOptionsKit const & in_options);
6893 
6901  static void ExportPDF(CADModel const & in_cad_model, KeyPathArray const & in_additional_key_paths, char const * in_file_name, ExportOptionsKit const & in_options);
6902 
6911  static void ExportPDF(CADModel const & in_cad_model, size_t in_count, KeyPath const in_additional_key_paths[], char const * in_file_name, ExportOptionsKit const & in_options);
6912 
6919  static void ExportPDF(AnnotationKit const & in_annotation, char const * in_file_name, ExportOptionsKit const & in_options);
6920 
6927  static void ExportPDF(DocumentKit const & in_document, char const * in_file_name, ExportOptionsKit const & in_options);
6928 
6933  static void ExportPDF(DocumentKey const & in_document, char const * in_file_name);
6934 
6935 
6944  static void ExportHTML(CADModel const & in_cad_model, char const * in_file_name, char const * in_template_name, bool in_include_measurement_information);
6945 
6953  static void ExportHTML(KeyPathArray const & in_key_paths, char const * in_file_name, char const * in_template_name);
6954 
6963  static void ExportHTML(size_t in_count, KeyPath const in_key_paths[], char const * in_file_name, char const * in_template_name);
6964 
6972  static void ExportHTML(KeyPath const & in_key_path, char const * in_file_name, char const * in_template_name);
6973 
6984  static void ExportHTML(CADModel const & in_cad_model, KeyPathArray const & in_additional_key_paths, char const * in_file_name, char const * in_template_name, bool in_include_measurement_information);
6985 
6997  static void ExportHTML(CADModel const & in_cad_model, size_t in_count, KeyPath const in_additional_key_paths[], char const * in_file_name, char const * in_template_name, bool in_include_measurement_information);
6998 
6999  private:
7001  File();
7002  };
7003 
7005  class PUBLISH_API ExportOptionsKit : public SprocketKit
7006  {
7007  public:
7009  ExportOptionsKit();
7010 
7013  ExportOptionsKit(ExportOptionsKit const & in_kit);
7014 
7018 
7019  virtual ~ExportOptionsKit();
7020 
7021  static const HPS::Type staticType = HPS::Type::PublishExportOptionsKit;
7022  HPS::Type ObjectType() const { return staticType; }
7023 
7026  void Set(ExportOptionsKit const & in_kit);
7027 
7030  void Show(ExportOptionsKit & out_kit) const;
7031 
7035  ExportOptionsKit & operator=(ExportOptionsKit const & in_kit);
7036 
7040  ExportOptionsKit & operator=(ExportOptionsKit && in_kit);
7041 
7044  bool Empty() const;
7045 
7049  bool Equals(ExportOptionsKit const & in_kit) const;
7050 
7054  bool operator==(ExportOptionsKit const & in_kit) const;
7055 
7059  bool operator!=(ExportOptionsKit const & in_kit) const;
7060 
7061 
7065  ExportOptionsKit & SetDocumentToAppendTo(char const * in_filename);
7066 
7067 
7070  ExportOptionsKit & UnsetDocumentToAppendTo();
7071 
7074  ExportOptionsKit & UnsetEverything();
7075 
7076 
7080  bool ShowDocumentToAppendTo(UTF8 & out_filename) const;
7081  };
7082 
7083 private:
7085  Publish();
7086 };
7087 
7088 }
7089 
7090 #endif
Mode
Definition: sprk_publish.h:285
Definition: hps.h:3488
Definition: hps.h:85
Definition: sprk_publish.h:3259
Definition: sprk_publish.h:2859
Mode
Definition: sprk_publish.h:457
Definition: sprk_publish.h:475
Preference
Definition: sprk_publish.h:497
Definition: sprk.h:67
Definition: sprk_publish.h:4599
HPS::Type ObjectType() const
Definition: sprk_publish.h:3980
Definition: sprk_publish.h:163
Orientation
Definition: sprk_publish.h:127
Definition: sprk_publish.h:314
Definition: sprk.h:242
std::vector< KeyPath, Allocator< KeyPath > > KeyPathArray
Array of type HPS::KeyPath.
Definition: hps.h:6815
HPS::Type ObjectType() const
Definition: sprk_publish.h:2876
Definition: sprk_publish.h:452
Format
Definition: sprk_publish.h:109
Definition: sprk_publish.h:182
Type
Definition: sprk_publish.h:319
std::vector< bool, Allocator< bool > > BoolArray
Array of type bool.
Definition: hps.h:6785
Definition: sprk_publish.h:5573
Mode
Definition: sprk_publish.h:258
Definition: sprk_publish.h:42
Definition: sprk_publish.h:3086
HPS::Type ObjectType() const
Definition: sprk_publish.h:5590
HPS::Type ObjectType() const
Definition: sprk_publish.h:6215
Type
Definition: sprk_publish.h:569
HPS::Type ObjectType() const
Definition: sprk_publish.h:4616
HPS::Type ObjectType() const
Definition: sprk_publish.h:956
Style
Definition: sprk_publish.h:204
HPS::Type ObjectType() const
Definition: sprk_publish.h:7022
Definition: sprk_publish.h:4295
Definition: sprk_publish.h:235
Definition: sprk_publish.h:566
Definition: sprk_publish.h:6856
Rotation
Definition: sprk_publish.h:378
Definition: sprk_publish.h:3684
Definition: sprk_publish.h:85
Position
Definition: sprk_publish.h:548
Definition: sprk_publish.h:392
Definition: sprk_publish.h:217
Definition: sprk_publish.h:5849
Definition: sprk_publish.h:4917
Type
Definition: sprk_publish.h:432
Definition: sprk_publish.h:492
Definition: sprk_publish.h:427
Definition: sprk_publish.h:104
BRepCompression
Definition: sprk_publish.h:168
HPS::Type ObjectType() const
Definition: sprk_publish.h:3529
Definition: sprk_publish.h:3963
Definition: hps.h:4546
Definition: hps.h:7228
std::vector< float, Allocator< float > > FloatArray
Array of type float.
Definition: hps.h:6776
Definition: sprk_publish.h:139
Definition: sprk_publish.h:598
Definition: sprk_publish.h:7005
Style
Definition: sprk_publish.h:345
HPS::Type ObjectType() const
Definition: sprk_publish.h:3103
Definition: sprk_publish.h:199
Definition: sprk_publish.h:280
HPS::Type ObjectType() const
Definition: sprk_publish.h:4312
Definition: sprk_publish.h:6402
Definition: sprk_publish.h:6196
Definition: sprk_publish.h:5231
Thickness
Definition: sprk_publish.h:519
Definition: sprk_publish.h:3399
Type
Definition: sprk_publish.h:90
std::vector< UTF8, Allocator< UTF8 > > UTF8Array
Array of type HPS::UTF8.
Definition: hps.h:6783
SourceType
Definition: sprk_publish.h:150
Definition: sprk_publish.h:543
Format
Definition: sprk_publish.h:144
Definition: sprk_publish.h:310
Preference
Definition: sprk_publish.h:480
HPS::Type ObjectType() const
Definition: sprk_publish.h:2298
HPS::Type ObjectType() const
Definition: sprk_publish.h:3701
Justification
Definition: hps.h:1619
Name
Definition: sprk_publish.h:327
HPS::Type ObjectType() const
Definition: sprk_publish.h:3276
HPS::Type ObjectType() const
Definition: sprk_publish.h:5248
Format
Definition: sprk_publish.h:397
Definition: sprk_publish.h:514
Definition: sprk_publish.h:253
HPS::Type ObjectType() const
Definition: sprk_publish.h:6419
Language
Definition: sprk_publish.h:360
Definition: sprk_publish.h:930
HPS::Type ObjectType() const
Definition: sprk_publish.h:4934
std::vector< IntRectangle, Allocator< IntRectangle > > IntRectangleArray
Array of type HPS::IntRectangle.
Definition: hps.h:6811
Definition: sprk_publish.h:471
When
Definition: sprk_publish.h:222
HPS::Type ObjectType() const
Definition: sprk_publish.h:3416
Style
Definition: sprk_publish.h:528
Definition: hps.h:9488
Definition: hps.h:11178
When
Definition: sprk_publish.h:240
Definition: sprk.h:3041
Definition: sprk_publish.h:2281
HPS::Type ObjectType() const
Definition: sprk_publish.h:615
HPS::Type ObjectType() const
Definition: sprk_publish.h:5866
Version
Definition: sprk_publish.h:187
Definition: sprk_publish.h:3512
std::vector< size_t, Allocator< size_t > > SizeTArray
Array of type size_t.
Definition: hps.h:6775
std::vector< ImageKit, Allocator< ImageKit > > ImageKitArray
Array of type HPS::ImageKit.
Definition: hps.h:6835