ICompFontDataSettings Class Reference

#include <ICompositeFont.h>

Inheritance diagram for ICompFontDataSettings:

Public Types
enum	{ kDefaultIID = IID_ICOMPFONTDATASETTINGS }

Public Member Functions
virtual void	ClearRanges ()=0
virtual void	SetDefault ()=0
virtual void	SetName (const PMString &s)=0
virtual void	SetName (const PMString &s, bool16 translatable)=0
virtual const PMString &	GetName () const =0
virtual void	SetFontUID (const UID &nUID)=0
virtual UID	GetFontUID () const =0
virtual void	SetFontStyle (const PMString &nFontStyle)=0
virtual PMString	GetFontStyle () const =0
virtual void	SetSizeValue (const PMReal nSize)=0
virtual PMReal	GetSizeValue () const =0
virtual void	SetBaselineValue (const PMReal nBaseline)=0
virtual PMReal	GetBaselineValue () const =0
virtual void	SetHScaleValue (const PMReal nScale)=0
virtual PMReal	GetHScaleValue () const =0
virtual void	SetVScaleValue (const PMReal nScale)=0
virtual PMReal	GetVScaleValue () const =0
virtual void	SetLocked (const bool16 locked)=0
virtual bool16	IsLocked () const =0
virtual void	SetCharRanges (const CharRangeCollection ranges)=0
virtual CharRangeCollection	GetCharRanges () const =0
virtual CharRangeCollection	GetCharRangesAjustedForCoolType ()=0
virtual bool16	ConvertToUnicode ()=0
virtual void	AddRemapRange (UTF32TextChar firstChar, UTF32TextChar lastChar, UTF32TextChar destChar, int32 script=-1)=0
virtual void	AddRange (UTF32TextChar firstChar, UTF32TextChar lastChar, int32 script=-1)=0
virtual WideString	GetRangeAsWideString () const =0
virtual PMString	GetRangeAsString () const =0
virtual void	SetRangeFromWideString (WideString setWString, int32 script=-1)=0
virtual void	SetRangeFromString (PMString setString)=0
virtual bool16	SupportsScript (int32 script) const =0
virtual void	CopyCompFontSetting (ICompFontDataSettings *from)=0
virtual void	ReadWrite (IPMStream *s, ImplementationID id)=0
virtual bool16	FindCharInRange (UTF32TextChar findChar, UTF32TextChar &remapChar) const =0
virtual void	ClearScaleAdjustment ()=0
virtual ScaleAdjustment	GetScaleAdjustment () const =0
virtual bool16	GetScaleOption ()=0
virtual void	SetScaleOption (bool16 scaleOption)=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

Settings in a ICompositeFont.

Member Function Documentation

virtual void ICompFontDataSettings::AddRange ( UTF32TextChar  firstChar, UTF32TextChar  lastChar, int32  script = -1  )

pure virtual

Add unicode range to setting.

Parameters

firstChar	first unicode value of range
lastChar	last unicode value of range
script	Obsolete. Do not use.

virtual void ICompFontDataSettings::AddRemapRange ( UTF32TextChar  firstChar, UTF32TextChar  lastChar, UTF32TextChar  destChar, int32  script = -1  )

pure virtual

Add unicode range to setting.

Parameters

firstChar	first unicode value of range
lastChar	last unicode value of range
destChar	new unicode value to remap firstChar. If equal to firstChar no remapping is done.
script	Obsolete. Do not use.

virtual void ICompFontDataSettings::ClearRanges ( )

pure virtual

Clear all character ranges.

virtual void ICompFontDataSettings::ClearScaleAdjustment ( )

pure virtual

Set all scale adjustment values to 0.

virtual bool16 ICompFontDataSettings::ConvertToUnicode ( )

pure virtual

This converts InDesign 1.0J composite fonts from platform encoding to unicode encoding

Returns

bool16 kTrue if success. kFalse if could not convert to unicode

virtual void ICompFontDataSettings::CopyCompFontSetting ( ICompFontDataSettings *  from )

pure virtual

Copy composite font setting data

Parameters

from	data to copy

virtual bool16 ICompFontDataSettings::FindCharInRange ( UTF32TextChar  findChar, UTF32TextChar &  remapChar  ) const

pure virtual

Given a character return kTrue if in range and return remapped character in remapChar

Parameters

findChar	character to find
remapChar	remapped character value. Unless ranges are remapped this is same as findChar

Returns

bool16 kTrue if character is in range.

virtual PMReal ICompFontDataSettings::GetBaselineValue ( ) const

pure virtual

Get relative base line shift percentage. This is relative to base(Kanji) setting.

Returns

percent of base setting base line shift

virtual CharRangeCollection ICompFontDataSettings::GetCharRanges ( ) const

pure virtual

Get character ranges

Returns

CharRangeCollection character ranges

virtual CharRangeCollection ICompFontDataSettings::GetCharRangesAjustedForCoolType ( )

pure virtual

this is the ranges adjusted for sending to cooltype. this flattens ATC ranges when a component font is ATC

Returns

CharRangeCollection adjusted character ranges

virtual PMString ICompFontDataSettings::GetFontStyle ( ) const

pure virtual

Get font style name for setting

Returns

font style name

virtual UID ICompFontDataSettings::GetFontUID ( ) const

pure virtual

Get UID of font family for this setting

Returns

font family UID

virtual PMReal ICompFontDataSettings::GetHScaleValue ( ) const

pure virtual

Get relative horizontal scale percentage. This is relative to base(Kanji) setting.

Returns

percent of base font horizontal scale

virtual const PMString& ICompFontDataSettings::GetName ( ) const

pure virtual

Get name of setting

Returns

PMString name of setting

virtual PMString ICompFontDataSettings::GetRangeAsString ( ) const

pure virtual

Range is returned as a PMString of characters

Returns

PMString string of range characters

virtual WideString ICompFontDataSettings::GetRangeAsWideString ( ) const

pure virtual

Range is returned as a Unicode string of characters.

Returns

WideString Unicode string of range characters.

virtual ScaleAdjustment ICompFontDataSettings::GetScaleAdjustment ( ) const

pure virtual

Get scale adjustment setting. Most of the time you just need the GetScaleOption value.

Returns

ScaleAdjustment scale adjustment setting

virtual bool16 ICompFontDataSettings::GetScaleOption ( )

pure virtual

Get the scale from center option.

Returns

bool16 kTrue if scaling from center. kFalse if scaling from baseline

virtual PMReal ICompFontDataSettings::GetSizeValue ( ) const

pure virtual

Get relative font size percentage. This is relative to base(Kanji) setting.

Returns

percent of base font size

virtual PMReal ICompFontDataSettings::GetVScaleValue ( ) const

pure virtual

Get relative vertical scale percentage. This is relative to base(Kanji) setting.

Returns

percent of base font vertical scale

virtual bool16 ICompFontDataSettings::IsLocked ( ) const

pure virtual

Gets locked status of data setting.

Returns

bool16 kTrue if locked. kFalse if unlocked

virtual void ICompFontDataSettings::ReadWrite ( IPMStream *  s, ImplementationID  id  )

pure virtual

Read/Write the setting data

Parameters

s	stream to read write
id	not used

virtual void ICompFontDataSettings::SetBaselineValue ( const PMReal  nBaseline )

pure virtual

Set relative base line shift percentage. This is relative to base(Kanji) setting.

Parameters

nBaseline

percent of base setting base line shift

virtual void ICompFontDataSettings::SetCharRanges ( const CharRangeCollection  ranges )

pure virtual

Set character ranges. replaces does not append.

Parameters

ranges

new character ranges.

virtual void ICompFontDataSettings::SetDefault ( )

pure virtual

Set all values to default. This will also clear all ranges.

virtual void ICompFontDataSettings::SetFontStyle ( const PMString &  nFontStyle )

pure virtual

Set font style name for setting

Parameters

nFontStyle

font style name

virtual void ICompFontDataSettings::SetFontUID ( const UID &  nUID )

pure virtual

Set UID of font family for this setting

Parameters

nUID	font family UID

virtual void ICompFontDataSettings::SetHScaleValue ( const PMReal  nScale )

pure virtual

Set relative horizontal scale percentage. This is relative to base(Kanji) setting.

Parameters

nSize

percent of base font horizontal scale

virtual void ICompFontDataSettings::SetLocked ( const bool16  locked )

pure virtual

Sets data setting so user cannot edit.

Parameters

bool16

kTrue to set lock. kFalse to set unlocked

virtual void ICompFontDataSettings::SetName ( const PMString &  s )

pure virtual

Set name of setting.

Parameters

s	name of setting.

virtual void ICompFontDataSettings::SetName ( const PMString &  s, bool16  translatable  )

pure virtual

Set name of setting.

Parameters

s	name of setting.
translatable	kTrue if name is translatable. Translatable names are usually only for the default settings like "Kanji", "Kana" ,,,

virtual void ICompFontDataSettings::SetRangeFromString ( PMString  setString )

pure virtual

Set range from PMString string

Parameters

setString

string to use to set ranges

virtual void ICompFontDataSettings::SetRangeFromWideString ( WideString  setWString, int32  script = -1  )

pure virtual

Set range from Unicode string

Parameters

setWString	string to use to set ranges
script	OBSOLETE

virtual void ICompFontDataSettings::SetScaleOption ( bool16  scaleOption )

pure virtual

Set the scale from center option.

Parameters

scaleOption

kTrue if scaling from center. kFalse if scaling from baseline

virtual void ICompFontDataSettings::SetSizeValue ( const PMReal  nSize )

pure virtual

Set relative font size percentage. This is relative to base(Kanji) setting.

Parameters

nSize

percent of base font size

virtual void ICompFontDataSettings::SetVScaleValue ( const PMReal  nScale )

pure virtual

Set relative vertical scale percentage. This is relative to base(Kanji) setting.

Parameters

nSize

percent of base font vertical scale

virtual bool16 ICompFontDataSettings::SupportsScript ( int32  script ) const

pure virtual

Returns what script the setting supports. Kanji supports all CJK scripts. This is used to determine what fonts are shown in composite font setting UI.

Parameters

script

script to test for support

Returns

bool16 kTrue if setting supports the script.