InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IKentenStyle Class Referenceabstract

#include <IKentenStyle.h>

Inheritance diagram for IKentenStyle:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IKENTENSTYLE }
 
enum  KentenKind {
  Kenten_None = 0, Kenten_BlackSesameDot, Kenten_WhiteSesameDot, Kenten_Fisheye,
  Kenten_BlackCircle, Kenten_SmallBlackCircle, Kenten_Bullseye, Kenten_BlackTriangle,
  Kenten_WhiteTriangle, Kenten_WhiteCircle, Kenten_SmallWhiteCircle, Kenten_Custom
}
 
enum  AlignmentType { kLeft, kCenter, kRight }
 
enum  { kShiftJIS = 0, kJIS, kUnicode, kKuten }
 
enum  {
  kBlackSesameAscii = 0x0030, kWhiteSesameAscii, kFisheyeAscii, kBlackCircleAscii,
  kSmallBlackCircleAscii, kBullseyeAscii, kBlackTriangleAscii, kWhiteTriangleAscii,
  kWhiteCircleAscii, kSmallWhiteCircleAscii
}
 

Public Member Functions

virtual void SetKentenKind (IKentenStyle::KentenKind flag)=0
 
virtual IKentenStyle::KentenKind GetKentenKind () const =0
 
virtual void SetKentenSize (PMReal p)=0
 
virtual PMReal GetKentenSize () const =0
 
virtual void SetKentenRelatedSize (PMReal p)=0
 
virtual PMReal GetKentenRelatedSize () const =0
 
virtual void SetKentenFontFamily (UID u)=0
 
virtual UID GetKentenFontFamily () const =0
 
virtual void SetKentenFontStyle (const PMString &n)=0
 
virtual const PMStringGetKentenFontStyle () const =0
 
virtual void SetKentenXScale (PMReal r)=0
 
virtual PMReal GetKentenXScale () const =0
 
virtual void SetKentenYScale (PMReal r)=0
 
virtual PMReal GetKentenYScale () const =0
 
virtual void SetKentenXOffset (PMReal r)=0
 
virtual PMReal GetKentenXOffset () const =0
 
virtual void SetKentenYOffset (PMReal r)=0
 
virtual PMReal GetKentenYOffset () const =0
 
virtual void SetKentenColor (UID newColor)=0
 
virtual UID GetKentenColor ()=0
 
virtual void SetColorUID (bool16 stroke, UID newColor)=0
 
virtual UID GetColorUID (bool16 stroke)=0
 
virtual void SetTint (bool16 stroke, PMReal tint)=0
 
virtual PMReal GetTint (bool16 stroke) const =0
 
virtual void SetOverprint (bool16 stroke, int16 over)=0
 
virtual int16 GetOverprint (bool16 stroke) const =0
 
virtual void SetOutlineWidth (PMReal width)=0
 
virtual PMReal GetOutlineWidth () const =0
 
virtual bool16 IsOutlined ()=0
 
virtual void SetKentenAlignment (IKentenStyle::AlignmentType align)=0
 
virtual int16 GetKentenAlignment () const =0
 
virtual void SetKentenCharacterSet (int16 characterSet)=0
 
virtual int16 GetKentenCharacterSet () const =0
 
virtual void SetKentenPosition (bool16 pos)=0
 
virtual bool16 GetKentenPosition () const =0
 
virtual void SetKentenCharacter (textchar code)=0
 
virtual textchar GetKentenCharacter () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface for the kenten style text attribute. It is traditionally an accent mark above or below kanji characters.

Member Enumeration Documentation

anonymous enum

interface ID enum

anonymous enum

Kenten character set enum

anonymous enum

Kenten kind ascii enum (for Adobe Kenten font)

Kenten alignment enum

Kenten kind enum
Enumerator
Kenten_Custom 

user selected glyph

Member Function Documentation

virtual UID IKentenStyle::GetColorUID (bool16 stroke)
pure virtual
Get Kenten Color UID

Returns
Kenten Color UID
virtual int16 IKentenStyle::GetKentenAlignment () const
pure virtual
Get Kenten Alignment

Returns
Kenten Alignment
virtual textchar IKentenStyle::GetKentenCharacter () const
pure virtual
Get Kenten Character code

Returns
Kenten Character code
virtual int16 IKentenStyle::GetKentenCharacterSet () const
pure virtual
Get Kenten Character Set

Returns
Kenten Character Set
virtual UID IKentenStyle::GetKentenColor ()
pure virtual
Get Kenten Color

Returns
Kenten Color UID
virtual UID IKentenStyle::GetKentenFontFamily () const
pure virtual
Get Kenten Font family

Returns
Kenten Font family UID
virtual const PMString& IKentenStyle::GetKentenFontStyle () const
pure virtual
Get Kenten Font style

Returns
Kenten Font family style name
virtual IKentenStyle::KentenKind IKentenStyle::GetKentenKind () const
pure virtual

Get Kenten Character kind

virtual bool16 IKentenStyle::GetKentenPosition () const
pure virtual
Get Kenten Position

Returns
Kenten Position
virtual PMReal IKentenStyle::GetKentenRelatedSize () const
pure virtual
Get Kenten related size

Returns
Kenten related size
virtual PMReal IKentenStyle::GetKentenSize () const
pure virtual
Get Kenten point size

Returns
Kenten point size
virtual PMReal IKentenStyle::GetKentenXOffset () const
pure virtual
Get Kenten X Offset

Returns
Kenten X Offset
virtual PMReal IKentenStyle::GetKentenXScale () const
pure virtual
Get Kenten X Scale

Returns
Kenten X Scale
virtual PMReal IKentenStyle::GetKentenYOffset () const
pure virtual
Get Kenten Y Offset

Returns
Kenten Y Offset
virtual PMReal IKentenStyle::GetKentenYScale () const
pure virtual
Get Kenten Y Scale

Returns
Kenten Y Scale
virtual PMReal IKentenStyle::GetOutlineWidth () const
pure virtual
Get Kenten Outline Width

Returns
Kenten Outline Width
virtual int16 IKentenStyle::GetOverprint (bool16 stroke) const
pure virtual
Get Kenten Overprint

Returns
Kenten Overprint
virtual PMReal IKentenStyle::GetTint (bool16 stroke) const
pure virtual
Get Kenten tint

Returns
Kenten tint
virtual bool16 IKentenStyle::IsOutlined ()
pure virtual
Get Kenten is outlined flag

Returns
Kenten is outlined flag
virtual void IKentenStyle::SetColorUID (bool16 stroke,
UID newColor 
)
pure virtual

Set Kenten Color

Parameters
strokeflag
newColorcolor uid
virtual void IKentenStyle::SetKentenAlignment (IKentenStyle::AlignmentType align)
pure virtual

Set Kenten Alignment

Parameters
align
virtual void IKentenStyle::SetKentenCharacter (textchar code)
pure virtual

Set Kenten Character code of Kenten (Custom)

Parameters
codekenten textchar
virtual void IKentenStyle::SetKentenCharacterSet (int16 characterSet)
pure virtual

Set Kenten Character Set

Parameters
characterSet
virtual void IKentenStyle::SetKentenColor (UID newColor)
pure virtual

Set Kenten Color

Parameters
newColorcolor UID
virtual void IKentenStyle::SetKentenFontFamily (UID u)
pure virtual

Set Kenten Font family

Parameters
ufont UID
virtual void IKentenStyle::SetKentenFontStyle (const PMStringn)
pure virtual

Set Kenten Font style

Parameters
nfontStyleName
virtual void IKentenStyle::SetKentenKind (IKentenStyle::KentenKind flag)
pure virtual

Set Kenten kind

Parameters
flag(should be of the KentenKind enumerated type specified above!)
virtual void IKentenStyle::SetKentenPosition (bool16 pos)
pure virtual

Set Kenten Position

Parameters
pos0: above/right 1: below/left
virtual void IKentenStyle::SetKentenRelatedSize (PMReal p)
pure virtual

Set Kenten related size

Parameters
prelated size
virtual void IKentenStyle::SetKentenSize (PMReal p)
pure virtual

Set Kenten point size

Parameters
ppoint size
virtual void IKentenStyle::SetKentenXOffset (PMReal r)
pure virtual

Set Kenten X Offset

Parameters
rthe x offset value
virtual void IKentenStyle::SetKentenXScale (PMReal r)
pure virtual

Set Kenten X Scale

Parameters
rthe x scale value
virtual void IKentenStyle::SetKentenYOffset (PMReal r)
pure virtual

Set Kenten Y Offset

Parameters
rthe y offset value
virtual void IKentenStyle::SetKentenYScale (PMReal r)
pure virtual

Set Kenten Y Scale

Parameters
rthe y scale value
virtual void IKentenStyle::SetOutlineWidth (PMReal width)
pure virtual

Set Kenten Outline Width

Parameters
width
virtual void IKentenStyle::SetOverprint (bool16 stroke,
int16 over 
)
pure virtual

Set Kenten Overprint

Parameters
strokeflag
overprintvalue
virtual void IKentenStyle::SetTint (bool16 stroke,
PMReal tint 
)
pure virtual

Set Kenten tint

Parameters
strokeflag
tintvalue