Skip to main content

Float

Struct Float 

Source
pub struct Float<'a, Message, Theme = Theme, Renderer = Renderer>
where Theme: Catalog,
{ /* private fields */ }
Expand description

A widget that can make its contents float over other widgets.

Implementations§

Source§

impl<'a, Message, Theme, Renderer> Float<'a, Message, Theme, Renderer>
where Theme: Catalog,

Source

pub fn new(content: impl Into<Element<'a, Message, Theme, Renderer>>) -> Self

Creates a new Float widget with the given content.

Source

pub fn scale(self, scale: f32) -> Self

Sets the scale to be applied to the contents of the Float.

Source

pub fn translate( self, translate: impl Fn(Rectangle, Rectangle) -> Vector + 'a, ) -> Self

Sets the translation logic to be applied to the contents of the Float.

The logic takes the original (non-scaled) bounds of the contents and the viewport bounds. These bounds can be useful to ensure the floating elements always stay on screen.

Source

pub fn style(self, style: impl Fn(&Theme) -> Style + 'a) -> Self
where Theme::Class<'a>: From<StyleFn<'a, Theme>>,

Sets the style of the Float.

Source

pub fn class(self, class: impl Into<Theme::Class<'a>>) -> Self

Available on crate feature advanced only.

Sets the style class of the Float.

Trait Implementations§

Source§

impl<'a, Message, Theme, Renderer> From<Float<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>
where Message: 'a, Theme: Catalog + 'a, Renderer: Renderer + 'a,

Source§

fn from(float: Float<'a, Message, Theme, Renderer>) -> Self

Converts to this type from the input type.
Source§

impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Float<'_, Message, Theme, Renderer>
where Theme: Catalog, Renderer: Renderer,

Source§

fn tag(&self) -> Tag

Returns the Tag of the Widget.
Source§

fn state(&self) -> State

Returns the State of the Widget.
Source§

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.
Source§

fn diff(&self, tree: &mut Tree)

Reconciles the Widget with the provided Tree.
Source§

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.
Source§

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget. Read more
Source§

fn layout( &mut self, tree: &mut Tree, renderer: &Renderer, limits: &Limits, ) -> Node

Returns the layout::Node of the Widget. Read more
Source§

fn update( &mut self, tree: &mut Tree, event: &Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, shell: &mut Shell<'_, Message>, viewport: &Rectangle, )

Processes a runtime Event. Read more
Source§

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, style: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.
Source§

fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget. Read more
Source§

fn operate( &mut self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation, )

Applies an Operation to the Widget.
Source§

fn overlay<'a>( &'a mut self, state: &'a mut Tree, layout: Layout<'a>, renderer: &Renderer, viewport: &Rectangle, offset: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.

Auto Trait Implementations§

§

impl<'a, Message, Theme, Renderer> Freeze for Float<'a, Message, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: Freeze,

§

impl<'a, Message, Theme = Theme, Renderer = Renderer> !RefUnwindSafe for Float<'a, Message, Theme, Renderer>

§

impl<'a, Message, Theme = Theme, Renderer = Renderer> !Send for Float<'a, Message, Theme, Renderer>

§

impl<'a, Message, Theme = Theme, Renderer = Renderer> !Sync for Float<'a, Message, Theme, Renderer>

§

impl<'a, Message, Theme, Renderer> Unpin for Float<'a, Message, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: Unpin,

§

impl<'a, Message, Theme, Renderer> UnsafeUnpin for Float<'a, Message, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: UnsafeUnpin,

§

impl<'a, Message, Theme = Theme, Renderer = Renderer> !UnwindSafe for Float<'a, Message, Theme, Renderer>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.