Hot Door CORE 0.8.4
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreMessage.h
Go to the documentation of this file.
1
6
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
115 };
116
120 class ActionMessage : public Message
121 {
122 public:
128 virtual ~ActionMessage();
129
130
131 private:
132 // Only Dispatcher can construct an ActionMessage object
133 friend class Dispatcher;
134
140 ActionMessage(const MessageType, void*);
141
147 ActionMessage(const ActionMessage&);
148
154 ActionMessage& operator=(const ActionMessage&);
155 };
156
157 #if defined(HDI_CORE_PSP_MODE)
162 class AcquireMessage : public Message
163 {
164 public:
170 virtual ~AcquireMessage();
171
172
173 private:
174 // Only Dispatcher can construct an AcquireMessage object
175 friend class Dispatcher;
176
182 AcquireMessage(const MessageType, void*);
183
189 AcquireMessage(const AcquireMessage&);
190
196 AcquireMessage& operator=(const AcquireMessage&);
197 };
198 #endif
199 // HDI_CORE_PSP_MODE
200
201 #if defined(HDI_CORE_AIP_MODE)
207 class AdapterMessage : public Message
208 {
209 public:
216
217
218 private:
219 // Only Dispatcher can construct an AdapterMessage object
220 friend class Dispatcher;
221
227 AdapterMessage(const MessageType, void*);
228
234 AdapterMessage(const AdapterMessage&);
235
241 AdapterMessage& operator=(const AdapterMessage&);
242 };
243
247 class AnnotatorMessage : public Message
248 {
249 public:
250 typedef std::vector<Rect> RectVector;
251
252 typedef AIAnnotatorDrawer* ContextPtr;
253
260
268 Annotator* const annotator() const;
269
279 const ContextPtr context() const;
280
288 DocumentView* const docView() const;
289
298
306 bool showEdges() const;
307
318 RectVector* const invalidationRects() const;
319
320
321 private:
322 // Only Dispatcher can construct an AnnotatorMessage object
323 friend class Dispatcher;
324
330 AnnotatorMessage(const Annotator&, const MessageType, void*);
331
337 AnnotatorMessage(const AnnotatorMessage&);
338
344 AnnotatorMessage& operator=(const AnnotatorMessage&);
345 };
346
351 class ClipboardMessage : public Message
352 {
353 public:
360
361
362 private:
363 // Only Dispatcher can construct a ClipboardMessage object
364 friend class Dispatcher;
365
371 ClipboardMessage(const MessageType, void*);
372
378 ClipboardMessage(const ClipboardMessage&);
379
385 ClipboardMessage& operator=(const ClipboardMessage&);
386 };
387
391 class CommandMessage : public Message
392 {
393 public:
400
401
402 private:
403 // Only Dispatcher can construct a CommandMessage object
404 friend class Dispatcher;
405
411 CommandMessage(const MessageType, void*);
412
418 CommandMessage(const CommandMessage&);
419
425 CommandMessage& operator=(const CommandMessage&);
426 };
427 #endif
428 // HDI_CORE_AIP_MODE
429
433 class CustomMessage : public Message
434 {
435 public:
441 virtual ~CustomMessage();
442
453 std::string caller() const;
454
465 std::string selector() const;
466
467 #if defined(HDI_CORE_PSP_MODE)
478 CallerType callerNumeric() const;
479
491 int16_t selectorNumeric() const;
492 #endif
493
494
495 private:
496 // Only Dispatcher can construct a CustomMessage object
497 friend class Dispatcher;
498
504 CustomMessage(const std::string&, const std::string&, const MessageType, void*);
505
506 #if defined(HDI_CORE_PSP_MODE)
512 CustomMessage(const CallerType, const int16_t, const MessageType, void*);
513 #endif
514
520 CustomMessage(const CustomMessage&);
521
527 CustomMessage& operator=(const CustomMessage&);
528 };
529
530 #if defined(HDI_CORE_PSP_MODE)
535 class ExportMessage : public Message
536 {
537 public:
543 virtual ~ExportMessage();
544
545
546 private:
547 // Only Dispatcher can construct an ExportMessage object
548 friend class Dispatcher;
549
555 ExportMessage(const MessageType, void*);
556
562 ExportMessage(const ExportMessage&);
563
569 ExportMessage& operator=(const ExportMessage&);
570 };
571 #endif
572 // HDI_CORE_PSP_MODE
573
574 #if defined(HDI_CORE_AIP_MODE)
579 class FileFormatMessage : public Message
580 {
581 public:
582 typedef std::vector< std::shared_ptr<Artboard> > ArtboardVector;
583
590
598 FileFormat* const fileFormat() const;
599
608
617
625 std::string filePath() const;
626
634 void setFilePath(const std::string& path_);
635
644 void* actionParam() const;
645
654 ArtboardVector artboards() const;
655
656
657 private:
658 // Only Dispatcher can construct a FileFormatMessage object
659 friend class Dispatcher;
660
666 FileFormatMessage(const MessageType, void*);
667
673 FileFormatMessage(const FileFormatMessage&);
674
680 FileFormatMessage& operator=(const FileFormatMessage&);
681 };
682 #endif
683 // HDI_CORE_AIP_MODE
684
685 #if defined(HDI_CORE_PSP_MODE)
702 class FileFormatMessage : public Message
703 {
704 public:
710 virtual ~FileFormatMessage();
711
712
713 private:
714 // Only Dispatcher can construct a FileFormatMessage object
715 friend class Dispatcher;
716
722 FileFormatMessage(const MessageType, void*);
723
730
736 FileFormatMessage& operator=(const FileFormatMessage&);
737 };
738 #endif
739 // HDI_CORE_AIP_MODE
740
746 class FilterMessage : public Message
747 {
748 public:
754 virtual ~FilterMessage();
755
756 #if defined(HDI_CORE_PSP_MODE)
769 bool shouldAbort() const;
770
781 void setProgress(const int32_t completed_, const int32_t total_);
782
792 int16_t planes() const;
793
802 int32_t maxSpace() const;
803
811 int32_t bufferSpace() const;
812
825 void setBufferSpace(const int32_t bs_);
826
835 int16_t inLoPlane() const;
836
847 void setInLoPlane(const int16_t ilp_);
848
857 int16_t inHiPlane() const;
858
869 void setInHiPlane(const int16_t ihp_);
870
879 int16_t outLoPlane() const;
880
891 void setOutLoPlane(const int16_t olp_);
892
901 int16_t outHiPlane() const;
902
913 void setOutHiPlane(const int16_t ohp_);
914
923 void* const inData() const;
924
933 int32_t inRowBytes() const;
934
943 void* const outData() const;
944
953 int32_t outRowBytes() const;
954
980 bool advanceState();
981
1000 bool drawPixelData(
1001 const PlatformDrawingContextPtr dc_,
1002 const PixelMap& srcPM_,
1003 const Rect& srcArea_,
1004 const Point& dstTL_,
1005 const Rect& dstArea_
1006 );
1007
1015 bool isFloating() const;
1016
1024 bool hasMask() const;
1025
1033 bool autoMask() const;
1034
1048 void setAutoMask(const bool masked_);
1049
1062 void* const maskData() const;
1063
1071 int32_t maskRowBytes() const;
1072
1080 ArtColor backColor() const;
1081
1089 ArtColor foreColor() const;
1090
1098 ColorSpace imageMode() const;
1099
1107 double hRes() const;
1108
1116 double vRes() const;
1117
1125 MonitorSpecs* const monitor() const;
1126
1134 bool supportsDummyChannels() const;
1135
1145 bool supportsAlternateLayouts() const;
1146
1154 DataLayout wantLayout() const;
1155
1166 void setWantLayout(const DataLayout wl_);
1167
1178 FilterCase filterCase() const;
1179
1189 int16_t dummyPlaneValue() const;
1190
1201 void setDummyPlaneValue(const int16_t dpv_);
1202
1213 bool supportsAbsolute() const;
1214
1223 bool wantsAbsolute() const;
1224
1233 bool cannotUndo() const;
1234
1245 void setCannotUndo(const bool undo_);
1246
1254 bool supportsPadding() const;
1255
1263 int16_t inputPadding() const;
1264
1275 void setInputPadding(const int16_t pad_);
1276
1284 int16_t outputPadding() const;
1285
1296 void setOutputPadding(const int16_t pad_);
1297
1305 int16_t maskPadding() const;
1306
1317 void setMaskPadding(const int16_t pad_);
1318
1326 bool samplingSupport() const;
1327
1350 double inputRate() const;
1351
1359 void setInputRate(const double rate_);
1360
1383 double maskRate() const;
1384
1392 void setMaskRate(const double rate_);
1393
1415 int16_t inLayerPlanes() const;
1416
1426 int16_t inTransparencyMask() const;
1427
1437 int16_t inLayerMasks() const;
1438
1448 int16_t inInvertedLayerMasks() const;
1449
1459 int16_t inNonLayerPlanes() const;
1460
1470 int16_t outLayerPlanes() const;
1471
1481 int16_t outTransparencyMask() const;
1482
1492 int16_t outLayerMasks() const;
1493
1503 int16_t outInvertedLayerMasks() const;
1504
1514 int16_t outNonLayerPlanes() const;
1515
1526 int16_t absLayerPlanes() const;
1527
1538 int16_t absTransparencyMask() const;
1539
1550 int16_t absLayerMasks() const;
1551
1562 int16_t absInvertedLayerMasks() const;
1563
1574 int16_t absNonLayerPlanes() const;
1575
1584 int16_t inPreDummyPlanes() const;
1585
1594 int16_t inPostDummyPlanes() const;
1595
1604 int16_t outPreDummyPlanes() const;
1605
1614 int16_t outPostDummyPlanes() const;
1615
1626 int32_t inColumnBytes() const;
1627
1638 int32_t inPlaneBytes() const;
1639
1650 int32_t outColumnBytes() const;
1651
1662 int32_t outPlaneBytes() const;
1663
1673 int16_t inTileHeight() const;
1674
1684 int16_t inTileWidth() const;
1685
1693 Point inTileOrigin() const;
1694
1704 int16_t absTileHeight() const;
1705
1715 int16_t absTileWidth() const;
1716
1724 Point absTileOrigin() const;
1725
1735 int16_t outTileHeight() const;
1736
1746 int16_t outTileWidth() const;
1747
1755 Point outTileOrigin() const;
1756
1766 int16_t maskTileHeight() const;
1767
1777 int16_t maskTileWidth() const;
1778
1786 Point maskTileOrigin() const;
1787
1795 std::string errorString() const;
1796
1810 void setErrorString(const std::string& error_);
1811
1819 DocumentInfo* const documentInfo() const;
1820
1828 int32_t depth() const;
1829
1844 int32_t hasImageScrap() const;
1845
1853 Size imageSize() const;
1854
1868 Rect filterRect() const;
1869
1877 Rect inRect() const;
1878
1891 void setInRect(const Rect& ir_);
1892
1900 Rect outRect() const;
1901
1914 void setOutRect(const Rect& or_);
1915
1923 Rect maskRect() const;
1924
1937 void setMaskRect(const Rect& mr_);
1938
1946 Point floatCoordinate() const;
1947
1955 Size wholeSize() const;
1956 #endif
1957 // HDI_CORE_PSP_MODE
1958
1959
1960 private:
1961 // Only Dispatcher can construct a FilterMessage object
1962 friend class Dispatcher;
1963
1969 FilterMessage(const MessageType, void*);
1970
1976 FilterMessage(const FilterMessage&);
1977
1983 FilterMessage& operator=(const FilterMessage&);
1984 };
1985
1986 #if defined(HDI_CORE_AIP_MODE)
1990 class LayerListMessage : public Message
1991 {
1992 public:
1999
2000
2001 private:
2002 // Only Dispatcher can construct a LayerListMessage object
2003 friend class Dispatcher;
2004
2010 LayerListMessage(const MessageType, void*);
2011
2017 LayerListMessage(const LayerListMessage&);
2018
2024 LayerListMessage& operator=(const LayerListMessage&);
2025 };
2026
2031 {
2032 public:
2039
2040
2041 protected:
2048
2055
2065 };
2066
2070 class LiveEffectGoMessage : public LiveEffectMessage
2071 {
2072 public:
2079
2080
2081 private:
2082 // Only Dispatcher can construct a LiveEffectGoMessage object
2083 friend class Dispatcher;
2084
2090 LiveEffectGoMessage(const MessageType, void*);
2091
2097 LiveEffectGoMessage(const LiveEffectGoMessage&);
2098
2104 LiveEffectGoMessage& operator=(const LiveEffectGoMessage&);
2105 };
2106
2110 class LiveEffectEditParamsMessage : public LiveEffectMessage
2111 {
2112 public:
2119
2120
2121 private:
2122 // Only Dispatcher can construct a LiveEffectEditParamsMessage object
2123 friend class Dispatcher;
2124
2130 LiveEffectEditParamsMessage(const MessageType, void*);
2131
2137 LiveEffectEditParamsMessage(const LiveEffectEditParamsMessage&);
2138
2144 LiveEffectEditParamsMessage& operator=(const LiveEffectEditParamsMessage&);
2145 };
2146
2150 class LiveEffectInterpolateMessage : public LiveEffectMessage
2151 {
2152 public:
2159
2160
2161 private:
2162 // Only Dispatcher can construct a LiveEffectInterpolateMessage object
2163 friend class Dispatcher;
2164
2170 LiveEffectInterpolateMessage(const MessageType, void*);
2171
2177 LiveEffectInterpolateMessage(const LiveEffectInterpolateMessage&);
2178
2184 LiveEffectInterpolateMessage& operator=(const LiveEffectInterpolateMessage&);
2185 };
2186
2190 class LiveEffectInputMessage : public LiveEffectMessage
2191 {
2192 public:
2199
2200
2201 private:
2202 // Only Dispatcher can construct a LiveEffectInputMessage object
2203 friend class Dispatcher;
2204
2210 LiveEffectInputMessage(const MessageType, void*);
2211
2217 LiveEffectInputMessage(const LiveEffectInputMessage&);
2218
2224 LiveEffectInputMessage& operator=(const LiveEffectInputMessage&);
2225 };
2226
2230 class LiveEffectConvertColorSpaceMessage : public LiveEffectMessage
2231 {
2232 public:
2239
2240
2241 private:
2242 // Only Dispatcher can construct a LiveEffectConvertColorSpaceMessage object
2243 friend class Dispatcher;
2244
2250 LiveEffectConvertColorSpaceMessage(const MessageType, void*);
2251
2257 LiveEffectConvertColorSpaceMessage(const LiveEffectConvertColorSpaceMessage&);
2258
2264 LiveEffectConvertColorSpaceMessage& operator=(const LiveEffectConvertColorSpaceMessage&);
2265 };
2266
2270 class LiveEffectAdjustColorsMessage : public LiveEffectMessage
2271 {
2272 public:
2279
2280
2281 private:
2282 // Only Dispatcher can construct a LiveEffectAdjustColorsMessage object
2283 friend class Dispatcher;
2284
2290 LiveEffectAdjustColorsMessage(const MessageType, void*);
2291
2297 LiveEffectAdjustColorsMessage(const LiveEffectAdjustColorsMessage&);
2298
2304 LiveEffectAdjustColorsMessage& operator=(const LiveEffectAdjustColorsMessage&);
2305 };
2306
2310 class LiveEffectScaleParamsMessage : public LiveEffectMessage
2311 {
2312 public:
2319
2320
2321 private:
2322 // Only Dispatcher can construct a LiveEffectScaleParamsMessage object
2323 friend class Dispatcher;
2324
2330 LiveEffectScaleParamsMessage(const MessageType, void*);
2331
2337 LiveEffectScaleParamsMessage(const LiveEffectScaleParamsMessage&);
2338
2344 LiveEffectScaleParamsMessage& operator=(const LiveEffectScaleParamsMessage&);
2345 };
2346
2350 class LiveEffectMergeMessage : public LiveEffectMessage
2351 {
2352 public:
2359
2360
2361 private:
2362 // Only Dispatcher can construct a LiveEffectMergeMessage object
2363 friend class Dispatcher;
2364
2370 LiveEffectMergeMessage(const MessageType, void*);
2371
2377 LiveEffectMergeMessage(const LiveEffectMergeMessage&);
2378
2384 LiveEffectMergeMessage& operator=(const LiveEffectMergeMessage&);
2385 };
2386
2390 class LiveEffectGetSVGFilterMessage : public LiveEffectMessage
2391 {
2392 public:
2399
2400
2401 private:
2402 // Only Dispatcher can construct a LiveEffectGetSVGFilterMessage object
2403 friend class Dispatcher;
2404
2410 LiveEffectGetSVGFilterMessage(const MessageType, void*);
2411
2417 LiveEffectGetSVGFilterMessage(const LiveEffectGetSVGFilterMessage&);
2418
2424 LiveEffectGetSVGFilterMessage& operator=(const LiveEffectGetSVGFilterMessage&);
2425 };
2426
2430 class LiveEffectIsCompatibleMessage : public LiveEffectMessage
2431 {
2432 public:
2439
2440
2441 private:
2442 // Only Dispatcher can construct a LiveEffectIsCompatibleMessage object
2443 friend class Dispatcher;
2444
2450 LiveEffectIsCompatibleMessage(const MessageType, void*);
2451
2457 LiveEffectIsCompatibleMessage(const LiveEffectIsCompatibleMessage&);
2458
2464 LiveEffectIsCompatibleMessage& operator=(const LiveEffectIsCompatibleMessage&);
2465 };
2466 #endif
2467 // HDI_CORE_AIP_MODE
2468
2469 #if defined(HDI_CORE_PSP_MODE)
2475 class MeasurementMessage : public Message
2476 {
2477 public:
2483 virtual ~MeasurementMessage();
2484
2485
2486 private:
2487 // Only Dispatcher can construct a MeasurementMessage object
2488 friend class Dispatcher;
2489
2495 MeasurementMessage(const MessageType, void*);
2496
2502 MeasurementMessage(const MeasurementMessage&);
2503
2509 MeasurementMessage& operator=(const MeasurementMessage&);
2510 };
2511 #endif
2512 // HDI_CORE_PSP_MODE
2513
2514 #if defined(HDI_CORE_AIP_MODE)
2518 class MenuMessage : public Message
2519 {
2520 public:
2526 virtual ~MenuMessage();
2527
2535 MenuItem* const menuItem() const;
2536
2537
2538 private:
2539 // Only Dispatcher can construct a MenuMessage object
2540 friend class Dispatcher;
2541
2547 MenuMessage(const MenuItem&, const MessageType, void*);
2548
2554 MenuMessage(const MenuMessage&);
2555
2561 MenuMessage& operator=(const MenuMessage&);
2562 };
2563
2567 class NotifyMessage : public Message
2568 {
2569 public:
2576
2584 Notifier* const notifier() const;
2585
2594
2595
2596 private:
2597 // Only Dispatcher can construct a NotifyMessage object
2598 friend class Dispatcher;
2599
2605 NotifyMessage(const Notifier&, const MessageType, void*);
2606
2612 NotifyMessage(const NotifyMessage&);
2613
2619 NotifyMessage& operator=(const NotifyMessage&);
2620 };
2621
2628 class ObjectSetMessage : public Message
2629 {
2630 public:
2637
2638
2639 private:
2640 // Only Dispatcher can construct a ObjectSetMessage object
2641 friend class Dispatcher;
2642
2648 ObjectSetMessage(const MessageType, void*);
2649
2655 ObjectSetMessage(const ObjectSetMessage&);
2656
2662 ObjectSetMessage& operator=(const ObjectSetMessage&);
2663 };
2664 #endif
2665 // HDI_CORE_AIP_MODE
2666
2670 class PluginMessage : public Message
2671 {
2672 public:
2679
2680
2681 private:
2682 // Only Dispatcher can construct a PluginMessage object
2683 friend class Dispatcher;
2684
2690 PluginMessage(const MessageType, void*);
2691
2697 PluginMessage(const PluginMessage&);
2698
2704 PluginMessage& operator=(const PluginMessage&);
2705 };
2706
2707 #if defined(HDI_CORE_AIP_MODE)
2716 class CustomArtMessage : public Message
2717 {
2718 public:
2725
2735 std::unique_ptr<Art> customArt() const;
2736
2737
2738 private:
2739 // Only Dispatcher can construct a CustomArtMessage object
2740 friend class Dispatcher;
2741
2747 CustomArtMessage(const MessageType, void*);
2748
2754 CustomArtMessage(const CustomArtMessage&);
2755
2761 CustomArtMessage& operator=(const CustomArtMessage&);
2762 };
2763 #endif
2764 // HDI_CORE_AIP_MODE
2765
2766 #if defined(HDI_CORE_PSP_MODE)
2770 class PickerMessage : public Message
2771 {
2772 public:
2778 virtual ~PickerMessage();
2779
2780
2781 private:
2782 // Only Dispatcher can construct a PickerMessage object
2783 friend class Dispatcher;
2784
2790 PickerMessage(const MessageType, void*);
2791
2797 PickerMessage(const PickerMessage&);
2798
2804 PickerMessage& operator=(const PickerMessage&);
2805 };
2806 #endif
2807 // HDI_CORE_PSP_MODE
2808
2809 #if defined(HDI_CORE_AIP_MODE)
2814 class PreferencesMessage : public Message
2815 {
2816 public:
2823
2824
2825 private:
2826 // Only Dispatcher can construct a PreferencesMessage object
2827 friend class Dispatcher;
2828
2834 PreferencesMessage(const MessageType, void*);
2835
2841 PreferencesMessage(const PreferencesMessage&);
2842
2848 PreferencesMessage& operator=(const PreferencesMessage&);
2849 };
2850
2854 class PropertiesMessage : public Message
2855 {
2856 public:
2863
2864
2865 private:
2866 // Only Dispatcher can construct a PropertiesMessage object
2867 friend class Dispatcher;
2868
2874 PropertiesMessage(const MessageType, void*);
2875
2881 PropertiesMessage(const PropertiesMessage&);
2882
2888 PropertiesMessage& operator=(const PropertiesMessage&);
2889 };
2890 #endif
2891 // HDI_CORE_AIP_MODE
2892
2893 #if defined(HDI_CORE_PSP_MODE)
2897 class SelectionMessage : public Message
2898 {
2899 public:
2905 virtual ~SelectionMessage();
2906
2907
2908 private:
2909 // Only Dispatcher can construct a SelectionMessage object
2910 friend class Dispatcher;
2911
2917 SelectionMessage(const MessageType, void*);
2918
2924 SelectionMessage(const SelectionMessage&);
2925
2931 SelectionMessage& operator=(const SelectionMessage&);
2932 };
2933 #endif
2934 // HDI_CORE_PSP_MODE
2935
2936 #if defined(HDI_CORE_AIP_MODE)
2940 class TimerMessage : public Message
2941 {
2942 public:
2948 virtual ~TimerMessage();
2949
2957 Timer* const timer() const;
2958
2959
2960 private:
2961 // Only Dispatcher can construct a TimerMessage object
2962 friend class Dispatcher;
2963
2969 TimerMessage(const Timer&, const MessageType, void*);
2970
2976 TimerMessage(const TimerMessage&);
2977
2983 TimerMessage& operator=(const TimerMessage&);
2984 };
2985
2993 class ToolMessage : public Message
2994 {
2995 public:
2999 static const double normalPressure;
3000
3009
3018
3027
3033 virtual ~ToolMessage();
3034
3042 Tool* const tool() const;
3043
3052
3061 double pressure() const;
3062
3071 double stylusWheel() const;
3072
3080 Angle tilt() const;
3081
3090
3099
3108
3109
3110 private:
3111 // Only Dispatcher can construct a ToolMessage object
3112 friend class Dispatcher;
3113
3119 ToolMessage(const Tool&, const MessageType, void*);
3120
3126 ToolMessage(const ToolMessage&);
3127
3133 ToolMessage& operator=(const ToolMessage&);
3134 };
3135
3143 class ToolboxMessage : public Message
3144 {
3145 public:
3152
3153
3154 private:
3155 // Only Dispatcher can construct a ToolboxMessage object
3156 friend class Dispatcher;
3157
3163 ToolboxMessage(const MessageType, void*);
3164
3170 ToolboxMessage(const ToolboxMessage&);
3171
3177 ToolboxMessage& operator=(const ToolboxMessage&);
3178 };
3179
3183 class TransformAgainMessage : public Message
3184 {
3185 public:
3192
3193
3194 private:
3195 // Only Dispatcher can construct a TransformAgainMessage object
3196 friend class Dispatcher;
3197
3203 TransformAgainMessage(const MessageType, void*);
3204
3210 TransformAgainMessage(const TransformAgainMessage&);
3211
3217 TransformAgainMessage& operator=(const TransformAgainMessage&);
3218 };
3219
3223 class WorkspaceMessage : public Message
3224 {
3225 public:
3232
3233
3234 private:
3235 // Only Dispatcher can construct a WorkspaceMessage object
3236 friend class Dispatcher;
3237
3243 WorkspaceMessage(const MessageType, void*);
3244
3250 WorkspaceMessage(const WorkspaceMessage&);
3251
3257 WorkspaceMessage& operator=(const WorkspaceMessage&);
3258 };
3259 #endif
3260 // HDI_CORE_AIP_MODE
3261 }
3262}
3263
3264#endif
3265// __HDI_CORE_MESSAGE__
virtual ~ActionMessage()
Destructs a ActionMessage object.
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
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:42
Handles general art-related functionality.
Definition hdicoreArt.h:51
Represents an individual artboard in the current document.
Definition hdicoreArtboard.h:36
Describes a point on the Illustrator artboard.
Definition hdicoreArtboardPoint.h:31
virtual ~ClipboardMessage()
Destructs a ClipboardMessage object.
virtual ~CommandMessage()
Destructs a CommandMessage object.
std::unique_ptr< Art > customArt() const
Custom art to which the received message applies.
virtual ~CustomArtMessage()
Destructs a CustomArtMessage object.
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:580
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.
virtual ~FilterMessage()
Destructs a FilterMessage object.
virtual ~LayerListMessage()
Destructs a LayerListMessage object.
virtual ~LiveEffectAdjustColorsMessage()
Destructs a LiveEffectAdjustColorsMessage object.
virtual ~LiveEffectConvertColorSpaceMessage()
Destructs a LiveEffectConvertColorSpaceMessage object.
virtual ~LiveEffectEditParamsMessage()
Destructs a LiveEffectEditParamsMessage object.
virtual ~LiveEffectGetSVGFilterMessage()
Destructs a LiveEffectGetSVGFilterMessage object.
virtual ~LiveEffectGoMessage()
Destructs a LiveEffectGoMessage object.
virtual ~LiveEffectInputMessage()
Destructs a LiveEffectInputMessage object.
virtual ~LiveEffectInterpolateMessage()
Destructs a LiveEffectInterpolateMessage object.
virtual ~LiveEffectIsCompatibleMessage()
Destructs a LiveEffectIsCompatibleMessage object.
virtual ~LiveEffectMergeMessage()
Destructs a LiveEffectMergeMessage object.
LiveEffectMessage(const MessageType, void *)
Internal use only.
LiveEffectMessage(const LiveEffectMessage &)
Unused.
virtual ~LiveEffectMessage()
Destructs a LiveEffectMessage object.
LiveEffectMessage & operator=(const LiveEffectMessage &)
Unused.
virtual ~LiveEffectScaleParamsMessage()
Destructs a LiveEffectScaleParamsMessage object.
Wraps around an application menu item to allow for selection callbacks, en/disabling,...
Definition hdicoreMenuItem.h:26
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
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.
virtual ~ObjectSetMessage()
Destructs a ObjectSetMessage object.
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
virtual ~PreferencesMessage()
Destructs a PreferencesMessage object.
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
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
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:2999
Angle rotation() const
Gets the rotation of the tool, measure clockwise around the tool's barrel.
virtual ~ToolboxMessage()
Destructs a ToolboxMessage object.
virtual ~TransformAgainMessage()
Destructs a TransformAgainMessage object.
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:1113
ModifierKey
Describes various modifier keys.
Definition hdicoreTypes.h:931