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

Public Types

enum  { kDefaultIID = IID_IWAXLINEHILITE }
 

Public Member Functions

virtual void GetHighlightBounds (const PMMatrix &toWindow, bool16 XORmode, const PMRect &highlightAdjust, const PMLineSeg &maxTopBottom, K2Vector< PMPolygon4 > *pSetOfHighlightBounds) const =0
 
virtual void GetHighlightBounds (int32 offset, int32 length, const PMMatrix &toWindow, bool16 XORmode, const PMRect &highlightAdjust, const PMLineSeg &maxTopBottom, K2Vector< PMPolygon4 > *pSetOfHighlightBounds) const =0
 
virtual void DrawLineHighlight (IGraphicsContext *gc, const K2Vector< PMPolygon4 > *pSetOfHighlightBounds) const =0
 
virtual const
ITextSelectionAdornment
GetTextSelectionAdornment () 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 IWaxLineHilite::DrawLineHighlight (IGraphicsContextgc,
const K2Vector< PMPolygon4 > * pSetOfHighlightBounds 
) const
pure virtual
Draw the highlight for the given set of bounds on the given IGraphicsContext.

Parameters
gcIN Where to draw the bounds.
pSetOfHighlightBoundsIN The set of bounds returned from GetHighlightBounds().
virtual void IWaxLineHilite::GetHighlightBounds (const PMMatrixtoWindow,
bool16 XORmode,
const PMRecthighlightAdjust,
const PMLineSegmaxTopBottom,
K2Vector< PMPolygon4 > * pSetOfHighlightBounds 
) const
pure virtual

Get the set of bounds that would be highlighted for the entire range of text within the waxLine. See the other GetHighlightBounds() method for details.

virtual void IWaxLineHilite::GetHighlightBounds (int32 offset,
int32 length,
const PMMatrixtoWindow,
bool16 XORmode,
const PMRecthighlightAdjust,
const PMLineSegmaxTopBottom,
K2Vector< PMPolygon4 > * pSetOfHighlightBounds 
) const
pure virtual

Get the set of bounds to highlight for the given range on the waxLine.

Parameters
offsetIN where in the line to start the computation for the highlight (0 for the start of the waxLine)
lengthIN the length of the text to highlight (-1 can be used to denote the rest of the text to the end of the waxLine)
toWindowIN Matrix that converts to window coordinates from this.
XORmodeIN If kFalse indicates that the caller will not use XOR to highlight.
highlightAdjustIN Used to indicate that an amount should be shaved off the highlight on the indicated side (used to prevent double XOR problems when two (adjacent) waxLine's highlights touch).
maxTopBottomIN is used to prevent double XOR problems when waxLines are too close together.
  • any highlight should be trimmed to these bounds (if DeltaY() is non-zero).
pSetOfHighlightBoundsOUT the resulting set of bounds. There may be none, one, or many bounds that apply to this line.
virtual const ITextSelectionAdornment* IWaxLineHilite::GetTextSelectionAdornment () const
pure virtual

Get the associated text selection adornment if any.