Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
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. More...
 
std::string caller () const
 Gets the caller string that was received with the message. More...
 
std::string selector () const
 Gets the selector string that was received with the message. More...
 
void * data () const
 Gets a pointer to the data that was received with the message. More...
 
- Public Member Functions inherited from hdi::core::Message
virtual ~Message ()
 Destructs a Message object. More...
 
virtual MessageType type () const
 Gets the type of message data the target object represents. More...
 

Friends

class Dispatcher
 

Additional Inherited Members

- Protected Member Functions inherited from hdi::core::Message
 Message ()
 Internal use only. More...
 
 Message (const Message &)
 Unused. More...
 
Messageoperator= (const Message &)
 Unused. More...
 
- 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

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

Destructs a CustomMessage object.

Author
GW
Date
08/2013

Member Function Documentation

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
void* hdi::core::CustomMessage::data ( ) const

Gets a pointer to the data that was received with the message.

Author
GW
Date
04/2014
Returns
A pointer to the message data. It is the method caller's responsibility to cast it properly. Typically, memory allocated for the message data does not need to be managed by the method caller.
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