ScummVM API documentation
Gob::GCTFile Class Reference
Inheritance diagram for Gob::GCTFile:
Gob::BackBuffer

Public Member Functions

 GCTFile (Common::SeekableReadStream &gct, Common::RandomSource &rnd)
 
uint16 getLineCount (uint item) const
 
void setArea (int16 left, int16 top, int16 right, int16 bottom)
 
void selectLine (uint item, uint16 line)
 
void setText (uint item, uint16 line, const Common::String &text)
 
void setText (uint item, const Common::String &text)
 
void reset ()
 
bool clear (Surface &dest, int16 &left, int16 &top, int16 &right, int16 &bottom)
 
bool fill (Surface &dest, uint8 color, int16 &left, int16 &top, int16 &right, int16 &bottom)
 
bool draw (Surface &dest, uint16 item, const Font &font, uint8 color, int16 &left, int16 &top, int16 &right, int16 &bottom)
 
bool finished () const
 

Static Public Attributes

static const uint16 kSelectorAll = 0xFFFE
 Print all lines.
 
static const uint16 kSelectorRandom = 0xFFFF
 Print a random line.
 

Additional Inherited Members

- Protected Member Functions inherited from Gob::BackBuffer
void trashBuffer ()
 
void resizeBuffer (uint16 width, uint16 height)
 
bool saveScreen (const Surface &dest, int16 &left, int16 &top, int16 &right, int16 &bottom)
 
bool restoreScreen (Surface &dest, int16 &left, int16 &top, int16 &right, int16 &bottom)
 
bool hasBuffer () const
 
bool hasSavedBackground () const
 

Member Function Documentation

◆ getLineCount()

uint16 Gob::GCTFile::getLineCount ( uint  item) const

Return the number of lines in an item.

◆ setArea()

void Gob::GCTFile::setArea ( int16  left,
int16  top,
int16  right,
int16  bottom 
)

Set the area the text will be printed in.

◆ selectLine()

void Gob::GCTFile::selectLine ( uint  item,
uint16  line 
)

Set which line of this item should be printed.

◆ setText() [1/2]

void Gob::GCTFile::setText ( uint  item,
uint16  line,
const Common::String text 
)

Change the text of an items' line.

◆ setText() [2/2]

void Gob::GCTFile::setText ( uint  item,
const Common::String text 
)

Change the item into one one line and set that line's text.

◆ reset()

void Gob::GCTFile::reset ( )

Reset the item drawing state.

◆ clear()

bool Gob::GCTFile::clear ( Surface dest,
int16 &  left,
int16 &  top,
int16 &  right,
int16 &  bottom 
)

Clear the drawn text, restoring the original content.

◆ fill()

bool Gob::GCTFile::fill ( Surface dest,
uint8  color,
int16 &  left,
int16 &  top,
int16 &  right,
int16 &  bottom 
)

Fill the text area with a color.

◆ draw()

bool Gob::GCTFile::draw ( Surface dest,
uint16  item,
const Font font,
uint8  color,
int16 &  left,
int16 &  top,
int16 &  right,
int16 &  bottom 
)

Draw an item onto the surface, until all text has been drawn or the area is filled.

◆ finished()

bool Gob::GCTFile::finished ( ) const

Did we draw all text?


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