Struct Pin

pub struct Pin<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>>
where
    Renderer: Renderer,
{ /* private fields */ }

A widget that positions its contents at some fixed coordinates inside of its boundaries.

By default, a Pin widget will try to fill its parent.

Example

use iced::widget::pin;
use iced::Fill;

enum Message {
    // ...
}

fn view(state: &State) -> Element<'_, Message> {
    pin("This text is displayed at coordinates (50, 50)!")
        .x(50)
        .y(50)
        .into()
}

Implementations

impl<'a, Message, Theme, Renderer> Pin<'a, Message, Theme, Renderer>

where Renderer: Renderer,

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

Creates a Pin widget with the given content.

pub fn width( self, width: impl Into<Length>, ) -> Pin<'a, Message, Theme, Renderer>

Sets the width of the Pin.

pub fn height( self, height: impl Into<Length>, ) -> Pin<'a, Message, Theme, Renderer>

Sets the height of the Pin.

pub fn position( self, position: impl Into<Point>, ) -> Pin<'a, Message, Theme, Renderer>

Sets the position of the Pin; where the pinned widget will be displayed.

pub fn x(self, x: impl Into<Pixels>) -> Pin<'a, Message, Theme, Renderer>

Sets the X coordinate of the Pin.

pub fn y(self, y: impl Into<Pixels>) -> Pin<'a, Message, Theme, Renderer>

Sets the Y coordinate of the Pin.

Trait Implementations

impl<'a, Message, Theme, Renderer> From<Pin<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Message: 'a, Theme: 'a, Renderer: Renderer + 'a,

fn from( pin: Pin<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Pin<'_, Message, Theme, Renderer>

where Renderer: Renderer,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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

Returns the state Tree of the children of the Widget.

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

Reconciles the Widget with the provided Tree.

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

Returns the Size of the Widget in lengths.

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

Returns the layout::Node of the Widget.

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

Applies an Operation to the Widget.

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

Processes a runtime Event.

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

Returns the current mouse::Interaction of the Widget.

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.

fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'_>, renderer: &Renderer, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

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

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

Returns a Size hint for laying out the Widget.