IObjectStylesStoryOptions Class Reference

#include <IObjectStylesStoryOptions.h>

Inheritance diagram for IObjectStylesStoryOptions:

Public Types
enum	{ kDefaultIID = IID_IOBJECTSTYLESSTORYOPTIONS }
enum	ObjectStyleDirection { kUnknownDirection, kHorizontal, kVertical }
enum	ObjectStyleWritingDirection { kUnknownWDirection, kLTRDirection = 1, kRTLDirection }
enum	ObjectStyleFrameType { kUnknownFrameType, kTextFrame, kFrameGrid }

Public Member Functions
virtual void	SetFrameDirection (IObjectStylesStoryOptions::ObjectStyleDirection direction)=0
virtual IObjectStylesStoryOptions::ObjectStyleDirection	GetFrameDirection () const =0
virtual void	SetWritingDirection (IObjectStylesStoryOptions::ObjectStyleWritingDirection direction)=0
virtual IObjectStylesStoryOptions::ObjectStyleWritingDirection	GetWritingDirection () 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 IObjectStylesStoryOptions::ObjectStyleFrameType	GetFrameType () const =0
virtual void	SetFrameType (IObjectStylesStoryOptions::ObjectStyleFrameType frameType)=0
virtual void	CopyData (IObjectStylesStoryOptions *pCopyTo) 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 void IObjectStylesStoryOptions::CopyData ( IObjectStylesStoryOptions *  pCopyTo ) const

pure virtual

Copy these values TO the passed in interface.

Parameters

pCopyTo

is filled out with the current interface's values.

virtual ClassID IObjectStylesStoryOptions::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 IObjectStylesStoryOptions::ObjectStyleDirection IObjectStylesStoryOptions::GetFrameDirection ( ) const

pure virtual

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

Returns

- direction

virtual IObjectStylesStoryOptions::ObjectStyleFrameType IObjectStylesStoryOptions::GetFrameType ( ) const

pure virtual

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

Returns

- Is frame grid or text frame or unknown?

virtual PMReal IObjectStylesStoryOptions::GetParagraphBodySize ( ) const

pure virtual

Gets the story's optical-margin-alignment size

Returns

- The current size (in points)

virtual IObjectStylesStoryOptions::ObjectStyleWritingDirection IObjectStylesStoryOptions::GetWritingDirection ( ) const

pure virtual

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

Returns

- direction

virtual void IObjectStylesStoryOptions::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 IObjectStylesStoryOptions::SetFrameDirection ( IObjectStylesStoryOptions::ObjectStyleDirection  direction )

pure virtual

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

Parameters

direction

- Should this story be vertical (kVertical) or horizontal (kHorizontal) or unknown.

virtual void IObjectStylesStoryOptions::SetFrameType ( IObjectStylesStoryOptions::ObjectStyleFrameType  frameType )

pure virtual

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

Parameters

frameType

- Set as kTextFrame or kFrameGrid?

virtual void IObjectStylesStoryOptions::SetParagraphBodySize ( PMReal  b )

pure virtual

Sets the story's optical-margin-alignment size

Parameters

b	- The new size to use (in points)

virtual void IObjectStylesStoryOptions::SetWritingDirection ( IObjectStylesStoryOptions::ObjectStyleWritingDirection  direction )

pure virtual

Set whether this story should be right-to-left or not (ME-Text)

Parameters

direction

- Should this story be vertical (kVertical) or horizontal (kHorizontal) or unknown.