#include <view.h>

Inheritance diagram for Got::Views::View:

Public Member Functions
	View (const Common::String &name, UIElement *uiParent)

	View (const Common::String &name)

bool	msgFocus (const FocusMessage &msg) override

bool	msgUnfocus (const UnfocusMessage &msg) override

bool	msgMouseMove (const MouseMoveMessage &msg) override

bool	msgMouseDown (const MouseDownMessage &msg) override

bool	msgMouseUp (const MouseUpMessage &msg) override

Public Member Functions inherited from Got::UIElement
	UIElement (const Common::String &name, UIElement *uiParent)

	UIElement (const Common::String &name)

bool	needsRedraw () const

void	redraw ()

virtual void	close ()

virtual void	replaceView (UIElement *ui, bool replaceAllViews=false, bool fadeOutIn=false)

virtual void	replaceView (const Common::String &name, bool replaceAllViews=false, bool fadeOutIn=false)

virtual void	addView (UIElement *ui)

virtual void	addView (const Common::String &name)

void	addView ()

void	open ()

int	getRandomNumber (int minNumber, int maxNumber)

int	getRandomNumber (int maxNumber)

virtual void	setBounds (const Common::Rect &r)

Common::Rect	getBounds () const

const Common::String &	getName () const

Gfx::GfxSurface	getSurface (bool innerBounds=false) const

virtual void	draw ()

virtual bool	tick ()

virtual UIElement *	findView (const Common::String &name)

bool	send (const MouseMoveMessage &msg)

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 MouseEnterMessage &msg)

bool	send (const MouseEnterMessage &msg)

bool	send (const Common::String &viewName, const MouseLeaveMessage &msg)

bool	send (const MouseLeaveMessage &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 ValueMessage &msg)

bool	send (const ValueMessage &msg)

Protected Member Functions
void	playSound (int index, bool priority_override)

void	playSound (const Gfx::GraphicChunk &src)

void	musicPlay (int num, bool override)

void	musicPlay (const char *name, bool override)

void	musicPause ()

void	musicResume ()

void	musicStop ()

bool	musicIsOn () const

void	fadeOut ()

void	fadeIn (const byte *pal=nullptr)

Protected Member Functions inherited from Got::UIElement
bool	isDelayActive () const

void	cancelDelay ()

virtual void	timeout ()

virtual bool	msgMouseEnter (const MouseEnterMessage &e)

virtual bool	msgMouseLeave (const MouseLeaveMessage &e)

virtual bool	msgKeypress (const KeypressMessage &e)

virtual bool	msgAction (const ActionMessage &e)

virtual bool	msgGame (const GameMessage &e)

virtual bool	msgValue (const ValueMessage &e)

Additional Inherited Members
Protected Attributes inherited from Got::UIElement
UIElement *	_parent

Common::Array< UIElement * >	_children

Common::Rect	_innerBounds

Bounds	_bounds

bool	_needsRedraw = true

Common::String	_name

Detailed Description

Base view class for screens and dialogs that appear on-screen. The View class takes care of two important things: 1) By default events get sent to all controls on a view until one handles it. For mouse events, we instead want only the control the mouse cursor is over to receive the events, saving the individual controls from having to check if the mouse is within their bounds. 2) Individual elements will get a Focus/Unfocus message as the mouse enters and leaves them. This allows, for example, buttons that have been pressed to de-select if the mouse leaves their bounds.

Member Function Documentation

◆ msgMouseMove()

bool Got::Views::View::msgMouseMove ( const MouseMoveMessage & msg )

overridevirtual

Handles events

Reimplemented from Got::UIElement.

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

engines/got/views/view.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ msgMouseMove()