Overview

Sample Code

Programming Guide

API Reference

Support

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  All,
586  };
587 
588  private:
590  Permission();
591  };
592 
593  typedef std::vector<Permission::Type, HPS::Allocator<Permission::Type> > PermissionTypeArray;
594 
595 
597  class PUBLISH_API DocumentKit : public Sprocket
598  {
599  public:
601  DocumentKit();
602 
605  DocumentKit(DocumentKit const & in_kit);
606 
609  DocumentKit(DocumentKit && in_kit);
610 
611  virtual ~DocumentKit();
612 
613  HPS::Type ObjectType() const { return HPS::Type::PublishDocumentKit; }
614 
618  static DocumentKit GetDefault();
619 
622  void Set(DocumentKit const & in_kit);
623 
626  void Show(DocumentKit & out_kit) const;
627 
631  DocumentKit & operator=(DocumentKit const & in_kit);
632 
636  DocumentKit & operator=(DocumentKit && in_kit);
637 
640  bool Empty() const;
641 
645  bool Equals(DocumentKit const & in_kit) const;
646 
650  bool operator==(DocumentKit const & in_kit) const;
651 
655  bool operator!=(DocumentKit const & in_kit) const;
656 
657 
667  DocumentKit & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
668 
673  DocumentKit & SetPasswords(char const * in_user_password, char const * in_owner_password);
674 
680  DocumentKit & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
681 
688  DocumentKit & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
689 
695  DocumentKit & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
696 
701  DocumentKit & AddAttachment(char const * in_filename, char const * in_description);
702 
708  DocumentKit & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
709 
714  DocumentKit & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
715 
720  DocumentKit & AddIconImage(char const * in_name, ImageKit const & in_image);
721 
727  DocumentKit & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
728 
733  DocumentKit & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
734 
739  DocumentKit & SetPage(PageKit const & in_page);
740 
745  DocumentKit & AddPage(PageKit const & in_page);
746 
752  DocumentKit & SetPages(size_t in_count, PageKit const in_pages[]);
753 
758  DocumentKit & SetPages(PageKitArray const & in_pages);
759 
765  DocumentKit & AddPages(size_t in_count, PageKit const in_pages[]);
766 
771  DocumentKit & AddPages(PageKitArray const & in_pages);
772 
777  DocumentKit & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
778 
782  DocumentKit & SetPermissions(PermissionTypeArray const & in_permissions);
783 
784 
787  DocumentKit & UnsetInformation();
788 
791  DocumentKit & UnsetPasswords();
792 
796  DocumentKit & UnsetJavaScript(char const * in_script_name);
797 
802  DocumentKit & UnsetJavaScript(size_t in_count, UTF8 const in_script_names[]);
803 
807  DocumentKit & UnsetJavaScript(UTF8Array const & in_script_names);
808 
811  DocumentKit & UnsetJavaScript();
812 
816  DocumentKit & UnsetAttachment(char const * in_filename);
817 
822  DocumentKit & UnsetAttachments(size_t in_count, UTF8 const in_filenames[]);
823 
827  DocumentKit & UnsetAttachments(UTF8Array const & in_filenames);
828 
831  DocumentKit & UnsetAttachments();
832 
836  DocumentKit & UnsetIconImage(char const * in_name);
837 
842  DocumentKit & UnsetIconImages(size_t in_count, UTF8 const in_names[]);
843 
847  DocumentKit & UnsetIconImages(UTF8Array const & in_names);
848 
851  DocumentKit & UnsetIconImages();
852 
856  DocumentKit & UnsetPage(size_t in_index);
857 
862  DocumentKit & UnsetPages(size_t in_count, size_t const in_indices[]);
863 
867  DocumentKit & UnsetPages(SizeTArray const & in_indices);
868 
871  DocumentKit & UnsetPages();
872 
875  DocumentKit & UnsetPermissions();
876 
879  DocumentKit & UnsetEverything();
880 
881 
888  bool ShowInformation(UTF8 & out_title, UTF8 & out_author, UTF8 & out_subject, UTF8 & out_creator) const;
889 
894  bool ShowPasswords(UTF8 & out_user_password, UTF8 & out_owner_password) const;
895 
902  bool ShowJavaScript(UTF8Array & out_script_names, UTF8Array & out_sources, SourceTypeArray & out_types) const;
903 
908  bool ShowAttachments(UTF8Array & out_filenames, UTF8Array & out_descriptions) const;
909 
914  bool ShowIconImages(UTF8Array & out_names, ImageKitArray & out_images) const;
915 
919  bool ShowPages(PageKitArray & out_pages) const;
920 
924  bool ShowPermissions(PermissionTypeArray & out_permissions) const;
925  };
926 
928  class PUBLISH_API PageKit : public Sprocket
929  {
930  public:
932  PageKit();
933 
937  PageKit(Page::Format in_format, Page::Orientation in_orientation);
938 
941  PageKit(char const * in_filename);
942 
945  PageKit(PageKit const & in_kit);
946 
949  PageKit(PageKit && in_kit);
950 
951  virtual ~PageKit();
952 
953  HPS::Type ObjectType() const { return HPS::Type::PublishPageKit; }
954 
958  static PageKit GetDefault();
959 
962  void Set(PageKit const & in_kit);
963 
966  void Show(PageKit & out_kit) const;
967 
971  PageKit & operator=(PageKit const & in_kit);
972 
976  PageKit & operator=(PageKit && in_kit);
977 
980  bool Empty() const;
981 
985  bool Equals(PageKit const & in_kit) const;
986 
990  bool operator==(PageKit const & in_kit) const;
991 
995  bool operator!=(PageKit const & in_kit) const;
996 
997 
1002  PageKit & SetFormat(Page::Format in_format);
1003 
1008  PageKit & SetOrientation(Page::Orientation in_orientation);
1009 
1014  PageKit & SetAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
1015 
1020  PageKit & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
1021 
1027  PageKit & SetAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
1028 
1033  PageKit & SetAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
1034 
1040  PageKit & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
1041 
1046  PageKit & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
1047 
1052  PageKit & SetText(TextKit const & in_text, IntRectangle const & in_location);
1053 
1058  PageKit & AddText(TextKit const & in_text, IntRectangle const & in_location);
1059 
1065  PageKit & SetText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
1066 
1071  PageKit & SetText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
1072 
1078  PageKit & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
1079 
1084  PageKit & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
1085 
1090  PageKit & SetImage(ImageKit const & in_image, IntRectangle const & in_location);
1091 
1096  PageKit & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
1097 
1103  PageKit & SetImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
1104 
1109  PageKit & SetImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
1110 
1116  PageKit & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
1117 
1122  PageKit & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
1123 
1128  PageKit & SetTable(TableKit const & in_table, IntRectangle const & in_location);
1129 
1134  PageKit & AddTable(TableKit const & in_table, IntRectangle const & in_location);
1135 
1141  PageKit & SetTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
1142 
1147  PageKit & SetTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
1148 
1154  PageKit & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
1155 
1160  PageKit & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
1161 
1166  PageKit & SetLink(LinkKit const & in_link, IntRectangle const & in_location);
1167 
1172  PageKit & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
1173 
1179  PageKit & SetLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
1180 
1185  PageKit & SetLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
1186 
1192  PageKit & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
1193 
1198  PageKit & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
1199 
1204  PageKit & SetButton(ButtonKit const & in_button, IntRectangle const & in_location);
1205 
1210  PageKit & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
1211 
1217  PageKit & SetButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
1218 
1223  PageKit & SetButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
1224 
1230  PageKit & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
1231 
1236  PageKit & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
1237 
1242  PageKit & SetTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
1243 
1248  PageKit & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
1249 
1255  PageKit & SetTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
1256 
1261  PageKit & SetTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
1262 
1268  PageKit & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
1269 
1274  PageKit & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
1275 
1280  PageKit & SetSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
1281 
1286  PageKit & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
1287 
1293  PageKit & SetSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
1294 
1299  PageKit & SetSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
1300 
1306  PageKit & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
1307 
1312  PageKit & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
1313 
1318  PageKit & SetCheckBox(CheckBoxKit const & in_checkbox, IntRectangle const & in_location);
1319 
1324  PageKit & AddCheckBox(CheckBoxKit const & in_checkbox, IntRectangle const & in_location);
1325 
1331  PageKit & SetCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]);
1332 
1337  PageKit & SetCheckBoxes(CheckBoxKitArray const & in_checkbox, IntRectangleArray const & in_locations);
1338 
1344  PageKit & AddCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]);
1345 
1350  PageKit & AddCheckBoxes(CheckBoxKitArray const & in_checkbox, IntRectangleArray const & in_locations);
1351 
1356  PageKit & SetRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
1357 
1362  PageKit & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
1363 
1369  PageKit & SetRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
1370 
1375  PageKit & SetRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
1376 
1382  PageKit & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
1383 
1388  PageKit & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
1389 
1394  PageKit & SetListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
1395 
1400  PageKit & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
1401 
1407  PageKit & SetListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]);
1408 
1413  PageKit & SetListBoxes(ListBoxKitArray const & in_list_box, IntRectangleArray const & in_locations);
1414 
1420  PageKit & AddListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]);
1421 
1426  PageKit & AddListBoxes(ListBoxKitArray const & in_list_box, IntRectangleArray const & in_locations);
1427 
1432  PageKit & SetDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
1433 
1438  PageKit & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
1439 
1445  PageKit & SetDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]);
1446 
1451  PageKit & SetDropDownLists(DropDownListKitArray const & in_drop_down_list, IntRectangleArray const & in_locations);
1452 
1458  PageKit & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]);
1459 
1464  PageKit & AddDropDownLists(DropDownListKitArray const & in_drop_down_list, IntRectangleArray const & in_locations);
1465 
1470  PageKit & SetSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
1471 
1476  PageKit & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
1477 
1483  PageKit & SetSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]);
1484 
1489  PageKit & SetSignatureFields(SignatureFieldKitArray const & in_signature_field, IntRectangleArray const & in_locations);
1490 
1496  PageKit & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]);
1497 
1502  PageKit & AddSignatureFields(SignatureFieldKitArray const & in_signature_field, IntRectangleArray const & in_locations);
1503 
1507  PageKit & SetTemplateFile(char const * in_filename);
1508 
1514  PageKit & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
1515 
1522  PageKit & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
1523 
1529  PageKit & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
1530 
1536  PageKit & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
1537 
1544  PageKit & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
1545 
1551  PageKit & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
1552 
1558  PageKit & SetButtonLabelByField(char const * in_field, char const * in_label);
1559 
1566  PageKit & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
1567 
1573  PageKit & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
1574 
1581  PageKit & SetListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
1582 
1589  PageKit & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
1590 
1598  PageKit & SetListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
1599 
1606  PageKit & SetListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
1607 
1615  PageKit & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
1616 
1623  PageKit & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
1624 
1632  PageKit & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
1633 
1642  PageKit & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
1643 
1651  PageKit & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
1652 
1658  PageKit & SetVisibilityByField(char const * in_field, bool in_state);
1659 
1666  PageKit & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
1667 
1673  PageKit & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
1674 
1680  PageKit & SetTextValueByField(char const * in_field, char const * in_value);
1681 
1688  PageKit & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
1689 
1695  PageKit & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
1696 
1697 
1700  PageKit & UnsetFormat();
1701 
1704  PageKit & UnsetOrientation();
1705 
1709  PageKit & UnsetAnnotation(size_t in_index);
1710 
1715  PageKit & UnsetAnnotations(size_t in_count, size_t const in_indices[]);
1716 
1720  PageKit & UnsetAnnotations(SizeTArray const & in_indices);
1721 
1724  PageKit & UnsetAnnotations();
1725 
1729  PageKit & UnsetText(size_t in_index);
1730 
1735  PageKit & UnsetText(size_t in_count, size_t const in_indices[]);
1736 
1740  PageKit & UnsetText(SizeTArray const & in_indices);
1741 
1744  PageKit & UnsetText();
1745 
1749  PageKit & UnsetCheckBox(size_t in_index);
1750 
1755  PageKit & UnsetCheckBoxes(size_t in_count, size_t const in_indices[]);
1756 
1760  PageKit & UnsetCheckBoxes(SizeTArray const & in_indices);
1761 
1764  PageKit & UnsetCheckBoxes();
1765 
1769  PageKit & UnsetRadioButton(size_t in_index);
1770 
1775  PageKit & UnsetRadioButtons(size_t in_count, size_t const in_indices[]);
1776 
1780  PageKit & UnsetRadioButtons(SizeTArray const & in_indices);
1781 
1784  PageKit & UnsetRadioButtons();
1785 
1789  PageKit & UnsetListBox(size_t in_index);
1790 
1795  PageKit & UnsetListBoxes(size_t in_count, size_t const in_indices[]);
1796 
1800  PageKit & UnsetListBoxes(SizeTArray const & in_indices);
1801 
1804  PageKit & UnsetListBoxes();
1805 
1809  PageKit & UnsetDropDownList(size_t in_index);
1810 
1815  PageKit & UnsetDropDownLists(size_t in_count, size_t const in_indices[]);
1816 
1820  PageKit & UnsetDropDownLists(SizeTArray const & in_indices);
1821 
1824  PageKit & UnsetDropDownLists();
1825 
1829  PageKit & UnsetSignatureField(size_t in_index);
1830 
1835  PageKit & UnsetSignatureFields(size_t in_count, size_t const in_indices[]);
1836 
1840  PageKit & UnsetSignatureFields(SizeTArray const & in_indices);
1841 
1844  PageKit & UnsetSignatureFields();
1845 
1849  PageKit & UnsetImage(size_t in_index);
1850 
1855  PageKit & UnsetImages(size_t in_count, size_t const in_indices[]);
1856 
1860  PageKit & UnsetImages(SizeTArray const & in_indices);
1861 
1864  PageKit & UnsetImages();
1865 
1869  PageKit & UnsetTable(size_t in_index);
1870 
1875  PageKit & UnsetTables(size_t in_count, size_t const in_indices[]);
1876 
1880  PageKit & UnsetTables(SizeTArray const & in_indices);
1881 
1884  PageKit & UnsetTables();
1885 
1889  PageKit & UnsetLink(size_t in_index);
1890 
1895  PageKit & UnsetLinks(size_t in_count, size_t const in_indices[]);
1896 
1900  PageKit & UnsetLinks(SizeTArray const & in_indices);
1901 
1904  PageKit & UnsetLinks();
1905 
1909  PageKit & UnsetButton(size_t in_index);
1910 
1915  PageKit & UnsetButtons(size_t in_count, size_t const in_indices[]);
1916 
1920  PageKit & UnsetButtons(SizeTArray const & in_indices);
1921 
1924  PageKit & UnsetButtons();
1925 
1929  PageKit & UnsetTextField(size_t in_index);
1930 
1935  PageKit & UnsetTextFields(size_t in_count, size_t const in_indices[]);
1936 
1940  PageKit & UnsetTextFields(SizeTArray const & in_indices);
1941 
1944  PageKit & UnsetTextFields();
1945 
1949  PageKit & UnsetSlideTable(size_t in_index);
1950 
1955  PageKit & UnsetSlideTables(size_t in_count, size_t const in_indices[]);
1956 
1960  PageKit & UnsetSlideTables(SizeTArray const & in_indices);
1961 
1964  PageKit & UnsetSlideTables();
1965 
1968  PageKit & UnsetTemplateFile();
1969 
1973  PageKit & UnsetAnnotationByField(char const * in_field);
1974 
1979  PageKit & UnsetAnnotationsByField(size_t in_count, UTF8 const in_fields[]);
1980 
1984  PageKit & UnsetAnnotationsByField(UTF8Array const & in_fields);
1985 
1988  PageKit & UnsetAnnotationsByField();
1989 
1993  PageKit & UnsetButtonIconByField(char const * in_field);
1994 
1999  PageKit & UnsetButtonIconsByField(size_t in_count, UTF8 const in_fields[]);
2000 
2004  PageKit & UnsetButtonIconsByField(UTF8Array const & in_fields);
2005 
2008  PageKit & UnsetButtonIconsByField();
2009 
2013  PageKit & UnsetButtonLabelByField(char const * in_field);
2014 
2019  PageKit & UnsetButtonLabelsByField(size_t in_count, UTF8 const in_fields[]);
2020 
2024  PageKit & UnsetButtonLabelsByField(UTF8Array const & in_fields);
2025 
2028  PageKit & UnsetButtonLabelsByField();
2029 
2034  PageKit & UnsetListItemByField(char const * in_field, size_t in_index);
2035 
2041  PageKit & UnsetListItemsByField(char const * in_field, size_t in_count, size_t const in_indices[]);
2042 
2047  PageKit & UnsetListItemsByField(char const * in_field, SizeTArray const & in_indices);
2048 
2052  PageKit & UnsetListItemsByField(char const * in_field);
2053 
2058  PageKit & UnsetListItemsByField(size_t in_count, UTF8 const in_fields[]);
2059 
2063  PageKit & UnsetListItemsByField(UTF8Array const & in_fields);
2064 
2067  PageKit & UnsetListItemsByField();
2068 
2072  PageKit & UnsetJavaScriptActionByField(char const * in_field);
2073 
2078  PageKit & UnsetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[]);
2079 
2083  PageKit & UnsetJavaScriptActionsByField(UTF8Array const & in_fields);
2084 
2087  PageKit & UnsetJavaScriptActionsByField();
2088 
2092  PageKit & UnsetVisibilityByField(char const * in_field);
2093 
2098  PageKit & UnsetVisibilitiesByField(size_t in_count, UTF8 const in_fields[]);
2099 
2103  PageKit & UnsetVisibilitiesByField(UTF8Array const & in_fields);
2104 
2107  PageKit & UnsetVisibilitiesByField();
2108 
2112  PageKit & UnsetTextValueByField(char const * in_field);
2113 
2118  PageKit & UnsetTextValuesByField(size_t in_count, UTF8 const in_fields[]);
2119 
2123  PageKit & UnsetTextValuesByField(UTF8Array const & in_fields);
2124 
2127  PageKit & UnsetTextValuesByField();
2128 
2131  PageKit & UnsetEverything();
2132 
2133 
2137  bool ShowFormat(Page::Format & out_format) const;
2138 
2142  bool ShowOrientation(Page::Orientation & out_orientation) const;
2143 
2148  bool ShowAnnotations(AnnotationKitArray & out_annotations, IntRectangleArray & out_locations) const;
2149 
2154  bool ShowText(TextKitArray & out_text, IntRectangleArray & out_locations) const;
2155 
2160  bool ShowImages(ImageKitArray & out_images, IntRectangleArray & out_locations) const;
2161 
2166  bool ShowTables(TableKitArray & out_tables, IntRectangleArray & out_locations) const;
2167 
2172  bool ShowLinks(LinkKitArray & out_links, IntRectangleArray & out_locations) const;
2173 
2178  bool ShowButtons(ButtonKitArray & out_buttons, IntRectangleArray & out_locations) const;
2179 
2184  bool ShowCheckBoxes(CheckBoxKitArray & out_check_boxes, IntRectangleArray & out_locations) const;
2185 
2190  bool ShowRadioButtons(RadioButtonKitArray & out_radio_buttons, IntRectangleArray & out_locations) const;
2191 
2196  bool ShowListBoxes(ListBoxKitArray & out_list_boxes, IntRectangleArray & out_locations) const;
2197 
2202  bool ShowDropDownLists(DropDownListKitArray & out_drop_down_lists, IntRectangleArray & out_locations) const;
2203 
2208  bool ShowSignatureFields(SignatureFieldKitArray & out_signature_fields, IntRectangleArray & out_locations) const;
2209 
2214  bool ShowTextFields(TextFieldKitArray & out_text_fields, IntRectangleArray & out_locations) const;
2215 
2220  bool ShowSlideTables(SlideTableKitArray & out_slide_tables, IntRectangleArray & out_locations) const;
2221 
2225  bool ShowTemplateFile(UTF8 & out_filename) const;
2226 
2231  bool ShowAnnotationsByField(UTF8Array & out_fields, AnnotationKitArray & out_annotations) const;
2232 
2237  bool ShowButtonIconsByField(UTF8Array & out_fields, ImageKitArray & out_images) const;
2238 
2243  bool ShowButtonLabelsByField(UTF8Array & out_fields, UTF8Array & out_labels) const;
2244 
2248  bool ShowListItemFields(UTF8Array & out_fields) const;
2249 
2255  bool ShowListItemsByField(char const * in_field, UTF8Array & out_values, UTF8Array & out_export_values) const;
2256 
2262  bool ShowJavaScriptActionsByField(UTF8Array & out_fields, UTF8Array & out_sources, SourceTypeArray & out_types) const;
2263 
2268  bool ShowVisibilitiesByField(UTF8Array & out_fields, BoolArray & out_states) const;
2269 
2274  bool ShowTextValuesByField(UTF8Array & out_fields, UTF8Array & out_values) const;
2275  };
2276 
2278  class PUBLISH_API AnnotationKit : public Sprocket
2279  {
2280  public:
2282  AnnotationKit();
2283 
2286  AnnotationKit(AnnotationKit const & in_kit);
2287 
2290  AnnotationKit(AnnotationKit && in_kit);
2291 
2292  virtual ~AnnotationKit();
2293 
2294  HPS::Type ObjectType() const { return HPS::Type::PublishAnnotationKit; }
2295 
2299  static AnnotationKit GetDefault();
2300 
2303  void Set(AnnotationKit const & in_kit);
2304 
2307  void Show(AnnotationKit & out_kit) const;
2308 
2312  AnnotationKit & operator=(AnnotationKit const & in_kit);
2313 
2317  AnnotationKit & operator=(AnnotationKit && in_kit);
2318 
2321  bool Empty() const;
2322 
2326  bool Equals(AnnotationKit const & in_kit) const;
2327 
2331  bool operator==(AnnotationKit const & in_kit) const;
2332 
2336  bool operator!=(AnnotationKit const & in_kit) const;
2337 
2338 
2343  AnnotationKit & SetSource(CADModel const & in_cad_model);
2344 
2349  AnnotationKit & SetSource(KeyPathArray const & in_sources);
2350 
2356  AnnotationKit & SetSource(size_t in_count, KeyPath const in_sources[]);
2357 
2362  AnnotationKit & SetSource(KeyPath const & in_source);
2363 
2370  AnnotationKit & SetSource(CADModel const & in_cad_model, KeyPathArray const & in_additional_sources);
2371 
2379  AnnotationKit & SetSource(CADModel const & in_cad_model, size_t in_count, KeyPath const in_additional_sources []);
2380 
2384  AnnotationKit & SetFormat(Annotation::Format in_format);
2385 
2390  AnnotationKit & SetPRCTessellationCompression(bool in_state);
2391 
2396  AnnotationKit & SetPRCBRepCompression(PRC::BRepCompression in_level);
2397 
2402  AnnotationKit & SetPRCBRepRemoval(bool in_state);
2403 
2408  AnnotationKit & SetPRCAttributeRemoval(bool in_state);
2409 
2414  AnnotationKit & SetU3DVersion(U3D::Version in_version);
2415 
2420  AnnotationKit & SetU3DCompression(unsigned char in_level);
2421 
2425  AnnotationKit & SetName(char const * in_name);
2426 
2430  AnnotationKit & SetArtwork(ArtworkKit const & in_artwork);
2431 
2435  AnnotationKit & SetActivation(Activation::When in_when);
2436 
2440  AnnotationKit & SetDeactivation(Deactivation::When in_when);
2441 
2445  AnnotationKit & SetToolbarVisibility(bool in_state);
2446 
2450  AnnotationKit & SetModelTreeVisibility(bool in_state);
2451 
2455  AnnotationKit & SetInteractivity(bool in_state);
2456 
2460  AnnotationKit & SetBorderWidth(int in_width);
2461 
2466  AnnotationKit & SetTransparentBackground(bool in_state);
2467 
2471  AnnotationKit & SetBackgroundColor(RGBColor const & in_color);
2472 
2476  AnnotationKit & SetLighting(Lighting::Mode in_mode);
2477 
2481  AnnotationKit & SetRendering(Rendering::Mode in_mode);
2482 
2486  AnnotationKit & SetPosterImage(ImageKit const & in_image);
2487 
2495  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);
2496 
2503  AnnotationKit & SetCarouselButtons(UTF8Array const & in_button_names, char const * in_previous_button_name, char const * in_next_button_name, size_t in_scroll_size);
2504 
2512  AnnotationKit & SetCarouselViews(size_t in_count, size_t const in_indices[], ImageKit const in_images[] = nullptr);
2513 
2520  AnnotationKit & SetCarouselViews(SizeTArray const & in_indices, ImageKitArray const & in_images = ImageKitArray());
2521 
2522 
2525  AnnotationKit & UnsetSource();
2526 
2529  AnnotationKit & UnsetFormat();
2530 
2533  AnnotationKit & UnsetPRCTessellationCompression();
2534 
2537  AnnotationKit & UnsetPRCBRepCompression();
2538 
2541  AnnotationKit & UnsetPRCBRepRemoval();
2542 
2545  AnnotationKit & UnsetPRCAttributeRemoval();
2546 
2549  AnnotationKit & UnsetU3DVersion();
2550 
2553  AnnotationKit & UnsetU3DCompression();
2554 
2557  AnnotationKit & UnsetName();
2558 
2561  AnnotationKit & UnsetArtwork();
2562 
2565  AnnotationKit & UnsetActivation();
2566 
2569  AnnotationKit & UnsetDeactivation();
2570 
2573  AnnotationKit & UnsetToolbarVisibility();
2574 
2577  AnnotationKit & UnsetModelTreeVisibility();
2578 
2581  AnnotationKit & UnsetInteractivity();
2582 
2585  AnnotationKit & UnsetBorderWidth();
2586 
2589  AnnotationKit & UnsetTransparentBackground();
2590 
2593  AnnotationKit & UnsetBackgroundColor();
2594 
2597  AnnotationKit & UnsetLighting();
2598 
2601  AnnotationKit & UnsetRendering();
2602 
2605  AnnotationKit & UnsetPosterImage();
2606 
2609  AnnotationKit & UnsetCarouselButtons();
2610 
2613  AnnotationKit & UnsetCarouselViews();
2614 
2617  AnnotationKit & UnsetEverything();
2618 
2619 
2625  bool ShowSource(Annotation::SourceType & out_source_type, CADModel & out_cad_model, KeyPathArray & out_key_paths) const;
2626 
2630  bool ShowFormat(Annotation::Format & out_format) const;
2631 
2635  bool ShowPRCTessellationCompression(bool & out_state) const;
2636 
2640  bool ShowPRCBRepCompression(PRC::BRepCompression & out_level) const;
2641 
2645  bool ShowPRCBRepRemoval(bool & out_state) const;
2646 
2650  bool ShowPRCAttributeRemoval(bool & out_state) const;
2651 
2655  bool ShowU3DVersion(U3D::Version & out_version) const;
2656 
2660  bool ShowU3DCompression(unsigned char & out_level) const;
2661 
2665  bool ShowName(UTF8 & out_name) const;
2666 
2670  bool ShowArtwork(ArtworkKit & out_artwork) const;
2671 
2675  bool ShowActivation(Activation::When & out_when) const;
2676 
2680  bool ShowDeactivation(Deactivation::When & out_when) const;
2681 
2685  bool ShowToolbarVisibility(bool & out_state) const;
2686 
2690  bool ShowModelTreeVisibility(bool & out_state) const;
2691 
2695  bool ShowInteractivity(bool & out_state) const;
2696 
2700  bool ShowBorderWidth(int & out_width) const;
2701 
2705  bool ShowTransparentBackground(bool & out_state) const;
2706 
2710  bool ShowBackgroundColor(RGBColor & out_color) const;
2711 
2715  bool ShowLighting(Lighting::Mode & out_mode) const;
2716 
2720  bool ShowRendering(Rendering::Mode & out_mode) const;
2721 
2725  bool ShowPosterImage(ImageKit & out_image) const;
2726 
2733  bool ShowCarouselButtons(UTF8Array & out_button_names, UTF8 & out_previous_button_name, UTF8 & out_next_button_name, size_t & out_scroll_size) const;
2734 
2739  bool ShowCarouselViews(SizeTArray & out_indices, ImageKitArray & out_images) const;
2740  };
2741 
2743  class PUBLISH_API ArtworkKit : public Sprocket
2744  {
2745  public:
2747  ArtworkKit();
2748 
2751  ArtworkKit(ArtworkKit const & in_kit);
2752 
2755  ArtworkKit(ArtworkKit && in_kit);
2756 
2757  virtual ~ArtworkKit();
2758 
2759  HPS::Type ObjectType() const { return HPS::Type::PublishArtworkKit; }
2760 
2764  static ArtworkKit GetDefault();
2765 
2768  void Set(ArtworkKit const & in_kit);
2769 
2772  void Show(ArtworkKit & out_kit) const;
2773 
2777  ArtworkKit & operator=(ArtworkKit const & in_kit);
2778 
2782  ArtworkKit & operator=(ArtworkKit && in_kit);
2783 
2786  bool Empty() const;
2787 
2791  bool Equals(ArtworkKit const & in_kit) const;
2792 
2796  bool operator==(ArtworkKit const & in_kit) const;
2797 
2801  bool operator!=(ArtworkKit const & in_kit) const;
2802 
2803 
2807  ArtworkKit & SetAnimationStyle(Animation::Style in_style);
2808 
2813  ArtworkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
2814 
2818  ArtworkKit & SetPMICrossHighlighting(bool in_state);
2819 
2823  ArtworkKit & SetPMISemanticInformation(bool in_state);
2824 
2828  ArtworkKit & SetDefaultViewPreference(Artwork::View::Preference in_preference);
2829 
2833  ArtworkKit & SetDisplayPreference(Artwork::Display::Preference in_preference);
2834 
2838  ArtworkKit & SetView(ViewKit const & in_view);
2839 
2843  ArtworkKit & AddView(ViewKit const & in_view);
2844 
2849  ArtworkKit & SetViews(size_t in_count, ViewKit const in_views[]);
2850 
2854  ArtworkKit & SetViews(ViewKitArray const & in_views);
2855 
2860  ArtworkKit & AddViews(size_t in_count, ViewKit const in_views[]);
2861 
2865  ArtworkKit & AddViews(ViewKitArray const & in_views);
2866 
2870  ArtworkKit & SetPMIColor(HPS::RGBColor const & in_pmi_color);
2871 
2872 
2875  ArtworkKit & UnsetAnimationStyle();
2876 
2879  ArtworkKit & UnsetJavaScript();
2880 
2883  ArtworkKit & UnsetPMICrossHighlighting();
2884 
2887  ArtworkKit & UnsetPMISemanticInformation();
2888 
2891  ArtworkKit & UnsetDefaultViewPreference();
2892 
2895  ArtworkKit & UnsetDisplayPreference();
2896 
2900  ArtworkKit & UnsetView(size_t in_index);
2901 
2906  ArtworkKit & UnsetViews(size_t in_count, size_t const in_indices[]);
2907 
2911  ArtworkKit & UnsetViews(SizeTArray const & in_indices);
2912 
2915  ArtworkKit & UnsetViews();
2916 
2919  ArtworkKit & UnsetPMIColor();
2920 
2923  ArtworkKit & UnsetEverything();
2924 
2925 
2929  bool ShowAnimationStyle(Animation::Style & out_style) const;
2930 
2935  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
2936 
2940  bool ShowPMICrossHighlighting(bool & out_state) const;
2941 
2945  bool ShowPMISemanticInformation(bool & out_state) const;
2946 
2950  bool ShowDefaultViewPreference(Artwork::View::Preference & out_preference) const;
2951 
2955  bool ShowDisplayPreference(Artwork::Display::Preference & out_preference) const;
2956 
2960  bool ShowViews(ViewKitArray & out_views) const;
2961 
2965  bool ShowPMIColor(HPS::RGBColor & out_pmi_color) const;
2966  };
2967 
2969  class PUBLISH_API ViewKit : public Sprocket
2970  {
2971  public:
2973  ViewKit();
2974 
2977  ViewKit(ViewKit const & in_kit);
2978 
2981  ViewKit(ViewKit && in_kit);
2982 
2983  virtual ~ViewKit();
2984 
2985  HPS::Type ObjectType() const { return HPS::Type::PublishViewKit; }
2986 
2990  static ViewKit GetDefault();
2991 
2994  void Set(ViewKit const & in_kit);
2995 
2998  void Show(ViewKit & out_kit) const;
2999 
3003  ViewKit & operator=(ViewKit const & in_kit);
3004 
3008  ViewKit & operator=(ViewKit && in_kit);
3009 
3012  bool Empty() const;
3013 
3017  bool Equals(ViewKit const & in_kit) const;
3018 
3022  bool operator==(ViewKit const & in_kit) const;
3023 
3027  bool operator!=(ViewKit const & in_kit) const;
3028 
3029 
3033  ViewKit & SetInternalName(char const * in_name);
3034 
3038  ViewKit & SetExternalName(char const * in_name);
3039 
3048  ViewKit & SetCamera(CameraKit const & in_camera);
3049 
3053  ViewKit & SetDefault(bool in_state);
3054 
3058  ViewKit & SetBackgroundColor(RGBColor const & in_color);
3059 
3063  ViewKit & SetLighting(Lighting::Mode in_mode);
3064 
3068  ViewKit & SetRendering(Rendering::Mode in_mode);
3069 
3070 
3073  ViewKit & UnsetInternalName();
3074 
3077  ViewKit & UnsetExternalName();
3078 
3081  ViewKit & UnsetCamera();
3082 
3085  ViewKit & UnsetDefault();
3086 
3089  ViewKit & UnsetBackgroundColor();
3090 
3093  ViewKit & UnsetLighting();
3094 
3097  ViewKit & UnsetRendering();
3098 
3101  ViewKit & UnsetEverything();
3102 
3103 
3107  bool ShowInternalName(UTF8 & out_name) const;
3108 
3112  bool ShowExternalName(UTF8 & out_name) const;
3113 
3117  bool ShowCamera(CameraKit & out_camera) const;
3118 
3122  bool ShowDefault(bool & out_state) const;
3123 
3127  bool ShowBackgroundColor(RGBColor & out_color) const;
3128 
3132  bool ShowLighting(Lighting::Mode & out_mode) const;
3133 
3137  bool ShowRendering(Rendering::Mode & out_mode) const;
3138  };
3139 
3141  class PUBLISH_API TextKit : public Sprocket
3142  {
3143  public:
3145  TextKit();
3146 
3149  TextKit(TextKit const & in_kit);
3150 
3153  TextKit(TextKit && in_kit);
3154 
3155  virtual ~TextKit();
3156 
3157  HPS::Type ObjectType() const { return HPS::Type::PublishTextKit; }
3158 
3162  static TextKit GetDefault();
3163 
3166  void Set(TextKit const & in_kit);
3167 
3170  void Show(TextKit & out_kit) const;
3171 
3175  TextKit & operator=(TextKit const & in_kit);
3176 
3180  TextKit & operator=(TextKit && in_kit);
3181 
3184  bool Empty() const;
3185 
3189  bool Equals(TextKit const & in_kit) const;
3190 
3194  bool operator==(TextKit const & in_kit) const;
3195 
3199  bool operator!=(TextKit const & in_kit) const;
3200 
3201 
3206  TextKit & SetText(char const * in_text);
3207 
3211  TextKit & SetFont(Text::Font::Name in_font);
3212 
3218  TextKit & SetFont(char const * in_font_name, Text::Language in_language, bool in_embed_font);
3219 
3224  TextKit & SetSize(int in_size);
3225 
3230  TextKit & SetColor(RGBColor const & in_color);
3231 
3232 
3235  TextKit & UnsetText();
3236 
3239  TextKit & UnsetFont();
3240 
3243  TextKit & UnsetSize();
3244 
3247  TextKit & UnsetColor();
3248 
3251  TextKit & UnsetEverything();
3252 
3253 
3257  bool ShowText(UTF8 & out_text) const;
3258 
3266  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;
3267 
3271  bool ShowSize(int & out_size) const;
3272 
3276  bool ShowColor(RGBColor & out_color) const;
3277  };
3278 
3280  class PUBLISH_API ImageKit : public Sprocket
3281  {
3282  public:
3284  ImageKit();
3285 
3288  ImageKit(ImageKit const & in_kit);
3289 
3292  ImageKit(ImageKit && in_kit);
3293 
3294  virtual ~ImageKit();
3295 
3296  HPS::Type ObjectType() const { return HPS::Type::PublishImageKit; }
3297 
3298  // no GetDefault() since function doesn't make sense for this class
3299 
3302  void Set(ImageKit const & in_kit);
3303 
3306  void Show(ImageKit & out_kit) const;
3307 
3311  ImageKit & operator=(ImageKit const & in_kit);
3312 
3316  ImageKit & operator=(ImageKit && in_kit);
3317 
3320  bool Empty() const;
3321 
3325  bool Equals(ImageKit const & in_kit) const;
3326 
3330  bool operator==(ImageKit const & in_kit) const;
3331 
3335  bool operator!=(ImageKit const & in_kit) const;
3336 
3337 
3341  ImageKit & SetFile(char const * in_filename);
3342 
3348  ImageKit & SetSize(int in_width, int in_height);
3349 
3353  ImageKit & SetFormat(Image::Format in_format);
3354 
3355 
3358  ImageKit & UnsetFile();
3359 
3362  ImageKit & UnsetSize();
3363 
3366  ImageKit & UnsetFormat();
3367 
3370  ImageKit & UnsetEverything();
3371 
3372 
3376  bool ShowFile(UTF8 & out_filename) const;
3377 
3382  bool ShowSize(int & out_width, int & out_height) const;
3383 
3387  bool ShowFormat(Image::Format & out_format) const;
3388  };
3389 
3392  class PUBLISH_API TableKit : public Sprocket
3393  {
3394  public:
3396  TableKit();
3397 
3400  TableKit(TableKit const & in_kit);
3401 
3404  TableKit(TableKit && in_kit);
3405 
3406  virtual ~TableKit();
3407 
3408  HPS::Type ObjectType() const { return HPS::Type::PublishTableKit; }
3409 
3410  // no GetDefault() since function doesn't make sense for this class
3411 
3414  void Set(TableKit const & in_kit);
3415 
3418  void Show(TableKit & out_kit) const;
3419 
3423  TableKit & operator=(TableKit const & in_kit);
3424 
3428  TableKit & operator=(TableKit && in_kit);
3429 
3432  bool Empty() const;
3433 
3437  bool Equals(TableKit const & in_kit) const;
3438 
3442  bool operator==(TableKit const & in_kit) const;
3443 
3447  bool operator!=(TableKit const & in_kit) const;
3448 
3449 
3454  TableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3455 
3460  TableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3461 
3467  TableKit & SetLink(int in_row, int in_column, LinkKit const & in_link);
3468 
3474  TableKit & SetText(int in_row, int in_column, TextKit const & in_text);
3475 
3481  TableKit & SetButton(int in_row, int in_column, ButtonKit const & in_button);
3482 
3488  TableKit & SetTextField(int in_row, int in_column, TextFieldKit const & in_text_field);
3489 
3490 
3493  TableKit & UnsetHTML();
3494 
3497  TableKit & UnsetHTMLStyle();
3498 
3501  TableKit & UnsetLink(int in_row, int in_column);
3502 
3505  TableKit & UnsetText(int in_row, int in_column);
3506 
3509  TableKit & UnsetButton(int in_row, int in_column);
3510 
3513  TableKit & UnsetTextField(int in_row, int in_column);
3514 
3517  TableKit & UnsetEverything();
3518 
3519 
3524  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3525 
3530  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3531 
3537  bool ShowLink(int in_row, int in_column, LinkKit & out_link) const;
3538 
3544  bool ShowText(int in_row, int in_column, TextKit & out_text) const;
3545 
3551  bool ShowButton(int in_row, int in_column, ButtonKit & out_button) const;
3552 
3558  bool ShowTextField(int in_row, int in_column, TextFieldKit & out_text_field) const;
3559  };
3560 
3563  class PUBLISH_API SlideTableKit : public Sprocket
3564  {
3565  public:
3567  SlideTableKit();
3568 
3571  SlideTableKit(SlideTableKit const & in_kit);
3572 
3575  SlideTableKit(SlideTableKit && in_kit);
3576 
3577  virtual ~SlideTableKit();
3578 
3579  HPS::Type ObjectType() const { return HPS::Type::PublishSlideTableKit; }
3580 
3581  // no GetDefault() since function doesn't make sense for this class
3582 
3585  void Set(SlideTableKit const & in_kit);
3586 
3589  void Show(SlideTableKit & out_kit) const;
3590 
3594  SlideTableKit & operator=(SlideTableKit const & in_kit);
3595 
3599  SlideTableKit & operator=(SlideTableKit && in_kit);
3600 
3603  bool Empty() const;
3604 
3608  bool Equals(SlideTableKit const & in_kit) const;
3609 
3613  bool operator==(SlideTableKit const & in_kit) const;
3614 
3618  bool operator!=(SlideTableKit const & in_kit) const;
3619 
3620 
3625  SlideTableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3626 
3631  SlideTableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3632 
3637  SlideTableKit & SetButtons(char const * in_previous_button_name, char const * in_next_button_name);
3638 
3644  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKit const in_text[]);
3645 
3651  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKitArray const & in_text);
3652 
3656  SlideTableKit & SetHeader(bool in_state);
3657 
3658 
3661  SlideTableKit & UnsetHTML();
3662 
3665  SlideTableKit & UnsetHTMLStyle();
3666 
3669  SlideTableKit & UnsetButtons();
3670 
3673  SlideTableKit & UnsetText();
3674 
3677  SlideTableKit & UnsetHeader();
3678 
3681  SlideTableKit & UnsetEverything();
3682 
3683 
3688  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3689 
3694  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3695 
3700  bool ShowButtons(UTF8 & out_previous_button_name, UTF8 & out_next_button_name) const;
3701 
3707  bool ShowText(size_t & out_rows, size_t & out_columns, TextFieldKitArray & out_text) const;
3708 
3712  bool ShowHeader(bool & out_state) const;
3713  };
3714 
3716  class PUBLISH_API LinkKit : public Sprocket
3717  {
3718  public:
3720  LinkKit();
3721 
3724  LinkKit(LinkKit const & in_kit);
3725 
3728  LinkKit(LinkKit && in_kit);
3729 
3730  virtual ~LinkKit();
3731 
3732  HPS::Type ObjectType() const { return HPS::Type::PublishLinkKit; }
3733 
3734  // no GetDefault() since function doesn't make sense for this class
3735 
3738  void Set(LinkKit const & in_kit);
3739 
3742  void Show(LinkKit & out_kit) const;
3743 
3747  LinkKit & operator=(LinkKit const & in_kit);
3748 
3752  LinkKit & operator=(LinkKit && in_kit);
3753 
3756  bool Empty() const;
3757 
3761  bool Equals(LinkKit const & in_kit) const;
3762 
3766  bool operator==(LinkKit const & in_kit) const;
3767 
3771  bool operator!=(LinkKit const & in_kit) const;
3772 
3773 
3778  LinkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
3779 
3783  LinkKit & SetBorderWidth(int in_width);
3784 
3788  LinkKit & SetHighlighting(Highlighting::Mode in_mode);
3789 
3793  LinkKit & SetBorderColor(RGBColor const & in_color);
3794 
3795 
3798  LinkKit & UnsetJavaScript();
3799 
3802  LinkKit & UnsetBorderWidth();
3803 
3806  LinkKit & UnsetHighlighting();
3807 
3810  LinkKit & UnsetBorderColor();
3811 
3814  LinkKit & UnsetEverything();
3815 
3816 
3821  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
3822 
3826  bool ShowBorderWidth(int & out_width) const;
3827 
3831  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
3832 
3836  bool ShowBorderColor(RGBColor & out_color) const;
3837  };
3838 
3840  class PUBLISH_API ButtonKit : public Sprocket
3841  {
3842  public:
3844  ButtonKit();
3845 
3848  ButtonKit(ButtonKit const & in_kit);
3849 
3852  ButtonKit(ButtonKit && in_kit);
3853 
3854  virtual ~ButtonKit();
3855 
3856  HPS::Type ObjectType() const { return HPS::Type::PublishButtonKit; }
3857 
3861  static ButtonKit GetDefault();
3862 
3865  void Set(ButtonKit const & in_kit);
3866 
3869  void Show(ButtonKit & out_kit) const;
3870 
3874  ButtonKit & operator=(ButtonKit const & in_kit);
3875 
3879  ButtonKit & operator=(ButtonKit && in_kit);
3880 
3883  bool Empty() const;
3884 
3888  bool Equals(ButtonKit const & in_kit) const;
3889 
3893  bool operator==(ButtonKit const & in_kit) const;
3894 
3898  bool operator!=(ButtonKit const & in_kit) const;
3899 
3900 
3904  ButtonKit & SetName(char const * in_name);
3905 
3909  ButtonKit & SetLabel(char const * in_label);
3910 
3914  ButtonKit & SetFont(Text::Font::Name in_name);
3915 
3920  ButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
3921 
3925  ButtonKit & SetFontSize(int in_size);
3926 
3930  ButtonKit & SetTextColor(RGBColor const & in_color);
3931 
3935  ButtonKit & SetTooltip(char const * in_tooltip);
3936 
3940  ButtonKit & SetVisibility(bool in_state);
3941 
3945  ButtonKit & SetPrintability(bool in_state);
3946 
3950  ButtonKit & SetTextRotation(Text::Rotation in_rotation);
3951 
3955  ButtonKit & SetLock(bool in_state);
3956 
3960  ButtonKit & SetBorder(bool in_state);
3961 
3965  ButtonKit & SetBorderColor(RGBColor const & in_color);
3966 
3970  ButtonKit & SetBorderThickness(Border::Thickness in_thickness);
3971 
3975  ButtonKit & SetBorderStyle(Border::Style in_style);
3976 
3981  ButtonKit & SetFillColor(RGBColor const & in_color);
3982 
3986  ButtonKit & SetLabelPosition(Label::Position in_position);
3987 
3991  ButtonKit & SetHighlighting(Highlighting::Mode in_mode);
3992 
3996  ButtonKit & SetIconImage(ImageKit const & in_image);
3997 
3998 
4001  ButtonKit & UnsetName();
4002 
4005  ButtonKit & UnsetLabel();
4006 
4009  ButtonKit & UnsetFont();
4010 
4013  ButtonKit & UnsetFontSize();
4014 
4017  ButtonKit & UnsetTextColor();
4018 
4021  ButtonKit & UnsetTooltip();
4022 
4025  ButtonKit & UnsetVisibility();
4026 
4029  ButtonKit & UnsetPrintability();
4030 
4033  ButtonKit & UnsetTextRotation();
4034 
4037  ButtonKit & UnsetLock();
4038 
4041  ButtonKit & UnsetBorder();
4042 
4045  ButtonKit & UnsetBorderColor();
4046 
4049  ButtonKit & UnsetBorderThickness();
4050 
4053  ButtonKit & UnsetBorderStyle();
4054 
4057  ButtonKit & UnsetFillColor();
4058 
4061  ButtonKit & UnsetLabelPosition();
4062 
4065  ButtonKit & UnsetHighlighting();
4066 
4069  ButtonKit & UnsetIconImage();
4070 
4073  ButtonKit & UnsetEverything();
4074 
4075 
4079  bool ShowName(UTF8 & out_name) const;
4080 
4084  bool ShowLabel(UTF8 & out_label) const;
4085 
4092  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4093 
4097  bool ShowFontSize(int & out_size) const;
4098 
4102  bool ShowTextColor(RGBColor & out_color) const;
4103 
4107  bool ShowTooltip(UTF8 & out_tooltip) const;
4108 
4112  bool ShowVisibility(bool & out_state) const;
4113 
4117  bool ShowPrintability(bool & out_state) const;
4118 
4122  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4123 
4127  bool ShowLock(bool & out_state) const;
4128 
4132  bool ShowBorder(bool & out_state) const;
4133 
4137  bool ShowBorderColor(RGBColor & out_color) const;
4138 
4142  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4143 
4147  bool ShowBorderStyle(Border::Style & out_style) const;
4148 
4152  bool ShowFillColor(RGBColor & out_color) const;
4153 
4157  bool ShowLabelPosition(Label::Position & out_position) const;
4158 
4162  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
4163 
4167  bool ShowIconImage(ImageKit & out_image) const;
4168  };
4169 
4171  class PUBLISH_API CheckBoxKit : public Sprocket
4172  {
4173  public:
4175  CheckBoxKit();
4176 
4179  CheckBoxKit(CheckBoxKit const & in_kit);
4180 
4183  CheckBoxKit(CheckBoxKit && in_kit);
4184 
4185  virtual ~CheckBoxKit();
4186 
4187  HPS::Type ObjectType() const { return HPS::Type::PublishCheckBoxKit; }
4188 
4192  static CheckBoxKit GetDefault();
4193 
4196  void Set(CheckBoxKit const & in_kit);
4197 
4200  void Show(CheckBoxKit & out_kit) const;
4201 
4205  CheckBoxKit & operator=(CheckBoxKit const & in_kit);
4206 
4210  CheckBoxKit & operator=(CheckBoxKit && in_kit);
4211 
4214  bool Empty() const;
4215 
4219  bool Equals(CheckBoxKit const & in_kit) const;
4220 
4224  bool operator==(CheckBoxKit const & in_kit) const;
4225 
4229  bool operator!=(CheckBoxKit const & in_kit) const;
4230 
4231 
4235  CheckBoxKit & SetName(char const * in_name);
4236 
4240  CheckBoxKit & SetFont(Text::Font::Name in_name);
4241 
4246  CheckBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4247 
4251  CheckBoxKit & SetFontSize(int in_size);
4252 
4256  CheckBoxKit & SetTextColor(RGBColor const & in_color);
4257 
4261  CheckBoxKit & SetTooltip(char const * in_tooltip);
4262 
4266  CheckBoxKit & SetVisibility(bool in_state);
4267 
4271  CheckBoxKit & SetPrintability(bool in_state);
4272 
4276  CheckBoxKit & SetTextRotation(Text::Rotation in_rotation);
4277 
4281  CheckBoxKit & SetLock(bool in_state);
4282 
4286  CheckBoxKit & SetBorder(bool in_state);
4287 
4291  CheckBoxKit & SetBorderColor(RGBColor const & in_color);
4292 
4296  CheckBoxKit & SetBorderThickness(Border::Thickness in_thickness);
4297 
4301  CheckBoxKit & SetBorderStyle(Border::Style in_style);
4302 
4307  CheckBoxKit & SetFillColor(RGBColor const & in_color);
4308 
4312  CheckBoxKit & SetExportValue(char const * in_export_value);
4313 
4317  CheckBoxKit & SetDefaultState(bool in_state);
4318 
4319 
4322  CheckBoxKit & UnsetName();
4323 
4326  CheckBoxKit & UnsetFont();
4327 
4330  CheckBoxKit & UnsetFontSize();
4331 
4334  CheckBoxKit & UnsetTextColor();
4335 
4338  CheckBoxKit & UnsetTooltip();
4339 
4342  CheckBoxKit & UnsetVisibility();
4343 
4346  CheckBoxKit & UnsetPrintability();
4347 
4350  CheckBoxKit & UnsetTextRotation();
4351 
4354  CheckBoxKit & UnsetLock();
4355 
4358  CheckBoxKit & UnsetBorder();
4359 
4362  CheckBoxKit & UnsetBorderColor();
4363 
4366  CheckBoxKit & UnsetBorderThickness();
4367 
4370  CheckBoxKit & UnsetBorderStyle();
4371 
4374  CheckBoxKit & UnsetFillColor();
4375 
4378  CheckBoxKit & UnsetExportValue();
4379 
4382  CheckBoxKit & UnsetDefaultState();
4383 
4386  CheckBoxKit & UnsetEverything();
4387 
4388 
4392  bool ShowName(UTF8 & out_name) const;
4393 
4400  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4401 
4405  bool ShowFontSize(int & out_size) const;
4406 
4410  bool ShowTextColor(RGBColor & out_color) const;
4411 
4415  bool ShowTooltip(UTF8 & out_tooltip) const;
4416 
4420  bool ShowVisibility(bool & out_state) const;
4421 
4425  bool ShowPrintability(bool & out_state) const;
4426 
4430  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4431 
4435  bool ShowLock(bool & out_state) const;
4436 
4440  bool ShowBorder(bool & out_state) const;
4441 
4445  bool ShowBorderColor(RGBColor & out_color) const;
4446 
4450  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4451 
4455  bool ShowBorderStyle(Border::Style & out_style) const;
4456 
4460  bool ShowFillColor(RGBColor & out_color) const;
4461 
4465  bool ShowExportValue(UTF8 & out_export_value) const;
4466 
4470  bool ShowDefaultState(bool & out_default_state) const;
4471  };
4472 
4474  class PUBLISH_API RadioButtonKit : public Sprocket
4475  {
4476  public:
4478  RadioButtonKit();
4479 
4482  RadioButtonKit(RadioButtonKit const & in_kit);
4483 
4486  RadioButtonKit(RadioButtonKit && in_kit);
4487 
4488  virtual ~RadioButtonKit();
4489 
4490  HPS::Type ObjectType() const { return HPS::Type::PublishRadioButtonKit; }
4491 
4495  static RadioButtonKit GetDefault();
4496 
4499  void Set(RadioButtonKit const & in_kit);
4500 
4503  void Show(RadioButtonKit & out_kit) const;
4504 
4508  RadioButtonKit & operator=(RadioButtonKit const & in_kit);
4509 
4513  RadioButtonKit & operator=(RadioButtonKit && in_kit);
4514 
4517  bool Empty() const;
4518 
4522  bool Equals(RadioButtonKit const & in_kit) const;
4523 
4527  bool operator==(RadioButtonKit const & in_kit) const;
4528 
4532  bool operator!=(RadioButtonKit const & in_kit) const;
4533 
4534 
4538  RadioButtonKit & SetName(char const * in_name);
4539 
4543  RadioButtonKit & SetFont(Text::Font::Name in_name);
4544 
4549  RadioButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4550 
4554  RadioButtonKit & SetFontSize(int in_size);
4555 
4559  RadioButtonKit & SetTextColor(RGBColor const & in_color);
4560 
4564  RadioButtonKit & SetTooltip(char const * in_tooltip);
4565 
4569  RadioButtonKit & SetVisibility(bool in_state);
4570 
4574  RadioButtonKit & SetPrintability(bool in_state);
4575 
4579  RadioButtonKit & SetTextRotation(Text::Rotation in_rotation);
4580 
4584  RadioButtonKit & SetLock(bool in_state);
4585 
4589  RadioButtonKit & SetBorder(bool in_state);
4590 
4594  RadioButtonKit & SetBorderColor(RGBColor const & in_color);
4595 
4599  RadioButtonKit & SetBorderThickness(Border::Thickness in_thickness);
4600 
4604  RadioButtonKit & SetBorderStyle(Border::Style in_style);
4605 
4610  RadioButtonKit & SetFillColor(RGBColor const & in_color);
4611 
4615  RadioButtonKit & SetExportValue(char const * in_export_value);
4616 
4620  RadioButtonKit & SetDefaultState(bool in_state);
4621 
4625  RadioButtonKit & SetGrouping(bool in_state);
4626 
4627 
4630  RadioButtonKit & UnsetName();
4631 
4634  RadioButtonKit & UnsetFont();
4635 
4638  RadioButtonKit & UnsetFontSize();
4639 
4642  RadioButtonKit & UnsetTextColor();
4643 
4646  RadioButtonKit & UnsetTooltip();
4647 
4650  RadioButtonKit & UnsetVisibility();
4651 
4654  RadioButtonKit & UnsetPrintability();
4655 
4658  RadioButtonKit & UnsetTextRotation();
4659 
4662  RadioButtonKit & UnsetLock();
4663 
4666  RadioButtonKit & UnsetBorder();
4667 
4670  RadioButtonKit & UnsetBorderColor();
4671 
4674  RadioButtonKit & UnsetBorderThickness();
4675 
4678  RadioButtonKit & UnsetBorderStyle();
4679 
4682  RadioButtonKit & UnsetFillColor();
4683 
4686  RadioButtonKit & UnsetExportValue();
4687 
4690  RadioButtonKit & UnsetDefaultState();
4691 
4694  RadioButtonKit & UnsetGrouping();
4695 
4698  RadioButtonKit & UnsetEverything();
4699 
4700 
4704  bool ShowName(UTF8 & out_name) const;
4705 
4712  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4713 
4717  bool ShowFontSize(int & out_size) const;
4718 
4722  bool ShowTextColor(RGBColor & out_color) const;
4723 
4727  bool ShowTooltip(UTF8 & out_tooltip) const;
4728 
4732  bool ShowVisibility(bool & out_state) const;
4733 
4737  bool ShowPrintability(bool & out_state) const;
4738 
4742  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4743 
4747  bool ShowLock(bool & out_state) const;
4748 
4752  bool ShowBorder(bool & out_state) const;
4753 
4757  bool ShowBorderColor(RGBColor & out_color) const;
4758 
4762  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4763 
4767  bool ShowBorderStyle(Border::Style & out_style) const;
4768 
4772  bool ShowFillColor(RGBColor & out_color) const;
4773 
4777  bool ShowExportValue(UTF8 & out_export_value) const;
4778 
4782  bool ShowDefaultState(bool & out_default_state) const;
4783 
4787  bool ShowGrouping(bool & out_grouping) const;
4788  };
4789 
4791  class PUBLISH_API ListBoxKit : public Sprocket
4792  {
4793  public:
4795  ListBoxKit();
4796 
4799  ListBoxKit(ListBoxKit const & in_kit);
4800 
4803  ListBoxKit(ListBoxKit && in_kit);
4804 
4805  virtual ~ListBoxKit();
4806 
4807  HPS::Type ObjectType() const { return HPS::Type::PublishListBoxKit; }
4808 
4812  static ListBoxKit GetDefault();
4813 
4816  void Set(ListBoxKit const & in_kit);
4817 
4820  void Show(ListBoxKit & out_kit) const;
4821 
4825  ListBoxKit & operator=(ListBoxKit const & in_kit);
4826 
4830  ListBoxKit & operator=(ListBoxKit && in_kit);
4831 
4834  bool Empty() const;
4835 
4839  bool Equals(ListBoxKit const & in_kit) const;
4840 
4844  bool operator==(ListBoxKit const & in_kit) const;
4845 
4849  bool operator!=(ListBoxKit const & in_kit) const;
4850 
4851 
4855  ListBoxKit & SetName(char const * in_name);
4856 
4860  ListBoxKit & SetFont(Text::Font::Name in_name);
4861 
4866  ListBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4867 
4871  ListBoxKit & SetFontSize(int in_size);
4872 
4876  ListBoxKit & SetTextColor(RGBColor const & in_color);
4877 
4881  ListBoxKit & SetTooltip(char const * in_tooltip);
4882 
4886  ListBoxKit & SetVisibility(bool in_state);
4887 
4891  ListBoxKit & SetPrintability(bool in_state);
4892 
4896  ListBoxKit & SetTextRotation(Text::Rotation in_rotation);
4897 
4901  ListBoxKit & SetLock(bool in_state);
4902 
4906  ListBoxKit & SetBorder(bool in_state);
4907 
4911  ListBoxKit & SetBorderColor(RGBColor const & in_color);
4912 
4916  ListBoxKit & SetBorderThickness(Border::Thickness in_thickness);
4917 
4921  ListBoxKit & SetBorderStyle(Border::Style in_style);
4922 
4927  ListBoxKit & SetFillColor(RGBColor const & in_color);
4928 
4932  ListBoxKit & SetMultipleSelection(bool in_state);
4933 
4939  ListBoxKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
4940 
4946  ListBoxKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
4947 
4948 
4951  ListBoxKit & UnsetName();
4952 
4955  ListBoxKit & UnsetFont();
4956 
4959  ListBoxKit & UnsetFontSize();
4960 
4963  ListBoxKit & UnsetTextColor();
4964 
4967  ListBoxKit & UnsetTooltip();
4968 
4971  ListBoxKit & UnsetVisibility();
4972 
4975  ListBoxKit & UnsetPrintability();
4976 
4979  ListBoxKit & UnsetTextRotation();
4980 
4983  ListBoxKit & UnsetLock();
4984 
4987  ListBoxKit & UnsetBorder();
4988 
4991  ListBoxKit & UnsetBorderColor();
4992 
4995  ListBoxKit & UnsetBorderThickness();
4996 
4999  ListBoxKit & UnsetBorderStyle();
5000 
5003  ListBoxKit & UnsetFillColor();
5004 
5007  ListBoxKit & UnsetMultipleSelection();
5008 
5011  ListBoxKit & UnsetContents();
5012 
5015  ListBoxKit & UnsetEverything();
5016 
5017 
5021  bool ShowName(UTF8 & out_name) const;
5022 
5029  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5030 
5034  bool ShowFontSize(int & out_size) const;
5035 
5039  bool ShowTextColor(RGBColor & out_color) const;
5040 
5044  bool ShowTooltip(UTF8 & out_tooltip) const;
5045 
5049  bool ShowVisibility(bool & out_state) const;
5050 
5054  bool ShowPrintability(bool & out_state) const;
5055 
5059  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5060 
5064  bool ShowLock(bool & out_state) const;
5065 
5069  bool ShowBorder(bool & out_state) const;
5070 
5074  bool ShowBorderColor(RGBColor & out_color) const;
5075 
5079  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5080 
5084  bool ShowBorderStyle(Border::Style & out_style) const;
5085 
5089  bool ShowFillColor(RGBColor & out_color) const;
5090 
5094  bool ShowMultipleSelection(bool & out_state) const;
5095 
5100  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5101  };
5102 
5104  class PUBLISH_API DropDownListKit : public Sprocket
5105  {
5106  public:
5108  DropDownListKit();
5109 
5112  DropDownListKit(DropDownListKit const & in_kit);
5113 
5116  DropDownListKit(DropDownListKit && in_kit);
5117 
5118  virtual ~DropDownListKit();
5119 
5120  HPS::Type ObjectType() const { return HPS::Type::PublishDropDownListKit; }
5121 
5125  static DropDownListKit GetDefault();
5126 
5129  void Set(DropDownListKit const & in_kit);
5130 
5133  void Show(DropDownListKit & out_kit) const;
5134 
5138  DropDownListKit & operator=(DropDownListKit const & in_kit);
5139 
5143  DropDownListKit & operator=(DropDownListKit && in_kit);
5144 
5147  bool Empty() const;
5148 
5152  bool Equals(DropDownListKit const & in_kit) const;
5153 
5157  bool operator==(DropDownListKit const & in_kit) const;
5158 
5162  bool operator!=(DropDownListKit const & in_kit) const;
5163 
5164 
5168  DropDownListKit & SetName(char const * in_name);
5169 
5173  DropDownListKit & SetFont(Text::Font::Name in_name);
5174 
5179  DropDownListKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5180 
5184  DropDownListKit & SetFontSize(int in_size);
5185 
5189  DropDownListKit & SetTextColor(RGBColor const & in_color);
5190 
5194  DropDownListKit & SetTooltip(char const * in_tooltip);
5195 
5199  DropDownListKit & SetVisibility(bool in_state);
5200 
5204  DropDownListKit & SetPrintability(bool in_state);
5205 
5209  DropDownListKit & SetTextRotation(Text::Rotation in_rotation);
5210 
5214  DropDownListKit & SetLock(bool in_state);
5215 
5219  DropDownListKit & SetBorder(bool in_state);
5220 
5224  DropDownListKit & SetBorderColor(RGBColor const & in_color);
5225 
5229  DropDownListKit & SetBorderThickness(Border::Thickness in_thickness);
5230 
5234  DropDownListKit & SetBorderStyle(Border::Style in_style);
5235 
5240  DropDownListKit & SetFillColor(RGBColor const & in_color);
5241 
5245  DropDownListKit & SetCustomText(bool in_state);
5246 
5250  DropDownListKit & SetSpellChecking(bool in_state);
5251 
5255  DropDownListKit & SetImmediateCommit(bool in_state);
5256 
5262  DropDownListKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
5263 
5269  DropDownListKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
5270 
5271 
5274  DropDownListKit & UnsetName();
5275 
5278  DropDownListKit & UnsetFont();
5279 
5282  DropDownListKit & UnsetFontSize();
5283 
5286  DropDownListKit & UnsetTextColor();
5287 
5290  DropDownListKit & UnsetTooltip();
5291 
5294  DropDownListKit & UnsetVisibility();
5295 
5298  DropDownListKit & UnsetPrintability();
5299 
5302  DropDownListKit & UnsetTextRotation();
5303 
5306  DropDownListKit & UnsetLock();
5307 
5310  DropDownListKit & UnsetBorder();
5311 
5314  DropDownListKit & UnsetBorderColor();
5315 
5318  DropDownListKit & UnsetBorderThickness();
5319 
5322  DropDownListKit & UnsetBorderStyle();
5323 
5326  DropDownListKit & UnsetFillColor();
5327 
5330  DropDownListKit & UnsetCustomText();
5331 
5334  DropDownListKit & UnsetSpellChecking();
5335 
5338  DropDownListKit & UnsetImmediateCommit();
5339 
5342  DropDownListKit & UnsetContents();
5343 
5346  DropDownListKit & UnsetEverything();
5347 
5348 
5352  bool ShowName(UTF8 & out_name) const;
5353 
5360  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5361 
5365  bool ShowFontSize(int & out_size) const;
5366 
5370  bool ShowTextColor(RGBColor & out_color) const;
5371 
5375  bool ShowTooltip(UTF8 & out_tooltip) const;
5376 
5380  bool ShowVisibility(bool & out_state) const;
5381 
5385  bool ShowPrintability(bool & out_state) const;
5386 
5390  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5391 
5395  bool ShowLock(bool & out_state) const;
5396 
5400  bool ShowBorder(bool & out_state) const;
5401 
5405  bool ShowBorderColor(RGBColor & out_color) const;
5406 
5410  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5411 
5415  bool ShowBorderStyle(Border::Style & out_style) const;
5416 
5420  bool ShowFillColor(RGBColor & out_color) const;
5421 
5425  bool ShowCustomText(bool & out_state) const;
5426 
5430  bool ShowSpellChecking(bool & out_state) const;
5431 
5435  bool ShowImmediateCommit(bool & out_state) const;
5436 
5441  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5442  };
5443 
5445  class PUBLISH_API SignatureFieldKit : public Sprocket
5446  {
5447  public:
5450 
5453  SignatureFieldKit(SignatureFieldKit const & in_kit);
5454 
5458 
5459  virtual ~SignatureFieldKit();
5460 
5461  HPS::Type ObjectType() const { return HPS::Type::PublishSignatureFieldKit; }
5462 
5466  static SignatureFieldKit GetDefault();
5467 
5470  void Set(SignatureFieldKit const & in_kit);
5471 
5474  void Show(SignatureFieldKit & out_kit) const;
5475 
5479  SignatureFieldKit & operator=(SignatureFieldKit const & in_kit);
5480 
5484  SignatureFieldKit & operator=(SignatureFieldKit && in_kit);
5485 
5488  bool Empty() const;
5489 
5493  bool Equals(SignatureFieldKit const & in_kit) const;
5494 
5498  bool operator==(SignatureFieldKit const & in_kit) const;
5499 
5503  bool operator!=(SignatureFieldKit const & in_kit) const;
5504 
5505 
5509  SignatureFieldKit & SetName(char const * in_name);
5510 
5514  SignatureFieldKit & SetFont(Text::Font::Name in_name);
5515 
5520  SignatureFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5521 
5525  SignatureFieldKit & SetFontSize(int in_size);
5526 
5530  SignatureFieldKit & SetTextColor(RGBColor const & in_color);
5531 
5535  SignatureFieldKit & SetTooltip(char const * in_tooltip);
5536 
5540  SignatureFieldKit & SetVisibility(bool in_state);
5541 
5545  SignatureFieldKit & SetPrintability(bool in_state);
5546 
5550  SignatureFieldKit & SetTextRotation(Text::Rotation in_rotation);
5551 
5555  SignatureFieldKit & SetLock(bool in_state);
5556 
5560  SignatureFieldKit & SetBorder(bool in_state);
5561 
5565  SignatureFieldKit & SetBorderColor(RGBColor const & in_color);
5566 
5570  SignatureFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5571 
5575  SignatureFieldKit & SetBorderStyle(Border::Style in_style);
5576 
5581  SignatureFieldKit & SetFillColor(RGBColor const & in_color);
5582 
5583 
5586  SignatureFieldKit & UnsetName();
5587 
5590  SignatureFieldKit & UnsetFont();
5591 
5594  SignatureFieldKit & UnsetFontSize();
5595 
5598  SignatureFieldKit & UnsetTextColor();
5599 
5602  SignatureFieldKit & UnsetTooltip();
5603 
5606  SignatureFieldKit & UnsetVisibility();
5607 
5610  SignatureFieldKit & UnsetPrintability();
5611 
5614  SignatureFieldKit & UnsetTextRotation();
5615 
5618  SignatureFieldKit & UnsetLock();
5619 
5622  SignatureFieldKit & UnsetBorder();
5623 
5626  SignatureFieldKit & UnsetBorderColor();
5627 
5630  SignatureFieldKit & UnsetBorderThickness();
5631 
5634  SignatureFieldKit & UnsetBorderStyle();
5635 
5638  SignatureFieldKit & UnsetFillColor();
5639 
5642  SignatureFieldKit & UnsetEverything();
5643 
5644 
5648  bool ShowName(UTF8 & out_name) const;
5649 
5656  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5657 
5661  bool ShowFontSize(int & out_size) const;
5662 
5666  bool ShowTextColor(RGBColor & out_color) const;
5667 
5671  bool ShowTooltip(UTF8 & out_tooltip) const;
5672 
5676  bool ShowVisibility(bool & out_state) const;
5677 
5681  bool ShowPrintability(bool & out_state) const;
5682 
5686  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5687 
5691  bool ShowLock(bool & out_state) const;
5692 
5696  bool ShowBorder(bool & out_state) const;
5697 
5701  bool ShowBorderColor(RGBColor & out_color) const;
5702 
5706  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5707 
5711  bool ShowBorderStyle(Border::Style & out_style) const;
5712 
5716  bool ShowFillColor(RGBColor & out_color) const;
5717  };
5718 
5720  class PUBLISH_API TextFieldKit : public Sprocket
5721  {
5722  public:
5724  TextFieldKit();
5725 
5728  TextFieldKit(TextFieldKit const & in_kit);
5729 
5732  TextFieldKit(TextFieldKit && in_kit);
5733 
5734  virtual ~TextFieldKit();
5735 
5736  HPS::Type ObjectType() const { return HPS::Type::PublishTextFieldKit; }
5737 
5741  static TextFieldKit GetDefault();
5742 
5745  void Set(TextFieldKit const & in_kit);
5746 
5749  void Show(TextFieldKit & out_kit) const;
5750 
5754  TextFieldKit & operator=(TextFieldKit const & in_kit);
5755 
5759  TextFieldKit & operator=(TextFieldKit && in_kit);
5760 
5763  bool Empty() const;
5764 
5768  bool Equals(TextFieldKit const & in_kit) const;
5769 
5773  bool operator==(TextFieldKit const & in_kit) const;
5774 
5778  bool operator!=(TextFieldKit const & in_kit) const;
5779 
5780 
5781 
5785  TextFieldKit & SetName(char const * in_name);
5786 
5790  TextFieldKit & SetFont(Text::Font::Name in_name);
5791 
5796  TextFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5797 
5801  TextFieldKit & SetFontSize(int in_size);
5802 
5806  TextFieldKit & SetTextColor(RGBColor const & in_color);
5807 
5811  TextFieldKit & SetTooltip(char const * in_tooltip);
5812 
5816  TextFieldKit & SetVisibility(bool in_state);
5817 
5821  TextFieldKit & SetPrintability(bool in_state);
5822 
5826  TextFieldKit & SetTextRotation(Text::Rotation in_rotation);
5827 
5831  TextFieldKit & SetLock(bool in_state);
5832 
5836  TextFieldKit & SetBorder(bool in_state);
5837 
5841  TextFieldKit & SetBorderColor(RGBColor const & in_color);
5842 
5846  TextFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5847 
5851  TextFieldKit & SetBorderStyle(Border::Style in_style);
5852 
5857  TextFieldKit & SetFillColor(RGBColor const & in_color);
5858 
5862  TextFieldKit & SetDefaultValue(char const * in_value);
5863 
5867  TextFieldKit & SetTextJustification(HPS::Text::Justification in_justification);
5868 
5872  TextFieldKit & SetMultiline(bool in_state);
5873 
5877  TextFieldKit & SetScrolling(bool in_state);
5878 
5882  TextFieldKit & SetReadOnly(bool in_state);
5883 
5884 
5887  TextFieldKit & UnsetName();
5888 
5891  TextFieldKit & UnsetFont();
5892 
5895  TextFieldKit & UnsetFontSize();
5896 
5899  TextFieldKit & UnsetTextColor();
5900 
5903  TextFieldKit & UnsetTooltip();
5904 
5907  TextFieldKit & UnsetVisibility();
5908 
5911  TextFieldKit & UnsetPrintability();
5912 
5915  TextFieldKit & UnsetTextRotation();
5916 
5919  TextFieldKit & UnsetLock();
5920 
5923  TextFieldKit & UnsetBorder();
5924 
5927  TextFieldKit & UnsetBorderColor();
5928 
5931  TextFieldKit & UnsetBorderThickness();
5932 
5935  TextFieldKit & UnsetBorderStyle();
5936 
5939  TextFieldKit & UnsetFillColor();
5940 
5943  TextFieldKit & UnsetDefaultValue();
5944 
5947  TextFieldKit & UnsetTextJustification();
5948 
5951  TextFieldKit & UnsetMultiline();
5952 
5955  TextFieldKit & UnsetScrolling();
5956 
5959  TextFieldKit & UnsetReadOnly();
5960 
5963  TextFieldKit & UnsetEverything();
5964 
5965 
5969  bool ShowName(UTF8 & out_name) const;
5970 
5977  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_font, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5978 
5982  bool ShowFontSize(int & out_size) const;
5983 
5987  bool ShowTextColor(RGBColor & out_color) const;
5988 
5992  bool ShowTooltip(UTF8 & out_tooltip) const;
5993 
5997  bool ShowVisibility(bool & out_state) const;
5998 
6002  bool ShowPrintability(bool & out_state) const;
6003 
6007  bool ShowTextRotation(Text::Rotation & out_rotation) const;
6008 
6012  bool ShowLock(bool & out_state) const;
6013 
6017  bool ShowBorder(bool & out_state) const;
6018 
6022  bool ShowBorderColor(RGBColor & out_color) const;
6023 
6027  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
6028 
6032  bool ShowBorderStyle(Border::Style & out_style) const;
6033 
6037  bool ShowFillColor(RGBColor & out_color) const;
6038 
6042  bool ShowDefaultValue(UTF8 & out_value) const;
6043 
6047  bool ShowTextJustification(HPS::Text::Justification & out_justification) const;
6048 
6052  bool ShowMultiline(bool & out_state) const;
6053 
6057  bool ShowScrolling(bool & out_state) const;
6058 
6062  bool ShowReadOnly(bool & out_state) const;
6063  };
6064 
6066  class PUBLISH_API DocumentKey : public Sprocket
6067  {
6068  public:
6070  DocumentKey();
6071 
6074  DocumentKey(DocumentKey const & in_that);
6075 
6078  DocumentKey(DocumentKey && in_that);
6079 
6082  virtual ~DocumentKey();
6083 
6084  HPS::Type ObjectType() const { return HPS::Type::PublishDocumentKey; }
6085 
6089  DocumentKey & operator=(DocumentKey const & in_that);
6090 
6094  DocumentKey & operator=(DocumentKey && in_that);
6095 
6099  virtual void Assign(DocumentKey const & in_that);
6100 
6104  bool Equals(DocumentKey const & in_that) const;
6105 
6109  bool operator!=(DocumentKey const & in_that) const;
6110 
6114  bool operator==(DocumentKey const & in_that) const;
6115 
6119  void Delete();
6120 
6121 
6126  DocumentKey & AddPage(PageKit const & in_page);
6127 
6133  DocumentKey & AddPages(size_t in_count, PageKit const in_pages[]);
6134 
6139  DocumentKey & AddPages(PageKitArray const & in_pages);
6140 
6150  DocumentKey & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
6151 
6156  DocumentKey & SetPasswords(char const * in_user_password, char const * in_owner_password);
6157 
6163  DocumentKey & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
6164 
6171  DocumentKey & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
6172 
6178  DocumentKey & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6179 
6184  DocumentKey & AddAttachment(char const * in_filename, char const * in_description);
6185 
6191  DocumentKey & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
6192 
6197  DocumentKey & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
6198 
6203  DocumentKey & AddIconImage(char const * in_name, ImageKit const & in_image);
6204 
6210  DocumentKey & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
6211 
6216  DocumentKey & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
6217 
6222  DocumentKey & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
6223 
6227  DocumentKey & SetPermissions(PermissionTypeArray const & in_permissions);
6228 
6229 
6231  size_t GetPageCount() const;
6232 
6236  DocumentKey & RemovePage(size_t in_index);
6237 
6242  DocumentKey & RemovePages(size_t in_start, size_t in_count);
6243 
6248  DocumentKey & RemovePages(size_t in_count, size_t const in_indices[]);
6249 
6253  DocumentKey & RemovePages(SizeTArray const & in_indices);
6254 
6257  DocumentKey & RemoveAllPages();
6258 
6262  PageControl GetPageControl(size_t in_index);
6263 
6267  PageControl const GetPageControl(size_t in_index) const;
6268  };
6269 
6271  class PUBLISH_API PageControl : public Sprocket
6272  {
6273  public:
6275  PageControl();
6276 
6279  PageControl(PageControl const & in_that);
6280 
6283  PageControl(PageControl && in_that);
6284 
6285  virtual ~PageControl();
6286 
6287  HPS::Type ObjectType() const { return HPS::Type::PublishPageControl; }
6288 
6292  PageControl & operator=(PageControl const & in_that);
6293 
6297  PageControl & operator=(PageControl && in_kit);
6298 
6299 
6304  PageControl & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
6305 
6311  PageControl & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
6312 
6317  PageControl & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
6318 
6323  PageControl & AddText(TextKit const & in_text, IntRectangle const & in_location);
6324 
6330  PageControl & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
6331 
6336  PageControl & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
6337 
6342  PageControl & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
6343 
6349  PageControl & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
6350 
6355  PageControl & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
6356 
6361  PageControl & AddTable(TableKit const & in_table, IntRectangle const & in_location);
6362 
6368  PageControl & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
6369 
6374  PageControl & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
6375 
6380  PageControl & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
6381 
6387  PageControl & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
6388 
6393  PageControl & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
6394 
6399  PageControl & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
6400 
6406  PageControl & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
6407 
6412  PageControl & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
6413 
6418  PageControl & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
6419 
6425  PageControl & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
6426 
6431  PageControl & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
6432 
6437  PageControl & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
6438 
6444  PageControl & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
6445 
6450  PageControl & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
6451 
6456  PageControl & AddCheckBox(CheckBoxKit const & in_check_box, IntRectangle const & in_location);
6457 
6463  PageControl & AddCheckBoxes(size_t in_count, CheckBoxKit const in_check_boxes[], IntRectangle const in_locations[]);
6464 
6469  PageControl & AddCheckBoxes(CheckBoxKitArray const & in_check_boxes, IntRectangleArray const & in_locations);
6470 
6475  PageControl & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
6476 
6482  PageControl & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
6483 
6488  PageControl & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
6489 
6494  PageControl & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
6495 
6501  PageControl & AddListBoxes(size_t in_count, ListBoxKit const in_list_boxes[], IntRectangle const in_locations[]);
6502 
6507  PageControl & AddListBoxes(ListBoxKitArray const & in_list_boxes, IntRectangleArray const & in_locations);
6508 
6513  PageControl & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
6514 
6520  PageControl & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_lists[], IntRectangle const in_locations[]);
6521 
6526  PageControl & AddDropDownLists(DropDownListKitArray const & in_drop_down_lists, IntRectangleArray const & in_locations);
6527 
6532  PageControl & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
6533 
6539  PageControl & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_fields[], IntRectangle const in_locations[]);
6540 
6545  PageControl & AddSignatureFields(SignatureFieldKitArray const & in_signature_fields, IntRectangleArray const & in_locations);
6546 
6547 
6553  PageControl & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
6554 
6561  PageControl & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
6562 
6568  PageControl & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
6569 
6575  PageControl & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
6576 
6583  PageControl & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
6584 
6590  PageControl & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
6591 
6597  PageControl & SetButtonLabelByField(char const * in_field, char const * in_label);
6598 
6605  PageControl & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
6606 
6612  PageControl & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
6613 
6620  PageControl & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
6621 
6629  PageControl & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
6630 
6637  PageControl & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
6638 
6646  PageControl & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
6647 
6656  PageControl & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
6657 
6665  PageControl & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6666 
6672  PageControl & SetVisibilityByField(char const * in_field, bool in_state);
6673 
6680  PageControl & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
6681 
6687  PageControl & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
6688 
6694  PageControl & SetTextValueByField(char const * in_field, char const * in_value);
6695 
6702  PageControl & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
6703 
6709  PageControl & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
6710 
6711 
6717  bool ShowFields(UTF8Array & out_names, IntRectangleArray & out_locations, FieldTypeArray & out_types) const;
6718  };
6719 
6720 
6721  class ExportOptionsKit;
6722 
6724  class PUBLISH_API File
6725  {
6726  public:
6732  static void Export(CADModel const & in_cad_model, char const * in_file_name, ExportOptionsKit const & in_options);
6733 
6739  static void Export(KeyPathArray const & in_key_paths, char const * in_file_name, ExportOptionsKit const & in_options);
6740 
6747  static void Export(size_t in_count, KeyPath const in_key_paths [], char const * in_file_name, ExportOptionsKit const & in_options);
6748 
6754  static void Export(KeyPath const & in_key_path, char const * in_file_name, ExportOptionsKit const & in_options);
6755 
6763  static void Export(CADModel const & in_cad_model, KeyPathArray const & in_additional_key_paths, char const * in_file_name, ExportOptionsKit const & in_options);
6764 
6773  static void Export(CADModel const & in_cad_model, size_t in_count, KeyPath const in_additional_key_paths [], char const * in_file_name, ExportOptionsKit const & in_options);
6774 
6781  static void Export(AnnotationKit const & in_annotation, char const * in_file_name, ExportOptionsKit const & in_options);
6782 
6789  static void Export(DocumentKit const & in_document, char const * in_file_name, ExportOptionsKit const & in_options);
6790 
6795  static DocumentKey CreateDocument(char const * in_file_name = nullptr);
6796 
6801  static void Export(DocumentKey const & in_document, char const * in_file_name);
6802 
6803  private:
6805  File();
6806  };
6807 
6809  class PUBLISH_API ExportOptionsKit : public Sprocket
6810  {
6811  public:
6813  ExportOptionsKit();
6814 
6817  ExportOptionsKit(ExportOptionsKit const & in_kit);
6818 
6822 
6823  virtual ~ExportOptionsKit();
6824 
6825  HPS::Type ObjectType() const { return HPS::Type::PublishExportOptionsKit; }
6826 
6829  void Set(ExportOptionsKit const & in_kit);
6830 
6833  void Show(ExportOptionsKit & out_kit) const;
6834 
6838  ExportOptionsKit & operator=(ExportOptionsKit const & in_kit);
6839 
6843  ExportOptionsKit & operator=(ExportOptionsKit && in_kit);
6844 
6847  bool Empty() const;
6848 
6852  bool Equals(ExportOptionsKit const & in_kit) const;
6853 
6857  bool operator==(ExportOptionsKit const & in_kit) const;
6858 
6862  bool operator!=(ExportOptionsKit const & in_kit) const;
6863 
6864 
6868  ExportOptionsKit & SetDocumentToAppendTo(char const * in_filename);
6869 
6870 
6873  ExportOptionsKit & UnsetDocumentToAppendTo();
6874 
6877  ExportOptionsKit & UnsetEverything();
6878 
6879 
6883  bool ShowDocumentToAppendTo(UTF8 & out_filename) const;
6884  };
6885 
6886 private:
6888  Publish();
6889 };
6890 
6891 }
6892 
6893 #endif
Mode
Definition: sprk_publish.h:285
Definition: hps.h:3286
Definition: sprk_publish.h:3141
Definition: sprk_publish.h:2743
Mode
Definition: sprk_publish.h:457
Definition: sprk_publish.h:475
Preference
Definition: sprk_publish.h:497
Definition: sprk.h:66
HPS::Type ObjectType() const
Definition: sprk_publish.h:2294
Definition: sprk_publish.h:4474
HPS::Type ObjectType() const
Definition: sprk_publish.h:3408
Definition: sprk_publish.h:163
Orientation
Definition: sprk_publish.h:127
Definition: sprk_publish.h:314
Definition: sprk_publish.h:452
Format
Definition: sprk_publish.h:109
Definition: sprk_publish.h:182
Type
Definition: sprk_publish.h:319
Definition: sprk_publish.h:5445
Mode
Definition: sprk_publish.h:258
Definition: sprk_publish.h:42
Definition: sprk_publish.h:2969
Type
Definition: sprk_publish.h:569
Style
Definition: sprk_publish.h:204
HPS::Type ObjectType() const
Definition: sprk_publish.h:6825
Definition: sprk_publish.h:4171
Definition: sprk_publish.h:235
HPS::Type ObjectType() const
Definition: sprk_publish.h:6084
HPS::Type ObjectType() const
Definition: sprk_publish.h:4187
Definition: sprk_publish.h:566
HPS::Type ObjectType() const
Definition: sprk_publish.h:4490
Definition: sprk_publish.h:6724
Rotation
Definition: sprk_publish.h:378
Definition: sprk_publish.h:3563
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:5720
Definition: sprk_publish.h:4791
Type
Definition: sprk_publish.h:432
Definition: sprk_publish.h:492
Definition: sprk_publish.h:427
Justification
Definition: hps.h:1525
Definition: sprk_publish.h:104
BRepCompression
Definition: sprk_publish.h:168
Definition: sprk_publish.h:3840
Definition: hps.h:4250
Definition: hps.h:6817
Definition: sprk_publish.h:139
Definition: sprk_publish.h:597
HPS::Type ObjectType() const
Definition: sprk_publish.h:5120
Definition: sprk_publish.h:6809
Style
Definition: sprk_publish.h:345
Definition: sprk_publish.h:199
Definition: sprk_publish.h:280
Definition: sprk_publish.h:6271
Definition: sprk_publish.h:6066
HPS::Type ObjectType() const
Definition: sprk_publish.h:613
Definition: sprk_publish.h:5104
HPS::Type ObjectType() const
Definition: sprk_publish.h:2759
HPS::Type ObjectType() const
Definition: sprk_publish.h:5736
Thickness
Definition: sprk_publish.h:519
Definition: sprk_publish.h:3280
Type
Definition: sprk_publish.h:90
HPS::Type ObjectType() const
Definition: sprk_publish.h:4807
SourceType
Definition: sprk_publish.h:150
Definition: sprk_publish.h:543
HPS::Type ObjectType() const
Definition: sprk_publish.h:6287
Format
Definition: sprk_publish.h:144
Definition: sprk_publish.h:310
Preference
Definition: sprk_publish.h:480
Name
Definition: sprk_publish.h:327
Format
Definition: sprk_publish.h:397
Definition: sprk_publish.h:514
HPS::Type ObjectType() const
Definition: sprk_publish.h:3856
HPS::Type ObjectType() const
Definition: sprk_publish.h:953
Definition: sprk_publish.h:253
HPS::Type ObjectType() const
Definition: sprk_publish.h:3157
Language
Definition: sprk_publish.h:360
Definition: sprk_publish.h:928
Definition: sprk_publish.h:471
When
Definition: sprk_publish.h:222
Style
Definition: sprk_publish.h:528
Definition: hps.h:8938
Definition: hps.h:10375
When
Definition: sprk_publish.h:240
Definition: sprk.h:2372
HPS::Type ObjectType() const
Definition: sprk_publish.h:2985
HPS::Type ObjectType() const
Definition: sprk_publish.h:5461
Definition: sprk_publish.h:2278
HPS::Type ObjectType() const
Definition: sprk_publish.h:3579
Version
Definition: sprk_publish.h:187
Definition: sprk_publish.h:3392
HPS::Type ObjectType() const
Definition: sprk_publish.h:3296