#include <textbox.hpp>

Inheritance diagram for fcn::TextBox:

Public Member Functions
virtual void	addRow (std::string const &row)
void	adjustSize () override
void	draw (Graphics *graphics) override
void	fontChanged () override
unsigned int	getCaretColumn () const
unsigned int	getCaretPosition () const
unsigned int	getCaretRow () const
unsigned int	getNumberOfRows () const
std::string	getText () const
std::string	getTextRow (int row) const
bool	isEditable () const
bool	isOpaque () const
void	keyPressed (KeyEvent &keyEvent) override
void	mouseDragged (MouseEvent &mouseEvent) override
void	mousePressed (MouseEvent &mouseEvent) override
TextBox &	operator= (TextBox &&)=delete
TextBox &	operator= (TextBox const &)=delete
void	resizeToContent (bool recursion=true) override
virtual void	scrollToCaret ()
void	setCaretColumn (int column)
void	setCaretPosition (unsigned int position)
void	setCaretRow (int row)
void	setCaretRowColumn (int row, int column)
void	setEditable (bool editable)
void	setOpaque (bool opaque)
void	setText (std::string const &text)
void	setTextRow (int row, std::string const &text)
	TextBox (std::string const &text="")
	TextBox (TextBox &&)=delete
	TextBox (TextBox const &)=delete
void	textInput (TextInputEvent &event) override
Public Member Functions inherited from fcn::Widget
virtual void	_draw (Graphics *graphics)
virtual FocusHandler *	_getFocusHandler ()
virtual std::list< FocusListener * > const &	_getFocusListeners ()
virtual FocusHandler *	_getInternalFocusHandler ()
virtual std::list< KeyListener * > const &	_getKeyListeners ()
virtual std::list< MouseListener * > const &	_getMouseListeners ()
virtual void	_logic ()
virtual void	_setFocusHandler (FocusHandler *focusHandler)
virtual void	_setParent (Widget *parent)
void	adaptLayout ()
virtual void	adaptLayout (bool top)
void	addActionListener (ActionListener *actionListener)
void	addDeathListener (DeathListener *deathListener)
void	addDropTargetListener (DropTargetListener *listener)
void	addFocusListener (FocusListener *focusListener)
void	addKeyListener (KeyListener *keyListener)
void	addMouseListener (MouseListener *mouseListener)
void	addWidgetListener (WidgetListener *widgetListener)
bool	captureMouse ()
bool	contains (int x, int y) const
virtual void	drawBorder (Graphics *graphics)
void	drawBorder (Graphics *graphics, unsigned int sides) const
virtual void	drawOutline (Graphics *graphics)
virtual void	drawSelectionFrame (Graphics *graphics)
void	expandContent ()
virtual void	expandContent (bool recursion)
virtual void	focusNext ()
virtual void	focusPrevious ()
virtual void	getAbsolutePosition (int &x, int &y) const
std::string const &	getActionEventId () const
Color const &	getBackgroundColor () const
Color const &	getBaseColor () const
Color const &	getBorderColor () const
unsigned int	getBorderSides () const
unsigned int	getBorderSize () const
unsigned int	getBorderStyle () const
virtual Rectangle	getChildrenArea ()
unsigned int	getChildrenCount () const
Rectangle const &	getDimension () const
Size const &	getFixedSize () const
Font *	getFont () const
Color const &	getForegroundColor () const
int	getHeight () const
std::string const &	getId () const
void	getLastPosition (int &x, int &y) const
int	getMarginBottom () const
int	getMarginLeft () const
int	getMarginRight () const
int	getMarginTop () const
Size const &	getMaxSize () const
Size const &	getMinSize () const
Color const &	getOutlineColor () const
unsigned int	getOutlineSize () const
unsigned int	getPaddingBottom () const
unsigned int	getPaddingLeft () const
unsigned int	getPaddingRight () const
unsigned int	getPaddingTop () const
virtual Widget *	getParent () const
Color const &	getSelectionColor () const
SelectionMode	getSelectionMode () const
virtual Widget *	getTop () const
unsigned int	getVisibleChildrenCount () const
Widget *	getWidgetAt (int x, int y)
virtual Widget *	getWidgetAt (int x, int y, Widget *exclude)
std::list< Widget * >	getWidgetsIn (Rectangle const &area)
virtual std::list< Widget * >	getWidgetsIn (Rectangle const &area, Widget *ignore)
int	getWidth () const
int	getX () const
int	getY () const
bool	hasMouseCapture () const
bool	isDescendantOf (Widget const *ancestor) const noexcept
bool	isEnabled () const
bool	isFixedSize () const
bool	isFocusable () const
virtual bool	isFocused () const
bool	isHorizontalExpand () const
bool	isInsideActiveMouseModal () const noexcept
bool	isLastPositionSet () const
virtual bool	isLayouted ()
virtual bool	isModalFocusable () const
virtual bool	isModalFocused () const
virtual bool	isModalMouseInputFocusable () const
bool	isMouseInside (MouseEvent const &mouseEvent) const
bool	isSetVisible () const
bool	isTabInEnabled () const
bool	isTabOutEnabled () const
virtual bool	isUnderMouseModal () const
bool	isVerticalExpand () const
bool	isVisible () const
virtual void	logic ()
virtual void	moveToBottom (Widget *widget)
virtual void	moveToTop (Widget *widget)
virtual void	onFocusChanged ()
virtual void	onFocusGained ()
virtual void	onFocusLost ()
Widget &	operator= (Widget &&)=delete
Widget &	operator= (Widget const &)=delete
void	releaseMouse ()
void	removeActionListener (ActionListener *actionListener)
void	removeDeathListener (DeathListener *deathListener)
void	removeDropTargetListener (DropTargetListener *listener)
void	removeFocusListener (FocusListener *focusListener)
void	removeKeyListener (KeyListener *keyListener)
void	removeMouseListener (MouseListener *mouseListener)
void	removeWidgetListener (WidgetListener *widgetListener)
virtual void	requestFocus ()
virtual void	requestMoveToBottom ()
virtual void	requestMoveToTop ()
void	setActionEventId (std::string const &actionEventId)
virtual void	setBackgroundColor (Color const &color)
virtual void	setBaseColor (Color const &color)
void	setBorderBottom (unsigned int size, unsigned int style)
virtual void	setBorderColor (Color const &color)
void	setBorderSides (unsigned int sides)
void	setBorderSize (unsigned int size)
void	setBorderStyle (unsigned int style)
void	setBorderTop (unsigned int size, unsigned int style)
virtual void	setDimension (Rectangle const &dimension)
void	setEnabled (bool enabled)
void	setFixedSize (Size const &size)
void	setFocusable (bool focusable)
virtual void	setFocused (bool focused)
virtual void	setFont (Font *font)
virtual void	setForegroundColor (Color const &color)
virtual void	setHeight (int height)
void	setHorizontalExpand (bool expand)
void	setId (std::string const &id)
void	setInternalFocusHandler (FocusHandler *internalFocusHandler)
void	setLastPosition (int x, int y)
void	setMargin (int margin)
void	setMarginBottom (int margin)
void	setMarginLeft (int margin)
void	setMarginRight (int margin)
void	setMarginTop (int margin)
void	setMaxSize (Size const &size)
void	setMinSize (Size const &size)
virtual void	setOutlineColor (Color const &color)
void	setOutlineSize (unsigned int size)
void	setPadding (unsigned int padding)
void	setPaddingBottom (unsigned int padding)
void	setPaddingLeft (unsigned int padding)
void	setPaddingRight (unsigned int padding)
void	setPaddingTop (unsigned int padding)
void	setPosition (int x, int y)
virtual void	setSelectionColor (Color const &color)
virtual void	setSelectionMode (SelectionMode mode)
virtual void	setSize (int width, int height)
void	setTabInEnabled (bool enabled)
void	setTabOutEnabled (bool enabled)
void	setVerticalExpand (bool expand)
void	setVisible (bool visible)
virtual void	setWidth (int width)
void	setX (int x)
void	setY (int y)
virtual void	showPart (Rectangle rectangle)
virtual void	showWidgetPart (Widget *widget, Rectangle area)
	Widget ()
	Widget (Widget &&)=delete
	Widget (Widget const &)=delete
Public Member Functions inherited from fcn::MouseListener
virtual void	mouseClicked (MouseEvent &mouseEvent)
virtual void	mouseEntered (MouseEvent &mouseEvent)
virtual void	mouseExited (MouseEvent &mouseEvent)
	MouseListener (MouseListener &&)=default
	MouseListener (MouseListener const &)=default
virtual void	mouseMoved (MouseEvent &mouseEvent)
virtual void	mouseReleased (MouseEvent &mouseEvent)
virtual void	mouseWheelMovedDown (MouseEvent &mouseEvent)
virtual void	mouseWheelMovedLeft (MouseEvent &mouseEvent)
virtual void	mouseWheelMovedRight (MouseEvent &mouseEvent)
virtual void	mouseWheelMovedUp (MouseEvent &mouseEvent)
MouseListener &	operator= (MouseListener &&)=default
MouseListener &	operator= (MouseListener const &)=default
Public Member Functions inherited from fcn::KeyListener
	KeyListener (KeyListener &&)=default
	KeyListener (KeyListener const &)=default
virtual void	keyReleased (KeyEvent &keyEvent)
KeyListener &	operator= (KeyListener &&)=default
KeyListener &	operator= (KeyListener const &)=default

Protected Member Functions
void	adjustSizeImpl ()
virtual void	drawCaret (Graphics *graphics, int x, int y)
void	setCaretColumnUTF8 (int column)
void	setCaretRowColumnUTF8 (int row, int column)
void	setCaretRowUTF8 (int row)
Protected Member Functions inherited from fcn::Widget
void	add (Widget *widget)
void	calculateSize ()
void	distributeActionEvent ()
void	distributeAncestorHiddenEvent (Widget *ancestor)
void	distributeAncestorMovedEvent (Widget *ancestor)
void	distributeAncestorShownEvent (Widget *ancestor)
void	distributeDragDrop (DragEvent &event)
bool	distributeDragEnter (DragEvent &event)
void	distributeDragHover (DragEvent &event)
void	distributeDragLeave (DragEvent &event)
void	distributeHiddenEvent ()
void	distributeMovedEvent ()
void	distributeResizedEvent ()
void	distributeShownEvent ()
virtual Widget *	findWidgetById (std::string const &id)
std::list< Widget * > const &	getChildren () const
virtual void	remove (Widget *widget)
virtual void	removeAllChildren ()
void	resizeToChildren ()
Protected Member Functions inherited from fcn::MouseListener
	MouseListener ()=default
Protected Member Functions inherited from fcn::KeyListener
	KeyListener ()=default

Protected Attributes
bool	mEditable {true}
bool	mOpaque {true}
UTF8StringEditor *	mStringEditor
Text *	mText
Protected Attributes inherited from fcn::Widget
std::string	mActionEventId
std::list< ActionListener * >	mActionListeners
Color	mBackgroundColor {0xf9fafb}
Color	mBaseColor {0xe5e7eb}
Color	mBorderColor {0xd1d5db}
unsigned int	mBorderSides {BORDER_ALL}
unsigned int	mBorderSize {0}
unsigned int	mBorderStyle {BORDER_STYLE_FLAT}
std::list< Widget * >	mChildren
Font *	mCurrentFont {nullptr}
std::list< DeathListener * >	mDeathListeners
Rectangle	mDimension
std::list< DropTargetListener * >	mDropTargetListeners
bool	mEnabled {true}
Size	mFixedSize {-1, -1}
bool	mFixedSizeUsed {false}
bool	mFocusable {false}
bool	mFocused {false}
FocusHandler *	mFocusHandler {nullptr}
std::list< FocusListener * >	mFocusListeners
Color	mForegroundColor {0x1f2933}
bool	mHExpand {false}
std::string	mId
FocusHandler *	mInternalFocusHandler {nullptr}
std::list< KeyListener * >	mKeyListeners
int	mLastX {0}
int	mLastY {0}
int	mMarginBottom {0}
int	mMarginLeft {0}
int	mMarginRight {0}
int	mMarginTop {0}
Size	mMaxSize {std::numeric_limits<int>::max(), std::numeric_limits<int>::max()}
Size	mMinSize {0, 0}
std::list< MouseListener * >	mMouseListeners
Rectangle	mOffsetRect
Color	mOutlineColor {0x9ca3af}
unsigned int	mOutlineSize {0}
unsigned int	mPaddingBottom {0}
unsigned int	mPaddingLeft {0}
unsigned int	mPaddingRight {0}
unsigned int	mPaddingTop {0}
Widget *	mParent {nullptr}
Color	mSelectionColor {0x3b82f6}
SelectionMode	mSelectionMode {SelectionMode::None}
bool	mTabIn {true}
bool	mTabOut {true}
bool	mVExpand {false}
bool	mVisible {true}
std::list< WidgetListener * >	mWidgetListeners

Additional Inherited Members
Public Types inherited from fcn::Widget
enum	BorderSide : uint8_t { BORDER_NONE = 0 , BORDER_LEFT = 1 << 0 , BORDER_TOP = 1 << 1 , BORDER_RIGHT = 1 << 2 , BORDER_BOTTOM = 1 << 3 , BORDER_ALL = BORDER_LEFT \| BORDER_TOP \| BORDER_RIGHT \| BORDER_BOTTOM }
enum	BorderStyle : uint8_t { BORDER_STYLE_BEVEL = 0 , BORDER_STYLE_FLAT = 1 }
enum class	SelectionMode : uint8_t { None = 0 , Border = 1 , Background = 2 }
Static Public Member Functions inherited from fcn::Widget
static DeathListener *	_getGuiDeathListener ()
static VisibilityEventHandler *	_getVisibilityEventHandler ()
static void	_setGuiDeathListener (DeathListener *deathListener)
static void	_setVisibilityEventHandler (VisibilityEventHandler *visibilityEventHandler)
static Widget *	getMouseCapture ()
static void	resetGlobalFont ()
static void	setGlobalFont (Font *font)
static bool	widgetExists (Widget const *widget)
Static Protected Attributes inherited from fcn::Widget
static DefaultFont	mDefaultFont
static Font *	mGlobalFont = nullptr
static DeathListener *	mGuiDeathListener = nullptr
static VisibilityEventHandler *	mVisibilityEventHandler = nullptr
static std::list< Widget * >	mWidgetInstances
static Widget *	sMouseCapture = nullptr

Detailed Description

A multi-line text input field.

Definition at line 31 of file textbox.hpp.

Constructor & Destructor Documentation

◆ TextBox()

fcn::TextBox::TextBox ( std::string const & text = "" )

explicit

Constructor.

Parameters

text	The default text of the text box.

Definition at line 26 of file textbox.cpp.

References fcn::Widget::addKeyListener(), fcn::Widget::addMouseListener(), adjustSizeImpl(), mStringEditor, mText, and fcn::Widget::setFocusable().

◆ ~TextBox()

fcn::TextBox::~TextBox ( )

override

Definition at line 38 of file textbox.cpp.

Member Function Documentation

◆ addRow()

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

virtual

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

Parameters

row	The row to add.

Definition at line 354 of file textbox.cpp.

References adjustSizeImpl(), and mText.

◆ adjustSize()

void fcn::TextBox::adjustSize ( )

overridevirtual

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

Reimplemented from fcn::Widget.

Definition at line 230 of file textbox.cpp.

References adjustSizeImpl().

◆ adjustSizeImpl()

void fcn::TextBox::adjustSizeImpl ( )

protected

Adjusts the size of the button to fit the caption.

The public adjustSize() method serves as a virtual entry point for polymorphism, while this adjustSizeImpl() method contains the concrete implementation of the resizing logic.

See also: adjustSize (virtual entry point for polymorphism)

Definition at line 235 of file textbox.cpp.

References fcn::Widget::getFont(), fcn::Widget::getHeight(), fcn::Widget::getWidth(), fcn::Rectangle::height, fcn::Widget::isFixedSize(), fcn::Widget::isHorizontalExpand(), fcn::Widget::isVerticalExpand(), mText, fcn::Widget::setSize(), and fcn::Rectangle::width.

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

◆ draw()

void fcn::TextBox::draw ( Graphics * graphics )

overridevirtual

Draws the widget.

The call to draw is initiated by the widget's parent. 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. If a widget has children, the parent's draw function will always be called before the children's draw functions are called.

Note: A widget with children won't draw its children unless the children area given by Widget::getChildrenArea returns a none empty rectangle inside the widgets dimension. The children area is considered relative to the widget's position.

Parameters

graphics A graphics object to draw with.

See also: getChildrenArea, drawOutline, drawBorder

Implements fcn::Widget.

Definition at line 52 of file textbox.cpp.

References drawCaret(), fcn::Graphics::drawText(), fcn::Graphics::fillRectangle(), fcn::Widget::getBackgroundColor(), fcn::Widget::getFont(), fcn::Widget::getForegroundColor(), fcn::Widget::getHeight(), fcn::Widget::getWidth(), isEditable(), fcn::Widget::isFocused(), mOpaque, mText, fcn::Graphics::setColor(), and fcn::Graphics::setFont().

◆ drawCaret()

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

protectedvirtual

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 75 of file textbox.cpp.

References fcn::Graphics::drawLine(), fcn::Widget::getFont(), fcn::Widget::getForegroundColor(), fcn::Widget::getHeight(), and fcn::Graphics::setColor().

Referenced by draw().

◆ fontChanged()

void fcn::TextBox::fontChanged ( )

overridevirtual

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 fcn::Widget.

Definition at line 332 of file textbox.cpp.

References adjustSizeImpl().

◆ getCaretColumn()

unsigned int fcn::TextBox::getCaretColumn ( ) const

Gets the column where the caret is currently located.

Returns: The column where the caret is currently located.

See also: setCaretColumn

Definition at line 299 of file textbox.cpp.

References mText.

Referenced by keyPressed(), setCaretRowUTF8(), and textInput().

◆ getCaretPosition()

unsigned int fcn::TextBox::getCaretPosition ( ) const

Gets the caret position in the text.

Returns: The caret position in the text.

See also: setCaretPosition

Definition at line 269 of file textbox.cpp.

References mText.

◆ getCaretRow()

unsigned int fcn::TextBox::getCaretRow ( ) const

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 288 of file textbox.cpp.

References mText.

Referenced by keyPressed(), setCaretColumnUTF8(), setCaretRowUTF8(), and textInput().

◆ getNumberOfRows()

unsigned int fcn::TextBox::getNumberOfRows ( ) const

Gets the number of rows in the text.

Returns: The number of rows in the text.

Definition at line 322 of file textbox.cpp.

References mText.

Referenced by getTextRow(), keyPressed(), setCaretRowUTF8(), and setTextRow().

◆ getText()

std::string fcn::TextBox::getText ( ) const

Gets the text of the text box.

Returns: The text of the text box.

See also: setText

Definition at line 327 of file textbox.cpp.

References mText.

◆ getTextRow()

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

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 304 of file textbox.cpp.

References getNumberOfRows(), and mText.

Referenced by keyPressed(), setCaretColumnUTF8(), and setCaretRowUTF8().

◆ isEditable()

bool fcn::TextBox::isEditable ( ) const

Checks if the text box is editable.

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

See also: setEditable

Definition at line 349 of file textbox.cpp.

References mEditable.

Referenced by draw().

◆ isOpaque()

bool fcn::TextBox::isOpaque ( ) const

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 362 of file textbox.cpp.

References mOpaque.

◆ keyPressed()

void fcn::TextBox::keyPressed ( KeyEvent & keyEvent )

overridevirtual

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

keyEvent Describes the event.

Reimplemented from fcn::KeyListener.

Definition at line 98 of file textbox.cpp.

References adjustSizeImpl(), fcn::InputEvent::consume(), fcn::UTF8StringEditor::countChars(), fcn::UTF8StringEditor::eraseChar(), getCaretColumn(), getCaretRow(), fcn::Widget::getChildrenArea(), fcn::Widget::getFont(), fcn::Font::getHeight(), fcn::KeyEvent::getKey(), getNumberOfRows(), fcn::UTF8StringEditor::getOffset(), fcn::Widget::getParent(), getTextRow(), fcn::Rectangle::height, mEditable, mText, fcn::UTF8StringEditor::nextChar(), fcn::UTF8StringEditor::prevChar(), scrollToCaret(), setCaretColumn(), setCaretRow(), setCaretRowUTF8(), and fcn::Widget::Widget().

◆ mouseDragged()

void fcn::TextBox::mouseDragged ( MouseEvent & mouseEvent )

overridevirtual

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

Parameters

mouseEvent Describes the event.

Reimplemented from fcn::MouseListener.

Definition at line 93 of file textbox.cpp.

References fcn::InputEvent::consume().

◆ mousePressed()

void fcn::TextBox::mousePressed ( MouseEvent & mouseEvent )

overridevirtual

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

Note: A mouse press is NOT equal to a mouse click. Use mouseClicked() for "pressed AND released" (full click) on a widget.

See also: mouseClicked

Parameters

mouseEvent Describes the event.

Reimplemented from fcn::MouseListener.

Definition at line 83 of file textbox.cpp.

References fcn::InputEvent::consume(), fcn::MouseEvent::getButton(), fcn::Widget::getFont(), fcn::MouseEvent::getX(), fcn::MouseEvent::getY(), and mText.

◆ resizeToContent()

void fcn::TextBox::resizeToContent ( bool recursion = true )

overridevirtual

Resizes the widget's size to fit the content exactly, calls recursively all childs.

The default value true allows callers to use resizeToContent() without argument.

Parameters

recursion If true, perform the resize operation recursively on children.

Reimplemented from fcn::Widget.

Definition at line 224 of file textbox.cpp.

References adjustSizeImpl().

◆ scrollToCaret()

void fcn::TextBox::scrollToCaret ( )

virtual

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

See also: ScrollArea

Definition at line 337 of file textbox.cpp.

References fcn::Widget::getFont(), mText, and fcn::Widget::showPart().

Referenced by keyPressed(), and textInput().

◆ setCaretColumn()

void fcn::TextBox::setCaretColumn ( int column )

Sets the column where the caret should be currently located.

Parameters

column The column where the caret should be currently located.

See also: getCaretColumn

Definition at line 293 of file textbox.cpp.

References mText.

Referenced by keyPressed(), setCaretColumnUTF8(), setCaretRowUTF8(), and textInput().

◆ setCaretColumnUTF8()

void fcn::TextBox::setCaretColumnUTF8 ( int column )

protected

Sets caret column (UTF-8 aware).

Parameters

column Caret column.

Definition at line 372 of file textbox.cpp.

References getCaretRow(), fcn::UTF8StringEditor::getOffset(), getTextRow(), and setCaretColumn().

Referenced by setCaretRowColumnUTF8().

◆ setCaretPosition()

void fcn::TextBox::setCaretPosition ( unsigned int position )

Sets the position of the caret in the text.

Parameters

position the position of the caret.

See also: getCaretPosition

Definition at line 263 of file textbox.cpp.

References mText.

◆ setCaretRow()

void fcn::TextBox::setCaretRow ( int row )

Sets the row where the caret should be currently located.

Parameters

row	The row where the caret should be currently located.

See also: getCaretRow

Definition at line 282 of file textbox.cpp.

References mText.

Referenced by keyPressed(), and setCaretRowUTF8().

◆ setCaretRowColumn()

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

Sets the row and the column where the caret should be currently 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 274 of file textbox.cpp.

References mText.

◆ setCaretRowColumnUTF8()

void fcn::TextBox::setCaretRowColumnUTF8	(	int	row,
		int	column )

protected

Sets the caret row and column (UTF-8 aware).

Parameters

row	Caret row (UTF-8 aware index).
column	Caret column (UTF-8 aware index).

Definition at line 392 of file textbox.cpp.

References setCaretColumnUTF8(), and setCaretRowUTF8().

◆ setCaretRowUTF8()

void fcn::TextBox::setCaretRowUTF8 ( int row )

protected

Sets caret row (UTF-8 aware).

Parameters

row	Caret row.

Definition at line 380 of file textbox.cpp.

References fcn::UTF8StringEditor::countChars(), getCaretColumn(), getCaretRow(), getNumberOfRows(), fcn::UTF8StringEditor::getOffset(), getTextRow(), setCaretColumn(), and setCaretRow().

Referenced by keyPressed(), and setCaretRowColumnUTF8().

◆ setEditable()

void fcn::TextBox::setEditable ( 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 344 of file textbox.cpp.

References mEditable.

◆ setOpaque()

void fcn::TextBox::setOpaque ( bool opaque )

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 367 of file textbox.cpp.

References mOpaque.

◆ setText()

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

Sets the text of the text box.

Parameters

text	The text of the text box.

See also: getText

Definition at line 44 of file textbox.cpp.

References adjustSizeImpl(), and mText.

◆ setTextRow()

void fcn::TextBox::setTextRow	(	int	row,
		std::string const &	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 312 of file textbox.cpp.

References adjustSizeImpl(), getNumberOfRows(), and mText.

◆ textInput()

void fcn::TextBox::textInput ( TextInputEvent & event )

overridevirtual

Called when text input (IME, dead-key, paste) is received.

Override this to handle text input in your widget. The default implementation does nothing.

Parameters

event The text input event containing the UTF-8 text.

Reimplemented from fcn::Widget.

Definition at line 213 of file textbox.cpp.

References adjustSizeImpl(), getCaretColumn(), getCaretRow(), mEditable, mText, scrollToCaret(), and setCaretColumn().

Member Data Documentation

◆ mEditable

bool fcn::TextBox::mEditable {true}

protected

True if the text box is editable, false otherwise.

Definition at line 277 of file textbox.hpp.

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

◆ mOpaque

bool fcn::TextBox::mOpaque {true}

protected

True if the text box is opaque, false otherwise.

Definition at line 282 of file textbox.hpp.

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

◆ mStringEditor

UTF8StringEditor* fcn::TextBox::mStringEditor

protected

UTF8StringEditor for UTF8 support.

Definition at line 287 of file textbox.hpp.

Referenced by TextBox().

◆ mText

Text* fcn::TextBox::mText

protected

Holds the text of the text box.

Definition at line 272 of file textbox.hpp.

Referenced by addRow(), adjustSizeImpl(), draw(), getCaretColumn(), getCaretPosition(), getCaretRow(), getNumberOfRows(), getText(), getTextRow(), keyPressed(), mousePressed(), scrollToCaret(), setCaretColumn(), setCaretPosition(), setCaretRow(), setCaretRowColumn(), setText(), setTextRow(), TextBox(), and textInput().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextBox()

◆ ~TextBox()

Member Function Documentation

◆ addRow()

◆ adjustSize()

◆ adjustSizeImpl()

◆ draw()

◆ drawCaret()

◆ fontChanged()

◆ getCaretColumn()

◆ getCaretPosition()

◆ getCaretRow()

◆ getNumberOfRows()

◆ getText()

◆ getTextRow()

◆ isEditable()

◆ isOpaque()

◆ keyPressed()

◆ mouseDragged()

◆ mousePressed()

◆ resizeToContent()

◆ scrollToCaret()

◆ setCaretColumn()

◆ setCaretColumnUTF8()

◆ setCaretPosition()

◆ setCaretRow()

◆ setCaretRowColumn()

◆ setCaretRowColumnUTF8()

◆ setCaretRowUTF8()

◆ setEditable()

◆ setOpaque()

◆ setText()

◆ setTextRow()

◆ textInput()

Member Data Documentation

◆ mEditable

◆ mOpaque

◆ mStringEditor

◆ mText