Struct Svg 

pub struct Svg { /* private fields */ }

Available on crate features image or svg or canvas only.

An SVG image widget

May be default constructed (result is empty).

The size of the widget is inferred from the SVG source in logical pixels then scaled by the display’s scale factor. If a different size should be used it must be set after loading the SVG data.

By default, the drawn SVG will not be allowed to scale above its specified size; if the widget is forced to stretch, content will be positioned within this space according to alignment rules (centered by default).

Implementations

impl Svg

pub fn new(data: &'static [u8]) -> Result<Svg, impl Error>

Construct from data

Returns an error if the SVG fails to parse. If using this method with include_bytes it is probably safe to unwrap.

The (logical) size of the widget is set to that from the SVG source.

pub fn new_path<P>(path: P) -> Result<Svg, impl Error>

where P: AsRef<Path>,

Construct from a path

pub fn load( &mut self, cx: &mut ConfigCx<'_>, data: &'static [u8], resources_dir: Option<&Path>, ) -> Result<(), impl Error + use<>>

Load from data

Replaces existing data and request a resize. The size is inferred from the SVG using units of logical pixels.

pub fn load_path<P>( &mut self, cx: &mut ConfigCx<'_>, path: P, ) -> Result<(), impl Error + use<P>>

where P: AsRef<Path>,

Load from a path

This is a wrapper around Self::load.

pub fn set_logical_size(&mut self, size: impl Into<LogicalSize>)

Set size in logical pixels

pub fn with_logical_size(self, size: impl Into<LogicalSize>) -> Svg

Set size in logical pixels (inline)

pub fn with_margin_style(self, style: MarginStyle) -> Svg

Set the margin style (inline)

By default, this is MarginStyle::Large.

pub fn with_fixed_aspect_ratio(self, fixed: bool) -> Svg

Control whether the aspect ratio is fixed (inline)

By default this is fixed.

pub fn with_stretch(self, stretch: Stretch) -> Svg

Set the stretch factor (inline)

By default this is Stretch::None. Particular to this widget, Stretch::None will avoid stretching of content, aligning instead.

Trait Implementations

impl Debug for Svg

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

Formats the value using the given formatter.

impl Default for Svg

fn default() -> Svg

Returns the “default value” for a type.

impl Events for Svg

fn handle_messages(&mut self, cx: &mut EventCx<'_>, _: &<Svg as Widget>::Data)

Handler for messages from children/descendants

fn handle_event( &mut self, _: &mut EventCx<'_>, _: &<Svg as Widget>::Data, _: Event<'_>, ) -> IsUsed

Handle an Event

const REDRAW_ON_MOUSE_OVER: bool = false

Does this widget have a different appearance on mouse over?

fn mouse_over_icon(&self) -> Option<CursorIcon>

The mouse pointer icon to use on mouse over

fn make_child_id(&mut self, index: usize) -> Id

Make an identifier for a child

fn probe(&self, coord: Coord) -> Id

Probe a coordinate for a widget’s Id

fn configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

fn post_configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self (post-child-configuration actions)

fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update self using input data

fn recurse_indices(&self) -> ChildIndices

Recursion control

fn handle_mouse_over(&mut self, cx: &mut EventCx<'_>, state: bool)

Mouse focus handler

fn child_nav_focus(&mut self, cx: &mut EventCx<'_>, id: Id)

Notification that a child received navigation focus

fn handle_resize( &mut self, cx: &mut ConfigCx<'_>, data: &Self::Data, ) -> Option<ActionResize>

Handler for resize requests

fn handle_scroll( &mut self, cx: &mut EventCx<'_>, data: &Self::Data, scroll: Scroll, )

Handler for scrolling

impl Layout for Svg

fn size_rules(&mut self, cx: &mut SizeCx<'_>, axis: AxisInfo) -> SizeRules

Calculate size requirements for an axis

fn set_rect(&mut self, cx: &mut SizeCx<'_>, rect: Rect, hints: AlignHints)

Set size and position

fn draw(&self, draw: DrawCx<'_>)

Draw a widget and its children

fn rect(&self) -> Rect

Get the widget’s region

impl Tile for Svg

fn role(&self, _: &mut dyn RoleCx) -> Role<'_>

Describe the widget’s role

fn as_tile(&self) -> &dyn Tile

Get as a dyn Tile

fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

fn identify(&self) -> IdentifyWidget<'_>

Return a Display-able widget identifier

fn get_child(&self, index: usize) -> Option<&dyn Tile>

Access a child as a dyn Tile, if available

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

fn try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

fn nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

fn id(&self) -> Id

Get the widget’s identifier

fn navigable(&self) -> bool

Whether this widget supports navigation focus

fn tooltip(&self) -> Option<&str>

Tooltip

fn role_child_properties(&self, cx: &mut dyn RoleCx, index: usize)

Specify additional role properties for child index

fn find_child_index(&self, id: &Id) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn translation(&self, index: usize) -> Offset

Get translation of child index relative to this widget

impl Widget for Svg

type Data = ()

Input data type

fn as_node<'__a>( &'__a mut self, data: &'__a <Svg as Widget>::Data, ) -> Node<'__a>

Erase type

fn child_node<'__n>( &'__n mut self, data: &'__n <Svg as Widget>::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available