Struct Svg 

pub struct Svg<'a, Theme = Theme>
where
    Theme: Catalog,
{ /* private fields */ }

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.

Example

use iced::widget::svg;

enum Message {
    // ...
}

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

Implementations

impl<'a, Theme> Svg<'a, Theme>

where Theme: Catalog,

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

Available on crate feature svg only.

Creates a new Svg from the given Handle.

pub fn from_path(path: impl Into<PathBuf>) -> Svg<'a, Theme>

Available on crate feature svg only.

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<'a, Theme>

Available on crate feature svg only.

Sets the width of the Svg.

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

Available on crate feature svg only.

Sets the height of the Svg.

pub fn content_fit(self, content_fit: ContentFit) -> Svg<'a, Theme>

Available on crate feature svg only.

Sets the ContentFit of the Svg.

Defaults to ContentFit::Contain

pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> Svg<'a, Theme>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme, Status) -> Style + 'a>>,

Available on crate feature svg only.

Sets the style of the Svg.

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

Available on crate features svg and advanced only.

Sets the style class of the Svg.

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

Available on crate feature svg only.

Applies the given Rotation to the Svg.

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

Available on crate feature svg only.

Sets the opacity of the Svg.

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

pub fn alt(self, text: impl Into<String>) -> Svg<'a, Theme>

Available on crate feature svg only.

Sets the alt text of the Svg.

This is the accessible name announced by screen readers. It should be a short phrase describing the image content.

pub fn description(self, description: impl Into<String>) -> Svg<'a, Theme>

Available on crate feature svg only.

Sets an extended description of the Svg.

This supplements the alt text with additional context for assistive technology, when the alt text alone is not sufficient.

Trait Implementations

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

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

fn from(icon: Svg<'a, Theme>) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

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

where Renderer: Renderer, Theme: Catalog,

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

Returns the Size of the Widget in lengths.

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

Returns the layout::Node of the Widget.

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

Processes a runtime Event.

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 operate( &mut self, _tree: &mut Tree, layout: Layout<'_>, _renderer: &Renderer, operation: &mut dyn Operation, )

Applies an Operation to the Widget.

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

Reconciles the Widget with the provided Tree.

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

Returns the current mouse::Interaction of the Widget.

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

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