diff options
| author |  Héctor Ramón Jiménez <hector0193@gmail.com> | 2019-11-22 19:36:57 +0100 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector0193@gmail.com> | 2019-11-22 19:36:57 +0100 |
| commit | a7dba612f03e58d7bd9527499d893987986b347c (patch) | |
| tree | b8c3d8f997b714aa368bd6eaecf14065f7645c77 /native/src/widget/column.rs | |
| parent | ba56a561b254c9a5f3d23cb54d23dc311759ab4c (diff) | |
| download | iced-a7dba612f03e58d7bd9527499d893987986b347c.tar.gz iced-a7dba612f03e58d7bd9527499d893987986b347c.tar.bz2 iced-a7dba612f03e58d7bd9527499d893987986b347c.zip | |
Write docs for `iced` and `iced_native`
Diffstat (limited to 'native/src/widget/column.rs')
| -rw-r--r-- | native/src/widget/column.rs | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/native/src/widget/column.rs b/native/src/widget/column.rs index 87c51f48..281437fd 100644 --- a/native/src/widget/column.rs +++ b/native/src/widget/column.rs @@ -1,3 +1,4 @@ +//! Distribute content vertically. use std::hash::Hash; use crate::{ @@ -189,7 +190,23 @@ where } } +/// The renderer of a [`Column`]. +/// +/// Your [renderer] will need to implement this trait before being +/// able to use a [`Column`] in your user interface. +/// +/// [`Column`]: struct.Column.html +/// [renderer]: ../../renderer/index.html pub trait Renderer: crate::Renderer + Sized { + /// Draws a [`Column`]. + /// + /// It receives: + /// - the children of the [`Column`] + /// - the [`Layout`] of the [`Column`] and its children + /// - the cursor position + /// + /// [`Column`]: struct.Row.html + /// [`Layout`]: ../layout/struct.Layout.html fn draw<Message>( &mut self, content: &[Element<'_, Message, Self>], |