ScummVM API documentation
Titanic::TTword Class Reference
Inheritance diagram for Titanic::TTword:
Titanic::TTmajorWord Titanic::TTaction Titanic::TTadj Titanic::TTpicture Titanic::TTpronoun

Public Member Functions

 TTword (const TTstring &str, WordClass wordClass, int val2)
 
 TTword (const TTword *src)
 
void deleteSiblings ()
 
int readSyn (SimpleFile *file)
 
void setSyn (TTsynonym *synP)
 
int setSynStr (TTstring &str)
 
bool hasSynonyms () const
 
void appendNode (TTsynonym *node)
 
int load (SimpleFile *file, WordClass wordClass)
 
bool findSynByName (const TTstring &str, TTsynonym *dest, VocabMode mode) const
 
const char * c_str () const
 
 operator const char * () const
 
const TTstring getText ()
 
bool compareTo (const char *str) const
 
bool compareTo (TTstring *str) const
 
TTstringStatus getStatus () const
 
bool isValid () const
 
TTstringStatus getChainStatus () const
 
bool isClass (WordClass wordClass) const
 
TTwordcopyWords ()
 
virtual TTwordcopy () const
 
virtual bool proc2 (int val) const
 
virtual int proc3 () const
 
virtual void proc4 ()
 
virtual void proc5 ()
 
virtual bool checkTag () const
 
virtual bool compareTagTo (uint tag) const
 
virtual uint getTag () const
 
virtual bool proc9 (int val) const
 
virtual int proc10 () const
 
virtual void proc11 ()
 
virtual bool proc12 (int val) const
 
virtual int proc13 () const
 
virtual bool proc14 (int val) const
 
virtual int proc15 () const
 
virtual bool proc16 () const
 
virtual bool proc17 () const
 
virtual bool proc18 () const
 
virtual bool comparePronounTo (int val) const
 
virtual int proc20 () const
 
virtual FileHandle getSynFile () const
 
virtual bool checkSynFile (FileHandle file) const
 
virtual void setSynFile (FileHandle file)
 
virtual int save (SimpleFile *file) const
 

Public Attributes

TTword_nextP
 
TTsynonym_synP
 
TTstring _text
 
WordClass _wordClass
 
int _id
 
uint _tag
 

Protected Member Functions

uint readNumber (const char *str)
 
bool testFileHandle (SimpleFile *file) const
 
bool testFileHandle (FileHandle resHandle) const
 

Protected Attributes

TTstringStatus _status
 
int _field24
 
int _field28
 

Member Function Documentation

◆ readNumber()

uint Titanic::TTword::readNumber ( const char *  str)
protected

Read in a number

◆ deleteSiblings()

void Titanic::TTword::deleteSiblings ( )

Delete any following words chained to the word

◆ readSyn()

int Titanic::TTword::readSyn ( SimpleFile file)

Read in a synonym for the given word

◆ setSyn()

void Titanic::TTword::setSyn ( TTsynonym synP)

Set a new synonym for the word

◆ setSynStr()

int Titanic::TTword::setSynStr ( TTstring str)

Set a new synonym string

◆ hasSynonyms()

bool Titanic::TTword::hasSynonyms ( ) const
inline

Returns true if synonyms have been set for the word

◆ appendNode()

void Titanic::TTword::appendNode ( TTsynonym node)

Either sets the first synonym for a word, or adds it to an existing one

◆ load()

int Titanic::TTword::load ( SimpleFile file,
WordClass  wordClass 
)

Load the word

◆ findSynByName()

bool Titanic::TTword::findSynByName ( const TTstring str,
TTsynonym dest,
VocabMode  mode 
) const

Finds a synonym in the word by name, if one exists

Parameters
strName to search for
destDestination synonym instance to copy match into
modeSpecifies English or German vocab mode
Returns
Returns true if a match was found

◆ getText()

const TTstring Titanic::TTword::getText ( )
inline

Return the text of the word

◆ compareTo() [1/2]

bool Titanic::TTword::compareTo ( const char *  str) const

Compares the word's text to a passed string

◆ compareTo() [2/2]

bool Titanic::TTword::compareTo ( TTstring str) const
inline

Compares the word's text to a passed string

◆ getStatus()

TTstringStatus Titanic::TTword::getStatus ( ) const
inline

Return the status of the word

◆ isValid()

bool Titanic::TTword::isValid ( ) const
inline

Returns true if the word is in a valid state

◆ getChainStatus()

TTstringStatus Titanic::TTword::getChainStatus ( ) const

Return the status of the entire word chain

◆ isClass()

bool Titanic::TTword::isClass ( WordClass  wordClass) const
inline

Returns true if the word is of the specified class

◆ copyWords()

TTword* Titanic::TTword::copyWords ( )

Copy the word and any attached to it

◆ copy()

virtual TTword* Titanic::TTword::copy ( ) const
virtual

Creates a copy of the word

Reimplemented in Titanic::TTaction, Titanic::TTpicture, Titanic::TTadj, Titanic::TTpronoun, and Titanic::TTmajorWord.

◆ checkTag()

virtual bool Titanic::TTword::checkTag ( ) const
inlinevirtual

Checks whether the word's tag is a known type

Reimplemented in Titanic::TTpicture.

◆ compareTagTo()

virtual bool Titanic::TTword::compareTagTo ( uint  tag) const
inlinevirtual

Compare the word's tag to a given tag value

Reimplemented in Titanic::TTpicture.

◆ getTag()

virtual uint Titanic::TTword::getTag ( ) const
inlinevirtual

Return the tag associated with the word

Reimplemented in Titanic::TTpicture.

◆ getSynFile()

virtual FileHandle Titanic::TTword::getSynFile ( ) const
virtual

Returns the file associated with the word's first synonym

◆ checkSynFile()

virtual bool Titanic::TTword::checkSynFile ( FileHandle  file) const
virtual

Checks whether the file associated with the word's first synonym matches the specified file

◆ setSynFile()

virtual void Titanic::TTword::setSynFile ( FileHandle  file)
virtual

Sets the file associated with a synonym

◆ save()

virtual int Titanic::TTword::save ( SimpleFile file) const
inlinevirtual

Dumps data associated with the word to file

Reimplemented in Titanic::TTadj, and Titanic::TTpronoun.


The documentation for this class was generated from the following file: