Struct PaneNavigator 

pub struct PaneNavigator<K> { /* private fields */ }

A destination history and the pane value it gives. Own it in an Entity and hand it to a super::PaneScaffold, which keeps its directive current.

use gpui_kit_material::prelude::*;

// One pane at a time: the list, then the detail, then back.
let mut navigator = PaneNavigator::<u32>::list_detail();
assert!(navigator.is_expanded(PaneRole::Secondary));
navigator.navigate_to(PaneRole::Primary, Some(7));
assert!(navigator.is_expanded(PaneRole::Primary));
assert_eq!(navigator.content_key(), Some(&7));
navigator.navigate_back(BackNavigationBehavior::default());
assert!(navigator.is_expanded(PaneRole::Secondary));

Implementations

impl<K: Clone + PartialEq> PaneNavigator<K>

pub fn list_detail() -> Self

A list-detail navigator, starting on the list.

pub fn supporting_pane() -> Self

A supporting pane navigator, starting on the main pane.

pub fn history(&self) -> &[PaneDestination<K>]

The destination history, oldest first.

pub fn current(&self) -> Option<&PaneDestination<K>>

The latest destination.

pub fn content_key(&self) -> Option<&K>

The latest content key in the history, for what a detail pane shows.

pub fn directive(&self) -> PaneDirective

The directive in force.

pub fn set_directive(&mut self, directive: PaneDirective) -> bool

Apply a directive; true when it changed.

pub fn strategies(&self) -> &AdaptStrategies

The adapt strategies in force.

pub fn value(&self) -> ThreePaneValue

The panes’ current value.

pub fn is_expanded(&self, pane: PaneRole) -> bool

Whether a pane has its own partition, as a list checks before marking its selected row.

pub fn navigate_to(&mut self, pane: PaneRole, content_key: Option<K>)

Navigate to a pane.

pub fn can_navigate_back(&self, behavior: BackNavigationBehavior) -> bool

Whether there is a destination to go back to.

pub fn navigate_back(&mut self, behavior: BackNavigationBehavior) -> bool

Go back; false when there was nothing to go back to, which also clears the history, as Compose does.

Trait Implementations

impl<K: Clone> Clone for PaneNavigator<K>

fn clone(&self) -> PaneNavigator<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for PaneNavigator<K>

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

Formats the value using the given formatter.