Use recently stabilized intra-doc links
See RFC: https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md
This commit is contained in:
parent
d612bf5678
commit
01322f69a4
135 changed files with 135 additions and 1769 deletions
|
|
@ -5,8 +5,6 @@ use crate::layout;
|
|||
use crate::{Clipboard, Hasher, Layout, Point, Size, Vector};
|
||||
|
||||
/// A generic [`Overlay`].
|
||||
///
|
||||
/// [`Overlay`]: trait.Overlay.html
|
||||
#[allow(missing_debug_implementations)]
|
||||
pub struct Element<'a, Message, Renderer> {
|
||||
position: Point,
|
||||
|
|
@ -18,9 +16,6 @@ where
|
|||
Renderer: crate::Renderer,
|
||||
{
|
||||
/// Creates a new [`Element`] containing the given [`Overlay`].
|
||||
///
|
||||
/// [`Element`]: struct.Element.html
|
||||
/// [`Overlay`]: trait.Overlay.html
|
||||
pub fn new(
|
||||
position: Point,
|
||||
overlay: Box<dyn Overlay<Message, Renderer> + 'a>,
|
||||
|
|
@ -29,16 +24,12 @@ where
|
|||
}
|
||||
|
||||
/// Translates the [`Element`].
|
||||
///
|
||||
/// [`Element`]: struct.Element.html
|
||||
pub fn translate(mut self, translation: Vector) -> Self {
|
||||
self.position = self.position + translation;
|
||||
self
|
||||
}
|
||||
|
||||
/// Applies a transformation to the produced message of the [`Element`].
|
||||
///
|
||||
/// [`Element`]: struct.Element.html
|
||||
pub fn map<B>(self, f: &'a dyn Fn(Message) -> B) -> Element<'a, B, Renderer>
|
||||
where
|
||||
Message: 'a,
|
||||
|
|
@ -52,15 +43,11 @@ where
|
|||
}
|
||||
|
||||
/// Computes the layout of the [`Element`] in the given bounds.
|
||||
///
|
||||
/// [`Element`]: struct.Element.html
|
||||
pub fn layout(&self, renderer: &Renderer, bounds: Size) -> layout::Node {
|
||||
self.overlay.layout(renderer, bounds, self.position)
|
||||
}
|
||||
|
||||
/// Processes a runtime [`Event`].
|
||||
///
|
||||
/// [`Event`]: enum.Event.html
|
||||
pub fn on_event(
|
||||
&mut self,
|
||||
event: Event,
|
||||
|
|
@ -81,9 +68,6 @@ where
|
|||
}
|
||||
|
||||
/// Draws the [`Element`] and its children using the given [`Layout`].
|
||||
///
|
||||
/// [`Element`]: struct.Element.html
|
||||
/// [`Layout`]: layout/struct.Layout.html
|
||||
pub fn draw(
|
||||
&self,
|
||||
renderer: &mut Renderer,
|
||||
|
|
@ -96,8 +80,6 @@ where
|
|||
}
|
||||
|
||||
/// Computes the _layout_ hash of the [`Element`].
|
||||
///
|
||||
/// [`Element`]: struct.Element.html
|
||||
pub fn hash_layout(&self, state: &mut Hasher) {
|
||||
self.overlay.hash_layout(state, self.position);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -32,9 +32,6 @@ where
|
|||
{
|
||||
/// Creates a new [`Menu`] with the given [`State`], a list of options, and
|
||||
/// the message to produced when an option is selected.
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
/// [`State`]: struct.State.html
|
||||
pub fn new(
|
||||
state: &'a mut State,
|
||||
options: &'a [T],
|
||||
|
|
@ -55,40 +52,30 @@ where
|
|||
}
|
||||
|
||||
/// Sets the width of the [`Menu`].
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
pub fn width(mut self, width: u16) -> Self {
|
||||
self.width = width;
|
||||
self
|
||||
}
|
||||
|
||||
/// Sets the padding of the [`Menu`].
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
pub fn padding(mut self, padding: u16) -> Self {
|
||||
self.padding = padding;
|
||||
self
|
||||
}
|
||||
|
||||
/// Sets the text size of the [`Menu`].
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
pub fn text_size(mut self, text_size: u16) -> Self {
|
||||
self.text_size = Some(text_size);
|
||||
self
|
||||
}
|
||||
|
||||
/// Sets the font of the [`Menu`].
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
pub fn font(mut self, font: Renderer::Font) -> Self {
|
||||
self.font = font;
|
||||
self
|
||||
}
|
||||
|
||||
/// Sets the style of the [`Menu`].
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
pub fn style(
|
||||
mut self,
|
||||
style: impl Into<<Renderer as self::Renderer>::Style>,
|
||||
|
|
@ -103,8 +90,6 @@ where
|
|||
/// The `target_height` will be used to display the menu either on top
|
||||
/// of the target or under it, depending on the screen position and the
|
||||
/// dimensions of the [`Menu`].
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
pub fn overlay<Message: 'a>(
|
||||
self,
|
||||
position: Point,
|
||||
|
|
@ -118,8 +103,6 @@ where
|
|||
}
|
||||
|
||||
/// The local state of a [`Menu`].
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
#[derive(Debug, Clone, Default)]
|
||||
pub struct State {
|
||||
scrollable: scrollable::State,
|
||||
|
|
@ -127,9 +110,6 @@ pub struct State {
|
|||
|
||||
impl State {
|
||||
/// Creates a new [`State`] for a [`Menu`].
|
||||
///
|
||||
/// [`State`]: struct.State.html
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
pub fn new() -> Self {
|
||||
Self::default()
|
||||
}
|
||||
|
|
@ -402,21 +382,16 @@ where
|
|||
/// Your [renderer] will need to implement this trait before being
|
||||
/// able to use a [`Menu`] in your user interface.
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
/// [renderer]: ../../renderer/index.html
|
||||
/// [renderer]: crate::renderer
|
||||
pub trait Renderer:
|
||||
scrollable::Renderer + container::Renderer + text::Renderer
|
||||
{
|
||||
/// The [`Menu`] style supported by this renderer.
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
type Style: Default + Clone;
|
||||
|
||||
/// Decorates a the list of options of a [`Menu`].
|
||||
///
|
||||
/// This method can be used to draw a background for the [`Menu`].
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
fn decorate(
|
||||
&mut self,
|
||||
bounds: Rectangle,
|
||||
|
|
@ -426,8 +401,6 @@ pub trait Renderer:
|
|||
) -> Self::Output;
|
||||
|
||||
/// Draws the list of options of a [`Menu`].
|
||||
///
|
||||
/// [`Menu`]: struct.Menu.html
|
||||
fn draw<T: ToString>(
|
||||
&mut self,
|
||||
bounds: Rectangle,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue