7#ifndef __HDI_CORE_MESSAGE__
8#define __HDI_CORE_MESSAGE__
24 #if defined(HDI_CORE_AIP_MODE)
38 #if defined(HDI_CORE_PSP_MODE)
133 friend class Dispatcher;
147 ActionMessage(
const ActionMessage&);
154 ActionMessage& operator=(
const ActionMessage&);
157 #if defined(HDI_CORE_PSP_MODE)
162 class AcquireMessage :
public Message
170 virtual ~AcquireMessage();
189 AcquireMessage(
const AcquireMessage&);
196 AcquireMessage& operator=(
const AcquireMessage&);
201 #if defined(HDI_CORE_AIP_MODE)
220 friend class Dispatcher;
234 AdapterMessage(
const AdapterMessage&);
241 AdapterMessage& operator=(
const AdapterMessage&);
250 typedef std::vector<Rect> RectVector;
252 typedef AIAnnotatorDrawer* ContextPtr;
323 friend class Dispatcher;
337 AnnotatorMessage(
const AnnotatorMessage&);
344 AnnotatorMessage& operator=(
const AnnotatorMessage&);
364 friend class Dispatcher;
378 ClipboardMessage(
const ClipboardMessage&);
385 ClipboardMessage& operator=(
const ClipboardMessage&);
404 friend class Dispatcher;
418 CommandMessage(
const CommandMessage&);
425 CommandMessage& operator=(
const CommandMessage&);
467 #if defined(HDI_CORE_PSP_MODE)
478 CallerType callerNumeric()
const;
491 int16_t selectorNumeric()
const;
497 friend class Dispatcher;
504 CustomMessage(
const std::string&,
const std::string&,
const MessageType,
void*);
506 #if defined(HDI_CORE_PSP_MODE)
512 CustomMessage(
const CallerType,
const int16_t,
const MessageType,
void*);
520 CustomMessage(
const CustomMessage&);
527 CustomMessage& operator=(
const CustomMessage&);
530 #if defined(HDI_CORE_PSP_MODE)
535 class ExportMessage :
public Message
543 virtual ~ExportMessage();
562 ExportMessage(
const ExportMessage&);
569 ExportMessage& operator=(
const ExportMessage&);
574 #if defined(HDI_CORE_AIP_MODE)
582 typedef std::vector< std::shared_ptr<Artboard> > ArtboardVector;
659 friend class Dispatcher;
673 FileFormatMessage(
const FileFormatMessage&);
680 FileFormatMessage& operator=(
const FileFormatMessage&);
685 #if defined(HDI_CORE_PSP_MODE)
756 #if defined(HDI_CORE_PSP_MODE)
769 bool shouldAbort()
const;
781 void setProgress(
const int32_t completed_,
const int32_t total_);
792 int16_t planes()
const;
802 int32_t maxSpace()
const;
811 int32_t bufferSpace()
const;
825 void setBufferSpace(
const int32_t bs_);
835 int16_t inLoPlane()
const;
847 void setInLoPlane(
const int16_t ilp_);
857 int16_t inHiPlane()
const;
869 void setInHiPlane(
const int16_t ihp_);
879 int16_t outLoPlane()
const;
891 void setOutLoPlane(
const int16_t olp_);
901 int16_t outHiPlane()
const;
913 void setOutHiPlane(
const int16_t ohp_);
923 void*
const inData()
const;
933 int32_t inRowBytes()
const;
943 void*
const outData()
const;
953 int32_t outRowBytes()
const;
1001 const PlatformDrawingContextPtr dc_,
1002 const PixelMap& srcPM_,
1003 const Rect& srcArea_,
1004 const Point& dstTL_,
1005 const Rect& dstArea_
1015 bool isFloating()
const;
1024 bool hasMask()
const;
1033 bool autoMask()
const;
1048 void setAutoMask(
const bool masked_);
1062 void*
const maskData()
const;
1071 int32_t maskRowBytes()
const;
1098 ColorSpace imageMode()
const;
1107 double hRes()
const;
1116 double vRes()
const;
1125 MonitorSpecs*
const monitor()
const;
1134 bool supportsDummyChannels()
const;
1145 bool supportsAlternateLayouts()
const;
1154 DataLayout wantLayout()
const;
1166 void setWantLayout(
const DataLayout wl_);
1178 FilterCase filterCase()
const;
1189 int16_t dummyPlaneValue()
const;
1201 void setDummyPlaneValue(
const int16_t dpv_);
1213 bool supportsAbsolute()
const;
1223 bool wantsAbsolute()
const;
1233 bool cannotUndo()
const;
1245 void setCannotUndo(
const bool undo_);
1254 bool supportsPadding()
const;
1263 int16_t inputPadding()
const;
1275 void setInputPadding(
const int16_t pad_);
1284 int16_t outputPadding()
const;
1296 void setOutputPadding(
const int16_t pad_);
1305 int16_t maskPadding()
const;
1317 void setMaskPadding(
const int16_t pad_);
1326 bool samplingSupport()
const;
1350 double inputRate()
const;
1359 void setInputRate(
const double rate_);
1383 double maskRate()
const;
1392 void setMaskRate(
const double rate_);
1415 int16_t inLayerPlanes()
const;
1426 int16_t inTransparencyMask()
const;
1437 int16_t inLayerMasks()
const;
1448 int16_t inInvertedLayerMasks()
const;
1459 int16_t inNonLayerPlanes()
const;
1470 int16_t outLayerPlanes()
const;
1481 int16_t outTransparencyMask()
const;
1492 int16_t outLayerMasks()
const;
1503 int16_t outInvertedLayerMasks()
const;
1514 int16_t outNonLayerPlanes()
const;
1526 int16_t absLayerPlanes()
const;
1538 int16_t absTransparencyMask()
const;
1550 int16_t absLayerMasks()
const;
1562 int16_t absInvertedLayerMasks()
const;
1574 int16_t absNonLayerPlanes()
const;
1584 int16_t inPreDummyPlanes()
const;
1594 int16_t inPostDummyPlanes()
const;
1604 int16_t outPreDummyPlanes()
const;
1614 int16_t outPostDummyPlanes()
const;
1626 int32_t inColumnBytes()
const;
1638 int32_t inPlaneBytes()
const;
1650 int32_t outColumnBytes()
const;
1662 int32_t outPlaneBytes()
const;
1673 int16_t inTileHeight()
const;
1684 int16_t inTileWidth()
const;
1693 Point inTileOrigin()
const;
1704 int16_t absTileHeight()
const;
1715 int16_t absTileWidth()
const;
1724 Point absTileOrigin()
const;
1735 int16_t outTileHeight()
const;
1746 int16_t outTileWidth()
const;
1755 Point outTileOrigin()
const;
1766 int16_t maskTileHeight()
const;
1777 int16_t maskTileWidth()
const;
1786 Point maskTileOrigin()
const;
1795 std::string errorString()
const;
1810 void setErrorString(
const std::string& error_);
1819 DocumentInfo*
const documentInfo()
const;
1828 int32_t depth()
const;
1844 int32_t hasImageScrap()
const;
1853 Size imageSize()
const;
1868 Rect filterRect()
const;
1877 Rect inRect()
const;
1891 void setInRect(
const Rect& ir_);
1900 Rect outRect()
const;
1914 void setOutRect(
const Rect& or_);
1923 Rect maskRect()
const;
1937 void setMaskRect(
const Rect& mr_);
1946 Point floatCoordinate()
const;
1955 Size wholeSize()
const;
1962 friend class Dispatcher;
1976 FilterMessage(
const FilterMessage&);
1983 FilterMessage& operator=(
const FilterMessage&);
1986 #if defined(HDI_CORE_AIP_MODE)
2003 friend class Dispatcher;
2017 LayerListMessage(
const LayerListMessage&);
2024 LayerListMessage& operator=(
const LayerListMessage&);
2083 friend class Dispatcher;
2097 LiveEffectGoMessage(
const LiveEffectGoMessage&);
2104 LiveEffectGoMessage& operator=(
const LiveEffectGoMessage&);
2123 friend class Dispatcher;
2130 LiveEffectEditParamsMessage(
const MessageType,
void*);
2137 LiveEffectEditParamsMessage(
const LiveEffectEditParamsMessage&);
2144 LiveEffectEditParamsMessage& operator=(
const LiveEffectEditParamsMessage&);
2163 friend class Dispatcher;
2170 LiveEffectInterpolateMessage(
const MessageType,
void*);
2177 LiveEffectInterpolateMessage(
const LiveEffectInterpolateMessage&);
2184 LiveEffectInterpolateMessage& operator=(
const LiveEffectInterpolateMessage&);
2203 friend class Dispatcher;
2217 LiveEffectInputMessage(
const LiveEffectInputMessage&);
2224 LiveEffectInputMessage& operator=(
const LiveEffectInputMessage&);
2243 friend class Dispatcher;
2250 LiveEffectConvertColorSpaceMessage(
const MessageType,
void*);
2257 LiveEffectConvertColorSpaceMessage(
const LiveEffectConvertColorSpaceMessage&);
2264 LiveEffectConvertColorSpaceMessage& operator=(
const LiveEffectConvertColorSpaceMessage&);
2283 friend class Dispatcher;
2290 LiveEffectAdjustColorsMessage(
const MessageType,
void*);
2297 LiveEffectAdjustColorsMessage(
const LiveEffectAdjustColorsMessage&);
2304 LiveEffectAdjustColorsMessage& operator=(
const LiveEffectAdjustColorsMessage&);
2323 friend class Dispatcher;
2330 LiveEffectScaleParamsMessage(
const MessageType,
void*);
2337 LiveEffectScaleParamsMessage(
const LiveEffectScaleParamsMessage&);
2344 LiveEffectScaleParamsMessage& operator=(
const LiveEffectScaleParamsMessage&);
2363 friend class Dispatcher;
2377 LiveEffectMergeMessage(
const LiveEffectMergeMessage&);
2384 LiveEffectMergeMessage& operator=(
const LiveEffectMergeMessage&);
2403 friend class Dispatcher;
2410 LiveEffectGetSVGFilterMessage(
const MessageType,
void*);
2417 LiveEffectGetSVGFilterMessage(
const LiveEffectGetSVGFilterMessage&);
2424 LiveEffectGetSVGFilterMessage& operator=(
const LiveEffectGetSVGFilterMessage&);
2443 friend class Dispatcher;
2450 LiveEffectIsCompatibleMessage(
const MessageType,
void*);
2457 LiveEffectIsCompatibleMessage(
const LiveEffectIsCompatibleMessage&);
2464 LiveEffectIsCompatibleMessage& operator=(
const LiveEffectIsCompatibleMessage&);
2469 #if defined(HDI_CORE_PSP_MODE)
2475 class MeasurementMessage :
public Message
2483 virtual ~MeasurementMessage();
2502 MeasurementMessage(
const MeasurementMessage&);
2509 MeasurementMessage& operator=(
const MeasurementMessage&);
2514 #if defined(HDI_CORE_AIP_MODE)
2540 friend class Dispatcher;
2554 MenuMessage(
const MenuMessage&);
2561 MenuMessage& operator=(
const MenuMessage&);
2598 friend class Dispatcher;
2612 NotifyMessage(
const NotifyMessage&);
2619 NotifyMessage& operator=(
const NotifyMessage&);
2641 friend class Dispatcher;
2655 ObjectSetMessage(
const ObjectSetMessage&);
2662 ObjectSetMessage& operator=(
const ObjectSetMessage&);
2683 friend class Dispatcher;
2697 PluginMessage(
const PluginMessage&);
2704 PluginMessage& operator=(
const PluginMessage&);
2707 #if defined(HDI_CORE_AIP_MODE)
2740 friend class Dispatcher;
2754 CustomArtMessage(
const CustomArtMessage&);
2761 CustomArtMessage& operator=(
const CustomArtMessage&);
2766 #if defined(HDI_CORE_PSP_MODE)
2770 class PickerMessage :
public Message
2778 virtual ~PickerMessage();
2797 PickerMessage(
const PickerMessage&);
2804 PickerMessage& operator=(
const PickerMessage&);
2809 #if defined(HDI_CORE_AIP_MODE)
2827 friend class Dispatcher;
2841 PreferencesMessage(
const PreferencesMessage&);
2848 PreferencesMessage& operator=(
const PreferencesMessage&);
2867 friend class Dispatcher;
2881 PropertiesMessage(
const PropertiesMessage&);
2888 PropertiesMessage& operator=(
const PropertiesMessage&);
2893 #if defined(HDI_CORE_PSP_MODE)
2897 class SelectionMessage :
public Message
2905 virtual ~SelectionMessage();
2924 SelectionMessage(
const SelectionMessage&);
2931 SelectionMessage& operator=(
const SelectionMessage&);
2936 #if defined(HDI_CORE_AIP_MODE)
2962 friend class Dispatcher;
2976 TimerMessage(
const TimerMessage&);
2983 TimerMessage& operator=(
const TimerMessage&);
3112 friend class Dispatcher;
3126 ToolMessage(
const ToolMessage&);
3133 ToolMessage& operator=(
const ToolMessage&);
3156 friend class Dispatcher;
3170 ToolboxMessage(
const ToolboxMessage&);
3177 ToolboxMessage& operator=(
const ToolboxMessage&);
3196 friend class Dispatcher;
3210 TransformAgainMessage(
const TransformAgainMessage&);
3217 TransformAgainMessage& operator=(
const TransformAgainMessage&);
3236 friend class Dispatcher;
3250 WorkspaceMessage(
const WorkspaceMessage&);
3257 WorkspaceMessage& operator=(
const WorkspaceMessage&);
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
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 ~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.
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.
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 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