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

#include <IVerticalRelatedStyle.h>

Inheritance diagram for IVerticalRelatedStyle:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IVERTICALRELATEDSTYLE }
 

Public Member Functions

virtual void SetRotateRoman (bool16 flag)=0
 
virtual bool16 GetRotateRoman () const =0
 
virtual void SetNumOfKumiNumber (int16 num)=0
 
virtual int16 GetNumOfKumiNumber () const =0
 
virtual void SetKumiNumberWithRoman (bool16 flag)=0
 
virtual bool16 GetKumiNumberWithRoman () const =0
 
virtual void SetTatechuyokoFlag (bool16 flag)=0
 
virtual bool16 GetTatechuyokoFlag () const =0
 
virtual void SetTatechuyokoXOffset (PMReal r)=0
 
virtual PMReal GetTatechuyokoXOffset () const =0
 
virtual void SetTatechuyokoYOffset (PMReal r)=0
 
virtual PMReal GetTatechuyokoYOffset () 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

IVerticalRelatedStyle is one of the interfaces hanging off the kComposeStyleBoss object. As such, it is easily Queried from an IDrawingStyle interface. Text attributes can be summarized into a kComposeStyleBoss object, which is a non-persistent summary of every text attribute applied to some text. IVerticalRelatedStyle lists character attributes associated with the Japanese vertical text feature. IVerticalRelatedStyle should be considered a "read-only" interface because the set operations have no impact beyond this data interface. It does not apply through to the text that this interface derived from. The text attributes themselves are the primary setters of the data.

See Also
IDrawingStyle
IMojikumiStyle

Member Function Documentation

virtual bool16 IVerticalRelatedStyle::GetKumiNumberWithRoman () const
pure virtual
 Accesses whether or not single-byte Roman characters should be included in automatic Tate-chuu-yoko

Returns
kTrue if single-byte Roman characters should be included in automatic Tate-chuu-yoko
virtual int16 IVerticalRelatedStyle::GetNumOfKumiNumber () const
pure virtual
 Accesses the number of digits of single-byte numbers will be turned into auto-TCY

Returns
number of digits
virtual bool16 IVerticalRelatedStyle::GetRotateRoman () const
pure virtual
 Accesses whether or not the Rotate Roman character to be upright in vertical text feature is on

Returns
kTrue if feature is on
virtual bool16 IVerticalRelatedStyle::GetTatechuyokoFlag () const
pure virtual
 Accesses whether or not the Tate-chuu-yoko (horizontal-in-vertical) text feature is on

Returns
kTrue if feature is on
virtual PMReal IVerticalRelatedStyle::GetTatechuyokoXOffset () const
pure virtual
 Accesses x-offset adjustment of TCY run

Returns
x-offset in points
virtual PMReal IVerticalRelatedStyle::GetTatechuyokoYOffset () const
pure virtual
 Accesses y-offset adjustment of TCY run

Returns
y-offset in points
virtual void IVerticalRelatedStyle::SetKumiNumberWithRoman (bool16 flag)
pure virtual
 Turns on the "include single-byte Roman characters in automatic Tate-chuu-yoko" feature

Parameters
bool16[IN] kTrue if single-byte Roman characters should be included in auto-TCY
virtual void IVerticalRelatedStyle::SetNumOfKumiNumber (int16 num)
pure virtual
 Turns on the automatic Tate-chuu-yoko feature for single-byte numbers in vertical text

Parameters
int16[IN] number of digits to include in auto-TCY
virtual void IVerticalRelatedStyle::SetRotateRoman (bool16 flag)
pure virtual
 Turns on the Rotate Roman characters to be upright in vertical feature

Parameters
flag[IN] kTrue means the feature is on
virtual void IVerticalRelatedStyle::SetTatechuyokoFlag (bool16 flag)
pure virtual
 Turns on the Tate-chuu-yoko (horizontal-in-vertical) text feature

Parameters
flag[IN] kTrue if feature is on
virtual void IVerticalRelatedStyle::SetTatechuyokoXOffset (PMReal r)
pure virtual
 Sets x-offset adjustment of TCY run

Parameters
r[IN] x-offset in points
virtual void IVerticalRelatedStyle::SetTatechuyokoYOffset (PMReal r)
pure virtual
 Sets y-offset adjustment of TCY run

Parameters
r[IN] y-offset in points