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

#include <IWarichuStyle.h>

Inheritance diagram for IWarichuStyle:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IWARICHUSTYLE }
 

Public Member Functions

virtual void SetWarichuFlag (bool16 flag)=0
 
virtual bool16 GetWarichuFlag () const =0
 
virtual void SetWarichuNumOfLines (int16 num)=0
 
virtual int16 GetWarichuNumOfLines () const =0
 
virtual void SetWarichuRelativeSize (PMReal p)=0
 
virtual PMReal GetWarichuRelativeSize () const =0
 
virtual void SetWarichuLineSpacing (PMReal p)=0
 
virtual PMReal GetWarichuLineSpacing () const =0
 
virtual
ICompositionStyle::TextAlignment 
GetWarichuAlignment () const =0
 
virtual void SetWarichuAlignment (ICompositionStyle::TextAlignment align)=0
 
virtual bool16 OverrideParagraphAlignment () const =0
 
virtual void SetMinCharsBeforeBreak (int16 num)=0
 
virtual int16 GetMinCharsBeforeBreak () const =0
 
virtual void SetMinCharsAfterBreak (int16 num)=0
 
virtual int16 GetMinCharsAfterBreak () const =0
 
virtual void SetAutoResizeParen (bool16 flag)=0
 
virtual bool16 GetAutoResizeParen () 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

IWarichuStyle 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. IWarichuStyle lists character attributes associated with the Japanese Warichuu feature. IWarichuStyle 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 IWarichuStyle::GetAutoResizeParen () const
pure virtual

Gets flag for causing parentheses characters next to warichuu to be resized automatically, in composers that support this feature.

Parameters
flag
virtual int16 IWarichuStyle::GetMinCharsAfterBreak () const
pure virtual

Gets the minimum number of characters per warichuu line at the end of multi-line warichuu.

Parameters
none
Returns
int16
virtual int16 IWarichuStyle::GetMinCharsBeforeBreak () const
pure virtual

Gets the minimum number of characters per warichuu line at the start of multi-line warichuu.

Parameters
none
Returns
int16
virtual ICompositionStyle::TextAlignment IWarichuStyle::GetWarichuAlignment () const
pure virtual

will get base text's alignment if override is NOT set This means that usually the alignment of the warichuu matches that of the parent paragraph. But if the user overrides that setting, the overridden setting will be returned.

Parameters
none
Returns
ICompositionStyle::TextAlignment
virtual bool16 IWarichuStyle::GetWarichuFlag () const
pure virtual

Accesses whether Warichuu is on or off

Parameters
none
Returns
bool16
virtual PMReal IWarichuStyle::GetWarichuLineSpacing () const
pure virtual

Sets the space between each warichuu line in points

Parameters
none
Returns
PMReal
virtual int16 IWarichuStyle::GetWarichuNumOfLines () const
pure virtual

Gets the number of warichuu lines

Parameters
none
Returns
int16
virtual PMReal IWarichuStyle::GetWarichuRelativeSize () const
pure virtual

Gets the warichuu relative size (e.g. 50% scale = 0.5)

Parameters
none
Returns
PMReal
virtual bool16 IWarichuStyle::OverrideParagraphAlignment () const
pure virtual

Returns if the alignment is local to the warichuu or if it matches that of the parent paragraph

Parameters
none
Returns
bool16
virtual void IWarichuStyle::SetAutoResizeParen (bool16 flag)
pure virtual

Sets flag for causing parentheses characters next to warichuu to be resized automatically, in composers that support this feature.

Parameters
flag
virtual void IWarichuStyle::SetMinCharsAfterBreak (int16 num)
pure virtual

Sets the minimum number of characters per warichuu line at the end of multi-line warichuu.

Parameters
num
virtual void IWarichuStyle::SetMinCharsBeforeBreak (int16 num)
pure virtual

Sets the minimum number of characters per warichuu line at the start of multi-line warichuu.

Parameters
num
virtual void IWarichuStyle::SetWarichuAlignment (ICompositionStyle::TextAlignment align)
pure virtual

Sets the alignment of the warichuu (similar to paragraph alignment)

Parameters
align
virtual void IWarichuStyle::SetWarichuFlag (bool16 flag)
pure virtual

Turns Warichuu on or off

Parameters
flag
virtual void IWarichuStyle::SetWarichuLineSpacing (PMReal p)
pure virtual

Sets the space between each warichuu line in points

Parameters
p
virtual void IWarichuStyle::SetWarichuNumOfLines (int16 num)
pure virtual

Sets the number of warichuu lines

Parameters
num
virtual void IWarichuStyle::SetWarichuRelativeSize (PMReal p)
pure virtual

Sets the relative size (e.g. 50% scale = 0.5) of the warichuu

Parameters
p