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

#include <IMediaAdornmentInfo.h>

Inheritance diagram for IMediaAdornmentInfo:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMEDIAADORNMENTINFO }
 

Public Member Functions

virtual ClassID GetBottomAdornmentClassID () const =0
 
virtual const PMString GetName () const =0
 
virtual ClassID GetTopAdornmentClassID () 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 is a call-back interface that provides information for constructing adornments that appear on media frames.

If a media frame requires adornments, this interface should be aggregated by the media page item boss.

Member Function Documentation

virtual ClassID IMediaAdornmentInfo::GetBottomAdornmentClassID () const
pure virtual

Retrieves the ClassID of the adornment that appears at the bottom of the frame.

Returns
a valid ClassID if there is a bottom adornment; return kInvalidClass if no bottom adornment.
virtual const PMString IMediaAdornmentInfo::GetName () const
pure virtual

Retrieves the name that displays as part of the adornment.

Returns
a PMString containing the name.
virtual ClassID IMediaAdornmentInfo::GetTopAdornmentClassID () const
pure virtual

Retrieves the ClassID of the adornment that appears at the top of the frame.

Returns
a valid ClassID if there is a top adornment; return kInvalidClass if no top adornment.