IMovieAttributes Class Reference

#include <IMovieAttributes.h>

Inheritance diagram for IMovieAttributes:

Public Types
enum	{ kDefaultIID = IID_IMOVIEATTRIBUTES }
enum	PlayMode { eOnce = 0, eOpen = 1, eRepeat = 2 }
enum	FloatingWindowScale {   eOneFifth = 9, eOneForth = 10, eOneHalf = 11, eFull = 12,   e2X = 13, e3X = 14, e4X = 15, eMax = 16 }
enum	{ kNumberOfPlayModes = 3, kNumberOfFWScaleOptions = 8 }
enum	MovieAttributeID {   enShowControls = kMoviePrefix + 0, enPlayMode = kMoviePrefix + 1, enFloatingWindowScale = kMoviePrefix + 2, enHasFloatingWindow = kMoviePrefix + 3,   enFloatingWindowPosition = kMoviePrefix + 4 }

Public Member Functions
virtual const PMRect	GetBoundingBox ()=0
virtual bool16	ShowControls () const =0
virtual PlayMode	GetPlayMode () const =0
virtual FloatingWindowScale	GetFloatingWindowScale () const =0
virtual bool16	HasFloatingWindow () const =0
virtual const PMPoint	GetFloatingWindowPosition ()=0
virtual void	SetFloatingWindowPosition (const PMPoint &p)=0
virtual void	SetFloatingWindowScale (FloatingWindowScale s)=0
virtual void	SetShowControls (bool16 b)=0
virtual void	SetHasFloatingWindow (bool16 b)=0
virtual void	SetPlayMode (PlayMode m)=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 interface provides methods for accessing movie page item attributes.

Member Enumeration Documentation

enum IMovieAttributes::FloatingWindowScale

this enum defines the size of the movie floating window, relative to the movie bounds

enum IMovieAttributes::MovieAttributeID

this enum defines the IDs of all attributes specific to movie media.

See Also

IMediaAttributes.

Enumerator
enShowControls	Displays movie controller during play if set
enPlayMode	The movie PlayMode as defined above.
enFloatingWindowScale	Movie FloatingWindowScale as defined above.
enHasFloatingWindow	Movie is played in a floating window if set.
enFloatingWindowPosition	The PMPoint position of the movie's floating window.

enum IMovieAttributes::PlayMode

this enum defines the movie play modes

Enumerator
eOnce	play once, then close
eOpen	play once, then stay open
eRepeat	repeat play indefinitely

Member Function Documentation

virtual const PMRect IMovieAttributes::GetBoundingBox ( )

pure virtual

Retrieves the movie's bounding box. If the movie is to play in a floating window, the bounding box is the movie's intrinsic bounds; otherwise, it is the bounds of the movie page item.

Returns

PMRect set to the bounds.

virtual const PMPoint IMovieAttributes::GetFloatingWindowPosition ( )

pure virtual

Retrieves the floating window position.

Returns

one of the predefined PMPoint floating window positions.

virtual FloatingWindowScale IMovieAttributes::GetFloatingWindowScale ( ) const

pure virtual

Retrieves the current FloatingWindowScale.

Returns

the current FloatingWindowScale.

virtual PlayMode IMovieAttributes::GetPlayMode ( ) const

pure virtual

Retrieves the movie PlayMode.

Returns

movie PlayMode.

virtual bool16 IMovieAttributes::HasFloatingWindow ( ) const

pure virtual

Tests if the movie is to be shown in its own window by the PDF viewer.

Returns

kTrue to show in its own window; kFalse to show within the page.

virtual void IMovieAttributes::SetFloatingWindowPosition ( const PMPoint &  p )

pure virtual

Sets the floating window position.

Parameters

p	one of the predefined PMPoint floating window positions.

virtual void IMovieAttributes::SetFloatingWindowScale ( FloatingWindowScale  s )

pure virtual

Sets the FloatingWindowScale attribute.

Parameters

s	the FloatingWindowScale.

virtual void IMovieAttributes::SetHasFloatingWindow ( bool16  b )

pure virtual

Sets the floating window option.

Parameters

b	kTrue to show the movie in its own window by the PDF viewer; kFalse to show the movie on the page.

virtual void IMovieAttributes::SetPlayMode ( PlayMode  m )

pure virtual

Sets the movie PlayMode attribute.

Parameters

m	the movie PlayMode.

virtual void IMovieAttributes::SetShowControls ( bool16  b )

pure virtual

Sets the show movie controls option.

Parameters

b	kTrue to show a movie controller in the PDF viewer while the movie is active; kFalse to omit the movie controller.

virtual bool16 IMovieAttributes::ShowControls ( ) const

pure virtual

Tests if movie controls should be displayed by the PDF reader.

Returns

kTrue if movie controls should be displayed, kFalse if not.