BscTAAttrReport Class Reference

Inheritance diagram for BscTAAttrReport:

Public Member Functions
	BscTAAttrReport (IPMUnknown *boss)
virtual bool16	IsParagraphAttribute (void) const
virtual bool16	LastsThroughStyleChange (void) const
virtual IAttrReport::ContinuationType	AutomaticContinuation (void) const
virtual bool16	CanBeInStyle (void) const
virtual bool16	SurvivesReplace (void) const
virtual bool16	OmitFromFocusCache (void) const
virtual IAttrReport::RecompositionLevel	RequiresRecomposition (void) const
virtual void	TellComposition (ICompositionStyle *compositionStyle, IDrawingStyle *drawingStyle) const
virtual void	AppendDescription (PMString *into, IDataBase *theDB, const AttributeBossList *attrBossList) const
Public Member Functions inherited from CPMUnknown< IAttrReport >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Additional Inherited Members
Public Types inherited from IAttrReport
enum	{ kDefaultIID = IID_IATTRREPORT }
enum	RecompositionLevel { kInvalOnly, kInkBoundsChange, kRequiresRecomposition }
enum	ContinuationType { kNeverContinue, kAlwaysContinue, kContinueFromLeftOnly }
Protected Member Functions inherited from CPMUnknown< IAttrReport >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< IAttrReport >
HelperInterface	fHelperInterface

Detailed Description

Provides a custom character attribute. The visible adornment is provided by BscTAAdornment. See kBscTAAttrBoss and kBscTAAdornmentBoss.

Most of the behavior specified in BscTAAttrReport is based on a fundamental character attribute (specified privately), except that CanBeInStyle() is set to kFalse due to the lack of the UI to set this particular attribute when creating styles.

Implements IAttrReport using the CPMUnknown helper class.

, John Hake

Constructor & Destructor Documentation

BscTAAttrReport::BscTAAttrReport ( IPMUnknown *  boss )

inline

Constructor

Parameters

boss	interface ptr from boss object on which this interface is aggregated.

Member Function Documentation

void BscTAAttrReport::AppendDescription ( PMString *  into, IDataBase *  theDB, const AttributeBossList *  attrBossList  ) const

virtual

Appends our attribute description.

Parameters

into	The PMString that holds the description.
theDB	The current database. (Not used)
attrBossList	The attribute boss list that contains other attributes applied. (Not used).

Implements IAttrReport.

IAttrReport::ContinuationType BscTAAttrReport::AutomaticContinuation ( void  ) const

virtual

Specifies if the attribute continues if the user types text at the end of the run of characters to which the attribute applies.

Returns

ContinuationType specifies how you the attribute will continue. NOTE: The API has changed since InDesign 2.0 Beta.
(Beta) bool16 BscTAAttrReport::AutomaticContinuation(void) const
(RC) IAttrReport::ContinuationType BscTAAttrReport::AutomaticContinuation(void) const

Implements IAttrReport.

bool16 BscTAAttrReport::CanBeInStyle ( void  ) const

virtual

Specifies whether the attribute can be part of a style. NOTE: This method has been added since InDesign 2.0 beta.

Implements IAttrReport.

Binds the C implementation class onto its ImplementationID making the C code callable by the application *bool16 BscTAAttrReport::IsParagraphAttribute ( void  ) const

virtual

We implement a character attribute so we return kFalse.

Implements IAttrReport.

bool16 BscTAAttrReport::LastsThroughStyleChange ( void  ) const

virtual

We don't want style changes to blow away our attribute so we return kTrue.

Implements IAttrReport.

bool16 BscTAAttrReport::OmitFromFocusCache ( void  ) const

virtual

Specifies whether the attribute should be omitted from the focus cache. NOTE: This method has been added since InDesign 2.0 beta.

IAttrReport::RecompositionLevel BscTAAttrReport::RequiresRecomposition ( void  ) const

virtual

Specifies if/when the attribute requires recomposition.

Returns

RecompositionLevel specifies when the attribute requires recomposition.

NOTE: The API has changed since InDesign 2.0 Beta.
(Beta) bool16 BscTAAttrReport::RequiresRecomposition(void) const
(RC) IAttrReport::RecompositionLevel BscTAAttrReport::RequiresRecomposition(void) const

Implements IAttrReport.

bool16 BscTAAttrReport::SurvivesReplace ( void  ) const

virtual

Specifies whether the attribute can stay after a search/replace operation. NOTE: This method has been added since InDesign 2.0 beta.

void BscTAAttrReport::TellComposition ( ICompositionStyle *  compositionStyle, IDrawingStyle *  drawingStyle  ) const

virtual

This is the hook we use to add/remove our adornment to the text so that when the frame is drawn our adornment will be drawn on screen. Called by the composer as it composes the text in a frame. See BscTAAdornmentBoss::Draw() to see how the adornment is drawn.

Parameters

compositionStyle	The composition style interface that describes the settings of the currently used composer.
drawingStyle	The drawing style interface that describes visually oriented settings. We use the IDrawingStyle::AddTextAdornment() method to add our custom text adornment.

Implements IAttrReport.