#include <textfield.h>

Inheritance diagram for TextField:

Public Member Functions
	TextField (const Widget2 const widget, const std::string &text, const LoseFocusOnTab loseFocusOnTab, ActionListener const listener, const std::string &eventId, const bool sendAlwaysEvents)

	~TextField ()

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	updateAlpha ()

void	drawFrame (Graphics *const graphics)

void	safeDrawFrame (Graphics *const graphics)

void	setNumeric (const bool numeric)

void	setRange (const int min, const int max)

void	keyPressed (KeyEvent &event)

void	setMinimum (const int min)

void	setMaximum (const int max)

int	getValue () const

void	setSendAlwaysEvents (const bool b)

void	adjustSize ()

void	adjustHeight ()

void	setCaretPosition (unsigned int position)

void	mousePressed (MouseEvent &event)

void	handlePaste ()

void	handleCopy () const

void	focusGained (const Event &event)

void	focusLost (const Event &event)

void	moveCaretBack ()

void	moveCaretForward ()

void	moveCaretWordBack ()

void	moveCaretWordForward ()

void	caretDelete ()

void	caretDeleteToStart ()

void	caretDeleteWord ()

void	setAllowSpecialActions (const bool b)

std::string	getTextBeforeCaret () const

void	setText (const std::string &text)

const std::string &	getText () const

unsigned int	getCaretPosition () const

void	mouseDragged (MouseEvent &event)

void	widgetHidden (const Event &event)

void	setParent (Widget *widget)

void	setWindow (Widget *const widget)

void	signalEvent ()

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

virtual void	logic ()

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

virtual void	setFocusHandler (FocusHandler *const focusHandler)

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

Font *	getFont () const

void	setFont (Font *const font)

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

virtual Widget *	getWidgetAt (int x, int y)

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual Rect	getChildrenArea ()

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

virtual void	moveToTop (Widget *widget)

virtual void	moveToBottom (Widget *widget)

virtual void	focusNext ()

virtual void	focusPrevious ()

virtual void	showWidgetPart (Widget *const widget, const Rect &area)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

virtual bool	isSelectable () const

void	setSelectable (const bool selectable)

void	windowResized ()

virtual void	postInit ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

Public Member Functions inherited from FocusListener
virtual	~FocusListener ()

Public Member Functions inherited from KeyListener
virtual	~KeyListener ()

virtual void	keyReleased (KeyEvent &event)

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()

virtual void	mouseEntered (MouseEvent &event)

virtual void	mouseExited (MouseEvent &event)

virtual void	mouseReleased (MouseEvent &event)

virtual void	mouseClicked (MouseEvent &event)

virtual void	mouseWheelMovedUp (MouseEvent &event)

virtual void	mouseWheelMovedDown (MouseEvent &event)

virtual void	mouseMoved (MouseEvent &event)

Public Member Functions inherited from WidgetListener
virtual	~WidgetListener ()

virtual void	widgetResized (const Event &event)

virtual void	widgetMoved (const Event &event)

virtual void	widgetShown (const Event &event)

Protected Member Functions
void	drawCaret (Graphics *graphics, int x)

void	fixScroll ()

void	fontChanged ()

bool	handleNormalKeys (const InputActionT action, bool &consumed)

void	handleCtrlKeys (const InputActionT action, bool &consumed)

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Member Functions inherited from FocusListener
	FocusListener ()

Protected Member Functions inherited from KeyListener
	KeyListener ()

Protected Member Functions inherited from MouseListener
	MouseListener ()

Protected Member Functions inherited from WidgetListener
	WidgetListener ()

Protected Attributes
std::string	mText

TextChunk	mTextChunk

unsigned int	mCaretPosition

int	mXScroll

const Color *	mCaretColor

int	mMinimum

int	mMaximum

time_t	mLastEventPaste

int	mPadding

bool	mNumeric

LoseFocusOnTab	mLoseFocusOnTab

bool	mAllowSpecialActions

bool	mSendAlwaysEvents

bool	mTextChanged

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes
static Skin *	mSkin

static int	instances = 0

static float	mAlpha = 1.0

static ImageRect	skin

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Additional Inherited Members
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Detailed Description

A text field.

Definition at line 88 of file textfield.h.

Constructor & Destructor Documentation

◆ TextField()

TextField::TextField	(	const Widget2 *const	widget,
		const std::string &	text,
		const LoseFocusOnTab	loseFocusOnTab,
		ActionListener *const	listener,
		const std::string &	eventId,
		const bool	sendAlwaysEvents
	)

Constructor, initializes the text field with the given string.

Definition at line 109 of file textfield.cpp.

                                                   :
     Widget(widget),
     FocusListener(),
     KeyListener(),
     MouseListener(),
     WidgetListener(),
     mText(text),
     mTextChunk(),
     mCaretPosition(0),
     mXScroll(0),
     mCaretColor(&getThemeColor(ThemeColorId::CARET, 255U)),
     mMinimum(0),
     mMaximum(0),
     mLastEventPaste(0),
     mPadding(1),
     mNumeric(false),
     mLoseFocusOnTab(loseFocusOnTab),
     mAllowSpecialActions(true),
     mSendAlwaysEvents(sendAlwaysEvents),
     mTextChanged(true)
 {
     mAllowLogic = false;
     setFocusable(true);
     addMouseListener(this);
     addKeyListener(this);
  
     setFrameSize(2);
     mForegroundColor = getThemeColor(ThemeColorId::TEXTFIELD, 255U);
     mForegroundColor2 = getThemeColor(ThemeColorId::TEXTFIELD_OUTLINE, 255U);
  
     addFocusListener(this);
  
     if (instances == 0)
     {
         if (theme != nullptr)
         {
             mSkin = theme->loadSkinRect(skin,
                 "textfield.xml",
                 "textfield_background.xml",
                 0,
                 8);
         }
     }
  
     instances++;
  
     if (mSkin != nullptr)
     {
         mPadding = mSkin->getPadding();
         mFrameSize = mSkin->getOption("frameSize", 2);
     }
  
     adjustSize();
     if (!eventId.empty())
         setActionEventId(eventId);
  
     if (listener != nullptr)
         addActionListener(listener);
 }

References Widget::addActionListener(), Widget::addFocusListener(), Widget::addKeyListener(), Widget::addMouseListener(), adjustSize(), Skin::getOption(), Skin::getPadding(), Widget2::getThemeColor(), instances, anonymous_namespace{itemlinkhandler.cpp}::listener, Theme::loadSkinRect(), Widget::mAllowLogic, Widget::mForegroundColor, Widget2::mForegroundColor2, Widget::mFrameSize, mPadding, mSkin, Widget::setActionEventId(), Widget::setFocusable(), Widget::setFrameSize(), skin, and theme.

◆ ~TextField()

TextField::~TextField ( )

Definition at line 174 of file textfield.cpp.

 {
     if (mWindow != nullptr)
         mWindow->removeWidgetListener(this);
  
     if (gui != nullptr)
         gui->removeDragged(this);
  
     instances--;
     if (instances == 0)
     {
         if (theme != nullptr)
         {
             theme->unload(mSkin);
             Theme::unloadRect(skin, 0, 8);
         }
     }
     mTextChunk.deleteImage();
 }

References TextChunk::deleteImage(), gui, instances, mSkin, mTextChunk, Widget2::mWindow, Gui::removeDragged(), Widget::removeWidgetListener(), skin, theme, Theme::unload(), and Theme::unloadRect().

Member Function Documentation

◆ adjustHeight()

void TextField::adjustHeight ( )

Definition at line 724 of file textfield.cpp.

 {
     setHeight(getFont()->getHeight() + 2 * mPadding);
 }

References Widget::getFont(), Widget::getHeight(), mPadding, and Widget::setHeight().

Referenced by adjustSize().

◆ adjustSize()

void TextField::adjustSize ( )

Definition at line 716 of file textfield.cpp.

 {
     setWidth(getFont()->getWidth(mText) + 2 * mPadding + 1);
     adjustHeight();
  
     fixScroll();
 }

References adjustHeight(), fixScroll(), Widget::getFont(), Widget::getWidth(), mPadding, mText, and Widget::setWidth().

Referenced by LoginDialog::LoginDialog(), and TextField().

◆ caretDelete()

void TextField::caretDelete ( )

Definition at line 616 of file textfield.cpp.

 {
     unsigned sz = CAST_U32(mText.size());
     while (mCaretPosition < sz)
     {
         --sz;
         mText.erase(mCaretPosition, 1);
         if (mCaretPosition == sz || (mText[mCaretPosition] & 192) != 128)
             break;
     }
     mTextChanged = true;
 }

References CAST_U32, mCaretPosition, mText, and mTextChanged.

Referenced by handleCtrlKeys().

◆ caretDeleteToStart()

void TextField::caretDeleteToStart ( )

Definition at line 641 of file textfield.cpp.

 {
     if (mCaretPosition > 0)
     {
         mText = mText.substr(mCaretPosition);
         mCaretPosition = 0;
     }
     mTextChanged = true;
 }

References mCaretPosition, mText, and mTextChanged.

Referenced by handleCtrlKeys().

◆ caretDeleteWord()

void TextField::caretDeleteWord ( )

Definition at line 690 of file textfield.cpp.

 {
     while (mCaretPosition > 0)
     {
         deleteCharLeft(mText, &mCaretPosition);
         if (mCaretPosition > 0 && isWordSeparator(mText[mCaretPosition - 1]))
             break;
     }
     mTextChanged = true;
 }

References deleteCharLeft(), isWordSeparator(), mCaretPosition, mText, and mTextChanged.

Referenced by handleCtrlKeys().

◆ draw()

void TextField::draw ( Graphics *const graphics )

virtual

Draws the text field.

Implements Widget.

Definition at line 210 of file textfield.cpp.

 {
     BLOCK_START("TextField::draw")
     updateAlpha();
  
     Font *const font = getFont();
     if (isFocused())
     {
         drawCaret(graphics,
             font->getWidth(mText.substr(0, mCaretPosition)) - mXScroll);
     }
  
     if (mTextChanged)
     {
         mTextChunk.textFont = font;
         mTextChunk.deleteImage();
         mTextChunk.text = mText;
         mTextChunk.color = mForegroundColor;
         mTextChunk.color2 = mForegroundColor2;
         font->generate(mTextChunk);
         mTextChanged = false;
     }
  
     const Image *const image = mTextChunk.img;
     if (image != nullptr)
         graphics->drawImage(image, mPadding - mXScroll, mPadding);
  
     BLOCK_END("TextField::draw")
 }

References BLOCK_END, BLOCK_START, TextChunk::color, TextChunk::color2, TextChunk::deleteImage(), drawCaret(), Graphics::drawImage(), Font::generate(), Widget::getFont(), Font::getWidth(), TextChunk::img, Widget::isFocused(), mCaretPosition, Widget::mForegroundColor, Widget2::mForegroundColor2, mPadding, mText, mTextChanged, mTextChunk, mXScroll, TextChunk::text, TextChunk::textFont, and updateAlpha().

Referenced by PasswordField::draw(), and safeDraw().

◆ drawCaret()

void TextField::drawCaret	(	Graphics *	graphics,
		int	x
	)

protected

Definition at line 707 of file textfield.cpp.

 {
     const ClipRect &clipArea = graphics->getTopClip();
  
     graphics->setColor(*mCaretColor);
     graphics->drawLine(x + mPadding, clipArea.height - mPadding,
         x + mPadding, mPadding);
 }

References Graphics::drawLine(), Graphics::getTopClip(), Rect::height, mCaretColor, mPadding, Graphics::setColor(), and x.

Referenced by draw().

◆ drawFrame()

void TextField::drawFrame ( Graphics *const graphics )

virtual

Draws the background and border.

Reimplemented from Widget.

Definition at line 245 of file textfield.cpp.

 {
     BLOCK_START("TextField::drawFrame")
     const int bs = 2 * mFrameSize;
     graphics->drawImageRect(0,
         0,
         mDimension.width + bs,
         mDimension.height + bs,
         skin);
     BLOCK_END("TextField::drawFrame")
 }

References BLOCK_END, BLOCK_START, Graphics::drawImageRect(), Rect::height, Widget::mDimension, Widget::mFrameSize, skin, and Rect::width.

◆ fixScroll()

void TextField::fixScroll ( )

protected

Definition at line 729 of file textfield.cpp.

 {
     if (isFocused())
     {
         const int caretX = getFont()->getWidth(
             mText.substr(0, mCaretPosition));
  
         const int width = mDimension.width;
         const int pad = 2 * mPadding;
         if (caretX - mXScroll >= width - pad)
         {
             mXScroll = caretX - width + pad;
         }
         else if (caretX - mXScroll <= 0)
         {
             mXScroll = caretX - width / 2;
  
             if (mXScroll < 0)
                 mXScroll = 0;
         }
     }
 }

References Widget::getFont(), Font::getWidth(), Widget::isFocused(), mCaretPosition, Widget::mDimension, mPadding, mText, mXScroll, and Rect::width.

Referenced by adjustSize(), fontChanged(), handleNormalKeys(), keyPressed(), mousePressed(), and setCaretPosition().

◆ focusGained()

void TextField::focusGained ( const Event & event )

virtual

Called when a widget gains focus.

Parameters

event Discribes the event.

Reimplemented from FocusListener.

Definition at line 791 of file textfield.cpp.

 {
 #if defined(ANDROID) || defined(__SWITCH__)
     if (!WindowManager::isKeyboardVisible())
         inputManager.executeAction(InputAction::SHOW_KEYBOARD);
 #endif  // ANDROID
 }

References InputManager::executeAction(), inputManager, WindowManager::isKeyboardVisible(), and InputAction::SHOW_KEYBOARD.

◆ focusLost()

void TextField::focusLost ( const Event & event )

virtual

Called when a widget loses focus.

Parameters

event Discribes the event.

Reimplemented from FocusListener.

Definition at line 799 of file textfield.cpp.

800 {

801 }

Referenced by ChatInput::focusLost().

◆ fontChanged()

void TextField::fontChanged ( )

protectedvirtual

Called when the font has changed. If the change is global, this function will only be called if the widget doesn't have a font already set.

Reimplemented from Widget.

Definition at line 763 of file textfield.cpp.

 {
     fixScroll();
 }

References fixScroll().

◆ getCaretPosition()

unsigned int TextField::getCaretPosition ( ) const

inline

Gets the caret position. As there is only one line of text in a text field the position is the caret's x coordinate.

Returns: The caret position.

See also: setCaretPosition

Definition at line 234 of file textfield.h.

235 { return mCaretPosition; }

References mCaretPosition.

Referenced by ChatWindow::addInputText(), ChatWindow::autoComplete(), and handlePaste().

◆ getText()

const std::string& TextField::getText ( ) const

inline

Gets the text of the text field.

Returns: The text of the text field.

See also: setText

Definition at line 224 of file textfield.h.

225 { return mText; }

References mText.

Referenced by SetupItemTextField::action(), SetupItemIntTextField::action(), BuyDialog::action(), ChangeEmailDialog::action(), ChangePasswordDialog::action(), ChatWindow::action(), EditServerDialog::action(), InventoryWindow::action(), NpcDialog::action(), RegisterDialog::action(), TradeWindow::action(), ChatWindow::addCurrentToHistory(), ChatWindow::addInputText(), ChatWindow::autoComplete(), LoginDialog::canSubmit(), RegisterDialog::canSubmit(), MailEditWindow::focusLost(), SetupItemTextField::fromWidget(), SetupItemIntTextField::fromWidget(), EditDialog::getMsg(), PincodeDialog::getMsg(), CharCreateDialog::getName(), TextDialog::getText(), IntTextField::getValue(), handleCopy(), handlePaste(), IntTextField::keyPressed(), ChatWindow::keyPressed(), LoginDialog::LoginDialog(), LoginDialog::postInit(), RegisterDialog::postInit(), LoginDialog::prepareUpdate(), TextCommandEditor::save(), MailEditWindow::sendMail(), and PincodeDialog::updateButtons().

◆ getTextBeforeCaret()

std::string TextField::getTextBeforeCaret ( ) const

inline

Definition at line 207 of file textfield.h.

208 { return mText.substr(0, mCaretPosition); }

References mCaretPosition, and mText.

Referenced by ChatWindow::keyPressed().

◆ getValue()

int TextField::getValue ( ) const

Return the value for a numeric field

Definition at line 286 of file textfield.cpp.

 {
     if (!mNumeric)
         return 0;
  
     const int value = atoi(mText.c_str());
     if (value < mMinimum)
         return mMinimum;
  
     if (value > mMaximum)
         return mMaximum;
  
     return value;
 }

References mMaximum, mMinimum, mNumeric, and mText.

Referenced by Setup_Colors::Setup_Colors().

◆ handleCopy()

void TextField::handleCopy ( ) const

Definition at line 701 of file textfield.cpp.

 {
     std::string text = getText();
     sendBuffer(text);
 }

References getText(), and sendBuffer().

Referenced by handleCtrlKeys(), and PopupMenu::handleLink().

◆ handleCtrlKeys()

void TextField::handleCtrlKeys	(	const InputActionT	action,
		bool &	consumed
	)

protected

Definition at line 496 of file textfield.cpp.

 {
     PRAGMA45(GCC diagnostic push)
     PRAGMA45(GCC diagnostic ignored "-Wswitch-enum")
     switch (action)
     {
         case InputAction::GUI_LEFT:
         {
             moveCaretWordBack();
             consumed = true;
             break;
         }
         case InputAction::GUI_RIGHT:
         {
             moveCaretWordForward();
             consumed = true;
             break;
         }
         case InputAction::GUI_B:
         {
             if (mAllowSpecialActions)
             {
                 moveCaretBack();
                 consumed = true;
             }
             break;
         }
         case InputAction::GUI_F:
         {
             moveCaretForward();
             consumed = true;
             break;
         }
         case InputAction::GUI_D:
         {
             caretDelete();
             consumed = true;
             break;
         }
         case InputAction::GUI_E:
         {
             mCaretPosition = CAST_S32(mText.size());
             consumed = true;
             break;
         }
         case InputAction::GUI_H:
         {
             deleteCharLeft(mText, &mCaretPosition);
             mTextChanged = true;
             consumed = true;
             break;
         }
         case InputAction::GUI_K:
         {
             mText = mText.substr(0, mCaretPosition);
             mTextChanged = true;
             consumed = true;
             break;
         }
         case InputAction::GUI_U:
         {
             caretDeleteToStart();
             consumed = true;
             break;
         }
         case InputAction::GUI_C:
         {
             handleCopy();
             consumed = true;
             break;
         }
         case InputAction::GUI_V:
         {
 #ifdef USE_SDL2
             handlePaste();
 #else  // USE_SDL2
  
             // hack to prevent paste key sticking
             if ((mLastEventPaste != 0) && mLastEventPaste > cur_time)
                 break;
             handlePaste();
             mLastEventPaste = cur_time + 2;
 #endif  // USE_SDL2
  
             consumed = true;
             break;
         }
         case InputAction::GUI_W:
         {
             caretDeleteWord();
             consumed = true;
             break;
         }
         default:
             break;
     }
     PRAGMA45(GCC diagnostic pop)
 }

References caretDelete(), caretDeleteToStart(), caretDeleteWord(), CAST_S32, cur_time, deleteCharLeft(), InputAction::GUI_B, InputAction::GUI_C, InputAction::GUI_D, InputAction::GUI_E, InputAction::GUI_F, InputAction::GUI_H, InputAction::GUI_K, InputAction::GUI_LEFT, InputAction::GUI_RIGHT, InputAction::GUI_U, InputAction::GUI_V, InputAction::GUI_W, handleCopy(), handlePaste(), mAllowSpecialActions, mCaretPosition, mLastEventPaste, moveCaretBack(), moveCaretForward(), moveCaretWordBack(), moveCaretWordForward(), mText, mTextChanged, and PRAGMA45().

Referenced by keyPressed().

◆ handleNormalKeys()

bool TextField::handleNormalKeys	(	const InputActionT	action,
		bool &	consumed
	)

protected

Definition at line 409 of file textfield.cpp.

 {
     PRAGMA45(GCC diagnostic push)
     PRAGMA45(GCC diagnostic ignored "-Wswitch-enum")
     switch (action)
     {
         case InputAction::GUI_LEFT:
         {
             consumed = true;
             while (mCaretPosition > 0)
             {
                 --mCaretPosition;
                 if ((mText[mCaretPosition] & 192) != 128)
                     break;
             }
             break;
         }
  
         case InputAction::GUI_RIGHT:
         {
             consumed = true;
             const unsigned sz = CAST_U32(mText.size());
             while (mCaretPosition < sz)
             {
                 ++mCaretPosition;
                 if (mCaretPosition == sz ||
                     (mText[mCaretPosition] & 192) != 128)
                 {
                     break;
                 }
             }
             break;
         }
  
         case InputAction::GUI_DELETE:
         {
             consumed = true;
             unsigned sz = CAST_U32(mText.size());
             while (mCaretPosition < sz)
             {
                 --sz;
                 mText.erase(mCaretPosition, 1);
                 mTextChanged = true;
                 if (mCaretPosition == sz ||
                     (mText[mCaretPosition] & 192) != 128)
                 {
                     break;
                 }
             }
             break;
         }
  
         case InputAction::GUI_BACKSPACE:
             consumed = true;
             deleteCharLeft(mText, &mCaretPosition);
             mTextChanged = true;
             break;
  
         case InputAction::GUI_SELECT2:
             distributeActionEvent();
             consumed = true;
             fixScroll();
             return false;
  
         case InputAction::GUI_HOME:
             mCaretPosition = 0;
             consumed = true;
             break;
  
         case InputAction::GUI_END:
             mCaretPosition = CAST_U32(mText.size());
             consumed = true;
             break;
  
         case InputAction::GUI_TAB:
             if (mLoseFocusOnTab == LoseFocusOnTab_true)
                 return false;
             consumed = true;
             break;
  
         default:
             break;
     }
     PRAGMA45(GCC diagnostic pop)
     return true;
 }

References CAST_U32, deleteCharLeft(), Widget::distributeActionEvent(), fixScroll(), InputAction::GUI_BACKSPACE, InputAction::GUI_DELETE, InputAction::GUI_END, InputAction::GUI_HOME, InputAction::GUI_LEFT, InputAction::GUI_RIGHT, InputAction::GUI_SELECT2, InputAction::GUI_TAB, LoseFocusOnTab_true, mCaretPosition, mLoseFocusOnTab, mText, mTextChanged, and PRAGMA45().

Referenced by keyPressed().

◆ handlePaste()

void TextField::handlePaste ( )

Definition at line 629 of file textfield.cpp.

 {
     std::string text = getText();
     size_t caretPos = CAST_SIZE(getCaretPosition());
  
     if (retrieveBuffer(text, caretPos))
     {
         setText(text);
         setCaretPosition(CAST_U32(caretPos));
     }
 }

References CAST_SIZE, CAST_U32, getCaretPosition(), getText(), retrieveBuffer(), setCaretPosition(), and setText().

Referenced by handleCtrlKeys(), and PopupMenu::handleLink().

◆ keyPressed()

void TextField::keyPressed ( KeyEvent & event )

virtual

Processes one keypress.

Reimplemented from KeyListener.

Definition at line 301 of file textfield.cpp.

 {
     const int val = event.getKey().getValue();
  
 #ifdef USE_SDL2
     if (val == KeyValue::TEXTINPUT)
     {
         std::string str = event.getText();
         mText.insert(mCaretPosition, str);
         mTextChanged = true;
         mCaretPosition += CAST_U32(str.size());
         event.consume();
         fixScroll();
         if (mSendAlwaysEvents)
             distributeActionEvent();
         return;
     }
     bool consumed(false);
 #else  // USE_SDL2
  
     if (val >= 32)
     {
         if (mNumeric)
         {
             if ((val >= '0' && val <= '9') ||
                 (val == '-' && mCaretPosition == 0U))
             {
                 char buf[2];
                 buf[0] = CAST_8(val);
                 buf[1] = 0;
                 mText.insert(mCaretPosition, std::string(buf));
                 mTextChanged = true;
                 mCaretPosition += 1;
                 event.consume();
                 fixScroll();
                 if (mSendAlwaysEvents)
                     distributeActionEvent();
                 return;
             }
         }
         else if ((mMaximum == 0) ||
                  CAST_S32(mText.size()) < mMaximum)
         {
             int len;
             if (val < 128)
                 len = 1;               // 0xxxxxxx
             else if (val < 0x800)
                 len = 2;               // 110xxxxx 10xxxxxx
             else if (val < 0x10000)
                 len = 3;               // 1110xxxx 10xxxxxx 10xxxxxx
             else
                 len = 4;               // 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
  
             char buf[4];
             for (int i = 0; i < len; ++ i)
             {
                 buf[i] = CAST_8(val >> (6 * (len - i - 1)));
                 if (i > 0)
                     buf[i] = CAST_8((buf[i] & 63) | 128);
             }
  
             if (len > 1)
                 buf[0] |= CAST_8(255U << (8 - len));
  
             mText.insert(mCaretPosition, std::string(buf, buf + len));
             mCaretPosition += len;
             mTextChanged = true;
             event.consume();
             fixScroll();
             if (mSendAlwaysEvents)
                 distributeActionEvent();
             return;
         }
     }
  
     /* In UTF-8, 10xxxxxx is only used for inner parts of characters. So skip
        them when processing key presses. */
  
     // unblock past key
     if (val != 22)
         mLastEventPaste = 0;
  
     bool consumed(false);
 #endif  // USE_SDL2
  
     const InputActionT action = event.getActionId();
     if (!inputManager.isActionActive(InputAction::GUI_CTRL))
     {
         if (!handleNormalKeys(action, consumed))
         {
             if (consumed)
                 event.consume();
             return;
         }
     }
     else
     {
         handleCtrlKeys(action, consumed);
     }
  
     if (mSendAlwaysEvents)
         distributeActionEvent();
  
     if (consumed)
         event.consume();
     fixScroll();
 }

References CAST_8, CAST_S32, CAST_U32, Widget::distributeActionEvent(), fixScroll(), InputAction::GUI_CTRL, handleCtrlKeys(), handleNormalKeys(), inputManager, InputManager::isActionActive(), mCaretPosition, mLastEventPaste, mMaximum, mNumeric, mSendAlwaysEvents, mText, mTextChanged, and KeyValue::TEXTINPUT.

Referenced by IntTextField::keyPressed().

◆ mouseDragged()

void TextField::mouseDragged ( MouseEvent & event )

virtual

Called when the mouse has moved and the mouse has previously been pressed on the widget.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 812 of file textfield.cpp.

 {
     event.consume();
 }

◆ mousePressed()

void TextField::mousePressed ( MouseEvent & event )

virtual

Called when a mouse button has been pressed on the widget area.

NOTE: A mouse press is NOT equal to a mouse click. Use mouseClickMessage to check for mouse clicks.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 768 of file textfield.cpp.

 {
 #if defined(ANDROID) || defined(__SWITCH__)
     if (!WindowManager::isKeyboardVisible())
         inputManager.executeAction(InputAction::SHOW_KEYBOARD);
 #endif  // ANDROID
  
     event.consume();
     if (event.getButton() == MouseButton::RIGHT)
     {
 #ifndef DYECMD
         if (popupMenu != nullptr)
             popupMenu->showTextFieldPopup(this);
 #endif  // DYECMD
     }
     else if (event.getButton() == MouseButton::LEFT)
     {
         mCaretPosition = getFont()->getStringIndexAt(
             mText, event.getX() + mXScroll);
         fixScroll();
     }
 }

References InputManager::executeAction(), fixScroll(), MouseEvent::getButton(), Widget::getFont(), Font::getStringIndexAt(), MouseEvent::getX(), inputManager, WindowManager::isKeyboardVisible(), MouseButton::LEFT, mCaretPosition, mText, mXScroll, popupMenu, MouseButton::RIGHT, InputAction::SHOW_KEYBOARD, and PopupMenu::showTextFieldPopup().

◆ moveCaretBack()

void TextField::moveCaretBack ( )

Definition at line 595 of file textfield.cpp.

 {
     while (mCaretPosition > 0)
     {
         --mCaretPosition;
         if ((mText[mCaretPosition] & 192) != 128)
         break;
     }
 }

References mCaretPosition, and mText.

Referenced by handleCtrlKeys().

◆ moveCaretForward()

void TextField::moveCaretForward ( )

Definition at line 605 of file textfield.cpp.

 {
     const unsigned sz = CAST_U32(mText.size());
     while (mCaretPosition < sz)
     {
         ++mCaretPosition;
         if (mCaretPosition == sz || (mText[mCaretPosition] & 192) != 128)
             break;
     }
 }

References CAST_U32, mCaretPosition, and mText.

Referenced by handleCtrlKeys().

◆ moveCaretWordBack()

void TextField::moveCaretWordBack ( )

Definition at line 651 of file textfield.cpp.

 {
     const unsigned int oldCaret = mCaretPosition;
     while (mCaretPosition > 0)
     {
         if (!isWordSeparator(mText[mCaretPosition - 1]))
             break;
         mCaretPosition --;
     }
     if (oldCaret != mCaretPosition)
         return;
     while (mCaretPosition > 0)
     {
         if (isWordSeparator(mText[mCaretPosition - 1]))
             break;
         mCaretPosition --;
     }
 }

References isWordSeparator(), mCaretPosition, and mText.

Referenced by handleCtrlKeys().

◆ moveCaretWordForward()

void TextField::moveCaretWordForward ( )

Definition at line 670 of file textfield.cpp.

 {
     const unsigned sz = CAST_U32(mText.size());
     const unsigned int oldCaret = mCaretPosition;
     while (mCaretPosition < sz)
     {
         if (!isWordSeparator(mText[mCaretPosition]))
             break;
         mCaretPosition ++;
     }
     if (oldCaret != mCaretPosition)
         return;
     while (mCaretPosition < sz)
     {
         if (isWordSeparator(mText[mCaretPosition]))
             break;
         mCaretPosition ++;
     }
 }

References CAST_U32, isWordSeparator(), mCaretPosition, and mText.

Referenced by handleCtrlKeys().

◆ safeDraw()

void TextField::safeDraw ( Graphics *const graphics )

virtual

Implements Widget.

Definition at line 240 of file textfield.cpp.

 {
     TextField::draw(graphics);
 }

References draw().

◆ safeDrawFrame()

void TextField::safeDrawFrame ( Graphics *const graphics )

virtual

Reimplemented from Widget.

Definition at line 257 of file textfield.cpp.

 {
     BLOCK_START("TextField::drawFrame")
     const int bs = 2 * mFrameSize;
     graphics->drawImageRect(0,
         0,
         mDimension.width + bs,
         mDimension.height + bs,
         skin);
     BLOCK_END("TextField::drawFrame")
 }

References BLOCK_END, BLOCK_START, Graphics::drawImageRect(), Rect::height, Widget::mDimension, Widget::mFrameSize, skin, and Rect::width.

◆ setAllowSpecialActions()

void TextField::setAllowSpecialActions ( const bool b )

inline

Definition at line 204 of file textfield.h.

205 { mAllowSpecialActions = b; }

References mAllowSpecialActions.

Referenced by ChatWindow::ChatWindow().

◆ setCaretPosition()

void TextField::setCaretPosition ( unsigned int position )

Definition at line 752 of file textfield.cpp.

 {
     const unsigned int sz = CAST_U32(mText.size());
     if (position > sz)
         mCaretPosition = CAST_S32(sz);
     else
         mCaretPosition = position;
  
     fixScroll();
 }

References CAST_S32, CAST_U32, fixScroll(), mCaretPosition, and mText.

Referenced by ChatWindow::addInputText(), ChatWindow::autoComplete(), handlePaste(), ChatWindow::keyPressed(), RegisterDialog::postInit(), and IntTextField::setValue().

◆ setMaximum()

void TextField::setMaximum ( const int max )

inline

Set the maximum value for a range

Definition at line 158 of file textfield.h.

159 { mMaximum = max; }

References mMaximum.

Referenced by CharCreateDialog::CharCreateDialog().

◆ setMinimum()

void TextField::setMinimum ( const int min )

inline

Set the minimum value for a range

Definition at line 152 of file textfield.h.

153 { mMinimum = min; }

References mMinimum.

◆ setNumeric()

void TextField::setNumeric ( const bool numeric )

Determine whether the field should be numeric or not

Definition at line 269 of file textfield.cpp.

 {
     mNumeric = numeric;
     if (!numeric)
         return;
  
     const char *const text = mText.c_str();
     for (const char *textPtr = text; *textPtr != 0; ++textPtr)
     {
         if (*textPtr < '0' || *textPtr > '9')
         {
             setText(mText.substr(0, textPtr - text));
             return;
         }
     }
 }

References mNumeric, mText, and setText().

Referenced by EditServerDialog::EditServerDialog(), and Setup_Colors::Setup_Colors().

◆ setParent()

void TextField::setParent ( Widget * parent )

virtual

Sets the parent of the widget. A parent must be a BasicContainer.

WARNING: This function is used internally and should not be called or overloaded unless you know what you are doing.

Parameters

parent The parent of the widget.

See also: getParent

Reimplemented from Widget.

Definition at line 823 of file textfield.cpp.

 {
     if (mWindow != nullptr)
         mWindow->addWidgetListener(this);
     Widget::setParent(widget);
 }

References Widget::addWidgetListener(), Widget2::mWindow, and Widget::setParent().

◆ setRange()

void TextField::setRange	(	const int	min,
		const int	max
	)

inline

Set the range on the field if it is numeric

Definition at line 137 of file textfield.h.

         {
             mMinimum = min;
             mMaximum = max;
         }

References mMaximum, and mMinimum.

Referenced by EditServerDialog::EditServerDialog(), Setup_Colors::Setup_Colors(), and Setup_Colors::valueChanged().

◆ setSendAlwaysEvents()

void TextField::setSendAlwaysEvents ( const bool b )

inline

Definition at line 166 of file textfield.h.

167 { mSendAlwaysEvents = b; }

References mSendAlwaysEvents.

Referenced by BuyDialog::init().

◆ setText()

void TextField::setText ( const std::string & text )

Sets the text of the text field.

Parameters

text	The text of the text field.

See also: getText

Definition at line 803 of file textfield.cpp.

 {
     const unsigned int sz = CAST_U32(text.size());
     if (sz < mCaretPosition)
         mCaretPosition = sz;
     mText = text;
     mTextChanged = true;
 }

References CAST_U32, mCaretPosition, mText, and mTextChanged.

Referenced by Pincode::action(), SetupItemTextField::action(), Setup_Colors::action(), ChatWindow::action(), NpcDialog::action(), RegisterDialog::action(), TradeWindow::action(), ChatWindow::addInputText(), ChatWindow::autoComplete(), EditDialog::EditDialog(), EditServerDialog::EditServerDialog(), handlePaste(), TradeWindow::initTrade(), IntTextField::keyPressed(), ChatWindow::keyPressed(), LoginDialog::LoginDialog(), LoginDialog::postInit(), TradeWindow::reset(), Setup_Colors::setEntry(), MailEditWindow::setMessage(), setNumeric(), MailEditWindow::setSubject(), TextDialog::setText(), MailEditWindow::setTo(), IntTextField::setValue(), TextCommandEditor::TextCommandEditor(), NpcDialog::textRequest(), SetupItemTextField::toWidget(), and SetupItemIntTextField::toWidget().

◆ setWindow()

void TextField::setWindow ( Widget *const widget )

virtual

Reimplemented from Widget2.

Definition at line 830 of file textfield.cpp.

 {
     if ((widget == nullptr) && (mWindow != nullptr))
     {
         mWindow->removeWidgetListener(this);
         mWindow = nullptr;
     }
     else
     {
         Widget2::setWindow(widget);
     }
 }

References Widget2::mWindow, Widget::removeWidgetListener(), and Widget2::setWindow().

◆ signalEvent()

void TextField::signalEvent ( )

Definition at line 843 of file textfield.cpp.

 {
     distributeActionEvent();
 }

References Widget::distributeActionEvent().

Referenced by Pincode::action().

◆ updateAlpha()

void TextField::updateAlpha ( )

Update the alpha value to the graphic components.

Definition at line 194 of file textfield.cpp.

 {
     const float alpha = std::max(settings.guiAlpha,
         theme->getMinimumOpacity());
  
     if (alpha != mAlpha)
     {
         mAlpha = alpha;
         for (int a = 0; a < 9; a++)
         {
             if (skin.grid[a] != nullptr)
                 skin.grid[a]->setAlpha(mAlpha);
         }
     }
 }

References Theme::getMinimumOpacity(), ImageRect::grid, Settings::guiAlpha, mAlpha, settings, skin, and theme.

Referenced by draw().

◆ widgetHidden()

void TextField::widgetHidden ( const Event & event )

virtual

Invoked when a widget is hidden, i.e it's set to be not visible.

Parameters

event Describes the event.

Reimplemented from WidgetListener.

Definition at line 817 of file textfield.cpp.

 {
     mTextChanged = true;
     mTextChunk.deleteImage();
 }

References TextChunk::deleteImage(), mTextChanged, and mTextChunk.

Field Documentation

◆ instances

int TextField::instances = 0

staticprotected

Definition at line 280 of file textfield.h.

Referenced by TextField(), and ~TextField().

◆ mAllowSpecialActions

bool TextField::mAllowSpecialActions

protected

Definition at line 289 of file textfield.h.

Referenced by handleCtrlKeys(), and setAllowSpecialActions().

◆ mAlpha

float TextField::mAlpha = 1.0

staticprotected

Definition at line 281 of file textfield.h.

Referenced by updateAlpha().

◆ mCaretColor

const Color* TextField::mCaretColor

protected

Definition at line 279 of file textfield.h.

Referenced by drawCaret().

◆ mCaretPosition

unsigned int TextField::mCaretPosition

protected

Holds the caret position.

Definition at line 270 of file textfield.h.

Referenced by caretDelete(), caretDeleteToStart(), caretDeleteWord(), draw(), fixScroll(), getCaretPosition(), getTextBeforeCaret(), handleCtrlKeys(), handleNormalKeys(), keyPressed(), mousePressed(), moveCaretBack(), moveCaretForward(), moveCaretWordBack(), moveCaretWordForward(), setCaretPosition(), and setText().

◆ mLastEventPaste

time_t TextField::mLastEventPaste

protected

Definition at line 285 of file textfield.h.

Referenced by handleCtrlKeys(), and keyPressed().

◆ mLoseFocusOnTab

LoseFocusOnTab TextField::mLoseFocusOnTab

protected

Definition at line 288 of file textfield.h.

Referenced by handleNormalKeys().

◆ mMaximum

int TextField::mMaximum

protected

Definition at line 284 of file textfield.h.

Referenced by getValue(), keyPressed(), setMaximum(), and setRange().

◆ mMinimum

int TextField::mMinimum

protected

Definition at line 283 of file textfield.h.

Referenced by getValue(), setMinimum(), and setRange().

◆ mNumeric

bool TextField::mNumeric

protected

Definition at line 287 of file textfield.h.

Referenced by getValue(), keyPressed(), and setNumeric().

◆ mPadding

int TextField::mPadding

protected

Definition at line 286 of file textfield.h.

Referenced by adjustHeight(), adjustSize(), draw(), drawCaret(), fixScroll(), and TextField().

◆ mSendAlwaysEvents

bool TextField::mSendAlwaysEvents

protected

Definition at line 290 of file textfield.h.

Referenced by IntTextField::keyPressed(), keyPressed(), and setSendAlwaysEvents().

◆ mSkin

Skin * TextField::mSkin

staticprotected

Definition at line 258 of file textfield.h.

Referenced by TextField(), and ~TextField().

◆ mText

std::string TextField::mText

protected

Holds the text of the text box.

Definition at line 263 of file textfield.h.

Referenced by adjustSize(), caretDelete(), caretDeleteToStart(), caretDeleteWord(), PasswordField::draw(), draw(), fixScroll(), getText(), getTextBeforeCaret(), getValue(), handleCtrlKeys(), handleNormalKeys(), keyPressed(), mousePressed(), moveCaretBack(), moveCaretForward(), moveCaretWordBack(), moveCaretWordForward(), setCaretPosition(), setNumeric(), and setText().

◆ mTextChanged

bool TextField::mTextChanged

protected

Definition at line 291 of file textfield.h.

Referenced by caretDelete(), caretDeleteToStart(), caretDeleteWord(), draw(), handleCtrlKeys(), handleNormalKeys(), keyPressed(), setText(), and widgetHidden().

◆ mTextChunk

TextChunk TextField::mTextChunk

protected

Definition at line 265 of file textfield.h.

Referenced by draw(), widgetHidden(), and ~TextField().

◆ mXScroll

int TextField::mXScroll

protected

Holds the amount scrolled in x. If a user types more characters than the text field can display, due to the text field being to small, the text needs to scroll in order to show the last type character.

Definition at line 277 of file textfield.h.

Referenced by draw(), fixScroll(), and mousePressed().

◆ skin

ImageRect TextField::skin

staticprotected

Definition at line 282 of file textfield.h.

Referenced by drawFrame(), safeDrawFrame(), TextField(), updateAlpha(), and ~TextField().

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

src/gui/widgets/textfield.h (986a3bf)
src/gui/widgets/textfield.cpp (986a3bf)

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextField()

◆ ~TextField()

Member Function Documentation

◆ adjustHeight()

◆ adjustSize()

◆ caretDelete()

◆ caretDeleteToStart()

◆ caretDeleteWord()

◆ draw()

◆ drawCaret()

◆ drawFrame()

◆ fixScroll()

◆ focusGained()

◆ focusLost()

◆ fontChanged()

◆ getCaretPosition()

◆ getText()

◆ getTextBeforeCaret()

◆ getValue()

◆ handleCopy()

◆ handleCtrlKeys()

◆ handleNormalKeys()

◆ handlePaste()

◆ keyPressed()

◆ mouseDragged()

◆ mousePressed()

◆ moveCaretBack()

◆ moveCaretForward()

◆ moveCaretWordBack()

◆ moveCaretWordForward()

◆ safeDraw()

◆ safeDrawFrame()

◆ setAllowSpecialActions()

◆ setCaretPosition()

◆ setMaximum()

◆ setMinimum()

◆ setNumeric()

◆ setParent()

◆ setRange()

◆ setSendAlwaysEvents()

◆ setText()

◆ setWindow()

◆ signalEvent()

◆ updateAlpha()

◆ widgetHidden()

Field Documentation

◆ instances

◆ mAllowSpecialActions

◆ mAlpha

◆ mCaretColor

◆ mCaretPosition

◆ mLastEventPaste

◆ mLoseFocusOnTab

◆ mMaximum

◆ mMinimum

◆ mNumeric

◆ mPadding

◆ mSendAlwaysEvents

◆ mSkin

◆ mText

◆ mTextChanged

◆ mTextChunk

◆ mXScroll

◆ skin