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

#include <ICHLFileNameTable.h>

Inheritance diagram for ICHLFileNameTable:
IPMUnknownCPMUnknown< ICHLFileNameTable >CHLFileNameTable

Public Types

enum  { kDefaultIID = IID_ICHLFILENAMETABLE }
 

Public Member Functions

virtual void Install (const PMString &rPath)=0
 
virtual int32 GetEntriesCount () const =0
 
virtual const CHLFileNameDataGetNthEntry (int32 nIndex) const =0
 
virtual bool16 IsSpellingService (int32 nIndex) const =0
 
virtual bool16 IsHyphenationService (int32 nIndex) const =0
 
virtual bool16 IsThesaurusService (int32 nIndex) 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

From SDK sample; interface that encapsulates a name table that defines the data files on which the spelling service depends.

Member Function Documentation

virtual int32 ICHLFileNameTable::GetEntriesCount () const
pure virtual

Get the count of CHLFileNameData entries.

Returns
Count of CHLFileNameData entries

Implemented in CHLFileNameTable.

virtual const CHLFileNameData* ICHLFileNameTable::GetNthEntry (int32 nIndex) const
pure virtual

Get the CHLFileNameData entry for the specified index.

Parameters
nIndexIN the index of the entries.
Returns
CHLFileNameData associated with the index entry.

Implemented in CHLFileNameTable.

virtual void ICHLFileNameTable::Install (const PMStringrPath)
pure virtual

Populates an internal copy of the CHLFileNameTable and validates the dictionary paths. This is called from Install method of CHLSpellingMgr.

Parameters
rPathIt isn't being used by this sample.

Implemented in CHLFileNameTable.

virtual bool16 ICHLFileNameTable::IsHyphenationService (int32 nIndex) const
pure virtual

Checks whether the specified index is a hyphenation service.

Parameters
nIndexIN the index, it isn't used by this sample.
Returns
returns kTrue if it is.

Implemented in CHLFileNameTable.

virtual bool16 ICHLFileNameTable::IsSpellingService (int32 nIndex) const
pure virtual

Checks whether the specified index is a spelling service.

Parameters
nIndexIN the index, it isn't used by this sample.
Returns
returns kTrue if it is.

Implemented in CHLFileNameTable.

virtual bool16 ICHLFileNameTable::IsThesaurusService (int32 nIndex) const
pure virtual

Checks whether the specified index is a thesaurus service.

Parameters
nIndexIN the index, it isn't used by this sample.
Returns
returns kTrue if it is.

Implemented in CHLFileNameTable.