Sherlock::Scalpel::ScalpelUserInterface Class Reference

Inheritance diagram for Sherlock::Scalpel::ScalpelUserInterface:

Public Member Functions
	ScalpelUserInterface (SherlockEngine *vm)
void	whileMenuCounter ()
void	restoreButton (int num)
void	examine ()
Common::Point	getTopLeftButtonPoint (int num) const
Common::Rect	getButtonRect (int buttonNr) const
int	infoLineHeight () const
int	infoLineYOffset () const
void	reset () override
void	handleInput () override
void	drawInterface (int bufferNum=3) override
void	summonWindow (const Surface &bgSurface, bool slideUp=true) override
void	summonWindow (bool slideUp=true, int height=CONTROLS_Y) override
void	banishWindow (bool slideUp=true) override
void	clearInfo () override
void	clearWindow () override
virtual void	printObjectDesc ()
Public Member Functions inherited from Sherlock::UserInterface
void	checkAction (ActionType &action, int objNum, FixedTextActionId fixedTextActionId=kFixedTextAction_Invalid)

Public Attributes
ImageFile *	_controlPanel
ImageFile *	_controls
int	_oldUse
byte	_hotkeyLook
byte	_hotkeyMove
byte	_hotkeyTalk
byte	_hotkeyPickUp
byte	_hotkeyOpen
byte	_hotkeyClose
byte	_hotkeyInventory
byte	_hotkeyUse
byte	_hotkeyGive
byte	_hotkeyJournal
byte	_hotkeyFiles
byte	_hotkeySetUp
byte	_hotkeyLoadGame
byte	_hotkeySaveGame
byte	_hotkeysIndexed [14]
Public Attributes inherited from Sherlock::UserInterface
MenuMode	_menuMode
int	_menuCounter
bool	_infoFlag
bool	_windowOpen
bool	_endKeyActive
int	_invLookFlag
bool	_slideWindows
bool	_helpStyle
Common::Rect	_windowBounds
bool	_lookScriptFlag
int	_bgFound
int	_oldBgFound
int	_exitZone
signed char	_key
signed char	_oldKey
int	_selector
int	_oldSelector
int	_temp
int	_oldTemp
int	_temp1
int	_lookHelp

Additional Inherited Members
Static Public Member Functions inherited from Sherlock::UserInterface
static UserInterface *	init (SherlockEngine *vm)
Protected Member Functions inherited from Sherlock::UserInterface
	UserInterface (SherlockEngine *vm)
Protected Attributes inherited from Sherlock::UserInterface
SherlockEngine *	_vm

Member Function Documentation

whileMenuCounter()

void Sherlock::Scalpel::ScalpelUserInterface::whileMenuCounter

(

)

Handles counting down whilst checking for input, then clears the info line.

restoreButton()

void Sherlock::Scalpel::ScalpelUserInterface::restoreButton

(

int

num

)

Draws the image for the given user interface button in the up (not selected) position

examine()

void Sherlock::Scalpel::ScalpelUserInterface::examine

(

)

Creates a text window and uses it to display the in-depth description of the highlighted object

reset()

void Sherlock::Scalpel::ScalpelUserInterface::reset ( )

overridevirtual

Resets the user interface

Reimplemented from Sherlock::UserInterface.

handleInput()

void Sherlock::Scalpel::ScalpelUserInterface::handleInput ( )

overridevirtual

Main input handler for the user interface

Reimplemented from Sherlock::UserInterface.

drawInterface()

void Sherlock::Scalpel::ScalpelUserInterface::drawInterface ( int  bufferNum = 3 )

overridevirtual

Draw the user interface onto the screen's back buffers

Reimplemented from Sherlock::UserInterface.

summonWindow() [1/2]

void Sherlock::Scalpel::ScalpelUserInterface::summonWindow ( const Surface &  bgSurface, bool  slideUp = true  )

overridevirtual

Displays a passed window by gradually scrolling it vertically on-screen

Reimplemented from Sherlock::UserInterface.

summonWindow() [2/2]

void Sherlock::Scalpel::ScalpelUserInterface::summonWindow ( bool  slideUp = true, int  height = CONTROLS_Y  )

overridevirtual

Slide the window stored in the back buffer onto the screen

Reimplemented from Sherlock::UserInterface.

banishWindow()

void Sherlock::Scalpel::ScalpelUserInterface::banishWindow ( bool  slideUp = true )

overridevirtual

Close a currently open window

Parameters

flag	0 = slide old window down, 1 = slide prior UI back up

Reimplemented from Sherlock::UserInterface.

clearInfo()

void Sherlock::Scalpel::ScalpelUserInterface::clearInfo ( )

overridevirtual

Clears the info line of the screen

Reimplemented from Sherlock::UserInterface.

clearWindow()

void Sherlock::Scalpel::ScalpelUserInterface::clearWindow ( )

overridevirtual

Clear any active text window

Reimplemented from Sherlock::UserInterface.

printObjectDesc()

virtual void Sherlock::Scalpel::ScalpelUserInterface::printObjectDesc ( )

virtual

Print the previously selected object's decription

---

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

• engines/sherlock/scalpel/scalpel_user_interface.h