Struct Image

pub struct Image<'a, Handle = Handle> { /* private fields */ }

A frame that displays an image while keeping aspect ratio.

Example

use iced::widget::image;

enum Message {
    // ...
}

fn view(state: &State) -> Element<'_, Message> {
    image("ferris.png").into()
}

Implementations

impl<'a, Handle> Image<'a, Handle>

pub fn new(handle: impl Into<Handle>) -> Image<'a, Handle>

Creates a new Image with the given path.

pub fn border_radius(self, border_radius: [f32; 4]) -> Image<'a, Handle>

Sets the border radius of the image.

pub fn width(self, width: impl Into<Length>) -> Image<'a, Handle>

Sets the width of the Image boundaries.

pub fn height(self, height: impl Into<Length>) -> Image<'a, Handle>

Sets the height of the Image boundaries.

pub fn content_fit(self, content_fit: ContentFit) -> Image<'a, Handle>

Sets the ContentFit of the Image.

Defaults to ContentFit::Contain

pub fn filter_method(self, filter_method: FilterMethod) -> Image<'a, Handle>

Sets the FilterMethod of the Image.

pub fn rotation(self, rotation: impl Into<Rotation>) -> Image<'a, Handle>

Applies the given Rotation to the Image.

pub fn opacity(self, opacity: impl Into<f32>) -> Image<'a, Handle>

Sets the opacity of the Image.

It should be in the [0.0, 1.0] range—0.0 meaning completely transparent, and 1.0 meaning completely opaque.

pub fn name(self, name: impl Into<Cow<'a, str>>) -> Image<'a, Handle>

Sets the name of the Image.

pub fn description_widget<T>(self, description: &T) -> Image<'a, Handle>

where T: Describes,

Sets the description of the Image.

pub fn description( self, description: impl Into<Cow<'a, str>>, ) -> Image<'a, Handle>

Sets the description of the Image.

pub fn label(self, label: &dyn Labels) -> Image<'a, Handle>

Sets the label of the Image.

Trait Implementations

impl<'a, Handle> Debug for Image<'a, Handle>

where Handle: Debug,

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

Formats the value using the given formatter.

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

where Renderer: Renderer<Handle = Handle>, Handle: Clone + 'a,

fn from(image: Image<'a, Handle>) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer, Handle> Widget<Message, Theme, Renderer> for Image<'a, Handle>

where Renderer: Renderer<Handle = Handle>, Handle: Clone,

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 draw( &self, _state: &Tree, renderer: &mut Renderer, _theme: &Theme, _style: &Style, layout: Layout<'_>, _cursor: Cursor, _viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn a11y_nodes( &self, layout: Layout<'_>, _state: &Tree, _cursor: Cursor, ) -> A11yTree

get the a11y nodes for the widget and its children

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

Returns the id of the widget

fn set_id(&mut self, id: Id)

Sets the id of the widget This may be called while diffing the widget tree

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

Returns a Size hint for laying out the Widget.

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(&mut self, _tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn on_event( &mut self, _state: &mut Tree, _event: Event, _layout: Layout<'_>, _cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, _shell: &mut Shell<'_, Message>, _viewport: &Rectangle, ) -> Status

Processes a runtime Event.

fn mouse_interaction( &self, _state: &Tree, _layout: Layout<'_>, _cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

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

fn drag_destinations( &self, _state: &Tree, _layout: Layout<'_>, _renderer: &Renderer, _dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.