CRenderingObject Class Reference

Inheritance diagram for CRenderingObject:

Public Member Functions
	CRenderingObject (IPMUnknown *boss)
virtual void	ReadWrite (IPMStream *s, ImplementationID prop)
virtual void	Install (IGraphicsPort *gPort, IGraphicStyleDescriptor *iGSDesc, InstallAction theAction) const
virtual void	Install (IGraphicsPort *gPort, IWaxRenderData *iWaxData, InstallAction theAction) const
virtual void	Install (IGraphicsPort *gPort, IGraphicAttributeSuite *iGfxAttrSuite, InstallAction theAction, const PMRect &r) const
virtual void	Install (IGraphicsPort *gPort, const AttributeBossList &attrs, const PMRect &r, InstallAction theAction) const
virtual void	Install (IGraphicsPort *gPort, const PMRect &r) const
virtual void	Install (IGraphicsPort *gPort, RenderingObjectInstallData *data, const PMRect &r, InstallAction theAction) const
virtual const PMString &	GetSwatchUIName () const
virtual PMString	GetTipText () const
virtual PMString	GetTipText (const int32 &colorSpace, const ColorArray &colorComponents) const
virtual const PMString &	GetSwatchName () const
virtual bool16	GetVisibility () const
virtual bool16	GetCanDelete () const
virtual bool16	GetCanEdit () const
virtual bool16	IsGlobal () const
virtual UID	GetSwatchAliasUID () const
virtual int32	GetSpecialEditInfo () const
virtual void	SetSwatchName (const PMString &newName)
virtual void	SetVisibility (const bool16 visible)
virtual void	SetCanDelete (const bool16 canDelete)
virtual void	SetCanEdit (const bool16 canEdit)
virtual void	SetSwatchAliasUID (UID)
virtual int32	GetCreatorID () const
virtual void	SetCreatorID (int32)
virtual void	SetSpecialEditInfo (const int32 editInfo)
virtual bool16	NeedUpdate (UID interestedUID) const
virtual UID	DuplicateAsLocal (const IGraphicStyleDescriptor *overrideAttrs, InstallAction theAction) const
virtual UID	DuplicateAsLocal (const AttributeBossList *overrideAttrs, InstallAction theAction) const
virtual UID	DuplicateAsLocal (const PMReal &tint) const
virtual ClassID	GetRenderClass () const
virtual bool16	IsEqual (const IRenderingObject *) const

Protected Member Functions
UID	DuplicateAsLocal (void) const

Protected Attributes
PMString	fRenderName

Additional Inherited Members
Public Types inherited from IRenderingObject
enum	{ kDefaultIID = IID_IRENDERINGOBJECT }
enum	InstallAction { kInstallStroke, kInstallFill, kInstallGap }

Member Function Documentation

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

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.

Implements IRenderingObject.

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

virtual

See Also

DuplicateAsLocal

Implements IRenderingObject.

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

virtual

See Also

DuplicateAsLocal

Implements IRenderingObject.

virtual bool16 CRenderingObject::GetCanDelete ( ) const

virtual

Returns kTrue if swtach can be deleted.

Returns

kTrue if swtach can be deleted.

Implements IRenderingObject.

virtual bool16 CRenderingObject::GetCanEdit ( ) const

virtual

Returns kTrue if swtach can be edited.

Returns

kTrue if swtach can be edited.

Implements IRenderingObject.

virtual int32 CRenderingObject::GetCreatorID ( ) const

virtual

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

Returns

the creator ID.

Implements IRenderingObject.

virtual ClassID CRenderingObject::GetRenderClass ( ) const

inlinevirtual

Returns the rendering class.

Returns

the rendering class.

Implements IRenderingObject.

virtual int32 CRenderingObject::GetSpecialEditInfo ( ) const

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.

Implements IRenderingObject.

virtual UID CRenderingObject::GetSwatchAliasUID ( ) const

virtual

Returns the swatch's alias swatch UID.

Returns

the swatch's alias swatch UID.

Implements IRenderingObject.

virtual const PMString& CRenderingObject::GetSwatchName ( ) const

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.

Implements IRenderingObject.

virtual const PMString& CRenderingObject::GetSwatchUIName ( ) const

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.

Implements IRenderingObject.

virtual PMString CRenderingObject::GetTipText ( ) const

virtual

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

Returns

a PMString that is the rendering object tip text.

Implements IRenderingObject.

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

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.

Implements IRenderingObject.

virtual bool16 CRenderingObject::GetVisibility ( ) const

virtual

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

Returns

kTrue if swtach is visible in UI.

Implements IRenderingObject.

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

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.

Implements IRenderingObject.

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

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.

Implements IRenderingObject.

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

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.

Implements IRenderingObject.

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

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.

Implements IRenderingObject.

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

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.

Implements IRenderingObject.

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

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.

Implements IRenderingObject.

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

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.

Implements IRenderingObject.

virtual bool16 CRenderingObject::IsGlobal ( ) const

virtual

Returns kTrue if swtach is a global swatch.

Returns

kTrue if swtach is a global swatch.

Implements IRenderingObject.

virtual bool16 CRenderingObject::NeedUpdate ( UID  interestedUID ) const

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.

Implements IRenderingObject.

virtual void CRenderingObject::SetCanDelete ( const bool16  canDelete )

virtual

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

Parameters

canDelete

kTrue if swatch can be deleted.

Implements IRenderingObject.

virtual void CRenderingObject::SetCanEdit ( const bool16  canEdit )

virtual

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

Parameters

canEdit

kTrue if swatch can be edited.

Implements IRenderingObject.

virtual void CRenderingObject::SetCreatorID ( int32  newCreatorID )

virtual

Sets the new creator ID.

Parameters

newCreatorID

the new creator ID to set.

Implements IRenderingObject.

virtual void CRenderingObject::SetSpecialEditInfo ( const int32  newEditInfo )

virtual

Sets the new special edit info.

Parameters

newEditInfo

the new edit info to set.

Implements IRenderingObject.

virtual void CRenderingObject::SetSwatchAliasUID ( UID  newAliasUID )

virtual

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

Parameters

newAliasUID

the new alias swatch UID to set.

Implements IRenderingObject.

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

virtual

Sets the new swatch name.

Parameters

newName

the new swatch name to set.

Implements IRenderingObject.

virtual void CRenderingObject::SetVisibility ( const bool16  visible )

virtual

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

Parameters

visible

kTrue if swatch is visible.

Implements IRenderingObject.