Struct CellElementContext 

pub struct CellElementContext<'a, R: GridRow> { /* private fields */ }

What LiveGridDelegate::render_cell knows about a visible cell of an Element or Control column.

Implementations

impl<'a, R: GridRow> CellElementContext<'a, R>

pub fn row(&self) -> &'a R

The row, as this frame shows it.

pub fn shared_row(&self) -> &'a Arc<R>

The row, shared: for an element’s handlers, which run after the frame and outlive it.

pub fn key(&self) -> &'a R::Key

The row’s key.

pub fn column(&self) -> R::Column

The column.

pub fn value(&self) -> CellValue<'a>

The cell’s value: the store’s, or the value a commit of the cell still waits with.

pub fn text(&self) -> &'a str

The text the body would paint for the value.

pub fn change(&self) -> Option<CellChange>

The cell’s highlighted change, if it is hot: for an element that shows the change itself. On a removed row that fades out it is RowChange::Removed at the fade’s intensity: the element is drawn until the fade ends, and takes no press, Space or edit.

pub fn size(&self) -> ComponentSize

The grid’s size: gpui-kit elements take it through Sizable and fit the row.

pub fn cell_size(&self) -> Size<Pixels>

The room for the element: the cell without its padding.

pub fn is_selected(&self) -> bool

Returns true if the cell is selected.

pub fn is_focused(&self) -> bool

Returns true if the cell has the grid’s focus.

pub fn edit_state(&self) -> Option<&'a EditState>

The cell’s edits: a commit that waits for an answer (Pending) or for the store (Accepted) — Self::value is its value then — or a refused one (Failed). None for a cell with no edits.

pub fn edit(&self) -> Option<CellEditHandle>

A handle that commits values of this cell as edits, for the element’s handlers, such as a checkbox’s on_click and on_activate: EditCommit, then the value shown until the commit settles. None if the column has no editor, or on a pinned row. Whether the delegate’s is_editable takes the cell is asked at the commit, outside the frame.

pub fn on_activate(&self, handler: impl Fn(&mut Window, &mut App) + 'static)

Sets what Space does on the focused cell of a Control column (ActivateCell): what a press on the element does, such as toggling a checkbox. Kept for the focused cell only, until the next frame; on any other cell it is dropped without being stored. It runs after the key is handled, outside the grid’s update, so it may update the grid.