TextEdit¶

Inherits: Image
C++ type: TextEdit

Description¶

An interactive single-line text input field. TextEdit composes an Image background, a Text display layer, and polygon overlays for the cursor and text selection highlight. It handles keyboard input, clipboard operations, cursor navigation, and optional password masking.

Properties¶

Methods¶

Property details¶

text¶

• Setter: void setText(const std::string& text)
• Getter: std::string getText() const

The current content of the input field.

TextEdit nameField(&scene);
nameField.createImage();
nameField.setTexture("ui/input_bg.png");
nameField.setPatchMargin(8);
nameField.setSize(280, 36);
nameField.setPlaceholder("Enter your name...");
nameField.setFontSize(18);

local nameField = TextEdit(scene)
nameField:createImage()
nameField:setTexture("ui/input_bg.png")
nameField:setPatchMargin(8)
nameField:setSize(280, 36)
nameField:setPlaceholder("Enter your name...")
nameField:setFontSize(18)

textColor¶

• Setter: void setTextColor(Vector4 color)
• Getter: Vector4 getTextColor() const

RGBA tint colour applied to the input text glyphs.

textFont¶

• Setter: void setTextFont(const std::string& font)
• Getter: std::string getTextFont() const

Path to the TTF/OTF font file.

fontSize¶

• Setter: void setFontSize(unsigned int fontSize)
• Getter: unsigned int getFontSize() const

Glyph size in pixels.

maxTextSize¶

• Setter: void setMaxTextSize(unsigned int maxTextSize)
• Getter: unsigned int getMaxTextSize() const

Maximum allowed number of characters. 0 means no limit.

placeholder¶

• Setter: void setPlaceholder(const std::string& placeholder)
• Getter: std::string getPlaceholder() const
• Setter: void setPlaceholderColor(Vector4 color)
• Getter: Vector4 getPlaceholderColor() const

Ghost text displayed when the field is empty. Typically a prompt like "Type here…".

password¶

• Setter: void setPassword(bool password)
• Getter: bool getPassword() const
• Setter: void setPasswordChar(char passwordChar)
• Getter: char getPasswordChar() const

When password is true, each character is displayed as passwordChar (default '*'). The actual text is still accessible via getText().

disabled¶

• Setter: void setDisabled(bool disabled)
• Getter: bool getDisabled() const

When true, the field ignores keyboard and pointer events.

cursorIndex¶

• Setter: void setCursorIndex(int cursorIndex)
• Getter: int getCursorIndex() const

Current insertion-point position (0 = before the first character, getNumChars() = after the last).

cursorBlink / cursorWidth / cursorColor¶

• Setters/Getters: setCursorBlink / getCursorBlink, setCursorWidth / getCursorWidth, setCursorColor / getCursorColor

Visual properties of the cursor caret. cursorBlink is the on/off period in seconds.

selectionColor¶

• Setter: void setSelectionColor(Vector4 color)
• Getter: Vector4 getSelectionColor() const

Background colour of the text selection highlight polygon.

Method details¶

getTextObject¶

• Text getTextObject() const

Returns the child Text entity used for rendering the input content.

setSelection¶

• void setSelection(int anchor, int focus)
• int getSelectionAnchor() const
• int getSelectionFocus() const

Programmatically set or query the text selection. anchor is the fixed end of the selection; focus is the cursor end that moves with keyboard navigation. Pass equal values to collapse the selection to a cursor.