Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreMessage.h
Go to the documentation of this file.
1
7#ifndef __HDI_CORE_MESSAGE__
8#define __HDI_CORE_MESSAGE__
9
10#include <vector>
11
12#include "hdicoreAngle.h"
14#include "hdicoreArtColor.h"
15#include "hdicoreFileFormat.h"
16#include "hdicorePoint.h"
17#include "hdicoreRect.h"
18#include "hdicoreTypes.h"
19
20namespace hdi
21{
22 namespace core
23 {
24 #if defined(HDI_CORE_AIP_MODE)
25 class Annotator;
26 class Art;
27 class Artboard;
28 class DocumentView;
29 class FileFormat;
30 class MenuItem;
31 class Notification;
32 class Notifier;
33 class Timer;
34 class Tool;
35 #endif
36 // HDI_CORE_AIP_MODE
37
38 #if defined(HDI_CORE_PSP_MODE)
39 class DocumentInfo;
40 class PixelMap;
41 #endif
42 // HDI_CORE_PSP_MODE
43
47 class Message
48 {
49 public:
55 virtual ~Message();
56
64 virtual MessageType type() const;
65
84 virtual void* rawData() const;
85
86
87 protected:
91 void* _data;
92
99
106
113 };
114
118 class ActionMessage : public Message
119 {
120 public:
126 virtual ~ActionMessage();
127
128
129 private:
130 // Only Dispatcher can construct an ActionMessage object
131 friend class Dispatcher;
132
138 ActionMessage(const MessageType, void*);
139
146
152 ActionMessage& operator=(const ActionMessage&);
153 };
154
155 #if defined(HDI_CORE_PSP_MODE)
160 class AcquireMessage : public Message
161 {
162 public:
168 virtual ~AcquireMessage();
169
170
171 private:
172 // Only Dispatcher can construct an AcquireMessage object
173 friend class Dispatcher;
174
180 AcquireMessage(const MessageType, void*);
181
187 AcquireMessage(const AcquireMessage&);
188
194 AcquireMessage& operator=(const AcquireMessage&);
195 };
196 #endif
197 // HDI_CORE_PSP_MODE
198
199 #if defined(HDI_CORE_AIP_MODE)
205 class AdapterMessage : public Message
206 {
207 public:
214
215
216 private:
217 // Only Dispatcher can construct an AdapterMessage object
218 friend class Dispatcher;
219
225 AdapterMessage(const MessageType, void*);
226
233
239 AdapterMessage& operator=(const AdapterMessage&);
240 };
241
246 {
247 public:
248 typedef std::vector<Rect> RectVector;
249
250 typedef AIAnnotatorDrawer* ContextPtr;
251
258
266 Annotator* const annotator() const;
267
277 const ContextPtr context() const;
278
286 DocumentView* const docView() const;
287
296
304 bool showEdges() const;
305
316 RectVector* const invalidationRects() const;
317
318
319 private:
320 // Only Dispatcher can construct an AnnotatorMessage object
321 friend class Dispatcher;
322
328 AnnotatorMessage(const Annotator&, const MessageType, void*);
329
336
342 AnnotatorMessage& operator=(const AnnotatorMessage&);
343 };
344
350 {
351 public:
358
359
360 private:
361 // Only Dispatcher can construct a ClipboardMessage object
362 friend class Dispatcher;
363
369 ClipboardMessage(const MessageType, void*);
370
377
383 ClipboardMessage& operator=(const ClipboardMessage&);
384 };
385
386 class CommandMessage : public Message
387 {
388 public:
395
396
397 private:
398 // Only Dispatcher can construct a CommandMessage object
399 friend class Dispatcher;
400
406 CommandMessage(const MessageType, void*);
407
414
420 CommandMessage& operator=(const CommandMessage&);
421 };
422 #endif
423 // HDI_CORE_AIP_MODE
424
428 class CustomMessage : public Message
429 {
430 public:
436 virtual ~CustomMessage();
437
448 std::string caller() const;
449
460 std::string selector() const;
461
462 #if defined(HDI_CORE_PSP_MODE)
473 CallerType callerNumeric() const;
474
486 int16_t selectorNumeric() const;
487 #endif
488
489
490 private:
491 // Only Dispatcher can construct a CustomMessage object
492 friend class Dispatcher;
493
499 CustomMessage(const std::string&, const std::string&, const MessageType, void*);
500
501 #if defined(HDI_CORE_PSP_MODE)
507 CustomMessage(const CallerType, const int16_t, const MessageType, void*);
508 #endif
509
516
522 CustomMessage& operator=(const CustomMessage&);
523 };
524
525 #if defined(HDI_CORE_PSP_MODE)
530 class ExportMessage : public Message
531 {
532 public:
538 virtual ~ExportMessage();
539
540
541 private:
542 // Only Dispatcher can construct an ExportMessage object
543 friend class Dispatcher;
544
550 ExportMessage(const MessageType, void*);
551
557 ExportMessage(const ExportMessage&);
558
564 ExportMessage& operator=(const ExportMessage&);
565 };
566 #endif
567 // HDI_CORE_PSP_MODE
568
569 #if defined(HDI_CORE_AIP_MODE)
575 {
576 public:
577 typedef std::vector< std::shared_ptr<Artboard> > ArtboardVector;
578
585
593 FileFormat* const fileFormat() const;
594
603
612
620 std::string filePath() const;
621
629 void setFilePath(const std::string& path_);
630
639 void* actionParam() const;
640
649 ArtboardVector artboards() const;
650
651
652 private:
653 // Only Dispatcher can construct a FileFormatMessage object
654 friend class Dispatcher;
655
661 FileFormatMessage(const MessageType, void*);
662
669
675 FileFormatMessage& operator=(const FileFormatMessage&);
676 };
677 #endif
678 // HDI_CORE_AIP_MODE
679
680 #if defined(HDI_CORE_PSP_MODE)
697 class FileFormatMessage : public Message
698 {
699 public:
705 virtual ~FileFormatMessage();
706
707
708 private:
709 // Only Dispatcher can construct a FileFormatMessage object
710 friend class Dispatcher;
711
717 FileFormatMessage(const MessageType, void*);
718
725
731 FileFormatMessage& operator=(const FileFormatMessage&);
732 };
733 #endif
734 // HDI_CORE_AIP_MODE
735
741 class FilterMessage : public Message
742 {
743 public:
749 virtual ~FilterMessage();
750
751 #if defined(HDI_CORE_PSP_MODE)
764 bool shouldAbort() const;
765
776 void setProgress(const int32_t completed_, const int32_t total_);
777
787 int16_t planes() const;
788
797 int32_t maxSpace() const;
798
806 int32_t bufferSpace() const;
807
820 void setBufferSpace(const int32_t bs_);
821
830 int16_t inLoPlane() const;
831
842 void setInLoPlane(const int16_t ilp_);
843
852 int16_t inHiPlane() const;
853
864 void setInHiPlane(const int16_t ihp_);
865
874 int16_t outLoPlane() const;
875
886 void setOutLoPlane(const int16_t olp_);
887
896 int16_t outHiPlane() const;
897
908 void setOutHiPlane(const int16_t ohp_);
909
918 void* const inData() const;
919
928 int32_t inRowBytes() const;
929
938 void* const outData() const;
939
948 int32_t outRowBytes() const;
949
975 bool advanceState();
976
995 bool drawPixelData(
996 const PlatformDrawingContextPtr dc_,
997 const PixelMap& srcPM_,
998 const Rect& srcArea_,
999 const Point& dstTL_,
1000 const Rect& dstArea_
1001 );
1002
1010 bool isFloating() const;
1011
1019 bool hasMask() const;
1020
1028 bool autoMask() const;
1029
1043 void setAutoMask(const bool masked_);
1044
1057 void* const maskData() const;
1058
1066 int32_t maskRowBytes() const;
1067
1075 ArtColor backColor() const;
1076
1084 ArtColor foreColor() const;
1085
1093 ColorSpace imageMode() const;
1094
1102 double hRes() const;
1103
1111 double vRes() const;
1112
1120 MonitorSpecs* const monitor() const;
1121
1129 bool supportsDummyChannels() const;
1130
1140 bool supportsAlternateLayouts() const;
1141
1149 DataLayout wantLayout() const;
1150
1161 void setWantLayout(const DataLayout wl_);
1162
1173 FilterCase filterCase() const;
1174
1184 int16_t dummyPlaneValue() const;
1185
1196 void setDummyPlaneValue(const int16_t dpv_);
1197
1208 bool supportsAbsolute() const;
1209
1218 bool wantsAbsolute() const;
1219
1228 bool cannotUndo() const;
1229
1240 void setCannotUndo(const bool undo_);
1241
1249 bool supportsPadding() const;
1250
1258 int16_t inputPadding() const;
1259
1270 void setInputPadding(const int16_t pad_);
1271
1279 int16_t outputPadding() const;
1280
1291 void setOutputPadding(const int16_t pad_);
1292
1300 int16_t maskPadding() const;
1301
1312 void setMaskPadding(const int16_t pad_);
1313
1321 bool samplingSupport() const;
1322
1345 double inputRate() const;
1346
1354 void setInputRate(const double rate_);
1355
1378 double maskRate() const;
1379
1387 void setMaskRate(const double rate_);
1388
1410 int16_t inLayerPlanes() const;
1411
1421 int16_t inTransparencyMask() const;
1422
1432 int16_t inLayerMasks() const;
1433
1443 int16_t inInvertedLayerMasks() const;
1444
1454 int16_t inNonLayerPlanes() const;
1455
1465 int16_t outLayerPlanes() const;
1466
1476 int16_t outTransparencyMask() const;
1477
1487 int16_t outLayerMasks() const;
1488
1498 int16_t outInvertedLayerMasks() const;
1499
1509 int16_t outNonLayerPlanes() const;
1510
1521 int16_t absLayerPlanes() const;
1522
1533 int16_t absTransparencyMask() const;
1534
1545 int16_t absLayerMasks() const;
1546
1557 int16_t absInvertedLayerMasks() const;
1558
1569 int16_t absNonLayerPlanes() const;
1570
1579 int16_t inPreDummyPlanes() const;
1580
1589 int16_t inPostDummyPlanes() const;
1590
1599 int16_t outPreDummyPlanes() const;
1600
1609 int16_t outPostDummyPlanes() const;
1610
1621 int32_t inColumnBytes() const;
1622
1633 int32_t inPlaneBytes() const;
1634
1645 int32_t outColumnBytes() const;
1646
1657 int32_t outPlaneBytes() const;
1658
1668 int16_t inTileHeight() const;
1669
1679 int16_t inTileWidth() const;
1680
1688 Point inTileOrigin() const;
1689
1699 int16_t absTileHeight() const;
1700
1710 int16_t absTileWidth() const;
1711
1719 Point absTileOrigin() const;
1720
1730 int16_t outTileHeight() const;
1731
1741 int16_t outTileWidth() const;
1742
1750 Point outTileOrigin() const;
1751
1761 int16_t maskTileHeight() const;
1762
1772 int16_t maskTileWidth() const;
1773
1781 Point maskTileOrigin() const;
1782
1790 std::string errorString() const;
1791
1805 void setErrorString(const std::string& error_);
1806
1814 DocumentInfo* const documentInfo() const;
1815
1823 int32_t depth() const;
1824
1839 int32_t hasImageScrap() const;
1840
1848 Size imageSize() const;
1849
1863 Rect filterRect() const;
1864
1872 Rect inRect() const;
1873
1886 void setInRect(const Rect& ir_);
1887
1895 Rect outRect() const;
1896
1909 void setOutRect(const Rect& or_);
1910
1918 Rect maskRect() const;
1919
1932 void setMaskRect(const Rect& mr_);
1933
1941 Point floatCoordinate() const;
1942
1950 Size wholeSize() const;
1951 #endif
1952 // HDI_CORE_PSP_MODE
1953
1954
1955 private:
1956 // Only Dispatcher can construct a FilterMessage object
1957 friend class Dispatcher;
1958
1964 FilterMessage(const MessageType, void*);
1965
1972
1978 FilterMessage& operator=(const FilterMessage&);
1979 };
1980
1981 #if defined(HDI_CORE_AIP_MODE)
1986 {
1987 public:
1994
1995
1996 private:
1997 // Only Dispatcher can construct a LayerListMessage object
1998 friend class Dispatcher;
1999
2005 LayerListMessage(const MessageType, void*);
2006
2013
2019 LayerListMessage& operator=(const LayerListMessage&);
2020 };
2021
2026 {
2027 public:
2034
2035
2036 protected:
2043
2050
2057 };
2058
2063 {
2064 public:
2071
2072
2073 private:
2074 // Only Dispatcher can construct a LiveEffectGoMessage object
2075 friend class Dispatcher;
2076
2082 LiveEffectGoMessage(const MessageType, void*);
2083
2090
2096 LiveEffectGoMessage& operator=(const LiveEffectGoMessage&);
2097 };
2098
2103 {
2104 public:
2111
2112
2113 private:
2114 // Only Dispatcher can construct a LiveEffectEditParamsMessage object
2115 friend class Dispatcher;
2116
2123
2130
2137 };
2138
2143 {
2144 public:
2151
2152
2153 private:
2154 // Only Dispatcher can construct a LiveEffectInterpolateMessage object
2155 friend class Dispatcher;
2156
2163
2170
2177 };
2178
2183 {
2184 public:
2191
2192
2193 private:
2194 // Only Dispatcher can construct a LiveEffectInputMessage object
2195 friend class Dispatcher;
2196
2202 LiveEffectInputMessage(const MessageType, void*);
2203
2210
2217 };
2218
2223 {
2224 public:
2231
2232
2233 private:
2234 // Only Dispatcher can construct a LiveEffectConvertColorSpaceMessage object
2235 friend class Dispatcher;
2236
2243
2250
2257 };
2258
2263 {
2264 public:
2271
2272
2273 private:
2274 // Only Dispatcher can construct a LiveEffectAdjustColorsMessage object
2275 friend class Dispatcher;
2276
2283
2290
2297 };
2298
2303 {
2304 public:
2311
2312
2313 private:
2314 // Only Dispatcher can construct a LiveEffectScaleParamsMessage object
2315 friend class Dispatcher;
2316
2323
2330
2337 };
2338
2343 {
2344 public:
2351
2352
2353 private:
2354 // Only Dispatcher can construct a LiveEffectMergeMessage object
2355 friend class Dispatcher;
2356
2362 LiveEffectMergeMessage(const MessageType, void*);
2363
2370
2377 };
2378
2383 {
2384 public:
2391
2392
2393 private:
2394 // Only Dispatcher can construct a LiveEffectGetSVGFilterMessage object
2395 friend class Dispatcher;
2396
2403
2410
2417 };
2418
2423 {
2424 public:
2431
2432
2433 private:
2434 // Only Dispatcher can construct a LiveEffectIsCompatibleMessage object
2435 friend class Dispatcher;
2436
2443
2450
2457 };
2458 #endif
2459 // HDI_CORE_AIP_MODE
2460
2461 #if defined(HDI_CORE_PSP_MODE)
2467 class MeasurementMessage : public Message
2468 {
2469 public:
2475 virtual ~MeasurementMessage();
2476
2477
2478 private:
2479 // Only Dispatcher can construct a MeasurementMessage object
2480 friend class Dispatcher;
2481
2487 MeasurementMessage(const MessageType, void*);
2488
2494 MeasurementMessage(const MeasurementMessage&);
2495
2501 MeasurementMessage& operator=(const MeasurementMessage&);
2502 };
2503 #endif
2504 // HDI_CORE_PSP_MODE
2505
2506 #if defined(HDI_CORE_AIP_MODE)
2510 class MenuMessage : public Message
2511 {
2512 public:
2518 virtual ~MenuMessage();
2519
2527 MenuItem* const menuItem() const;
2528
2529
2530 private:
2531 // Only Dispatcher can construct a MenuMessage object
2532 friend class Dispatcher;
2533
2539 MenuMessage(const MenuItem&, const MessageType, void*);
2540
2546 MenuMessage(const MenuMessage&);
2547
2553 MenuMessage& operator=(const MenuMessage&);
2554 };
2555
2559 class NotifyMessage : public Message
2560 {
2561 public:
2568
2576 Notifier* const notifier() const;
2577
2586
2587
2588 private:
2589 // Only Dispatcher can construct a NotifyMessage object
2590 friend class Dispatcher;
2591
2597 NotifyMessage(const Notifier&, const MessageType, void*);
2598
2605
2611 NotifyMessage& operator=(const NotifyMessage&);
2612 };
2613
2621 {
2622 public:
2629
2630
2631 private:
2632 // Only Dispatcher can construct a ObjectSetMessage object
2633 friend class Dispatcher;
2634
2640 ObjectSetMessage(const MessageType, void*);
2641
2648
2654 ObjectSetMessage& operator=(const ObjectSetMessage&);
2655 };
2656 #endif
2657 // HDI_CORE_AIP_MODE
2658
2662 class PluginMessage : public Message
2663 {
2664 public:
2671
2672
2673 private:
2674 // Only Dispatcher can construct a PluginMessage object
2675 friend class Dispatcher;
2676
2682 PluginMessage(const MessageType, void*);
2683
2690
2696 PluginMessage& operator=(const PluginMessage&);
2697 };
2698
2699 #if defined(HDI_CORE_AIP_MODE)
2709 {
2710 public:
2717
2727 std::unique_ptr<Art> customArt() const;
2728
2729
2730 private:
2731 // Only Dispatcher can construct a CustomArtMessage object
2732 friend class Dispatcher;
2733
2739 CustomArtMessage(const MessageType, void*);
2740
2747
2753 CustomArtMessage& operator=(const CustomArtMessage&);
2754 };
2755 #endif
2756 // HDI_CORE_AIP_MODE
2757
2758 #if defined(HDI_CORE_PSP_MODE)
2762 class PickerMessage : public Message
2763 {
2764 public:
2770 virtual ~PickerMessage();
2771
2772
2773 private:
2774 // Only Dispatcher can construct a PickerMessage object
2775 friend class Dispatcher;
2776
2782 PickerMessage(const MessageType, void*);
2783
2789 PickerMessage(const PickerMessage&);
2790
2796 PickerMessage& operator=(const PickerMessage&);
2797 };
2798 #endif
2799 // HDI_CORE_PSP_MODE
2800
2801 #if defined(HDI_CORE_AIP_MODE)
2807 {
2808 public:
2815
2816
2817 private:
2818 // Only Dispatcher can construct a PreferencesMessage object
2819 friend class Dispatcher;
2820
2826 PreferencesMessage(const MessageType, void*);
2827
2834
2840 PreferencesMessage& operator=(const PreferencesMessage&);
2841 };
2842
2847 {
2848 public:
2855
2856
2857 private:
2858 // Only Dispatcher can construct a PropertiesMessage object
2859 friend class Dispatcher;
2860
2866 PropertiesMessage(const MessageType, void*);
2867
2874
2880 PropertiesMessage& operator=(const PropertiesMessage&);
2881 };
2882 #endif
2883 // HDI_CORE_AIP_MODE
2884
2885 #if defined(HDI_CORE_PSP_MODE)
2889 class SelectionMessage : public Message
2890 {
2891 public:
2897 virtual ~SelectionMessage();
2898
2899
2900 private:
2901 // Only Dispatcher can construct a SelectionMessage object
2902 friend class Dispatcher;
2903
2909 SelectionMessage(const MessageType, void*);
2910
2916 SelectionMessage(const SelectionMessage&);
2917
2923 SelectionMessage& operator=(const SelectionMessage&);
2924 };
2925 #endif
2926 // HDI_CORE_PSP_MODE
2927
2928 #if defined(HDI_CORE_AIP_MODE)
2932 class TimerMessage : public Message
2933 {
2934 public:
2940 virtual ~TimerMessage();
2941
2949 Timer* const timer() const;
2950
2951
2952 private:
2953 // Only Dispatcher can construct a TimerMessage object
2954 friend class Dispatcher;
2955
2961 TimerMessage(const Timer&, const MessageType, void*);
2962
2968 TimerMessage(const TimerMessage&);
2969
2975 TimerMessage& operator=(const TimerMessage&);
2976 };
2977
2985 class ToolMessage : public Message
2986 {
2987 public:
2991 static const double normalPressure;
2992
3001
3010
3019
3025 virtual ~ToolMessage();
3026
3034 Tool* const tool() const;
3035
3044
3053 double pressure() const;
3054
3063 double stylusWheel() const;
3064
3072 Angle tilt() const;
3073
3082
3091
3100
3101
3102 private:
3103 // Only Dispatcher can construct a ToolMessage object
3104 friend class Dispatcher;
3105
3111 ToolMessage(const Tool&, const MessageType, void*);
3112
3118 ToolMessage(const ToolMessage&);
3119
3125 ToolMessage& operator=(const ToolMessage&);
3126 };
3127
3136 {
3137 public:
3144
3145
3146 private:
3147 // Only Dispatcher can construct a ToolboxMessage object
3148 friend class Dispatcher;
3149
3155 ToolboxMessage(const MessageType, void*);
3156
3163
3169 ToolboxMessage& operator=(const ToolboxMessage&);
3170 };
3171
3176 {
3177 public:
3184
3185
3186 private:
3187 // Only Dispatcher can construct a TransformAgainMessage object
3188 friend class Dispatcher;
3189
3195 TransformAgainMessage(const MessageType, void*);
3196
3203
3210 };
3211
3216 {
3217 public:
3224
3225
3226 private:
3227 // Only Dispatcher can construct a WorkspaceMessage object
3228 friend class Dispatcher;
3229
3235 WorkspaceMessage(const MessageType, void*);
3236
3243
3249 WorkspaceMessage& operator=(const WorkspaceMessage&);
3250 };
3251 #endif
3252 // HDI_CORE_AIP_MODE
3253 }
3254}
3255
3256#endif
3257// __HDI_CORE_MESSAGE__
Received for ActionGoMessageType.
Definition: hdicoreMessage.h:119
virtual ~ActionMessage()
Destructs a ActionMessage object.
Received for AdaptersStartupMessageType, AdaptersShutdownMessageType, AdaptersDisposeInfoMessageType,...
Definition: hdicoreMessage.h:206
virtual ~AdapterMessage()
Destructs a AdapterMessage object.
Describes an angle, and allows for easy conversion between various units.
Definition: hdicoreAngle.h:26
Deals with annotator registration and drawing callbacks.
Definition: hdicoreAnnotator.h:29
Received for AnnotationDrawMessageType and AnnotationInvalidateMessageType.
Definition: hdicoreMessage.h:246
DocumentView *const docView() const
Gets the DocumentView to which the message applies.
RectVector *const invalidationRects() const
Gets the regions of the view that have been invalidated and need to be redrawn.
bool showEdges() const
Gets whether an outline should be drawn around the annotation area.
Annotator *const annotator() const
Gets the Annotator object to which the message applies.
const ContextPtr context() const
Gets the annotation context for the target message.
virtual ~AnnotatorMessage()
Destructs a AnnotatorMessage object.
bool triggeredByDragScroll() const
Gets whether the message was sent due to the view scrolling during a mouse drag event.
Describes the color of art on the artboard.
Definition: hdicoreArtColor.h:40
Describes a point on the Illustrator artboard.
Definition: hdicoreArtboardPoint.h:31
Received for ClipboardGoMessageType, ClipboardCanCopyMessageType, ClipboardCloneMessageType and Clipb...
Definition: hdicoreMessage.h:350
virtual ~ClipboardMessage()
Destructs a ClipboardMessage object.
Definition: hdicoreMessage.h:387
virtual ~CommandMessage()
Destructs a CommandMessage object.
Received for CustomArtNotifyEditsMessageType, CustomArtUpdateViewableArtMessageType,...
Definition: hdicoreMessage.h:2709
std::unique_ptr< Art > customArt() const
Custom art to which the received message applies.
virtual ~CustomArtMessage()
Destructs a CustomArtMessage object.
Received for any custom messages (i.e. custom caller/selector pairs)
Definition: hdicoreMessage.h:429
virtual ~CustomMessage()
Destructs a CustomMessage object.
std::string selector() const
Gets the selector string that was received with the message.
std::string caller() const
Gets the caller string that was received with the message.
Class through which all messages ultimately pass; holds registered callbacks for messages,...
Definition: hdicoreDispatcher.h:34
Allow for interacting the document views (windows)
Definition: hdicoreDocumentView.h:30
Describes a file format that Illustrator can either read or write.
Definition: hdicoreFileFormat.h:24
ExtendedOptions
Used to specify the extended capabilities of a file format.
Definition: hdicoreFileFormat.h:154
Options
Used to specify the capabilities of a file format.
Definition: hdicoreFileFormat.h:43
Received for FileFormatGetParamsMessageType, FileFormatSetParamsMessageType, FileFormatGoMessageType,...
Definition: hdicoreMessage.h:575
void setFilePath(const std::string &path_)
Sets the path of the file to read, write, check, etc.
void * actionParam() const
Gets the additional parameter data, if the ContainsPartialParametersOption is set in the return value...
FileFormat *const fileFormat() const
Gets the FileFormat object to which the message applies.
FileFormat::Options operation() const
Gets the requested operation.
FileFormat::ExtendedOptions extendedOperation() const
Gets the requested extended operation.
std::string filePath() const
Gets the path of the file to read, write, check, etc.
ArtboardVector artboards() const
If the extended operation is SaveMultiArtboardsExtendedOption, this gets the artboards affected by th...
virtual ~FileFormatMessage()
Destructs a FileFormatMessage object.
Received for FilterGetParamsMessageType and FilterGoMessageType for Illustrator, and FilterParameters...
Definition: hdicoreMessage.h:742
virtual ~FilterMessage()
Destructs a FilterMessage object.
Received for LayerListPushMessageType, LayerListPopMessageType, and LayerListDeleteMessageType.
Definition: hdicoreMessage.h:1986
virtual ~LayerListMessage()
Destructs a LayerListMessage object.
Received for LiveEffectAdjustColorsMessageType.
Definition: hdicoreMessage.h:2263
virtual ~LiveEffectAdjustColorsMessage()
Destructs a LiveEffectAdjustColorsMessage object.
Received for LiveEffectConvertColorSpaceMessageType.
Definition: hdicoreMessage.h:2223
virtual ~LiveEffectConvertColorSpaceMessage()
Destructs a LiveEffectConvertColorSpaceMessage object.
Received for LiveEffectEditParamsMessageType.
Definition: hdicoreMessage.h:2103
virtual ~LiveEffectEditParamsMessage()
Destructs a LiveEffectEditParamsMessage object.
Received for LiveEffectGetSVGFilterMessageType.
Definition: hdicoreMessage.h:2383
virtual ~LiveEffectGetSVGFilterMessage()
Destructs a LiveEffectGetSVGFilterMessage object.
Received for LiveEffectGoMessageType.
Definition: hdicoreMessage.h:2063
virtual ~LiveEffectGoMessage()
Destructs a LiveEffectGoMessage object.
Received for LiveEffectInputMessageType.
Definition: hdicoreMessage.h:2183
virtual ~LiveEffectInputMessage()
Destructs a LiveEffectInputMessage object.
Received for LiveEffectInterpolateMessageType.
Definition: hdicoreMessage.h:2143
virtual ~LiveEffectInterpolateMessage()
Destructs a LiveEffectInterpolateMessage object.
Received for LiveEffectIsCompatibleMessageType.
Definition: hdicoreMessage.h:2423
virtual ~LiveEffectIsCompatibleMessage()
Destructs a LiveEffectIsCompatibleMessage object.
Received for LiveEffectMergeMessageType.
Definition: hdicoreMessage.h:2343
virtual ~LiveEffectMergeMessage()
Destructs a LiveEffectMergeMessage object.
Base class for all LiveEffect*Message subclasses.
Definition: hdicoreMessage.h:2026
LiveEffectMessage(const MessageType, void *)
Internal use only.
LiveEffectMessage(const LiveEffectMessage &)
Unused.
virtual ~LiveEffectMessage()
Destructs a LiveEffectMessage object.
LiveEffectMessage & operator=(const LiveEffectMessage &)
Unused.
Received for LiveEffectScaleParamsMessageType.
Definition: hdicoreMessage.h:2303
virtual ~LiveEffectScaleParamsMessage()
Destructs a LiveEffectScaleParamsMessage object.
Wraps around an application menu item to allow for selection callbacks, en/disabling,...
Definition: hdicoreMenuItem.h:26
Received for MenuGoMessageType and MenuUpdateMessageType.
Definition: hdicoreMessage.h:2511
MenuItem *const menuItem() const
Gets the MenuItem object to which the message applies.
virtual ~MenuMessage()
Destructs a MenuMessage object.
Base class for all *Message subclasses.
Definition: hdicoreMessage.h:48
virtual void * rawData() const
Gets the raw Illustrator message data struct.
virtual ~Message()
Destructs a Message object.
Message(const Message &)
Unused.
Message()
Internal use only.
Message & operator=(const Message &)
Unused.
virtual MessageType type() const
Gets the type of message data the target object represents.
void * _data
Stores private implementation data.
Definition: hdicoreMessage.h:91
Base class for all *Notification subclasses.
Definition: hdicoreNotification.h:27
Acts as a receiver for specific notifications, passing them along to caller-supplied callbacks.
Definition: hdicoreNotifier.h:24
Received for NotifyMessageType.
Definition: hdicoreMessage.h:2560
Notifier *const notifier() const
Gets the Notifier object to which the message applies.
virtual ~NotifyMessage()
Destructs a NotifyMessage object.
Notification *const notification() const
Gets the Notification data object for the received notifier message, if any is relevant.
Received for ObjectSetDisposeContentsMessageType, ObjectSetMarkUsageMessageType, ObjectSetUpdateInter...
Definition: hdicoreMessage.h:2621
virtual ~ObjectSetMessage()
Destructs a ObjectSetMessage object.
Received for PluginReloadMessageType, PluginPurgeCachesMessageType, and PluginUnloadMessageType.
Definition: hdicoreMessage.h:2663
virtual ~PluginMessage()
Destructs a PluginMessage object.
Describes a point in the 2-dimensional (x,y) coordinate system, typically in an Illustrator document ...
Definition: hdicorePoint.h:38
Received for PreferencesInitMessageType, PreferencesOKMessageType, PreferencesCancelMessageType,...
Definition: hdicoreMessage.h:2807
virtual ~PreferencesMessage()
Destructs a PreferencesMessage object.
Received for PropertiesAcquireMessageType and PropertiesReleaseMessageType.
Definition: hdicoreMessage.h:2847
virtual ~PropertiesMessage()
Destructs a PropertiesMessage object.
Contains Point and Size objects to describe a rectangle that exists at a specific point of given dime...
Definition: hdicoreRect.h:34
Contains a width and height for a rectangular shape.
Definition: hdicoreSize.h:25
Deals with timer registration and callbacks.
Definition: hdicoreTimer.h:32
Received for TimerGoMessageType.
Definition: hdicoreMessage.h:2933
virtual ~TimerMessage()
Destructs a TimerMessage object.
Timer *const timer() const
Gets the Timer object to which the message applies.
Base class for all tools; stores hit data, cursor loc, dialogs, etc.; receives tool-related messages.
Definition: hdicoreTool.h:35
Received for ToolEditMessageType, ToolTrackMessageType, ToolMouseDownMessageType, ToolMouseDragMessag...
Definition: hdicoreMessage.h:2986
double pressure() const
Gets the pressure of the input device.
Tool *const tool() const
Gets the Tool object to which the message applies.
static Angle normalRotation()
Gets a normal/default pen rotation angle.
ModifierKey modifiers() const
Gets the modifier keys that were present when the message was received.
double stylusWheel() const
Gets the tangential pressure on the finger wheel of the airbrush tool.
virtual ~ToolMessage()
Destructs a ToolMessage object.
static Angle normalTilt()
Gets a normal/default pen tilt angle.
Angle bearing() const
Gets the direction of tilt, measured clockwise around the z-axis; also called azimuth.
static Angle normalBearing()
Gets a normal/default pen bearing angle.
Angle tilt() const
Gets how the tool is angled; also called altitude or elevation.
ArtboardPoint cursor() const
Gets the current position of the cursor on the artboard.
static const double normalPressure
Normal/default tool pressure value (tool pressure values are in the range [0.0, 1....
Definition: hdicoreMessage.h:2991
Angle rotation() const
Gets the rotation of the tool, measure clockwise around the tool's barrel.
Received for ToolboxStartMessageType, ToolboxEndMessageType, ToolboxStartGroupMessageType,...
Definition: hdicoreMessage.h:3136
virtual ~ToolboxMessage()
Destructs a ToolboxMessage object.
Received for TransformAgainMessageType.
Definition: hdicoreMessage.h:3176
virtual ~TransformAgainMessage()
Destructs a TransformAgainMessage object.
Received for WorkspaceWriteMessageType, WorkspaceRestoreMessageType, and WorkspaceDefaultMessageType.
Definition: hdicoreMessage.h:3216
virtual ~WorkspaceMessage()
Destructs a WorkspaceMessage object.
Header file for describing angles.
Header file for art color manipulation.
Header file for geometric point manipulation on the Illustrator artboard.
Header file for Illustrator file format manipulation.
Header file for describing 2D points.
Header file for describing rectangles.
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.
MessageType
Describes the types of plugin messages for which subscriptions are available.
Definition: hdicoreTypes.h:1080
ModifierKey
Describes various modifier keys.
Definition: hdicoreTypes.h:898