Struct Modifier 

pub struct Modifier { /* private fields */ }

A persistent handle to a modifier chain.

Implementations

impl Modifier

pub fn on_layout_size_changed<F>(self, handler: F) -> Self

where F: Into<CallbackWith<PxSize>>,

Observes measured dimensions in local layout units after initial placement and size changes. Moving or scaling an ancestor does not trigger a callback unless the local measured size changes. Hidden layouts resume observation when placed again.

pub fn on_visible_window_bounds<F>(self, handler: F) -> Self

where F: Into<CallbackWith<Option<FloatRect>>>,

Observes the window-space bounds remaining after ancestor rectangular clipping and window boundaries. Reports None when fully clipped or when a previously placed layout becomes unplaced. Shape bounds are included; occlusion by other content is not considered.

pub fn layout_coordinate_space(self) -> Self

Uses this layout’s local units as a coordinate space for descendant Self::on_layout_rect_in_space observers, including this layout. Nested spaces take precedence over their ancestors.

pub fn on_layout_rect_in_space<F>(self, handler: F) -> Self

where F: Into<CallbackWith<FloatRect>>,

Observes this layout’s fractional bounds in the nearest declared Self::layout_coordinate_space. Without a declared space, observes window bounds. Calls after initial placement and when these bounds change; moving or scaling the entire space does not trigger a callback. Hidden layouts resume observation when placed again.

pub fn new() -> Self

Creates an empty modifier chain.

pub fn then(self, other: Modifier) -> Self

Appends another modifier chain after this one without flattening it.

pub fn nested_scroll(self, connection: NestedScrollConnection) -> Self

Attaches a nested scroll connection to this node.

pub fn attach(self)

Attaches this modifier chain to the current component node.

pub fn run<F>(self, child: F)

where F: Fn() + Send + Sync + 'static,

Attaches this modifier chain to the current node and then runs child.

pub fn is_empty(&self) -> bool

Returns true when the modifier has no actions.

Trait Implementations

impl Clone for Modifier

fn clone(&self) -> Modifier

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CursorModifierExt for Modifier

fn hover_cursor_icon(self, icon: CursorIcon) -> Modifier

Sets the cursor icon used while the pointer hovers this node.

impl Debug for Modifier

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

Formats the value using the given formatter.

impl Default for Modifier

fn default() -> Modifier

Returns the “default value” for a type.

impl Eq for Modifier

impl FocusModifierExt for Modifier

fn focusable(self) -> Modifier

Registers a focus target for this subtree.

fn focus_requester(self, requester: FocusRequester) -> Modifier

Binds an explicit focus requester to this subtree.

fn focus_properties(self, properties: FocusProperties) -> Modifier

Applies explicit focus properties to this subtree.

fn preferred_tab_stop(self, preferred: bool) -> Modifier

Prefers this focus target when Tab enters a group with a single Tab stop, preserving its other focus properties.

fn focus_group(self) -> Modifier

Registers a traversal-only focus group for this subtree.

fn focus_scope_with(self, scope: FocusScopeNode) -> Modifier

Registers an explicit focus scope handle for this subtree.

fn focus_group_with(self, group: FocusGroupNode) -> Modifier

Registers an explicit focus group handle for this subtree.

fn focus_restorer(self, fallback: Option<FocusRequester>) -> Modifier

Registers a focus scope with restore behavior for this subtree.

fn focus_restorer_with( self, scope: FocusScopeNode, fallback: Option<FocusRequester>, ) -> Modifier

Registers an explicit focus restorer scope for this subtree.

fn focus_traversal_policy(self, policy: FocusTraversalPolicy) -> Modifier

Applies a traversal policy to the current focus group or scope.

fn on_focus_changed<F>(self, handler: F) -> Modifier

where F: Into<CallbackWith<FocusState>>,

Registers a callback that runs when the subtree focus state changes.

fn on_focus_event<F>(self, handler: F) -> Modifier

where F: Into<CallbackWith<FocusState>>,

Registers a callback that observes focus events for this subtree.

fn focus_beyond_bounds_handler<F>(self, handler: F) -> Modifier

where F: Into<CallbackWith<FocusDirection, bool>>,

Registers a callback that moves focus beyond the current viewport.

fn focus_reveal_handler<F>(self, handler: F) -> Modifier

where F: Into<CallbackWith<FocusRevealRequest, bool>>,

Registers a callback that reveals the focused target within the viewport.

fn on_globally_positioned<F>(self, handler: F) -> Modifier

where F: Into<CallbackWith<PxRect>>,

Registers a callback invoked with this node’s window rectangle after attachment and whenever the rectangle changes.

fn on_globally_positioned_precise<F>(self, handler: F) -> Modifier

where F: Into<CallbackWith<FloatRect>>,

Observes this node’s exact fractional rectangle in window coordinates.

fn on_local_to_window<F>(self, handler: F) -> Modifier

where F: Into<CallbackWith<LocalToWindow>>,

Observes the transformation from this node’s local units to the window.

fn on_layout_coordinates<F>(self, handler: F) -> Modifier

where F: Into<CallbackWith<LayoutCoordinates>>,

Observes local layout dimensions and their exact transformation to the window.

impl Hash for Modifier

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ModifierCapabilityExt for Modifier

fn push_clipboard_input<N>(self, node: N) -> Self

where N: ClipboardInputModifierNode,

Appends a clipboard-input modifier for focused content.

fn push_layout<N>(self, node: N) -> Self

where N: LayoutModifierNode + PartialEq,

Appends a layout modifier node to the current modifier chain.

fn push_placement<N>(self, node: N) -> Self

where N: PlacementModifierNode + PartialEq,

Appends a placement modifier node to the current modifier chain.

fn push_draw<N>(self, node: N) -> Self

where N: DrawModifierNode,

Appends a draw modifier node to the current modifier chain.

fn push_parent_data<N>(self, node: N) -> Self

where N: ParentDataModifierNode,

Appends a parent-data modifier node to the current modifier chain.

fn push_build<N>(self, node: N) -> Self

where N: BuildModifierNode,

Appends a build modifier node to the current modifier chain.

fn push_semantics<N>(self, node: N) -> Self

where N: SemanticsModifierNode,

Appends a semantics modifier node to the current modifier chain.

fn push_pointer_preview_input<N>(self, node: N) -> Self

where N: PointerInputModifierNode,

Appends a preview pointer-input modifier node to the current modifier chain.

fn push_pointer_input<N>(self, node: N) -> Self

where N: PointerInputModifierNode,

Appends a pointer-input modifier node to the current modifier chain.

fn push_pointer_final_input<N>(self, node: N) -> Self

where N: PointerInputModifierNode,

Appends a final pointer-input modifier node to the current modifier chain.

fn push_keyboard_preview_input<N>(self, node: N) -> Self

where N: KeyboardInputModifierNode,

Appends a preview keyboard-input modifier node to the current modifier chain.

fn push_keyboard_input<N>(self, node: N) -> Self

where N: KeyboardInputModifierNode,

Appends a keyboard-input modifier node to the current modifier chain.

fn push_ime_preview_input<N>(self, node: N) -> Self

where N: ImeInputModifierNode,

Appends a preview IME-input modifier node to the current modifier chain.

fn push_ime_input<N>(self, node: N) -> Self

where N: ImeInputModifierNode,

Appends an IME-input modifier node to the current modifier chain.

impl PartialEq for Modifier

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.