ISetMediaAttrCmdData Class Reference

Inheritance diagram for ISetMediaAttrCmdData:

Public Types
enum	{ kDefaultIID = IID_ISETMEDIAATTRCMDDATA }

Public Member Functions
virtual bool16	GetCustomPosterFromMedia () const =0
virtual const PMString &	GetDescription () const =0
virtual bool16	GetEmbedOnPDFExport () const =0
virtual bool16	GetDoNotPrintPoster () const =0
virtual bool16	GetPlayOnPageTurn () const =0
virtual int32	GetPosterTime () const =0
virtual const PMString &	GetTitle () const =0
virtual bool16	GetTitleIsFrozen () const =0
virtual bool16	IsSet_CustomPosterFromMedia () const =0
virtual bool16	IsSet_Description () const =0
virtual bool16	IsSet_EmbedOnPDFExport () const =0
virtual bool16	IsSet_PlayOnPageTurn () const =0
virtual bool16	IsSet_PosterTime () const =0
virtual bool16	IsSet_DoNotPrintPoster () const =0
virtual bool16	IsSet_Title () const =0
virtual bool16	IsSet_TitleIsFrozen () const =0
virtual void	SetCustomPosterFromMedia (bool16 b)=0
virtual void	SetDescription (const PMString &desc)=0
virtual void	SetEmbedOnPDFExport (bool16 b)=0
virtual void	SetDoNotPrintPoster (bool16 b)=0
virtual void	SetPlayOnPageTurn (bool16 b)=0
virtual void	SetPosterTime (int32 t)=0
virtual void	SetTitle (const PMString &title)=0
virtual void	SetTitleIsFrozen (bool16 b)=0
virtual ErrorCode	ApplyAttributes (IMediaAttributes *iMediaAttributes)=0
virtual void	Clear ()=0
virtual ErrorCode	CopyAttributes (ISetMediaAttrCmdData *destData) const =0
virtual bool	HasChanged ()=0
virtual void	SetAttribute (uint32 attributeID, int16 value)=0
virtual void	SetAttribute (uint32 attributeID, int32 value)=0
virtual void	SetAttribute (uint32 attributeID, uint32 value)=0
virtual void	SetAttribute (uint32 attributeID, ClassID value)=0
virtual void	SetAttribute (uint32 attributeID, const PMPoint &value)=0
virtual void	SetAttribute (uint32 attributeID, const PMReal &value)=0
virtual void	SetAttribute (uint32 attributeID, const PMRect &value)=0
virtual void	SetAttribute (uint32 attributeID, const PMString &value)=0
virtual void	SetAttribute (uint32 attributeID, const NamedUint32AttributeList &value)=0
virtual void	SetFlag (uint32 attributeID, bool16 b)=0
virtual void	ClearFlag (uint32 attributeID)=0
virtual void	ClearInt16 (uint32 attributeID)=0
virtual void	ClearPMPoint (uint32 attributeID)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual ErrorCode ISetMediaAttrCmdData::ApplyAttributes ( IMediaAttributes *  iMediaAttributes )

pure virtual

Applies all set data to an IMediaAttributes instance. This method modifies the model; it must be called from within the context of a command.

virtual void ISetMediaAttrCmdData::Clear ( )

pure virtual

Removes all settings from the instance.

virtual void ISetMediaAttrCmdData::ClearFlag ( uint32  attributeID )

pure virtual

Clears a flag attribute. This method has no affect if the attribute does not exist.

Parameters

attributeID

may be either a MediaAttributeID or a media-specific ID.

virtual void ISetMediaAttrCmdData::ClearInt16 ( uint32  attributeID )

pure virtual

Clears an attribute int16 value. This method has no affect if the attribute does not exist.

Parameters

attributeID

may be either a MediaAttributeID or a media-specific ID.

virtual void ISetMediaAttrCmdData::ClearPMPoint ( uint32  attributeID )

pure virtual

Clears an attribute PMPoint value. This method has no affect if the attribute does not exist.

Parameters

attributeID

may be either a MediaAttributeID or a media-specific ID.

virtual ErrorCode ISetMediaAttrCmdData::CopyAttributes ( ISetMediaAttrCmdData *  destData ) const

pure virtual

Copies all attributes from this instance to the destData instance.

Parameters

destData

is a valid pointer to an ISetMediaAttrCmdData instance that will receive the attributes.

virtual bool ISetMediaAttrCmdData::HasChanged ( )

pure virtual

Tests if the data represented by this instance has changed; i.e., if one or more of the Set methods has been called.

Returns

true if data has changed; otherwise returns false.

virtual void ISetMediaAttrCmdData::SetAttribute ( uint32  attributeID, int16  value  )

pure virtual

Sets the value of an attribute of type int16.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void ISetMediaAttrCmdData::SetAttribute ( uint32  attributeID, int32  value  )

pure virtual

Sets the value of an attribute of type int32.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void ISetMediaAttrCmdData::SetAttribute ( uint32  attributeID, uint32  value  )

pure virtual

Sets the value of an attribute of type uint32.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void ISetMediaAttrCmdData::SetAttribute ( uint32  attributeID, ClassID  value  )

pure virtual

Sets the value of an attribute of type ClassID.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void ISetMediaAttrCmdData::SetAttribute ( uint32  attributeID, const PMPoint &  value  )

pure virtual

Sets the value of an attribute of type PMPoint.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void ISetMediaAttrCmdData::SetAttribute ( uint32  attributeID, const PMReal &  value  )

pure virtual

Sets the value of an attribute of type PMReal.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void ISetMediaAttrCmdData::SetAttribute ( uint32  attributeID, const PMRect &  value  )

pure virtual

Sets the value of an attribute of type PMRect.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void ISetMediaAttrCmdData::SetAttribute ( uint32  attributeID, const PMString &  value  )

pure virtual

Sets the value of an attribute of type PMString.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void ISetMediaAttrCmdData::SetAttribute ( uint32  attributeID, const NamedUint32AttributeList &  value  )

pure virtual

Sets the value of an attribute of type NamedInt32AttributeList.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void ISetMediaAttrCmdData::SetFlag ( uint32  attributeID, bool16  b  )

pure virtual

Sets or clears a flag attribute.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
b	flag value; specify kTrue to set the flag, or kFalse to clear it.