Add screenshots to all widgets

Remove cruft

Author: PoignardAzur

masonry/src/testing/screenshots.rs

@@ -20,6 +20,11 @@ macro_rules! include_screenshot {
     };
 }
 
+// TODO:
+// - Check whether the docs.rs trick actually works.
+// - Check whether this method will work with cargo rdme.
+// - Make better screenshots than the ones we currently use.
+
 #[cfg(not(docsrs))]
 #[doc(hidden)]
 #[macro_export]
@@ -33,13 +38,6 @@ macro_rules! include_screenshot {
     };
 }
 
-// [!Image alt](link)
-
-// https://raw.githubusercontent.com/linebender/xilem/7f40266bd831c3f8e715bf7af325e3a53e046612/masonry/src/widget/screenshots/masonry__widget__align__tests__centered.png
-
-#[cfg(FALSE)]
-include_screenshot!("hello");
-
 #[cfg_attr(docsrs, doc = r" This is a doc comment.")]
 #[cfg_attr(not(docsrs), doc = r" This is a doc comment.")]
 pub(crate) fn get_image_diff(ref_image: &RgbImage, new_image: &RgbImage) -> Option<RgbImage> {

masonry/src/widget/align.rs

@@ -14,7 +14,6 @@ use tracing::{trace_span, Span};
 use vello::Scene;
 
 use crate::contexts::AccessCtx;
-use crate::include_screenshot;
 use crate::paint_scene_helpers::UnitPoint;
 use crate::widget::WidgetPod;
 use crate::{
@@ -26,7 +25,7 @@ use crate::{
 
 /// A widget that aligns its child.
 ///
-#[doc = include_screenshot!("widget/screenshots/masonry__widget__align__tests__right.png", "Right-aligned label")]
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__align__tests__right.png", "Right-aligned label")]
 pub struct Align {
     align: UnitPoint,
     child: WidgetPod<Box<dyn Widget>>,

masonry/src/widget/button.rs

@@ -26,6 +26,8 @@ const LABEL_INSETS: Insets = Insets::uniform_xy(8., 2.);
 /// A button with a text label.
 ///
 /// Emits [`Action::ButtonPressed`] when pressed.
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__button__tests__hello.png", "Button with text label")]
 pub struct Button {
     label: WidgetPod<Label>,
 }

masonry/src/widget/checkbox.rs

@@ -19,6 +19,8 @@ use crate::{
 };
 
 /// A checkbox that can be toggled.
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__checkbox__tests__hello_checked.png", "Checkbox with checked state")]
 pub struct Checkbox {
     checked: bool,
     label: WidgetPod<Label>,

masonry/src/widget/flex.rs

@@ -19,6 +19,8 @@ use crate::{
 /// A container with either horizontal or vertical layout.
 ///
 /// This widget is the foundation of most layouts, and is highly configurable.
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__flex__tests__col_main_axis_spaceAround.png", "Flex column with multiple labels")]
 pub struct Flex {
     direction: Axis,
     cross_alignment: CrossAxisAlignment,

masonry/src/widget/grid.rs

@@ -13,6 +13,9 @@ use crate::{
     QueryCtx, Size, TextEvent, Widget, WidgetId, WidgetPod,
 };
 
+/// A widget that arranges its children in a grid.
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__grid__tests__with_changed_spacing.png", "Grid with buttons of various sizes")]
 pub struct Grid {
     children: Vec<Child>,
     grid_width: i32,

masonry/src/widget/label.rs

@@ -42,6 +42,8 @@ pub enum LineBreaking {
 ///
 /// This is useful for creating interactive widgets which internally
 /// need support for displaying text, such as a button.
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__label__tests__styled_label.png", "Styled label")]
 pub struct Label {
     text_layout: Layout<BrushIndex>,
     accessibility: LayoutAccessibility,

masonry/src/widget/progress_bar.rs

@@ -20,6 +20,8 @@ use crate::{
 use super::{Label, LineBreaking, WidgetPod};
 
 /// A progress bar.
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__progress_bar__tests__25_percent_progressbar.png", "25% progress bar")]
 pub struct ProgressBar {
     /// A value in the range `[0, 1]` inclusive, where 0 is 0% and 1 is 100% complete.
     ///

masonry/src/widget/prose.rs

@@ -38,6 +38,8 @@ const PROSE_PADDING: Padding = Padding::horizontal(2.0);
 /// as it enables users to copy/paste from the text.
 ///
 /// This widget has no actions.
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__prose__tests__prose_alignment_flex.png", "Multiple lines with different alignments")]
 pub struct Prose {
     text: WidgetPod<TextArea<false>>,
 

masonry/src/widget/scroll_bar.rs

@@ -24,6 +24,9 @@ use crate::{
 // - Document names
 // - Document invariants
 
+/// A scrollbar.
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__scroll_bar__tests__scrollbar_default.png", "Vertical scrollbar")]
 pub struct ScrollBar {
     axis: Axis,
     pub(crate) cursor_progress: f64,

masonry/src/widget/sized_box.rs

@@ -56,6 +56,8 @@ pub struct Padding {
 /// If not given a child, `SizedBox` will try to size itself as close to the specified height
 /// and width as possible given the parent's constraints. If height or width is not set,
 /// it will be treated as zero.
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__sized_box__tests__label_box_with_outer_padding.png", "Box with blue border, pink background and a child label")]
 pub struct SizedBox {
     child: Option<WidgetPod<Box<dyn Widget>>>,
     width: Option<f64>,

masonry/src/widget/spinner.rs

@@ -24,6 +24,8 @@ use crate::{
 /// that has a fixed width and height.
 ///
 /// [`SizedBox`]: crate::widget::SizedBox
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__spinner__tests__spinner_init.png", "Spinner frame")]
 pub struct Spinner {
     t: f64,
     color: Color,

masonry/src/widget/split.rs

@@ -19,8 +19,9 @@ use crate::{
 };
 
 // TODO - Have child widget type as generic argument
-
 /// A container containing two other widgets, splitting the area either horizontally or vertically.
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__split__tests__columns.png", "Split panel with two labels")]
 pub struct Split {
     split_axis: Axis,
     split_point_chosen: f64,

masonry/src/widget/zstack.rs

@@ -29,6 +29,8 @@ pub enum ChildAlignment {
 ///
 /// The alignment of how the children are placed can be specified globally using [`with_alignment`][Self::with_alignment].
 /// Each child can additionally override the global alignment using [`ChildAlignment::SelfAligned`].
+///
+#[doc = crate::include_screenshot!("widget/screenshots/masonry__widget__zstack__tests__zstack_alignment_default.png", "Red foreground widget on top of blue background widget")]
 #[derive(Default)]
 pub struct ZStack {
     children: Vec<Child>,