7#ifndef __HDI_CORE_MESSAGE__
8#define __HDI_CORE_MESSAGE__
24 #if defined(HDI_CORE_AIP_MODE)
38 #if defined(HDI_CORE_PSP_MODE)
155 #if defined(HDI_CORE_PSP_MODE)
160 class AcquireMessage :
public Message
168 virtual ~AcquireMessage();
187 AcquireMessage(
const AcquireMessage&);
194 AcquireMessage& operator=(
const AcquireMessage&);
199 #if defined(HDI_CORE_AIP_MODE)
248 typedef std::vector<Rect> RectVector;
250 typedef AIAnnotatorDrawer* ContextPtr;
462 #if defined(HDI_CORE_PSP_MODE)
473 CallerType callerNumeric()
const;
486 int16_t selectorNumeric()
const;
501 #if defined(HDI_CORE_PSP_MODE)
525 #if defined(HDI_CORE_PSP_MODE)
530 class ExportMessage :
public Message
538 virtual ~ExportMessage();
557 ExportMessage(
const ExportMessage&);
564 ExportMessage& operator=(
const ExportMessage&);
569 #if defined(HDI_CORE_AIP_MODE)
577 typedef std::vector< std::shared_ptr<Artboard> > ArtboardVector;
680 #if defined(HDI_CORE_PSP_MODE)
751 #if defined(HDI_CORE_PSP_MODE)
764 bool shouldAbort()
const;
776 void setProgress(
const int32_t completed_,
const int32_t total_);
787 int16_t planes()
const;
797 int32_t maxSpace()
const;
806 int32_t bufferSpace()
const;
820 void setBufferSpace(
const int32_t bs_);
830 int16_t inLoPlane()
const;
842 void setInLoPlane(
const int16_t ilp_);
852 int16_t inHiPlane()
const;
864 void setInHiPlane(
const int16_t ihp_);
874 int16_t outLoPlane()
const;
886 void setOutLoPlane(
const int16_t olp_);
896 int16_t outHiPlane()
const;
908 void setOutHiPlane(
const int16_t ohp_);
918 void*
const inData()
const;
928 int32_t inRowBytes()
const;
938 void*
const outData()
const;
948 int32_t outRowBytes()
const;
996 const PlatformDrawingContextPtr dc_,
997 const PixelMap& srcPM_,
998 const Rect& srcArea_,
1000 const Rect& dstArea_
1010 bool isFloating()
const;
1019 bool hasMask()
const;
1028 bool autoMask()
const;
1043 void setAutoMask(
const bool masked_);
1057 void*
const maskData()
const;
1066 int32_t maskRowBytes()
const;
1093 ColorSpace imageMode()
const;
1102 double hRes()
const;
1111 double vRes()
const;
1120 MonitorSpecs*
const monitor()
const;
1129 bool supportsDummyChannels()
const;
1140 bool supportsAlternateLayouts()
const;
1149 DataLayout wantLayout()
const;
1161 void setWantLayout(
const DataLayout wl_);
1173 FilterCase filterCase()
const;
1184 int16_t dummyPlaneValue()
const;
1196 void setDummyPlaneValue(
const int16_t dpv_);
1208 bool supportsAbsolute()
const;
1218 bool wantsAbsolute()
const;
1228 bool cannotUndo()
const;
1240 void setCannotUndo(
const bool undo_);
1249 bool supportsPadding()
const;
1258 int16_t inputPadding()
const;
1270 void setInputPadding(
const int16_t pad_);
1279 int16_t outputPadding()
const;
1291 void setOutputPadding(
const int16_t pad_);
1300 int16_t maskPadding()
const;
1312 void setMaskPadding(
const int16_t pad_);
1321 bool samplingSupport()
const;
1345 double inputRate()
const;
1354 void setInputRate(
const double rate_);
1378 double maskRate()
const;
1387 void setMaskRate(
const double rate_);
1410 int16_t inLayerPlanes()
const;
1421 int16_t inTransparencyMask()
const;
1432 int16_t inLayerMasks()
const;
1443 int16_t inInvertedLayerMasks()
const;
1454 int16_t inNonLayerPlanes()
const;
1465 int16_t outLayerPlanes()
const;
1476 int16_t outTransparencyMask()
const;
1487 int16_t outLayerMasks()
const;
1498 int16_t outInvertedLayerMasks()
const;
1509 int16_t outNonLayerPlanes()
const;
1521 int16_t absLayerPlanes()
const;
1533 int16_t absTransparencyMask()
const;
1545 int16_t absLayerMasks()
const;
1557 int16_t absInvertedLayerMasks()
const;
1569 int16_t absNonLayerPlanes()
const;
1579 int16_t inPreDummyPlanes()
const;
1589 int16_t inPostDummyPlanes()
const;
1599 int16_t outPreDummyPlanes()
const;
1609 int16_t outPostDummyPlanes()
const;
1621 int32_t inColumnBytes()
const;
1633 int32_t inPlaneBytes()
const;
1645 int32_t outColumnBytes()
const;
1657 int32_t outPlaneBytes()
const;
1668 int16_t inTileHeight()
const;
1679 int16_t inTileWidth()
const;
1688 Point inTileOrigin()
const;
1699 int16_t absTileHeight()
const;
1710 int16_t absTileWidth()
const;
1719 Point absTileOrigin()
const;
1730 int16_t outTileHeight()
const;
1741 int16_t outTileWidth()
const;
1750 Point outTileOrigin()
const;
1761 int16_t maskTileHeight()
const;
1772 int16_t maskTileWidth()
const;
1781 Point maskTileOrigin()
const;
1790 std::string errorString()
const;
1805 void setErrorString(
const std::string& error_);
1814 DocumentInfo*
const documentInfo()
const;
1823 int32_t depth()
const;
1839 int32_t hasImageScrap()
const;
1848 Size imageSize()
const;
1863 Rect filterRect()
const;
1872 Rect inRect()
const;
1886 void setInRect(
const Rect& ir_);
1895 Rect outRect()
const;
1909 void setOutRect(
const Rect& or_);
1918 Rect maskRect()
const;
1932 void setMaskRect(
const Rect& mr_);
1941 Point floatCoordinate()
const;
1950 Size wholeSize()
const;
1981 #if defined(HDI_CORE_AIP_MODE)
2461 #if defined(HDI_CORE_PSP_MODE)
2467 class MeasurementMessage :
public Message
2475 virtual ~MeasurementMessage();
2494 MeasurementMessage(
const MeasurementMessage&);
2501 MeasurementMessage& operator=(
const MeasurementMessage&);
2506 #if defined(HDI_CORE_AIP_MODE)
2699 #if defined(HDI_CORE_AIP_MODE)
2758 #if defined(HDI_CORE_PSP_MODE)
2762 class PickerMessage :
public Message
2770 virtual ~PickerMessage();
2789 PickerMessage(
const PickerMessage&);
2796 PickerMessage& operator=(
const PickerMessage&);
2801 #if defined(HDI_CORE_AIP_MODE)
2885 #if defined(HDI_CORE_PSP_MODE)
2889 class SelectionMessage :
public Message
2897 virtual ~SelectionMessage();
2916 SelectionMessage(
const SelectionMessage&);
2923 SelectionMessage& operator=(
const SelectionMessage&);
2928 #if defined(HDI_CORE_AIP_MODE)
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
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 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.
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.
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 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