ScummVM API documentation
Stark::StaticLocationScreen Class Reference

#include <locationscreen.h>

Inheritance diagram for Stark::StaticLocationScreen:
Stark::SingleWindowScreen Stark::Screen Stark::Window Stark::DialogScreen Stark::DiaryIndexScreen Stark::DiaryPagesScreen Stark::FMVMenuScreen Stark::MainMenuScreen Stark::SaveLoadMenuScreen Stark::SettingsMenuScreen Stark::LoadMenuScreen Stark::SaveMenuScreen

Public Member Functions

 StaticLocationScreen (Gfx::Driver *gfx, Cursor *cursor, const char *locationName, Screen::Name screenName)
 
void open () override
 
void close () override
 
void onScreenChanged () override
 
void waitForSoundsToComplete ()
 
- Public Member Functions inherited from Stark::SingleWindowScreen
 SingleWindowScreen (Name name, Gfx::Driver *gfx, Cursor *cursor)
 
void handleGameLoop () override
 
void render () override
 
void handleMouseMove () override
 
void handleClick () override
 
void handleRightClick () override
 
void handleDoubleClick () override
 
- Public Member Functions inherited from Stark::Screen
 Screen (Name name)
 
Name getName () const
 
- Public Member Functions inherited from Stark::Window
 Window (Gfx::Driver *gfx, Cursor *cursor)
 
void handleMouseMove ()
 
void handleClick ()
 
void handleRightClick ()
 
void handleDoubleClick ()
 
void handleGameLoop ()
 
void render ()
 
bool isMouseInside () const
 
bool isVisible () const
 
Graphics::SurfacegetScreenshot () const
 

Protected Member Functions

void onMouseMove (const Common::Point &pos) override
 
void onClick (const Common::Point &pos) override
 
void onGameLoop () override
 
void onRender () override
 
- Protected Member Functions inherited from Stark::Window
virtual void onRightClick (const Common::Point &pos)
 
virtual void onDoubleClick (const Common::Point &pos)
 
Common::Point getRelativeMousePosition () const
 

Protected Attributes

Common::Array< StaticLocationWidget * > _widgets
 
- Protected Attributes inherited from Stark::Window
Gfx::Driver_gfx
 
Cursor_cursor
 
Common::Rect _position
 
bool _visible
 

Additional Inherited Members

- Public Types inherited from Stark::Screen
enum  Name {
  kScreenMainMenu, kScreenGame, kScreenFMV, kScreenDiaryIndex,
  kScreenSettingsMenu, kScreenSaveMenu, kScreenLoadMenu, kScreenFMVMenu,
  kScreenDiaryPages, kScreenDialog
}
 

Detailed Description

Abstract user interface screen using resources from a static Location sub-tree

Member Function Documentation

◆ open()

void Stark::StaticLocationScreen::open ( )
overridevirtual

The screen is being made active, prepare it to be drawn

Reimplemented from Stark::Screen.

Reimplemented in Stark::LoadMenuScreen, Stark::SaveMenuScreen, Stark::SettingsMenuScreen, Stark::SaveLoadMenuScreen, and Stark::MainMenuScreen.

◆ close()

void Stark::StaticLocationScreen::close ( )
overridevirtual

The screen is no longer active, release resources to free memory

Reimplemented from Stark::Screen.

Reimplemented in Stark::SettingsMenuScreen, and Stark::SaveLoadMenuScreen.

◆ onScreenChanged()

void Stark::StaticLocationScreen::onScreenChanged ( )
overridevirtual

Called when the screen resolution changes

Reimplemented from Stark::Screen.

◆ waitForSoundsToComplete()

void Stark::StaticLocationScreen::waitForSoundsToComplete ( )

Wait for all effect sounds to complete

Used to ensure the button press sounds are no longer playing before performing the next action that would produce a sound.


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