BPISuiteTextCSB Class Reference

Inheritance diagram for BPISuiteTextCSB:

Public Member Functions
	BPISuiteTextCSB (IPMUnknown *boss)
virtual	~BPISuiteTextCSB (void)
Public Member Functions inherited from BPISuiteCSB
	BPISuiteCSB (IPMUnknown *boss)
virtual	~BPISuiteCSB (void)
virtual bool16	CanApplyBPIData (void)
virtual ErrorCode	ApplyBPIData (const WideString &value)
virtual bool16	CanGetBPIData (void)
virtual void	GetBPIData (K2Vector< WideString > &values)
virtual void	Startup (void)
virtual void	Shutdown (void)
virtual void	SelectionChanged (SuiteBroadcastData *, const PMIID &, void *)
virtual void	SelectionAttributeChanged (SuiteBroadcastData *, const PMIID &, void *)
virtual void	HandleIntegratorSuiteMessage (void *, const ClassID &, ISubject *, const PMIID &, void *)
virtual ProtocolCollection *	CreateObserverProtocolCollection (void)
Public Member Functions inherited from CPMUnknown< IBPISuite >
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

Protected Member Functions
virtual UIDList	GetTarget (void)

Additional Inherited Members
Public Types inherited from IBPISuite
enum	{ kDefaultIID = IID_IBPISUITE }
Protected Attributes inherited from CPMUnknown< IBPISuite >
HelperInterface	fHelperInterface

Detailed Description

IBPISuite implementation for the text CSB that gets used when a text selection exists; it examines ITextTarget and determine the text frames touched by the range of text that is selected (IBPIData is associated with page items rather than a story).

The rest of the implementation is provided by BPISuiteCSB.

See Also

Selection fundamentals chapter in Programming Guide

Constructor & Destructor Documentation

BPISuiteTextCSB::BPISuiteTextCSB

(

IPMUnknown *

boss

)

Constructor.

Parameters

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

BPISuiteTextCSB::~BPISuiteTextCSB ( void  )

virtual

Destructor.

Member Function Documentation

UIDList BPISuiteTextCSB::GetTarget ( void  )

protectedvirtual

Returns

the UIDs of text frames touched by the text selection specified in ITextTarget. If the text selection spans multiple text frames the UID of each frame(spline) touched is returned.

Implements BPISuiteCSB.