InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPathPageItem Class Referenceabstract

#include <IPathPageItem.h>

Inheritance diagram for IPathPageItem:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPATHPAGEITEM }
 

Public Member Functions

virtual void Stroke (IGraphicsPort *gPort)=0
 
virtual void Fill (IGraphicsPort *gPort)=0
 
virtual void Clip (IGraphicsPort *gPort)=0
 
virtual void CopyPath (IGraphicsPort *gPort)=0
 
virtual PMRect GetStrokeBoundingBox (const PMMatrix &theMatrix)=0
 
virtual PMRect GetPaintedBoundingBox (const PMMatrix &theMatrix)=0
 
virtual bool16 InStroke (IGraphicsPort *gPort, const PMRect &r)=0
 
virtual bool16 InFill (IGraphicsPort *gPort, const PMRect &r)=0
 
virtual void GetOutlineInfo (IOutlineInfo *iOutlineInfo)=0
 
virtual bool16 InFill (IGraphicsPort *gPort, const PMRect &r, int32 whichPath)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface is designed to encapsulate the drawing, hit testing, and querying of path-based page items. All bosses must include an IID_IGRAPHICSTYLE_DESCRIPTOR interface as well.

Member Enumeration Documentation

anonymous enum

Define the default interface IID as IID_IPATHPAGEITEM.

Member Function Documentation

virtual void IPathPageItem::Clip (IGraphicsPortgPort)
pure virtual

Clip creates the path, including corners and clips it. Does not do a gsave/grestore. Depending on the attributes it will use even odd or winding rule.

Parameters
gPort[IN] parameter the graphics port that does clip operation.
Returns
void.
virtual void IPathPageItem::CopyPath (IGraphicsPortgPort)
pure virtual

Copies the path into the graphicsport includes corners.

Parameters
gPort[IN] parameter the graphics port that source path comes from.
Returns
void.
virtual void IPathPageItem::Fill (IGraphicsPortgPort)
pure virtual

Fill creates the path, including corners and fills it. Does not do a gsave/grestore. Depending on the attributes it will use even odd or winding rule.

Parameters
gPort[IN] parameter the graphics port that does fill operation.
Returns
void.
virtual void IPathPageItem::GetOutlineInfo (IOutlineInfoiOutlineInfo)
pure virtual

Return the outline of the path including corner effects.

Parameters
iOutlineInfo[IN] parameter used as the call back function.
Returns
void.
virtual PMRect IPathPageItem::GetPaintedBoundingBox (const PMMatrixtheMatrix)
pure virtual

Same as GetStrokeBoundingBox except it tries to guarantee that invalidations with this bounds will not leave stuff on the screen.

Parameters
theMatrix[IN] parameter the matrix that does the transformation before returning the result.
Returns
PMRect the result bounding box.
virtual PMRect IPathPageItem::GetStrokeBoundingBox (const PMMatrixtheMatrix)
pure virtual

Returns the bounding box for the entire stroked path, including corners and line ends. The bounding box is converted using the passed in matrix. This GetStrokeBoundingBox() returns the theoretical bounds.

Parameters
theMatrix[IN] parameter the matrix that does the transformation before returning the result.
Returns
PMRect the result bounding box.
virtual bool16 IPathPageItem::InFill (IGraphicsPortgPort,
const PMRectr 
)
pure virtual

Check whether the given rectangle intersects the fill. The rectangle is in device space.

Parameters
gPort[IN] parameter the graphics port that the operation happens.
r[IN] parameter the given rectangle.
Returns
bool16 kTrue if the given rectangles intersects the fill, otherwise kFalse.
virtual bool16 IPathPageItem::InFill (IGraphicsPortgPort,
const PMRectr,
int32 whichPath 
)
pure virtual

Check whether the given rectangle intersects the fill of the given path. The rectangle is in device space.

Parameters
gPort[IN] parameter the graphics port that the operation happens.
r[IN] parameter the given rectangle.
whichPath[IN] parameter the given path.
Returns
bool16 kTrue if the given rectangles intersects the fill, otherwise kFalse.
virtual bool16 IPathPageItem::InStroke (IGraphicsPortgPort,
const PMRectr 
)
pure virtual

Check whether the given rectangle intersects the stroke. The rectangle is in device space.

Parameters
gPort[IN] parameter the graphics port that the operation happens.
r[IN] parameter the given rectangle.
Returns
bool16 kTrue if the given rectangles intersects the stroke, otherwise kFalse.
virtual void IPathPageItem::Stroke (IGraphicsPortgPort)
pure virtual

Stroke creates the full path, including corners and line ends, and strokes it. Does not do a gsave/grestore.

Parameters
gPort[IN] parameter the graphics port that does stroke operation.
Returns
void.