Struct iced::widget::image::Viewer

source · [−]

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

Available on crate feature image only.

Expand description

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

Implementations

source

impl<'a, Handle> Viewer<'a, Handle>

source

pub fn new(state: &'a mut State, handle: Handle) -> Viewer<'a, Handle>

Creates a new Viewer with the given State.

source

pub fn padding(self, units: u16) -> Viewer<'a, Handle>

Sets the padding of the Viewer.

source

pub fn width(self, width: Length) -> Viewer<'a, Handle>

Sets the width of the Viewer.

source

pub fn height(self, height: Length) -> Viewer<'a, Handle>

Sets the height of the Viewer.

source

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

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

Default is 10.0

source

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

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

Default is 0.25

source

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

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

Default is 0.10

Trait Implementations

source

fn width(&self) -> Length

Returns the width of the Widget.

source

fn height(&self) -> Length

Returns the height of the Widget.

source

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

Returns the Node of the Widget. Read more

source

fn on_event(
 &mut self,
 event: Event,
 layout: Layout<'_>,
 cursor_position: Point,
 renderer: &Renderer,
 _clipboard: &mut dyn Clipboard,
 _shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event. Read more

source

fn mouse_interaction(
 &self,
 layout: Layout<'_>,
 cursor_position: Point,
 _viewport: &Rectangle<f32>,
 _renderer: &Renderer
) -> Interaction

Returns the current mouse::Interaction of the Widget. Read more

source

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

Draws the Widget using the associated Renderer.

source

fn overlay(
 &mut self,
 _layout: Layout<'_>,
 _renderer: &Renderer
) -> Option<Element<'_, Message, Renderer>>

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

Auto Trait Implementations

impl<'a, Handle> RefUnwindSafe for Viewer<'a, Handle> where
Handle: RefUnwindSafe,

impl<'a, Handle> Send for Viewer<'a, Handle> where
Handle: Send,

impl<'a, Handle> Sync for Viewer<'a, Handle> where
Handle: Sync,

impl<'a, Handle> Unpin for Viewer<'a, Handle> where
Handle: Unpin,

impl<'a, Handle> !UnwindSafe for Viewer<'a, Handle>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

Struct iced::widget::image::Viewer

Implementations

impl<'a, Handle> Viewer<'a, Handle>

pub fn new(state: &'a mut State, handle: Handle) -> Viewer<'a, Handle>

pub fn padding(self, units: u16) -> Viewer<'a, Handle>

pub fn width(self, width: Length) -> Viewer<'a, Handle>

pub fn height(self, height: Length) -> Viewer<'a, Handle>

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

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

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

Trait Implementations

impl<'a, Message, Renderer, Handle> Widget<Message, Renderer> for Viewer<'a, Handle> where Renderer: Renderer<Handle = Handle>, Handle: Clone + Hash,

fn width(&self) -> Length

fn height(&self) -> Length

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

fn on_event( &mut self, event: Event, layout: Layout<'_>, cursor_position: Point, renderer: &Renderer, _clipboard: &mut dyn Clipboard, _shell: &mut Shell<'_, Message>) -> Status

fn mouse_interaction( &self, layout: Layout<'_>, cursor_position: Point, _viewport: &Rectangle<f32>, _renderer: &Renderer) -> Interaction

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

fn overlay( &mut self, _layout: Layout<'_>, _renderer: &Renderer) -> Option<Element<'_, Message, Renderer>>

Auto Trait Implementations

impl<'a, Handle> RefUnwindSafe for Viewer<'a, Handle> where Handle: RefUnwindSafe,

impl<'a, Handle> Send for Viewer<'a, Handle> where Handle: Send,

impl<'a, Handle> Sync for Viewer<'a, Handle> where Handle: Sync,

impl<'a, Handle> Unpin for Viewer<'a, Handle> where Handle: Unpin,

impl<'a, Handle> !UnwindSafe for Viewer<'a, Handle>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> MaybeSend for T where T: Send,

impl<'a, Message, Renderer, Handle> Widget<Message, Renderer> for Viewer<'a, Handle> where
Renderer: Renderer<Handle = Handle>,
Handle: Clone + Hash,

fn on_event(
&mut self,
event: Event,
layout: Layout<'_>,
cursor_position: Point,
renderer: &Renderer,
_clipboard: &mut dyn Clipboard,
_shell: &mut Shell<'_, Message>
) -> Status

fn mouse_interaction(
&self,
layout: Layout<'_>,
cursor_position: Point,
_viewport: &Rectangle<f32>,
_renderer: &Renderer
) -> Interaction

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

fn overlay(
&mut self,
_layout: Layout<'_>,
_renderer: &Renderer
) -> Option<Element<'_, Message, Renderer>>

impl<'a, Handle> RefUnwindSafe for Viewer<'a, Handle> where
Handle: RefUnwindSafe,

impl<'a, Handle> Send for Viewer<'a, Handle> where
Handle: Send,

impl<'a, Handle> Sync for Viewer<'a, Handle> where
Handle: Sync,

impl<'a, Handle> Unpin for Viewer<'a, Handle> where
Handle: Unpin,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> MaybeSend for T where
T: Send,