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>

Creates a new Svg from the given Handle.

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

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>

Sets the width of the Svg.

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

Sets the height of the Svg.

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

Sets the ContentFit of the Svg.

Defaults to ContentFit::Contain

pub fn symbolic(self, symbolic: bool) -> Svg<'a, Theme>

Symbolic icons inherit their color from the renderer if a color is not defined.

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>>,

Sets the style of the Svg.

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

Sets the style class of the Svg.

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

Applies the given Rotation to the Svg.

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

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 name(self, name: impl Into<Cow<'a, str>>) -> Svg<'a, Theme>

Sets the name of the Svg.

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

where T: Describes,

Sets the description of the Svg.

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

Sets the description of the Svg.

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

Sets the label of the Svg.

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<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Svg<'a, Theme>

where Renderer: Renderer, Theme: Catalog,

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, renderer_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.