ScummVM API documentation
Xeen::ButtonContainer Class Reference
Inheritance diagram for Xeen::ButtonContainer:
Xeen::Cutscenes Xeen::Awards Xeen::CantCast Xeen::CastSpell Xeen::CharacterInfo Xeen::Choose123 Xeen::Confirm Xeen::ControlPanel Xeen::CreateCharacterDialog Xeen::CreditsScreen Xeen::DetectMonsters Xeen::DifficultyDialog Xeen::Dismiss Xeen::ExchangeDialog Xeen::HowMuch Xeen::IdentifyMonster Xeen::InfoDialog Xeen::Input Xeen::Interface Xeen::ItemsDialog Xeen::ItemSelectionDialog Xeen::LloydsBeacon Xeen::Locations::BaseLocation Xeen::MapDialog Xeen::MessageDialog Xeen::NotWhileEngaged Xeen::PartyDialog Xeen::Quests Xeen::QuickFight Xeen::QuickReferenceDialog Xeen::SelectElement Xeen::SettingsBaseDialog Xeen::SpellOnWho Xeen::SpellsDialog Xeen::SwordsOfXeen::MainMenu Xeen::Teleport Xeen::TownPortal Xeen::WhoWill Xeen::WorldOfXeen::MenuContainerDialog Xeen::YesNo

Public Member Functions

 ButtonContainer (XeenEngine *vm)
 
void saveButtons ()
 
void clearButtons ()
 
void restoreButtons ()
 
void addButton (const Common::Rect &bounds, int val, SpriteResource *sprites=nullptr)
 
void addButton (const Common::Rect &bounds, int val, int frameNum, SpriteResource *sprites=nullptr)
 
void addPartyButtons (XeenEngine *vm)
 
void drawButtons (XSurface *surface)
 
void clearEvents ()
 

Protected Member Functions

bool checkEvents (XeenEngine *vm)
 
bool doScroll (bool rollUp, bool fadeIn) override
 
void loadStrings (const Common::String &name)
 
void loadStrings (const Common::String &name, int ccMode)
 
void setWaitBounds ()
 
- Protected Member Functions inherited from Xeen::Cutscenes
 Cutscenes (XeenEngine *vm)
 
uint getSpeakingFrame (uint minFrame, uint maxFrame)
 

Protected Attributes

Common::Array< UIButton_buttons
 
Common::StringArray _textStrings
 
Common::Rect _waitBounds
 
int _buttonValue
 
- Protected Attributes inherited from Xeen::Cutscenes
XeenEngine_vm
 

Member Function Documentation

◆ doScroll()

bool Xeen::ButtonContainer::doScroll ( bool  rollUp,
bool  fadeIn 
)
overrideprotectedvirtual

Draws the scroll in the background

Parameters
rollUpIf true, rolls up the scroll. If false, unrolls.
fadeInIf true, does an initial fade in
Returns
True if key or mouse pressed

Reimplemented from Xeen::Cutscenes.

◆ loadStrings() [1/2]

void Xeen::ButtonContainer::loadStrings ( const Common::String name)
protected

Load a set of text strings from the given resource

Parameters
nameName of resource containing strings

◆ loadStrings() [2/2]

void Xeen::ButtonContainer::loadStrings ( const Common::String name,
int  ccMode 
)
protected

Load a set of text strings from the given resource

Parameters
nameName of resource containing strings
ccModeOptional cc file number to explicitly use

◆ setWaitBounds()

void Xeen::ButtonContainer::setWaitBounds ( )
protected

Sets the wait bounds, the area where clicking with the mouse generates the equivalent of a space bar press, to the main interface area

◆ saveButtons()

void Xeen::ButtonContainer::saveButtons ( )

Saves the current list of buttons

◆ drawButtons()

void Xeen::ButtonContainer::drawButtons ( XSurface surface)

Draws the buttons onto the passed surface

◆ clearEvents()

void Xeen::ButtonContainer::clearEvents ( )
inline

Clears any currently set button value


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