diff options
Diffstat (limited to 'src/widget/image.rs')
-rw-r--r-- | src/widget/image.rs | 139 |
1 files changed, 139 insertions, 0 deletions
diff --git a/src/widget/image.rs b/src/widget/image.rs new file mode 100644 index 00000000..f9b3a037 --- /dev/null +++ b/src/widget/image.rs @@ -0,0 +1,139 @@ +//! Displays image to your users. + +use crate::{ + Style, Node, Element, MouseCursor, Layout, Hasher, Widget, + Rectangle, Point, +}; + +use std::hash::Hash; + +/// A widget that displays an image. +/// +/// It implements [`Widget`] when the associated [`core::Renderer`] implements +/// the [`image::Renderer`] trait. +/// +/// [`Widget`]: ../../core/trait.Widget.html +/// [`core::Renderer`]: ../../core/trait.Renderer.html +/// [`image::Renderer`]: trait.Renderer.html +/// # Example +/// +/// ``` +/// use iced::Image; +/// +/// let image = Image::new("image"); +/// ``` +pub struct Image<I> { + image: I, + source: Option<Rectangle<u16>>, + style: Style, +} + +impl<I> std::fmt::Debug for Image<I> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("Image") + .field("source", &self.source) + .field("style", &self.style) + .finish() + } +} + +impl<I> Image<I> { + /// Creates a new [`Image`] with given image handle. + /// + /// [`Image`]: struct.Image.html + pub fn new(image: &I) -> Self where I: Clone { + Image { + image: image.clone(), + source: None, + style: Style::default().fill_width().fill_height(), + } + } + + /// Sets the portion of the [`Image`] that we want to draw. + /// + /// [`Image`]: struct.Image.html + pub fn clip(mut self, source: Rectangle<u16>) -> Self { + self.source = Some(source); + self + } + + /// Sets the width of the [`Image`] boundaries in pixels. + /// + /// [`Image`]: struct.Image.html + pub fn width(mut self, width: u32) -> Self { + self.style = self.style.width(width); + self + } + + /// Sets the height of the [`Image`] boundaries in pixels. + /// + /// [`Image`]: struct.Image.html + pub fn height(mut self, height: u32) -> Self { + self.style = self.style.height(height); + self + } +} + +impl<I, Message, Renderer> Widget<Message, Renderer> for Image<I> +where + Renderer: self::Renderer<I>, + I: Clone, +{ + fn node(&self, _renderer: &Renderer) -> Node { + Node::new(self.style) + } + + fn draw( + &self, + renderer: &mut Renderer, + layout: Layout<'_>, + _cursor_position: Point, + ) -> MouseCursor { + renderer.draw( + layout.bounds(), + self.image.clone(), + self.source, + ); + + MouseCursor::OutOfBounds + } + + fn hash(&self, state: &mut Hasher) { + self.style.hash(state); + } +} + +/// The renderer of a [`Image`]. +/// +/// Your [`core::Renderer`] will need to implement this trait before being +/// able to use a [`Image`] in your user interface. +/// +/// [`Image`]: struct.Image.html +/// [`core::Renderer`]: ../../core/trait.Renderer.html +pub trait Renderer<I> { + /// Draws a [`Image`]. + /// + /// It receives: + /// * the bounds of the [`Image`] + /// * the handle of the loaded [`Image`] + /// * the portion of the image that we wants to draw, + /// if not specified, draw entire image + /// + /// [`Image`]: struct.Image.html + fn draw( + &mut self, + bounds: Rectangle<f32>, + image: I, + source: Option<Rectangle<u16>>, + ); +} + +impl<'a, I, Message, Renderer> From<Image<I>> for Element<'a, Message, Renderer> +where + Renderer: self::Renderer<I>, + I: Clone + 'a, +{ + fn from(image: Image<I>) -> Element<'a, Message, Renderer> { + Element::new(image) + } +} |