Struct PaneInfo 

pub struct PaneInfo {

    pub id: u32,
    pub is_plugin: bool,
    pub is_focused: bool,
    pub is_fullscreen: bool,
    pub is_floating: bool,
    pub is_suppressed: bool,
    pub title: String,
    pub exited: bool,
    pub exit_status: Option<i32>,
    pub is_held: bool,
    pub pane_x: usize,
    pub pane_content_x: usize,
    pub pane_y: usize,
    pub pane_content_y: usize,
    pub pane_rows: usize,
    pub pane_content_rows: usize,
    pub pane_columns: usize,
    pub pane_content_columns: usize,
    pub cursor_coordinates_in_pane: Option<(usize, usize)>,
    pub terminal_command: Option<String>,
    pub plugin_url: Option<String>,
    pub is_selectable: bool,
    pub index_in_pane_group: BTreeMap<ClientId, usize>,
    pub default_fg: Option<String>,
    pub default_bg: Option<String>,
}

Contains all the information for a currently open pane

Difference between coordinates/size and content coordinates/size

The pane basic coordinates and size (eg. pane_x or pane_columns) are the entire space taken up by this pane - including its frame and title if it has a border.

The pane content coordinates and size (eg. pane_content_x or pane_content_columns) represent the area taken by the pane’s content, excluding its frame and title if it has a border.

Fields

id: u32

The id of the pane, unique to all panes of this kind (eg. id in terminals or id in panes)

is_plugin: bool

Whether this pane is a plugin (true) or a terminal (false), used along with id can represent a unique pane ID across the running session

is_focused: bool

Whether the pane is focused in its layer (tiled or floating)

is_fullscreen: bool

is_floating: bool

Whether a pane is floating or tiled (embedded)

is_suppressed: bool

Whether a pane is suppressed - suppressed panes are not visible to the user, but still run in the background

title: String

The full title of the pane as it appears in the UI (if there is room for it)

exited: bool

Whether a pane exited or not, note that most panes close themselves before setting this flag, so this is only relevant to command panes

exit_status: Option<i32>

The exit status of a pane if it did exit and is still in the UI

is_held: bool

A “held” pane is a paused pane that is waiting for user input (eg. a command pane that exited and is waiting to be re-run or closed)

pane_x: usize

pane_content_x: usize

pane_y: usize

pane_content_y: usize

pane_rows: usize

pane_content_rows: usize

pane_columns: usize

pane_content_columns: usize

cursor_coordinates_in_pane: Option<(usize, usize)>

The coordinates of the cursor - if this pane is focused - relative to the pane’s coordinates

terminal_command: Option<String>

If this is a command pane, this will show the stringified version of the command and its arguments

plugin_url: Option<String>

The URL from which this plugin was loaded (eg. zellij:strider for the built-in strider plugin or file:/path/to/my/plugin.wasm for a local plugin)

is_selectable: bool

Unselectable panes are often used for UI elements that do not have direct user interaction (eg. the default status-bar or tab-bar).

index_in_pane_group: BTreeMap<ClientId, usize>

Grouped panes (usually through an explicit user action) that are staged for a bulk action the index is kept track of in order to preserve the pane group order

default_fg: Option<String>

The default foreground color of this pane, if set (e.g. “#00e000”)

default_bg: Option<String>

The default background color of this pane, if set (e.g. “#001a3a”)

Implementations

impl PaneInfo

pub fn decode_from_kdl( kdl_document: &KdlDocument, ) -> Result<(usize, Self), String>

pub fn encode_to_kdl(&self) -> KdlDocument

Trait Implementations

impl Clone for PaneInfo

fn clone(&self) -> PaneInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaneInfo

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

Formats the value using the given formatter.

impl Default for PaneInfo

fn default() -> PaneInfo

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PaneInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for PaneInfo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PaneInfo

fn eq(&self, other: &PaneInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PaneInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PaneInfo> for PaneInfo

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(protobuf_pane_info: ProtobufPaneInfo) -> Result<Self, &'static str>

Performs the conversion.

impl TryFrom<PaneInfo> for ProtobufPaneInfo

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(pane_info: PaneInfo) -> Result<Self, &'static str>

Performs the conversion.

impl Eq for PaneInfo

impl StructuralPartialEq for PaneInfo