Struct iced_native::widget::pane_grid::state::State

source · [−]

pub struct State<T> {
    pub panes: HashMap<Pane, T>,
    pub internal: Internal,
    /* private fields */
}

Expand description

The state of a PaneGrid.

It keeps track of the state of each Pane and the position of each Split.

The State needs to own any mutable contents a Pane may need. This is why this struct is generic over the type T. Values of this type are provided to the view function of PaneGrid::new for displaying each Pane.

Fields

panes: HashMap<Pane, T>

The panes of the PaneGrid.

internal: Internal

The internal state of the PaneGrid.

Implementations

source

impl<T> State<T>

source

pub fn new(first_pane_state: T) -> (Self, Pane )

Creates a new State, initializing the first pane with the provided state.

Alongside the State, it returns the first Pane identifier.

source

pub fn with_configuration(config: impl Into<Configuration<T>>) -> Self

Creates a new State with the given Configuration.

source

pub fn len(&self) -> usize

Returns the total amount of panes in the State.

source

pub fn get(&self, pane: &Pane) -> Option<&T>

Returns the internal state of the given Pane, if it exists.

source

pub fn get_mut(&mut self, pane: &Pane) -> Option<&mut T>

Returns the internal state of the given Pane with mutability, if it exists.

source

pub fn iter(&self) -> impl Iterator<Item = (&Pane, &T)>

Returns an iterator over all the panes of the State, alongside its internal state.

source

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&Pane, &mut T)>

Returns a mutable iterator over all the panes of the State, alongside its internal state.

source

pub fn layout(&self) -> &Node

Returns the layout of the State.

source

pub fn adjacent(&self, pane: &Pane, direction: Direction) -> Option<Pane>

Returns the adjacent Pane of another Pane in the given direction, if there is one.

source

pub fn split(
 &mut self,
 axis: Axis,
 pane: &Pane,
 state: T
) -> Option<(Pane, Split )>

Splits the given Pane into two in the given Axis and initializing the new Pane with the provided internal state.

source

pub fn swap(&mut self, a: &Pane, b: &Pane)

Swaps the position of the provided panes in the State.

If you want to swap panes on drag and drop in your PaneGrid, you will need to call this method when handling a DragEvent.

source

pub fn resize(&mut self, split: &Split, ratio: f32)

Resizes two panes by setting the position of the provided Split.

The ratio is a value in [0, 1], representing the exact position of a Split between two panes.

If you want to enable resize interactions in your PaneGrid, you will need to call this method when handling a ResizeEvent.

source

pub fn close(&mut self, pane: &Pane) -> Option<(T, Pane )>

Closes the given Pane and returns its internal state and its closest sibling, if it exists.

Trait Implementations

source

impl<T: Clone> Clone for State<T>

source

fn clone(&self) -> State<T>

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<T: Debug> Debug for State<T>

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<T> RefUnwindSafe for State<T> where
T: RefUnwindSafe,

impl<T> Send for State<T> where
T: Send,

impl<T> Sync for State<T> where
T: Sync,

impl<T> Unpin for State<T> where
T: Unpin,

impl<T> UnwindSafe for State<T> where
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct iced_native::widget::pane_grid::state::State

Fields

Implementations

impl<T> State<T>

pub fn new(first_pane_state: T) -> (Self, Pane)

pub fn with_configuration(config: impl Into<Configuration<T>>) -> Self

pub fn len(&self) -> usize

pub fn get(&self, pane: &Pane) -> Option<&T>

pub fn get_mut(&mut self, pane: &Pane) -> Option<&mut T>

pub fn iter(&self) -> impl Iterator<Item = (&Pane, &T)>

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&Pane, &mut T)>

pub fn layout(&self) -> &Node

pub fn adjacent(&self, pane: &Pane, direction: Direction) -> Option<Pane>

pub fn split( &mut self, axis: Axis, pane: &Pane, state: T) -> Option<(Pane, Split)>

pub fn swap(&mut self, a: &Pane, b: &Pane)

pub fn resize(&mut self, split: &Split, ratio: f32)

pub fn close(&mut self, pane: &Pane) -> Option<(T, Pane)>

Trait Implementations

impl<T: Clone> Clone for State<T>

fn clone(&self) -> State<T>

fn clone_from(&mut self, source: &Self)

impl<T: Debug> Debug for State<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Auto Trait Implementations

impl<T> RefUnwindSafe for State<T> where T: RefUnwindSafe,

impl<T> Send for State<T> where T: Send,

impl<T> Sync for State<T> where T: Sync,

impl<T> Unpin for State<T> where T: Unpin,

impl<T> UnwindSafe for State<T> where T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> MaybeSend for T where T: Send,

pub fn new(first_pane_state: T) -> (Self, Pane )

pub fn split(
&mut self,
axis: Axis,
pane: &Pane,
state: T
) -> Option<(Pane, Split )>

pub fn close(&mut self, pane: &Pane) -> Option<(T, Pane )>

impl<T> RefUnwindSafe for State<T> where
T: RefUnwindSafe,

impl<T> Send for State<T> where
T: Send,

impl<T> Sync for State<T> where
T: Sync,

impl<T> Unpin for State<T> where
T: Unpin,

impl<T> UnwindSafe for State<T> where
T: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> MaybeSend for T where
T: Send,