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

Public Member Functions

 SnpPerformTextAttrLanguage ()
 
virtual ~SnpPerformTextAttrLanguage ()
 
ErrorCode ApplyLanguage (const InDesign::TextRange &textRange, const PMString &languageName)
 
ErrorCode InspectLanguage (const InDesign::TextRange &textRange, SnpLanguageData &data)
 
void ReportLanguageData (const SnpLanguageData &languageData)
 
void ReportLanguageList (void)
 
void GetLanguageList (IDocument *document)
 
void GetLanguagesCachedAsStringList (K2Vector< PMString > &listString)
 
PMString GetNthCachedUntranslatedLang (int32 n)
 

Detailed Description

  • How to apply and inspect Language text attributes,
  • How to acquire the language list which can be used.
See Also
IAttrReport
IComposeScanner
ITextAttrClassID
ITextTarget
ILanguage
ILanguageList
IVendorList
IDocument

Constructor & Destructor Documentation

SnpPerformTextAttrLanguage::SnpPerformTextAttrLanguage ()
inline

Constructor.

virtual SnpPerformTextAttrLanguage::~SnpPerformTextAttrLanguage ()
inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpPerformTextAttrLanguage::ApplyLanguage (const InDesign::TextRange & textRange,
const PMString & languageName 
)

Applies language attribute to the specified text model.

Parameters
textRange(in) The text range to which you want to apply language.
languageName(in) The language name to which you want to apply language.
Returns
kSuccess on success, kFailure otherwise.
void SnpPerformTextAttrLanguage::GetLanguageList (IDocument * document)

Get the language list made from the current document.

Parameters
document(in) current document.
ErrorCode SnpPerformTextAttrLanguage::InspectLanguage (const InDesign::TextRange & textRange,
SnpLanguageData & data 
)

Inspects language attribute over the specified text model. The details are printed to the SNIPLOG.

Parameters
textRange(in) The text range from which you want to inspect lLanguage.
data(out) The language data.
Returns
kSuccess on success, kFailure otherwise.
void SnpPerformTextAttrLanguage::ReportLanguageData (const SnpLanguageData & languageData)

Reports language data to SNIPLOG.

Parameters
languageData(in) The language settings.
void SnpPerformTextAttrLanguage::ReportLanguageList (void )

Reports language list to SNIPLOG.