InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
SnpPerformTextAttrWarichu Class Reference
Snippets | Text Samples | CJK Samples

Public Member Functions

 SnpPerformTextAttrWarichu ()
 
virtual ~SnpPerformTextAttrWarichu ()
 
ErrorCode ApplyWarichu (const InDesign::TextRange &textRange, const SnpWarichuDataSettings &warichuData)
 
ErrorCode RemoveWarichu (const InDesign::TextRange &textRange)
 
ErrorCode InspectWarichu (const InDesign::TextRange &textRange, SnpWarichuDataSettings &warichuData)
 
void SetWarichuData (const InDesign::TextRange &textRange, SnpWarichuDataSettings &warichuData)
 
void ReportWarichuData (const SnpWarichuDataSettings &warichuData)
 

Detailed Description

  • How to apply, remove, and inspect Japanese Warichu text attributes.

"Warichu" refers to an in-line text annotation that is commonly used in Japanese text layout. It is used in ways similar to footnotes or endnotes in. In InDesign, Warichu is implemented as a group of text attributes along with appropriate support from the Japanese text composers. When you apply Warichu to your text, you must be using a Japanese text composer.

See Also
IAttrReport
IComposeScanner
ITextAttrClassID
ITextAttrInt16
ITextAttrRealNumber
ITextFocus
ITextModel
ITextTarget

Constructor & Destructor Documentation

SnpPerformTextAttrWarichu::SnpPerformTextAttrWarichu ()
inline

Constructor.

virtual SnpPerformTextAttrWarichu::~SnpPerformTextAttrWarichu ()
inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpPerformTextAttrWarichu::ApplyWarichu (const InDesign::TextRange & textRange,
const SnpWarichuDataSettings & warichuData 
)

Applies Warichu attributes onto the specified text model range.

Parameters
[in]textRangeThe text range to which you want to apply Warichu.
[in]warichuDataThe Warichu settings. Use SetWarichuData() to fill in the members.
Returns
kSuccess on success, kFailure otherwise.
ErrorCode SnpPerformTextAttrWarichu::InspectWarichu (const InDesign::TextRange & textRange,
SnpWarichuDataSettings & warichuData 
)

Inspects Warichu attributes over the specified text model range. The details are printed onto the SNIPLOG.

Parameters
[in]textRangeThe text range from which you want to inspect Warichu.
[out]warichuDataThe Warichu settings.
Returns
kSuccess on success, kFailure otherwise.
ErrorCode SnpPerformTextAttrWarichu::RemoveWarichu (const InDesign::TextRange & textRange)

Removes (or simply turns off) Warichu attributes from the specified text model range.

Parameters
[in]textRangeThe text range from which you want to remove Warichu.
Returns
kSuccess on success, kFailure otherwise.
void SnpPerformTextAttrWarichu::ReportWarichuData (const SnpWarichuDataSettings & warichuData)

Reports Warichu data to SNIPLOG.

Parameters
[in]warichuDataThe Warichu settings.
void SnpPerformTextAttrWarichu::SetWarichuData (const InDesign::TextRange & textRange,
SnpWarichuDataSettings & warichuData 
)

Sets the SnpWarichuDataSettings structure.

Parameters
[in]textRangeThe text range to use as a basis for some Warichu settings.
[out]warichuDataThe Warichu settings that can be passed on to ApplyWarichu().