179 lines
4.9 KiB
Rust
179 lines
4.9 KiB
Rust
//! Use the built-in widgets or create your own.
|
|
//!
|
|
//! # Built-in widgets
|
|
//! Every built-in drawable widget has its own module with a `Renderer` trait
|
|
//! that must be implemented by a [renderer] before being able to use it as
|
|
//! a [`Widget`].
|
|
//!
|
|
//! # Custom widgets
|
|
//! If you want to implement a custom widget, you simply need to implement the
|
|
//! [`Widget`] trait. You can use the API of the built-in widgets as a guide or
|
|
//! source of inspiration.
|
|
//!
|
|
//! [renderer]: crate::renderer
|
|
pub mod button;
|
|
pub mod checkbox;
|
|
pub mod column;
|
|
pub mod container;
|
|
pub mod image;
|
|
pub mod pane_grid;
|
|
pub mod pick_list;
|
|
pub mod progress_bar;
|
|
pub mod radio;
|
|
pub mod row;
|
|
pub mod rule;
|
|
pub mod scrollable;
|
|
pub mod slider;
|
|
pub mod space;
|
|
pub mod svg;
|
|
pub mod text;
|
|
pub mod text_input;
|
|
pub mod toggler;
|
|
pub mod tooltip;
|
|
|
|
#[doc(no_inline)]
|
|
pub use button::Button;
|
|
#[doc(no_inline)]
|
|
pub use checkbox::Checkbox;
|
|
#[doc(no_inline)]
|
|
pub use column::Column;
|
|
#[doc(no_inline)]
|
|
pub use container::Container;
|
|
#[doc(no_inline)]
|
|
pub use image::Image;
|
|
#[doc(no_inline)]
|
|
pub use pane_grid::PaneGrid;
|
|
#[doc(no_inline)]
|
|
pub use pick_list::PickList;
|
|
#[doc(no_inline)]
|
|
pub use progress_bar::ProgressBar;
|
|
#[doc(no_inline)]
|
|
pub use radio::Radio;
|
|
#[doc(no_inline)]
|
|
pub use row::Row;
|
|
#[doc(no_inline)]
|
|
pub use rule::Rule;
|
|
#[doc(no_inline)]
|
|
pub use scrollable::Scrollable;
|
|
#[doc(no_inline)]
|
|
pub use slider::Slider;
|
|
#[doc(no_inline)]
|
|
pub use space::Space;
|
|
#[doc(no_inline)]
|
|
pub use svg::Svg;
|
|
#[doc(no_inline)]
|
|
pub use text::Text;
|
|
#[doc(no_inline)]
|
|
pub use text_input::TextInput;
|
|
#[doc(no_inline)]
|
|
pub use toggler::Toggler;
|
|
#[doc(no_inline)]
|
|
pub use tooltip::Tooltip;
|
|
|
|
use crate::event::{self, Event};
|
|
use crate::layout;
|
|
use crate::mouse;
|
|
use crate::overlay;
|
|
use crate::renderer;
|
|
use crate::{Clipboard, Layout, Length, Point, Rectangle, Shell};
|
|
|
|
/// A component that displays information and allows interaction.
|
|
///
|
|
/// If you want to build your own widgets, you will need to implement this
|
|
/// trait.
|
|
///
|
|
/// # Examples
|
|
/// The repository has some [examples] showcasing how to implement a custom
|
|
/// widget:
|
|
///
|
|
/// - [`bezier_tool`], a Paint-like tool for drawing Bézier curves using
|
|
/// [`lyon`].
|
|
/// - [`custom_widget`], a demonstration of how to build a custom widget that
|
|
/// draws a circle.
|
|
/// - [`geometry`], a custom widget showcasing how to draw geometry with the
|
|
/// `Mesh2D` primitive in [`iced_wgpu`].
|
|
///
|
|
/// [examples]: https://github.com/iced-rs/iced/tree/0.3/examples
|
|
/// [`bezier_tool`]: https://github.com/iced-rs/iced/tree/0.3/examples/bezier_tool
|
|
/// [`custom_widget`]: https://github.com/iced-rs/iced/tree/0.3/examples/custom_widget
|
|
/// [`geometry`]: https://github.com/iced-rs/iced/tree/0.3/examples/geometry
|
|
/// [`lyon`]: https://github.com/nical/lyon
|
|
/// [`iced_wgpu`]: https://github.com/iced-rs/iced/tree/0.3/wgpu
|
|
pub trait Widget<Message, Renderer>
|
|
where
|
|
Renderer: crate::Renderer,
|
|
{
|
|
/// Returns the width of the [`Widget`].
|
|
fn width(&self) -> Length;
|
|
|
|
/// Returns the height of the [`Widget`].
|
|
fn height(&self) -> Length;
|
|
|
|
/// Returns the [`Node`] of the [`Widget`].
|
|
///
|
|
/// This [`Node`] is used by the runtime to compute the [`Layout`] of the
|
|
/// user interface.
|
|
///
|
|
/// [`Node`]: layout::Node
|
|
fn layout(
|
|
&self,
|
|
renderer: &Renderer,
|
|
limits: &layout::Limits,
|
|
) -> layout::Node;
|
|
|
|
/// Draws the [`Widget`] using the associated `Renderer`.
|
|
fn draw(
|
|
&self,
|
|
renderer: &mut Renderer,
|
|
style: &renderer::Style,
|
|
layout: Layout<'_>,
|
|
cursor_position: Point,
|
|
viewport: &Rectangle,
|
|
);
|
|
|
|
/// Processes a runtime [`Event`].
|
|
///
|
|
/// It receives:
|
|
/// * an [`Event`] describing user interaction
|
|
/// * the computed [`Layout`] of the [`Widget`]
|
|
/// * the current cursor position
|
|
/// * a mutable `Message` list, allowing the [`Widget`] to produce
|
|
/// new messages based on user interaction.
|
|
/// * the `Renderer`
|
|
/// * a [`Clipboard`], if available
|
|
///
|
|
/// By default, it does nothing.
|
|
fn on_event(
|
|
&mut self,
|
|
_event: Event,
|
|
_layout: Layout<'_>,
|
|
_cursor_position: Point,
|
|
_renderer: &Renderer,
|
|
_clipboard: &mut dyn Clipboard,
|
|
_shell: &mut Shell<'_, Message>,
|
|
) -> event::Status {
|
|
event::Status::Ignored
|
|
}
|
|
|
|
/// Returns the current [`mouse::Interaction`] of the [`Widget`].
|
|
///
|
|
/// By default, it returns [`mouse::Interaction::Idle`].
|
|
fn mouse_interaction(
|
|
&self,
|
|
_layout: Layout<'_>,
|
|
_cursor_position: Point,
|
|
_viewport: &Rectangle,
|
|
_renderer: &Renderer,
|
|
) -> mouse::Interaction {
|
|
mouse::Interaction::Idle
|
|
}
|
|
|
|
/// Returns the overlay of the [`Widget`], if there is any.
|
|
fn overlay(
|
|
&mut self,
|
|
_layout: Layout<'_>,
|
|
_renderer: &Renderer,
|
|
) -> Option<overlay::Element<'_, Message, Renderer>> {
|
|
None
|
|
}
|
|
}
|