#include <textbox.h>

Inheritance diagram for TextBox:

Public Member Functions
	TextBox (const Widget2 *const widget)

	~TextBox ()

void	setTextWrapped (const std::string &text, const int minDimension)

int	getMinWidth () const

void	keyPressed (KeyEvent &event)

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	setForegroundColor (const Color &color)

void	setForegroundColorAll (const Color &color1, const Color &color2)

void	setText (const std::string &text)

std::string	getText () const

const std::string &	getTextRow (const int row) const

void	setTextRow (const int row, const std::string &text)

unsigned int	getNumberOfRows () const

unsigned int	getCaretPosition () const

void	setCaretPosition (unsigned int position)

unsigned int	getCaretRow () const

void	setCaretRow (const int row)

unsigned int	getCaretColumn () const

void	setCaretColumn (const int column)

void	setCaretRowColumn (const int row, const int column)

void	scrollToCaret ()

bool	isEditable () const

void	setEditable (const bool editable)

void	addRow (const std::string &row)

bool	isOpaque () const

void	setOpaque (const Opaque opaque)

void	fontChanged ()

void	mousePressed (MouseEvent &event)

void	mouseDragged (MouseEvent &event)

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

	~Widget ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

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

virtual void	setParent (Widget *parent)

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

virtual void	setWindow (Widget *const window)

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 KeyListener
virtual	~KeyListener ()

virtual void	keyReleased (KeyEvent &event)

Private Member Functions
void	drawCaret (Graphics *const graphics, const int x, const int y) const

void	adjustSize ()

Private Attributes
std::vector< std::string >	mTextRows

int	mCaretColumn

int	mCaretRow

int	mMinWidth

bool	mEditable

Opaque	mOpaque

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

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

Protected Member Functions inherited from KeyListener
	KeyListener ()

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 inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

A text box, meant to be used inside a scroll area. Same as the Guichan text box except this one doesn't have a background or border, instead completely relying on the scroll area.

Definition at line 86 of file textbox.h.

Constructor & Destructor Documentation

◆ TextBox()

TextBox::TextBox ( const Widget2 *const widget )

explicit

Constructor.

Definition at line 79 of file textbox.cpp.

                                             :
     Widget(widget),
     MouseListener(),
     KeyListener(),
     mTextRows(),
     mCaretColumn(0),
     mCaretRow(0),
     mMinWidth(getWidth()),
     mEditable(true),
     mOpaque(Opaque_true)
 {
     mAllowLogic = false;
     setText("");
     setFocusable(true);
  
     addMouseListener(this);
     addKeyListener(this);
     adjustSize();
  
     mForegroundColor = getThemeColor(ThemeColorId::TEXTBOX, 255U);
     setOpaque(Opaque_false);
     setFrameSize(0);
 }

References Widget::addKeyListener(), Widget::addMouseListener(), adjustSize(), Widget2::getThemeColor(), Widget::mAllowLogic, Widget::mForegroundColor, Opaque_false, Widget::setFocusable(), Widget::setFrameSize(), setOpaque(), and setText().

◆ ~TextBox()

TextBox::~TextBox ( )

Definition at line 103 of file textbox.cpp.

 {
     if (gui != nullptr)
         gui->removeDragged(this);
 }

References gui, and Gui::removeDragged().

Member Function Documentation

◆ addRow()

void TextBox::addRow ( const std::string & row )

Adds a row of text to the end of the text.

Parameters

row	The row to add.

Definition at line 596 of file textbox.cpp.

 {
     mTextRows.push_back(row);
     adjustSize();
 }

References adjustSize(), and mTextRows.

◆ adjustSize()

void TextBox::adjustSize ( )

private

Adjusts the text box's size to fit the text.

Definition at line 635 of file textbox.cpp.

 {
     int width = 0;
     const Font *const font = getFont();
     for (size_t i = 0, sz = mTextRows.size(); i < sz; ++i)
     {
         const int w = font->getWidth(mTextRows[i]);
         if (width < w)
             width = w;
     }
  
     setWidth(width + 1);
     setHeight(font->getHeight() * CAST_S32(mTextRows.size()));
 }

References CAST_S32, Widget::getFont(), Font::getHeight(), Font::getWidth(), mTextRows, Widget::setHeight(), and Widget::setWidth().

Referenced by addRow(), fontChanged(), keyPressed(), setText(), setTextRow(), and TextBox().

◆ draw()

void TextBox::draw ( Graphics *const graphics )

virtual

Draws the widget. It is called by the parent widget when it is time for the widget to draw itself. The graphics object is set up so that all drawing is relative to the widget, i.e coordinate (0,0) is the top left corner of the widget. It is not possible to draw outside of a widget's dimension.

Parameters

graphics aA graphics object to draw with.

Implements Widget.

Definition at line 446 of file textbox.cpp.

 {
     BLOCK_START("TextBox::draw")
     if (mOpaque == Opaque_true)
     {
         graphics->setColor(mBackgroundColor);
         graphics->fillRectangle(Rect(0, 0, getWidth(), getHeight()));
     }
  
     Font *const font = getFont();
     if (isFocused() && isEditable())
     {
         drawCaret(graphics, font->getWidth(
             mTextRows[mCaretRow].substr(0, mCaretColumn)),
             mCaretRow * font->getHeight());
     }
  
     const int fontHeight = font->getHeight();
  
     for (size_t i = 0, sz = mTextRows.size(); i < sz; i++)
     {
         // Move the text one pixel so we can have a caret before a letter.
         font->drawString(graphics,
             mForegroundColor,
             mForegroundColor2,
             mTextRows[i], 1,
             CAST_S32(i * CAST_SIZE(fontHeight)));
     }
     BLOCK_END("TextBox::draw")
 }

References BLOCK_END, BLOCK_START, CAST_S32, CAST_SIZE, drawCaret(), Font::drawString(), Graphics::fillRectangle(), Widget::getFont(), Font::getHeight(), Widget::getHeight(), Widget::getWidth(), Font::getWidth(), isEditable(), Widget::isFocused(), Widget::mBackgroundColor, mCaretColumn, mCaretRow, Widget::mForegroundColor, Widget2::mForegroundColor2, mOpaque, mTextRows, Opaque_true, and Graphics::setColor().

Referenced by safeDraw().

◆ drawCaret()

void TextBox::drawCaret	(	Graphics *const	graphics,
		const int	x,
		const int	y
	)		const

private

Draws the caret. Overloaded this method if you want to change the style of the caret.

Parameters

graphics	a Graphics object to draw with.
x	the x position.
y	the y position.

Definition at line 627 of file textbox.cpp.

 {
     graphics->setColor(mForegroundColor);
     graphics->drawLine(x, getFont()->getHeight() + y, x, y);
 }

References Graphics::drawLine(), Widget::getFont(), Widget::getHeight(), Widget::mForegroundColor, Graphics::setColor(), x, and y.

Referenced by draw().

◆ fontChanged()

void TextBox::fontChanged ( )

inlinevirtual

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 276 of file textbox.h.

277 { adjustSize(); }

References adjustSize().

◆ getCaretColumn()

unsigned int TextBox::getCaretColumn ( ) const

Gets the column where the caret is currently located.

Returns: The column where the caret is currently located.

See also: setCaretColumn

◆ getCaretPosition()

unsigned int TextBox::getCaretPosition ( ) const

Gets the caret position in the text.

Returns: The caret position in the text.

See also: setCaretPosition

Definition at line 556 of file textbox.cpp.

 {
     int pos = 0;
  
     for (int row = 0; row < mCaretRow; row++)
         pos += CAST_S32(mTextRows[row].size());
  
     return pos + mCaretColumn;
 }

References CAST_S32, mCaretColumn, mCaretRow, mTextRows, and EmoteDB::size().

◆ getCaretRow()

unsigned int TextBox::getCaretRow ( ) const

inline

Gets the row number where the caret is currently located.

Returns: The row number where the caret is currently located.

See also: setCaretRow

Definition at line 187 of file textbox.h.

188 { return mCaretRow; }

References mCaretRow.

◆ getMinWidth()

int TextBox::getMinWidth ( ) const

inline

Get the minimum text width for the text box.

Definition at line 108 of file textbox.h.

109 { return mMinWidth; }

References mMinWidth.

Referenced by OkDialog::OkDialog(), ConfirmDialog::postInit(), ItemPopup::setItem(), and SkillPopup::show().

◆ getNumberOfRows()

unsigned int TextBox::getNumberOfRows ( ) const

inline

Gets the number of rows in the text.

Returns: The number of rows in the text.

Definition at line 162 of file textbox.h.

163 { return CAST_S32(mTextRows.size()); }

References CAST_S32, and mTextRows.

Referenced by ConfirmDialog::postInit(), ItemPopup::setItem(), and SkillPopup::show().

◆ getText()

std::string TextBox::getText ( ) const

Gets the text of the text box.

Returns: The text of the text box.

See also: setText

Definition at line 495 of file textbox.cpp.

 {
     if (mTextRows.empty())
         return std::string();
  
     int i;
     std::string text;
  
     const int sz = CAST_S32(mTextRows.size());
     for (i = 0; i < sz - 1; ++ i)
         text.append(mTextRows[i]).append("\n");
     text.append(mTextRows[i]);
  
     return text;
 }

References CAST_S32, and mTextRows.

◆ getTextRow()

const std::string& TextBox::getTextRow ( const int row ) const

inline

Gets a certain row from the text.

Parameters

row	The number of the row to get from the text.

Returns: A row from the text of the text box.

See also: setTextRow

Definition at line 145 of file textbox.h.

146 { return mTextRows[row]; }

References mTextRows.

◆ isEditable()

bool TextBox::isEditable ( ) const

inline

Checks if the text box is editable.

Returns: True it the text box is editable, false otherwise.

See also: setEditable

Definition at line 237 of file textbox.h.

238 { return mEditable; }

References mEditable.

Referenced by draw().

◆ isOpaque()

bool TextBox::isOpaque ( ) const

inline

Checks if the text box is opaque. An opaque text box will draw it's background and it's text. A non opaque text box only draw it's text making it transparent.

Returns: True if the text box is opaque, false otherwise.

See also: setOpaque

Definition at line 262 of file textbox.h.

263 { return mOpaque == Opaque_true; }

References mOpaque, and Opaque_true.

◆ keyPressed()

void TextBox::keyPressed ( KeyEvent & event )

virtual

Called if a key is pressed when the widget has keyboard focus. If a key is held down the widget will generate multiple key presses.

Parameters

event Discribes the event.

Reimplemented from KeyListener.

Definition at line 258 of file textbox.cpp.

 {
     const Key &key = event.getKey();
     const InputActionT action = event.getActionId();
  
     PRAGMA45(GCC diagnostic push)
     PRAGMA45(GCC diagnostic ignored "-Wswitch-enum")
     switch (action)
     {
         case InputAction::GUI_LEFT:
         {
             --mCaretColumn;
             if (mCaretColumn < 0)
             {
                 --mCaretRow;
  
                 if (mCaretRow < 0)
                 {
                     mCaretRow = 0;
                     mCaretColumn = 0;
                 }
                 else
                 {
                     mCaretColumn = CAST_S32(
                         mTextRows[mCaretRow].size());
                 }
             }
             break;
         }
  
         case InputAction::GUI_RIGHT:
         {
             ++mCaretColumn;
             if (mCaretColumn > CAST_S32(mTextRows[mCaretRow].size()))
             {
                 ++ mCaretRow;
  
                 const int sz = CAST_S32(mTextRows.size());
                 if (mCaretRow >= sz)
                 {
                     mCaretRow = sz - 1;
                     if (mCaretRow < 0)
                         mCaretRow = 0;
  
                     mCaretColumn = CAST_S32(
                         mTextRows[mCaretRow].size());
                 }
                 else
                 {
                     mCaretColumn = 0;
                 }
             }
             break;
         }
  
         case InputAction::GUI_DOWN:
         {
             setCaretRow(mCaretRow + 1);
             break;
         }
         case InputAction::GUI_UP:
         {
             setCaretRow(mCaretRow - 1);
             break;
         }
         case InputAction::GUI_HOME:
         {
             mCaretColumn = 0;
             break;
         }
         case InputAction::GUI_END:
         {
             mCaretColumn = CAST_S32(mTextRows[mCaretRow].size());
             break;
         }
  
         case InputAction::GUI_SELECT2:
         {
             if (mEditable)
             {
                 mTextRows.insert(mTextRows.begin() + mCaretRow + 1,
                     mTextRows[mCaretRow].substr(mCaretColumn,
                     mTextRows[mCaretRow].size() - mCaretColumn));
                 mTextRows[mCaretRow].resize(mCaretColumn);
                 ++mCaretRow;
                 mCaretColumn = 0;
             }
             break;
         }
  
         case InputAction::GUI_BACKSPACE:
         {
             if (mCaretColumn != 0 && mEditable)
             {
                 mTextRows[mCaretRow].erase(mCaretColumn - 1, 1);
                 --mCaretColumn;
             }
             else if (mCaretColumn == 0 && mCaretRow != 0 && mEditable)
             {
                 mCaretColumn = CAST_S32(
                     mTextRows[mCaretRow - 1].size());
                 mTextRows[mCaretRow - 1] += mTextRows[mCaretRow];
                 mTextRows.erase(mTextRows.begin() + mCaretRow);
                 --mCaretRow;
             }
             break;
         }
  
         case InputAction::GUI_DELETE:
         {
             if (mCaretColumn < CAST_S32(
                 mTextRows[mCaretRow].size()) && mEditable)
             {
                 mTextRows[mCaretRow].erase(mCaretColumn, 1);
             }
             else if (mCaretColumn == CAST_S32(
                      mTextRows[mCaretRow].size()) &&
                      mCaretRow < (CAST_S32(mTextRows.size()) - 1) &&
                      mEditable)
             {
                 mTextRows[mCaretRow] += mTextRows[mCaretRow + 1];
                 mTextRows.erase(mTextRows.begin() + mCaretRow + 1);
             }
             break;
         }
  
         case InputAction::GUI_PAGE_UP:
         {
             Widget *const par = getParent();
  
             if (par != nullptr)
             {
                 const int rowsPerPage = par->getChildrenArea().height
                     / getFont()->getHeight();
                 mCaretRow -= rowsPerPage;
  
                 if (mCaretRow < 0)
                     mCaretRow = 0;
             }
             break;
         }
  
         case InputAction::GUI_PAGE_DOWN:
         {
             Widget *const par = getParent();
  
             if (par != nullptr)
             {
                 const int rowsPerPage = par->getChildrenArea().height
                     / getFont()->getHeight();
                 mCaretRow += rowsPerPage;
  
                 const int sz = CAST_S32(mTextRows.size());
                 if (mCaretRow >= sz)
                     mCaretRow = sz - 1;
             }
             break;
         }
  
         case InputAction::GUI_TAB:
         {
             if (mEditable)
             {
                 mTextRows[mCaretRow].insert(mCaretColumn, std::string("    "));
                 mCaretColumn += 4;
             }
             break;
         }
  
         default:
         {
             if (key.isCharacter() && mEditable)
             {
                 mTextRows[mCaretRow].insert(mCaretColumn,
                     std::string(1, CAST_S8(key.getValue())));
                 ++ mCaretColumn;
             }
             break;
         }
     }
     PRAGMA45(GCC diagnostic pop)
  
     adjustSize();
     scrollToCaret();
  
     event.consume();
 }

References adjustSize(), CAST_S32, CAST_S8, Widget::getChildrenArea(), Widget::getFont(), Font::getHeight(), Widget::getParent(), Key::getValue(), InputAction::GUI_BACKSPACE, InputAction::GUI_DELETE, InputAction::GUI_DOWN, InputAction::GUI_END, InputAction::GUI_HOME, InputAction::GUI_LEFT, InputAction::GUI_PAGE_DOWN, InputAction::GUI_PAGE_UP, InputAction::GUI_RIGHT, InputAction::GUI_SELECT2, InputAction::GUI_TAB, InputAction::GUI_UP, Rect::height, Key::isCharacter(), mCaretColumn, mCaretRow, mEditable, mTextRows, PRAGMA45(), scrollToCaret(), setCaretRow(), and EmoteDB::size().

◆ mouseDragged()

void TextBox::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 622 of file textbox.cpp.

 {
     event.consume();
 }

◆ mousePressed()

void TextBox::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 602 of file textbox.cpp.

 {
     if (event.getButton() == MouseButton::LEFT)
     {
         const int height = getFont()->getHeight();
         if (height == 0)
             return;
  
         event.consume();
         mCaretRow = event.getY() / height;
  
         const int sz = CAST_S32(mTextRows.size());
         if (mCaretRow >= sz)
             mCaretRow = sz - 1;
  
         mCaretColumn = getFont()->getStringIndexAt(
             mTextRows[mCaretRow], event.getX());
     }
 }

References CAST_S32, MouseEvent::getButton(), Widget::getFont(), Font::getHeight(), Font::getStringIndexAt(), MouseEvent::getX(), MouseButton::LEFT, mCaretColumn, mCaretRow, and mTextRows.

◆ safeDraw()

void TextBox::safeDraw ( Graphics *const graphics )

virtual

Implements Widget.

Definition at line 477 of file textbox.cpp.

 {
     TextBox::draw(graphics);
 }

References draw().

◆ scrollToCaret()

void TextBox::scrollToCaret ( )

Scrolls the text to the caret if the text box is in a scroll area.

See also: ScrollArea

Definition at line 584 of file textbox.cpp.

 {
     const Font *const font = getFont();
     Rect scroll;
     scroll.x = font->getWidth(mTextRows[mCaretRow].substr(0, mCaretColumn));
     scroll.y = font->getHeight() * mCaretRow;
     scroll.width = font->getWidth(" ");
     // add 2 for some extra space
     scroll.height = font->getHeight() + 2;
     showPart(scroll);
 }

References Widget::getFont(), Font::getHeight(), Font::getWidth(), Rect::height, mCaretColumn, mCaretRow, mTextRows, Widget::showPart(), Rect::width, Rect::x, and Rect::y.

Referenced by keyPressed().

◆ setCaretColumn()

void TextBox::setCaretColumn ( const int column )

Sets the column where the caret should be currently located.

Parameters

The	column where the caret should be currently located.

See also: getCaretColumn

Definition at line 566 of file textbox.cpp.

 {
     mCaretColumn = column;
  
     const int sz = CAST_S32(mTextRows[mCaretRow].size());
     if (mCaretColumn > sz)
         mCaretColumn = sz;
  
     if (mCaretColumn < 0)
         mCaretColumn = 0;
 }

References CAST_S32, mCaretColumn, mCaretRow, mTextRows, and EmoteDB::size().

Referenced by setCaretRow(), setCaretRowColumn(), and setTextRow().

◆ setCaretPosition()

void TextBox::setCaretPosition ( unsigned int position )

Sets the position of the caret in the text.

Parameters

position the positon of the caret.

See also: getCaretPosition

Definition at line 521 of file textbox.cpp.

 {
     for (int row = 0, fsz = CAST_S32(mTextRows.size());
          row < fsz;
          row ++)
     {
         if (position <= mTextRows[row].size())
         {
             mCaretRow = row;
             mCaretColumn = position;
             return;  // we are done
         }
  
         position--;
     }
  
     // position beyond end of text
     mCaretRow = CAST_S32(mTextRows.size() - 1);
     mCaretColumn = CAST_S32(mTextRows[mCaretRow].size());
 }

References CAST_S32, mCaretColumn, mCaretRow, mTextRows, and EmoteDB::size().

◆ setCaretRow()

void TextBox::setCaretRow ( const int row )

Sets the row where the caret should be currently located.

Parameters

The	row where the caret should be currently located.

See also: getCaretRow

Definition at line 542 of file textbox.cpp.

 {
     mCaretRow = row;
  
     const int sz = CAST_S32(mTextRows.size());
     if (mCaretRow >= sz)
         mCaretRow = sz - 1;
  
     if (mCaretRow < 0)
         mCaretRow = 0;
  
     setCaretColumn(mCaretColumn);
 }

References CAST_S32, mCaretColumn, mCaretRow, mTextRows, and setCaretColumn().

Referenced by keyPressed(), and setCaretRowColumn().

◆ setCaretRowColumn()

void TextBox::setCaretRowColumn	(	const int	row,
		const int	column
	)

Sets the row and the column where the caret should be curretly located.

Parameters

row	The row where the caret should be currently located.
column	The column where the caret should be currently located.

See also: getCaretRow, getCaretColumn

Definition at line 578 of file textbox.cpp.

 {
     setCaretRow(row);
     setCaretColumn(column);
 }

References setCaretColumn(), and setCaretRow().

◆ setEditable()

void TextBox::setEditable ( const bool editable )

Sets the text box to be editable or not.

Parameters

editable True if the text box should be editable, false otherwise.

Definition at line 650 of file textbox.cpp.

 {
     mEditable = editable;
     mSelectable = editable;
 }

References mEditable, and Widget::mSelectable.

Referenced by ConfirmDialog::ConfirmDialog(), ItemPopup::ItemPopup(), OkDialog::OkDialog(), TextBoxPopup::postInit(), and SkillPopup::SkillPopup().

◆ setForegroundColor()

void TextBox::setForegroundColor ( const Color & color )

Definition at line 482 of file textbox.cpp.

 {
     mForegroundColor = color;
     mForegroundColor2 = color;
 }

References Widget::mForegroundColor, and Widget2::mForegroundColor2.

◆ setForegroundColorAll()

void TextBox::setForegroundColorAll	(	const Color &	color1,
		const Color &	color2
	)

Definition at line 488 of file textbox.cpp.

 {
     mForegroundColor = color1;
     mForegroundColor2 = color2;
 }

References Widget::mForegroundColor, and Widget2::mForegroundColor2.

Referenced by ItemPopup::ItemPopup(), TextBoxPopup::postInit(), and SkillPopup::SkillPopup().

◆ setOpaque()

void TextBox::setOpaque ( const Opaque opaque )

inline

Sets the text box to be opaque or not. An opaque text box will draw it's background and it's text. A non opaque text box only draw it's text making it transparent.

Parameters

opaque True if the text box should be opaque, false otherwise.

See also: isOpaque

Definition at line 273 of file textbox.h.

274 { mOpaque = opaque; }

References mOpaque.

Referenced by ConfirmDialog::ConfirmDialog(), OkDialog::OkDialog(), TextBoxPopup::postInit(), and TextBox().

◆ setText()

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

Sets the text of the text box.

Parameters

text	The text of the text box.

See also: getText

Definition at line 227 of file textbox.cpp.

 {
     mCaretColumn = 0;
     mCaretRow = 0;
  
     mTextRows.clear();
     if (text.empty())
     {
         adjustSize();
         return;
     }
  
     size_t pos;
     size_t lastPos = 0;
     int length;
     do
     {
         pos = text.find('\n', lastPos);
  
         if (pos != std::string::npos)
             length = CAST_S32(pos - lastPos);
         else
             length = CAST_S32(text.size() - lastPos);
         std::string sub = text.substr(lastPos, length);
         mTextRows.push_back(sub);
         lastPos = pos + 1;
     } while (pos != std::string::npos);
  
     adjustSize();
 }

References adjustSize(), CAST_S32, mCaretColumn, mCaretRow, and mTextRows.

Referenced by setTextWrapped(), and TextBox().

◆ setTextRow()

void TextBox::setTextRow	(	const int	row,
		const std::string &	text
	)

Sets the text of a certain row of the text.

Parameters

row	The number of the row to set in the text.
text	The text to set in the given row number.

See also: getTextRow

Definition at line 511 of file textbox.cpp.

 {
     mTextRows[row] = text;
  
     if (mCaretRow == row)
         setCaretColumn(mCaretColumn);
  
     adjustSize();
 }

References adjustSize(), mCaretColumn, mCaretRow, mTextRows, and setCaretColumn().

◆ setTextWrapped()

void TextBox::setTextWrapped	(	const std::string &	text,
		const int	minDimension
	)

Sets the text after wrapping it to the current width of the widget.

Definition at line 109 of file textbox.cpp.

 {
     // Make sure parent scroll area sets width of this widget
     if (getParent() != nullptr)
         getParent()->logic();
  
     // Take the supplied minimum dimension as a starting
     // point and try to beat it
     mMinWidth = minDimension;
  
     const size_t textSize = text.size();
     size_t spacePos = text.rfind(' ', textSize);
  
     if (spacePos != std::string::npos)
     {
         const std::string word = text.substr(spacePos + 1);
         const int length = getFont()->getWidth(word);
  
         if (length > mMinWidth)
             mMinWidth = length;
     }
  
     std::stringstream wrappedStream;
     size_t newlinePos;
     size_t lastNewlinePos = 0;
     int minWidth = 0;
     int xpos;
  
     do
     {
         // Determine next piece of string to wrap
         newlinePos = text.find('\n', lastNewlinePos);
  
         if (newlinePos == std::string::npos)
             newlinePos = textSize;
  
         std::string line =
             text.substr(lastNewlinePos, newlinePos - lastNewlinePos);
         size_t lastSpacePos = 0;
         xpos = 0;
         const Font *const font = getFont();
         const int spaceWidth = font->getWidth(" ");
         size_t sz = line.size();
  
         do
         {
             spacePos = line.find(' ', lastSpacePos);
  
             if (spacePos == std::string::npos)
                 spacePos = sz;
  
             const std::string word =
                 line.substr(lastSpacePos, spacePos - lastSpacePos);
  
             const int width = font->getWidth(word);
  
             if (xpos == 0 && width > mMinWidth)
             {
                 mMinWidth = width;
                 xpos = width;
                 wrappedStream << word;
             }
             else if (xpos != 0 && xpos + spaceWidth + width <=
                      mMinWidth)
             {
                 xpos += spaceWidth + width;
                 wrappedStream << " " << word;
             }
             else if (lastSpacePos == 0)
             {
                 xpos += width;
                 wrappedStream << word;
             }
             else
             {
                 if (xpos > minWidth)
                     minWidth = xpos;
  
                 // The window wasn't big enough. Resize it and try again.
                 if (minWidth > mMinWidth)
                 {
                     mMinWidth = minWidth;
                     wrappedStream.clear();
                     wrappedStream.str("");
                     lastNewlinePos = 0;
                     newlinePos = text.find('\n', lastNewlinePos);
                     if (newlinePos == std::string::npos)
                         newlinePos = textSize;
                     line = text.substr(lastNewlinePos, newlinePos -
                                        lastNewlinePos);
                     sz = line.size();
                     break;
                 }
                 else
                 {
                     wrappedStream << "\n" << word;
                 }
                 xpos = width;
             }
             lastSpacePos = spacePos + 1;
         }
         while (spacePos != sz);
  
         if (text.find('\n', lastNewlinePos) != std::string::npos)
             wrappedStream << "\n";
  
         lastNewlinePos = newlinePos + 1;
     }
     while (newlinePos != textSize);
  
     if (xpos > minWidth)
         minWidth = xpos;
  
     mMinWidth = minWidth;
  
     setText(wrappedStream.str());
 }

References Widget::getFont(), Widget::getParent(), Font::getWidth(), Widget::logic(), mMinWidth, and setText().

Referenced by ConfirmDialog::ConfirmDialog(), OkDialog::OkDialog(), ItemPopup::setItem(), TextBoxPopup::show(), and SkillPopup::show().

Field Documentation

◆ mCaretColumn

int TextBox::mCaretColumn

private

Holds the current column of the caret.

Definition at line 309 of file textbox.h.

Referenced by draw(), getCaretPosition(), keyPressed(), mousePressed(), scrollToCaret(), setCaretColumn(), setCaretPosition(), setCaretRow(), setText(), and setTextRow().

◆ mCaretRow

int TextBox::mCaretRow

private

Holds the current row of the caret.

Definition at line 314 of file textbox.h.

Referenced by draw(), getCaretPosition(), getCaretRow(), keyPressed(), mousePressed(), scrollToCaret(), setCaretColumn(), setCaretPosition(), setCaretRow(), setText(), and setTextRow().

◆ mEditable

bool TextBox::mEditable

private

True if the text box is editable, false otherwise.

Definition at line 321 of file textbox.h.

Referenced by isEditable(), keyPressed(), and setEditable().

◆ mMinWidth

int TextBox::mMinWidth

private

Definition at line 316 of file textbox.h.

Referenced by getMinWidth(), and setTextWrapped().

◆ mOpaque

Opaque TextBox::mOpaque

private

True if the text box is editable, false otherwise.

Definition at line 326 of file textbox.h.

Referenced by draw(), isOpaque(), and setOpaque().

◆ mTextRows

std::vector<std::string> TextBox::mTextRows

private

Holds all the rows of the text.

Definition at line 304 of file textbox.h.

Referenced by addRow(), adjustSize(), draw(), getCaretPosition(), getNumberOfRows(), getText(), getTextRow(), keyPressed(), mousePressed(), scrollToCaret(), setCaretColumn(), setCaretPosition(), setCaretRow(), setText(), and setTextRow().

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextBox()

◆ ~TextBox()

Member Function Documentation

◆ addRow()

◆ adjustSize()

◆ draw()

◆ drawCaret()

◆ fontChanged()

◆ getCaretColumn()

◆ getCaretPosition()

◆ getCaretRow()

◆ getMinWidth()

◆ getNumberOfRows()

◆ getText()

◆ getTextRow()

◆ isEditable()

◆ isOpaque()

◆ keyPressed()

◆ mouseDragged()

◆ mousePressed()

◆ safeDraw()

◆ scrollToCaret()

◆ setCaretColumn()

◆ setCaretPosition()

◆ setCaretRow()

◆ setCaretRowColumn()

◆ setEditable()

◆ setForegroundColor()

◆ setForegroundColorAll()

◆ setOpaque()

◆ setText()

◆ setTextRow()

◆ setTextWrapped()

Field Documentation

◆ mCaretColumn

◆ mCaretRow

◆ mEditable

◆ mMinWidth

◆ mOpaque

◆ mTextRows