ScummVM API documentation
Ultima::Ultima1::Gfx::TextInput Class Reference

#include <text_input.h>

Inheritance diagram for Ultima::Ultima1::Gfx::TextInput:
Graphics::Views::UIElement

Public Member Functions

 TextInput (const Common::String &name, UIElement *parent, TextCursor &cursor)
 
void draw () override
 
bool msgKeypress (const KeypressMessage &msg) override
 
bool msgUnfocus (const UnfocusMessage &msg) override
 
void setPosition (const Common::Point &pt, int maxWidth)
 
void hide ()
 
void setColor (byte color)
 
- 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

Simple text entry field. Accepts printable characters up to a maximum width and backspace to delete; Enter sends a GameMessage named "INPUT" to its parent, with the entered text as the string parameter.

Rather than drawing its own caret, it drives a shared TextCursor - positioned just after the last typed character - so the same cursor animation is used consistently, whether it's parked at a prompt or following text as it's typed.

Member Function Documentation

◆ draw()

void Ultima::Ultima1::Gfx::TextInput::draw ( )
overridevirtual

Draws the element

Reimplemented from Graphics::Views::UIElement.

◆ msgKeypress()

bool Ultima::Ultima1::Gfx::TextInput::msgKeypress ( const KeypressMessage &  msg)
overridevirtual

Reimplemented from Graphics::Views::UIElement.

◆ msgUnfocus()

bool Ultima::Ultima1::Gfx::TextInput::msgUnfocus ( const UnfocusMessage &  msg)
overridevirtual

Reimplemented from Graphics::Views::UIElement.

◆ setPosition()

void Ultima::Ultima1::Gfx::TextInput::setPosition ( const Common::Point &  pt,
int  maxWidth 
)

Positions the field and shows it ready for input, clearing any previously entered text. The field's bounds are sized one character wider than maxWidth, to leave room for the cursor when the text is at its maximum length

◆ hide()

void Ultima::Ultima1::Gfx::TextInput::hide ( )

Hides the field

◆ setColor()

void Ultima::Ultima1::Gfx::TextInput::setColor ( byte  color)
inline

Sets the color the entered text is drawn in


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