#include <ITranFxSuite.h>

Inheritance diagram for ITranFxSuite:

Public Types
enum	{ kDefaultIID = IID_ITRANFXSUITE }

enum	AttrState { eNoValue, eCommonValue, eMixedValue }

Public Member Functions
virtual void	HasAdornment (AttrState &attrState) const =0

virtual void	HasXOffset (AttrState &attrState, PMReal &value) const =0

virtual void	HasYOffset (AttrState &attrState, PMReal &value) const =0

virtual void	HasUseBlackAsOpaque (AttrState &attrState, bool16 &value) const =0

virtual void	HasUseAlpha (AttrState &attrState, bool16 &value) const =0

virtual void	HasUseBlur (AttrState &attrState, bool16 &value) const =0

virtual bool16	CanApplyAdornment () const =0

virtual bool16	CanApplyXOffset () const =0

virtual bool16	CanApplyYOffset () const =0

virtual bool16	CanApplyUseBlackAsOpaque () const =0

virtual bool16	CanApplyUseAlpha () const =0

virtual bool16	CanApplyUseBlur () const =0

virtual ErrorCode	ApplyAdornment (const bool16 isAdd)=0

virtual ErrorCode	ApplyXOffset (const PMReal &value)=0

virtual ErrorCode	ApplyYOffset (const PMReal &value)=0

virtual ErrorCode	ApplyUseBlackAsOpaque (const bool16 value)=0

virtual ErrorCode	ApplyUseAlpha (const bool16 value)=0

virtual ErrorCode	ApplyUseBlur (const bool16 value)=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

From SDK sample; abstract suite which extends the selection so that it can manipulate this plug-in's transparency effect.

Member Enumeration Documentation

enum ITranFxSuite::AttrState

Enumeration indicating whether all the selected objects have no value, a common value or a mixed number of different values for a given attribute. Several objects can be selected simultaneously and have different values, or a common value, for an attribute. This state is normally reflected by client code in user interface controls.

Member Function Documentation

virtual ErrorCode ITranFxSuite::ApplyAdornment ( const bool16 isAdd )

pure virtual

Add or remove this plug-in's adornment to the objects that are selected.

Parameters

isAdd IN kTrue to add adornment, kFalse to remove.

Returns: kSuccess on success, other ErrorCode otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual ErrorCode ITranFxSuite::ApplyUseAlpha ( const bool16 value )

pure virtual

Change the state of the alpha flag of the objects that are selected.

Parameters

value kTrue to apply the alpha channel associated with the page item to the matte effect, kFalse if not.

Returns: kSuccess on success, other ErrorCode otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual ErrorCode ITranFxSuite::ApplyUseBlackAsOpaque ( const bool16 value )

pure virtual

Change the state of the black as opaque flag of the objects that are selected. This controls whether darker pixels in the page item are more opaque in the matte effect (kTrue) or more transparent (kFalse).

Parameters

value kTrue to cause darker pixels in the page item to be more opaque in the matte effect (black is fully opaque) and lighter pixels to be more transparent (white is fully transparent). kFalse to cause darker pixels in the page item to be more transparent in the matte effect (black is fully transparent) and lighter pixels to be more opaque (white is fully opaque). For example, if you want black text or a graphic with a black stroke to cast a matte effect, then make this kTrue. For example, if you want white text or a graphic with a white stroke to cast a matte effect, then make this kFalse.

Returns: kSuccess on success, other ErrorCode otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual ErrorCode ITranFxSuite::ApplyUseBlur ( const bool16 value )

pure virtual

Change the state of the blur flag of the objects that are selected.

Parameters

value kTrue to apply a slight blur to the matte effect and to reduce its intensity compared to the page item, kFalse if not.

Returns: kSuccess on success, other ErrorCode otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual ErrorCode ITranFxSuite::ApplyXOffset ( const PMReal & value )

pure virtual

Change the x offset of the objects that are selected.

Parameters

value IN the value to be applied.

Returns: kSuccess on success, other ErrorCode otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual ErrorCode ITranFxSuite::ApplyYOffset ( const PMReal & value )

pure virtual

Change the x offset of the objects that are selected.

Parameters

value IN the value to be applied.

Returns: kSuccess on success, other ErrorCode otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual bool16 ITranFxSuite::CanApplyAdornment ( ) const

pure virtual

Return kTrue if adornment can be applied, kFalse otherwise.

Returns: kTrue if adornment can be applied, kFalse otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual bool16 ITranFxSuite::CanApplyUseAlpha ( ) const

pure virtual

Return kTrue if alpha flag can be applied, kFalse otherwise.

Returns: kTrue if alpha flag can be applied, kFalse otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual bool16 ITranFxSuite::CanApplyUseBlackAsOpaque ( ) const

pure virtual

Return kTrue if black as opaque flag can be applied, kFalse otherwise.

Returns: kTrue if black as opaque flag can be applied, kFalse otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual bool16 ITranFxSuite::CanApplyUseBlur ( ) const

pure virtual

Return kTrue if blur flag can be applied, kFalse otherwise.

Returns: kTrue if blur flag can be applied, kFalse otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual bool16 ITranFxSuite::CanApplyXOffset ( ) const

pure virtual

Return kTrue if x offset can be applied, kFalse otherwise.

Returns: kTrue if x offset can be applied, kFalse otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual bool16 ITranFxSuite::CanApplyYOffset ( ) const

pure virtual

Return kTrue if y offset can be applied, kFalse otherwise.

Returns: kTrue if y offset can be applied, kFalse otherwise.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual void ITranFxSuite::HasAdornment ( AttrState & attrState ) const

pure virtual

Checks if objects that are selected have this plug-in's adornment applied.

Parameters

attrState OUT eCommonValue if all selected objects have the adornment, eMixedValue some objects have the adornment, eNoValue none of the objects have the adornment.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual void ITranFxSuite::HasUseAlpha	(	AttrState &	attrState,
		bool16 &	value
	)		const

pure virtual

Checks the state of the alpha flag of objects that are selected.

Parameters

itemList	IN list of objects to be checked.
value	OUT kTrue if alpha channel associated with page item should be applied to the effect, kFalse if not (default value kTrue).

Returns: enum indicating state of the attribute value.

See Also: ITranFxSuite::ApplyUseAlpha.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual void ITranFxSuite::HasUseBlackAsOpaque	(	AttrState &	attrState,
		bool16 &	value
	)		const

pure virtual

Checks the state of the black as opaque flag of objects that are selected.

Parameters

itemList	IN list of objects to be checked.
value	OUT kTrue if darker pixels in the page item should be more opaque in the effect, kFalse if transparent (default value kTrue).

Returns: enum indicating state of the attribute value.

See Also: ITranFxSuite::ApplyUseBlackAsOpaque.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual void ITranFxSuite::HasUseBlur	(	AttrState &	attrState,
		bool16 &	value
	)		const

pure virtual

Checks the state of the blur flag of objects that are selected.

Parameters

itemList	IN list of objects to be checked.
value	OUT kTrue if the effect should be blurred and reduced in intensity, kFalse if not (default value kTrue).

Returns: enum indicating state of the attribute value.

See Also: ITranFxSuite::ApplyUseBlur.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual void ITranFxSuite::HasXOffset	(	AttrState &	attrState,
		PMReal &	value
	)		const

pure virtual

Checks the x offset of objects that are selected.

Parameters

attrState	OUT eCommonValue if all selected objects share the same x offset value (default value 7.0 points).
value	OUT the x offset.

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

virtual void ITranFxSuite::HasYOffset	(	AttrState &	attrState,
		PMReal &	value
	)		const

pure virtual

Checks the y offset of objects that are selected.

Parameters

attrState	OUT eCommonValue if all selected objects share the same y offset value (default value 7.0 points).
value	OUT the y offset

Implemented in TranFxSuiteASB, and TranFxSuiteLayoutCSB.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation