TextInput Fields

GeonBit.UI

TextInput Fields

The TextInput type exposes the following members.

Fields
  NameDescription
Public fieldAfterDraw
Callback to execute every frame after this entity is rendered.
(Inherited from Entity.)
Public fieldAfterUpdate
Callback to execute every frame after this entity updates.
(Inherited from Entity.)
Public fieldAttachedData
Optional data you can attach to this entity and retrieve later (for example when handling events).
(Inherited from Entity.)
Public fieldBeforeDraw
Callback to execute every frame before this entity is rendered.
(Inherited from Entity.)
Public fieldBeforeUpdate
Callback to execute every frame before this entity updates.
(Inherited from Entity.)
Public fieldStatic memberCaretBlinkingSpeed
How fast to blink caret when text input is selected.
Public fieldCharactersLimit
Set to any number to limit input by characters count.
Public fieldClickThrough
If this boolean is true, events will just "go through" this entity to its children or entities behind it. This bool comes to solve conditions where you have two panels without skin that hide each other but you want users to be able to click on the bottom panel through the upper panel, provided it doesn't hit any of the first panel's children.
(Inherited from Entity.)
Public fieldStatic memberDefaultParagraphStyle
Default style for paragraph that show current value.
Public fieldStatic memberDefaultPlaceholderStyle
Default style for the placeholder paragraph.
Public fieldStatic memberDefaultSize
Default text-input size for when no size is provided or when -1 is set for either width or height.
Public fieldStatic memberDefaultStyle
Default styling for the text input itself. Note: loaded from UI theme xml file.
Public fieldDisabled
If true, this entity and its children will be drawn in greyscale effect and will not respond to events.
(Inherited from Entity.)
Public fieldExtraMargin
Adds extra space outside the dest rect for collision detection. In other words, if extra margin is set to 10 and the user points with its mouse 5 pixels above this entity, it would still think the user points on the entity.
(Inherited from Entity.)
Public fieldHideInputWithChar
If provided, hide input and replace it with the given character. This is useful for stuff like password input field.
Public fieldIdentifier
Optional identifier you can attach to entities so you can later search and retrieve by.
(Inherited from Entity.)
Public fieldLimitBySize
If true, will limit max input length to fit textbox size.
Public fieldLimitDraggingToParentBoundaries
If true, users will not be able to drag this entity outside its parent boundaries.
(Inherited from Entity.)
Public fieldLocked
If true, this entity and its children will not respond to events (but will be drawn normally, unlike when disabled).
(Inherited from Entity.)
Public fieldOnClick
Callback to execute when user clicks on this entity (eg release mouse over it).
(Inherited from Entity.)
Public fieldOnFocusChange
Callback to execute every time this entity focus / unfocus.
(Inherited from Entity.)
Public fieldOnMouseDown
Callback to execute when mouse button is pressed over this entity (called once when button is pressed).
(Inherited from Entity.)
Public fieldOnMouseEnter
Callback to execute when mouse start hovering over this entity (eg enters its region).
(Inherited from Entity.)
Public fieldOnMouseLeave
Callback to execute when mouse stop hovering over this entity (eg leaves its region).
(Inherited from Entity.)
Public fieldOnMouseReleased
Callback to execute when mouse button is released over this entity (called once when button is released).
(Inherited from Entity.)
Public fieldOnMouseWheelScroll
Callback to execute when mouse wheel scrolls and this entity is the active entity.
(Inherited from Entity.)
Public fieldOnStartDrag
Called when entity starts getting dragged (only if draggable).
(Inherited from Entity.)
Public fieldOnStopDrag
Called when entity stop getting dragged (only if draggable).
(Inherited from Entity.)
Public fieldOnValueChange
Callback to execute when entity value changes (relevant only for entities with value).
(Inherited from Entity.)
Public fieldOnVisiblityChange
Callback to execute every time the visibility of this entity changes (also invokes when parent becomes invisible / visible again).
(Inherited from Entity.)
Public fieldPlaceholderParagraph
A placeholder paragraph to show when text input is empty.
Public fieldPromiscuousClicksMode
If in promiscuous mode, mouse button is pressed *outside* the entity and then released on the entity, click event will be fired. If false, in order to fire click event the mouse button must be pressed AND released over this entity (but can travel outside while being held down, as long as its released inside). Note: Windows default behavior is non promiscuous mode.
(Inherited from Entity.)
Public fieldTextParagraph
The Paragraph object showing current text value.
Public fieldToolTipText
Optional tooltip text to show if the user points on this entity for long enough.
(Inherited from Entity.)
Public fieldUseActualSizeForCollision
If true (default), will use the actual object size for collision detection. If false, will use the size property. This is useful for paragraphs, for example, where the actual width is based on text content and can vary and be totally different than the size set in the constructor.
(Inherited from Entity.)
Public fieldValidators
List of validators to apply on text input.
Public fieldValueWhenEmpty
If provided, will automatically put this value whenever the user leave the input box and its empty.
Public fieldWhileDragging
Called every frame while the entity is being dragged.
(Inherited from Entity.)
Public fieldWhileMouseDown
Callback to execute every frame while mouse button is pressed over the entity.
(Inherited from Entity.)
Public fieldWhileMouseHover
Callback to execute every frame while mouse is hovering over the entity.
(Inherited from Entity.)
Top
See Also