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

#include <IPreflightArtworkShapeContext.h>

Inheritance diagram for IPreflightArtworkShapeContext:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPREFLIGHTARTWORKSHAPECONTEXT }
 

Public Member Functions

virtual bool IsShapeNode () const =0
 
virtual UIDRef GetShapeRef () const =0
 
virtual ClassID GetSubPart () const =0
 
virtual UIDRef GetSpreadRef () const =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

This interface provides context for a marking operation, group, or context. That is, IPreflightArtworkMarkInfo and IPreflightArtworkGroupInfo can tell you all about the specifics of the marking operation but this interface tells you what "high level" shape or shape subpart it's associated with.

See Also
IPreflightArtworkContext for a longer description of the relationship between marking operations and contexts, and how you might use this interface. In particular you would normally use IPreflightArtworkContext::QueryParentShapeContext() to obtain this interface.

Member Function Documentation

virtual UIDRef IPreflightArtworkShapeContext::GetShapeRef () const
pure virtual

Get the shape UIDRef. Ie this is something you can query an IShape from. See also the subpart (ie GetSubPart()) if you want to know whether it's referring to a specific part of that shape.

Also note that the page item might be a page, or a spread, in unusual circumstances.

Returns
The UIDRef of the shape, or UIDRef() if this is not a shape context.
virtual UIDRef IPreflightArtworkShapeContext::GetSpreadRef () const
pure virtual

Get the spread this marking operation is associated with. This method gets the shaperef from this node, or any suitable parent, and from that determines the spread.

Returns
A UIDRef of the spread.
virtual ClassID IPreflightArtworkShapeContext::GetSubPart () const
pure virtual

Get the subpart referred to by this node. This is only valid if IsShapeNode() is true. The subpart is typically one of the kPreflightOSP_* constants in PackageAndPreflightID.h.

Returns
The subpart code.
virtual bool IPreflightArtworkShapeContext::IsShapeNode () const
pure virtual

Returns whether this node is a metadata (context) node representing the shape information for a bunch of child marking operations. This is not usually that useful unless you're inspecting the tree in a relatively advanced way. Typically you would use QueryShape() if what you want to know the shape associated with an arbitrary bit of artwork.

Returns
kTrue if a shape node; kFalse otherwise.