InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextSelectionAdornment Class Referenceabstract
Inheritance diagram for ITextSelectionAdornment:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTSELECTIONADORNMENT }
 

Public Member Functions

virtual void DrawAdornment (const IWaxLineHilite *waxLineHilite, const K2Vector< PMPolygon4 > *pSetOfHighlightBounds, IGraphicsContext *gc, int32 flags)=0
 
virtual bool16 HitTest (const PMPoint &mousePoint) const =0
 
virtual bool16 IsMouseWithinHoverRect (const PMPoint &mousePoint) const =0
 
virtual PMRect GetAdornmentBounds () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual void ITextSelectionAdornment::DrawAdornment (const IWaxLineHilitewaxLineHilite,
const K2Vector< PMPolygon4 > * pSetOfHighlightBounds,
IGraphicsContextgc,
int32 flags 
)
pure virtual

DrawAdornment draws the page item adornment.

Parameters
gdIN The current GraphicsData.
pSetOfHighlightBoundsIN highlight bounds in waxline space.
gcIN graphics context.
flagsIN The graphics's ports flags.
virtual PMRect ITextSelectionAdornment::GetAdornmentBounds () const
pure virtual
This method will return the adornment bounds for the adornment.

Parameters
layoutViewview
mousePointMouse point in Window coordinates
Returns
true if mouse is over adornment
virtual bool16 ITextSelectionAdornment::HitTest (const PMPointmousePoint) const
pure virtual

This method will return true if the mouse point is over the adornment. If you override this you will need to call this directly. It is not hooked into any other hit test framework.

Parameters
layoutViewview
mousePointMouse point in Window coordinates
Returns
true if mouse is over adornment
virtual bool16 ITextSelectionAdornment::IsMouseWithinHoverRect (const PMPointmousePoint) const
pure virtual

This method will return true if the mouse point is within the hover rect. This is used to dismiss the context UI in case mouse goes out of the hover rect.

Parameters
layoutViewview
mousePointMouse point in Window coordinates
Returns
true if mouse is over adornment