hdi::core::AnnotatorMessage Class Reference

Received for AnnotationDrawMessageType and AnnotationInvalidateMessageType. More...

#include <hdicoreMessage.h>

Inheritance diagram for hdi::core::AnnotatorMessage:

Collaboration diagram for hdi::core::AnnotatorMessage:

Public Types
typedef std::vector< Rect >	RectVector
typedef AIAnnotatorDrawer *	ContextPtr

Public Member Functions
virtual	~AnnotatorMessage ()
	Destructs a AnnotatorMessage object.
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.
DocumentView *const	docView () const
	Gets the DocumentView to which the message applies.
bool	triggeredByDragScroll () const
	Gets whether the message was sent due to the view scrolling during a mouse drag event.
bool	showEdges () const
	Gets whether an outline should be drawn around the annotation area.
RectVector *const	invalidationRects () const
	Gets the regions of the view that have been invalidated and need to be redrawn.
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.
Message &	operator= (const Message &)
	Unused.
Protected Attributes inherited from hdi::core::Message
void *	_data
	Stores private implementation data.

Detailed Description

Received for AnnotationDrawMessageType and AnnotationInvalidateMessageType.

Constructor & Destructor Documentation

~AnnotatorMessage()

virtual hdi::core::AnnotatorMessage::~AnnotatorMessage ( )

virtual

Destructs a AnnotatorMessage object.

Author

GW

Date

08/2013

Member Function Documentation

annotator()

Annotator *const hdi::core::AnnotatorMessage::annotator

(

)

const

Gets the Annotator object to which the message applies.

Author

GW

Date

08/2013

Returns

The annotator that should draw (or invalidate) as a result of this message

context()

const ContextPtr hdi::core::AnnotatorMessage::context

(

)

const

Gets the annotation context for the target message.

Author

GW

Date

03/2014

Returns

A constant pointer to the annotation context

Note

The caller must not dispose/release the annotation context itself.

docView()

DocumentView *const hdi::core::AnnotatorMessage::docView

(

)

const

Gets the DocumentView to which the message applies.

Author

GW

Date

08/2013

Returns

The document view, in which annotations should be drawn (or invalidated)

invalidationRects()

RectVector *const hdi::core::AnnotatorMessage::invalidationRects

(

)

const

Gets the regions of the view that have been invalidated and need to be redrawn.

Author

GW

Date

08/2013

Returns

All view regions that have been invalidated

Note

These regions also double as clip rects when only portions of a drawn area have been invalidated.

showEdges()

bool hdi::core::AnnotatorMessage::showEdges

(

)

const

Gets whether an outline should be drawn around the annotation area.

Author

GW

Date

08/2013

Returns

true when an outline should be drawn, false otherwise

triggeredByDragScroll()

bool hdi::core::AnnotatorMessage::triggeredByDragScroll

(

)

const

Gets whether the message was sent due to the view scrolling during a mouse drag event.

Author

GW

Date

08/2013

Returns

true if auto-scrolling due to dragging occurred, false otherwise