hdi::core::Message Class Reference

Base class for all *Message subclasses. More...

#include <hdicoreMessage.h>

Inheritance diagram for hdi::core::Message:

Public Member Functions
virtual	~Message ()
	Destructs a Message object.
virtual MessageType	type () const
	Gets the type of message data the target object represents.
virtual void *	rawData () const
	Gets the raw Illustrator message data struct.

Protected Member Functions
	Message ()
	Internal use only.
	Message (const Message &)
	Unused.
Message &	operator= (const Message &)
	Unused.

Protected Attributes
void *	_data
	Stores private implementation data.

Detailed Description

Base class for all *Message subclasses.

Constructor & Destructor Documentation

~Message()

virtual hdi::core::Message::~Message ( )

virtual

Destructs a Message object.

Author

GW

Date

08/2013

Message() [1/2]

hdi::core::Message::Message ( )

protected

Internal use only.

Author

GW

Date

08/2013

Message() [2/2]

hdi::core::Message::Message ( const Message & )

protected

Unused.

Author

GW

Date

02/2015

Member Function Documentation

operator=()

Message & hdi::core::Message::operator= ( const Message & )

protected

Unused.

Author

GW

Date

02/2015

Returns

The target Message object, but with its values updated to match that of the param

rawData()

virtual void * hdi::core::Message::rawData ( ) const

virtual

Gets the raw Illustrator message data struct.

Author

GW

Date

08/2022

Returns

A pointer to the raw Illustrator message data that relates to the target object (and its subclass)

Warning

Use this method at your own risk; generally, you shouldn't need to call it. Only use it if you know what you're doing. If a specific piece of functionality provided by the app is not handled by this class (or related classes), then it should probably be added to the hdi_core library.

It is your responsibility to cast the void* to the proper data type based on the type of message to which the target relates. For example, the AnnotatorMessage class very likely wraps raw data of type AIAnnotatorMessage* (which you can determine by looking at which specific messages result in an AnnotatorMessage object and checking the Illustrator SDK documentation to see the related AIAnnotatorMessage struct).

type()

virtual MessageType hdi::core::Message::type ( ) const

virtual

Gets the type of message data the target object represents.

Author

GW

Date

08/2013

Returns

Message type (useful for determining how to cast a Message object to its subclass)