Sherlock::UserInterface Class Reference

Inheritance diagram for Sherlock::UserInterface:

Public Member Functions
void	checkAction (ActionType &action, int objNum, FixedTextActionId fixedTextActionId=kFixedTextAction_Invalid)
virtual void	reset ()
virtual void	drawInterface (int bufferNum=3)
virtual void	handleInput ()
virtual void	summonWindow (const Surface &bgSurface, bool slideUp=true)
virtual void	summonWindow (bool slideUp=true, int height=138)
virtual void	banishWindow (bool slideUp=true)
virtual void	clearInfo ()
virtual void	clearWindow ()

Static Public Member Functions
static UserInterface *	init (SherlockEngine *vm)

Public Attributes
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
Common::CustomEventType	_action
Common::CustomEventType	_oldAction
int	_selector
int	_oldSelector
int	_temp
int	_oldTemp
int	_temp1
int	_lookHelp

Protected Member Functions
	UserInterface (SherlockEngine *vm)

Protected Attributes
SherlockEngine *	_vm

Member Function Documentation

checkAction()

void Sherlock::UserInterface::checkAction	(	ActionType &	action,
		int	objNum,
		FixedTextActionId	fixedTextActionId = kFixedTextAction_Invalid
	)

Called for OPEN, CLOSE, and MOVE actions are being done

reset()

virtual void Sherlock::UserInterface::reset ( )

virtual

Resets the user interface

Reimplemented in Sherlock::Tattoo::TattooUserInterface, and Sherlock::Scalpel::ScalpelUserInterface.

drawInterface()

virtual void Sherlock::UserInterface::drawInterface ( int  bufferNum = 3 )

inlinevirtual

Draw the user interface onto the screen's back buffers

Reimplemented in Sherlock::Tattoo::TattooUserInterface, and Sherlock::Scalpel::ScalpelUserInterface.

handleInput()

virtual void Sherlock::UserInterface::handleInput ( )

inlinevirtual

Main input handler for the user interface

Reimplemented in Sherlock::Tattoo::TattooUserInterface, and Sherlock::Scalpel::ScalpelUserInterface.

summonWindow() [1/2]

virtual void Sherlock::UserInterface::summonWindow ( const Surface &  bgSurface, bool  slideUp = true  )

inlinevirtual

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

Reimplemented in Sherlock::Scalpel::ScalpelUserInterface.

summonWindow() [2/2]

virtual void Sherlock::UserInterface::summonWindow ( bool  slideUp = true, int  height = 138  )

inlinevirtual

Slide the window stored in the back buffer onto the screen

Reimplemented in Sherlock::Scalpel::ScalpelUserInterface.

banishWindow()

virtual void Sherlock::UserInterface::banishWindow ( bool  slideUp = true )

inlinevirtual

Close a currently open window

Parameters

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

Reimplemented in Sherlock::Tattoo::TattooUserInterface, and Sherlock::Scalpel::ScalpelUserInterface.

clearInfo()

virtual void Sherlock::UserInterface::clearInfo ( )

inlinevirtual

Clears the info line of the screen

Reimplemented in Sherlock::Scalpel::ScalpelUserInterface.

clearWindow()

virtual void Sherlock::UserInterface::clearWindow ( )

inlinevirtual

Clear any active text window

Reimplemented in Sherlock::Tattoo::TattooUserInterface, and Sherlock::Scalpel::ScalpelUserInterface.

---

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

• engines/sherlock/user_interface.h