ScummVM API documentation
Graphics::Views::View Class Reference

#include <view.h>

Inheritance diagram for Graphics::Views::View:
Graphics::Views::UIElement Ultima::Shared::View Ultima::Ultima3::Views::Title Ultima::Ultima1::Views::Dialog Ultima::Ultima1::Views::FullScreenDialog Ultima::Ultima1::Views::Game Ultima::Ultima1::Views::Interactions::Interaction Ultima::Ultima1::Views::SpaceGame Ultima::Ultima1::Views::Startup Ultima::Ultima1::Views::Title Ultima::Ultima2::Views::CreateCharacter Ultima::Ultima2::Views::Ending Ultima::Ultima2::Views::Game Ultima::Ultima2::Views::HelmMap Ultima::Ultima2::Views::Interactions::Interaction Ultima::Ultima2::Views::Map Ultima::Ultima2::Views::SpaceMap Ultima::Ultima2::Views::Title Ultima::Ultima2::Views::ZStats Ultima::Ultima3::Views::Game Ultima::Ultima3::Views::WindowView

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 Graphics::Views::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)
 
virtual void replaceView (const Common::String &name, bool replaceAllViews=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
 
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)
 
template<class T >
bool send (const T &msg)
 
template<class T >
bool send (const Common::String &viewName, const T &msg)
 

Additional Inherited Members

- Protected Member Functions inherited from Graphics::Views::UIElement
void delaySeconds (uint seconds)
 
void delayFrames (uint frames)
 
bool isDelayActive () const
 
void cancelDelay ()
 
virtual void timeout ()
 
virtual bool msgMouseMove (const MouseMoveMessage &msg)
 
void stopTextToSpeech ()
 
virtual bool msgFocus (const FocusMessage &e)
 
virtual bool msgUnfocus (const UnfocusMessage &e)
 
virtual bool msgMouseEnter (const MouseEnterMessage &e)
 
virtual bool msgMouseLeave (const MouseLeaveMessage &e)
 
virtual bool msgKeypress (const KeypressMessage &e)
 
virtual bool msgMouseDown (const MouseDownMessage &e)
 
virtual bool msgMouseUp (const MouseUpMessage &e)
 
virtual bool msgAction (const ActionMessage &e)
 
virtual bool msgGame (const GameMessage &e)
 
virtual bool msgValue (const ValueMessage &e)
 
virtual bool msgCustom (const Message &msg)
 
- Protected Attributes inherited from Graphics::Views::UIElement
UIElement * _parent
 
Common::Array< UIElement * > _children
 
Common::Rect _innerBounds
 
Bounds _bounds
 
bool _needsRedraw = true
 
Common::String _name
 
Common::String _previousSaid
 

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

◆ msgFocus()

bool Graphics::Views::View::msgFocus ( const FocusMessage &  msg)
overridevirtual

Reimplemented from Graphics::Views::UIElement.

◆ msgUnfocus()

bool Graphics::Views::View::msgUnfocus ( const UnfocusMessage &  msg)
overridevirtual

Reimplemented from Graphics::Views::UIElement.

◆ msgMouseMove()

bool Graphics::Views::View::msgMouseMove ( const MouseMoveMessage &  msg)
overridevirtual

Handles events

Reimplemented from Graphics::Views::UIElement.

◆ msgMouseDown()

bool Graphics::Views::View::msgMouseDown ( const MouseDownMessage &  msg)
overridevirtual

Reimplemented from Graphics::Views::UIElement.

◆ msgMouseUp()

bool Graphics::Views::View::msgMouseUp ( const MouseUpMessage &  msg)
overridevirtual

Reimplemented from Graphics::Views::UIElement.


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