summaryrefslogtreecommitdiffstats
path: root/native/src/widget/pane_grid.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-03-11 23:34:51 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-03-11 23:34:51 +0100
commit2d8d420949fc3b5c4390e32295cda64fb191488f (patch)
tree0ee5c56e98cf331752cc68cc9f10645535a9025a /native/src/widget/pane_grid.rs
parentf09b4bd4f4113872eeac67320e79f81eac0a948f (diff)
downloadiced-2d8d420949fc3b5c4390e32295cda64fb191488f.tar.gz
iced-2d8d420949fc3b5c4390e32295cda64fb191488f.tar.bz2
iced-2d8d420949fc3b5c4390e32295cda64fb191488f.zip
Replace `Panes` with `PaneGrid` in documentation
Diffstat (limited to 'native/src/widget/pane_grid.rs')
-rw-r--r--native/src/widget/pane_grid.rs25
1 files changed, 13 insertions, 12 deletions
diff --git a/native/src/widget/pane_grid.rs b/native/src/widget/pane_grid.rs
index 3b68b99e..31148168 100644
--- a/native/src/widget/pane_grid.rs
+++ b/native/src/widget/pane_grid.rs
@@ -53,17 +53,17 @@ impl<'a, Message, Renderer> PaneGrid<'a, Message, Renderer> {
}
}
- /// Sets the width of the [`Panes`].
+ /// Sets the width of the [`PaneGrid`].
///
- /// [`Panes`]: struct.Column.html
+ /// [`PaneGrid`]: struct.Column.html
pub fn width(mut self, width: Length) -> Self {
self.width = width;
self
}
- /// Sets the height of the [`Panes`].
+ /// Sets the height of the [`PaneGrid`].
///
- /// [`Panes`]: struct.Column.html
+ /// [`PaneGrid`]: struct.Column.html
pub fn height(mut self, height: Length) -> Self {
self.height = height;
self
@@ -587,19 +587,20 @@ impl Split {
}
}
-/// The renderer of some [`Panes`].
+/// The renderer of a [`PaneGrid`].
///
/// Your [renderer] will need to implement this trait before being
-/// able to use [`Panes`] in your user interface.
+/// able to use a [`PaneGrid`] in your user interface.
///
-/// [`Panes`]: struct.Panes.html
+/// [`PaneGrid`]: struct.PaneGrid.html
/// [renderer]: ../../renderer/index.html
pub trait Renderer: crate::Renderer + Sized {
- /// Draws some [`Panes`].
+ /// Draws a [`PaneGrid`].
///
/// It receives:
- /// - the children of the [`Column`]
- /// - the [`Layout`] of the [`Column`] and its children
+ /// - the elements of the [`PaneGrid`]
+ /// - the [`Pane`] that is currently being dragged
+ /// - the [`Layout`] of the [`PaneGrid`] and its elements
/// - the cursor position
///
/// [`Column`]: struct.Row.html
@@ -621,8 +622,8 @@ where
Message: 'static,
{
fn from(
- panes: PaneGrid<'a, Message, Renderer>,
+ pane_grid: PaneGrid<'a, Message, Renderer>,
) -> Element<'a, Message, Renderer> {
- Element::new(panes)
+ Element::new(pane_grid)
}
}