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

Public Member Functions

 RichTextWidget (GuiObject *boss, int x, int y, int w, int h, bool scale, const Common::U32String &text, const Common::U32String &tooltip=Common::U32String())
 
 RichTextWidget (GuiObject *boss, int x, int y, int w, int h, const Common::U32String &text, const Common::U32String &tooltip=Common::U32String())
 
 RichTextWidget (GuiObject *boss, const Common::String &name, const Common::U32String &text, const Common::U32String &tooltip=Common::U32String())
 
void reflowLayout () override
 
void draw () override
 
void handleCommand (CommandSender *sender, uint32 cmd, uint32 data) override
 
void handleMouseWheel (int x, int y, int direction) 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
 
void handleTooltipUpdate (int x, int y) override
 
void markAsDirty () override
 
bool containsWidget (Widget *) const override
 
void setImageArchive (const Common::Path &fname)
 
- 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)
 
virtual bool handleKeyDown (Common::KeyState state)
 
virtual bool handleKeyUp (Common::KeyState state)
 
virtual void handleOtherEvent (const Common::Event &evt)
 
virtual void handleTickle ()
 
void receivedFocus ()
 
void lostFocus ()
 
virtual bool wantsFocus ()
 
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)
 
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
 
- 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 init ()
 
void recalc ()
 
void drawWidget () override
 
void createWidget ()
 
WidgetfindWidget (int x, int y) override
 
- Protected Member Functions inherited from GUI::Widget
void updateState (int oldFlags, int newFlags)
 
virtual void receivedFocusWidget ()
 
virtual void lostFocusWidget ()
 
void releaseFocus () override
 

Protected Attributes

Graphics::MacText_txtWnd = nullptr
 
Graphics::ManagedSurface_surface = nullptr
 
Common::U32String _text
 
ScrollBarWidget_verticalScroll
 
int16 _scrolledX
 
int16 _scrolledY
 
int _mouseDownY = 0
 
int _mouseDownStartY = 0
 
int _innerMargin
 
int _scrollbarWidth
 
uint16 _limitH
 
int _textWidth
 
int _textHeight
 
Common::Path _imageArchive
 
- 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

◆ draw()

void GUI::RichTextWidget::draw ( )
overridevirtual

Redraw the widget if it was marked as dirty, and recursively proceed with its children

Reimplemented from GUI::Widget.

◆ markAsDirty()

void GUI::RichTextWidget::markAsDirty ( )
overridevirtual

Mark the widget and its children as dirty so they are redrawn on the next screen update

Reimplemented from GUI::Widget.


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