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

#include <IRenderObjectService.h>

Inheritance diagram for IRenderObjectService:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IRENDEROBJECTSERVICE }
 

Public Member Functions

virtual ClassID GetRenderObjectClassID (void) const =0
 
virtual IRenderingObjectCreateTemporaryRenderObject (const IRenderingObject *iSourceRenderObject)=0
 
virtual UID CreateDefaultRenderObject (IWorkspace *)=0
 
virtual UID CreateNewNamedRenderObject (IDataBase *iTargetDB, const IRenderingObject *iNewRenderData)=0
 
virtual UID CreateNewUnnamedRenderObject (IDataBase *iTargetDB, const IRenderingObject *iNewRenderData)=0
 
virtual ErrorCode DeleteRenderObjects (const UIDList &itemList, UIDList &remainderList)=0
 
virtual UIDListDuplicateRenderObjects (IDataBase *iTargetDB, const UIDList &itemList, UIDList &remainderList, ICommand *iCallingCommand, bool16 doUnlock, bool16 doConvertToUnnamed, bool16 doConvertToProcess)=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

Abstract interface to directly create, delete, duplicate one or more rendering objects. In practice client code would use ISwatchUtils or create corresponding command to provide for undo-able change to the swatches.

Member Function Documentation

virtual UID IRenderObjectService::CreateDefaultRenderObject (IWorkspace)
pure virtual

Create a default rendering object in the specified data base.

virtual UID IRenderObjectService::CreateNewNamedRenderObject (IDataBaseiTargetDB,
const IRenderingObjectiNewRenderData 
)
pure virtual

Create a new rendering object in the specified data base using the specified rendering object attributes.

Parameters
iTargetDBthe target data base in which the new rendering object is created.
iNewRenderObjecta memory copy of the rendering attributes which specifies how the new rendering object should be created.
virtual IRenderingObject* IRenderObjectService::CreateTemporaryRenderObject (const IRenderingObjectiSourceRenderObject)
pure virtual

Create a temporary memory-based rendering object based on the specified rendering object. The caller is responsible for deleting this object when done.

Parameters
iSourceRenderObjectthe rendering object this temporary object will copy the rendering properties.
Returns
temporary IRenderingObject*.
virtual ErrorCode IRenderObjectService::DeleteRenderObjects (const UIDListitemList,
UIDListremainderList 
)
pure virtual

Delete the specified rendering objects matching the render class. This method is called from the DeleteSwatchCommand to perform rendering objecct specific tasks. Client should not call this directly to delete a swatch.

Parameters
itemListthe list of item UID to be deleted.
Returns
remainderList containing those item UID not mathcing the render class and therefore not deleted.
virtual UIDList* IRenderObjectService::DuplicateRenderObjects (IDataBaseiTargetDB,
const UIDListitemList,
UIDListremainderList,
ICommandiCallingCommand,
bool16 doUnlock,
bool16 doConvertToUnnamed,
bool16 doConvertToProcess 
)
pure virtual

Duplicate the specified rendering objects matching the render class. This method is called from the DuplicateSwatchCommand to perform rendering objecct specific tasks. Client should not call this directly to duplicate a swatch.

Parameters
iTargetDBthe target data base in which the duplicated objects are created.
itemListthe list of item UID to be duplicated.
Returns
remainderList containing those item UID not mathcing the render class and therefore not duplicated.
a UIDList* of new UIDs.
virtual ClassID IRenderObjectService::GetRenderObjectClassID (void ) const
pure virtual

Returns the rendering object class ID of this render class provider.