InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UserDictWordList Class Reference

#include <UserDictWordList.h>

Public Member Functions

 UserDictWordList (const UserDictWordList &copy)
 
UserDictWordListoperator= (const UserDictWordList &other)
 
bool16 operator== (const UserDictWordList &other) const
 
bool16 operator!= (const UserDictWordList &other) const
 
const WideStringoperator[] (int32 i) const
 
void SetChunkSize (int32 chunk)
 
bool16 Preallocate (int32 newlen)
 
void clear ()
 
void Clear ()
 
void Remove (int32 at)
 
bool16 InsertUnique (const WideString &t)
 
int32 InsertUserDict (IUserDictService *pService, IUserDict *userDict, IUserDictIterator *dictIter, IUserDictService::WordType type)
 
int32 InsertScriptList (const ScriptListData &scriptWordList)
 
int32 ChunkSize () const
 
int32 Length () const
 
bool16 IsEmpty () const
 
const WideStringFirst () const
 
const WideStringLast () const
 
int32 ExactLocation (const WideString &t) const
 
int32 ExactLocation (const textchar *buffer, int32 length) const
 
int32 ExactLocation (const TextCharBuffer &wrapper) const
 
int32 Location (const WideString &t) const
 
int32 Location (const textchar *buffer, int32 length) const
 
int32 Location (const TextCharBuffer &wrapper) const
 
void ReadWrite (IPMStream *s)
 

Detailed Description

Sorted list of widestrings for use with user dictionaries.

Member Function Documentation

void UserDictWordList::clear ()

Clear list.

void UserDictWordList::Clear (void )
inline

Clear list.

int32 UserDictWordList::ExactLocation (const WideStringt) const

ExactLocation is for searching case-sensitive, and hyphen point matches.

Parameters
tstring to find
Returns
int32 returns location of string
int32 UserDictWordList::ExactLocation (const textchar * buffer,
int32 length 
) const
inline

ExactLocation is for searching case-sensitive, and hyphen point matches.

Parameters
bufferstring to find
lengthlength of string to find
Returns
int32 returns location of string
int32 UserDictWordList::ExactLocation (const TextCharBufferwrapper) const
inline

ExactLocation is for searching case-sensitive, and hyphen point matches.

Parameters
wrapperstring to find
Returns
int32 returns location of string
int32 UserDictWordList::InsertScriptList (const ScriptListData & scriptWordList)

Insert strings from script list data into list.

Returns
int32 returns number of words inserted into the list
bool16 UserDictWordList::InsertUnique (const WideStringt)

Insert string in list.

Returns
bool16 returns true if a word was inserted into the list
int32 UserDictWordList::InsertUserDict (IUserDictServicepService,
IUserDictuserDict,
IUserDictIteratordictIter,
IUserDictService::WordType type 
)

Insert strings from user dictionary into list.

Returns
int32 returns number of words inserted into the list
int32 UserDictWordList::Location (const WideStringt) const

Location is for searching case-insensitive, and hyphen points ignored matches.

Parameters
tstring to find
Returns
int32 returns location of string
int32 UserDictWordList::Location (const textchar * buffer,
int32 length 
) const
inline

Location is for searching case-insensitive, and hyphen points ignored matches.

Parameters
bufferstring to find
lengthlength of string to find
Returns
int32 returns location of string
int32 UserDictWordList::Location (const TextCharBufferwrapper) const
inline

Location is for searching case-insensitive, and hyphen points ignored matches.

Parameters
wrapperstring to find
Returns
int32 returns location of string
void UserDictWordList::Remove (int32 at)
inline

Remove string from list.

Parameters
atposition to remove