#include <editable.h>

Inheritance diagram for GUI::EditableWidget:

Public Member Functions
	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 void	setEditString (const Common::U32String &str)

virtual const Common::U32String &	getEditString () 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	reflowLayout () 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)

Widget *	next ()

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 ()

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::U32String &	getTooltip () 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 Widget *	addChild (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)

CommandReceiver *	getTarget () const

virtual void	sendCommand (uint32 cmd, uint32 data)

Protected Member Functions
void	drawWidget () override

virtual void	startEditMode ()=0

virtual void	endEditMode ()=0

virtual void	abortEditMode ()=0

virtual Common::Rect	getEditRect () const =0

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 void	receivedFocusWidget ()

virtual void	lostFocusWidget ()

virtual Widget *	findWidget (int x, int y)

void	releaseFocus () override

void	handleCommand (CommandSender *sender, uint32 cmd, uint32 data) override

Protected Attributes
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 Widget *	findWidgetInChain (Widget *start, int x, int y)

static Widget *	findWidgetInChain (Widget start, const char name)

static bool	containsWidgetInChain (Widget start, Widget search)

Detailed Description

Base class for widgets which need to edit text, like ListWidget and EditTextWidget.

Member Function Documentation

◆ getEditRect()

virtual Common::Rect GUI::EditableWidget::getEditRect ( ) const

protectedpure virtual

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.

Implemented in GUI::ListWidget, and GUI::EditTextWidget.

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

gui/widgets/editable.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getEditRect()