TextEdit

Multiline text editing control.

TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo.

@GodotBaseClass

struct TextEdit {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(TextEdit other);

TextEdit opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static TextEdit _new();

enum SearchFlags;

enum MenuItems;

enum Constants;

void _guiInput(InputEvent arg0);

void _scrollMoved(double arg0);

void _cursorChangedEmit();

void _textChangedEmit();

void _pushCurrentOp();

void _clickSelectionHeld();

void _toggleDrawCaret();

void _vScrollInput();

void setText(StringArg0 text);

void insertTextAtCursor(StringArg0 text);

long getLineCount();

String getText();

String getLine(long line);

void cursorSetColumn(long column, bool adjust_viewport);

void cursorSetLine(long line, bool adjust_viewport, bool can_be_hidden, long wrap_index);

long cursorGetColumn();

long cursorGetLine();

void cursorSetBlinkEnabled(bool enable);

bool cursorGetBlinkEnabled();

void cursorSetBlinkSpeed(double blink_speed);

double cursorGetBlinkSpeed();

void cursorSetBlockMode(bool enable);

bool cursorIsBlockMode();

void setRightClickMovesCaret(bool enable);

bool isRightClickMovingCaret();

void setReadonly(bool enable);

bool isReadonly();

void setWrapEnabled(bool enable);

bool isWrapEnabled();

void setContextMenuEnabled(bool enable);

bool isContextMenuEnabled();

void paste();

void select(long from_line, long from_column, long to_line, long to_column);

void selectAll();

void deselect();

bool isSelectionActive();

long getSelectionFromLine();

long getSelectionFromColumn();

long getSelectionToLine();

long getSelectionToColumn();

String getSelectionText();

String getWordUnderCursor();

PoolIntArray search(StringArg0 key, long flags, long from_line, long from_column);

void clearUndoHistory();

void setShowLineNumbers(bool enable);

bool isShowLineNumbersEnabled();

void setBreakpointGutterEnabled(bool enable);

bool isBreakpointGutterEnabled();

void setHidingEnabled(long enable);

long isHidingEnabled();

void setLineAsHidden(long line, bool enable);

bool isLineHidden(long line);

void foldAllLines();

void unhideAllLines();

void foldLine(long line);

void unfoldLine(long line);

void toggleFoldLine(long line);

bool canFold(long line);

bool isFolded(long line);

void setHighlightAllOccurrences(bool enable);

bool isHighlightAllOccurrencesEnabled();

void setOverrideSelectedFontColor(bool _override);

bool isOverridingSelectedFontColor();

void setSyntaxColoring(bool enable);

bool isSyntaxColoringEnabled();

void setHighlightCurrentLine(bool enabled);

bool isHighlightCurrentLineEnabled();

void setSmoothScrollEnable(bool enable);

bool isSmoothScrollEnabled();

void setVScrollSpeed(double speed);

double getVScrollSpeed();

void addKeywordColor(StringArg0 keyword, Color color);

bool hasKeywordColor(StringArg0 keyword);

Color getKeywordColor(StringArg0 keyword);

void addColorRegion(StringArg0 begin_key, StringArg1 end_key, Color color, bool line_only);

void clearColors();

void menuOption(long option);

PopupMenu getMenu();

Array getBreakpoints();

void removeBreakpoints();

String text [@property getter];

String text [@property setter];

bool readonly [@property getter];

bool readonly [@property setter];

bool highlightCurrentLine [@property getter];

bool highlightCurrentLine [@property setter];

bool syntaxHighlighting [@property getter];

bool syntaxHighlighting [@property setter];

bool showLineNumbers [@property getter];

bool showLineNumbers [@property setter];

bool breakpointGutter [@property getter];

bool breakpointGutter [@property setter];

bool highlightAllOccurrences [@property getter];

bool highlightAllOccurrences [@property setter];

bool overrideSelectedFontColor [@property getter];

bool overrideSelectedFontColor [@property setter];

bool contextMenuEnabled [@property getter];

bool contextMenuEnabled [@property setter];

bool smoothScrolling [@property getter];

bool smoothScrolling [@property setter];

double vScrollSpeed [@property getter];

double vScrollSpeed [@property setter];

long hidingEnabled [@property getter];

long hidingEnabled [@property setter];

bool wrapEnabled [@property getter];

bool wrapEnabled [@property setter];

bool caretBlockMode [@property getter];

bool caretBlockMode [@property setter];

bool caretBlink [@property getter];

bool caretBlink [@property setter];

double caretBlinkSpeed [@property getter];

double caretBlinkSpeed [@property setter];

bool caretMovingByRightClick [@property getter];

bool caretMovingByRightClick [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
MenuItems enum MenuItems
SearchFlags enum SearchFlags

Functions

_clickSelectionHeld void _clickSelectionHeld()
_cursorChangedEmit void _cursorChangedEmit()
_guiInput void _guiInput(InputEvent arg0)
_pushCurrentOp void _pushCurrentOp()
_scrollMoved void _scrollMoved(double arg0)
_textChangedEmit void _textChangedEmit()
_toggleDrawCaret void _toggleDrawCaret()
_vScrollInput void _vScrollInput()
addColorRegion void addColorRegion(StringArg0 begin_key, StringArg1 end_key, Color color, bool line_only): Add color region (given the delimiters) and its colors.
addKeywordColor void addKeywordColor(StringArg0 keyword, Color color): Add a keyword and its color.
canFold bool canFold(long line)
clearColors void clearColors(): Clear all the syntax coloring information.
clearUndoHistory void clearUndoHistory(): Clear the undo history.
copy void copy(): Copy the current selection.
cursorGetBlinkEnabled bool cursorGetBlinkEnabled()
cursorGetBlinkSpeed double cursorGetBlinkSpeed()
cursorGetColumn long cursorGetColumn(): Return the column the editing cursor is at.
cursorGetLine long cursorGetLine(): Return the line the editing cursor is at.
cursorIsBlockMode bool cursorIsBlockMode()
cursorSetBlinkEnabled void cursorSetBlinkEnabled(bool enable)
cursorSetBlinkSpeed void cursorSetBlinkSpeed(double blink_speed)
cursorSetBlockMode void cursorSetBlockMode(bool enable)
cursorSetColumn void cursorSetColumn(long column, bool adjust_viewport)
cursorSetLine void cursorSetLine(long line, bool adjust_viewport, bool can_be_hidden, long wrap_index)
cut void cut(): Cut the current selection.
deselect void deselect(): Clears the current selection.
foldAllLines void foldAllLines()
foldLine void foldLine(long line)
getBreakpoints Array getBreakpoints(): Return an array containing the line number of each breakpoint.
getKeywordColor Color getKeywordColor(StringArg0 keyword)
getLine String getLine(long line): Return the text of a specific line.
getLineCount long getLineCount(): Return the amount of total lines in the text.
getMenu PopupMenu getMenu()
getSelectionFromColumn long getSelectionFromColumn(): Return the selection begin column.
getSelectionFromLine long getSelectionFromLine(): Return the selection begin line.
getSelectionText String getSelectionText(): Return the text inside the selection.
getSelectionToColumn long getSelectionToColumn(): Return the selection end column.
getSelectionToLine long getSelectionToLine(): Return the selection end line.
getText String getText()
getVScrollSpeed double getVScrollSpeed()
getWordUnderCursor String getWordUnderCursor()
hasKeywordColor bool hasKeywordColor(StringArg0 keyword)
insertTextAtCursor void insertTextAtCursor(StringArg0 text): Insert a given text at the cursor position.
isBreakpointGutterEnabled bool isBreakpointGutterEnabled()
isContextMenuEnabled bool isContextMenuEnabled()
isFolded bool isFolded(long line)
isHidingEnabled long isHidingEnabled()
isHighlightAllOccurrencesEnabled bool isHighlightAllOccurrencesEnabled()
isHighlightCurrentLineEnabled bool isHighlightCurrentLineEnabled()
isLineHidden bool isLineHidden(long line)
isOverridingSelectedFontColor bool isOverridingSelectedFontColor()
isReadonly bool isReadonly()
isRightClickMovingCaret bool isRightClickMovingCaret()
isSelectionActive bool isSelectionActive(): Return true if the selection is active.
isShowLineNumbersEnabled bool isShowLineNumbersEnabled()
isSmoothScrollEnabled bool isSmoothScrollEnabled()
isSyntaxColoringEnabled bool isSyntaxColoringEnabled()
isWrapEnabled bool isWrapEnabled()
menuOption void menuOption(long option)
opAssign TextEdit opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(TextEdit other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
paste void paste(): Paste the current selection.
redo void redo(): Perform redo operation.
removeBreakpoints void removeBreakpoints(): Removes all the breakpoints (without firing "breakpoint_toggled" signal).
search PoolIntArray search(StringArg0 key, long flags, long from_line, long from_column): Perform a search inside the text. Search flags can be specified in the SEARCH_* enum.
select void select(long from_line, long from_column, long to_line, long to_column): Perform selection, from line/column to line/column.
selectAll void selectAll(): Select all the text.
setBreakpointGutterEnabled void setBreakpointGutterEnabled(bool enable)
setContextMenuEnabled void setContextMenuEnabled(bool enable)
setHidingEnabled void setHidingEnabled(long enable)
setHighlightAllOccurrences void setHighlightAllOccurrences(bool enable)
setHighlightCurrentLine void setHighlightCurrentLine(bool enabled)
setLineAsHidden void setLineAsHidden(long line, bool enable)
setOverrideSelectedFontColor void setOverrideSelectedFontColor(bool _override)
setReadonly void setReadonly(bool enable)
setRightClickMovesCaret void setRightClickMovesCaret(bool enable)
setShowLineNumbers void setShowLineNumbers(bool enable)
setSmoothScrollEnable void setSmoothScrollEnable(bool enable)
setSyntaxColoring void setSyntaxColoring(bool enable)
setText void setText(StringArg0 text)
setVScrollSpeed void setVScrollSpeed(double speed)
setWrapEnabled void setWrapEnabled(bool enable)
toggleFoldLine void toggleFoldLine(long line): Toggle the folding of the code block at the given line.
undo void undo(): Perform undo operation.
unfoldLine void unfoldLine(long line)
unhideAllLines void unhideAllLines()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

breakpointGutter bool breakpointGutter [@property getter]
bool breakpointGutter [@property setter]: If true the breakpoint gutter is visible.
caretBlink bool caretBlink [@property setter]: If true the caret (visual cursor) blinks.
caretBlink bool caretBlink [@property getter]: If true the caret (visual cursor) blinks.
caretBlinkSpeed double caretBlinkSpeed [@property setter]: Duration (in seconds) of a caret's blinking cycle.
caretBlinkSpeed double caretBlinkSpeed [@property getter]: Duration (in seconds) of a caret's blinking cycle.
caretBlockMode bool caretBlockMode [@property setter]: If true the caret displays as a rectangle. If false the caret displays as a bar.
caretBlockMode bool caretBlockMode [@property getter]: If true the caret displays as a rectangle. If false the caret displays as a bar.
caretMovingByRightClick bool caretMovingByRightClick [@property getter]
bool caretMovingByRightClick [@property setter]: If true a right click moves the cursor at the mouse position before displaying the context menu. If false the context menu disregards mouse location.
contextMenuEnabled bool contextMenuEnabled [@property getter]
bool contextMenuEnabled [@property setter]: If true a right click displays the context menu.
hidingEnabled long hidingEnabled [@property getter]
long hidingEnabled [@property setter]
highlightAllOccurrences bool highlightAllOccurrences [@property getter]
bool highlightAllOccurrences [@property setter]
highlightCurrentLine bool highlightCurrentLine [@property setter]: If true the line containing the cursor is highlighted.
highlightCurrentLine bool highlightCurrentLine [@property getter]: If true the line containing the cursor is highlighted.
overrideSelectedFontColor bool overrideSelectedFontColor [@property getter]
bool overrideSelectedFontColor [@property setter]
readonly bool readonly [@property setter]: If true read-only mode is enabled. Existing text cannot be modified and new text cannot be added.
readonly bool readonly [@property getter]: If true read-only mode is enabled. Existing text cannot be modified and new text cannot be added.
showLineNumbers bool showLineNumbers [@property getter]
bool showLineNumbers [@property setter]: If true line numbers are displayed to the left of the text.
smoothScrolling bool smoothScrolling [@property getter]
bool smoothScrolling [@property setter]
syntaxHighlighting bool syntaxHighlighting [@property getter]
bool syntaxHighlighting [@property setter]
text String text [@property setter]: String value of the TextEdit.
text String text [@property getter]: String value of the TextEdit.
vScrollSpeed double vScrollSpeed [@property getter]
double vScrollSpeed [@property setter]: If true, enables text wrapping when it goes beyond he edge of what is visible.
wrapEnabled bool wrapEnabled [@property getter]
bool wrapEnabled [@property setter]

Static functions

_new TextEdit _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot textedit structs

TextEdit