ScummVM API documentation
GUI::EditTextWidget Class Reference
Inheritance diagram for GUI::EditTextWidget:
GUI::EditableWidget GUI::Widget GUI::CommandSender GUI::GuiObject GUI::CommandReceiver

Public Member Functions

 EditTextWidget (GuiObject *boss, int x, int y, int w, int h, bool scale, const Common::U32String &text, const Common::U32String &tooltip=Common::U32String(), uint32 cmd=0, uint32 finishCmd=0, ThemeEngine::FontStyle font=ThemeEngine::kFontStyleNormal)
 
 EditTextWidget (GuiObject *boss, int x, int y, int w, int h, const Common::U32String &text, const Common::U32String &tooltip=Common::U32String(), uint32 cmd=0, uint32 finishCmd=0, ThemeEngine::FontStyle font=ThemeEngine::kFontStyleNormal)
 
 EditTextWidget (GuiObject *boss, const Common::String &name, const Common::U32String &text, const Common::U32String &tooltip=Common::U32String(), uint32 cmd=0, uint32 finishCmd=0, ThemeEngine::FontStyle font=ThemeEngine::kFontStyleNormal)
 
void setEditString (const Common::U32String &str) override
 
bool wantsFocus () override
 
void reflowLayout () override
 
- Public Member Functions inherited from GUI::EditableWidget
 EditableWidget (GuiObject *boss, int x, int y, int w, int h, bool scale, const Common::U32String &tooltip=Common::U32String(), uint32 cmd=0)
 
 EditableWidget (GuiObject *boss, int x, int y, int w, int h, const Common::U32String &tooltip=Common::U32String(), uint32 cmd=0)
 
 EditableWidget (GuiObject *boss, const Common::String &name, const Common::U32String &tooltip=Common::U32String(), uint32 cmd=0)
 
void init ()
 
virtual const Common::U32StringgetEditString () const
 
void handleTickle () override
 
void handleMouseDown (int x, int y, int button, int clickCount) override
 
void handleMouseUp (int x, int y, int button, int clickCount) override
 
void handleMouseMoved (int x, int y, int button) override
 
bool handleKeyDown (Common::KeyState state) override
 
bool handleKeyUp (Common::KeyState state) override
 
void handleOtherEvent (const Common::Event &evt) override
 
void moveCaretToStart (bool shiftPressed)
 
void moveCaretToEnd (bool shiftPressed)
 
bool setCaretPos (int newPos)
 
void setSelectionOffset (int newOffset)
 
- Public Member Functions inherited from GUI::Widget
 Widget (GuiObject *boss, int x, int y, int w, int h, bool scale, const Common::U32String &tooltip=Common::U32String())
 
 Widget (GuiObject *boss, int x, int y, int w, int h, const Common::U32String &tooltip=Common::U32String())
 
 Widget (GuiObject *boss, const Common::String &name, const Common::U32String &tooltip=Common::U32String())
 
void init ()
 
void setNext (Widget *w)
 
void setBoss (GuiObject *newBoss)
 
Widgetnext ()
 
int16 getAbsX () const override
 
int16 getAbsY () const override
 
virtual void setPos (int x, int y)
 
virtual void setSize (int w, int h)
 
virtual void getMinSize (int &minWidth, int &minHeight)
 
virtual void handleMouseEntered (int button)
 
virtual void handleMouseLeft (int button)
 
void handleMouseWheel (int x, int y, int direction) override
 
virtual void markAsDirty ()
 
virtual void draw ()
 
void receivedFocus ()
 
void lostFocus ()
 
uint32 getType () const
 
void setFlags (int flags)
 
void clearFlags (int flags)
 
int getFlags () const
 
void setEnabled (bool e)
 
bool isEnabled () const
 
void setVisible (bool e)
 
bool isVisible () const override
 
bool useRTL () const
 
uint8 parseHotkey (const Common::U32String &label)
 
Common::U32String cleanupHotkey (const Common::U32String &label)
 
bool hasTooltip () const
 
const Common::U32StringgetTooltip () const
 
void setTooltip (const Common::U32String &tooltip)
 
void setTooltip (const Common::String &tooltip)
 
virtual bool containsWidget (Widget *) const
 
void read (const Common::U32String &str)
 
- Public Member Functions inherited from GUI::GuiObject
 GuiObject (int x, int y, int w, int h, bool scale=false)
 
 GuiObject (const Common::String &name)
 
virtual void setTextDrawableArea (const Common::Rect &r)
 
virtual void resize (int x, int y, int w, int h, bool scale=true)
 
virtual WidgetaddChild (Widget *newChild)
 
virtual int16 getRelX () const
 
virtual int16 getRelY () const
 
virtual int16 getChildX () const
 
virtual int16 getChildY () const
 
virtual uint16 getWidth () const
 
virtual uint16 getHeight () const
 
virtual void removeWidget (Widget *widget)
 
virtual bool isPointIn (int x, int y)
 
virtual Common::Rect getClipRect () const
 
virtual void handleTooltipUpdate (int x, int y)
 
- Public Member Functions inherited from GUI::CommandSender
 CommandSender (CommandReceiver *target)
 
void setTarget (CommandReceiver *target)
 
CommandReceivergetTarget () const
 
virtual void sendCommand (uint32 cmd, uint32 data)
 

Protected Member Functions

void drawWidget () override
 
void receivedFocusWidget () override
 
void lostFocusWidget () override
 
void startEditMode () override
 
void endEditMode () override
 
void abortEditMode () override
 
Common::Rect getEditRect () const override
 
- Protected Member Functions inherited from GUI::EditableWidget
virtual int getCaretOffset () const
 
virtual int getSelectionCarretOffset () const
 
void drawCaret (bool erase, bool useRelativeCoordinates=false)
 
bool adjustOffset ()
 
void makeCaretVisible ()
 
void defaultKeyDownHandler (Common::KeyState &state, bool &dirty, bool &forcecaret, bool &handled)
 
void setFontStyle (ThemeEngine::FontStyle font)
 
virtual bool isCharAllowed (Common::u32char_type_t c) const
 
bool tryInsertChar (Common::u32char_type_t c, int pos)
 
int caretVisualPos (int logicalPos) const
 
int caretLogicalPos () const
 
void clearSelection ()
 
- Protected Member Functions inherited from GUI::Widget
void updateState (int oldFlags, int newFlags)
 
virtual WidgetfindWidget (int x, int y)
 
void releaseFocus () override
 
void handleCommand (CommandSender *sender, uint32 cmd, uint32 data) override
 

Protected Attributes

Common::U32String _backupString
 
int _leftPadding
 
int _rightPadding
 
uint32 _finishCmd
 
- Protected Attributes inherited from GUI::EditableWidget
Common::U32String _editString
 
uint32 _cmd
 
bool _caretVisible
 
uint32 _caretTime
 
int _caretPos
 
bool _caretInverse
 
int _editScrollOffset
 
int _selCaretPos
 
int _selOffset
 
bool _shiftPressed
 
bool _isDragging
 
bool _disableSelection
 
Graphics::TextAlign _align
 
Graphics::TextAlign _drawAlign
 
ThemeEngine::FontStyle _font
 
ThemeEngine::TextInversionState _inversion
 
- Protected Attributes inherited from GUI::Widget
uint32 _type
 
GuiObject_boss
 
Widget_next
 
bool _hasFocus
 
ThemeEngine::WidgetStateInfo _state
 
Common::U32String _tooltip
 
- Protected Attributes inherited from GUI::GuiObject
Common::Rect _textDrawableArea
 
int16 _x
 
int16 _y
 
uint16 _w
 
uint16 _h
 
bool _useRTL
 
const Common::String _name
 
Widget_firstWidget
 
- Protected Attributes inherited from GUI::CommandSender
CommandReceiver_target
 

Additional Inherited Members

- Static Public Member Functions inherited from GUI::Widget
static WidgetfindWidgetInChain (Widget *start, int x, int y)
 
static WidgetfindWidgetInChain (Widget *start, const char *name)
 
static bool containsWidgetInChain (Widget *start, Widget *search)
 

Member Function Documentation

◆ getEditRect()

Common::Rect GUI::EditTextWidget::getEditRect ( ) const
overrideprotectedvirtual

The area where text input is being made. This should exactly match the rect with which the actual edit string is drawn otherwise nasty graphics glitches when redrawing the caret can occur.

Implements GUI::EditableWidget.


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