IGraphicStateRenderObjects Class Reference

#include <IGraphicStateRenderObjects.h>

Inheritance diagram for IGraphicStateRenderObjects:

Public Types
enum	{ kDefaultIID = IID_IGRAPHICSTATE_RENDEROBJECTS }

Public Member Functions
virtual IDataBase *	GetDataBase (void)=0
virtual void	Initialize (IGraphicStateData *iGraphicStateData)=0
virtual ErrorCode	RegisterNewRenderObjectClass (ClassID renderClassID, UID renderUID)=0
virtual ErrorCode	SetBlock (ClassID renderClassID, bool16 blockFlag)=0
virtual ErrorCode	IsBlocked (ClassID renderClassID, bool16 *blockFlag) const =0
virtual void	ClearEveryBlock (void)=0
virtual const IRenderingObject *	QueryRenderObject (ClassID renderClassID) const =0
virtual UID	GetRenderObjectUID (ClassID renderClassID) const =0
virtual ErrorCode	ChangeRenderObject (ClassID renderClassID, UID renderUID, bool16 doBroadcast=kTrue)=0
virtual bool16	IsRenderingObjectIndeterminant (ClassID renderClassID) const =0
virtual ClassID *	CreateRenderObjectClassList (int32 *renderClassCount) const =0
virtual ClassID	GetCurrentRenderObjectClass (void) const =0
virtual void	RenderObjectChanged (ClassID renderClassID, bool16 doForwardToDefinition)=0
virtual void	ColorManagementChanged (void)=0
virtual void	EnabledRenderingTypesHaveChanged (const K2Vector< ClassID > *disabledList)=0
virtual bool16	IsRenderingObjectDisabled (const ClassID &renderClassID)=0
virtual ErrorCode	UpdateRenderData (ClassID renderClassID, UID renderUID)=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

This is a peresistent interface for the graphic state object. It manages changes to the graphic state's currently active rendering object.

Member Function Documentation

virtual ErrorCode IGraphicStateRenderObjects::ChangeRenderObject ( ClassID  renderClassID, UID  renderUID, bool16  doBroadcast = kTrue  )

pure virtual

Change the current rendering UID for the given rendering class to the specified rendering UID.

Parameters

renderClassID	the rendering class to change.
renderUID	the rendering UID to change.
doBroadcast	the flag indicating whether or not the change should be broadcasted.

Returns

error code (kSuccess or kFailure).

virtual void IGraphicStateRenderObjects::ClearEveryBlock ( void  )

pure virtual

Clear all blocks for all registered rendering classes.

virtual void IGraphicStateRenderObjects::ColorManagementChanged ( void  )

pure virtual

Broadcast a color management changed message.

virtual ClassID* IGraphicStateRenderObjects::CreateRenderObjectClassList ( int32 *  renderClassCount ) const

pure virtual

Returns a list of the currently registered rendering classes.

Parameters

renderClassCount

the number of rendering class in the list.

Returns

the list of rendering classes.

virtual void IGraphicStateRenderObjects::EnabledRenderingTypesHaveChanged ( const K2Vector< ClassID > *  disabledList )

pure virtual

Broadcast a change message indicating the changes in the rendering type's enabling state.

Parameters

disabledList

the list of currently disabled rendering classes.

virtual ClassID IGraphicStateRenderObjects::GetCurrentRenderObjectClass ( void  ) const

pure virtual

Returns the currently active rendering class in the graphic state.

Returns

the active rendering class.

virtual IDataBase* IGraphicStateRenderObjects::GetDataBase ( void  )

pure virtual

Returns the persistent data base associated with this interface.

virtual UID IGraphicStateRenderObjects::GetRenderObjectUID ( ClassID  renderClassID ) const

pure virtual

Return the current rendering UID for the spcified rendering class.

Parameters

renderClassID

the rendering class to query.

Returns

UID

virtual void IGraphicStateRenderObjects::Initialize ( IGraphicStateData *  iGraphicStateData )

pure virtual

Initialized the graphic rendering objects with the data specified by IGrahicStateData interface. This is called only when the graphic state is created without app defaults.

Parameters

iGraphicStateData

specifies the graphic state data to update with.

virtual ErrorCode IGraphicStateRenderObjects::IsBlocked ( ClassID  renderClassID, bool16 *  blockFlag  ) const

pure virtual

Return kTrue if the specified rendering class is blocked.

Parameters

renderClassID	the rendering class to query.
blockFlag	the flag is set to kTrue if the rendering object is blocked. Otherwise it is set to kFalse.

Returns

error code (kSuccess or kFailure).

virtual bool16 IGraphicStateRenderObjects::IsRenderingObjectDisabled ( const ClassID &  renderClassID )

pure virtual

Returns kTrue if the specified rendering class is currently disabled.

Parameters

renderClassID

the rendering class to query.

Returns

kTrue if the given rendering class is currently disabled.

virtual bool16 IGraphicStateRenderObjects::IsRenderingObjectIndeterminant ( ClassID  renderClassID ) const

pure virtual

Returns kTrue if the specified render class is currently indeterminant. This means that there are more than one dis-similar objects of the same rendering class in the graphic state.

Parameters

renderClassID

the rendering class to query.

Returns

kTrue if rendering class is indeterminant.

virtual const IRenderingObject* IGraphicStateRenderObjects::QueryRenderObject ( ClassID  renderClassID ) const

pure virtual

Return the current IRenderingObject interface for the spcified rendering class.

Parameters

renderClassID

the rendering class to query.

Returns

IRenderingObject*.

virtual ErrorCode IGraphicStateRenderObjects::RegisterNewRenderObjectClass ( ClassID  renderClassID, UID  renderUID  )

pure virtual

Register the specified rendering object class.

Parameters

renderClassID	the new rendering class ID to register.
renderUID	the rendering UID for renderClassID to register.

Returns

error code (kSuccess or kFailure).

virtual void IGraphicStateRenderObjects::RenderObjectChanged ( ClassID  renderClassID, bool16  doForwardToDefinition  )

pure virtual

Broadcast a render object changed message.

Parameters

renderClassID	the rendering class to change.
doForwardToDefinition	when this is set to kTrue, then the change is forwarded to the current definition.

virtual ErrorCode IGraphicStateRenderObjects::SetBlock ( ClassID  renderClassID, bool16  blockFlag  )

pure virtual

Set block for the specified rendering class.

Parameters

renderClassID	the rendering class set block.
blockFlag	the flag to set the rendering class block state.

Returns

error code (kSuccess or kFailure).

virtual ErrorCode IGraphicStateRenderObjects::UpdateRenderData ( ClassID  renderClassID, UID  renderUID  )

pure virtual

Updates the interface's persistent data interface. This is called by the graphic state's private commands. Client should not make this call directly. To change the graphic states render object, use ChangeRenderObject(). Calling this directly will cause database transaction errors.

Parameters

renderClassID	the rendering class to update.
renderUID	the new UID for the corresponding class.

Returns

kSuccess if the UID for given rendering class is updated successfully. Otherwise, return kFailure.