Struct SharedOverlayElement 

pub struct SharedOverlayElement<K, E> { /* private fields */ }

Frame-scoped, window-coordinate position/crossfade appearance.

Implementations

impl<K, E> SharedOverlayElement<K, E>

pub fn transition(self, transition: Transition) -> Self

Chooses interruptible position and crossfade timing.

pub fn active(self, active: bool) -> Self

Fades a retiring appearance. Disable its child input and restore focus in the host before making interactive content inactive.

pub fn match_size(self, enabled: bool) -> Self

Follows the measured destination width/height immediately via native layout. Child sizes are retained when false; neither mode scales text.

Trait Implementations

impl<K: Eq + Hash + Clone + 'static, E: IntoElement + Styled + 'static> Element for SharedOverlayElement<K, E>

type RequestLayoutState = AnyElement

The type of state returned from Element::request_layout. A mutable reference to this state is subsequently provided to Element::prepaint and Element::paint.

type PrepaintState = bool

The type of state returned from Element::prepaint. A mutable reference to this state is subsequently provided to Element::paint.

fn id(&self) -> Option<ElementId>

If this element has a unique identifier, return it here. This is used to track elements across frames, and will cause a GlobalElementId to be passed to the request_layout, prepaint, and paint methods.

fn source_location(&self) -> Option<&'static Location<'static>>

Source location where this element was constructed, used to disambiguate elements in the inspector and navigate to their source code.

fn request_layout( &mut self, id: Option<&GlobalElementId>, _: Option<&InspectorElementId>, window: &mut Window, cx: &mut App, ) -> (LayoutId, AnyElement)

Before an element can be painted, we need to know where it’s going to be and how big it is. Use this method to request a layout from Taffy and initialize the element’s state.

fn prepaint( &mut self, _: Option<&GlobalElementId>, _: Option<&InspectorElementId>, bounds: Bounds<Pixels>, child: &mut AnyElement, window: &mut Window, cx: &mut App, ) -> bool

After laying out an element, we need to commit its bounds to the current frame for hitbox purposes. The state argument is the same state that was returned from Element::request_layout().

fn paint( &mut self, _: Option<&GlobalElementId>, _: Option<&InspectorElementId>, _: Bounds<Pixels>, child: &mut AnyElement, ready: &mut bool, window: &mut Window, cx: &mut App, )

Once layout has been completed, this method will be called to paint the element to the screen. The state argument is the same state that was returned from Element::request_layout().

fn a11y_role(&self) -> Option<Role>

Returns the accessible role for this element, if any. Elements that return None are not included in the accessibility tree.

fn write_a11y_info(&self, _node: &mut Node)

Write accessibility properties to the given node. Called only when a11y_role() returns Some.

fn a11y_synthetic_children( &mut self, _prepaint: &mut Self::PrepaintState, _builder: &mut A11ySubtreeBuilder<'_>, )

Add synthetic child nodes to an Element that has an .id() and a .role().

fn into_any(self) -> AnyElement

Convert this element into a dynamically-typed AnyElement.

impl<K: Eq + Hash + Clone + 'static, E: IntoElement + Styled + 'static> IntoElement for SharedOverlayElement<K, E>

type Element = SharedOverlayElement<K, E>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.