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

Public Types

enum  AdornmentDrawOrder { kBeforeShape = 1, kAfterShape = 2, kAllAdornmentFlags = 3 }
 
enum  AdornmentDrawNumber { kNumberOfAdornments = 2 }
 
enum  AdornmentDrawMode { kNonTouchDrawMode = 0, kTouchDrawMode, kBothDrawMode }
 

Public Member Functions

virtual AdornmentDrawOrder GetDrawOrderBits ()=0
 
virtual void DrawAdornmentHandleShape (IHandleShape *iHandleShape, AdornmentDrawOrder adornmentDrawOrder, GraphicsData *gd, IConcreteSelection *concreteSelection, int32 flags=0)=0
 
virtual void DrawControlPointPath (IHandleShape *iHandleShape, AdornmentDrawOrder adornmentDrawOrder, GraphicsData *gd, int32 flags=0)=0
 
virtual bool16 HitTest (IHandleShape *iHandleShape, AdornmentDrawOrder adornmentDrawOrder, GraphicsData *gd, const PMRect &r, PointSelector *handleIndex, bool16 bDragging=kFalse)=0
 
virtual bool16 HitTestControlPointPath (IHandleShape *iHandleShape, AdornmentDrawOrder adornmentDrawOrder, GraphicsData *gd, const PMRect &r)=0
 
virtual PMRect GetPaintedAdornmentHandleBounds (IHandleShape *iHandleShape, AdornmentDrawOrder adornmentDrawOrder, const PMRect &itemBounds, const PMMatrix &innertoview)=0
 
virtual ITrackerQueryTracker (IHandleShape *iHandleShape, AdornmentDrawOrder adornmentDrawOrder, IControlView *layView, const PBPMPoint &where, int32 selectionMode, const PointSelector &index)=0
 
virtual ITipQueryTip (const PointSelector *handleIndex)=0
 
virtual AdornmentDrawMode GetAdornmentDrawMode ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Protected Member Functions

virtual void DrawAdornmentHandleShapeModeChecked (IHandleShape *iHandleShape, AdornmentDrawOrder adornmentDrawOrder, GraphicsData *gd, IConcreteSelection *concreteSelection, int32 flags=0)=0
 

Member Enumeration Documentation

Enumerator
kBeforeShape 

Before shape adornments

kAfterShape 

After shape adornments

kAllAdornmentFlags 

All the adornments

Member Function Documentation

virtual void IAdornmentHandleShape::DrawAdornmentHandleShape (IHandleShapeiHandleShape,
AdornmentDrawOrder adornmentDrawOrder,
GraphicsDatagd,
IConcreteSelectionconcreteSelection,
int32 flags = 0 
)
pure virtual

Draw the adorment handle shape. It is up to the adornment to save and restore the graphic state.

Parameters
iHandleShape[IN]the owning page item.
adornmentDrawOrder[IN]the draw order of the adornment, in case this adornment is used more than once.
gd[IN]the graphics context used for drawing.
concretSelection[IN]the selection boss.
flags[IN]default as kNoFlags and serves as a drawing flag.
virtual void IAdornmentHandleShape::DrawAdornmentHandleShapeModeChecked (IHandleShapeiHandleShape,
AdornmentDrawOrder adornmentDrawOrder,
GraphicsDatagd,
IConcreteSelectionconcreteSelection,
int32 flags = 0 
)
protectedpure virtual

Draw the adorment handle shape. It is up to the adornment to save and restore the graphic state.

Parameters
iHandleShape[IN]the owning page item.
adornmentDrawOrder[IN]the draw order of the adornment, in case this adornment is used more than once.
gd[IN]the graphics context used for drawing.
concretSelection[IN]the selection boss.
flags[IN]default as kNoFlags and serves as a drawing flag.
virtual void IAdornmentHandleShape::DrawControlPointPath (IHandleShapeiHandleShape,
AdornmentDrawOrder adornmentDrawOrder,
GraphicsDatagd,
int32 flags = 0 
)
pure virtual

Draw the path based on item's control points.

Parameters
iHandleShape[IN]the owning page item.
adornmentDrawOrder[IN]the draw order of the adornment, in case this adornment is used more than once.
gd[IN]the graphics context used for drawing.
flags[IN]default as kNoFlags and serves as a drawing flag.
virtual AdornmentDrawMode IAdornmentHandleShape::GetAdornmentDrawMode ()
pure virtual

Obtain the adornment draw mode kNonTouchDrawMode - Draw only in non touch mode kTouchDrawMode - Draw only in touch mode kBothDrawMode - Draw in both modes

virtual AdornmentDrawOrder IAdornmentHandleShape::GetDrawOrderBits ()
pure virtual

Retrieve the draw order flags

Returns
AdornmentDrawOrder flags.
virtual PMRect IAdornmentHandleShape::GetPaintedAdornmentHandleBounds (IHandleShapeiHandleShape,
AdornmentDrawOrder adornmentDrawOrder,
const PMRectitemBounds,
const PMMatrixinnertoview 
)
pure virtual

Returns the bounding box by computing it in pasteboard coords and then transforming it by inner to view.

Parameters
iHandleShape[IN]the owning page item.
adornmentDrawOrder[IN]the draw order of the adornment, in case this adornment is used more than once.
itemBounds[IN]the painted bounds of the page item.
innertoview[IN]inner to view matrix.
Returns
PMRect the bounds for painting(redrawing).
virtual bool16 IAdornmentHandleShape::HitTest (IHandleShapeiHandleShape,
AdornmentDrawOrder adornmentDrawOrder,
GraphicsDatagd,
const PMRectr,
PointSelectorhandleIndex,
bool16 bDragging = kFalse 
)
pure virtual

Check if a particular adornment handle of the item has been hit or not within the specified area.

Parameters
iHandleShape[IN]the owning page item.
adornmentDrawOrder[IN]the draw order of the adornment, in case this adornment is used more than once.
gd[IN]the graphics context used for hit testing.
r[IN]the area for checking hit test.
handleIndex[IN]the index of adornment handle.
bDragging[IN]the flag which indicates whether dragging is on or not.
Returns
bool16 kTrue if it hits, otherwise kFalse.
virtual bool16 IAdornmentHandleShape::HitTestControlPointPath (IHandleShapeiHandleShape,
AdornmentDrawOrder adornmentDrawOrder,
GraphicsDatagd,
const PMRectr 
)
pure virtual

Check if the control point path has been hit or not.

Parameters
iHandleShape[IN]the owning page item.
adornmentDrawOrder[IN]the draw order of the adornment, in case this adornment is used more than once.
gd[IN]the graphics context used for hit testing.
r[IN]the area for checking hit test.
Returns
bool16 kTrue if it hits, otherwise kFalse.
virtual ITip* IAdornmentHandleShape::QueryTip (const PointSelectorhandleIndex)
pure virtual

Query for any tip implemented on the Adornment. If there is any tip on the Adornment then the ITip interface Ptr will be returned else nil is returned in the default implementation.

Parameters
handleIndex[IN]the index of the handle for the adornment.
Returns
ITip* the result tip interface and caller should deference it.
virtual ITracker* IAdornmentHandleShape::QueryTracker (IHandleShapeiHandleShape,
AdornmentDrawOrder adornmentDrawOrder,
IControlViewlayView,
const PBPMPointwhere,
int32 selectionMode,
const PointSelectorindex 
)
pure virtual

Query the tracker based on the given mouse position, hit test mode and adornment handle index.

Parameters
iHandleShape[IN]the owning page item.
adornmentDrawOrder[IN]the draw order of the adornment, in case this adornment is used more than once.
layView[IN]the active layout view where mouse is on.
where[IN]the mouse position based on pasteboard coordinate.
selectionMode[IN]the hit test flags.
index[IN]specifies the index of adornment handle.
Returns
ITracker* the result tracker and caller should deference it.