ScummVM API documentation
Bagel::CBofStringTable Class Reference
Inheritance diagram for Bagel::CBofStringTable:
Bagel::CBofFile Bagel::CBofObject Bagel::CBofError

Public Member Functions

 CBofStringTable (const char *pszFileName)
 
virtual ~CBofStringTable ()
 
const char * getString (int nId)
 
- Public Member Functions inherited from Bagel::CBofFile
 CBofFile ()
 
 CBofFile (const char *pszFileName, uint32 lFlags=(0x00000002|0x00000004))
 
virtual ~CBofFile ()
 
ErrorCode open (const char *pszFileName, uint32 lFlags=(0x00000002|0x00000004))
 
ErrorCode create (const char *pszFileName, uint32 lFlags=(0x00000002|0x00000004)|0x00000020)
 
virtual ErrorCode close ()
 
virtual ErrorCode read (void *pDestBuf, int32 lBytes)
 
virtual ErrorCode write (const void *pSrcBuf, int32 lBytes)
 
void commit ()
 
ErrorCode seek (uint32 lPos)
 
ErrorCode seekToBeginning ()
 
ErrorCode seekToEnd ()
 
ErrorCode setPosition (uint32 lPos)
 
uint32 getPosition ()
 
uint32 getLength ()
 
 operator Common::SeekableReadStream * () const
 
- Public Member Functions inherited from Bagel::CBofError
void reportError (ErrorCode errCode, const char *format,...)
 
bool errorOccurred () const
 
ErrorCode getErrorCode () const
 
void clearError ()
 

Protected Member Functions

ErrorCode load (const char *pszFileName)
 
void release ()
 
ErrorCode buildTable ()
 
void killTable ()
 
- Protected Member Functions inherited from Bagel::CBofError
virtual void bofMessageBox (const Common::String &content, const Common::String &title)
 

Additional Inherited Members

- Static Public Member Functions inherited from Bagel::CBofObject
static bool isValidObject (const CBofObject *pObject)
 
- Static Public Member Functions inherited from Bagel::CBofError
static void fatalError (ErrorCode errCode, const char *format,...)
 
static void initialize ()
 
static int getErrorCount ()
 
- Protected Attributes inherited from Bagel::CBofFile
char _szFileName [MAX_FNAME]
 
Common::Stream_stream = nullptr
 
uint32 _lFlags = ( 0x00000002 | 0x00000004 )
 
- Protected Attributes inherited from Bagel::CBofError
ErrorCode _errCode
 
- Static Protected Attributes inherited from Bagel::CBofError
static int _count
 

Constructor & Destructor Documentation

◆ CBofStringTable()

Bagel::CBofStringTable::CBofStringTable ( const char *  pszFileName)

Constructor for Boffo Resource String Table

Parameters
pszFileNameName of file containing resources

◆ ~CBofStringTable()

virtual Bagel::CBofStringTable::~CBofStringTable ( )
virtual

Destructor

Member Function Documentation

◆ load()

ErrorCode Bagel::CBofStringTable::load ( const char *  pszFileName)
protected

Loads string table from specified res file

Parameters
pszFileNameName of file containing resources
Returns
Error return code

◆ release()

void Bagel::CBofStringTable::release ( )
protected

De-allocates the current Resource String Table

◆ buildTable()

ErrorCode Bagel::CBofStringTable::buildTable ( )
protected

Allocates the current Resource String Table

Returns
Error return code

◆ killTable()

void Bagel::CBofStringTable::killTable ( )
protected

De-allocates the current Resource String Table

◆ getString()

const char* Bagel::CBofStringTable::getString ( int  nId)

Retrieves the specified resource string

Parameters
nIdRes ID for string to be retrieved

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