IMediaInfo Class Reference

#include <IMediaInfo.h>

Inheritance diagram for IMediaInfo:

Public Types
enum	{ kDefaultIID = IID_IMEDIAINFO }
enum	{ kMinPageItemHeight = 10, kMinPageItemWidth = kMinPageItemHeight }

Public Member Functions
virtual ICommand *	GetApplyFilterAttributesCmd () const =0
virtual bool16	GetEmbedOnPDFExportDefault () const =0
virtual ClassID	GetMediaPageItemClassID () const =0
virtual MediaType	GetMediaType () const =0
virtual CursorSpec	GetPlaceIntoCursor () const =0
virtual CursorSpec	GetPlaceCursor () const =0
virtual const PMString	GetStandardPosterFileName () const =0
virtual bool16	IsSelected () const =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 call-back interface that is used by the Media plugin to get information it needs to create media page items. When adding a new kind of media page item, you need to add this interface to your PlaceProvider boss, and to your page item boss that is based on the kMediaPageItemBoss.

Member Function Documentation

virtual ICommand* IMediaInfo::GetApplyFilterAttributesCmd ( ) const

pure virtual

DEPRECATED Retrieves an ICommand instance that applies IMediaFilterAttributes to the media page item. An example of such a command would be one that applies attributes taken from a movie file to a movie page item.

Returns

a valid pointer to an ICommand object, or nil if there are no attributes to apply to the media page item.

virtual bool16 IMediaInfo::GetEmbedOnPDFExportDefault ( ) const

pure virtual

Retrieves the default value for the EmbedOnPDFExport option.

Returns

kTrue if the default is to embed content when exported to PDF; kFalse otherwise.

virtual ClassID IMediaInfo::GetMediaPageItemClassID ( ) const

pure virtual

Retrieves the ClassID (boss ID) of a media page item that is based on the kMediaPageItemBoss.

Returns

a valid ClassID for a media page item.

virtual MediaType IMediaInfo::GetMediaType ( ) const

pure virtual

Retrieves the id of the type of media handled by this interface.

Returns

a media type identifier, based on the MediaType enum.

virtual CursorSpec IMediaInfo::GetPlaceCursor ( ) const

pure virtual

Retrieves the cursor used for placing the media page item onto the spread.

See Also

IPlaceBehavior.

Returns

the CursorSpec object for the place cursor.

virtual CursorSpec IMediaInfo::GetPlaceIntoCursor ( ) const

pure virtual

Retrieves the cursor used for placing the media page item into another page item.

See Also

IPlaceBehavior.

Returns

the CursorSpec object for the place into cursor.

virtual const PMString IMediaInfo::GetStandardPosterFileName ( ) const

pure virtual

DEPRECATED. Use IMediaReadFormatInfo::GetStandardPosterFileName() instead. Retrieves the standard poster name for a specific type of media, if it exists.

Returns

a PMString object containing the absolute path to the standard poster file. Returns the null string (PMString("")) if there is no standard poster for the media page item.

virtual bool16 IMediaInfo::IsSelected ( ) const

pure virtual

Tests if the media page item is currently selected.

Returns

kTrue if selected; kFalse if not selected.