logo
pub struct PaneGrid<'a, Message, Renderer> where
    Renderer: Renderer,
    Renderer::Theme: StyleSheet + StyleSheet
{ /* private fields */ }
Expand description

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

Pane grid - Iced

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(&state, |pane, state| {
        pane_grid::Content::new(match state {
            PaneState::SomePane => text("This is some pane"),
            PaneState::AnotherKindOfPane => text("This is another kind of pane"),
        })
    })
    .on_drag(Message::PaneDragged)
    .on_resize(10, Message::PaneResized);

Implementations

Creates a PaneGrid with the given State and view function.

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

Sets the width of the PaneGrid.

Sets the height of the PaneGrid.

Sets the spacing between the panes of the PaneGrid.

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

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

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.

Sets the style of the PaneGrid.

Trait Implementations

Converts to this type from the input type.

Returns the Tag of the Widget. Read more

Returns the State of the Widget. Read more

Returns the state Tree of the children of the Widget.

Reconciliates the Widget with the provided Tree.

Returns the width of the Widget.

Returns the height of the Widget.

Returns the layout::Node of the Widget. Read more

Processes a runtime Event. Read more

Returns the current mouse::Interaction of the Widget. Read more

Draws the Widget using the associated Renderer.

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

Applies an Operation to the Widget.

Auto Trait Implementations

Blanket Implementations

Convert the source color to the destination color using the specified method Read more

Convert the source color to the destination color using the bradford method by default Read more

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Convert into T with values clamped to the color defined bounds Read more

Convert into T. The resulting color might be invalid in its color space Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more