#include <iWidgetLineTextEdit.h>

Inherits igor::iWidget.

Public Member Functions
	iWidgetLineTextEdit (const iWidgetPtr parent=nullptr)

virtual	~iWidgetLineTextEdit ()=default

void	setHorizontalTextAlignment (iHorizontalAlignment align)

iHorizontalAlignment	getHorizontalTextAlignment () const

void	setVerticalTextAlignment (iVerticalAlignment valign)

iVerticalAlignment	getVerticalTextAlignment () const

void	setMaxTextLength (int32 chars)

int32	getMaxTextLength ()

void	setWriteProtected (bool writeProtected)

bool	isWriteProtected ()

void	setChangeEventAtOnce ()

void	setChangeEventOnEnterAndLostFocus ()

void	setText (const iaString &text)

const iaString &	getText () const

void	setCursorPos (uint64 cursorPos)

uint64	getCursorPos () const

uint64	getCursorPosPix () const

void	incCursorPos ()

void	decCursorPos ()

Public Member Functions inherited from igor::iWidget
iWidgetType	getWidgetType () const

iWidgetKind	getWidgetKind () const

void	setZValue (uint32 zvalue)

uint32	getZValue () const

void	setBackground (const iaColor4f &color)

const iaColor4f &	getBackground () const

void	setForeground (const iaColor4f &color)

const iaColor4f &	getForeground () const

bool	isBlocked () const

bool	hasKeyboardFocus () const

iWidgetState	getState () const

iClickEvent &	getClickEvent ()

iMouseOffClickEvent &	getMouseOffClickEvent ()

iDoubleClickEvent &	getDoubleClickEvent ()

iMouseOverEvent &	getMouseOverEvent ()

iMouseOffEvent &	getMouseOffEvent ()

iChangeEvent &	getChangeEvent ()

iFocusEvent &	getFocusEvent ()

iWheelUpEvent &	getWheelUpEvent ()

iWheelDownEvent &	getWheelDownEvent ()

iContextMenuEvent &	getContextMenuEvent ()

iSelectionChangedEvent &	getSelectionChangedEvent ()

iaVector2f	getActualPos () const

int32	getActualPosX () const

int32	getActualPosY () const

int32	getActualWidth () const

int32	getActualHeight () const

iaRectanglef	getActualRect () const

iaRectanglef	getActualClientRect () const

int32	getRelativePosX () const

int32	getRelativePosY () const

int32	getMinWidth () const

int32	getMinHeight () const

int32	getConfiguredMinWidth () const

int32	getConfiguredMinHeight () const

void	setMinWidth (int32 width)

void	setMinHeight (int32 height)

void	setMinSize (int32 width, int32 height)

void	setAcceptOutOfBoundsClicks (bool acceptOutOfBoundsClick=true)

bool	getAcceptOutOfBoundsClicks () const

iHorizontalAlignment	getHorizontalAlignment () const

iVerticalAlignment	getVerticalAlignment () const

void	setHorizontalAlignment (iHorizontalAlignment horizontalAlignment)

void	setVerticalAlignment (iVerticalAlignment verticalAlignment)

bool	isVisible () const

bool	isEnabled () const

void	setVisible (bool visible=true)

void	setEnabled (bool enabled=true)

iWidgetID	getID () const

iWidgetID	getParentID () const

iWidgetPtr	getParent () const

bool	isMouseOver ()

void	setAcceptDrag (bool acceptDrag)

bool	isAcceptingDrag ()

void	setAcceptDrop (bool acceptDrop)

bool	isAcceptingDrop ()

bool	hasParent () const

void	setGrowingByContent (bool grow=true)

bool	isGrowingByContent () const

iaString	getInfo () const

void	setTooltip (const iaString &text)

iaString	getTooltip () const

const std::vector< iWidgetPtr > &	getChildren () const

virtual void	clear ()

void	setIgnoreChildEventConsumption (bool value=true)

bool	isIgnoringChildEventConsumption () const

iWidgetPtr	getRoot ()

virtual void	blockEvents ()

virtual void	unblockEvents ()

void	setOverlayEnabled (bool overlay)

bool	isOverlayEnabled () const

virtual void	draw ()

virtual void	drawOverlay ()

virtual void	addWidget (iWidgetPtr widget)

virtual void	removeWidget (iWidgetPtr widget)

void	setCursor (iMouseCursorType cursorType)

void	setUserData (const std::any &userData)

std::any	getUserData () const

void	setSelectable (bool selectable)

bool	isSelectable () const

void	setMultiSelection (bool enabled)

bool	isMultiSelectionEnabled () const

void	setSelect (bool select)

bool	isSelected () const

void	clearSelection ()

const std::vector< iWidgetPtr >	getSelection () const

void	setSelection (const std::vector< iWidgetPtr > &selection)

void	refresh ()

Protected Member Functions
bool	onASCII (const iEventKeyASCII &event) override

virtual bool	onKeyDown (const iEventKeyDown &event) override

virtual bool	onKeyUp (const iEventKeyUp &event) override

virtual void	onGainedKeyboardFocus () override

virtual void	onLostKeyboardFocus () override

void	handleChanges ()

Protected Member Functions inherited from igor::iWidget
void	clearChildren ()

void	updateMinSize (int32 width, int32 height)

void	setParent (iWidgetPtr parent)

void	setKeyboardFocus ()

void	resetKeyboardFocus ()

void	setClientArea (int32 left, int32 right, int32 top, int32 bottom)

const iaVector2f &	getLastMousePos () const

	iWidget (iWidgetType type, iWidgetKind kind, const iWidgetPtr parent=nullptr)

virtual	~iWidget ()

virtual bool	onEvent (iEvent &event)

virtual bool	onMouseWheel (const iEventMouseWheel &event)

virtual bool	onMouseKeyDown (const iEventMouseKeyDown &event)

virtual bool	onMouseDoubleClick (const iEventMouseKeyDoubleClick &event)

virtual bool	onMouseKeyUp (const iEventMouseKeyUp &event)

virtual void	onMouseMove (const iEventMouseMove &event)

virtual bool	onASCII (const iEventKeyASCII &event)

virtual bool	onKeyDown (const iEventKeyDown &event)

virtual bool	onKeyUp (const iEventKeyUp &event)

virtual void	onLostKeyboardFocus ()

virtual void	onGainedKeyboardFocus ()

virtual void	calcMinSize ()

virtual void	updateAlignment (int32 clientWidth, int32 clientHeight)

virtual void	calcChildOffsets (std::vector< iaRectanglef > &offsets)

virtual void	onDragEnter (iDrag &drag)

virtual void	onDragMove (iDrag &drag, const iaVector2f &mousePos)

virtual void	onDragLeave (iDrag &drag)

virtual void	onDrop (const iDrag &drag, const iaVector2f &mousePos)

virtual void	onDrag ()

virtual void	onRefresh ()

Protected Attributes
iHorizontalAlignment	_horizontalTextAlignment = iHorizontalAlignment::Left

iVerticalAlignment	_verticalTextAlignment = iVerticalAlignment::Center

bool	_triggerChangeAtOnce = false

iaString	_text

iaString	_textBackup

Protected Attributes inherited from igor::iWidget
bool	_selected = false

bool	_isSelectable = false

bool	_isMultiSelectionEnabled = false

std::vector< iWidgetPtr >	_children

int32	_configuredMinWidth = 0

int32	_configuredMinHeight = 0

iClickEvent	_click

iMouseOffClickEvent	_mouseOffClick

iContextMenuEvent	_contextMenu

iDoubleClickEvent	_doubleClick

iMouseOverEvent	_mouseOver

iMouseOffEvent	_mouseOff

iChangeEvent	_change

iFocusEvent	_focus

iWheelUpEvent	_wheelUp

iWheelDownEvent	_wheelDown

iSelectionChangedEvent	_selectionChanged

iaString	_tooltip

iaVector2f	_tooltipPos

iaTime	_tooltipTime = iaTime(0)

bool	_initTooltip = false

uint32	_zValue = 0

bool	_reactOnMouseWheel = true

bool	_blockedEvents = false

bool	_acceptOutOfBoundsClicks = false

bool	_acceptDrop = false

bool	_acceptDrag = false

bool	_isMouseOver = false

bool	_ignoreChildEventConsumption = false

iaVector2f	_lastMousePos

iaVector2f	_lastMousePressPos

bool	_needRefresh = true

Additional Inherited Members
Static Public Member Functions inherited from igor::iWidget
static iWidgetPtr	getKeyboardFocusWidget ()

static IGOR_INLINE float32	getScale ()

Static Public Attributes inherited from igor::iWidget
static const iWidgetID	INVALID_WIDGET_ID = 0

Detailed Description

single line text edit widget

Constructor & Destructor Documentation

◆ iWidgetLineTextEdit()

igor::iWidgetLineTextEdit::iWidgetLineTextEdit ( const iWidgetPtr parent = nullptr )

initializes member variables

Parameters

parent optional parent

◆ ~iWidgetLineTextEdit()

virtual igor::iWidgetLineTextEdit::~iWidgetLineTextEdit ( )

virtualdefault

deinitializes member variables

Member Function Documentation

◆ decCursorPos()

void igor::iWidgetLineTextEdit::decCursorPos ( )

decrease cursor pos by one

◆ getCursorPos()

uint64 igor::iWidgetLineTextEdit::getCursorPos ( ) const

◆ getCursorPosPix()

uint64 igor::iWidgetLineTextEdit::getCursorPosPix ( ) const

◆ getHorizontalTextAlignment()

iHorizontalAlignment igor::iWidgetLineTextEdit::getHorizontalTextAlignment ( ) const

Returns: horizontal text alignment

◆ getMaxTextLength()

int32 igor::iWidgetLineTextEdit::getMaxTextLength ( )

Returns: the max length of text in characters

◆ getText()

const iaString & igor::iWidgetLineTextEdit::getText ( ) const

Returns: the text

◆ getVerticalTextAlignment()

iVerticalAlignment igor::iWidgetLineTextEdit::getVerticalTextAlignment ( ) const

Returns: vertical text alignment

◆ handleChanges()

void igor::iWidgetLineTextEdit::handleChanges ( )

protected

triggers a change event if the content has changed

◆ incCursorPos()

void igor::iWidgetLineTextEdit::incCursorPos ( )

increase cursor pos by one

◆ isWriteProtected()

bool igor::iWidgetLineTextEdit::isWriteProtected ( )

\retruns if text edit is write protected

◆ onASCII()

bool igor::iWidgetLineTextEdit::onASCII ( const iEventKeyASCII & event )

overrideprotectedvirtual

handles incoming acsii codes from keyboard

Parameters

event the key ascii event

Reimplemented from igor::iWidget.

◆ onGainedKeyboardFocus()

void igor::iWidgetLineTextEdit::onGainedKeyboardFocus ( )

overrideprotectedvirtual

handles gained kayboard focus

Reimplemented from igor::iWidget.

◆ onKeyDown()

bool igor::iWidgetLineTextEdit::onKeyDown ( const iEventKeyDown & event )

overrideprotectedvirtual

handles incoming released key events

Parameters

event the key down event

Reimplemented from igor::iWidget.

◆ onKeyUp()

bool igor::iWidgetLineTextEdit::onKeyUp ( const iEventKeyUp & event )

overrideprotectedvirtual

handles incoming released key events

Parameters

event the key up event

Reimplemented from igor::iWidget.

◆ onLostKeyboardFocus()

void igor::iWidgetLineTextEdit::onLostKeyboardFocus ( )

overrideprotectedvirtual

handles lost keyboard focus

Reimplemented from igor::iWidget.

◆ setChangeEventAtOnce()

void igor::iWidgetLineTextEdit::setChangeEventAtOnce ( )

set up that the change event will only triggered if you press enter

◆ setChangeEventOnEnterAndLostFocus()

void igor::iWidgetLineTextEdit::setChangeEventOnEnterAndLostFocus ( )

set up that the change event will be triggered for every change in the text field

◆ setCursorPos()

void igor::iWidgetLineTextEdit::setCursorPos ( uint64 cursorPos )

sets cursor pos

cursor pos will be clamped by current text size

Parameters

cursorPos the new cursor pos

◆ setHorizontalTextAlignment()

void igor::iWidgetLineTextEdit::setHorizontalTextAlignment ( iHorizontalAlignment align )

sets horrizotnal text aligment

Parameters

align the horizontal allignment of the text

◆ setMaxTextLength()

void igor::iWidgetLineTextEdit::setMaxTextLength ( int32 chars )

sets the text max length in characters

Parameters

chars number of characters

◆ setText()

void igor::iWidgetLineTextEdit::setText ( const iaString & text )

sets the text

Parameters

text	the text to be set

◆ setVerticalTextAlignment()

void igor::iWidgetLineTextEdit::setVerticalTextAlignment ( iVerticalAlignment valign )

sets vertical text aligment

Parameters

valign the vertical allignment of the text

◆ setWriteProtected()

void igor::iWidgetLineTextEdit::setWriteProtected ( bool writeProtected )

sets text edit write protected

Parameters

writeProtected true: text edit will be write protected

Member Data Documentation

◆ _horizontalTextAlignment

iHorizontalAlignment igor::iWidgetLineTextEdit::_horizontalTextAlignment = iHorizontalAlignment::Left

protected

the horizontal alignment

◆ _text

iaString igor::iWidgetLineTextEdit::_text

protected

the text

◆ _textBackup

iaString igor::iWidgetLineTextEdit::_textBackup

protected

backup text

◆ _triggerChangeAtOnce

bool igor::iWidgetLineTextEdit::_triggerChangeAtOnce = false

protected

flat to handle change event trigger behaviour

◆ _verticalTextAlignment

iVerticalAlignment igor::iWidgetLineTextEdit::_verticalTextAlignment = iVerticalAlignment::Center

protected

the vertical alignment

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

/home/martin/dev/Igor/src/igor/igor/ui/widgets/iWidgetLineTextEdit.h
/home/martin/dev/Igor/src/igor/igor/ui/widgets/iWidgetLineTextEdit.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ iWidgetLineTextEdit()

◆ ~iWidgetLineTextEdit()

Member Function Documentation

◆ decCursorPos()

◆ getCursorPos()

◆ getCursorPosPix()

◆ getHorizontalTextAlignment()

◆ getMaxTextLength()

◆ getText()

◆ getVerticalTextAlignment()

◆ handleChanges()

◆ incCursorPos()

◆ isWriteProtected()

◆ onASCII()

◆ onGainedKeyboardFocus()

◆ onKeyDown()

◆ onKeyUp()

◆ onLostKeyboardFocus()

◆ setChangeEventAtOnce()

◆ setChangeEventOnEnterAndLostFocus()

◆ setCursorPos()

◆ setHorizontalTextAlignment()

◆ setMaxTextLength()

◆ setText()

◆ setVerticalTextAlignment()

◆ setWriteProtected()

Member Data Documentation

◆ _horizontalTextAlignment

◆ _text

◆ _textBackup

◆ _triggerChangeAtOnce

◆ _verticalTextAlignment