Module text_box2d

Structs§

ACTUAL_DEPTH_PROPERTY
The calculated size of the node in depth direction when used in a layout.
ACTUAL_HEIGHT_PROPERTY
The calculated height of the node when used in a layout.
ACTUAL_WIDTH_PROPERTY
The calculated width of the node when used in a layout.
ASPECT_RATIO_PROPERTY
Determines the proportion of width and height. You cannot set both the Aspect Ratio and both, Width and Height.
BACKGROUND_BRUSH_PROPERTY
The background brush to paint the background of 2D nodes.
BACKSPACE_AT_CURSOR
In a Text Box node, deletes a character using backspace. For example, in text that uses a left-to-right script it deletes the character on the left side of the cursor.
BACKSPACE_WORD_AT_CURSOR
In a Text Box node, deletes the characters until the next word boundary using backspace. For example, in text that uses a left-to-right script it deletes the characters between the cursor position and the closest word boundary on the left side of the cursor.
CACHE_VALID_PROPERTY
Indicates whether the node is cached. To disable the cache for one frame, disable this property.
CACHING_MODE_PROPERTY
Sets the caching mode of this node:
CANCEL_TEXT_COMPOSITION
Discards the text composed in an Input Method Editor. This action works only when the Text Box node, which the action targets, is in the editing state.
CHARACTER_COUNT_PROPERTY
CHARACTER_SPACING_PROPERTY
Sets the character spacing in pixels.
CLEAR_SELECTION
In a Text Box node, clears the current text selection.
CLIP_CHILDREN_PROPERTY
Sets whether to clip the child nodes of this node. Kanzi clips the child nodes whose bounding box is completely outside of the bounding box of their parent node. Use this property with layout nodes. The child nodes can use only translation transformation.
COMMIT_COMPOSITION_TEXT
Commits to a Text Box node the text composed in an Input Method Editor. This action works only when the Text Box node, which the action targets, is in the editing state.
COMPOSITION_BRUSH_PROPERTY
The brush to use to compose 2D nodes to screen.
COMPOSITION_TEXT_BACKGROUND_BRUSH_PROPERTY
Sets the brush that highlights the text that the user composes using an input method editor (IME).
COMPOSITION_TEXT_CHANGED
Occurs when the text produced in an Input Method Editor is updated in a Text Box node.
COMPOSITION_TEXT_COMMITTED
Occurs:
COMPOSITION_TEXT_FOREGROUND_BRUSH_PROPERTY
Sets the brush for the text that the user composes using an input method editor (IME).
COMPOSITION_TEXT_PROPERTY
Reports the text that the user composes in the Text Box using an input method editor (IME).
CONTENT_STRETCH_PROPERTY
Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size).
CREATED_FROM_KZB_PROPERTY
Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file.
CURSOR_MOVED
Occurs when the user moves the cursor in a Text Box node.
CURSOR_POSITION_PROPERTY
Sets the position of the cursor in the text shown in the Text Box node.
CURSOR_PREFAB_PROPERTY
Sets the prefab template that defines the appearance of the cursor instead of the default cursor.
CharacterRemovalMessageArguments
CursorPositionMessageArguments
DELETE_AT_CURSOR
In a Text Box node, deletes a character using delete. For example, in text that uses a left-to-right script it deletes the character on the right side of the cursor.
DELETE_SELECTION
In a Text Box node, erases any currently selected text.
DELETE_TEXT
In a Text Box node, deletes the text between given start and end character indexes.
DELETE_WORD_AT_CURSOR
In a Text Box node, deletes the characters until the next word boundary using delete. For example, in text that uses a left-to-right script it deletes the characters between the cursor position and the closest word boundary on the right side of the cursor.
DEPTH_ALIGNMENT_PROPERTY
The alignment in depth direction the node should use when it resides under a layout.
DEPTH_MARGIN_PROPERTY
Sets the depth distance between this node and other nodes that are adjacent to this node in a layout.
DEPTH_PROPERTY
The size of the node in depth direction when used in a layout. Overrides the default bounds of the item.
DISABLE_RENDER_TARGET_CLEAR_PROPERTY
Do not clear render target buffers before rendering into it even if necessary.
DISPLAY_TEXT_PROPERTY
Reports the text that the Text Box displays.
DeleteSelectionMessageArguments
ECHO_MODE_PROPERTY
Sets how the Text Box node shows text:
EDITING_FINISHED
Occurs when a Text Box node leaves the editing state after the user modified the text content.
EDITING_STARTED
Occurs when the user makes the first modification to the text in a Text Box node that is in the editing state.
EDIT_MODE_PROPERTY
Sets how the Text Box node enters the editing state:
EFFECTIVELY_ENABLED_PROPERTY
Indicates whether this node and its ancestor nodes are enabled. Use this property in state managers and bindings to observe whether a node is effectively enabled. To enable or disable a node, use the Enabled property. When a node is effectively disabled:
EFFECT_PREFAB_PROPERTY
The 2D Effect to use for this node.
EFFECT_PROPERTY
Reports the runtime effect instance that this node uses. Kanzi sets the value of this property internally when the value of the Effect Prefab property in this node changes.
ENABLED_PROPERTY
Whether this node is enabled. When you disable this property in a node, that node and its descendant nodes in the same overlay focus scope are effectively disabled. Effectively disabling a node removes that node from the focus chain and cancels all the active input manipulators.Use the Effectively Enabled property to observe whether a node is effectively enabled.
ENTERED_EDITING_STATE
Occurs when a Text Box node enters the editing state.
ENTER_EDITING
Makes a Text Box node enter the editing state.
EXIT_EDITING
Makes a Text Box node leave the editing state.
EditingStateChangedMessageArguments
FIXED_CHARACTER_WIDTH_PROPERTY
When set, overrides the font advance widths to make each character take a fixed amount of space specified in pixels.
FOCUSABLE_PROPERTY
Indicates whether the node can receive focus.
FOCUSED_PROPERTY
Indicates whether the node has the key focus.
FOCUS_STATE_PROPERTY
Reports the focus state of a node:
FONT_COLOR_PROPERTY
Sets the color of the text in a 3D text node.
FONT_FAMILY_PROPERTY
The font family used to render the text.
FONT_HINTING_PREFERENCE_PROPERTY
Sets the hinting preference of the font.
FONT_MATERIAL_PROPERTY
Sets the material whose shader is used to render the text. The shader must use the ContentTexture uniform which is automatically filled with glyph data.
FONT_STYLE_PROPERTY
Sets the style of the font.
FORCE_COMPOSITION_PROPERTY
Force rendering to composing target even if not otherwise necessary.
FOREGROUND_BRUSH_PROPERTY
The foreground brush to paint the foreground of 2D nodes.
FOREGROUND_HINT_PROPERTY
Give a hint of the type of the foreground of 2D nodes:
FRACTIONAL_CHARACTER_WIDTH_PROPERTY
Sets whether Kanzi uses fractional or rounded character widths to lay out text. In most cases fractional widths provide the best result. However, with small font sizes, fractional widths can cause the characters to run together or have too much space, making it difficult to read.
FontStyleConcept
HAS_SELECTION_PROPERTY
Indicates whether any of the text in the Text Box node is selected.
HEIGHT_PROPERTY
The height of the node when used in a layout. Overrides the default bounds of the item.
HIDE_TEXT_HINT_WHEN_EDITING_PROPERTY
Sets whether to hide the placeholder content, which you set using the Text Hint Prefab property, when the Text Box node is in the editing state. To hide the placeholder content only when the user enters text in the Text Box node, disable this property.
HIT_TESTABLE_CONTAINER_PROPERTY
When enabled, Kanzi uses the layout bounds as geometry for hit testing.
HIT_TESTABLE_PROPERTY
When enabled, the node can be hit tested. Enabling Hit Testable for a 2D node enables hit testing only for that node. Enabling Hit Testable for a 3D node enables hit testing also for the child nodes. Kanzi hit tests 3D nodes using the default Camera node or the Hit Test Camera node of the active Scene node.
HORIZONTAL_ALIGNMENT_PROPERTY
The alignment in horizontal direction the node should use when it resides under a layout.
HORIZONTAL_FIT_PROPERTY
Whether to horizontally scale the glyphs to make them fit into the Layout Width of the Text Block. To adjust the scale, use the Horizontal Fit Scale Limits property.
HORIZONTAL_FIT_SCALE_LIMITS_PROPERTY
When the Horizontal Fit property is enabled, sets the minimum and maximum scale for glyphs when the width of text in a Text Block does not match the Layout Width of that Text Block. For example:
HORIZONTAL_MARGIN_PROPERTY
Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.
HORIZONTAL_PADDING_PROPERTY
Sets the padding spaces between the content and the left and right boundaries of the Text node.
HOVER_PROPERTY
Indicates whether a node is the foremost hit testable node under the cursor.
INPUT_METHOD_ACTION
Occurs when the user taps the action button on their on-screen keyboard while editing the text in a Text Box node.
INPUT_METHOD_ACTION_PROPERTY
Sets the label of the user action button on the on-screen keyboard for this Text Box. By default uses the label of the default input method of the operating system.
INPUT_METHOD_AVAILABLE
Occurs when an input method becomes available to a Text Box node. For example, an on-screen keyboard becomes available when it appears on the screen.
INPUT_METHOD_UNAVAILABLE
Occurs when the input method that is composing text in a Text Box node becomes unavailable. For example, an on-screen keyboard becomes unavailable when the user hides it.
INPUT_TYPE_PROPERTY
Sets the input type of the input methods that provide the input layout to let the user enter and edit text of specific type in the Text Box node:
INSERT_TEXT
In a Text Box node, inserts text at a specified character index.
INSERT_TEXT_AT_CURSOR
In a Text Box node, adds text at the cursor position. Set the value of the Text property to the text that you want to add.
INode2DBase
IS_COMPOSING_TEXT_PROPERTY
Reports the text composition state of the Text Box node.
IS_EDITING_PROPERTY
Reports the editing state of the Text Box node.
InputMethodActionMessageArguments
InputMethodAvailableMessageArguments
LAYOUT_TRANSFORMATION_PROPERTY
The 2D transformation to be applied before layouting.
LEFT_EDITING_STATE
Occurs when a Text Box node leaves the editing state
LINE_SPACING_PROPERTY
Sets the line spacing in multiples of the normal line height of the selected font.
LOCALE_PROPERTY
The locale of the node.
MAXIMUM_TEXT_LENGTH_PROPERTY
Sets the maximum length of text that the user can insert in the Text Box node. The unit is a UTF-8 character and the buffer byte length can be greater for multi-byte characters.
MOVE_CURSOR_BACKWARD
In a Text Box node, moves the cursor backward by one character.
MOVE_CURSOR_FORWARD
In a Text Box node, moves the cursor forward by one character.
MOVE_CURSOR_HOME
In a Text Box node, moves the cursor ahead of the first character of the text content.
MOVE_CURSOR_TO_END
In a Text Box node, moves the cursor after the last character of the text content.
MOVE_CURSOR_TO_NEXT_WORD
In a Text Box node, moves the cursor forward to the next word boundary.
MOVE_CURSOR_TO_PREVIOUS_WORD
In a Text Box node, moves the cursor backward to the previous word boundary.
MOVE_SELECTION_END_BACKWARD
In a Text Box node, moves the handle at the end of text selection backward by one character.
MOVE_SELECTION_END_FORWARD
In a Text Box node, moves the handle at the end of text selection forward by one character.
MOVE_SELECTION_END_TO_NEXT_WORD
In a Text Box node, moves the handle at the end of text selection forward to the start of the next word.
MOVE_SELECTION_END_TO_PREVIOUS_WORD
In a Text Box node, moves the handle at the end of text selection backward to the start of the previous word.
MOVE_SELECTION_START_BACKWARD
In a Text Box node, moves the handle at the beginning of text selection backward by one character.
MOVE_SELECTION_START_FORWARD
In a Text Box node, moves the handle at the beginning of text selection forward by one character.
MOVE_SELECTION_START_TO_NEXT_WORD
In a Text Box node, moves the handle at the beginning of text selection forward to the start of the next word.
MOVE_SELECTION_START_TO_PREVIOUS_WORD
In a Text Box node, moves the handle at the beginning of text selection backward to the start of the previous word.
MULTISAMPLE_LEVEL_PROPERTY
Sets the amount of multisample anti-aliasing to apply to the temporary composition targets to which Kanzi renders this node.
MessageSubscriptionToken
Message subscription token for nodes.
ModifyEditingStateMessageArguments
ModifySelectionMessageArguments
MoveCursorMessageArguments
NAME_PROPERTY
Node name.
Node
Base class for Kanzi nodes.
Node2D
Node2D is the base class of 2D nodes.
Node2DChildrenIterator
NodeComponentIterator
OFFSCREEN_RENDERING_PROPERTY
When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen.
OPACITY_PROPERTY
Opacity of the node.
OVERFLOW_PROPERTY
Sets the characters that represent the truncated text when the text does not fit in this node. The default value is ‘…’. By default, Kanzi truncates the text at the end. Use the Truncation Direction property to set the part of the text that you want to truncate.
PASSWORD_ECHO_TIMEOUT_PROPERTY
When the Echo Mode property is set to Password, this property sets the time in milliseconds that an inserted character is visible before being masked.
PASSWORD_MASKING_CHARACTER_PROPERTY
When the Echo Mode property is set to Password, this property sets the character that masks each character that the application user enters.
PATH_PROPERTY
Full path to the node.
PERSPECTIVE_TRANSFORMATION_FOV_PROPERTY
The 3D transformation field of view (degrees) to be applied after layouting.
PERSPECTIVE_TRANSFORMATION_MODE_PROPERTY
Defines the mode of operation for the coordinate system and field of view.
PERSPECTIVE_TRANSFORMATION_ORIGIN_PROPERTY
The 3D transformation origin to be used for perspective transformation on this or child nodes.
PERSPECTIVE_TRANSFORMATION_PIVOT_PROPERTY
The 3D pivot point in relative coordinates.
PERSPECTIVE_TRANSFORMATION_PROPERTY
The 3D transformation to be applied after layouting.
PIXEL_FORMAT_PROPERTY
The pixel format of the node if rendering to a texture.
PROJECTION_2D_TO_3D_SCALE_PROPERTY
Sets the scale factor to project pixels to 3D size. When scale is 1, then the size of one pixel is one 3D space unit.
READ_ONLY_PROPERTY
Sets whether the Text Box node is editable. When you enable this property, you can set the text only through the Text property and the user cannot edit the text in the Text Box node.
REMOVE_SIDE_BEARINGS_PROPERTY
Whether to position the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node.
RENDER_SELF_PROPERTY
Whether the node renders itself. Does not affect the rendering of child nodes.
RENDER_TARGET_MINIMUM_HEIGHT_PROPERTY
Sets the minimum height of implicitly generated render targets.
RENDER_TARGET_MINIMUM_WIDTH_PROPERTY
Sets the minimum width of implicitly generated render targets.
RENDER_TARGET_PROPERTY
Forces the node to be rendered into a given render target texture. When set to “No Target”, regular conditions whether node is rendered to a texture, such as opacity and rotation, are applied.
RENDER_TARGET_REALLOCATION_LIMIT_PROPERTY
The change in size that triggers reallocation of a render target.
RENDER_TRANSFORMATION_ORIGIN_PROPERTY
Sets the render transform origin in relative coordinates.
RENDER_TRANSFORMATION_PROPERTY
The 2D transformation to be applied after layouting.
SELECTION_BACKGROUND_BRUSH_PROPERTY
Sets the brush that highlights the selected text.
SELECTION_CHANGED
Occurs when the user changes the text selection in a Text Box node.
SELECTION_CLEARED
Occurs when the user clears or resets the text selection in a Text Box node.
SELECTION_END_CURSOR_POSITION_PROPERTY
The position of the cursor that marks the end of text selection in the Text Box node.
SELECTION_END_PREFAB_PROPERTY
Sets the prefab template that defines the appearance of the selection handle at the end of text selection instead of the default handle.
SELECTION_FOREGROUND_BRUSH_PROPERTY
Sets the brush for the selected text.
SELECTION_STARTED
Occurs when the user starts selecting text in a Text Box node.
SELECTION_START_CURSOR_POSITION_PROPERTY
The position of the cursor that marks the beginning of text selection in the Text Box node.
SELECTION_START_PREFAB_PROPERTY
Sets the prefab template that defines the appearance of the selection handle at the beginning of text selection instead of the default handle.
SELECT_ALL
In a Text Box node, selects all text.
SELECT_TEXT
In a Text Box node, selects the text between given start and end character indexes.
SELECT_TO_END
In a Text Box node, selects the text from the cursor position to the end of the text.
SELECT_TO_HOME
In a Text Box node, selects the text from the start of the text to the cursor position.
SELECT_WORD_AT_CURSOR
In a Text Box node, selects the word at the cursor position.
SIZE_PROPERTY
Sets the size of the font in pixels.
SNAP_CHARACTER_TO_PIXEL_PROPERTY_PROPERTY
Sets whether Kanzi positions characters in 2D rendering to the nearest pixel:
SNAP_TO_PIXEL_PROPERTY
Snap the translation of the node and its size into pixel boundary.
STATE_MANAGER_PROPERTY
Sets the State Manager to the node.
STYLE_PROPERTY
Sets a style to the node.
SelectedTextMessageArguments
TEXT_CHANGED
Occurs when the user changes the text in a Text Box node.
TEXT_COMPOSITION_CANCELED
Occurs:
TEXT_HINT_PREFAB_PROPERTY
Sets the prefab template for showing placeholder content when the Text Box node is empty.
TEXT_HORIZONTAL_ALIGNMENT_PROPERTY
Sets the horizontal alignment of the text.
TEXT_KEY_NAVIGATION_DIRECTION_PROPERTY
Sets the text key navigation direction.
TEXT_PROPERTY
Sets the text content that the text node renders. To create a line break press Shift+Enter.
TEXT_VERTICAL_ALIGNMENT_PROPERTY
Sets the vertical alignment of the text.
TRUNCATION_DIRECTION_PROPERTY
Sets which part Kanzi truncates when either the Truncation or Overflow property is set and the text does not fit in this node:
TRUNCATION_PROPERTY
Sets how Kanzi truncates text when either Truncation or Overflow property is set and the text does not fit in this node:
TextBox2D
TextBox2D provides the required overrides to handle 2D rendering and gesture handling for the 2D text input.
TextBoxConcept
TextChangedMessageArguments
TextCompositionStateMessageArguments
TextConcept
TextContentMessageArguments
TextInsertionMessageArguments
TextRangeMessageArguments
VERTICAL_ALIGNMENT_PROPERTY
The alignment in vertical direction the node should use when it resides under a layout.
VERTICAL_MARGIN_PROPERTY
Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.
VERTICAL_PADDING_PROPERTY
Sets the padding spaces between the content and the top and bottom boundaries of the Text node.
VISIBLE_AMOUNT_IN_PARENT_PROPERTY
Sets the amount the node is inside its parent. Use the value of this property in shaders to implement fades. Calculated by the parent node.
VISIBLE_PROPERTY
When disabled, Kanzi does not render the node.
WEIGHT_PROPERTY
Sets the weight of the font.
WIDTH_PROPERTY
The width of the node when used in a layout. Overrides the default bounds of the item.
WORD_COUNT_PROPERTY

Enums§

ContentStretch
Content stretch option.
DepthAlignment
Depth alignment options.
EditMode
The edit modes.
ForegroundHint
Hint for foreground handling of nodes.
HorizontalAlignment
Horizontal alignment options.
PerspectiveTransformationMode
Node2D perspective transformation mode.
PixelFormat
Pixel formats.
VerticalAlignment
Vertical alignment options.

Traits§

Handler
IFontStyleConcept
FontStyleConcept is the base class for the nodes that draw text with different font styles.
INode2D
ITextBoxConcept
Use the Text %Box nodes to add single-line text input to your application. Use TextBox3D to add text input in 3D space and TextBox2D to add text input in 2D space.
ITextConcept
TextConcept is the base class for the nodes that implement text rendering.

Functions§

MessageSubscriptionToken_Handler_drop
MessageSubscriptionToken_Handler_executor_ref