diff options
Diffstat (limited to 'widget')
| -rw-r--r-- | widget/src/helpers.rs | 46 | ||||
| -rw-r--r-- | widget/src/text.rs | 22 | 
2 files changed, 54 insertions, 14 deletions
| diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs index 146393dc..142d64d6 100644 --- a/widget/src/helpers.rs +++ b/widget/src/helpers.rs @@ -81,7 +81,6 @@ macro_rules! stack {  ///  /// ```no_run  /// # mod iced { -/// #     pub struct Element<Message>(pub std::marker::PhantomData<Message>);  /// #     pub mod widget {  /// #         macro_rules! text {  /// #           ($($arg:tt)*) => {unimplemented!()} @@ -89,22 +88,23 @@ macro_rules! stack {  /// #         pub(crate) use text;  /// #     }  /// # } -/// # struct Example; -/// # enum Message {} -/// use iced::Element; +/// # pub type State = (); +/// # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::core::Theme, ()>;  /// use iced::widget::text;  /// -/// impl Example { -///     fn view(&self) -> Element<Message> { -///         let simple = text!("Hello, world!"); +/// enum Message { +///     // ... +/// } +/// +/// fn view(_state: &State) -> Element<Message> { +///     let simple = text!("Hello, world!");  /// -///         let keyword = text!("Hello, {}", "world!"); +///     let keyword = text!("Hello, {}", "world!");  /// -///         let planet = "Earth"; -///         let local_variable = text!("Hello, {planet}!"); -///         // ... -///         # iced::Element(std::marker::PhantomData) -///     } +///     let planet = "Earth"; +///     let local_variable = text!("Hello, {planet}!"); +///     // ... +///     # unimplemented!()  /// }  /// ```  #[macro_export] @@ -758,6 +758,26 @@ where  }  /// Creates a new [`Text`] widget with the provided content. +/// +/// # Example +/// ```no_run +/// # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; } +/// # pub type State = (); +/// # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::core::Theme, ()>; +/// use iced::widget::text; +/// use iced::color; +/// +/// enum Message { +///     // ... +/// } +/// +/// fn view(state: &State) -> Element<'_, Message> { +///     text("Hello, this is iced!") +///         .size(20) +///         .color(color!(0x0000ff)) +///         .into() +/// } +/// ```  pub fn text<'a, Theme, Renderer>(      text: impl text::IntoFragment<'a>,  ) -> Text<'a, Theme, Renderer> diff --git a/widget/src/text.rs b/widget/src/text.rs index 9bf7fce4..c2243434 100644 --- a/widget/src/text.rs +++ b/widget/src/text.rs @@ -5,6 +5,26 @@ pub use crate::core::text::{Fragment, Highlighter, IntoFragment, Span};  pub use crate::core::widget::text::*;  pub use rich::Rich; -/// A paragraph. +/// A bunch of text. +/// +/// # Example +/// ```no_run +/// # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; } +/// # pub type State = (); +/// # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>; +/// use iced::widget::text; +/// use iced::color; +/// +/// enum Message { +///     // ... +/// } +/// +/// fn view(state: &State) -> Element<'_, Message> { +///     text("Hello, this is iced!") +///         .size(20) +///         .color(color!(0x0000ff)) +///         .into() +/// } +/// ```  pub type Text<'a, Theme = crate::Theme, Renderer = crate::Renderer> =      crate::core::widget::Text<'a, Theme, Renderer>; | 
