InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ITableAttrGradient Class Referenceabstract

#include <ITableAttrGradient.h>

Inheritance diagram for ITableAttrGradient:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITABLEATTRGRADIENT }
 

Public Member Functions

virtual PMPoint GetStartPt (const PMRect &area=kUnitArea) const =0
 
virtual void SetStartPt (const PMPoint &value, const PMRect &area=kUnitArea)=0
 
virtual PMReal GetAngle (const PMRect &area=kUnitArea) const =0
 
virtual PMReal GetLength (const PMRect &area=kUnitArea) const =0
 
virtual void SetEndPt (const PMReal &length, const PMReal &angle, const PMRect &area=kUnitArea)=0
 
virtual PMReal GetHiliteAngle (const PMRect &area=kUnitArea) const =0
 
virtual PMReal GetHiliteLength (const PMRect &area=kUnitArea) const =0
 
virtual void SetHilite (const PMReal &length, const PMReal &angle, const PMRect &area=kUnitArea)=0
 
virtual bool16 IsEqual (const ITableAttrGradient *rhs) const =0
 
virtual void SetAngle (const PMReal &angle)=0
 
virtual void SetLength (const PMReal &length)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Abstract interface representing table attribute that stores gradient parameters. Both the fill and the stroke of a cell in a table can have gradient attributes associated.

Member Function Documentation

virtual PMReal ITableAttrGradient::GetAngle (const PMRect & area = kUnitArea) const
pure virtual

Accessor for the gradient angle.

Angle and length specify a vector that is anchored at start point and points to the end point. For a linear gradient this specifies the rectangle in the table frame that encompasses the gradient. For a radial gradient this defines the inner disk. Note that angles are in degrees...

Parameters
area– usually the bounds of the Table Frame, point is returned relative to the area, if no area is passed in then the normalized point is returned
Returns
virtual PMReal ITableAttrGradient::GetHiliteAngle (const PMRect & area = kUnitArea) const
pure virtual

Accessor for the hilite angle, only relevant to radial gradients.

Hilite length and hilite angle are only used for radial gradients when you click (not drag) with the gradient tool. They are used to define the outer circle.

Parameters
area– usually the bounds of the Table Frame, point is returned relative to the area, if no area is passed in then the normalized point is returned
Returns
virtual PMReal ITableAttrGradient::GetHiliteLength (const PMRect & area = kUnitArea) const
pure virtual

Accessor for the hilite length, only relevant to radial gradients.

Parameters
area– usually the bounds of the Table Frame, length is returned relative to the area, if no area is passed in then the normalized length is returned
Returns
virtual PMReal ITableAttrGradient::GetLength (const PMRect & area = kUnitArea) const
pure virtual

Accessor for the gradient length. See GetAngle().

Parameters
area– usually the bounds of the Table Frame, length is returned relative to the area, if no area is passed in then the normalized length is returned
Returns
length relative to the area, Normalized if no area is passed in
virtual PMPoint ITableAttrGradient::GetStartPt (const PMRect & area = kUnitArea) const
pure virtual

Accessor for the gradient "start-point".

For linear gradients this is the start point. For radial gradients this is the inner center point.

Parameters
area– usually the bounds of the Table Frame, point is returned relative to the area, if no area is passed in then the normalized point is returned
Returns
StartPt relative to the area, Normalized if no area is passed in
virtual bool16 ITableAttrGradient::IsEqual (const ITableAttrGradient * rhs) const
pure virtual

Method to allow a comparison of this gradient attribute and a comparand.

Parameters
rhsspecifies the gradient to compare this gradient against
Returns
kTrue if the gradients are equal, kFalse otherwise
virtual void ITableAttrGradient::SetAngle (const PMReal & angle)
pure virtual

Mutator for the angle

Use SetAngle & SetLength only if you call SetStartPt with kUnitArea. See GetAngle for dicussion of angle

Parameters
angleof normalized vector
Returns
virtual void ITableAttrGradient::SetEndPt (const PMReal & length,
const PMReal & angle,
const PMRect & area = kUnitArea 
)
pure virtual

Mutator for the gradient end-point.

Parameters
length
angle
area– usually the bounds of the Table Frame to normalize the point, if no value is passed in we assume it is normalized
virtual void ITableAttrGradient::SetHilite (const PMReal & length,
const PMReal & angle,
const PMRect & area = kUnitArea 
)
pure virtual

Mutator for the hilite length, only relevant to radial gradients.

Parameters
length
angle
area– usually the bounds of the Table Frame to normalize the point, if no value is passed in we assume it is normalized
virtual void ITableAttrGradient::SetLength (const PMReal & length)
pure virtual

Mutator for the gradient length.

Use SetAngle & SetLength only if you call SetStartPt with kUnitArea. See GetAngle for discussion of length.

Parameters
lengthlength of normalized vector
virtual void ITableAttrGradient::SetStartPt (const PMPoint & value,
const PMRect & area = kUnitArea 
)
pure virtual

Mutator for the gradient "start-point".

For linear gradients this is the start point. For radial gradients this is the inner center point.

Parameters
value,:New StartPt
area– usually the bounds of the Table Frame to normalize the point, if no value is passed in we assume it is normalized