IStoryPropertiesSuite Class Reference

Inheritance diagram for IStoryPropertiesSuite:

Public Types
enum	{ kDefaultIID = IID_ISTORYPROPERTIESSUITE }
enum	GenericBooleanState { kStateUnknown, kStateOff, kStateOn, kStateMixed }
enum	TextDirection { kDirUnknown, kDirHorizontal, kDirVertical, kDirMixed }
enum	StoryDir { kLTRDirection = 0, kRTLDirection = 1, kUnknownDirection = 2, kMixedDirection = 3 }
enum	FrameType { kFrameTypeUnknown, kFrameTypePlain, kFrameTypeCJKGrid, kFrameTypeMixed }

Public Member Functions
virtual bool16	ShouldEnableOpticalMarginAlignment () const =0
virtual GenericBooleanState	GetOpticalMarginAlignment () const =0
virtual ErrorCode	SetOpticalMarginAlignment (GenericBooleanState bAlign)=0
virtual bool16	ShouldEnableOpticalMarginAlignmentSize () const =0
virtual K2Vector< PMReal > *	GetOpticalMarginAlignmentSize () const =0
virtual ErrorCode	SetOpticalMarginAlignmentSize (PMReal alignmentSize)=0
virtual bool16	ShouldEnableTextDirection () const =0
virtual TextDirection	GetTextDirection () const =0
virtual ErrorCode	SetTextDirection (TextDirection dir)=0
virtual bool16	ShouldEnableStoryDirection () const =0
virtual StoryDir	GetStoryDirection () const =0
virtual ErrorCode	SetStoryDirection (StoryDir dir)=0
virtual bool16	ShouldEnableFrameType () const =0
virtual FrameType	GetFrameType () const =0
virtual ErrorCode	SetFrameType (FrameType frameType)=0
virtual bool16	CanSetStoryAttributeLock () const =0
virtual bool16	CanSetStoryInsertLock () const =0
virtual GenericBooleanState	GetStoryAttributeLock () const =0
virtual GenericBooleanState	GetStoryInsertLock () const =0
virtual ErrorCode	SetStoryAttributeLock (GenericBooleanState locked)=0
virtual ErrorCode	SetStoryInsertLock (GenericBooleanState locked)=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 IStoryPropertiesSuite::CanSetStoryAttributeLock ( ) const

pure virtual

Whether the story attribute lock can be set

Returns

kTrue if it can be set

virtual bool16 IStoryPropertiesSuite::CanSetStoryInsertLock ( ) const

pure virtual

Whether the story insert lock can be set

Returns

kTrue if it can be set

virtual FrameType IStoryPropertiesSuite::GetFrameType ( ) const

pure virtual

Gets the frame type of the story (Japanese featureset)

Returns

frame type (enum)

virtual GenericBooleanState IStoryPropertiesSuite::GetOpticalMarginAlignment ( ) const

pure virtual

Gets the optical margin alignment story attribute on or off

Returns

kStateOn if on

virtual K2Vector<PMReal>* IStoryPropertiesSuite::GetOpticalMarginAlignmentSize ( ) const

pure virtual

Gets the optical margin alignment size story attribute

Returns

ptr to array of sizes

virtual GenericBooleanState IStoryPropertiesSuite::GetStoryAttributeLock ( ) const

pure virtual

Gets the story attribute lock

Returns

kStateOn if on

virtual GenericBooleanState IStoryPropertiesSuite::GetStoryInsertLock ( ) const

pure virtual

Gets the story insert lock

Returns

kStateOn if on

virtual TextDirection IStoryPropertiesSuite::GetTextDirection ( ) const

pure virtual

Gets the text direction of the story (Japanese featureset)

Returns

text direction (enum)

virtual ErrorCode IStoryPropertiesSuite::SetFrameType ( FrameType  frameType )

pure virtual

Sets the frame type of the story (Japanese featureset)

Parameters

dir	[IN] frame type to be set

Returns

error if operation failed

virtual ErrorCode IStoryPropertiesSuite::SetOpticalMarginAlignment ( GenericBooleanState  bAlign )

pure virtual

Sets the optical margin alignment story attribute on or off

Parameters

bAlign

the state of the alignment of selected stories

Returns

error if operation failed

virtual ErrorCode IStoryPropertiesSuite::SetOpticalMarginAlignmentSize ( PMReal  alignmentSize )

pure virtual

Sets the optical margin alignment size story attribute

Parameters

alignmentSize

[IN] size, in points, of the average body text in the story

Returns

error if operation failed

virtual ErrorCode IStoryPropertiesSuite::SetStoryAttributeLock ( GenericBooleanState  locked )

pure virtual

Sets the story attribute lock

Parameters

locked

kStateOn if on

Returns

error if operation failed

virtual ErrorCode IStoryPropertiesSuite::SetStoryInsertLock ( GenericBooleanState  locked )

pure virtual

Sets the story insert lock

Parameters

locked

kStateOn if on

Returns

error if operation failed

virtual ErrorCode IStoryPropertiesSuite::SetTextDirection ( TextDirection  dir )

pure virtual

Sets the text direction of the story (Japanese featureset)

Parameters

dir	[IN] text direction to be set

Returns

error if operation failed

virtual bool16 IStoryPropertiesSuite::ShouldEnableFrameType ( ) const

pure virtual

Whether the frame type widget should be enabled in the Story panel (Japanese featureset)

Returns

kTrue if widget should be enabled

virtual bool16 IStoryPropertiesSuite::ShouldEnableOpticalMarginAlignment ( ) const

pure virtual

Whether the optical margin alignment widget should be enabled in the Story panel

Returns

kTrue if widget should be enabled

virtual bool16 IStoryPropertiesSuite::ShouldEnableOpticalMarginAlignmentSize ( ) const

pure virtual

Whether the optical margin alignment size widget should be enabled in the Story panel

Returns

kTrue if widget should be enabled

virtual bool16 IStoryPropertiesSuite::ShouldEnableTextDirection ( ) const

pure virtual

Whether the text direction widget should be enabled in the Story panel (Japanese featureset)

Returns

kTrue if widget should be enabled