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

#include <IGradientFillInstall.h>

Inheritance diagram for IGradientFillInstall:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IGRADIENTFILLINSTALL }
 

Public Member Functions

virtual void InstallGradient (IGraphicsPort *port, const PMRect &r, PMReal angle, K2Vector< PMReal > *gradBound, K2Vector< PMReal > *gradMidPoint, GradientType gradType)=0
 
virtual void InstallGradient (IGraphicsPort *port, PMReal length, PMPoint innerCenter, PMPoint outerCenter, PMReal radius, PMReal angle, PMReal hiliteLen, PMReal hiliteAngle, K2Vector< PMReal > *gradBound, K2Vector< PMReal > *gradMidPoint, GradientType gradType, PMMatrix gradMatrix)=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 helps to install a gradient rendering object in the graphic port. To use, you have to set up all the attribute of the gradient first. This is done by using the IGRADIENTFILL interface. Gradient rendering objects are defined in GradientFillID.h.

See Also
GradientFillID.h
IRenderingObject
IGradientFill

Member Function Documentation

virtual void IGradientFillInstall::InstallGradient (IGraphicsPortport,
const PMRectr,
PMReal angle,
K2Vector< PMReal > * gradBound,
K2Vector< PMReal > * gradMidPoint,
GradientType gradType 
)
pure virtual

This method is typcially used to install a gradient for proxy and swatch icons.

Parameters
portthe graphic port in which to install the gradient object.
rthe rectangular arear where the gradient will be installed.
anglethe gradient angle.
gradBoundthe list of gradient stop positions.
gradMidPointthe list of gradinet mid points.
gradTypethe gradient type to install.
virtual void IGradientFillInstall::InstallGradient (IGraphicsPortport,
PMReal length,
PMPoint innerCenter,
PMPoint outerCenter,
PMReal radius,
PMReal angle,
PMReal hiliteLen,
PMReal hiliteAngle,
K2Vector< PMReal > * gradBound,
K2Vector< PMReal > * gradMidPoint,
GradientType gradType,
PMMatrix gradMatrix 
)
pure virtual

This method is typcially used to install either a gradient fill or a gradient stroke of an InDesign document objects such as page items, text, or table objects. All relevant graphic attributes are taken into account when the gradient is installed.

Parameters
portthe graphic port in which to install the gradient object.
lengththe gradient length.
radiusthe gradient radius.
anglethe gradient angle.
hiliteLenthe gradient highlight length.
hiliteAnglethe gradient highlight angle.
gradBoundthe list of gradient stop positions.
gradMidPointthe list of gradinet mid points.
gradTypethe gradient type to install.
gradMatrixthe transformation matrix for the gradient.