Struct iced::widget::image::Viewer

pub struct Viewer<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§

§

impl<Handle> Viewer<Handle>

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

Creates a new Viewer with the given State.

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

Sets the padding of the Viewer.

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

Sets the width of the Viewer.

pub fn height(self, height: 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<Message, Renderer, Handle> Widget<Message, Renderer> for Viewer<Handle>where
    Renderer: Renderer<Handle = Handle>,
    Handle: Clone + Hash,

§

fn tag(&self) -> Tag

Returns the Tag of the [Widget].
§

fn state(&self) -> State

Returns the State of the [Widget].
§

fn width(&self) -> Length

Returns the width of the [Widget].
§

fn height(&self) -> Length

Returns the height of the [Widget].
§

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

Returns the [layout::Node] of the [Widget]. Read more
§

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

Processes a runtime Event. Read more
§

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

Returns the current mouse::Interaction of the [Widget]. Read more
§

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

Draws the [Widget] using the associated Renderer.
§

fn children(&self) -> Vec<Tree, Global>

Returns the state [Tree] of the children of the [Widget].
§

fn diff(&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<Message>
)

Applies an [Operation] to the [Widget].
§

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

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

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

impl<Handle> UnwindSafe for Viewer<Handle>where
    Handle: UnwindSafe,

Blanket Implementations§

source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
    T: FloatComponent,
    Swp: WhitePoint,
    Dwp: WhitePoint,
    D: AdaptFrom<S, Swp, Dwp, T>,

source§

fn adapt_into_using<M>(self, method: M) -> Dwhere
    M: TransformMatrix<Swp, Dwp, T>,

Convert the source color to the destination color using the specified method
source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default
source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
    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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere
    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.

source§

impl<T, U> IntoColor<U> for Twhere
    U: FromColor<T>,

source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
source§

impl<T, U> IntoColorUnclamped<U> for Twhere
    U: FromColorUnclamped<T>,

source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

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<U> for Twhere
    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<U>>::Error>

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

impl<T, U> TryIntoColor<U> for Twhere
    U: TryFromColor<T>,

source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
§

impl<T> Upcast<T> for T

§

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

§

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

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
    S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> MaybeSend for Twhere
    T: Send,