Struct Viewer

pub struct Viewer<Handle> { /* private fields */ }

Available on crate feature image only.

A frame that displays an image with the ability to zoom in/out and pan.

Implementations

impl<Handle> Viewer<Handle>

pub fn new<T>(handle: T) -> Viewer<Handle>

where T: Into<Handle>,

Creates a new Viewer with the given State.

pub fn filter_method(self, filter_method: FilterMethod) -> Viewer<Handle>

Sets the FilterMethod of the Viewer.

pub fn content_fit(self, content_fit: ContentFit) -> Viewer<Handle>

Sets the ContentFit of the Viewer.

pub fn padding(self, padding: impl Into<Pixels>) -> Viewer<Handle>

Sets the padding of the Viewer.

pub fn width(self, width: impl Into<Length>) -> Viewer<Handle>

Sets the width of the Viewer.

pub fn height(self, height: impl Into<Length>) -> Viewer<Handle>

Sets the height of the Viewer.

pub fn max_scale(self, max_scale: f32) -> Viewer<Handle>

Sets the max scale applied to the image of the Viewer.

Default is 10.0

pub fn min_scale(self, min_scale: f32) -> Viewer<Handle>

Sets the min scale applied to the image of the Viewer.

Default is 0.25

pub fn scale_step(self, scale_step: f32) -> Viewer<Handle>

Sets the percentage the image of the Viewer will be scaled by when zoomed in / out.

Default is 0.10

Trait Implementations

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

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

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

Converts to this type from the input type.

impl<Message, Theme, Renderer, Handle> Widget<Message, Theme, Renderer> for Viewer<Handle>

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

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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 update( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, )

Processes a runtime Event.

fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, _theme: &Theme, _style: &Style, layout: Layout<'_>, _cursor: Cursor, _viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

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

Returns a Size hint for laying out 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 operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an Operation to 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.