InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CHLFileNameTable Class Reference
Inheritance diagram for CHLFileNameTable:
CPMUnknown< ICHLFileNameTable >ICHLFileNameTableIPMUnknown

Public Member Functions

 CHLFileNameTable (IPMUnknown *boss)
 
virtual void Install (const PMString &rPath)
 
virtual int32 GetEntriesCount () const
 
virtual const CHLFileNameDataGetNthEntry (int32 nIndex) const
 
virtual bool16 IsSpellingService (int32 nIndex) const
 
virtual bool16 IsHyphenationService (int32 nIndex) const
 
virtual bool16 IsThesaurusService (int32 nIndex) const
 
- Public Member Functions inherited from CPMUnknown< ICHLFileNameTable >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Public Types inherited from ICHLFileNameTable
enum  { kDefaultIID = IID_ICHLFILENAMETABLE }
 
- Protected Member Functions inherited from CPMUnknown< ICHLFileNameTable >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< ICHLFileNameTable >
HelperInterface fHelperInterface
 

Detailed Description

Provides a convenient way of encapsulating a table that defines the data files on which the spelling service depends. The table stored here defines the set of the dictionaries, etc. that you need. At run time you can go and check that these files are present. For example, if you offer a Hungarian spelling service but can't find your Hungarian dictionary then you can complain and not install your Hungarian spelling service. The interface is typically used by the spelling, hyphenation and dictionary manager interfaces.

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * CHLFileNameTable::CHLFileNameTable (IPMUnknownboss)

Constructor.

Parameters
bossinterface ptr from boss object on which this interface is aggregated.

Member Function Documentation

int32 CHLFileNameTable::GetEntriesCount () const
virtual

Get the count of CHLFileNameData entries.

Returns
Count of CHLFileNameData entries

Implements ICHLFileNameTable.

const CHLFileNameData * CHLFileNameTable::GetNthEntry (int32 nIndex) const
virtual

Get the CHLFileNameData for the specified index in the table.

Parameters
nIndexIN the index in the table.
Returns
the CHLFileNameData associated with nInDex.

Implements ICHLFileNameTable.

void CHLFileNameTable::Install (const PMStringrPath)
virtual

It is called from Install method of CHLSpellingMgr.

Parameters
rPathIt isn't being used by this sample.

install ICU languages

Implements ICHLFileNameTable.

bool16 CHLFileNameTable::IsHyphenationService (int32 nIndex) const
virtual

Tests whether nIndex entry is a hyphenation service.

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

Implements ICHLFileNameTable.

bool16 CHLFileNameTable::IsSpellingService (int32 nIndex) const
virtual

Tests whether nIndex entry is a spelling service.

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

Implements ICHLFileNameTable.

bool16 CHLFileNameTable::IsThesaurusService (int32 nIndex) const
virtual

Tests whether nIndex entry is a thesaurus service.

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

Implements ICHLFileNameTable.