IStoryOptions Class Reference

#include <IStoryOptions.h>

Inheritance diagram for IStoryOptions:

Public Types
enum	{ kDefaultIID = IID_ISTORYOPTIONS }

Public Member Functions
virtual void	SetVertical (bool16 vertical)=0
virtual bool16	IsVertical () const =0
virtual void	SetRightToLeft (bool16 rtl)=0
virtual bool16	IsRightToLeft () const =0
virtual ClassID	GetEdgeAlignMethod () const =0
virtual void	SetEdgeAlignMethod (ClassID algo)=0
virtual PMReal	GetParagraphBodySize () const =0
virtual void	SetParagraphBodySize (PMReal b)=0
virtual bool16	GetCJKGridActive () const =0
virtual void	SetCJKGridActive (bool16 active)=0
virtual const ICJKGridData *	QueryCJKGridData () 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

Used to set various options for InDesign stories.

Member Function Documentation

virtual bool16 IStoryOptions::GetCJKGridActive ( ) const

pure virtual

Find out whether this story show the CJK Grid (J-Text)

Returns

- Is the grid be shown?

virtual ClassID IStoryOptions::GetEdgeAlignMethod ( ) const

pure virtual

Used to determine whether or not Optical Margin Alignment is used.

Returns

- kKFOpticalSideBearingBoss it is on, kEdgeAlignOffBoss it is off

virtual PMReal IStoryOptions::GetParagraphBodySize ( ) const

pure virtual

Gets the story's optical-margin-alignment size

Returns

- The current size (in points)

virtual bool16 IStoryOptions::IsRightToLeft ( ) const

pure virtual

Find out whether this story is right-to-left or not (ME - Text)

Returns

- Is this story right-to-left (kTrue) or left-to-right (kFalse)

virtual bool16 IStoryOptions::IsVertical ( ) const

pure virtual

Find out whether this story is vertical or not (J-Text)

Returns

- Is this story vertical (kTrue) or horizontal (kFalse)

virtual const ICJKGridData* IStoryOptions::QueryCJKGridData ( ) const

pure virtual

Same as this->QueryInterface(IID_ICJKGRIDDATA) but done to support multi-threading composition.

virtual void IStoryOptions::SetCJKGridActive ( bool16  active )

pure virtual

Set whether this story should show the CJK Grid (J-Text)

Parameters

vertical

- Should the grid be shown?

virtual void IStoryOptions::SetEdgeAlignMethod ( ClassID  algo )

pure virtual

Used to set whether or not Optical Margin Alignment is used.

Parameters

algo	- kKFOpticalSideBearingBoss will turn it on, kEdgeAlignOffBoss will turn it off

virtual void IStoryOptions::SetParagraphBodySize ( PMReal  b )

pure virtual

Sets the story's optical-margin-alignment size

Parameters

b	- The new size to use (in points)

virtual void IStoryOptions::SetRightToLeft ( bool16  rtl )

pure virtual

Set whether this story is primarily right to left (ME - Text)

Parameters

rtl	- Should this story be right-to-left (kTrue) or left-to-right (kFalse)

virtual void IStoryOptions::SetVertical ( bool16  vertical )

pure virtual

Set whether this story should be vertical or not (J-Text)

Parameters

vertical

- Should this story be vertical (kTrue) or horizontal (kFalse)