< Home

< Table of Contents

REFERENCE MANUAL

sprk_publish.h
1 // Copyright (c) 1998-2014 by Tech Soft 3D, Inc.
2 //
3 // The information contained herein is confidential and proprietary to Tech Soft 3D, Inc.,
4 // and considered a trade secret as defined under civil and criminal statutes.
5 // Tech Soft 3D, Inc. shall pursue its civil and criminal remedies in the event of
6 // unauthorized use or misappropriation of its trade secrets. Use of this information
7 // by anyone other than authorized employees of Tech Soft 3D, Inc. is granted only under
8 // a written non-disclosure agreement, expressly prescribing the scope and manner of such use.
9 
10 #ifndef SPRK_PUBLISH_H
11 #define SPRK_PUBLISH_H
12 
13 #include "sprk.h"
14 
15 typedef void A3DEntity;
16 
17 #ifdef _MSC_VER
18 # ifndef STATIC_APP
19 # ifdef SPROCKETS
20 # define PUBLISH_API __declspec (dllexport)
21 # else
22 # define PUBLISH_API __declspec (dllimport)
23 # endif
24 # endif
25 #else
26 # include <stddef.h>
27 # if defined(SPROCKETS) and defined(LINUX_SYSTEM)
28 # ifndef STATIC_APP
29 # define PUBLISH_API __attribute__ ((visibility ("default")))
30 # endif
31 # endif
32 #endif
33 
34 #ifndef PUBLISH_API
35 # define PUBLISH_API
36 #endif
37 
38 namespace HPS
39 {
40 
42 class PUBLISH_API Publish
43 {
44 public:
45  class DocumentKit;
46  class PageKit;
47  class TemplateKit;
48  class AnnotationKit;
49  class ArtworkKit;
50  class ViewKit;
51  class TextKit;
52  class ImageKit;
53  class TableKit;
54  class LinkKit;
55  class ButtonKit;
56  class CheckBoxKit;
57  class RadioButtonKit;
58  class ListBoxKit;
59  class DropDownListKit;
60  class SignatureFieldKit;
61  class TextFieldKit;
62  class SlideTableKit;
63  class DocumentKey;
64  class PageControl;
65 
66  typedef std::vector<PageKit, Allocator<PageKit>> PageKitArray;
67  typedef std::vector<AnnotationKit, Allocator<AnnotationKit>> AnnotationKitArray;
68  typedef std::vector<ViewKit, Allocator<ViewKit>> ViewKitArray;
69  typedef std::vector<TextKit, Allocator<TextKit>> TextKitArray;
70  typedef std::vector<ImageKit, Allocator<ImageKit>> ImageKitArray;
71  typedef std::vector<TableKit, Allocator<TableKit>> TableKitArray;
72  typedef std::vector<LinkKit, Allocator<LinkKit>> LinkKitArray;
73  typedef std::vector<ButtonKit, Allocator<ButtonKit>> ButtonKitArray;
74  typedef std::vector<CheckBoxKit, Allocator<CheckBoxKit>> CheckBoxKitArray;
75  typedef std::vector<RadioButtonKit, Allocator<RadioButtonKit>> RadioButtonKitArray;
76  typedef std::vector<ListBoxKit, Allocator<ListBoxKit>> ListBoxKitArray;
77  typedef std::vector<DropDownListKit, Allocator<DropDownListKit>> DropDownListKitArray;
78  typedef std::vector<SignatureFieldKit, Allocator<SignatureFieldKit>> SignatureFieldKitArray;
79  typedef std::vector<TextFieldKit, Allocator<TextFieldKit>> TextFieldKitArray;
80  typedef std::vector<SlideTableKit, 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, 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  private:
152  Annotation();
153  };
154 
156  class PUBLISH_API PRC
157  {
158  public:
161  enum class BRepCompression
162  {
163  None,
164  Low,
165  Medium,
166  High
167  };
168 
169  private:
171  PRC();
172  };
173 
175  class PUBLISH_API U3D
176  {
177  public:
180  enum class Version
181  {
182  ECMA1,
183  ECMA3
184  };
185 
186  private:
188  U3D();
189  };
190 
192  class PUBLISH_API Animation
193  {
194  public:
197  enum class Style
198  {
199  None,
200  Loop,
201  Bounce
202  };
203 
204  private:
206  Animation();
207  };
208 
210  class PUBLISH_API Activation
211  {
212  public:
215  enum class When
216  {
217  Explicit,
218  Opened,
219  Visible
220  };
221 
222  private:
224  Activation();
225  };
226 
228  class PUBLISH_API Deactivation
229  {
230  public:
233  enum class When
234  {
235  Explicit,
236  Closed,
237  NotVisible
238  };
239 
240  private:
242  Deactivation();
243  };
244 
246  class PUBLISH_API Lighting
247  {
248  public:
251  enum class Mode
252  {
253  Artwork,
254  None,
255  White,
256  Day,
257  Bright,
258  PrimaryColor,
259  Night,
260  Blue,
261  Red,
262  Cube,
263  CADOptimized,
264  Headlamp
265  };
266 
267  private:
269  Lighting();
270  };
271 
273  class PUBLISH_API Rendering
274  {
275  public:
278  enum class Mode
279  {
280  Solid,
281  SolidWireframe,
282  SolidOutline,
283  BoundingBox,
284  Transparent,
285  TransparentWireframe,
286  TransparentBoundingBox,
287  TransparentBoundingBoxOutline,
288  Illustration,
289  ShadedIllustration,
290  Wireframe,
291  ShadedWireframe,
292  HiddenWireframe,
293  Vertices,
294  ShadedVertices
295  };
296 
297  private:
299  Rendering();
300  };
301 
303  class PUBLISH_API Text
304  {
305  public:
307  class PUBLISH_API Font
308  {
309  public:
312  enum class Type
313  {
314  BuiltIn,
315  Explicit
316  };
317 
320  enum class Name
321  {
322  TimesRoman,
323  TimesItalic,
324  TimesBold,
325  TimesBoldItalic,
326  Helvetica,
327  HelveticaOblique,
328  HelveticaBold,
329  HelveticaBoldOblique,
330  Courier,
331  CourierOblique,
332  CourierBold,
333  CourierBoldOblique
334  };
335 
338  enum class Style
339  {
340  Regular,
341  Bold,
342  Italic,
343  BoldItalic,
344  };
345 
346  private:
348  Font();
349  };
350 
353  enum class Language
354  {
355  ASCII,
356  EastEuropeanRoman,
357  Cyrillic,
358  Greek,
359  Turkish,
360  Hebrew,
361  Arabic,
362  Baltic,
363  ChineseTraditional,
364  ChineseSimplified,
365  Japanese,
366  Korean
367  };
368 
371  enum class Rotation
372  {
373  None,
374  CounterClockwise90Degrees,
375  CounterClockwise180Degrees,
376  CounterClockwise270Degrees,
377  };
378 
379  private:
381  Text();
382  };
383 
385  class PUBLISH_API Image
386  {
387  public:
390  enum class Format
391  {
392  Unknown,
393  BMP,
394  PNG,
395  JPEG,
396  RawRGB,
397  RawRGBA,
398  RawGrey,
399  RawGreyA,
400  EMF,
401  URL,
402  GIF,
403  TIFF,
404  PCX,
405  Targa,
406  PPM,
407  ILBM,
408  CEL,
409  RGB,
410  PSD,
411  PIC
412  };
413 
414  private:
416  Image();
417  };
418 
420  class PUBLISH_API Field
421  {
422  public:
425  enum class Type
426  {
427  Text,
428  Button,
429  DropDown,
430  ListBox,
431  CheckBox,
432  RadioButton,
433  DigitalSignature,
434  BarCode
435  };
436 
437  private:
439  Field();
440  };
441 
442  typedef std::vector<Field::Type, Allocator<Field::Type>> FieldTypeArray;
443 
445  class PUBLISH_API Highlighting
446  {
447  public:
450  enum class Mode
451  {
452  None,
453  Invert,
454  Outline,
455  Push
456  };
457 
458  private:
460  Highlighting();
461  };
462 
464  class PUBLISH_API Artwork
465  {
466  public:
468  class PUBLISH_API View
469  {
470  public:
473  enum class Preference
474  {
475  Native,
476  PDF
477  };
478 
479  private:
481  View();
482  };
483 
485  class PUBLISH_API Display
486  {
487  public:
490  enum class Preference
491  {
492  Defined,
493  Runtime
494  };
495 
496  private:
498  Display();
499  };
500 
501  private:
503  Artwork();
504  };
505 
507  class PUBLISH_API Border
508  {
509  public:
512  enum class Thickness
513  {
514  Thin,
515  Medium,
516  Wide,
517  };
518 
521  enum class Style
522  {
523  Solid,
524  Dashed,
525  Beveled,
526  Inset,
527  Underlined,
528  };
529 
530  private:
532  Border();
533  };
534 
536  class PUBLISH_API Label
537  {
538  public:
541  enum class Position
542  {
543  LabelOnly,
544  IconOnly,
545  Top,
546  Bottom,
547  Left,
548  Right,
549  OnTop,
550  };
551 
552  private:
554  Label();
555  };
556 
557 
559  class PUBLISH_API Permission
560  {
561  public:
562  enum class Type
563  {
564  Open,
565  Secure,
566  Print,
567  Edit,
568  Copy,
569  EditNotes,
570  SaveAs,
571  FillAndSign,
572  Accessible,
573  Assembly,
574  HighQualityPrint,
575  Owner,
576  FormSubmit,
577  SpawnTemplate,
578  All,
579  };
580 
581  private:
583  Permission();
584  };
585 
586  typedef std::vector<Permission::Type, Allocator<Permission::Type> > PermissionTypeArray;
587 
588 
590  class PUBLISH_API DocumentKit : public Sprocket
591  {
592  public:
594  DocumentKit();
595 
598  DocumentKit(DocumentKit const & in_kit);
599 
602  DocumentKit(DocumentKit && in_kit);
603 
604  virtual ~DocumentKit();
605 
606  Type ObjectType() const { return Type::PublishDocumentKit; }
607 
611  static DocumentKit GetDefault();
612 
615  void Set(DocumentKit const & in_kit);
616 
619  void Show(DocumentKit & out_kit) const;
620 
624  DocumentKit & operator=(DocumentKit const & in_kit);
625 
629  DocumentKit & operator=(DocumentKit && in_kit);
630 
633  bool Empty() const;
634 
638  bool Equals(DocumentKit const & in_kit) const;
639 
643  bool operator==(DocumentKit const & in_kit) const;
644 
648  bool operator!=(DocumentKit const & in_kit) const;
649 
650 
660  DocumentKit & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
661 
666  DocumentKit & SetPasswords(char const * in_user_password, char const * in_owner_password);
667 
673  DocumentKit & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
674 
681  DocumentKit & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
682 
688  DocumentKit & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
689 
694  DocumentKit & AddAttachment(char const * in_filename, char const * in_description);
695 
701  DocumentKit & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
702 
707  DocumentKit & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
708 
713  DocumentKit & AddIconImage(char const * in_name, ImageKit const & in_image);
714 
720  DocumentKit & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
721 
726  DocumentKit & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
727 
732  DocumentKit & SetPage(PageKit const & in_page);
733 
738  DocumentKit & AddPage(PageKit const & in_page);
739 
745  DocumentKit & SetPages(size_t in_count, PageKit const in_pages[]);
746 
751  DocumentKit & SetPages(PageKitArray const & in_pages);
752 
758  DocumentKit & AddPages(size_t in_count, PageKit const in_pages[]);
759 
764  DocumentKit & AddPages(PageKitArray const & in_pages);
765 
770  DocumentKit & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
771 
775  DocumentKit & SetPermissions(PermissionTypeArray const & in_permissions);
776 
777 
780  DocumentKit & UnsetInformation();
781 
784  DocumentKit & UnsetPasswords();
785 
789  DocumentKit & UnsetJavaScript(char const * in_script_name);
790 
795  DocumentKit & UnsetJavaScript(size_t in_count, UTF8 const in_script_names[]);
796 
800  DocumentKit & UnsetJavaScript(UTF8Array const & in_script_names);
801 
804  DocumentKit & UnsetJavaScript();
805 
809  DocumentKit & UnsetAttachment(char const * in_filename);
810 
815  DocumentKit & UnsetAttachments(size_t in_count, UTF8 const in_filenames[]);
816 
820  DocumentKit & UnsetAttachments(UTF8Array const & in_filenames);
821 
824  DocumentKit & UnsetAttachments();
825 
829  DocumentKit & UnsetIconImage(char const * in_name);
830 
835  DocumentKit & UnsetIconImages(size_t in_count, UTF8 const in_names[]);
836 
840  DocumentKit & UnsetIconImages(UTF8Array const & in_names);
841 
844  DocumentKit & UnsetIconImages();
845 
849  DocumentKit & UnsetPage(size_t in_index);
850 
855  DocumentKit & UnsetPages(size_t in_count, size_t const in_indices[]);
856 
860  DocumentKit & UnsetPages(SizeTArray const & in_indices);
861 
864  DocumentKit & UnsetPages();
865 
868  DocumentKit & UnsetPermissions();
869 
872  DocumentKit & UnsetEverything();
873 
874 
881  bool ShowInformation(UTF8 & out_title, UTF8 & out_author, UTF8 & out_subject, UTF8 & out_creator) const;
882 
887  bool ShowPasswords(UTF8 & out_user_password, UTF8 & out_owner_password) const;
888 
895  bool ShowJavaScript(UTF8Array & out_script_names, UTF8Array & out_sources, SourceTypeArray & out_types) const;
896 
901  bool ShowAttachments(UTF8Array & out_filenames, UTF8Array & out_descriptions) const;
902 
907  bool ShowIconImages(UTF8Array & out_names, ImageKitArray & out_images) const;
908 
912  bool ShowPages(PageKitArray & out_pages) const;
913 
917  bool ShowPermissions(PermissionTypeArray & out_permissions) const;
918  };
919 
921  class PUBLISH_API PageKit : public Sprocket
922  {
923  public:
925  PageKit();
926 
930  PageKit(Page::Format in_format, Page::Orientation in_orientation);
931 
934  PageKit(char const * in_filename);
935 
938  PageKit(PageKit const & in_kit);
939 
942  PageKit(PageKit && in_kit);
943 
944  virtual ~PageKit();
945 
946  Type ObjectType() const { return Type::PublishPageKit; }
947 
951  static PageKit GetDefault();
952 
955  void Set(PageKit const & in_kit);
956 
959  void Show(PageKit & out_kit) const;
960 
964  PageKit & operator=(PageKit const & in_kit);
965 
969  PageKit & operator=(PageKit && in_kit);
970 
973  bool Empty() const;
974 
978  bool Equals(PageKit const & in_kit) const;
979 
983  bool operator==(PageKit const & in_kit) const;
984 
988  bool operator!=(PageKit const & in_kit) const;
989 
990 
995  PageKit & SetFormat(Page::Format in_format);
996 
1001  PageKit & SetOrientation(Page::Orientation in_orientation);
1002 
1007  PageKit & SetAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
1008 
1013  PageKit & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
1014 
1020  PageKit & SetAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
1021 
1026  PageKit & SetAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
1027 
1033  PageKit & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
1034 
1039  PageKit & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
1040 
1045  PageKit & SetText(TextKit const & in_text, IntRectangle const & in_location);
1046 
1051  PageKit & AddText(TextKit const & in_text, IntRectangle const & in_location);
1052 
1058  PageKit & SetText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
1059 
1064  PageKit & SetText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
1065 
1071  PageKit & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
1072 
1077  PageKit & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
1078 
1083  PageKit & SetImage(ImageKit const & in_image, IntRectangle const & in_location);
1084 
1089  PageKit & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
1090 
1096  PageKit & SetImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
1097 
1102  PageKit & SetImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
1103 
1109  PageKit & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
1110 
1115  PageKit & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
1116 
1121  PageKit & SetTable(TableKit const & in_table, IntRectangle const & in_location);
1122 
1127  PageKit & AddTable(TableKit const & in_table, IntRectangle const & in_location);
1128 
1134  PageKit & SetTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
1135 
1140  PageKit & SetTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
1141 
1147  PageKit & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
1148 
1153  PageKit & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
1154 
1159  PageKit & SetLink(LinkKit const & in_link, IntRectangle const & in_location);
1160 
1165  PageKit & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
1166 
1172  PageKit & SetLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
1173 
1178  PageKit & SetLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
1179 
1185  PageKit & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
1186 
1191  PageKit & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
1192 
1197  PageKit & SetButton(ButtonKit const & in_button, IntRectangle const & in_location);
1198 
1203  PageKit & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
1204 
1210  PageKit & SetButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
1211 
1216  PageKit & SetButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
1217 
1223  PageKit & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
1224 
1229  PageKit & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
1230 
1235  PageKit & SetTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
1236 
1241  PageKit & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
1242 
1248  PageKit & SetTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
1249 
1254  PageKit & SetTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
1255 
1261  PageKit & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
1262 
1267  PageKit & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
1268 
1273  PageKit & SetSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
1274 
1279  PageKit & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
1280 
1286  PageKit & SetSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
1287 
1292  PageKit & SetSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
1293 
1299  PageKit & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
1300 
1305  PageKit & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
1306 
1311  PageKit & SetCheckBox(CheckBoxKit const & in_checkbox, IntRectangle const & in_location);
1312 
1317  PageKit & AddCheckBox(CheckBoxKit const & in_checkbox, IntRectangle const & in_location);
1318 
1324  PageKit & SetCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]);
1325 
1330  PageKit & SetCheckBoxes(CheckBoxKitArray const & in_checkbox, IntRectangleArray const & in_locations);
1331 
1337  PageKit & AddCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[]);
1338 
1343  PageKit & AddCheckBoxes(CheckBoxKitArray const & in_checkbox, IntRectangleArray const & in_locations);
1344 
1349  PageKit & SetRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
1350 
1355  PageKit & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
1356 
1362  PageKit & SetRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
1363 
1368  PageKit & SetRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
1369 
1375  PageKit & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
1376 
1381  PageKit & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
1382 
1387  PageKit & SetListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
1388 
1393  PageKit & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
1394 
1400  PageKit & SetListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]);
1401 
1406  PageKit & SetListBoxes(ListBoxKitArray const & in_list_box, IntRectangleArray const & in_locations);
1407 
1413  PageKit & AddListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[]);
1414 
1419  PageKit & AddListBoxes(ListBoxKitArray const & in_list_box, IntRectangleArray const & in_locations);
1420 
1425  PageKit & SetDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
1426 
1431  PageKit & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
1432 
1438  PageKit & SetDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]);
1439 
1444  PageKit & SetDropDownLists(DropDownListKitArray const & in_drop_down_list, IntRectangleArray const & in_locations);
1445 
1451  PageKit & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[]);
1452 
1457  PageKit & AddDropDownLists(DropDownListKitArray const & in_drop_down_list, IntRectangleArray const & in_locations);
1458 
1463  PageKit & SetSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
1464 
1469  PageKit & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
1470 
1476  PageKit & SetSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]);
1477 
1482  PageKit & SetSignatureFields(SignatureFieldKitArray const & in_signature_field, IntRectangleArray const & in_locations);
1483 
1489  PageKit & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[]);
1490 
1495  PageKit & AddSignatureFields(SignatureFieldKitArray const & in_signature_field, IntRectangleArray const & in_locations);
1496 
1500  PageKit & SetTemplateFile(char const * in_filename);
1501 
1507  PageKit & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
1508 
1515  PageKit & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
1516 
1522  PageKit & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
1523 
1529  PageKit & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
1530 
1537  PageKit & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
1538 
1544  PageKit & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
1545 
1551  PageKit & SetButtonLabelByField(char const * in_field, char const * in_label);
1552 
1559  PageKit & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
1560 
1566  PageKit & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
1567 
1574  PageKit & SetListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
1575 
1582  PageKit & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
1583 
1591  PageKit & SetListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
1592 
1599  PageKit & SetListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
1600 
1608  PageKit & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
1609 
1616  PageKit & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
1617 
1625  PageKit & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
1626 
1635  PageKit & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
1636 
1644  PageKit & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
1645 
1651  PageKit & SetVisibilityByField(char const * in_field, bool in_state);
1652 
1659  PageKit & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
1660 
1666  PageKit & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
1667 
1673  PageKit & SetTextValueByField(char const * in_field, char const * in_value);
1674 
1681  PageKit & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
1682 
1688  PageKit & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
1689 
1690 
1693  PageKit & UnsetFormat();
1694 
1697  PageKit & UnsetOrientation();
1698 
1702  PageKit & UnsetAnnotation(size_t in_index);
1703 
1708  PageKit & UnsetAnnotations(size_t in_count, size_t const in_indices[]);
1709 
1713  PageKit & UnsetAnnotations(SizeTArray const & in_indices);
1714 
1717  PageKit & UnsetAnnotations();
1718 
1722  PageKit & UnsetText(size_t in_index);
1723 
1728  PageKit & UnsetText(size_t in_count, size_t const in_indices[]);
1729 
1733  PageKit & UnsetText(SizeTArray const & in_indices);
1734 
1737  PageKit & UnsetText();
1738 
1742  PageKit & UnsetCheckBox(size_t in_index);
1743 
1748  PageKit & UnsetCheckBoxes(size_t in_count, size_t const in_indices[]);
1749 
1753  PageKit & UnsetCheckBoxes(SizeTArray const & in_indices);
1754 
1757  PageKit & UnsetCheckBoxes();
1758 
1762  PageKit & UnsetRadioButton(size_t in_index);
1763 
1768  PageKit & UnsetRadioButtons(size_t in_count, size_t const in_indices[]);
1769 
1773  PageKit & UnsetRadioButtons(SizeTArray const & in_indices);
1774 
1777  PageKit & UnsetRadioButtons();
1778 
1782  PageKit & UnsetListBox(size_t in_index);
1783 
1788  PageKit & UnsetListBoxes(size_t in_count, size_t const in_indices[]);
1789 
1793  PageKit & UnsetListBoxes(SizeTArray const & in_indices);
1794 
1797  PageKit & UnsetListBoxes();
1798 
1802  PageKit & UnsetDropDownList(size_t in_index);
1803 
1808  PageKit & UnsetDropDownLists(size_t in_count, size_t const in_indices[]);
1809 
1813  PageKit & UnsetDropDownLists(SizeTArray const & in_indices);
1814 
1817  PageKit & UnsetDropDownLists();
1818 
1822  PageKit & UnsetSignatureField(size_t in_index);
1823 
1828  PageKit & UnsetSignatureFields(size_t in_count, size_t const in_indices[]);
1829 
1833  PageKit & UnsetSignatureFields(SizeTArray const & in_indices);
1834 
1837  PageKit & UnsetSignatureFields();
1838 
1842  PageKit & UnsetImage(size_t in_index);
1843 
1848  PageKit & UnsetImages(size_t in_count, size_t const in_indices[]);
1849 
1853  PageKit & UnsetImages(SizeTArray const & in_indices);
1854 
1857  PageKit & UnsetImages();
1858 
1862  PageKit & UnsetTable(size_t in_index);
1863 
1868  PageKit & UnsetTables(size_t in_count, size_t const in_indices[]);
1869 
1873  PageKit & UnsetTables(SizeTArray const & in_indices);
1874 
1877  PageKit & UnsetTables();
1878 
1882  PageKit & UnsetLink(size_t in_index);
1883 
1888  PageKit & UnsetLinks(size_t in_count, size_t const in_indices[]);
1889 
1893  PageKit & UnsetLinks(SizeTArray const & in_indices);
1894 
1897  PageKit & UnsetLinks();
1898 
1902  PageKit & UnsetButton(size_t in_index);
1903 
1908  PageKit & UnsetButtons(size_t in_count, size_t const in_indices[]);
1909 
1913  PageKit & UnsetButtons(SizeTArray const & in_indices);
1914 
1917  PageKit & UnsetButtons();
1918 
1922  PageKit & UnsetTextField(size_t in_index);
1923 
1928  PageKit & UnsetTextFields(size_t in_count, size_t const in_indices[]);
1929 
1933  PageKit & UnsetTextFields(SizeTArray const & in_indices);
1934 
1937  PageKit & UnsetTextFields();
1938 
1942  PageKit & UnsetSlideTable(size_t in_index);
1943 
1948  PageKit & UnsetSlideTables(size_t in_count, size_t const in_indices[]);
1949 
1953  PageKit & UnsetSlideTables(SizeTArray const & in_indices);
1954 
1957  PageKit & UnsetSlideTables();
1958 
1961  PageKit & UnsetTemplateFile();
1962 
1966  PageKit & UnsetAnnotationByField(char const * in_field);
1967 
1972  PageKit & UnsetAnnotationsByField(size_t in_count, UTF8 const in_fields[]);
1973 
1977  PageKit & UnsetAnnotationsByField(UTF8Array const & in_fields);
1978 
1981  PageKit & UnsetAnnotationsByField();
1982 
1986  PageKit & UnsetButtonIconByField(char const * in_field);
1987 
1992  PageKit & UnsetButtonIconsByField(size_t in_count, UTF8 const in_fields[]);
1993 
1997  PageKit & UnsetButtonIconsByField(UTF8Array const & in_fields);
1998 
2001  PageKit & UnsetButtonIconsByField();
2002 
2006  PageKit & UnsetButtonLabelByField(char const * in_field);
2007 
2012  PageKit & UnsetButtonLabelsByField(size_t in_count, UTF8 const in_fields[]);
2013 
2017  PageKit & UnsetButtonLabelsByField(UTF8Array const & in_fields);
2018 
2021  PageKit & UnsetButtonLabelsByField();
2022 
2027  PageKit & UnsetListItemByField(char const * in_field, size_t in_index);
2028 
2034  PageKit & UnsetListItemsByField(char const * in_field, size_t in_count, size_t const in_indices[]);
2035 
2040  PageKit & UnsetListItemsByField(char const * in_field, SizeTArray const & in_indices);
2041 
2045  PageKit & UnsetListItemsByField(char const * in_field);
2046 
2051  PageKit & UnsetListItemsByField(size_t in_count, UTF8 const in_fields[]);
2052 
2056  PageKit & UnsetListItemsByField(UTF8Array const & in_fields);
2057 
2060  PageKit & UnsetListItemsByField();
2061 
2065  PageKit & UnsetJavaScriptActionByField(char const * in_field);
2066 
2071  PageKit & UnsetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[]);
2072 
2076  PageKit & UnsetJavaScriptActionsByField(UTF8Array const & in_fields);
2077 
2080  PageKit & UnsetJavaScriptActionsByField();
2081 
2085  PageKit & UnsetVisibilityByField(char const * in_field);
2086 
2091  PageKit & UnsetVisibilitiesByField(size_t in_count, UTF8 const in_fields[]);
2092 
2096  PageKit & UnsetVisibilitiesByField(UTF8Array const & in_fields);
2097 
2100  PageKit & UnsetVisibilitiesByField();
2101 
2105  PageKit & UnsetTextValueByField(char const * in_field);
2106 
2111  PageKit & UnsetTextValuesByField(size_t in_count, UTF8 const in_fields[]);
2112 
2116  PageKit & UnsetTextValuesByField(UTF8Array const & in_fields);
2117 
2120  PageKit & UnsetTextValuesByField();
2121 
2124  PageKit & UnsetEverything();
2125 
2126 
2130  bool ShowFormat(Page::Format & out_format) const;
2131 
2135  bool ShowOrientation(Page::Orientation & out_orientation) const;
2136 
2141  bool ShowAnnotations(AnnotationKitArray & out_annotations, IntRectangleArray & out_locations) const;
2142 
2147  bool ShowText(TextKitArray & out_text, IntRectangleArray & out_locations) const;
2148 
2153  bool ShowImages(ImageKitArray & out_images, IntRectangleArray & out_locations) const;
2154 
2159  bool ShowTables(TableKitArray & out_tables, IntRectangleArray & out_locations) const;
2160 
2165  bool ShowLinks(LinkKitArray & out_links, IntRectangleArray & out_locations) const;
2166 
2171  bool ShowButtons(ButtonKitArray & out_buttons, IntRectangleArray & out_locations) const;
2172 
2177  bool ShowCheckBoxes(CheckBoxKitArray & out_check_boxes, IntRectangleArray & out_locations) const;
2178 
2183  bool ShowRadioButtons(RadioButtonKitArray & out_radio_buttons, IntRectangleArray & out_locations) const;
2184 
2189  bool ShowListBoxes(ListBoxKitArray & out_list_boxes, IntRectangleArray & out_locations) const;
2190 
2195  bool ShowDropDownLists(DropDownListKitArray & out_drop_down_lists, IntRectangleArray & out_locations) const;
2196 
2201  bool ShowSignatureFields(SignatureFieldKitArray & out_signature_fields, IntRectangleArray & out_locations) const;
2202 
2207  bool ShowTextFields(TextFieldKitArray & out_text_fields, IntRectangleArray & out_locations) const;
2208 
2213  bool ShowSlideTables(SlideTableKitArray & out_slide_tables, IntRectangleArray & out_locations) const;
2214 
2218  bool ShowTemplateFile(UTF8 & out_filename) const;
2219 
2224  bool ShowAnnotationsByField(UTF8Array & out_fields, AnnotationKitArray & out_annotations) const;
2225 
2230  bool ShowButtonIconsByField(UTF8Array & out_fields, ImageKitArray & out_images) const;
2231 
2236  bool ShowButtonLabelsByField(UTF8Array & out_fields, UTF8Array & out_labels) const;
2237 
2241  bool ShowListItemFields(UTF8Array & out_fields) const;
2242 
2248  bool ShowListItemsByField(char const * in_field, UTF8Array & out_values, UTF8Array & out_export_values) const;
2249 
2255  bool ShowJavaScriptActionsByField(UTF8Array & out_fields, UTF8Array & out_sources, SourceTypeArray & out_types) const;
2256 
2261  bool ShowVisibilitiesByField(UTF8Array & out_fields, BoolArray & out_states) const;
2262 
2267  bool ShowTextValuesByField(UTF8Array & out_fields, UTF8Array & out_values) const;
2268  };
2269 
2271  class PUBLISH_API AnnotationKit : public Sprocket
2272  {
2273  public:
2275  AnnotationKit();
2276 
2279  AnnotationKit(SprocketPath const & in_source);
2280 
2283  AnnotationKit(AnnotationKit const & in_kit);
2284 
2287  AnnotationKit(AnnotationKit && in_kit);
2288 
2289  virtual ~AnnotationKit();
2290 
2291  Type ObjectType() const { return Type::PublishAnnotationKit; }
2292 
2296  static AnnotationKit GetDefault();
2297 
2300  void Set(AnnotationKit const & in_kit);
2301 
2304  void Show(AnnotationKit & out_kit) const;
2305 
2309  AnnotationKit & operator=(AnnotationKit const & in_kit);
2310 
2314  AnnotationKit & operator=(AnnotationKit && in_kit);
2315 
2318  bool Empty() const;
2319 
2323  bool Equals(AnnotationKit const & in_kit) const;
2324 
2328  bool operator==(AnnotationKit const & in_kit) const;
2329 
2333  bool operator!=(AnnotationKit const & in_kit) const;
2334 
2335 
2339  AnnotationKit & SetSource(SprocketPath const & in_source);
2340 
2344  AnnotationKit & SetFormat(Annotation::Format in_format);
2345 
2350  AnnotationKit & SetPRCTessellationCompression(bool in_state);
2351 
2356  AnnotationKit & SetPRCBRepCompression(PRC::BRepCompression in_level);
2357 
2362  AnnotationKit & SetPRCBRepRemoval(bool in_state);
2363 
2368  AnnotationKit & SetPRCAttributeRemoval(bool in_state);
2369 
2374  AnnotationKit & SetU3DVersion(U3D::Version in_version);
2375 
2380  AnnotationKit & SetU3DCompression(unsigned char in_level);
2381 
2385  AnnotationKit & SetName(char const * in_name);
2386 
2390  AnnotationKit & SetArtwork(ArtworkKit const & in_artwork);
2391 
2395  AnnotationKit & SetActivation(Activation::When in_when);
2396 
2400  AnnotationKit & SetDeactivation(Deactivation::When in_when);
2401 
2405  AnnotationKit & SetToolbarVisibility(bool in_state);
2406 
2410  AnnotationKit & SetModelTreeVisibility(bool in_state);
2411 
2415  AnnotationKit & SetInteractivity(bool in_state);
2416 
2420  AnnotationKit & SetBorderWidth(int in_width);
2421 
2426  AnnotationKit & SetTransparentBackground(bool in_state);
2427 
2431  AnnotationKit & SetBackgroundColor(RGBColor const & in_color);
2432 
2436  AnnotationKit & SetLighting(Lighting::Mode in_mode);
2437 
2441  AnnotationKit & SetRendering(Rendering::Mode in_mode);
2442 
2446  AnnotationKit & SetPosterImage(ImageKit const & in_image);
2447 
2455  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);
2456 
2463  AnnotationKit & SetCarouselButtons(UTF8Array const & in_button_names, char const * in_previous_button_name, char const * in_next_button_name, size_t in_scroll_size);
2464 
2472  AnnotationKit & SetCarouselViews(size_t in_count, size_t const in_indices[], ImageKit const in_images[] = nullptr);
2473 
2480  AnnotationKit & SetCarouselViews(SizeTArray const & in_indices, ImageKitArray const & in_images = ImageKitArray());
2481 
2482 
2485  AnnotationKit & UnsetSource();
2486 
2489  AnnotationKit & UnsetFormat();
2490 
2493  AnnotationKit & UnsetPRCTessellationCompression();
2494 
2497  AnnotationKit & UnsetPRCBRepCompression();
2498 
2501  AnnotationKit & UnsetPRCBRepRemoval();
2502 
2505  AnnotationKit & UnsetPRCAttributeRemoval();
2506 
2509  AnnotationKit & UnsetU3DVersion();
2510 
2513  AnnotationKit & UnsetU3DCompression();
2514 
2517  AnnotationKit & UnsetName();
2518 
2521  AnnotationKit & UnsetArtwork();
2522 
2525  AnnotationKit & UnsetActivation();
2526 
2529  AnnotationKit & UnsetDeactivation();
2530 
2533  AnnotationKit & UnsetToolbarVisibility();
2534 
2537  AnnotationKit & UnsetModelTreeVisibility();
2538 
2541  AnnotationKit & UnsetInteractivity();
2542 
2545  AnnotationKit & UnsetBorderWidth();
2546 
2549  AnnotationKit & UnsetTransparentBackground();
2550 
2553  AnnotationKit & UnsetBackgroundColor();
2554 
2557  AnnotationKit & UnsetLighting();
2558 
2561  AnnotationKit & UnsetRendering();
2562 
2565  AnnotationKit & UnsetPosterImage();
2566 
2569  AnnotationKit & UnsetCarouselButtons();
2570 
2573  AnnotationKit & UnsetCarouselViews();
2574 
2577  AnnotationKit & UnsetEverything();
2578 
2579 
2583  bool ShowSource(SprocketPath & out_source) const;
2584 
2588  bool ShowFormat(Annotation::Format & out_format) const;
2589 
2593  bool ShowPRCTessellationCompression(bool & out_state) const;
2594 
2598  bool ShowPRCBRepCompression(PRC::BRepCompression & out_level) const;
2599 
2603  bool ShowPRCBRepRemoval(bool & out_state) const;
2604 
2608  bool ShowPRCAttributeRemoval(bool & out_state) const;
2609 
2613  bool ShowU3DVersion(U3D::Version & out_version) const;
2614 
2618  bool ShowU3DCompression(unsigned char & out_level) const;
2619 
2623  bool ShowName(UTF8 & out_name) const;
2624 
2628  bool ShowArtwork(ArtworkKit & out_artwork) const;
2629 
2633  bool ShowActivation(Activation::When & out_when) const;
2634 
2638  bool ShowDeactivation(Deactivation::When & out_when) const;
2639 
2643  bool ShowToolbarVisibility(bool & out_state) const;
2644 
2648  bool ShowModelTreeVisibility(bool & out_state) const;
2649 
2653  bool ShowInteractivity(bool & out_state) const;
2654 
2658  bool ShowBorderWidth(int & out_width) const;
2659 
2663  bool ShowTransparentBackground(bool & out_state) const;
2664 
2668  bool ShowBackgroundColor(RGBColor & out_color) const;
2669 
2673  bool ShowLighting(Lighting::Mode & out_mode) const;
2674 
2678  bool ShowRendering(Rendering::Mode & out_mode) const;
2679 
2683  bool ShowPosterImage(ImageKit & out_image) const;
2684 
2691  bool ShowCarouselButtons(UTF8Array & out_button_names, UTF8 & out_previous_button_name, UTF8 & out_next_button_name, size_t & out_scroll_size) const;
2692 
2697  bool ShowCarouselViews(SizeTArray & out_indices, ImageKitArray & out_images) const;
2698  };
2699 
2701  class PUBLISH_API ArtworkKit : public Sprocket
2702  {
2703  public:
2705  ArtworkKit();
2706 
2709  ArtworkKit(ArtworkKit const & in_kit);
2710 
2713  ArtworkKit(ArtworkKit && in_kit);
2714 
2715  virtual ~ArtworkKit();
2716 
2717  Type ObjectType() const { return Type::PublishArtworkKit; }
2718 
2722  static ArtworkKit GetDefault();
2723 
2726  void Set(ArtworkKit const & in_kit);
2727 
2730  void Show(ArtworkKit & out_kit) const;
2731 
2735  ArtworkKit & operator=(ArtworkKit const & in_kit);
2736 
2740  ArtworkKit & operator=(ArtworkKit && in_kit);
2741 
2744  bool Empty() const;
2745 
2749  bool Equals(ArtworkKit const & in_kit) const;
2750 
2754  bool operator==(ArtworkKit const & in_kit) const;
2755 
2759  bool operator!=(ArtworkKit const & in_kit) const;
2760 
2761 
2765  ArtworkKit & SetAnimationStyle(Animation::Style in_style);
2766 
2771  ArtworkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
2772 
2776  ArtworkKit & SetPMICrossHighlighting(bool in_state);
2777 
2781  ArtworkKit & SetPMISemanticInformation(bool in_state);
2782 
2786  ArtworkKit & SetDefaultViewPreference(Artwork::View::Preference in_preference);
2787 
2791  ArtworkKit & SetDisplayPreference(Artwork::Display::Preference in_preference);
2792 
2796  ArtworkKit & SetView(ViewKit const & in_view);
2797 
2801  ArtworkKit & AddView(ViewKit const & in_view);
2802 
2807  ArtworkKit & SetViews(size_t in_count, ViewKit const in_views[]);
2808 
2812  ArtworkKit & SetViews(ViewKitArray const & in_views);
2813 
2818  ArtworkKit & AddViews(size_t in_count, ViewKit const in_views[]);
2819 
2823  ArtworkKit & AddViews(ViewKitArray const & in_views);
2824 
2828  ArtworkKit & SetPMIColor(RGBColor const & in_pmi_color);
2829 
2830 
2833  ArtworkKit & UnsetAnimationStyle();
2834 
2837  ArtworkKit & UnsetJavaScript();
2838 
2841  ArtworkKit & UnsetPMICrossHighlighting();
2842 
2845  ArtworkKit & UnsetPMISemanticInformation();
2846 
2849  ArtworkKit & UnsetDefaultViewPreference();
2850 
2853  ArtworkKit & UnsetDisplayPreference();
2854 
2858  ArtworkKit & UnsetView(size_t in_index);
2859 
2864  ArtworkKit & UnsetViews(size_t in_count, size_t const in_indices[]);
2865 
2869  ArtworkKit & UnsetViews(SizeTArray const & in_indices);
2870 
2873  ArtworkKit & UnsetViews();
2874 
2877  ArtworkKit & UnsetPMIColor();
2878 
2881  ArtworkKit & UnsetEverything();
2882 
2883 
2887  bool ShowAnimationStyle(Animation::Style & out_style) const;
2888 
2893  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
2894 
2898  bool ShowPMICrossHighlighting(bool & out_state) const;
2899 
2903  bool ShowPMISemanticInformation(bool & out_state) const;
2904 
2908  bool ShowDefaultViewPreference(Artwork::View::Preference & out_preference) const;
2909 
2913  bool ShowDisplayPreference(Artwork::Display::Preference & out_preference) const;
2914 
2918  bool ShowViews(ViewKitArray & out_views) const;
2919 
2923  bool ShowPMIColor(RGBColor & out_pmi_color) const;
2924  };
2925 
2927  class PUBLISH_API ViewKit : public Sprocket
2928  {
2929  public:
2931  ViewKit();
2932 
2935  ViewKit(ViewKit const & in_kit);
2936 
2939  ViewKit(ViewKit && in_kit);
2940 
2941  virtual ~ViewKit();
2942 
2943  Type ObjectType() const { return Type::PublishViewKit; }
2944 
2948  static ViewKit GetDefault();
2949 
2952  void Set(ViewKit const & in_kit);
2953 
2956  void Show(ViewKit & out_kit) const;
2957 
2961  ViewKit & operator=(ViewKit const & in_kit);
2962 
2966  ViewKit & operator=(ViewKit && in_kit);
2967 
2970  bool Empty() const;
2971 
2975  bool Equals(ViewKit const & in_kit) const;
2976 
2980  bool operator==(ViewKit const & in_kit) const;
2981 
2985  bool operator!=(ViewKit const & in_kit) const;
2986 
2987 
2991  ViewKit & SetInternalName(char const * in_name);
2992 
2996  ViewKit & SetExternalName(char const * in_name);
2997 
3006  ViewKit & SetCamera(CameraKit const & in_camera);
3007 
3011  ViewKit & SetDefault(bool in_state);
3012 
3016  ViewKit & SetBackgroundColor(RGBColor const & in_color);
3017 
3021  ViewKit & SetLighting(Lighting::Mode in_mode);
3022 
3026  ViewKit & SetRendering(Rendering::Mode in_mode);
3027 
3028 
3031  ViewKit & UnsetInternalName();
3032 
3035  ViewKit & UnsetExternalName();
3036 
3039  ViewKit & UnsetCamera();
3040 
3043  ViewKit & UnsetDefault();
3044 
3047  ViewKit & UnsetBackgroundColor();
3048 
3051  ViewKit & UnsetLighting();
3052 
3055  ViewKit & UnsetRendering();
3056 
3059  ViewKit & UnsetEverything();
3060 
3061 
3065  bool ShowInternalName(UTF8 & out_name) const;
3066 
3070  bool ShowExternalName(UTF8 & out_name) const;
3071 
3075  bool ShowCamera(CameraKit & out_camera) const;
3076 
3080  bool ShowDefault(bool & out_state) const;
3081 
3085  bool ShowBackgroundColor(RGBColor & out_color) const;
3086 
3090  bool ShowLighting(Lighting::Mode & out_mode) const;
3091 
3095  bool ShowRendering(Rendering::Mode & out_mode) const;
3096  };
3097 
3099  class PUBLISH_API TextKit : public Sprocket
3100  {
3101  public:
3103  TextKit();
3104 
3107  TextKit(TextKit const & in_kit);
3108 
3111  TextKit(TextKit && in_kit);
3112 
3113  virtual ~TextKit();
3114 
3115  Type ObjectType() const { return Type::PublishTextKit; }
3116 
3120  static TextKit GetDefault();
3121 
3124  void Set(TextKit const & in_kit);
3125 
3128  void Show(TextKit & out_kit) const;
3129 
3133  TextKit & operator=(TextKit const & in_kit);
3134 
3138  TextKit & operator=(TextKit && in_kit);
3139 
3142  bool Empty() const;
3143 
3147  bool Equals(TextKit const & in_kit) const;
3148 
3152  bool operator==(TextKit const & in_kit) const;
3153 
3157  bool operator!=(TextKit const & in_kit) const;
3158 
3159 
3164  TextKit & SetText(char const * in_text);
3165 
3169  TextKit & SetFont(Text::Font::Name in_font);
3170 
3176  TextKit & SetFont(char const * in_font_name, Text::Language in_language, bool in_embed_font);
3177 
3182  TextKit & SetSize(int in_size);
3183 
3188  TextKit & SetColor(RGBColor const & in_color);
3189 
3190 
3193  TextKit & UnsetText();
3194 
3197  TextKit & UnsetFont();
3198 
3201  TextKit & UnsetSize();
3202 
3205  TextKit & UnsetColor();
3206 
3209  TextKit & UnsetEverything();
3210 
3211 
3215  bool ShowText(UTF8 & out_text) const;
3216 
3224  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;
3225 
3229  bool ShowSize(int & out_size) const;
3230 
3234  bool ShowColor(RGBColor & out_color) const;
3235  };
3236 
3238  class PUBLISH_API ImageKit : public Sprocket
3239  {
3240  public:
3242  ImageKit();
3243 
3246  ImageKit(ImageKit const & in_kit);
3247 
3250  ImageKit(ImageKit && in_kit);
3251 
3252  virtual ~ImageKit();
3253 
3254  Type ObjectType() const { return Type::PublishImageKit; }
3255 
3256  // no GetDefault() since function doesn't make sense for this class
3257 
3260  void Set(ImageKit const & in_kit);
3261 
3264  void Show(ImageKit & out_kit) const;
3265 
3269  ImageKit & operator=(ImageKit const & in_kit);
3270 
3274  ImageKit & operator=(ImageKit && in_kit);
3275 
3278  bool Empty() const;
3279 
3283  bool Equals(ImageKit const & in_kit) const;
3284 
3288  bool operator==(ImageKit const & in_kit) const;
3289 
3293  bool operator!=(ImageKit const & in_kit) const;
3294 
3295 
3299  ImageKit & SetFile(char const * in_filename);
3300 
3306  ImageKit & SetSize(int in_width, int in_height);
3307 
3311  ImageKit & SetFormat(Image::Format in_format);
3312 
3313 
3316  ImageKit & UnsetFile();
3317 
3320  ImageKit & UnsetSize();
3321 
3324  ImageKit & UnsetFormat();
3325 
3328  ImageKit & UnsetEverything();
3329 
3330 
3334  bool ShowFile(UTF8 & out_filename) const;
3335 
3340  bool ShowSize(int & out_width, int & out_height) const;
3341 
3345  bool ShowFormat(Image::Format & out_format) const;
3346  };
3347 
3350  class PUBLISH_API TableKit : public Sprocket
3351  {
3352  public:
3354  TableKit();
3355 
3358  TableKit(TableKit const & in_kit);
3359 
3362  TableKit(TableKit && in_kit);
3363 
3364  virtual ~TableKit();
3365 
3366  Type ObjectType() const { return Type::PublishTableKit; }
3367 
3368  // no GetDefault() since function doesn't make sense for this class
3369 
3372  void Set(TableKit const & in_kit);
3373 
3376  void Show(TableKit & out_kit) const;
3377 
3381  TableKit & operator=(TableKit const & in_kit);
3382 
3386  TableKit & operator=(TableKit && in_kit);
3387 
3390  bool Empty() const;
3391 
3395  bool Equals(TableKit const & in_kit) const;
3396 
3400  bool operator==(TableKit const & in_kit) const;
3401 
3405  bool operator!=(TableKit const & in_kit) const;
3406 
3407 
3412  TableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3413 
3418  TableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3419 
3425  TableKit & SetLink(int in_row, int in_column, LinkKit const & in_link);
3426 
3432  TableKit & SetText(int in_row, int in_column, TextKit const & in_text);
3433 
3439  TableKit & SetButton(int in_row, int in_column, ButtonKit const & in_button);
3440 
3446  TableKit & SetTextField(int in_row, int in_column, TextFieldKit const & in_text_field);
3447 
3448 
3451  TableKit & UnsetHTML();
3452 
3455  TableKit & UnsetHTMLStyle();
3456 
3459  TableKit & UnsetLink(int in_row, int in_column);
3460 
3463  TableKit & UnsetText(int in_row, int in_column);
3464 
3467  TableKit & UnsetButton(int in_row, int in_column);
3468 
3471  TableKit & UnsetTextField(int in_row, int in_column);
3472 
3475  TableKit & UnsetEverything();
3476 
3477 
3482  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3483 
3488  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3489 
3495  bool ShowLink(int in_row, int in_column, LinkKit & out_link) const;
3496 
3502  bool ShowText(int in_row, int in_column, TextKit & out_text) const;
3503 
3509  bool ShowButton(int in_row, int in_column, ButtonKit & out_button) const;
3510 
3516  bool ShowTextField(int in_row, int in_column, TextFieldKit & out_text_field) const;
3517  };
3518 
3521  class PUBLISH_API SlideTableKit : public Sprocket
3522  {
3523  public:
3525  SlideTableKit();
3526 
3529  SlideTableKit(SlideTableKit const & in_kit);
3530 
3533  SlideTableKit(SlideTableKit && in_kit);
3534 
3535  virtual ~SlideTableKit();
3536 
3537  Type ObjectType() const { return Type::PublishSlideTableKit; }
3538 
3539  // no GetDefault() since function doesn't make sense for this class
3540 
3543  void Set(SlideTableKit const & in_kit);
3544 
3547  void Show(SlideTableKit & out_kit) const;
3548 
3552  SlideTableKit & operator=(SlideTableKit const & in_kit);
3553 
3557  SlideTableKit & operator=(SlideTableKit && in_kit);
3558 
3561  bool Empty() const;
3562 
3566  bool Equals(SlideTableKit const & in_kit) const;
3567 
3571  bool operator==(SlideTableKit const & in_kit) const;
3572 
3576  bool operator!=(SlideTableKit const & in_kit) const;
3577 
3578 
3583  SlideTableKit & SetHTML(char const * in_source, Source::Type in_type = Source::Type::Code);
3584 
3589  SlideTableKit & SetHTMLStyle(char const * in_source, Source::Type in_type = Source::Type::Code);
3590 
3595  SlideTableKit & SetButtons(char const * in_previous_button_name, char const * in_next_button_name);
3596 
3602  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKit const in_text[]);
3603 
3609  SlideTableKit & SetText(size_t in_rows, size_t in_columns, TextFieldKitArray const & in_text);
3610 
3614  SlideTableKit & SetHeader(bool in_state);
3615 
3616 
3619  SlideTableKit & UnsetHTML();
3620 
3623  SlideTableKit & UnsetHTMLStyle();
3624 
3627  SlideTableKit & UnsetButtons();
3628 
3631  SlideTableKit & UnsetText();
3632 
3635  SlideTableKit & UnsetHeader();
3636 
3639  SlideTableKit & UnsetEverything();
3640 
3641 
3646  bool ShowHTML(UTF8 & out_source, Source::Type & out_type) const;
3647 
3652  bool ShowHTMLStyle(UTF8 & out_source, Source::Type & out_type) const;
3653 
3658  bool ShowButtons(UTF8 & out_previous_button_name, UTF8 & out_next_button_name) const;
3659 
3665  bool ShowText(size_t & out_rows, size_t & out_columns, TextFieldKitArray & out_text) const;
3666 
3670  bool ShowHeader(bool & out_state) const;
3671  };
3672 
3674  class PUBLISH_API LinkKit : public Sprocket
3675  {
3676  public:
3678  LinkKit();
3679 
3682  LinkKit(LinkKit const & in_kit);
3683 
3686  LinkKit(LinkKit && in_kit);
3687 
3688  virtual ~LinkKit();
3689 
3690  Type ObjectType() const { return Type::PublishLinkKit; }
3691 
3692  // no GetDefault() since function doesn't make sense for this class
3693 
3696  void Set(LinkKit const & in_kit);
3697 
3700  void Show(LinkKit & out_kit) const;
3701 
3705  LinkKit & operator=(LinkKit const & in_kit);
3706 
3710  LinkKit & operator=(LinkKit && in_kit);
3711 
3714  bool Empty() const;
3715 
3719  bool Equals(LinkKit const & in_kit) const;
3720 
3724  bool operator==(LinkKit const & in_kit) const;
3725 
3729  bool operator!=(LinkKit const & in_kit) const;
3730 
3731 
3736  LinkKit & SetJavaScript(char const * in_source, Source::Type in_type = Source::Type::Code);
3737 
3741  LinkKit & SetBorderWidth(int in_width);
3742 
3746  LinkKit & SetHighlighting(Highlighting::Mode in_mode);
3747 
3751  LinkKit & SetBorderColor(RGBColor const & in_color);
3752 
3753 
3756  LinkKit & UnsetJavaScript();
3757 
3760  LinkKit & UnsetBorderWidth();
3761 
3764  LinkKit & UnsetHighlighting();
3765 
3768  LinkKit & UnsetBorderColor();
3769 
3772  LinkKit & UnsetEverything();
3773 
3774 
3779  bool ShowJavaScript(UTF8 & out_source, Source::Type & out_type) const;
3780 
3784  bool ShowBorderWidth(int & out_width) const;
3785 
3789  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
3790 
3794  bool ShowBorderColor(RGBColor & out_color) const;
3795  };
3796 
3798  class PUBLISH_API ButtonKit : public Sprocket
3799  {
3800  public:
3802  ButtonKit();
3803 
3806  ButtonKit(ButtonKit const & in_kit);
3807 
3810  ButtonKit(ButtonKit && in_kit);
3811 
3812  virtual ~ButtonKit();
3813 
3814  Type ObjectType() const { return Type::PublishButtonKit; }
3815 
3819  static ButtonKit GetDefault();
3820 
3823  void Set(ButtonKit const & in_kit);
3824 
3827  void Show(ButtonKit & out_kit) const;
3828 
3832  ButtonKit & operator=(ButtonKit const & in_kit);
3833 
3837  ButtonKit & operator=(ButtonKit && in_kit);
3838 
3841  bool Empty() const;
3842 
3846  bool Equals(ButtonKit const & in_kit) const;
3847 
3851  bool operator==(ButtonKit const & in_kit) const;
3852 
3856  bool operator!=(ButtonKit const & in_kit) const;
3857 
3858 
3862  ButtonKit & SetName(char const * in_name);
3863 
3867  ButtonKit & SetLabel(char const * in_label);
3868 
3872  ButtonKit & SetFont(Text::Font::Name in_name);
3873 
3878  ButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
3879 
3883  ButtonKit & SetFontSize(int in_size);
3884 
3888  ButtonKit & SetTextColor(RGBColor const & in_color);
3889 
3893  ButtonKit & SetTooltip(char const * in_tooltip);
3894 
3898  ButtonKit & SetVisibility(bool in_state);
3899 
3903  ButtonKit & SetPrintability(bool in_state);
3904 
3908  ButtonKit & SetTextRotation(Text::Rotation in_rotation);
3909 
3913  ButtonKit & SetLock(bool in_state);
3914 
3918  ButtonKit & SetBorder(bool in_state);
3919 
3923  ButtonKit & SetBorderColor(RGBColor const & in_color);
3924 
3928  ButtonKit & SetBorderThickness(Border::Thickness in_thickness);
3929 
3933  ButtonKit & SetBorderStyle(Border::Style in_style);
3934 
3939  ButtonKit & SetFillColor(RGBColor const & in_color);
3940 
3944  ButtonKit & SetLabelPosition(Label::Position in_position);
3945 
3949  ButtonKit & SetHighlighting(Highlighting::Mode in_mode);
3950 
3954  ButtonKit & SetIconImage(ImageKit const & in_image);
3955 
3956 
3959  ButtonKit & UnsetName();
3960 
3963  ButtonKit & UnsetLabel();
3964 
3967  ButtonKit & UnsetFont();
3968 
3971  ButtonKit & UnsetFontSize();
3972 
3975  ButtonKit & UnsetTextColor();
3976 
3979  ButtonKit & UnsetTooltip();
3980 
3983  ButtonKit & UnsetVisibility();
3984 
3987  ButtonKit & UnsetPrintability();
3988 
3991  ButtonKit & UnsetTextRotation();
3992 
3995  ButtonKit & UnsetLock();
3996 
3999  ButtonKit & UnsetBorder();
4000 
4003  ButtonKit & UnsetBorderColor();
4004 
4007  ButtonKit & UnsetBorderThickness();
4008 
4011  ButtonKit & UnsetBorderStyle();
4012 
4015  ButtonKit & UnsetFillColor();
4016 
4019  ButtonKit & UnsetLabelPosition();
4020 
4023  ButtonKit & UnsetHighlighting();
4024 
4027  ButtonKit & UnsetIconImage();
4028 
4031  ButtonKit & UnsetEverything();
4032 
4033 
4037  bool ShowName(UTF8 & out_name) const;
4038 
4042  bool ShowLabel(UTF8 & out_label) const;
4043 
4050  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4051 
4055  bool ShowFontSize(int & out_size) const;
4056 
4060  bool ShowTextColor(RGBColor & out_color) const;
4061 
4065  bool ShowTooltip(UTF8 & out_tooltip) const;
4066 
4070  bool ShowVisibility(bool & out_state) const;
4071 
4075  bool ShowPrintability(bool & out_state) const;
4076 
4080  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4081 
4085  bool ShowLock(bool & out_state) const;
4086 
4090  bool ShowBorder(bool & out_state) const;
4091 
4095  bool ShowBorderColor(RGBColor & out_color) const;
4096 
4100  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4101 
4105  bool ShowBorderStyle(Border::Style & out_style) const;
4106 
4110  bool ShowFillColor(RGBColor & out_color) const;
4111 
4115  bool ShowLabelPosition(Label::Position & out_position) const;
4116 
4120  bool ShowHighlighting(Highlighting::Mode & out_mode) const;
4121 
4125  bool ShowIconImage(ImageKit & out_image) const;
4126  };
4127 
4129  class PUBLISH_API CheckBoxKit : public Sprocket
4130  {
4131  public:
4133  CheckBoxKit();
4134 
4137  CheckBoxKit(CheckBoxKit const & in_kit);
4138 
4141  CheckBoxKit(CheckBoxKit && in_kit);
4142 
4143  virtual ~CheckBoxKit();
4144 
4145  Type ObjectType() const { return Type::PublishCheckBoxKit; }
4146 
4150  static CheckBoxKit GetDefault();
4151 
4154  void Set(CheckBoxKit const & in_kit);
4155 
4158  void Show(CheckBoxKit & out_kit) const;
4159 
4163  CheckBoxKit & operator=(CheckBoxKit const & in_kit);
4164 
4168  CheckBoxKit & operator=(CheckBoxKit && in_kit);
4169 
4172  bool Empty() const;
4173 
4177  bool Equals(CheckBoxKit const & in_kit) const;
4178 
4182  bool operator==(CheckBoxKit const & in_kit) const;
4183 
4187  bool operator!=(CheckBoxKit const & in_kit) const;
4188 
4189 
4193  CheckBoxKit & SetName(char const * in_name);
4194 
4198  CheckBoxKit & SetFont(Text::Font::Name in_name);
4199 
4204  CheckBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4205 
4209  CheckBoxKit & SetFontSize(int in_size);
4210 
4214  CheckBoxKit & SetTextColor(RGBColor const & in_color);
4215 
4219  CheckBoxKit & SetTooltip(char const * in_tooltip);
4220 
4224  CheckBoxKit & SetVisibility(bool in_state);
4225 
4229  CheckBoxKit & SetPrintability(bool in_state);
4230 
4234  CheckBoxKit & SetTextRotation(Text::Rotation in_rotation);
4235 
4239  CheckBoxKit & SetLock(bool in_state);
4240 
4244  CheckBoxKit & SetBorder(bool in_state);
4245 
4249  CheckBoxKit & SetBorderColor(RGBColor const & in_color);
4250 
4254  CheckBoxKit & SetBorderThickness(Border::Thickness in_thickness);
4255 
4259  CheckBoxKit & SetBorderStyle(Border::Style in_style);
4260 
4265  CheckBoxKit & SetFillColor(RGBColor const & in_color);
4266 
4270  CheckBoxKit & SetExportValue(char const * in_export_value);
4271 
4275  CheckBoxKit & SetDefaultState(bool in_state);
4276 
4277 
4280  CheckBoxKit & UnsetName();
4281 
4284  CheckBoxKit & UnsetFont();
4285 
4288  CheckBoxKit & UnsetFontSize();
4289 
4292  CheckBoxKit & UnsetTextColor();
4293 
4296  CheckBoxKit & UnsetTooltip();
4297 
4300  CheckBoxKit & UnsetVisibility();
4301 
4304  CheckBoxKit & UnsetPrintability();
4305 
4308  CheckBoxKit & UnsetTextRotation();
4309 
4312  CheckBoxKit & UnsetLock();
4313 
4316  CheckBoxKit & UnsetBorder();
4317 
4320  CheckBoxKit & UnsetBorderColor();
4321 
4324  CheckBoxKit & UnsetBorderThickness();
4325 
4328  CheckBoxKit & UnsetBorderStyle();
4329 
4332  CheckBoxKit & UnsetFillColor();
4333 
4336  CheckBoxKit & UnsetExportValue();
4337 
4340  CheckBoxKit & UnsetDefaultState();
4341 
4344  CheckBoxKit & UnsetEverything();
4345 
4346 
4350  bool ShowName(UTF8 & out_name) const;
4351 
4358  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4359 
4363  bool ShowFontSize(int & out_size) const;
4364 
4368  bool ShowTextColor(RGBColor & out_color) const;
4369 
4373  bool ShowTooltip(UTF8 & out_tooltip) const;
4374 
4378  bool ShowVisibility(bool & out_state) const;
4379 
4383  bool ShowPrintability(bool & out_state) const;
4384 
4388  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4389 
4393  bool ShowLock(bool & out_state) const;
4394 
4398  bool ShowBorder(bool & out_state) const;
4399 
4403  bool ShowBorderColor(RGBColor & out_color) const;
4404 
4408  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4409 
4413  bool ShowBorderStyle(Border::Style & out_style) const;
4414 
4418  bool ShowFillColor(RGBColor & out_color) const;
4419 
4423  bool ShowExportValue(UTF8 & out_export_value) const;
4424 
4428  bool ShowDefaultState(bool & out_default_state) const;
4429  };
4430 
4432  class PUBLISH_API RadioButtonKit : public Sprocket
4433  {
4434  public:
4436  RadioButtonKit();
4437 
4440  RadioButtonKit(RadioButtonKit const & in_kit);
4441 
4444  RadioButtonKit(RadioButtonKit && in_kit);
4445 
4446  virtual ~RadioButtonKit();
4447 
4448  Type ObjectType() const { return Type::PublishRadioButtonKit; }
4449 
4453  static RadioButtonKit GetDefault();
4454 
4457  void Set(RadioButtonKit const & in_kit);
4458 
4461  void Show(RadioButtonKit & out_kit) const;
4462 
4466  RadioButtonKit & operator=(RadioButtonKit const & in_kit);
4467 
4471  RadioButtonKit & operator=(RadioButtonKit && in_kit);
4472 
4475  bool Empty() const;
4476 
4480  bool Equals(RadioButtonKit const & in_kit) const;
4481 
4485  bool operator==(RadioButtonKit const & in_kit) const;
4486 
4490  bool operator!=(RadioButtonKit const & in_kit) const;
4491 
4492 
4496  RadioButtonKit & SetName(char const * in_name);
4497 
4501  RadioButtonKit & SetFont(Text::Font::Name in_name);
4502 
4507  RadioButtonKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4508 
4512  RadioButtonKit & SetFontSize(int in_size);
4513 
4517  RadioButtonKit & SetTextColor(RGBColor const & in_color);
4518 
4522  RadioButtonKit & SetTooltip(char const * in_tooltip);
4523 
4527  RadioButtonKit & SetVisibility(bool in_state);
4528 
4532  RadioButtonKit & SetPrintability(bool in_state);
4533 
4537  RadioButtonKit & SetTextRotation(Text::Rotation in_rotation);
4538 
4542  RadioButtonKit & SetLock(bool in_state);
4543 
4547  RadioButtonKit & SetBorder(bool in_state);
4548 
4552  RadioButtonKit & SetBorderColor(RGBColor const & in_color);
4553 
4557  RadioButtonKit & SetBorderThickness(Border::Thickness in_thickness);
4558 
4562  RadioButtonKit & SetBorderStyle(Border::Style in_style);
4563 
4568  RadioButtonKit & SetFillColor(RGBColor const & in_color);
4569 
4573  RadioButtonKit & SetExportValue(char const * in_export_value);
4574 
4578  RadioButtonKit & SetDefaultState(bool in_state);
4579 
4583  RadioButtonKit & SetGrouping(bool in_state);
4584 
4585 
4588  RadioButtonKit & UnsetName();
4589 
4592  RadioButtonKit & UnsetFont();
4593 
4596  RadioButtonKit & UnsetFontSize();
4597 
4600  RadioButtonKit & UnsetTextColor();
4601 
4604  RadioButtonKit & UnsetTooltip();
4605 
4608  RadioButtonKit & UnsetVisibility();
4609 
4612  RadioButtonKit & UnsetPrintability();
4613 
4616  RadioButtonKit & UnsetTextRotation();
4617 
4620  RadioButtonKit & UnsetLock();
4621 
4624  RadioButtonKit & UnsetBorder();
4625 
4628  RadioButtonKit & UnsetBorderColor();
4629 
4632  RadioButtonKit & UnsetBorderThickness();
4633 
4636  RadioButtonKit & UnsetBorderStyle();
4637 
4640  RadioButtonKit & UnsetFillColor();
4641 
4644  RadioButtonKit & UnsetExportValue();
4645 
4648  RadioButtonKit & UnsetDefaultState();
4649 
4652  RadioButtonKit & UnsetGrouping();
4653 
4656  RadioButtonKit & UnsetEverything();
4657 
4658 
4662  bool ShowName(UTF8 & out_name) const;
4663 
4670  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4671 
4675  bool ShowFontSize(int & out_size) const;
4676 
4680  bool ShowTextColor(RGBColor & out_color) const;
4681 
4685  bool ShowTooltip(UTF8 & out_tooltip) const;
4686 
4690  bool ShowVisibility(bool & out_state) const;
4691 
4695  bool ShowPrintability(bool & out_state) const;
4696 
4700  bool ShowTextRotation(Text::Rotation & out_rotation) const;
4701 
4705  bool ShowLock(bool & out_state) const;
4706 
4710  bool ShowBorder(bool & out_state) const;
4711 
4715  bool ShowBorderColor(RGBColor & out_color) const;
4716 
4720  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
4721 
4725  bool ShowBorderStyle(Border::Style & out_style) const;
4726 
4730  bool ShowFillColor(RGBColor & out_color) const;
4731 
4735  bool ShowExportValue(UTF8 & out_export_value) const;
4736 
4740  bool ShowDefaultState(bool & out_default_state) const;
4741 
4745  bool ShowGrouping(bool & out_grouping) const;
4746  };
4747 
4749  class PUBLISH_API ListBoxKit : public Sprocket
4750  {
4751  public:
4753  ListBoxKit();
4754 
4757  ListBoxKit(ListBoxKit const & in_kit);
4758 
4761  ListBoxKit(ListBoxKit && in_kit);
4762 
4763  virtual ~ListBoxKit();
4764 
4765  Type ObjectType() const { return Type::PublishListBoxKit; }
4766 
4770  static ListBoxKit GetDefault();
4771 
4774  void Set(ListBoxKit const & in_kit);
4775 
4778  void Show(ListBoxKit & out_kit) const;
4779 
4783  ListBoxKit & operator=(ListBoxKit const & in_kit);
4784 
4788  ListBoxKit & operator=(ListBoxKit && in_kit);
4789 
4792  bool Empty() const;
4793 
4797  bool Equals(ListBoxKit const & in_kit) const;
4798 
4802  bool operator==(ListBoxKit const & in_kit) const;
4803 
4807  bool operator!=(ListBoxKit const & in_kit) const;
4808 
4809 
4813  ListBoxKit & SetName(char const * in_name);
4814 
4818  ListBoxKit & SetFont(Text::Font::Name in_name);
4819 
4824  ListBoxKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
4825 
4829  ListBoxKit & SetFontSize(int in_size);
4830 
4834  ListBoxKit & SetTextColor(RGBColor const & in_color);
4835 
4839  ListBoxKit & SetTooltip(char const * in_tooltip);
4840 
4844  ListBoxKit & SetVisibility(bool in_state);
4845 
4849  ListBoxKit & SetPrintability(bool in_state);
4850 
4854  ListBoxKit & SetTextRotation(Text::Rotation in_rotation);
4855 
4859  ListBoxKit & SetLock(bool in_state);
4860 
4864  ListBoxKit & SetBorder(bool in_state);
4865 
4869  ListBoxKit & SetBorderColor(RGBColor const & in_color);
4870 
4874  ListBoxKit & SetBorderThickness(Border::Thickness in_thickness);
4875 
4879  ListBoxKit & SetBorderStyle(Border::Style in_style);
4880 
4885  ListBoxKit & SetFillColor(RGBColor const & in_color);
4886 
4890  ListBoxKit & SetMultipleSelection(bool in_state);
4891 
4897  ListBoxKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
4898 
4904  ListBoxKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
4905 
4906 
4909  ListBoxKit & UnsetName();
4910 
4913  ListBoxKit & UnsetFont();
4914 
4917  ListBoxKit & UnsetFontSize();
4918 
4921  ListBoxKit & UnsetTextColor();
4922 
4925  ListBoxKit & UnsetTooltip();
4926 
4929  ListBoxKit & UnsetVisibility();
4930 
4933  ListBoxKit & UnsetPrintability();
4934 
4937  ListBoxKit & UnsetTextRotation();
4938 
4941  ListBoxKit & UnsetLock();
4942 
4945  ListBoxKit & UnsetBorder();
4946 
4949  ListBoxKit & UnsetBorderColor();
4950 
4953  ListBoxKit & UnsetBorderThickness();
4954 
4957  ListBoxKit & UnsetBorderStyle();
4958 
4961  ListBoxKit & UnsetFillColor();
4962 
4965  ListBoxKit & UnsetMultipleSelection();
4966 
4969  ListBoxKit & UnsetContents();
4970 
4973  ListBoxKit & UnsetEverything();
4974 
4975 
4979  bool ShowName(UTF8 & out_name) const;
4980 
4987  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
4988 
4992  bool ShowFontSize(int & out_size) const;
4993 
4997  bool ShowTextColor(RGBColor & out_color) const;
4998 
5002  bool ShowTooltip(UTF8 & out_tooltip) const;
5003 
5007  bool ShowVisibility(bool & out_state) const;
5008 
5012  bool ShowPrintability(bool & out_state) const;
5013 
5017  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5018 
5022  bool ShowLock(bool & out_state) const;
5023 
5027  bool ShowBorder(bool & out_state) const;
5028 
5032  bool ShowBorderColor(RGBColor & out_color) const;
5033 
5037  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5038 
5042  bool ShowBorderStyle(Border::Style & out_style) const;
5043 
5047  bool ShowFillColor(RGBColor & out_color) const;
5048 
5052  bool ShowMultipleSelection(bool & out_state) const;
5053 
5058  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5059  };
5060 
5062  class PUBLISH_API DropDownListKit : public Sprocket
5063  {
5064  public:
5066  DropDownListKit();
5067 
5070  DropDownListKit(DropDownListKit const & in_kit);
5071 
5074  DropDownListKit(DropDownListKit && in_kit);
5075 
5076  virtual ~DropDownListKit();
5077 
5078  Type ObjectType() const { return Type::PublishDropDownListKit; }
5079 
5083  static DropDownListKit GetDefault();
5084 
5087  void Set(DropDownListKit const & in_kit);
5088 
5091  void Show(DropDownListKit & out_kit) const;
5092 
5096  DropDownListKit & operator=(DropDownListKit const & in_kit);
5097 
5101  DropDownListKit & operator=(DropDownListKit && in_kit);
5102 
5105  bool Empty() const;
5106 
5110  bool Equals(DropDownListKit const & in_kit) const;
5111 
5115  bool operator==(DropDownListKit const & in_kit) const;
5116 
5120  bool operator!=(DropDownListKit const & in_kit) const;
5121 
5122 
5126  DropDownListKit & SetName(char const * in_name);
5127 
5131  DropDownListKit & SetFont(Text::Font::Name in_name);
5132 
5137  DropDownListKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5138 
5142  DropDownListKit & SetFontSize(int in_size);
5143 
5147  DropDownListKit & SetTextColor(RGBColor const & in_color);
5148 
5152  DropDownListKit & SetTooltip(char const * in_tooltip);
5153 
5157  DropDownListKit & SetVisibility(bool in_state);
5158 
5162  DropDownListKit & SetPrintability(bool in_state);
5163 
5167  DropDownListKit & SetTextRotation(Text::Rotation in_rotation);
5168 
5172  DropDownListKit & SetLock(bool in_state);
5173 
5177  DropDownListKit & SetBorder(bool in_state);
5178 
5182  DropDownListKit & SetBorderColor(RGBColor const & in_color);
5183 
5187  DropDownListKit & SetBorderThickness(Border::Thickness in_thickness);
5188 
5192  DropDownListKit & SetBorderStyle(Border::Style in_style);
5193 
5198  DropDownListKit & SetFillColor(RGBColor const & in_color);
5199 
5203  DropDownListKit & SetCustomText(bool in_state);
5204 
5208  DropDownListKit & SetSpellChecking(bool in_state);
5209 
5213  DropDownListKit & SetImmediateCommit(bool in_state);
5214 
5220  DropDownListKit & SetContents(UTF8Array const & in_displayed_values, UTF8Array const & in_export_values);
5221 
5227  DropDownListKit & SetContents(size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]);
5228 
5229 
5232  DropDownListKit & UnsetName();
5233 
5236  DropDownListKit & UnsetFont();
5237 
5240  DropDownListKit & UnsetFontSize();
5241 
5244  DropDownListKit & UnsetTextColor();
5245 
5248  DropDownListKit & UnsetTooltip();
5249 
5252  DropDownListKit & UnsetVisibility();
5253 
5256  DropDownListKit & UnsetPrintability();
5257 
5260  DropDownListKit & UnsetTextRotation();
5261 
5264  DropDownListKit & UnsetLock();
5265 
5268  DropDownListKit & UnsetBorder();
5269 
5272  DropDownListKit & UnsetBorderColor();
5273 
5276  DropDownListKit & UnsetBorderThickness();
5277 
5280  DropDownListKit & UnsetBorderStyle();
5281 
5284  DropDownListKit & UnsetFillColor();
5285 
5288  DropDownListKit & UnsetCustomText();
5289 
5292  DropDownListKit & UnsetSpellChecking();
5293 
5296  DropDownListKit & UnsetImmediateCommit();
5297 
5300  DropDownListKit & UnsetContents();
5301 
5304  DropDownListKit & UnsetEverything();
5305 
5306 
5310  bool ShowName(UTF8 & out_name) const;
5311 
5318  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5319 
5323  bool ShowFontSize(int & out_size) const;
5324 
5328  bool ShowTextColor(RGBColor & out_color) const;
5329 
5333  bool ShowTooltip(UTF8 & out_tooltip) const;
5334 
5338  bool ShowVisibility(bool & out_state) const;
5339 
5343  bool ShowPrintability(bool & out_state) const;
5344 
5348  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5349 
5353  bool ShowLock(bool & out_state) const;
5354 
5358  bool ShowBorder(bool & out_state) const;
5359 
5363  bool ShowBorderColor(RGBColor & out_color) const;
5364 
5368  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5369 
5373  bool ShowBorderStyle(Border::Style & out_style) const;
5374 
5378  bool ShowFillColor(RGBColor & out_color) const;
5379 
5383  bool ShowCustomText(bool & out_state) const;
5384 
5388  bool ShowSpellChecking(bool & out_state) const;
5389 
5393  bool ShowImmediateCommit(bool & out_state) const;
5394 
5399  bool ShowContents(UTF8Array & out_displayed_values, UTF8Array & out_export_values) const;
5400  };
5401 
5403  class PUBLISH_API SignatureFieldKit : public Sprocket
5404  {
5405  public:
5408 
5411  SignatureFieldKit(SignatureFieldKit const & in_kit);
5412 
5416 
5417  virtual ~SignatureFieldKit();
5418 
5419  Type ObjectType() const { return Type::PublishSignatureFieldKit; }
5420 
5424  static SignatureFieldKit GetDefault();
5425 
5428  void Set(SignatureFieldKit const & in_kit);
5429 
5432  void Show(SignatureFieldKit & out_kit) const;
5433 
5437  SignatureFieldKit & operator=(SignatureFieldKit const & in_kit);
5438 
5442  SignatureFieldKit & operator=(SignatureFieldKit && in_kit);
5443 
5446  bool Empty() const;
5447 
5451  bool Equals(SignatureFieldKit const & in_kit) const;
5452 
5456  bool operator==(SignatureFieldKit const & in_kit) const;
5457 
5461  bool operator!=(SignatureFieldKit const & in_kit) const;
5462 
5463 
5467  SignatureFieldKit & SetName(char const * in_name);
5468 
5472  SignatureFieldKit & SetFont(Text::Font::Name in_name);
5473 
5478  SignatureFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5479 
5483  SignatureFieldKit & SetFontSize(int in_size);
5484 
5488  SignatureFieldKit & SetTextColor(RGBColor const & in_color);
5489 
5493  SignatureFieldKit & SetTooltip(char const * in_tooltip);
5494 
5498  SignatureFieldKit & SetVisibility(bool in_state);
5499 
5503  SignatureFieldKit & SetPrintability(bool in_state);
5504 
5508  SignatureFieldKit & SetTextRotation(Text::Rotation in_rotation);
5509 
5513  SignatureFieldKit & SetLock(bool in_state);
5514 
5518  SignatureFieldKit & SetBorder(bool in_state);
5519 
5523  SignatureFieldKit & SetBorderColor(RGBColor const & in_color);
5524 
5528  SignatureFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5529 
5533  SignatureFieldKit & SetBorderStyle(Border::Style in_style);
5534 
5539  SignatureFieldKit & SetFillColor(RGBColor const & in_color);
5540 
5541 
5544  SignatureFieldKit & UnsetName();
5545 
5548  SignatureFieldKit & UnsetFont();
5549 
5552  SignatureFieldKit & UnsetFontSize();
5553 
5556  SignatureFieldKit & UnsetTextColor();
5557 
5560  SignatureFieldKit & UnsetTooltip();
5561 
5564  SignatureFieldKit & UnsetVisibility();
5565 
5568  SignatureFieldKit & UnsetPrintability();
5569 
5572  SignatureFieldKit & UnsetTextRotation();
5573 
5576  SignatureFieldKit & UnsetLock();
5577 
5580  SignatureFieldKit & UnsetBorder();
5581 
5584  SignatureFieldKit & UnsetBorderColor();
5585 
5588  SignatureFieldKit & UnsetBorderThickness();
5589 
5592  SignatureFieldKit & UnsetBorderStyle();
5593 
5596  SignatureFieldKit & UnsetFillColor();
5597 
5600  SignatureFieldKit & UnsetEverything();
5601 
5602 
5606  bool ShowName(UTF8 & out_name) const;
5607 
5614  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5615 
5619  bool ShowFontSize(int & out_size) const;
5620 
5624  bool ShowTextColor(RGBColor & out_color) const;
5625 
5629  bool ShowTooltip(UTF8 & out_tooltip) const;
5630 
5634  bool ShowVisibility(bool & out_state) const;
5635 
5639  bool ShowPrintability(bool & out_state) const;
5640 
5644  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5645 
5649  bool ShowLock(bool & out_state) const;
5650 
5654  bool ShowBorder(bool & out_state) const;
5655 
5659  bool ShowBorderColor(RGBColor & out_color) const;
5660 
5664  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5665 
5669  bool ShowBorderStyle(Border::Style & out_style) const;
5670 
5674  bool ShowFillColor(RGBColor & out_color) const;
5675  };
5676 
5678  class PUBLISH_API TextFieldKit : public Sprocket
5679  {
5680  public:
5682  TextFieldKit();
5683 
5686  TextFieldKit(TextFieldKit const & in_kit);
5687 
5690  TextFieldKit(TextFieldKit && in_kit);
5691 
5692  virtual ~TextFieldKit();
5693 
5694  Type ObjectType() const { return Type::PublishTextFieldKit; }
5695 
5699  static TextFieldKit GetDefault();
5700 
5703  void Set(TextFieldKit const & in_kit);
5704 
5707  void Show(TextFieldKit & out_kit) const;
5708 
5712  TextFieldKit & operator=(TextFieldKit const & in_kit);
5713 
5717  TextFieldKit & operator=(TextFieldKit && in_kit);
5718 
5721  bool Empty() const;
5722 
5726  bool Equals(TextFieldKit const & in_kit) const;
5727 
5731  bool operator==(TextFieldKit const & in_kit) const;
5732 
5736  bool operator!=(TextFieldKit const & in_kit) const;
5737 
5738 
5739 
5743  TextFieldKit & SetName(char const * in_name);
5744 
5748  TextFieldKit & SetFont(Text::Font::Name in_name);
5749 
5754  TextFieldKit & SetFont(char const * in_name, Text::Font::Style in_style = Text::Font::Style::Regular);
5755 
5759  TextFieldKit & SetFontSize(int in_size);
5760 
5764  TextFieldKit & SetTextColor(RGBColor const & in_color);
5765 
5769  TextFieldKit & SetTooltip(char const * in_tooltip);
5770 
5774  TextFieldKit & SetVisibility(bool in_state);
5775 
5779  TextFieldKit & SetPrintability(bool in_state);
5780 
5784  TextFieldKit & SetTextRotation(Text::Rotation in_rotation);
5785 
5789  TextFieldKit & SetLock(bool in_state);
5790 
5794  TextFieldKit & SetBorder(bool in_state);
5795 
5799  TextFieldKit & SetBorderColor(RGBColor const & in_color);
5800 
5804  TextFieldKit & SetBorderThickness(Border::Thickness in_thickness);
5805 
5809  TextFieldKit & SetBorderStyle(Border::Style in_style);
5810 
5815  TextFieldKit & SetFillColor(RGBColor const & in_color);
5816 
5820  TextFieldKit & SetDefaultValue(char const * in_value);
5821 
5825  TextFieldKit & SetTextJustification(Text::Justification in_justification);
5826 
5830  TextFieldKit & SetMultiline(bool in_state);
5831 
5835  TextFieldKit & SetScrolling(bool in_state);
5836 
5840  TextFieldKit & SetReadOnly(bool in_state);
5841 
5842 
5845  TextFieldKit & UnsetName();
5846 
5849  TextFieldKit & UnsetFont();
5850 
5853  TextFieldKit & UnsetFontSize();
5854 
5857  TextFieldKit & UnsetTextColor();
5858 
5861  TextFieldKit & UnsetTooltip();
5862 
5865  TextFieldKit & UnsetVisibility();
5866 
5869  TextFieldKit & UnsetPrintability();
5870 
5873  TextFieldKit & UnsetTextRotation();
5874 
5877  TextFieldKit & UnsetLock();
5878 
5881  TextFieldKit & UnsetBorder();
5882 
5885  TextFieldKit & UnsetBorderColor();
5886 
5889  TextFieldKit & UnsetBorderThickness();
5890 
5893  TextFieldKit & UnsetBorderStyle();
5894 
5897  TextFieldKit & UnsetFillColor();
5898 
5901  TextFieldKit & UnsetDefaultValue();
5902 
5905  TextFieldKit & UnsetTextJustification();
5906 
5909  TextFieldKit & UnsetMultiline();
5910 
5913  TextFieldKit & UnsetScrolling();
5914 
5917  TextFieldKit & UnsetReadOnly();
5918 
5921  TextFieldKit & UnsetEverything();
5922 
5923 
5927  bool ShowName(UTF8 & out_name) const;
5928 
5935  bool ShowFont(Text::Font::Type & out_type, Text::Font::Name & out_name, UTF8 & out_font_name, Text::Font::Style & out_style) const;
5936 
5940  bool ShowFontSize(int & out_size) const;
5941 
5945  bool ShowTextColor(RGBColor & out_color) const;
5946 
5950  bool ShowTooltip(UTF8 & out_tooltip) const;
5951 
5955  bool ShowVisibility(bool & out_state) const;
5956 
5960  bool ShowPrintability(bool & out_state) const;
5961 
5965  bool ShowTextRotation(Text::Rotation & out_rotation) const;
5966 
5970  bool ShowLock(bool & out_state) const;
5971 
5975  bool ShowBorder(bool & out_state) const;
5976 
5980  bool ShowBorderColor(RGBColor & out_color) const;
5981 
5985  bool ShowBorderThickness(Border::Thickness & out_thickness) const;
5986 
5990  bool ShowBorderStyle(Border::Style & out_style) const;
5991 
5995  bool ShowFillColor(RGBColor & out_color) const;
5996 
6000  bool ShowDefaultValue(UTF8 & out_value) const;
6001 
6005  bool ShowTextJustification(Text::Justification & out_justification) const;
6006 
6010  bool ShowMultiline(bool & out_state) const;
6011 
6015  bool ShowScrolling(bool & out_state) const;
6016 
6020  bool ShowReadOnly(bool & out_state) const;
6021  };
6022 
6024  class PUBLISH_API DocumentKey : public Sprocket
6025  {
6026  public:
6028  DocumentKey();
6029 
6032  DocumentKey(DocumentKey const & in_that);
6033 
6036  DocumentKey(DocumentKey && in_that);
6037 
6040  virtual ~DocumentKey();
6041 
6042  Type ObjectType() const { return Type::PublishDocumentKey; }
6043 
6047  DocumentKey & operator=(DocumentKey const & in_that);
6048 
6052  DocumentKey & operator=(DocumentKey && in_that);
6053 
6057  virtual void Assign(DocumentKey const & in_that);
6058 
6062  bool Equals(DocumentKey const & in_that) const;
6063 
6067  bool operator!=(DocumentKey const & in_that) const;
6068 
6072  bool operator==(DocumentKey const & in_that) const;
6073 
6077  void Delete();
6078 
6079 
6084  DocumentKey & AddPage(PageKit const & in_page);
6085 
6091  DocumentKey & AddPages(size_t in_count, PageKit const in_pages[]);
6092 
6097  DocumentKey & AddPages(PageKitArray const & in_pages);
6098 
6108  DocumentKey & SetInformation(char const * in_title, char const * in_author, char const * in_subject, char const * in_creator);
6109 
6114  DocumentKey & SetPasswords(char const * in_user_password, char const * in_owner_password);
6115 
6121  DocumentKey & AddJavaScript(char const * in_script_name, char const * in_source, Source::Type in_type = Source::Type::Code);
6122 
6129  DocumentKey & AddJavaScript(size_t in_count, UTF8 const in_script_names[], UTF8 const in_sources[], Source::Type const in_types[]);
6130 
6136  DocumentKey & AddJavaScript(UTF8Array const & in_script_names, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6137 
6142  DocumentKey & AddAttachment(char const * in_filename, char const * in_description);
6143 
6149  DocumentKey & AddAttachments(size_t in_count, UTF8 const in_filenames[], UTF8 const in_descriptions[]);
6150 
6155  DocumentKey & AddAttachments(UTF8Array const & in_filenames, UTF8Array const & in_descriptions);
6156 
6161  DocumentKey & AddIconImage(char const * in_name, ImageKit const & in_image);
6162 
6168  DocumentKey & AddIconImages(size_t in_count, UTF8 const in_names[], ImageKit const in_images[]);
6169 
6174  DocumentKey & AddIconImages(UTF8Array const & in_names, ImageKitArray const & in_images);
6175 
6180  DocumentKey & SetPermissions(size_t in_count, Permission::Type const in_permissions[]);
6181 
6185  DocumentKey & SetPermissions(PermissionTypeArray const & in_permissions);
6186 
6187 
6189  size_t GetPageCount() const;
6190 
6194  DocumentKey & RemovePage(size_t in_index);
6195 
6200  DocumentKey & RemovePages(size_t in_start, size_t in_count);
6201 
6206  DocumentKey & RemovePages(size_t in_count, size_t const in_indices[]);
6207 
6211  DocumentKey & RemovePages(SizeTArray const & in_indices);
6212 
6215  DocumentKey & RemoveAllPages();
6216 
6220  PageControl GetPageControl(size_t in_index);
6221 
6225  PageControl const GetPageControl(size_t in_index) const;
6226  };
6227 
6229  class PUBLISH_API PageControl : public Sprocket
6230  {
6231  public:
6233  PageControl();
6234 
6237  PageControl(PageControl const & in_that);
6238 
6241  PageControl(PageControl && in_that);
6242 
6243  virtual ~PageControl();
6244 
6245  Type ObjectType() const { return Type::PublishPageControl; }
6246 
6250  PageControl & operator=(PageControl const & in_that);
6251 
6255  PageControl & operator=(PageControl && in_kit);
6256 
6257 
6262  PageControl & AddAnnotation(AnnotationKit const & in_annotation, IntRectangle const & in_location);
6263 
6269  PageControl & AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[]);
6270 
6275  PageControl & AddAnnotations(AnnotationKitArray const & in_annotations, IntRectangleArray const & in_locations);
6276 
6281  PageControl & AddText(TextKit const & in_text, IntRectangle const & in_location);
6282 
6288  PageControl & AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[]);
6289 
6294  PageControl & AddText(TextKitArray const & in_text, IntRectangleArray const & in_locations);
6295 
6300  PageControl & AddImage(ImageKit const & in_image, IntRectangle const & in_location);
6301 
6307  PageControl & AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[]);
6308 
6313  PageControl & AddImages(ImageKitArray const & in_images, IntRectangleArray const & in_locations);
6314 
6319  PageControl & AddTable(TableKit const & in_table, IntRectangle const & in_location);
6320 
6326  PageControl & AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[]);
6327 
6332  PageControl & AddTables(TableKitArray const & in_tables, IntRectangleArray const & in_locations);
6333 
6338  PageControl & AddLink(LinkKit const & in_link, IntRectangle const & in_location);
6339 
6345  PageControl & AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[]);
6346 
6351  PageControl & AddLinks(LinkKitArray const & in_links, IntRectangleArray const & in_locations);
6352 
6357  PageControl & AddButton(ButtonKit const & in_button, IntRectangle const & in_location);
6358 
6364  PageControl & AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[]);
6365 
6370  PageControl & AddButtons(ButtonKitArray const & in_buttons, IntRectangleArray const & in_locations);
6371 
6376  PageControl & AddTextField(TextFieldKit const & in_text_field, IntRectangle const & in_location);
6377 
6383  PageControl & AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[]);
6384 
6389  PageControl & AddTextFields(TextFieldKitArray const & in_text_fields, IntRectangleArray const & in_locations);
6390 
6395  PageControl & AddSlideTable(SlideTableKit const & in_slide_table, IntRectangle const & in_location);
6396 
6402  PageControl & AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[]);
6403 
6408  PageControl & AddSlideTables(SlideTableKitArray const & in_slide_tables, IntRectangleArray const & in_locations);
6409 
6414  PageControl & AddCheckBox(CheckBoxKit const & in_check_box, IntRectangle const & in_location);
6415 
6421  PageControl & AddCheckBoxes(size_t in_count, CheckBoxKit const in_check_boxes[], IntRectangle const in_locations[]);
6422 
6427  PageControl & AddCheckBoxes(CheckBoxKitArray const & in_check_boxes, IntRectangleArray const & in_locations);
6428 
6433  PageControl & AddRadioButton(RadioButtonKit const & in_radio_button, IntRectangle const & in_location);
6434 
6440  PageControl & AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[]);
6441 
6446  PageControl & AddRadioButtons(RadioButtonKitArray const & in_radio_buttons, IntRectangleArray const & in_locations);
6447 
6452  PageControl & AddListBox(ListBoxKit const & in_list_box, IntRectangle const & in_location);
6453 
6459  PageControl & AddListBoxes(size_t in_count, ListBoxKit const in_list_boxes[], IntRectangle const in_locations[]);
6460 
6465  PageControl & AddListBoxes(ListBoxKitArray const & in_list_boxes, IntRectangleArray const & in_locations);
6466 
6471  PageControl & AddDropDownList(DropDownListKit const & in_drop_down_list, IntRectangle const & in_location);
6472 
6478  PageControl & AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_lists[], IntRectangle const in_locations[]);
6479 
6484  PageControl & AddDropDownLists(DropDownListKitArray const & in_drop_down_lists, IntRectangleArray const & in_locations);
6485 
6490  PageControl & AddSignatureField(SignatureFieldKit const & in_signature_field, IntRectangle const & in_location);
6491 
6497  PageControl & AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_fields[], IntRectangle const in_locations[]);
6498 
6503  PageControl & AddSignatureFields(SignatureFieldKitArray const & in_signature_fields, IntRectangleArray const & in_locations);
6504 
6505 
6511  PageControl & SetAnnotationByField(char const * in_field, AnnotationKit const & in_annotation);
6512 
6519  PageControl & SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[]);
6520 
6526  PageControl & SetAnnotationsByField(UTF8Array const & in_fields, AnnotationKitArray const & in_annotations);
6527 
6533  PageControl & SetButtonIconByField(char const * in_field, ImageKit const & in_image);
6534 
6541  PageControl & SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[]);
6542 
6548  PageControl & SetButtonIconsByField(UTF8Array const & in_fields, ImageKitArray const & in_images);
6549 
6555  PageControl & SetButtonLabelByField(char const * in_field, char const * in_label);
6556 
6563  PageControl & SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[]);
6564 
6570  PageControl & SetButtonLabelsByField(UTF8Array const & in_fields, UTF8Array const & in_labels);
6571 
6578  PageControl & AddListItemByField(char const * in_field, char const * in_value, char const * in_export_value);
6579 
6587  PageControl & AddListItemsByField(char const * in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[]);
6588 
6595  PageControl & AddListItemsByField(char const * in_field, UTF8Array const & in_values, UTF8Array const & in_export_values);
6596 
6604  PageControl & SetJavaScriptActionByField(char const * in_field, char const * in_source, Source::Type in_type = Source::Type::Code);
6605 
6614  PageControl & SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[]);
6615 
6623  PageControl & SetJavaScriptActionsByField(UTF8Array const & in_fields, UTF8Array const & in_sources, SourceTypeArray const & in_types);
6624 
6630  PageControl & SetVisibilityByField(char const * in_field, bool in_state);
6631 
6638  PageControl & SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[]);
6639 
6645  PageControl & SetVisibilitiesByField(UTF8Array const & in_fields, BoolArray const & in_states);
6646 
6652  PageControl & SetTextValueByField(char const * in_field, char const * in_value);
6653 
6660  PageControl & SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[]);
6661 
6667  PageControl & SetTextValuesByField(UTF8Array const & in_fields, UTF8Array const & in_values);
6668 
6669 
6675  bool ShowFields(UTF8Array & out_names, IntRectangleArray & out_locations, FieldTypeArray & out_types) const;
6676  };
6677 
6678 
6679  class ExportOptionsKit;
6680 
6682  class PUBLISH_API File
6683  {
6684  public:
6691  static void Export(SprocketPath const & in_source, char const * in_filename, ExportOptionsKit const & in_options);
6692 
6699  static void Export(AnnotationKit const & in_annotation, char const * in_filename, ExportOptionsKit const & in_options);
6700 
6707  static void Export(DocumentKit const & in_document, char const * in_filename, ExportOptionsKit const & in_options);
6708 
6713  static DocumentKey CreateDocument(char const * in_filename = nullptr);
6714 
6719  static void Export(DocumentKey const & in_document, char const * in_filename);
6720 
6721  private:
6723  File();
6724  };
6725 
6727  class PUBLISH_API ExportOptionsKit : public Sprocket
6728  {
6729  public:
6731  ExportOptionsKit();
6732 
6735  ExportOptionsKit(ExportOptionsKit const & in_kit);
6736 
6740 
6741  virtual ~ExportOptionsKit();
6742 
6743  Type ObjectType() const { return Type::PublishExportOptionsKit; }
6744 
6747  void Set(ExportOptionsKit const & in_kit);
6748 
6751  void Show(ExportOptionsKit & out_kit) const;
6752 
6756  ExportOptionsKit & operator=(ExportOptionsKit const & in_kit);
6757 
6761  ExportOptionsKit & operator=(ExportOptionsKit && in_kit);
6762 
6765  bool Empty() const;
6766 
6770  bool Equals(ExportOptionsKit const & in_kit) const;
6771 
6775  bool operator==(ExportOptionsKit const & in_kit) const;
6776 
6780  bool operator!=(ExportOptionsKit const & in_kit) const;
6781 
6782 
6786  ExportOptionsKit & SetDocumentToAppendTo(char const * in_filename);
6787 
6788 
6791  ExportOptionsKit & UnsetDocumentToAppendTo();
6792 
6795  ExportOptionsKit & UnsetEverything();
6796 
6797 
6801  bool ShowDocumentToAppendTo(UTF8 & out_filename) const;
6802  };
6803 
6804 private:
6806  Publish();
6807 };
6808 
6809 }
6810 
6811 #endif
Mode
Definition: sprk_publish.h:278
Definition: hps.h:3201
Definition: sprk_publish.h:3099
Definition: sprk_publish.h:2701
Mode
Definition: sprk_publish.h:450
Definition: sprk_publish.h:468
Preference
Definition: sprk_publish.h:490
Definition: sprk.h:69
Type ObjectType() const
Definition: sprk_publish.h:2291
Definition: sprk_publish.h:4432
Type ObjectType() const
Definition: sprk_publish.h:3366
Definition: sprk_publish.h:156
Orientation
Definition: sprk_publish.h:127
Definition: sprk_publish.h:307
Definition: sprk.h:924
Definition: sprk_publish.h:445
Format
Definition: sprk_publish.h:109
Definition: sprk_publish.h:175
Type
Definition: sprk_publish.h:312
Definition: sprk_publish.h:5403
Mode
Definition: sprk_publish.h:251
Definition: sprk_publish.h:42
Definition: sprk_publish.h:2927
Type
Definition: sprk_publish.h:562
Style
Definition: sprk_publish.h:197
Type ObjectType() const
Definition: sprk_publish.h:6743
Definition: sprk_publish.h:4129
Definition: sprk_publish.h:228
Type ObjectType() const
Definition: sprk_publish.h:6042
Type ObjectType() const
Definition: sprk_publish.h:4145
Definition: sprk_publish.h:559
Type ObjectType() const
Definition: sprk_publish.h:4448
Definition: sprk_publish.h:6682
Rotation
Definition: sprk_publish.h:371
Definition: sprk_publish.h:3521
Definition: sprk_publish.h:85
Position
Definition: sprk_publish.h:541
Definition: sprk_publish.h:385
Definition: sprk_publish.h:210
Definition: sprk_publish.h:5678
Definition: sprk_publish.h:4749
Type
Definition: sprk_publish.h:425
Definition: sprk_publish.h:485
Definition: sprk_publish.h:420
Justification
Definition: hps.h:1536
Definition: sprk_publish.h:104
BRepCompression
Definition: sprk_publish.h:161
Definition: sprk_publish.h:3798
Definition: hps.h:4150
Definition: hps.h:6650
Definition: sprk_publish.h:139
Definition: sprk_publish.h:590
Type ObjectType() const
Definition: sprk_publish.h:5078
Definition: sprk_publish.h:6727
Style
Definition: sprk_publish.h:338
Definition: sprk_publish.h:192
Definition: sprk_publish.h:273
Definition: sprk_publish.h:6229
Definition: sprk_publish.h:6024
Type ObjectType() const
Definition: sprk_publish.h:606
Definition: sprk_publish.h:5062
Type ObjectType() const
Definition: sprk_publish.h:2717
Type ObjectType() const
Definition: sprk_publish.h:5694
Thickness
Definition: sprk_publish.h:512
Definition: sprk_publish.h:3238
Type
Definition: sprk_publish.h:90
Type ObjectType() const
Definition: sprk_publish.h:4765
Definition: sprk_publish.h:536
Type ObjectType() const
Definition: sprk_publish.h:6245
Format
Definition: sprk_publish.h:144
Definition: sprk_publish.h:303
Preference
Definition: sprk_publish.h:473
Name
Definition: sprk_publish.h:320
Format
Definition: sprk_publish.h:390
Definition: sprk_publish.h:507
Type ObjectType() const
Definition: sprk_publish.h:3814
Type ObjectType() const
Definition: sprk_publish.h:946
Definition: sprk_publish.h:246
Type ObjectType() const
Definition: sprk_publish.h:3115
Language
Definition: sprk_publish.h:353
Definition: sprk_publish.h:921
Definition: sprk_publish.h:464
When
Definition: sprk_publish.h:215
Style
Definition: sprk_publish.h:521
Definition: hps.h:9808
When
Definition: sprk_publish.h:233
Type ObjectType() const
Definition: sprk_publish.h:2943
Type ObjectType() const
Definition: sprk_publish.h:5419
Definition: sprk_publish.h:2271
Type ObjectType() const
Definition: sprk_publish.h:3537
Version
Definition: sprk_publish.h:180
Definition: sprk_publish.h:3350
Type ObjectType() const
Definition: sprk_publish.h:3254