IRenderingObject Class Reference

#include <IRenderingObject.h>

Inheritance diagram for IRenderingObject:

Public Types
enum	{ kDefaultIID = IID_IRENDERINGOBJECT }
enum	InstallAction { kInstallStroke, kInstallFill, kInstallGap }

Public Member Functions
virtual void	Install (IGraphicsPort *gPort, IGraphicStyleDescriptor *iGSDesc, InstallAction theAction) const =0
virtual void	Install (IGraphicsPort *gPort, IWaxRenderData *iWaxData, InstallAction theAction) const =0
virtual void	Install (IGraphicsPort *gPort, IGraphicAttributeSuite *iGfxAttrSuite, InstallAction theAction, const PMRect &r) const =0
virtual void	Install (IGraphicsPort *gPort, const AttributeBossList &attrs, const PMRect &r, InstallAction theAction) const =0
virtual void	Install (IGraphicsPort *gPort, const PMRect &r) const =0
virtual void	Install (IGraphicsPort *gPort, RenderingObjectInstallData *data, const PMRect &r, InstallAction theAction) const =0
virtual const PMString &	GetSwatchUIName () const =0
virtual PMString	GetTipText () const =0
virtual PMString	GetTipText (const int32 &colorSpace, const ColorArray &colorComponents) const =0
virtual const PMString &	GetSwatchName () const =0
virtual bool16	GetVisibility () const =0
virtual bool16	GetCanDelete () const =0
virtual bool16	GetCanEdit () const =0
virtual bool16	IsGlobal () const =0
virtual UID	GetSwatchAliasUID () const =0
virtual void	SetSwatchName (const PMString &newName)=0
virtual void	SetVisibility (const bool16 visible)=0
virtual void	SetCanDelete (const bool16 canDelete)=0
virtual void	SetCanEdit (const bool16 canEdit)=0
virtual void	SetSwatchAliasUID (UID newAliasUID)=0
virtual int32	GetCreatorID () const =0
virtual void	SetCreatorID (int32 newCreatorID)=0
virtual int32	GetSpecialEditInfo () const =0
virtual void	SetSpecialEditInfo (const int32 newEditInfo)=0
virtual bool16	NeedUpdate (UID interestedUID) const =0
virtual UID	DuplicateAsLocal (const IGraphicStyleDescriptor *overrideAttrs, InstallAction theAction) const =0
virtual UID	DuplicateAsLocal (const AttributeBossList *overrideAttrs, InstallAction theAction) const =0
virtual UID	DuplicateAsLocal (const PMReal &tint) const =0
virtual ClassID	GetRenderClass () const =0
virtual bool16	IsEqual (const IRenderingObject *iRenderObject2) const =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

A reqruied interface for all InDesign rendering objects. All rendering objects are represented by swatches. ISwatchList

Member Enumeration Documentation

enum IRenderingObject::InstallAction

Specifies how the rendering object are being installed.

Enumerator
kInstallStroke	Indicate installing the rendering object for stroke.
kInstallFill	Indicate installing the rendering object for fill.
kInstallGap	Indicate installing the rendering object for stroke gap. Gap color is currently not valid for text.

Member Function Documentation

virtual UID IRenderingObject::DuplicateAsLocal ( const IGraphicStyleDescriptor *  overrideAttrs, InstallAction  theAction  ) const

pure virtual

Duplicate this rendering object as a new unnamed rendering object taking into account any stroke or fill's overriding attributes if any. Returns the new UID that it created. "overrideAttrs" is either a graphic attribute boss list or a text attribute boss list. DuplicateAsLocal must be called within a command sequence in order for the Undo/Redo to be performed correctly.

Implemented in CRenderingObject.

virtual UID IRenderingObject::DuplicateAsLocal ( const AttributeBossList *  overrideAttrs, InstallAction  theAction  ) const

pure virtual

See Also

DuplicateAsLocal

Implemented in CRenderingObject.

virtual UID IRenderingObject::DuplicateAsLocal ( const PMReal &  tint ) const

pure virtual

See Also

DuplicateAsLocal

Implemented in CRenderingObject.

virtual bool16 IRenderingObject::GetCanDelete ( ) const

pure virtual

Returns kTrue if swtach can be deleted.

Returns

kTrue if swtach can be deleted.

Implemented in CRenderingObject.

virtual bool16 IRenderingObject::GetCanEdit ( ) const

pure virtual

Returns kTrue if swtach can be edited.

Returns

kTrue if swtach can be edited.

Implemented in CRenderingObject.

virtual int32 IRenderingObject::GetCreatorID ( ) const

pure virtual

Returns the swatch's creator ID. By default, swatch creator ID is set to kInDesignNativeSwatchCreatorID.

Returns

the creator ID.

Implemented in CRenderingObject.

virtual ClassID IRenderingObject::GetRenderClass ( ) const

pure virtual

Returns the rendering class.

Returns

the rendering class.

Implemented in CRenderingObject.

virtual int32 IRenderingObject::GetSpecialEditInfo ( ) const

pure virtual

Used to get/set special edit info about the render object. Using 0 to mean normal edit condition. Example: for a solid color, it can indicate which data elements can be edited which can't.

Returns

the four byte containing special edit info.

Implemented in CRenderingObject.

virtual UID IRenderingObject::GetSwatchAliasUID ( ) const

pure virtual

Returns the swatch's alias swatch UID.

Returns

the swatch's alias swatch UID.

Implemented in CRenderingObject.

virtual const PMString& IRenderingObject::GetSwatchName ( ) const

pure virtual

Returns the swatch name associated with this rendering object.

Returns

a PMString reference that is the rendering object' swatch name. Make sure that you do not use the reference to the name after the pointer to the IRenderingObject goes out of scope.

Implemented in CRenderingObject.

virtual const PMString& IRenderingObject::GetSwatchUIName ( ) const

pure virtual

Returns the string that includes the name as well as other information that appears in various UI elements such as tint percentage.

Returns

a PMString reference that is the rendering object's UI name. Make sure that you do not use the reference to the name after the pointer to the IRenderingObject goes out of scope.

Implemented in CRenderingObject.

virtual PMString IRenderingObject::GetTipText ( ) const

pure virtual

Returns the string that contains color info which is used as tip.

Returns

a PMString that is the rendering object tip text.

Implemented in CRenderingObject.

virtual PMString IRenderingObject::GetTipText ( const int32 &  colorSpace, const ColorArray &  colorComponents  ) const

pure virtual

Returns the string that contains color info which is used as tip using the specified color space and values.

Parameters

colorSpace	the color space to format.
colorComponents	the color values to format.

Returns

a PMString that is the rendering object tip text.

Implemented in CRenderingObject.

virtual bool16 IRenderingObject::GetVisibility ( ) const

pure virtual

Returns kTrue if swtach is visible in the swatches panel and other UI elements.

Returns

kTrue if swtach is visible in UI.

Implemented in CRenderingObject.

virtual void IRenderingObject::Install ( IGraphicsPort *  gPort, IGraphicStyleDescriptor *  iGSDesc, InstallAction  theAction  ) const

pure virtual

Install the rendering object for a pageitem with graphic attributes

Parameters

gPort	the graphic port in which to install the rendering object.
iGSDesc	the graphic style descriptor.
theAction	specifies which install action to do.

Implemented in CRenderingObject.

virtual void IRenderingObject::Install ( IGraphicsPort *  gPort, IWaxRenderData *  iWaxData, InstallAction  theAction  ) const

pure virtual

Install the rendering object for text.

Parameters

gPort	the graphic port in which to install the rendering object.
iGSDesc	the graphic style descriptor.
theAction	specifies which install action to do.

Implemented in CRenderingObject.

virtual void IRenderingObject::Install ( IGraphicsPort *  gPort, IGraphicAttributeSuite *  iGfxAttrSuite, InstallAction  theAction, const PMRect &  r  ) const

pure virtual

Install the rendering object for graphic state definition.

Parameters

gPort	the graphic port in which to install the rendering object.
iWaxData	the text wax data containing the related rendering attributes.
theAction	specifies which install action to do.

Implemented in CRenderingObject.

virtual void IRenderingObject::Install ( IGraphicsPort *  gPort, const AttributeBossList &  attrs, const PMRect &  r, InstallAction  theAction  ) const

pure virtual

Install the rendering object for tables

Parameters

gPort	the graphic port in which to install the rendering object.
attrs	the table attribute list.
r	the rectangle
theAction	specifies which install action to do.

Implemented in CRenderingObject.

virtual void IRenderingObject::Install ( IGraphicsPort *  gPort, const PMRect &  r  ) const

pure virtual

Install the rendering object for a simple rectangular area.

Parameters

gPort	the graphic port in which to install the rendering object.
r	the affected rectangular area
theAction	specifies which install action to do.

Implemented in CRenderingObject.

virtual void IRenderingObject::Install ( IGraphicsPort *  gPort, RenderingObjectInstallData *  data, const PMRect &  r, InstallAction  theAction  ) const

pure virtual

Install the rendering object for using the RenderingObjectInstallData.

Parameters

gPort	the graphic port in which to install the rendering object.
data	the rendering object related install data.
r	the affected rectangular area
theAction	specifies which install action to do.

Implemented in CRenderingObject.

virtual bool16 IRenderingObject::IsEqual ( const IRenderingObject *  iRenderObject2 ) const

pure virtual

Two rendering objects are equal if all their persisten data (except swatch name) and rendering data are equal. Swatch names ARE NOT compared.

Parameters

iRenderObject2

the rendering object to compare with.

Returns

kTrue if two rendering objects are equal.

Implemented in CRenderingObject.

virtual bool16 IRenderingObject::IsGlobal ( ) const

pure virtual

Returns kTrue if swtach is a global swatch.

Returns

kTrue if swtach is a global swatch.

Implemented in CRenderingObject.

virtual bool16 IRenderingObject::NeedUpdate ( UID  interestedUID ) const

pure virtual

Given an UID, determined if that UID caused any changes in the rendering object.

Returns

kTrue, if updates will be required. Otherwise, return kFalse.

Implemented in CRenderingObject.

virtual void IRenderingObject::SetCanDelete ( const bool16  canDelete )

pure virtual

Sets the new delete flag. By default, all custom swatches are deletable.

Parameters

canDelete

kTrue if swatch can be deleted.

Implemented in CRenderingObject.

virtual void IRenderingObject::SetCanEdit ( const bool16  canEdit )

pure virtual

Sets the new edit flag. By default, all custom swatches are editable.

Parameters

canEdit

kTrue if swatch can be edited.

Implemented in CRenderingObject.

virtual void IRenderingObject::SetCreatorID ( int32  newCreatorID )

pure virtual

Sets the new creator ID.

Parameters

newCreatorID

the new creator ID to set.

Implemented in CRenderingObject.

virtual void IRenderingObject::SetSpecialEditInfo ( const int32  newEditInfo )

pure virtual

Sets the new special edit info.

Parameters

newEditInfo

the new edit info to set.

Implemented in CRenderingObject.

virtual void IRenderingObject::SetSwatchAliasUID ( UID  newAliasUID )

pure virtual

Sets the swatch's new alias swatch UID. kInvalidUID means swatch is not aliased.

Parameters

newAliasUID

the new alias swatch UID to set.

Implemented in CRenderingObject.

virtual void IRenderingObject::SetSwatchName ( const PMString &  newName )

pure virtual

Sets the new swatch name.

Parameters

newName

the new swatch name to set.

Implemented in CRenderingObject.

virtual void IRenderingObject::SetVisibility ( const bool16  visible )

pure virtual

Sets the visibility flag. By default, unnamed swtach must not be visible.

Parameters

visible

kTrue if swatch is visible.

Implemented in CRenderingObject.