Struct iced::widget::Svg

pub struct Svg<Renderer>where
    Renderer: Renderer,
    <Renderer as Renderer>::Theme: StyleSheet,{ /* private fields */ }

Available on crate feature svg only.

A vector graphics image.

An Svg image resizes smoothly without losing any quality.

Svg images can have a considerable rendering cost when resized, specially when they are complex.

Implementations

impl<Renderer> Svg<Renderer>where Renderer: Renderer, <Renderer as Renderer>::Theme: StyleSheet,

pub fn new(handle: impl Into<Handle>) -> Svg<Renderer>

Creates a new Svg from the given Handle.

pub fn from_path(path: impl Into<PathBuf>) -> Svg<Renderer>

Creates a new Svg that will display the contents of the file at the provided path.

pub fn width(self, width: impl Into<Length>) -> Svg<Renderer>

Sets the width of the Svg.

pub fn height(self, height: impl Into<Length>) -> Svg<Renderer>

Sets the height of the Svg.

pub fn content_fit(self, content_fit: ContentFit) -> Svg<Renderer>

Sets the ContentFit of the Svg.

Defaults to ContentFit::Contain

pub fn style( self, style: <<Renderer as Renderer>::Theme as StyleSheet>::Style ) -> Svg<Renderer>

Sets the style variant of this Svg.

Trait Implementations

impl<Message, Renderer> Widget<Message, Renderer> for Svg<Renderer>where Renderer: Renderer, <Renderer as Renderer>::Theme: StyleSheet,

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

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

Returns the layout::Node of the Widget.

fn draw( &self, _state: &Tree, renderer: &mut Renderer, theme: &<Renderer as Renderer>::Theme, _style: &Style, layout: Layout<'_>, _cursor_position: Point, _viewport: &Rectangle<f32> )

Draws the Widget using the associated 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, Global>

Returns the state Tree of the children of the Widget.

fn diff(&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<Message> )

Applies an Operation to the Widget.

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

Processes a runtime Event.

fn mouse_interaction( &self, _state: &Tree, _layout: Layout<'_>, _cursor_position: Point, _viewport: &Rectangle<f32>, _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 ) -> Option<Element<'a, Message, Renderer>>

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