MM::MM1::ViewsEnh::ScrollView Class Reference

Inheritance diagram for MM::MM1::ViewsEnh::ScrollView:

Public Member Functions
	ScrollView (const Common::String &name)
	ScrollView (const Common::String &name, UIElement *owner)
void	clearButtons ()
int	addButton (Shared::Xeen::SpriteResource *sprites, const Common::Point &pos, int frame, const Common::KeyState &key, bool halfSize=false)
int	addButton (Shared::Xeen::SpriteResource *sprites, const Common::Point &pos, int frame, KeybindingAction action, bool halfSize=false)
int	addButton (const Common::Rect &r, const Common::KeyState &key)
int	addButton (const Common::Rect &r, KeybindingAction action)
void	setButtonEnabled (int buttonNum, bool enabled)
bool	isButtonEnabled (int buttonNum) const
void	setButtonPos (int buttonNum, const Common::Point &pos)
void	removeButtons (int start, int end=-2)
void	resetSelectedButton ()
void	draw () override
bool	msgFocus (const FocusMessage &msg) override
bool	msgMouseDown (const MouseDownMessage &msg) override
bool	msgMouseUp (const MouseUpMessage &msg) override
Public Member Functions inherited from MM::MM1::ViewsEnh::TextView
	TextView (const Common::String &name)
	TextView (const Common::String &name, UIElement *owner)
void	setReduced (bool flag)
Public Member Functions inherited from MM::MM1::UIElement
	UIElement (const Common::String &name, UIElement *uiParent)
bool	needsRedraw () const
void	redraw ()
void	focus ()
virtual void	close ()
bool	isFocused () const
void	replaceView (UIElement *ui, bool replaceAllViews=false)
void	replaceView (const Common::String &name, bool replaceAllViews=false)
void	addView (UIElement *ui)
void	addView (const Common::String &name)
void	addView ()
void	open ()
int	getRandomNumber (int minNumber, int maxNumber)
int	getRandomNumber (int maxNumber)
Common::String	getName () const
virtual void	setBounds (const Common::Rect &r)
Common::Rect	getBounds () const
Graphics::ManagedSurface	getSurface () const
virtual bool	tick ()
virtual UIElement *	findView (const Common::String &name)
bool	send (const Common::String &viewName, const FocusMessage &msg)
bool	send (const FocusMessage &msg)
bool	send (const Common::String &viewName, const UnfocusMessage &msg)
bool	send (const UnfocusMessage &msg)
bool	send (const Common::String &viewName, const KeypressMessage &msg)
bool	send (const KeypressMessage &msg)
bool	send (const Common::String &viewName, const MouseDownMessage &msg)
bool	send (const MouseDownMessage &msg)
bool	send (const Common::String &viewName, const MouseUpMessage &msg)
bool	send (const MouseUpMessage &msg)
bool	send (const Common::String &viewName, const ActionMessage &msg)
bool	send (const ActionMessage &msg)
bool	send (const Common::String &viewName, const GameMessage &msg)
bool	send (const GameMessage &msg)
bool	send (const Common::String &viewName, const HeaderMessage &msg)
bool	send (const HeaderMessage &msg)
bool	send (const Common::String &viewName, const InfoMessage &msg)
bool	send (const InfoMessage &msg)
bool	send (const Common::String &viewName, const DrawGraphicMessage &msg)
bool	send (const DrawGraphicMessage &msg)

Protected Member Functions
void	frame ()
void	fill ()
void	writeSymbol (int symbolId)
int	getButtonAt (const Common::Point &pos)
size_t	getButtonCount () const
void	drawButtons ()
Protected Member Functions inherited from MM::MM1::ViewsEnh::TextView
byte	setTextColor (byte col)
void	writeChar (unsigned char c)
void	writeChar (int x, int y, unsigned char c)
void	writeString (const Common::String &str, TextAlign align=ALIGN_LEFT)
void	writeString (int x, int y, const Common::String &str, TextAlign align=ALIGN_LEFT)
void	writeNumber (int val)
void	writeNumber (int x, int y, int val)
void	writeLine (int lineNum, const Common::String &str, TextAlign align=ALIGN_LEFT, int xp=0)
size_t	getStringWidth (const Common::String &str)
void	newLine ()
Common::StringArray	splitLines (const Common::String &str, int firstLineWidth=-1)
void	clearSurface () override
void	drawGraphic (int gfxNum)
Protected Member Functions inherited from MM::MM1::UIElement
Common::Rect	getLineBounds (int line1, int line2) const
void	delaySeconds (uint seconds)
void	delayFrames (uint frames)
bool	isDelayActive () const
void	cancelDelay ()
bool	endDelay ()
virtual void	timeout ()
virtual bool	msgUnfocus (const UnfocusMessage &e)
virtual bool	msgKeypress (const KeypressMessage &e)
virtual bool	msgAction (const ActionMessage &e)
virtual bool	msgGame (const GameMessage &e)
virtual bool	msgHeader (const HeaderMessage &e)
virtual bool	msgInfo (const InfoMessage &e)
virtual bool	msgDrawGraphic (const DrawGraphicMessage &e)

Protected Attributes
Common::Point	_symbolPos
Protected Attributes inherited from MM::MM1::ViewsEnh::TextView
Common::Point	_textPos
int	_colorsNum = 0
bool	_fontReduced = false
Protected Attributes inherited from MM::MM1::UIElement
UIElement *	_parent
Common::Array< UIElement * >	_children
Common::Rect	_innerBounds
Bounds	_bounds
bool	_needsRedraw = true
Common::String	_name

Member Function Documentation

frame()

void MM::MM1::ViewsEnh::ScrollView::frame ( )

protected

Draw the scroll frame

fill()

void MM::MM1::ViewsEnh::ScrollView::fill ( )

protected

Fill the scroll background

writeSymbol()

void MM::MM1::ViewsEnh::ScrollView::writeSymbol ( int  symbolId )

protected

Draw a special symbol

getButtonAt()

int MM::MM1::ViewsEnh::ScrollView::getButtonAt ( const Common::Point &  pos )

protected

Get the button at the given position

getButtonCount()

size_t MM::MM1::ViewsEnh::ScrollView::getButtonCount ( ) const

inlineprotected

Return the number of buttons

drawButtons()

void MM::MM1::ViewsEnh::ScrollView::drawButtons ( )

protected

Draws the buttons

clearButtons()

void MM::MM1::ViewsEnh::ScrollView::clearButtons ( )

inline

Clear the buttons list

addButton() [1/4]

int MM::MM1::ViewsEnh::ScrollView::addButton	(	Shared::Xeen::SpriteResource *	sprites,
		const Common::Point &	pos,
		int	frame,
		const Common::KeyState &	key,
		bool	halfSize = false
	)

Add a button for display

addButton() [2/4]

int MM::MM1::ViewsEnh::ScrollView::addButton	(	Shared::Xeen::SpriteResource *	sprites,
		const Common::Point &	pos,
		int	frame,
		KeybindingAction	action,
		bool	halfSize = false
	)

Add a button for display

addButton() [3/4]

int MM::MM1::ViewsEnh::ScrollView::addButton	(	const Common::Rect &	r,
		const Common::KeyState &	key
	)

Add a button for display

addButton() [4/4]

int MM::MM1::ViewsEnh::ScrollView::addButton	(	const Common::Rect &	r,
		KeybindingAction	action
	)

Add a button for display

setButtonEnabled()

void MM::MM1::ViewsEnh::ScrollView::setButtonEnabled ( int  buttonNum, bool  enabled  )

inline

Set a button's enablement

isButtonEnabled()

bool MM::MM1::ViewsEnh::ScrollView::isButtonEnabled ( int  buttonNum ) const

inline

Return true if a button is enabled

setButtonPos()

void MM::MM1::ViewsEnh::ScrollView::setButtonPos ( int  buttonNum, const Common::Point &  pos  )

inline

Set a button's position

removeButtons()

void MM::MM1::ViewsEnh::ScrollView::removeButtons	(	int	start,
		int	end = -2
	)

Delete buttons

resetSelectedButton()

void MM::MM1::ViewsEnh::ScrollView::resetSelectedButton

(

)

Reset selected button

draw()

void MM::MM1::ViewsEnh::ScrollView::draw ( )

overridevirtual

Draw the view

Reimplemented from MM::MM1::UIElement.

Reimplemented in MM::MM1::ViewsEnh::Search, MM::MM1::ViewsEnh::Spells::CastSpell, MM::MM1::ViewsEnh::Spells::Spellbook, MM::MM1::ViewsEnh::Spells::Teleport, MM::MM1::ViewsEnh::Trade, MM::MM1::ViewsEnh::YesNo, MM::MM1::ViewsEnh::Spells::Fly, MM::MM1::ViewsEnh::WhoWillTry, MM::MM1::ViewsEnh::SelectNumberSubview, MM::MM1::ViewsEnh::Trap, MM::MM1::ViewsEnh::Unlock, MM::MM1::ViewsEnh::WhichCharacter, MM::MM1::ViewsEnh::Spells::DetectMagic, MM::MM1::ViewsEnh::WhichItem, MM::MM1::ViewsEnh::Spells::Location, MM::MM1::ViewsEnh::WheelSpin, and MM::MM1::ViewsEnh::WonGame.

msgFocus()

bool MM::MM1::ViewsEnh::ScrollView::msgFocus ( const FocusMessage &  msg )

overridevirtual

View is focused

Reimplemented from MM::MM1::UIElement.

Reimplemented in MM::MM1::ViewsEnh::Search, MM::MM1::ViewsEnh::Trade, MM::MM1::ViewsEnh::Spells::Teleport, MM::MM1::ViewsEnh::Spells::Fly, and MM::MM1::ViewsEnh::WheelSpin.

msgMouseDown()

bool MM::MM1::ViewsEnh::ScrollView::msgMouseDown ( const MouseDownMessage &  msg )

overridevirtual

Mouse down messages

Reimplemented from MM::MM1::UIElement.

Reimplemented in MM::MM1::ViewsEnh::SelectNumber, MM::MM1::ViewsEnh::YesNo, MM::MM1::ViewsEnh::SelectNumberSubview, and MM::MM1::ViewsEnh::WonGame.

msgMouseUp()

bool MM::MM1::ViewsEnh::ScrollView::msgMouseUp ( const MouseUpMessage &  msg )

overridevirtual

Mouse up messages

Reimplemented from MM::MM1::UIElement.

Reimplemented in MM::MM1::ViewsEnh::YesNo.

---

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

• engines/mm/mm1/views_enh/scroll_view.h