Struct CursorArea 

pub struct CursorArea { /* private fields */ }

A container that changes the cursor icon when hovered.

When the component is dropped while still being hovered, the cursor is automatically reset to the default.

Example

fn app() -> impl IntoElement {
    CursorArea::new().child("Hover me!")
}

Implementations

impl CursorArea

pub fn new() -> Self

pub fn icon(self, cursor_icon: CursorIcon) -> Self

Set the cursor icon to show when hovered. Default is [CursorIcon::Pointer].

Trait Implementations

impl ChildrenExt for CursorArea

fn get_children(&mut self) -> &mut Vec<Element>

Returns a mutable reference to the internal children vector.

fn children(self, children: impl IntoIterator<Item = Element>) -> Self

Extends the children with an iterable of Elements.

fn maybe_child<C>(self, child: Option<C>) -> Self

where C: IntoElement,

Appends a child only when the Option is Some.

fn child<C>(self, child: C) -> Self

where C: IntoElement,

Appends a single child element.

impl Clone for CursorArea

fn clone(&self) -> CursorArea

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for CursorArea

fn render(&self) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl ContainerExt for CursorArea

fn position(self, position: impl Into<Position>) -> Self

Set how the element is placed relative to its parent or the window. See Position.

fn padding(self, padding: impl Into<Gaps>) -> Self

Set the inner spacing between the element’s edges and its content. See Gaps.

fn margin(self, margin: impl Into<Gaps>) -> Self

Set the outer spacing between the element’s edges and its surroundings. See Gaps.

fn min_width(self, minimum_width: impl Into<Size>) -> Self

Set the minimum width the element can shrink to. See Size.

fn min_height(self, minimum_height: impl Into<Size>) -> Self

Set the minimum height the element can shrink to. See Size.

fn max_width(self, maximum_width: impl Into<Size>) -> Self

Set the maximum width the element can grow to. See Size.

fn max_height(self, maximum_height: impl Into<Size>) -> Self

Set the maximum height the element can grow to. See Size.

fn visible_width(self, visible_width: impl Into<VisibleSize>) -> Self

Set how much of the measured width is actually used in layout. See VisibleSize.

fn visible_height(self, visible_height: impl Into<VisibleSize>) -> Self

Set how much of the measured height is actually used in layout. See VisibleSize.

impl Default for CursorArea

fn default() -> Self

Returns the “default value” for a type.

impl KeyExt for CursorArea

fn write_key(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.

fn key(self, key: impl Hash) -> Self

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists.

impl LayoutExt for CursorArea

fn get_layout(&mut self) -> &mut LayoutData

Returns a mutable reference to the element’s layout data.

fn layout(self, layout: LayoutData) -> Self

Replace all of the element’s layout data at once. See LayoutData.

impl PartialEq for CursorArea

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CursorArea