Struct TextFieldModifierNode 

pub struct TextFieldModifierNode { /* private fields */ }

The modifier node behind an editable text field. It measures and draws the text, the cursor and the selection, and handles pointer input.

Implementations

impl TextFieldModifierNode

pub fn new(state: TextFieldState, style: TextStyle) -> Self

Creates a new text field modifier node.

pub fn with_line_limits(self, line_limits: TextFieldLineLimits) -> Self

Creates a node with custom line limits.

pub fn with_handle_controller( self, controller: TextFieldHandleController, ) -> Self

Installs the controller the field publishes live handle metrics to.

pub fn text_pan_resolver(&self) -> Option<TextPanResolver>

Returns the pan resolver for single-line fields, None for multi-line.

Exposed to the modifier slices so the render scene builder can pan the text glyphs by the same offset used for the cursor and selection.

pub fn scroll_offset(&self) -> f32

Returns the current horizontal scroll (pan) offset in px.

pub fn line_limits(&self) -> TextFieldLineLimits

Returns the current line limits configuration.

pub fn with_cursor_color(self, color: Color) -> Self

Creates a node with a custom accent: the caret is drawn solid in color and the selection highlight is derived from it at crate::widgets::SELECTION_HIGHLIGHT_ALPHA — the reference field tints caret, handles and highlight from the one accent.

pub fn set_focused(&mut self, focused: bool)

Sets the focus state.

pub fn is_focused(&self) -> bool

Returns whether the field is focused.

pub fn text(&self) -> String

Returns the current text.

pub fn style(&self) -> &TextStyle

Returns the text style the field lays out and draws with.

pub fn selection(&self) -> TextRange

Returns the current selection.

pub fn cursor_brush(&self) -> Brush

Returns the cursor brush for rendering.

pub fn selection_brush(&self) -> Brush

Returns the selection brush for rendering selection highlight.

Trait Implementations

impl Debug for TextFieldModifierNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DelegatableNode for TextFieldModifierNode

fn node_state(&self) -> &NodeState

The runtime state of this node. Return a NodeState field of the node; the chain uses it to link the node and to track its capabilities.

fn aggregate_child_capabilities(&self) -> NodeCapabilities

The union of the capabilities of this node and of every node after it in the chain.

impl DrawModifierNode for TextFieldModifierNode

fn create_draw_closure(&self) -> Option<Rc<dyn Fn(&mut DrawScopeDefault)>>

Creates a closure for deferred drawing that will be evaluated at render time.

fn create_behind_draw_closure( &self, ) -> Option<Rc<dyn Fn(&mut DrawScopeDefault)>>

Like create_draw_closure, but the primitives render BEHIND the node’s content — e.g. a text field’s selection highlight, which must sit under the glyphs (a highlight drawn over them tints the text with its translucent fill).

impl LayoutModifierNode for TextFieldModifierNode

fn measure( &self, context: &mut dyn ModifierNodeContext, _measurable: &dyn Measurable, constraints: Constraints, ) -> LayoutModifierMeasureResult

Measures the wrapped content and returns both the size this modifier occupies and where the wrapped content should be placed.

fn min_intrinsic_width( &self, _measurable: &dyn Measurable, _height: f32, density: f32, ) -> f32

Returns the minimum intrinsic width of this modifier node. The default is the wrapped content’s, for a node that keeps the content’s size.

fn max_intrinsic_width( &self, _measurable: &dyn Measurable, _height: f32, density: f32, ) -> f32

Returns the maximum intrinsic width of this modifier node. The default is the wrapped content’s, for a node that keeps the content’s size.

fn min_intrinsic_height( &self, _measurable: &dyn Measurable, width: f32, density: f32, ) -> f32

Returns the minimum intrinsic height of this modifier node. The default is the wrapped content’s, for a node that keeps the content’s size.

fn max_intrinsic_height( &self, _measurable: &dyn Measurable, width: f32, density: f32, ) -> f32

Returns the maximum intrinsic height of this modifier node. The default is the wrapped content’s, for a node that keeps the content’s size.

fn measure_hold( &self, _density: f32, _constraints: Constraints, _size: Size, _wrapped: WrappedHold, ) -> Option<ConstraintsHold>

The incoming constraints the last measure of this node, which gave size under constraints, holds for: every constraints inside give the same result. wrapped is what the content this node wraps measured. None, the default, holds for constraints alone; a node that tells must give the range its own measure keeps its result and hands its content constraints that wrapped holds for.

impl ModifierNode for TextFieldModifierNode

fn on_attach(&mut self, context: &mut dyn ModifierNodeContext)

Called once when the node joins an attached chain. context receives the invalidation requests of the node.

fn on_detach(&mut self)

Called when the node leaves the chain or when the chain detaches. Release here whatever on_attach acquired.

fn as_draw_node(&self) -> Option<&dyn DrawModifierNode>

Returns this node as a draw modifier if it implements the trait.

fn as_draw_node_mut(&mut self) -> Option<&mut dyn DrawModifierNode>

Returns this node as a mutable draw modifier if it implements the trait.

fn as_layout_node(&self) -> Option<&dyn LayoutModifierNode>

Returns this node as a layout modifier if it implements the trait.

fn as_layout_node_mut(&mut self) -> Option<&mut dyn LayoutModifierNode>

Returns this node as a mutable layout modifier if it implements the trait.

fn as_semantics_node(&self) -> Option<&dyn SemanticsNode>

Returns this node as a semantics modifier if it implements the trait.

fn as_semantics_node_mut(&mut self) -> Option<&mut dyn SemanticsNode>

Returns this node as a mutable semantics modifier if it implements the trait.

fn as_pointer_input_node(&self) -> Option<&dyn PointerInputNode>

Returns this node as a pointer-input modifier if it implements the trait.

fn as_pointer_input_node_mut(&mut self) -> Option<&mut dyn PointerInputNode>

Returns this node as a mutable pointer-input modifier if it implements the trait.

fn on_reset(&mut self)

Called when the chain is reset, as Compose’s onReset. Clear state that belongs to an earlier use of the node.

fn as_focus_node(&self) -> Option<&(dyn FocusNode + 'static)>

Returns this node as a focus modifier if it implements the trait.

fn as_focus_node_mut(&mut self) -> Option<&mut (dyn FocusNode + 'static)>

Returns this node as a mutable focus modifier if it implements the trait.

fn for_each_delegate<'b>( &'b self, _visitor: &mut dyn FnMut(&'b (dyn ModifierNode + 'static)), )

Visits every delegate node owned by this modifier.

fn for_each_delegate_mut<'b>( &'b mut self, _visitor: &mut dyn FnMut(&'b mut (dyn ModifierNode + 'static)), )

Visits every delegate node mutably.

impl PointerInputNode for TextFieldModifierNode

fn on_pointer_event( &mut self, _context: &mut dyn ModifierNodeContext, _event: &PointerEvent, ) -> bool

Called when a pointer event occurs within the bounds of this node. Returns true if the event was consumed and should not propagate further.

fn hit_test(&self, x: f32, y: f32) -> bool

Returns true if this node should participate in hit-testing for the given pointer position.

fn pointer_input_handler(&self) -> Option<Rc<dyn Fn(PointerEvent)>>

Returns an event handler closure if the node wants to participate in pointer dispatch.

fn layout_size_sink(&self) -> Option<Rc<Cell<Size>>>

Returns the cell this node reads its owning layout node’s resolved size from, if it exposes a size to its handler (Compose’s PointerInputScope.size).

impl SemanticsNode for TextFieldModifierNode

fn reach(&self) -> SemanticsReach

Neither modal nor hidden, but the field’s text and selection are read live from its state, which an app may set without touching the node.

fn merge_semantics(&self, config: &mut SemanticsConfiguration)

Merges semantic properties into the provided configuration.