Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
hdi::core::CustomMessage Class Reference

Received for any custom messages (i.e. custom caller/selector pairs) More...

#include <hdicoreMessage.h>

Inheritance diagram for hdi::core::CustomMessage:
Inheritance graph
[legend]
Collaboration diagram for hdi::core::CustomMessage:
Collaboration graph
[legend]

Public Member Functions

virtual ~CustomMessage ()
 Destructs a CustomMessage object.
 
std::string caller () const
 Gets the caller string that was received with the message.
 
std::string selector () const
 Gets the selector string that was received with the message.
 
- Public Member Functions inherited from hdi::core::Message
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.
 

Friends

class Dispatcher
 

Additional Inherited Members

- Protected Member Functions inherited from hdi::core::Message
 Message ()
 Internal use only.
 
 Message (const Message &)
 Unused.
 
Messageoperator= (const Message &)
 Unused.
 
- Protected Attributes inherited from hdi::core::Message
void * _data
 Stores private implementation data.
 

Detailed Description

Received for any custom messages (i.e. custom caller/selector pairs)

Constructor & Destructor Documentation

◆ ~CustomMessage()

virtual hdi::core::CustomMessage::~CustomMessage ( )
virtual

Destructs a CustomMessage object.

Author
GW
Date
08/2013

Member Function Documentation

◆ caller()

std::string hdi::core::CustomMessage::caller ( ) const

Gets the caller string that was received with the message.

Author
GW
Date
04/2014
Returns
The caller string as received by the dispatcher
Note
The return value might be "" for Photoshop, in which case the callerNumeric() method should be used.

◆ selector()

std::string hdi::core::CustomMessage::selector ( ) const

Gets the selector string that was received with the message.

Author
GW
Date
04/2014
Returns
The selector string as received by the dispatcher
Note
The return value might be "" for Photoshop, in which case the selectorNumeric() method should be used.