#include <ICJKGridData.h>

Inheritance diagram for ICJKGridData:

Public Types
enum	{ kDefaultIID = IID_ICJKGRIDDATA }

Public Member Functions
virtual void	SetFontUID (UID font)=0

virtual UID	GetFontUID () const =0

virtual void	SetFontStyleName (const PMString &name)=0

virtual const PMString &	GetFontStyleName () const =0

virtual void	SetMMAxes (int32 num, const Fixed *buffer)=0

virtual int32	GetNumMMAxes () const =0

virtual const Fixed *	GetMMAxes () const =0

virtual void	SetTextSize (PMReal size)=0

virtual PMReal	GetTextSize () const =0

virtual void	SetCharAki (PMReal amount)=0

virtual PMReal	GetCharAki () const =0

virtual void	SetLineAki (PMReal space)=0

virtual PMReal	GetLineAki () const =0

virtual PMReal	GetCharOkuri (bool16 isVertical) const =0

virtual PMReal	GetLineOkuri (bool16 isVertical) const =0

virtual void	SetHScale (PMReal value)=0

virtual PMReal	GetHScale () const =0

virtual void	SetVScale (PMReal value)=0

virtual PMReal	GetVScale () const =0

virtual void	SetTextAlignment (ICompositionStyle::TextAlignment alignment)=0

virtual ICompositionStyle::TextAlignment	GetTextAlignment () const =0

virtual void	SetGridAlignment (Text::GridAlignmentMetric gridAlignment)=0

virtual Text::GridAlignmentMetric	GetGridAlignment () const =0

virtual void	SetCharacterHang (IDrawingStyle::CharacterHang characterHang)=0

virtual IDrawingStyle::CharacterHang	GetCharacterHang () const =0

virtual void	CopyFrom (const ICJKGridData *source, bool16 doDirty=kTrue)=0

virtual void	CopyFrom (const IFilteredCJKGridCmdData *source, bool16 doDirty=kTrue)=0

virtual bool16	GridDataMatches (const ICJKGridData *g2) const =0

virtual bool16	NonAlignmentGridDataMatches (const ICJKGridData *g2) 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

ICJKGridData is the interface used to describe a CJK grid. Among other places it is aggregated on the kTextStoryBoss to describe a story's frame grids, and on the kPageBoss to describe a page's layout grid.

Member Function Documentation

virtual void ICJKGridData::CopyFrom	(	const ICJKGridData *	source,
		bool16	doDirty = `kTrue`
	)

pure virtual

Copies all data from the passed in ICJKGridData to this ICJKGridData.

Parameters

source	IN ICJKGridData to copy from.
doDirty	IN Should dirty be called when changing data in this ICJKGridData.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual void ICJKGridData::CopyFrom	(	const IFilteredCJKGridCmdData *	source,
		bool16	doDirty = `kTrue`
	)

pure virtual

Copies all valid data from the passed in IFilteredCJKGridCmdData to this ICJKGridData.

Parameters

source	IN IFilteredCJKGridCmdData to copy from.
doDirty	IN Should dirty be called when changing data in this ICJKGridData.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual IDrawingStyle::CharacterHang ICJKGridData::GetCharacterHang ( ) const

pure virtual

Returns character hang setting

Returns: IDrawingStyle::CharacterHang.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual PMReal ICJKGridData::GetCharAki ( ) const

pure virtual

Returns char aki.

Returns: the distance in points between grid cells in the char wise direction

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual PMReal ICJKGridData::GetCharOkuri ( bool16 isVertical ) const

pure virtual

Returns Char Okuri in points. When vertical, okuri equals the grid size * vertical glyph scale + char aki. When horizontal okuri equals grid size * horizontal glyph scale + char aki.

Parameters

isVertical IN Whether or not the frame is vertical..

Returns: Grid size * appropriate glyph scale + char aki

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual const PMString& ICJKGridData::GetFontStyleName ( ) const

pure virtual

Returns the font style name

Returns: The font style name

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual UID ICJKGridData::GetFontUID ( ) const

pure virtual

Returns the font UID.

Returns: the current font UID.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual Text::GridAlignmentMetric ICJKGridData::GetGridAlignment ( ) const

pure virtual

Returns grid alignment setting

Returns: Text::GridAlignmentMetric.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual PMReal ICJKGridData::GetHScale ( ) const

pure virtual

Returns horizontal glyph scale

Returns: Horizontal glyph scale percentage (1.0 = 100%)

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual PMReal ICJKGridData::GetLineAki ( ) const

pure virtual

Returns line aki.

Returns: the distance in points between grid cells in the line wise direction

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual PMReal ICJKGridData::GetLineOkuri ( bool16 isVertical ) const

pure virtual

Returns Line Okuri in points. When vertical, okuri equals the grid size * horizontal glyph scale + line aki. When horizontal okuri equals grid size * vertical glyph scale + line aki.

Parameters

isVertical IN Whether or not the frame is vertical..

Returns: Grid size * appropriate glyph scale + line aki

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual const Fixed* ICJKGridData::GetMMAxes ( ) const

pure virtual

Get multiple master axes

Returns: Fixed*

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual int32 ICJKGridData::GetNumMMAxes ( ) const

pure virtual

Get number multiple master axes

Returns: number of axes

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual ICompositionStyle::TextAlignment ICJKGridData::GetTextAlignment ( ) const

pure virtual

Returns text alignment setting

Returns: ICompositionStyle::TextAlignment

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual PMReal ICJKGridData::GetTextSize ( ) const

pure virtual

Returns the pre-scale size of the grid box in points.

Returns: grid size in points.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual PMReal ICJKGridData::GetVScale ( ) const

pure virtual

Returns vertical glyph scale

Returns: Vertical glyph scale percentage (1.0 = 100%)

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual bool16 ICJKGridData::GridDataMatches ( const ICJKGridData * g2 ) const

pure virtual

Compares this grid data with passed in grid data.

Parameters

g2	IN Pointer to ICJKGridData to compare to this ICJKGridData .

Returns: kTrue on match, kFalse on difference

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual bool16 ICJKGridData::NonAlignmentGridDataMatches ( const ICJKGridData * g2 ) const

pure virtual

Compares this grid data (excluding alignment data) with passed in grid data.

Parameters

g2	IN Pointer to ICJKGridData to compare to this ICJKGridData .

Returns: kTrue on match, kFalse on difference

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual void ICJKGridData::SetCharacterHang ( IDrawingStyle::CharacterHang characterHang )

pure virtual

Sets character hang setting

Parameters

characterHang IN New character hang setting

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual void ICJKGridData::SetCharAki ( PMReal amount )

pure virtual

Sets char aki.

Parameters

space IN The new space between grid cells in the char wise direction.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual void ICJKGridData::SetFontStyleName ( const PMString & name )

pure virtual

Sets the font style name

Parameters

name	IN The new font style name.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual void ICJKGridData::SetFontUID ( UID font )

pure virtual

Sets the font UID.

Parameters

font	IN The new font UID.

Precondition: font should be a valid font UID.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual void ICJKGridData::SetGridAlignment ( Text::GridAlignmentMetric gridAlignment )

pure virtual

Sets grid alignment setting

Parameters

gridAlignment IN New grid alignment setting

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual void ICJKGridData::SetHScale ( PMReal value )

pure virtual

Sets horizontal glyph scale.

Parameters

value IN New horizontal glyph scale.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual void ICJKGridData::SetLineAki ( PMReal space )

pure virtual

Sets line aki.

Parameters

space IN The new space between grid cells in the line wise direction.

Implemented in ICJKFrameGridDefaults, and ICJKLayoutGridDefaults.

virtual void ICJKGridData::SetMMAxes	(	int32	num,
		const Fixed *	buffer
	)

pure virtual

Set axes for variable fonts. If you want to set this you can use the value from either IPMFont::GetNumDesignAxes() and IPMFont AccessDesignVector or FontGroupIteratorCallBack::OnMMAxes

Parameters