summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--core/src/padding.rs32
-rw-r--r--native/src/overlay/menu.rs5
-rw-r--r--native/src/widget/button.rs5
-rw-r--r--native/src/widget/column.rs5
-rw-r--r--native/src/widget/container.rs5
-rw-r--r--native/src/widget/pane_grid/title_bar.rs5
-rw-r--r--native/src/widget/pick_list.rs5
-rw-r--r--native/src/widget/row.rs5
-rw-r--r--native/src/widget/scrollable.rs5
-rw-r--r--native/src/widget/text_input.rs5
-rw-r--r--web/src/widget/button.rs5
-rw-r--r--web/src/widget/column.rs5
-rw-r--r--web/src/widget/container.rs5
-rw-r--r--web/src/widget/row.rs5
-rw-r--r--web/src/widget/scrollable.rs5
-rw-r--r--web/src/widget/text_input.rs5
16 files changed, 32 insertions, 75 deletions
diff --git a/core/src/padding.rs b/core/src/padding.rs
index 6eafd44d..22467d6b 100644
--- a/core/src/padding.rs
+++ b/core/src/padding.rs
@@ -1,4 +1,36 @@
/// An amount of space to pad for each side of a box
+///
+/// You can leverage the `From` trait to build [`Padding`] conveniently:
+///
+/// ```
+/// # use iced_core::Padding;
+/// #
+/// let padding = Padding::from(20); // 20px on all sides
+/// let padding = Padding::from([10, 20]); // top/bottom, left/right
+/// let padding = Padding::from([5, 10, 15, 20]); // top, right, bottom, left
+/// ```
+///
+/// Normally, the `padding` method of a widget will ask for an `Into<Padding>`,
+/// so you can easily write:
+///
+/// ```
+/// # use iced_core::Padding;
+/// #
+/// # struct Widget;
+/// #
+/// impl Widget {
+/// # pub fn new() -> Self { Self }
+/// #
+/// pub fn padding(mut self, padding: impl Into<Padding>) -> Self {
+/// // ...
+/// self
+/// }
+/// }
+///
+/// let widget = Widget::new().padding(20); // 20px on all sides
+/// let widget = Widget::new().padding([10, 20]); // top/bottom, left/right
+/// let widget = Widget::new().padding([5, 10, 15, 20]); // top, right, bottom, left
+/// ```
#[derive(Debug, Hash, Copy, Clone)]
pub struct Padding {
/// Top padding
diff --git a/native/src/overlay/menu.rs b/native/src/overlay/menu.rs
index b5ed07c7..f62dcb46 100644
--- a/native/src/overlay/menu.rs
+++ b/native/src/overlay/menu.rs
@@ -59,11 +59,6 @@ where
}
/// Sets the [`Padding`] of the [`Menu`].
- ///```ignore
- /// Menu::new(/*...*/).padding(20); // 20px on all sides
- /// Menu::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Menu::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/native/src/widget/button.rs b/native/src/widget/button.rs
index 3ad5fa62..f61c22d0 100644
--- a/native/src/widget/button.rs
+++ b/native/src/widget/button.rs
@@ -91,11 +91,6 @@ where
}
/// Sets the [`Padding`] of the [`Button`].
- ///```ignore
- /// Button::new(/*...*/).padding(20); // 20px on all sides
- /// Button::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Button::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/native/src/widget/column.rs b/native/src/widget/column.rs
index 9f25f918..52a2e80c 100644
--- a/native/src/widget/column.rs
+++ b/native/src/widget/column.rs
@@ -57,11 +57,6 @@ impl<'a, Message, Renderer> Column<'a, Message, Renderer> {
}
/// Sets the [`Padding`] of the [`Column`].
- ///```ignore
- /// Column::new(/*...*/).padding(20); // 20px on all sides
- /// Column::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Column::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/native/src/widget/container.rs b/native/src/widget/container.rs
index cf5cb3dc..69aee64d 100644
--- a/native/src/widget/container.rs
+++ b/native/src/widget/container.rs
@@ -50,11 +50,6 @@ where
}
/// Sets the [`Padding`] of the [`Container`].
- ///```ignore
- /// Container::new(/*...*/).padding(20); // 20px on all sides
- /// Container::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Container::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/native/src/widget/pane_grid/title_bar.rs b/native/src/widget/pane_grid/title_bar.rs
index 8f32992a..d9d85dbb 100644
--- a/native/src/widget/pane_grid/title_bar.rs
+++ b/native/src/widget/pane_grid/title_bar.rs
@@ -46,11 +46,6 @@ where
}
/// Sets the [`Padding`] of the [`TitleBar`].
- ///```ignore
- /// TitleBar::new(/*...*/).padding(20); // 20px on all sides
- /// TitleBar::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// TitleBar::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/native/src/widget/pick_list.rs b/native/src/widget/pick_list.rs
index 15fe66b2..92c183f3 100644
--- a/native/src/widget/pick_list.rs
+++ b/native/src/widget/pick_list.rs
@@ -98,11 +98,6 @@ where
}
/// Sets the [`Padding`] of the [`PickList`].
- ///```ignore
- /// PickList::new(/*...*/).padding(20); // 20px on all sides
- /// PickList::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// PickList::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/native/src/widget/row.rs b/native/src/widget/row.rs
index 9aa059c3..9ebc9145 100644
--- a/native/src/widget/row.rs
+++ b/native/src/widget/row.rs
@@ -56,11 +56,6 @@ impl<'a, Message, Renderer> Row<'a, Message, Renderer> {
}
/// Sets the [`Padding`] of the [`Row`].
- ///```ignore
- /// Row::new(/*...*/).padding(20); // 20px on all sides
- /// Row::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Row::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/native/src/widget/scrollable.rs b/native/src/widget/scrollable.rs
index 2b699e3b..7c4ea16c 100644
--- a/native/src/widget/scrollable.rs
+++ b/native/src/widget/scrollable.rs
@@ -52,11 +52,6 @@ impl<'a, Message, Renderer: self::Renderer> Scrollable<'a, Message, Renderer> {
}
/// Sets the [`Padding`] of the [`Scrollable`].
- ///```ignore
- /// Scrollable::new(/*...*/).padding(20); // 20px on all sides
- /// Scrollable::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Scrollable::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.content = self.content.padding(padding);
self
diff --git a/native/src/widget/text_input.rs b/native/src/widget/text_input.rs
index 197f1599..20117fa0 100644
--- a/native/src/widget/text_input.rs
+++ b/native/src/widget/text_input.rs
@@ -128,11 +128,6 @@ where
}
/// Sets the [`Padding`] of the [`TextInput`].
- ///```ignore
- /// TextInput::new(/*...*/).padding(20); // 20px on all sides
- /// TextInput::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// TextInput::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/web/src/widget/button.rs b/web/src/widget/button.rs
index 0e75fa3f..8a36aab9 100644
--- a/web/src/widget/button.rs
+++ b/web/src/widget/button.rs
@@ -78,11 +78,6 @@ impl<'a, Message> Button<'a, Message> {
}
/// Sets the [`Padding`] of the [`Button`].
- ///```ignore
- /// Button::new(/*...*/).padding(20); // 20px on all sides
- /// Button::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Button::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/web/src/widget/column.rs b/web/src/widget/column.rs
index a4c99046..8738c2af 100644
--- a/web/src/widget/column.rs
+++ b/web/src/widget/column.rs
@@ -49,11 +49,6 @@ impl<'a, Message> Column<'a, Message> {
}
/// Sets the [`Padding`] of the [`Column`].
- ///```ignore
- /// Column::new(/*...*/).padding(20); // 20px on all sides
- /// Column::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Column::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/web/src/widget/container.rs b/web/src/widget/container.rs
index 9040f2ae..c006e011 100644
--- a/web/src/widget/container.rs
+++ b/web/src/widget/container.rs
@@ -42,11 +42,6 @@ impl<'a, Message> Container<'a, Message> {
}
/// Sets the [`Padding`] of the [`Container`].
- ///```ignore
- /// Container::new(/*...*/).padding(20); // 20px on all sides
- /// Container::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Container::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/web/src/widget/row.rs b/web/src/widget/row.rs
index e0df294e..ffb515cf 100644
--- a/web/src/widget/row.rs
+++ b/web/src/widget/row.rs
@@ -49,11 +49,6 @@ impl<'a, Message> Row<'a, Message> {
}
/// Sets the [`Padding`] of the [`Row`].
- ///```ignore
- /// Row::new(/*...*/).padding(20); // 20px on all sides
- /// Row::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Row::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
diff --git a/web/src/widget/scrollable.rs b/web/src/widget/scrollable.rs
index 10f633de..ce0a10d4 100644
--- a/web/src/widget/scrollable.rs
+++ b/web/src/widget/scrollable.rs
@@ -42,11 +42,6 @@ impl<'a, Message> Scrollable<'a, Message> {
}
/// Sets the [`Padding`] of the [`Scrollable`].
- ///```ignore
- /// Scrollable::new(/*...*/).padding(20); // 20px on all sides
- /// Scrollable::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// Scrollable::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.content = self.content.padding(padding);
self
diff --git a/web/src/widget/text_input.rs b/web/src/widget/text_input.rs
index 591fc21d..e8d8ca2f 100644
--- a/web/src/widget/text_input.rs
+++ b/web/src/widget/text_input.rs
@@ -93,11 +93,6 @@ impl<'a, Message> TextInput<'a, Message> {
}
/// Sets the [`Padding`] of the [`TextInput`].
- ///```ignore
- /// TextInput::new(/*...*/).padding(20); // 20px on all sides
- /// TextInput::new(/*...*/).padding([10, 20]); // top/bottom, left/right
- /// TextInput::new(/*...*/).padding([5, 10, 15, 20]); // top, right, bottom, left
- /// ```
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
self.padding = padding.into();
self
generated by cgit (git 2.34.1) at 2025-04-09 16:03:37 +0000