summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-08-30 01:42:22 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-08-30 01:42:22 +0200
commite84e0b876c3c9547f5758c72f1cb971fdba71483 (patch)
treee3de4f1579417a6d589674f931414c57978b0513 /src
parent23d4d20e575f337ebeed083a4f874e67c5b5e516 (diff)
downloadiced-e84e0b876c3c9547f5758c72f1cb971fdba71483.tar.gz
iced-e84e0b876c3c9547f5758c72f1cb971fdba71483.tar.bz2
iced-e84e0b876c3c9547f5758c72f1cb971fdba71483.zip
Add example images to widget docs
Diffstat (limited to 'src')
-rw-r--r--src/widget/button.rs2
-rw-r--r--src/widget/checkbox.rs19
-rw-r--r--src/widget/radio.rs17
-rw-r--r--src/widget/slider.rs2
-rw-r--r--src/widget/text.rs9
5 files changed, 25 insertions, 24 deletions
diff --git a/src/widget/button.rs b/src/widget/button.rs
index b96f6130..2f7a641c 100644
--- a/src/widget/button.rs
+++ b/src/widget/button.rs
@@ -36,6 +36,8 @@ use std::hash::Hash;
/// Button::new(state, "Click me!")
/// .on_press(Message::ButtonClicked);
/// ```
+///
+/// ![Button drawn by Coffee's renderer](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/button.png?raw=true)
pub struct Button<'a, Message> {
state: &'a mut State,
label: String,
diff --git a/src/widget/checkbox.rs b/src/widget/checkbox.rs
index e7982b85..4fc022a5 100644
--- a/src/widget/checkbox.rs
+++ b/src/widget/checkbox.rs
@@ -24,24 +24,19 @@ use crate::{
/// #[derive(Debug, Clone, Copy)]
/// pub enum Color {
/// Black,
-/// White,
-/// }
-///
-/// impl Default for Color {
-/// fn default() -> Color {
-/// Color::Black
-/// }
/// }
///
/// pub enum Message {
/// CheckboxToggled(bool),
/// }
///
-/// fn some_checkbox(is_checked: bool) -> Checkbox<Color, Message> {
-/// Checkbox::new(is_checked, "Toggle me!", Message::CheckboxToggled)
-/// .label_color(Color::White)
-/// }
+/// let is_checked = true;
+///
+/// Checkbox::new(is_checked, "Toggle me!", Message::CheckboxToggled)
+/// .label_color(Color::Black);
/// ```
+///
+/// ![Checkbox drawn by Coffee's renderer](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/checkbox.png?raw=true)
pub struct Checkbox<Color, Message> {
is_checked: bool,
on_toggle: Box<dyn Fn(bool) -> Message>,
@@ -98,7 +93,7 @@ impl<Color, Message> Checkbox<Color, Message> {
impl<Color, Message, Renderer> Widget<Message, Renderer>
for Checkbox<Color, Message>
where
- Color: 'static + Copy + Default + std::fmt::Debug,
+ Color: 'static + Copy + std::fmt::Debug,
Renderer: self::Renderer + text::Renderer<Color>,
{
fn node(&self, renderer: &Renderer) -> Node {
diff --git a/src/widget/radio.rs b/src/widget/radio.rs
index 8e2a5da6..7bcb0da2 100644
--- a/src/widget/radio.rs
+++ b/src/widget/radio.rs
@@ -25,12 +25,6 @@ use std::hash::Hash;
/// Black,
/// }
///
-/// impl Default for Color {
-/// fn default() -> Color {
-/// Color::Black
-/// }
-/// }
-///
/// #[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// pub enum Choice {
/// A,
@@ -44,11 +38,14 @@ use std::hash::Hash;
///
/// let selected_choice = Some(Choice::A);
///
-/// Radio::<Color, Message>::new(Choice::A, "This is A", selected_choice, Message::RadioSelected)
+/// Radio::new(Choice::A, "This is A", selected_choice, Message::RadioSelected)
+/// .label_color(Color::Black);
+///
+/// Radio::new(Choice::B, "This is B", selected_choice, Message::RadioSelected)
/// .label_color(Color::Black);
/// ```
///
-/// ![Checkbox drawn by the built-in renderer in Coffee](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/radio.png?raw=true)
+/// ![Radio buttons drawn by Coffee's renderer](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/radio.png?raw=true)
pub struct Radio<Color, Message> {
is_selected: bool,
on_click: Message,
@@ -108,7 +105,7 @@ impl<Color, Message> Radio<Color, Message> {
impl<Color, Message, Renderer> Widget<Message, Renderer>
for Radio<Color, Message>
where
- Color: 'static + Copy + Default + std::fmt::Debug,
+ Color: 'static + Copy + std::fmt::Debug,
Renderer: self::Renderer + text::Renderer<Color>,
Message: Copy + std::fmt::Debug,
{
@@ -205,7 +202,7 @@ pub trait Renderer {
impl<'a, Color, Message, Renderer> From<Radio<Color, Message>>
for Element<'a, Message, Renderer>
where
- Color: 'static + Copy + Default + std::fmt::Debug,
+ Color: 'static + Copy + std::fmt::Debug,
Renderer: self::Renderer + text::Renderer<Color>,
Message: 'static + Copy + std::fmt::Debug,
{
diff --git a/src/widget/slider.rs b/src/widget/slider.rs
index 4a5d93ff..ced0021c 100644
--- a/src/widget/slider.rs
+++ b/src/widget/slider.rs
@@ -38,6 +38,8 @@ use crate::{
///
/// Slider::new(state, 0.0..=100.0, value, Message::SliderChanged);
/// ```
+///
+/// ![Slider drawn by Coffee's renderer](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/slider.png?raw=true)
pub struct Slider<'a, Message> {
state: &'a mut State,
range: RangeInclusive<f32>,
diff --git a/src/widget/text.rs b/src/widget/text.rs
index ac629b4e..858488d3 100644
--- a/src/widget/text.rs
+++ b/src/widget/text.rs
@@ -18,9 +18,14 @@ use std::hash::Hash;
/// ```
/// use iced::Text;
///
-/// Text::<(f32, f32, f32)>::new("I <3 iced!")
+/// #[derive(Debug, Clone, Copy)]
+/// pub enum Color {
+/// Black,
+/// }
+///
+/// Text::new("I <3 iced!")
/// .size(40)
-/// .color((0.0, 0.0, 1.0));
+/// .color(Color::Black);
/// ```
#[derive(Debug, Clone)]
pub struct Text<Color> {