Struct iced_native::widget::pane_grid::PaneGrid

pub struct PaneGrid<'a, Message, Renderer: Renderer> { /* fields omitted */ }

A collection of panes distributed using either vertical or horizontal splits to completely fill the space available.

This distribution of space is common in tiling window managers (like awesome, i3, or even tmux).

A PaneGrid supports:

• Vertical and horizontal splits
• Tracking of the last active pane
• Mouse-based resizing
• Drag and drop to reorganize panes
• Hotkey support
• Configurable modifier keys
• State API to perform actions programmatically (split, swap, resize, etc.)

Example

enum PaneState {
    SomePane,
    AnotherKindOfPane,
}

enum Message {
    PaneDragged(pane_grid::DragEvent),
    PaneResized(pane_grid::ResizeEvent),
}

let (mut state, _) = pane_grid::State::new(PaneState::SomePane);

let pane_grid =
    PaneGrid::new(&mut state, |pane, state| {
        pane_grid::Content::new(match state {
            PaneState::SomePane => Text::new("This is some pane"),
            PaneState::AnotherKindOfPane => Text::new("This is another kind of pane"),
        })
    })
    .on_drag(Message::PaneDragged)
    .on_resize(10, Message::PaneResized);

Implementations

impl<'a, Message, Renderer> PaneGrid<'a, Message, Renderer> where
    Renderer: Renderer, 

pub fn new<T>(
    state: &'a mut State<T>,
    view: impl Fn(Pane, &'a mut T) -> Content<'a, Message, Renderer>
) -> Self

Creates a PaneGrid with the given State and view function.

The view function will be called to display each Pane present in the State.

pub fn width(self, width: Length) -> Self

Sets the width of the PaneGrid.

pub fn height(self, height: Length) -> Self

Sets the height of the PaneGrid.

pub fn spacing(self, units: u16) -> Self

Sets the spacing between the panes of the PaneGrid.

pub fn on_click<F>(self, f: F) -> Self where
    F: 'a + Fn(Pane) -> Message, 

Sets the message that will be produced when a Pane of the PaneGrid is clicked.

pub fn on_drag<F>(self, f: F) -> Self where
    F: 'a + Fn(DragEvent) -> Message, 

Enables the drag and drop interactions of the PaneGrid, which will use the provided function to produce messages.

pub fn on_resize<F>(self, leeway: u16, f: F) -> Self where
    F: 'a + Fn(ResizeEvent) -> Message, 

Enables the resize interactions of the PaneGrid, which will use the provided function to produce messages.

The leeway describes the amount of space around a split that can be used to grab it.

The grabbable area of a split will have a length of spacing + leeway, properly centered. In other words, a length of (spacing + leeway) / 2.0 on either side of the split line.

Trait Implementations

impl<'a, Message, Renderer> From<PaneGrid<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
    Renderer: 'a + Renderer + Renderer,
    Message: 'a, 

pub fn from(
    pane_grid: PaneGrid<'a, Message, Renderer>
) -> Element<'a, Message, Renderer>

Performs the conversion.

impl<'a, Message, Renderer> Widget<Message, Renderer> for PaneGrid<'a, Message, Renderer> where
    Renderer: Renderer + Renderer, 

pub fn width(&self) -> Length

Returns the width of the Widget.

pub fn height(&self) -> Length

Returns the height of the Widget.

pub fn layout(&self, renderer: &Renderer, limits: &Limits) -> Node

Returns the Node of the Widget.

pub fn on_event(
    &mut self,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    messages: &mut Vec<Message>,
    renderer: &Renderer,
    clipboard: Option<&dyn Clipboard>
) -> Status

Processes a runtime Event.

pub fn draw(
    &self,
    renderer: &mut Renderer,
    defaults: &Renderer::Defaults,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle
) -> Renderer::Output

Draws the Widget using the associated Renderer.

pub fn hash_layout(&self, state: &mut Hasher)

Computes the layout hash of the Widget.

pub fn overlay(
    &mut self,
    layout: Layout<'_>
) -> Option<Element<'_, Message, Renderer>>

Returns the overlay of the Widget, if there is any.