TEXT_WIDGET

This element is created for displaying and editing multiline text. It supports various modes of operation, plain text, bbcode, lists, tables and more.

Attributes brief detailed show all inherited

	Name	Description	Default
	id	Identifier of the elementIf id is given, it is used for the main WIDGET of TextWidget, so that you can access exposed WIDGET attributes, as well as some other TextWidget exposed attributes. The id of an element has to be globally unique. If you don't specify the id it'll be auto-generated.
	text	Static text to display (also can use 'value' for compatibilty with TEXT)When the string_id or param_id attribute is used, this attribute is not taken into account	empty
	string_id	String id to display/editOverrides 'text' if set	empty
	param_id	Parameter id to display/editOverrides 'text' and 'string_id' if set	empty
Size and position
	width	default width in pixels / relative in percentage / auto (or empty)If TextWidget is resizable this is a default (starting) value. If set in percentage, then horizontal resizing is disabled. If is empty or "auto" then width is auto-calculated from content width (considering min/max_width).	empty
	min_width	minimum width in pixels (for resizing)Used when resize="both" or "horizontal" and width is empty (auto) or fixed (not in percentage)	200
	max_width	maximum width in pixels (for resizing)Used when resize="both" or "horizontal" and width is empty (auto) or fixed (not in percentage)	1000
	height	default width in pixels / relative in percentage / auto (or empty)If TextWidget is resizable this is a default (starting) value. If set in percentage, then vertical resizing is disabled. If is empty or "auto" then height is auto-calculated from content height (considering min/max_height)	empty
	min_height	minimum height (for resizing)Used when resize="both" or "vertical" and height is empty (auto) or fixed (not in percentage)	30
	max_height	maximum height (for resizing)Used when resize="both" or "vertical" and height is empty (auto) or fixed (not in percentage)	750
	h_align	Horizontal alignment of the widget in its parent cell	empty
	v_align	Vertical alignment of the widget in its parent cell	empty
	h_margin	horizontal margin of the widget	2
	v_margin	vertical margin of the widget	5
	v_offset	vertical offset of the widgetUsing this property lets you move a widget without changing the layout around it. The position is relative to the parent cell	0
	visible	show/hide the widget (does not impact the layout)	true
	display	show/hide the widgetWhen set to false, the content of the widget is not displayed (not visible) AND is not taken into account to compute the layout (the widget is ignored)	true
Content positioning
	h_pad	horizontal padding of the text contentDefines the space between text content and the edges or the content area. Can be set for left and right separately: h_pad="10;20"	6
	v_pad	vertical padding of the text contentDefines the space between text content and the edges or the content area. Can be set for top and bottom separately: v_pad="5;15"	6
	h_clip	additional h-clipping of the content areacan be set for left and right separately: "10;5"	0
	v_clip	additional v-clipping of the content areacan be set for top and bottom separately: "4;6"	0
	text_h_align	horizontal text alignmentCan be further adjusted with bbcode (if enabled) using [left], [center], [right] or [justify]	left
	text_v_align	vertical text alignment	top
Font-related
	font_face	Font name (face) with optional bold and italicYou can put 'bold' or 'italic' here as well: "Arial;bold;italic". Default font is monotype: Consolas for Windows, Menlo for MacOS	OS depe...
	font_size	Font size (with optional min and max values)If you set min and max (ex. "12;8;40") values then quick font-resizing will be available using mouse (Ctrl+wheel) and keyboard Ctrl + "+" or "-". To return to default font-size use Ctrl+click or Ctrl+"0"	14;6;50
	font_size_persistent	Is font size remembered after font-resize	false
	font_resize_follow_ratio	How much other elements are resized on font-resizeThis determines how other elements (paddings, widths, sizes etc) are resized when font is resized by user. 0 means they are not changed, 1 means the same ratio as font_size/font_default_size	0.4
	view_source_font	Font for the "view bbcode source" modeYou can use it like "Consolas;14;bold;italic" or just "Consolas". Default font is monotype OS Dependent (Consolas or Menlo)	OS depe...
	text_color	Overrides text_color from the theme (added for simplicity)Normally text_color is set via the theme or using style="text_color: #color"	empty
	font_weight	"bold" or "normal" (added to mimic TEXT behaviour)	empty
	font_style	"italic" or "normal" (added to mimic TEXT behaviour)	empty
Related to editing
	edit	Enable or disable editingWhen editing mode is enabled, selection is also enabled	false
	select	Enable or disable selectionWhen editing is enabled, selection is also enabled	false
	string_update_mode	when to update original string (while editing)If "never" - original string is never updated, "always" - updated on every keypress, "lazy" - updated in pauses while typing (when cursor blinks), "enter" - updated on hitting "Enter". String is also updated when textwidget loses focus.	lazy
	max_length	Maximum length in characters for the text content (not counting bbcode tags)Can be used to limit text input	-1
	allowed_chars	List of characters that can be used for text inputCan limit some input fields for entering just numbers, for example numbers: allowed_chars="1234567890-+e,.%"	empty
	max_undo_states	Supported depth of undoSmaller values saves memory	10
	word_separators	A built-in list of characters considered as word-separators (for editing/selection)Long list of charaters like ./\\()\'-:,.;>~!@#$%^*+=[]{}`~?<&\"\n\t\r	see des...
	word_separators_exclude	Here you can add some characters you don't want to be word-separators	empty
	cursor_pos_after_update	When string is updated externally, move cursor to start/end of the text.	empty
Decorations and controls
	theme	Name of the theme to use ("dark", "light" or user custom). See Themes.	empty
	theme_restyle	Theme attributes to override (for use with DEFINE). See Themes.	empty
	style	Theme attributes to override (for use with particular widget). See Themes.	empty
	border_width	Size of the border in pixels.If set to 0, border is invisible	0
	scrollbars_mode	How to display vertical;horizontal scrollbars (never, always, auto, no_collapse)Modes "auto" and "no_collapse" both show and hide scrollbars on demand, but 'auto' also collapses scrollbar area when scrollbar is not needed (so there's more area for content); "never" and "always" are self-explanatory. If can set one mode for both scrollbars, or separately for vertical;horizontal - "no_collapse;never"	auto
	scrollbars_width	Size of scrollbars (in pixels)If you want to hide/disable scrollbars use scrollbars_mode	8
	vertical_resizer_width	Width of the vertical resizer handle (if visible)This handle is displayed when resize="vertical". The drag area is slightly larger then the handle itself.	60
	vertical_resizer_height	Height of the vertical resizer handle (if visible)This handle is displayed when resize="vertical". The drag area is slightly larger then the handle itself.	5
	corner_resizer_size	Sze of the bottom-right corner resizer (if visible)This handle is displayed when resize="both" or "horizontal"	20
	line_numbers	Display line numbers (on the left side)Line numbers look can be customized using Themes.	false
	line_num_min_width	Minimal width of the line numbers columnThe width is auto-adjusted to match the width of the max line number.	6
	line_num_start	From which number to start lines numeration	1
	lines_as_split	DIsplay line numbers and stripe for each visible lineBy default lines are numbered by original text lines, not as they are currently split on screen. But this mode is useful for debugging, etc.	false
	line_stripes	Display line stripes ("zebra"-background under lines)Can be helpful for debugging or easier line identification. Also can show background under "active" line (also see theme's 'text_active_color'). Can be customized using Themes.	false
Miscellaneous
	multiline	Enable or disable multiline modeIf "false", then textwidget can be used in single-line inputs etc. Newlines are converted to spaces, and hitting enter doesn't add new lines.	true
	resize	Enable or disable resizingDepending on resize mode bottom handle or bottom-right handle appears. User can right-click resize handle to return to default width and height |	vertical
	dimensions_persistent	Are width and height remembered after resizeUser can right-click resize handle to return to default width and height	false
	scrollpos	Vertical scroll positionRelative values from 0 (top) to 1 (bottom)	0
	scrollpos_x	Horizontal scroll positionRelative values from 0 (left) to 1 (right)	0
	scrollpos_fixed	Fix vertical scroll position (disable vertical scrolling)	false
	scrollpos_x_fixed	Fix horizontal scroll position (disable horizontal scrolling)	false
	buffered	Enable or disable buffering for CANVASWhen enabled the CANVAS element uses buffering, which saves CPU in cost of RAM	true
	right_click_script	Script executed on right-click. Overrides the default behavior.When this is defined, the default right-click menus are disabled. If you want to simply remove right-click menu you can add some simple script here, like "int d=1;"	empty
	open_as_file_app	Which application to use for "Open as file" actionThis is OS dependent, use with caution. If not set, the default app for ".txt" files is used.	empty
	unselect_on_blur	If text was selected, forget selection on losing focus	false
	requires	Exposes required objects (for scripting).Added just for convenience. What you put in "requires" goes into EXPOSED_OBJECTS	empty
	cursor	Which cursor to use (if not empty)	empty
	options	Various options for tweaking TW behaviourAvailable options: log_append_mode; disable_partial_resplit; disable_bbcode_toggle	empty
	options_def	The same as options, but with a lower priority (for DEFINES)	empty
	base_dir	Base location for imagesImages with relative path are also searched in KUIML_DIR (for LM Skin) and SCRIPT_DATA_PATH (for Plug'n Script default skin)	$_DIR_$
Pre-parsing and BBCode
	trim_spaces	Trim leading/trailing spaces at start/end of line	leading...
	replace_rn_to_n	Replace "\r\n" to simple "\n"	true
	strip_comments	Strip /* comments like this */ in text	true
	max_chars_in_line	Limit number of characters in lineCan be sometimes useful with monotype fonts. Disabled when 0 or auto.	auto
	word_wrap_by_chars	Which characters to look for when splitting string	" \r"
	bbcode	Enable or disable bbcode. See BBCode.	false
	copy_with_bbcode	Enable or disable copying with bbcodeYou can hold "Shift" while copying to override this	false
	paste_with_bbcode	Enable or disable pasting with bbcodeYou can hold "Shift" while pasting to override this	false
	bbcode_default_defs	Definitions of default bbcode complex tags (like h1, h2, list, hr...)More info in the bbcode article	See bbc...
	bbcode_defs	Here you can add your own complex tags and override defaultsLike this [#h1=size=150%]. More info in the bbcode article
	parse_tables	Enable or disable parsing tablesWhen enabled, every line that has "\t" characters is considered a table line, \t divides it into columns. More info in the bbcode article	true
	modify_tables	Enable or disable editing tables structureWhen enabled, used can add/remove rows via right-click menu	false
Using with param_id
	content	String with param fields (to format output)Available fields: {value}, {unit}, {name}, {default}, {min}, {max}, {text_value}. {as_string}	{as_str...
	value_format	Format of the 'value' fieldThe default format shows the value with one character for the decimal part, and positive values start with a blank	empty
	value_suffix	Add a suffix for big and small values (10000 => 10k)If the value is too small or too big, the system will use a suffix for the value, such as 'k' for kilo, 'M' for Mega, or 'm' for 'milli'	false
	significant_digits	Number of significant digits to display, forcing the system to perform roundingWith significant_digits set to 2, "45678" will be displayed as 46000, and "0.654" will be displayed as 0.65. Set this parameter to 0 to disable rounding	0
Events handling
	event	Name of the last fired eventCurrently implemented events: "keypress|Enter", "keypress|CTRL+S" and events from "action" or "a" bbcode tags	empty
	events_counter	Event tracker - increments every time event is fired	0

	Name	Value type	Default	Description	Comment
	id	identifier		Identifier of the element	If id is given, it is used for the main WIDGET of TextWidget, so that you can access exposed WIDGET attributes, as well as some other TextWidget exposed attributes. The id of an element has to be globally unique. If you don't specify the id it'll be auto-generated.
	text	string	empty	Static text to display (also can use 'value' for compatibilty with TEXT)	When the string_id or param_id attribute is used, this attribute is not taken into account
	string_id	string id	empty	String id to display/edit	Overrides 'text' if set
	param_id	param id	empty	Parameter id to display/edit	Overrides 'text' and 'string_id' if set
Size and position
	width	number of pixels or percentage	empty	default width in pixels / relative in percentage / auto (or empty)	If TextWidget is resizable this is a default (starting) value. If set in percentage, then horizontal resizing is disabled. If is empty or "auto" then width is auto-calculated from content width (considering min/max_width).
	min_width	number of pixels	200	minimum width in pixels (for resizing)	Used when resize="both" or "horizontal" and width is empty (auto) or fixed (not in percentage)
	max_width	number of pixels	1000	maximum width in pixels (for resizing)	Used when resize="both" or "horizontal" and width is empty (auto) or fixed (not in percentage)
	height	number of pixels or percentage	empty	default width in pixels / relative in percentage / auto (or empty)	If TextWidget is resizable this is a default (starting) value. If set in percentage, then vertical resizing is disabled. If is empty or "auto" then height is auto-calculated from content height (considering min/max_height)
	min_height	number of pixels	30	minimum height (for resizing)	Used when resize="both" or "vertical" and height is empty (auto) or fixed (not in percentage)
	max_height	number of pixels	750	maximum height (for resizing)	Used when resize="both" or "vertical" and height is empty (auto) or fixed (not in percentage)
	h_align	horizontal alignment	empty	Horizontal alignment of the widget in its parent cell
	v_align	vertical alignment	empty	Vertical alignment of the widget in its parent cell
	h_margin	number of pixels	2	horizontal margin of the widget
	v_margin	number of pixels	5	vertical margin of the widget
	v_offset	position in pixels	0	vertical offset of the widget	Using this property lets you move a widget without changing the layout around it. The position is relative to the parent cell
	visible	boolean	true	show/hide the widget (does not impact the layout)
	display	boolean	true	show/hide the widget	When set to false, the content of the widget is not displayed (not visible) AND is not taken into account to compute the layout (the widget is ignored)
Content positioning
	h_pad	value in pixels	6	horizontal padding of the text content	Defines the space between text content and the edges or the content area. Can be set for left and right separately: h_pad="10;20"
	v_pad	value in pixels	6	vertical padding of the text content	Defines the space between text content and the edges or the content area. Can be set for top and bottom separately: v_pad="5;15"
	h_clip	value in pixels	0	additional h-clipping of the content area	can be set for left and right separately: "10;5"
	v_clip	value in pixels	0	additional v-clipping of the content area	can be set for top and bottom separately: "4;6"
	text_h_align	left, center, right or justify	left	horizontal text alignment	Can be further adjusted with bbcode (if enabled) using [left], [center], [right] or [justify]
	text_v_align	top, center of bottom	top	vertical text alignment
Font-related
	font_face	Font name, bold, italic	OS dependent	Font name (face) with optional bold and italic	You can put 'bold' or 'italic' here as well: "Arial;bold;italic". Default font is monotype: Consolas for Windows, Menlo for MacOS
	font_size	size; min; max	14;6;50	Font size (with optional min and max values)	If you set min and max (ex. "12;8;40") values then quick font-resizing will be available using mouse (Ctrl+wheel) and keyboard Ctrl + "+" or "-". To return to default font-size use Ctrl+click or Ctrl+"0"
	font_size_persistent	boolean	false	Is font size remembered after font-resize
	font_resize_follow_ratio	float	0.4	How much other elements are resized on font-resize	This determines how other elements (paddings, widths, sizes etc) are resized when font is resized by user. 0 means they are not changed, 1 means the same ratio as font_size/font_default_size
	view_source_font	string	OS dependent	Font for the "view bbcode source" mode	You can use it like "Consolas;14;bold;italic" or just "Consolas". Default font is monotype OS Dependent (Consolas or Menlo)
	text_color	String	empty	Overrides text_color from the theme (added for simplicity)	Normally text_color is set via the theme or using style="text_color: #color"
	font_weight	String	empty	"bold" or "normal" (added to mimic TEXT behaviour)
	font_style	String	empty	"italic" or "normal" (added to mimic TEXT behaviour)
Related to editing
	edit	boolean	false	Enable or disable editing	When editing mode is enabled, selection is also enabled
	select	boolean	false	Enable or disable selection	When editing is enabled, selection is also enabled
	string_update_mode	never, always, lazy, enter	lazy	when to update original string (while editing)	If "never" - original string is never updated, "always" - updated on every keypress, "lazy" - updated in pauses while typing (when cursor blinks), "enter" - updated on hitting "Enter". String is also updated when textwidget loses focus.
	max_length	int	-1	Maximum length in characters for the text content (not counting bbcode tags)	Can be used to limit text input
	allowed_chars	string	empty	List of characters that can be used for text input	Can limit some input fields for entering just numbers, for example numbers: allowed_chars="1234567890-+e,.%"
	max_undo_states	integer	10	Supported depth of undo	Smaller values saves memory
	word_separators	string	see description	A built-in list of characters considered as word-separators (for editing/selection)	Long list of charaters like ./\\()\'-:,.;>~!@#$%^*+=[]{}`~?<&\"\n\t\r
	word_separators_exclude	string	empty	Here you can add some characters you don't want to be word-separators
	cursor_pos_after_update	start, end or empty	empty	When string is updated externally, move cursor to start/end of the text.
Decorations and controls
	theme	string	empty	Name of the theme to use ("dark", "light" or user custom). See Themes.
	theme_restyle	string	empty	Theme attributes to override (for use with DEFINE). See Themes.
	style	string	empty	Theme attributes to override (for use with particular widget). See Themes.
	border_width	value in pixels	0	Size of the border in pixels.	If set to 0, border is invisible
	scrollbars_mode	never, always, auto, no_collapse	auto	How to display vertical;horizontal scrollbars (never, always, auto, no_collapse)	Modes "auto" and "no_collapse" both show and hide scrollbars on demand, but 'auto' also collapses scrollbar area when scrollbar is not needed (so there's more area for content); "never" and "always" are self-explanatory. If can set one mode for both scrollbars, or separately for vertical;horizontal - "no_collapse;never"
	scrollbars_width	value in pixels	8	Size of scrollbars (in pixels)	If you want to hide/disable scrollbars use scrollbars_mode
	vertical_resizer_width	value in pixels	60	Width of the vertical resizer handle (if visible)	This handle is displayed when resize="vertical". The drag area is slightly larger then the handle itself.
	vertical_resizer_height	value in pixels	5	Height of the vertical resizer handle (if visible)	This handle is displayed when resize="vertical". The drag area is slightly larger then the handle itself.
	corner_resizer_size	value in pixels	20	Sze of the bottom-right corner resizer (if visible)	This handle is displayed when resize="both" or "horizontal"
	line_numbers	boolean	false	Display line numbers (on the left side)	Line numbers look can be customized using Themes.
	line_num_min_width	value in pixels	6	Minimal width of the line numbers column	The width is auto-adjusted to match the width of the max line number.
	line_num_start	integer	1	From which number to start lines numeration
	lines_as_split	boolean	false	DIsplay line numbers and stripe for each visible line	By default lines are numbered by original text lines, not as they are currently split on screen. But this mode is useful for debugging, etc.
	line_stripes	boolean	false	Display line stripes ("zebra"-background under lines)	Can be helpful for debugging or easier line identification. Also can show background under "active" line (also see theme's 'text_active_color'). Can be customized using Themes.
Miscellaneous
	multiline	boolean	true	Enable or disable multiline mode	If "false", then textwidget can be used in single-line inputs etc. Newlines are converted to spaces, and hitting enter doesn't add new lines.
	resize	vertical, horizontal, both, false	vertical	Enable or disable resizing	Depending on resize mode bottom handle or bottom-right handle appears. User can right-click resize handle to return to default width and height |
	dimensions_persistent	boolean	false	Are width and height remembered after resize	User can right-click resize handle to return to default width and height
	scrollpos	0 to 1	0	Vertical scroll position	Relative values from 0 (top) to 1 (bottom)
	scrollpos_x	0 to 1	0	Horizontal scroll position	Relative values from 0 (left) to 1 (right)
	scrollpos_fixed	boolean	false	Fix vertical scroll position (disable vertical scrolling)
	scrollpos_x_fixed	boolean	false	Fix horizontal scroll position (disable horizontal scrolling)
	buffered	boolean	true	Enable or disable buffering for CANVAS	When enabled the CANVAS element uses buffering, which saves CPU in cost of RAM
	right_click_script	string	empty	Script executed on right-click. Overrides the default behavior.	When this is defined, the default right-click menus are disabled. If you want to simply remove right-click menu you can add some simple script here, like "int d=1;"
	open_as_file_app	string	empty	Which application to use for "Open as file" action	This is OS dependent, use with caution. If not set, the default app for ".txt" files is used.
	unselect_on_blur	boolean	false	If text was selected, forget selection on losing focus
	requires	string	empty	Exposes required objects (for scripting).	Added just for convenience. What you put in "requires" goes into EXPOSED_OBJECTS
	cursor	string	empty	Which cursor to use (if not empty)
	options	string	empty	Various options for tweaking TW behaviour	Available options: log_append_mode; disable_partial_resplit; disable_bbcode_toggle
	options_def	string	empty	The same as options, but with a lower priority (for DEFINES)
	base_dir	String	$_DIR_$	Base location for images	Images with relative path are also searched in KUIML_DIR (for LM Skin) and SCRIPT_DATA_PATH (for Plug'n Script default skin)
Pre-parsing and BBCode
	trim_spaces	leading;trailing	leading;trailing	Trim leading/trailing spaces at start/end of line
	replace_rn_to_n	boolean	true	Replace "\r\n" to simple "\n"
	strip_comments	boolean	true	Strip /* comments like this */ in text
	max_chars_in_line	int or auto	auto	Limit number of characters in line	Can be sometimes useful with monotype fonts. Disabled when 0 or auto.
	word_wrap_by_chars	string	" \r"	Which characters to look for when splitting string
	bbcode	boolean	false	Enable or disable bbcode. See BBCode.
	copy_with_bbcode	boolean	false	Enable or disable copying with bbcode	You can hold "Shift" while copying to override this
	paste_with_bbcode	boolean	false	Enable or disable pasting with bbcode	You can hold "Shift" while pasting to override this
	bbcode_default_defs	string	See bbcode	Definitions of default bbcode complex tags (like h1, h2, list, hr...)	More info in the bbcode article
	bbcode_defs	string		Here you can add your own complex tags and override defaults	Like this [#h1=size=150%]. More info in the bbcode article
	parse_tables	boolean	true	Enable or disable parsing tables	When enabled, every line that has "\t" characters is considered a table line, \t divides it into columns. More info in the bbcode article
	modify_tables	boolean	false	Enable or disable editing tables structure	When enabled, used can add/remove rows via right-click menu
Using with param_id
	content	string	{as_string}	String with param fields (to format output)	Available fields: {value}, {unit}, {name}, {default}, {min}, {max}, {text_value}. {as_string}
	value_format	param value formatting	empty	Format of the 'value' field	The default format shows the value with one character for the decimal part, and positive values start with a blank
	value_suffix	boolean	false	Add a suffix for big and small values (10000 => 10k)	If the value is too small or too big, the system will use a suffix for the value, such as 'k' for kilo, 'M' for Mega, or 'm' for 'milli'
	significant_digits	positive integer value	0	Number of significant digits to display, forcing the system to perform rounding	With significant_digits set to 2, "45678" will be displayed as 46000, and "0.654" will be displayed as 0.65. Set this parameter to 0 to disable rounding
Events handling
	event	String	empty	Name of the last fired event	Currently implemented events: "keypress|Enter", "keypress|CTRL+S" and events from "action" or "a" bbcode tags
	events_counter	integer	0	Event tracker - increments every time event is fired