ICharacterStyleSuite Class Reference

Inheritance diagram for ICharacterStyleSuite:

Public Types
enum	{ kDefaultIID = IID_ICHARACTERSTYLESUITE }

Public Member Functions
virtual bool16	CanCreateStyle () const =0
virtual UID	CreateStyle (UID parentUID=kInvalidUID, int32 position=-1)=0
virtual bool16	CanRedefineStyle () const =0
virtual ErrorCode	RedefineStyle ()=0
virtual bool16	CanEditStyle () const =0
virtual UID	GetStyleUID () const =0
virtual AttributeBossList *	NewStyleAttributeList ()=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 bool16 ICharacterStyleSuite::CanCreateStyle ( ) const

pure virtual

Can a style be created.

Returns

Returns true if a style can be

virtual bool16 ICharacterStyleSuite::CanEditStyle ( ) const

pure virtual

Can the style of the current selection be edited.

Returns

It returns false if the style cannot be edited for some reason

virtual bool16 ICharacterStyleSuite::CanRedefineStyle ( ) const

pure virtual

Can the style of the current selection be redefined based on selected overrides.

Returns

It returns false if the selection contains mixed overrides, no overrides, or mixed styles.

virtual UID ICharacterStyleSuite::CreateStyle ( UID  parentUID = kInvalidUID, int32  position = -1  )

pure virtual

Creates a new style based on the current selection.

Parameters

parentUID	[IN] UID of the parent group where the style is being created. kInvalidUID to create at root level
position	[IN] position with in the parent, where style is going to be created. -1 to create at the end.

Returns

UID of the new style

Postcondition

A unique style name is auto generated.

virtual UID ICharacterStyleSuite::GetStyleUID ( ) const

pure virtual

Returns selected style UID.

Returns

the style UID for the first character in the selection

virtual AttributeBossList* ICharacterStyleSuite::NewStyleAttributeList ( )

pure virtual

Constructs an AttributeBossList for the style overrides for the first character in the selection.

Returns

the style overrides for the first character in the selection

Postcondition

Caller is responsibe to delete returned AttributeBossList *.

virtual ErrorCode ICharacterStyleSuite::RedefineStyle ( )

pure virtual

Redefines the style of the current selection based on the text attributes of the current selection. (Any overrides become part of the style.)

Returns

kSuccess on success otherwise an error.