IApplyStyleData Class Reference

#include <IApplyStyleData.h>

Inheritance diagram for IApplyStyleData:

Public Types
enum	{ kDefaultIID = IID_IAPPLYSTYLEDATA }

Public Member Functions
virtual void	Set (ClassID whichStrand, UID style, const boost::shared_ptr< AttributeBossList > &over)=0
virtual ClassID	GetStrandID () const =0
virtual UID	GetStyleUID () const =0
virtual const boost::shared_ptr < AttributeBossList > &	GrabOverrides () const =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

IApplyStyleData is the primary data interface for the commands that apply text attributes. This interface contains the attribute & style data that is to be applied.

Member Function Documentation

virtual ClassID IApplyStyleData::GetStrandID ( ) const

pure virtual

GetStrandID is the apply command targetted towards character or paragraph style data?

Returns

the ClassID of the strand in question (kCharAttrStrandBoss or kParaAttrStrandBoss)

virtual UID IApplyStyleData::GetStyleUID ( ) const

pure virtual

GetStyleUID returns the UID of the style being applied. Can be kInvalidUID if only overrides are being applied.

Returns

the UID of the style being applied.

virtual const boost::shared_ptr<AttributeBossList>& IApplyStyleData::GrabOverrides ( ) const

pure virtual

GrabOverrides returns the attributes being applied. Can be empty when only the style is being applied

Returns

a shared pointer to an AttributeBossList containing the attributes to apply.

virtual void IApplyStyleData::Set ( ClassID  whichStrand, UID  style, const boost::shared_ptr< AttributeBossList > &  over  )

pure virtual

Set set the data about what to apply: character or paragraph styles & local overrides.

Parameters

whichStrand	is the target to apply to: (kCharAttrStrandBoss or kParaAttrStrandBoss).
style	is the text style to apply – can be kInvalidUID if this should be ignored.
over	is a shared pointer to an AttributeBossList containing attributes to apply. Can be empty if only a style is being applied.