ScummVM API documentation
MM::Xeen::ButtonContainer Class Reference
Inheritance diagram for MM::Xeen::ButtonContainer:
MM::Xeen::Cutscenes MM::Xeen::Awards MM::Xeen::CantCast MM::Xeen::CastSpell MM::Xeen::CharacterInfo MM::Xeen::Choose123 MM::Xeen::Confirm MM::Xeen::ControlPanel MM::Xeen::CreateCharacterDialog MM::Xeen::CreditsScreen MM::Xeen::DetectMonsters MM::Xeen::DifficultyDialog MM::Xeen::Dismiss MM::Xeen::ExchangeDialog MM::Xeen::HowMuch MM::Xeen::IdentifyMonster MM::Xeen::InfoDialog MM::Xeen::Input MM::Xeen::Interface MM::Xeen::ItemsDialog MM::Xeen::ItemSelectionDialog MM::Xeen::LloydsBeacon MM::Xeen::Locations::BaseLocation MM::Xeen::MapDialog MM::Xeen::MessageDialog MM::Xeen::NotWhileEngaged MM::Xeen::PartyDialog MM::Xeen::Quests MM::Xeen::QuickFight MM::Xeen::QuickReferenceDialog MM::Xeen::SelectElement MM::Xeen::SettingsBaseDialog MM::Xeen::SpellOnWho MM::Xeen::SpellsDialog MM::Xeen::SwordsOfXeen::MainMenu MM::Xeen::Teleport MM::Xeen::TownPortal MM::Xeen::WhoWill MM::Xeen::WorldOfXeen::MenuContainerDialog MM::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::Path &name)
 
void loadStrings (const Common::Path &name, int ccMode)
 
void setWaitBounds ()
 
- Protected Member Functions inherited from MM::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 MM::Xeen::Cutscenes
XeenEngine_vm
 

Member Function Documentation

◆ doScroll()

bool MM::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 MM::Xeen::Cutscenes.

◆ loadStrings() [1/2]

void MM::Xeen::ButtonContainer::loadStrings ( const Common::Path name)
protected

Load a set of text strings from the given resource

Parameters
nameName of resource containing strings

◆ loadStrings() [2/2]

void MM::Xeen::ButtonContainer::loadStrings ( const Common::Path 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 MM::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 MM::Xeen::ButtonContainer::saveButtons ( )

Saves the current list of buttons

◆ drawButtons()

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

Draws the buttons onto the passed surface

◆ clearEvents()

void MM::Xeen::ButtonContainer::clearEvents ( )
inline

Clears any currently set button value


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