Struct LiveGridHandle 

pub struct LiveGridHandle { /* private fields */ }

A grid without its delegate type: columns, layout, sort, grouping, quick filter, counts, the held order, copy and export, and its events, all by column id. What a toolbar, a status bar or a column chooser needs.

Clones refer to the same grid and keep it alive, as an Entity does; downgrade for a back reference. Each method is one read or one update of the grid: never call it from inside an update of the same grid, such as a delegate hook (the borrow panics). Edits are not here: they need row keys, the application’s own type.

use gpui_kit::{App, IntoElement, ParentElement as _, div};
use gpui_kit_grid::LiveGridHandle;

/// "120 of 4000 rows", whatever the grid's rows are.
fn row_counts(grid: &LiveGridHandle, cx: &App) -> impl IntoElement {
    div().child(format!(
        "{} of {} rows",
        grid.row_count(cx),
        grid.total_row_count(cx)
    ))
}

Implementations

impl LiveGridHandle

pub fn new<D: LiveGridDelegate>(grid: &Entity<LiveGridState<D>>) -> Self

A handle of grid.

pub fn entity_id(&self) -> EntityId

The grid entity’s id.

pub fn downgrade(&self) -> WeakLiveGridHandle

A handle that does not keep the grid alive.

pub fn focus_handle(&self, cx: &App) -> FocusHandle

The grid’s focus handle: focus it to give the grid the keyboard.

pub fn columns(&self, cx: &App) -> Vec<ColumnInfo>

Every schema column in display order (left, scrolling, right zone), hidden ones at their place. O(columns).

pub fn column(&self, id: &str, cx: &App) -> Option<ColumnInfo>

The schema column id; None if the schema has none.

pub fn set_column_visible(&self, id: &str, visible: bool, cx: &mut App) -> bool

Shows or hides the column id, as LiveGridState::set_column_visible does. Returns false, changing nothing, if the column is unknown or is the last visible one.

pub fn show_all_columns(&self, cx: &mut App)

Shows every column, with one LayoutChange.

pub fn move_column(&self, id: &str, before: Option<&str>, cx: &mut App) -> bool

Moves the column id before the column before (None: to the end of its zone), as LiveGridState::move_column does. Returns false, changing nothing, if a column is unknown, the zones differ or the move policy refuses.

pub fn move_band(&self, band: &str, before: Option<&str>, cx: &mut App) -> bool

Moves every column of band before the column before (None: to the end of the zone), as LiveGridState::move_band does. Returns false, changing nothing, if the band or the column is unknown, the zones differ or the move policy refuses.

pub fn set_column_zone(&self, id: &str, zone: ColumnZone, cx: &mut App) -> bool

Moves the column id to zone, as LiveGridState::set_column_zone does. Returns false if the column is unknown.

pub fn set_column_width(&self, id: &str, width: Pixels, cx: &mut App) -> bool

Sets the width of the column id, within its limits. Returns false if the column is unknown.

pub fn autofit_columns(&self, cx: &mut App)

Fits every visible column to its header and painted rows, as LiveGridState::autofit_columns does.

pub fn view_id(&self, cx: &App) -> Option<SharedString>

The view id of the grid’s saved layouts, if it has one.

pub fn layout(&self, cx: &App) -> GridLayout

The current layout (LiveGridState::layout).

pub fn set_layout( &self, layout: &GridLayout, cx: &mut App, ) -> Result<LayoutReport, LayoutError>

Restores a saved layout (LiveGridState::set_layout).

pub fn reset_layout(&self, cx: &mut App)

Restores the default layout (LiveGridState::reset_layout).

pub fn sort(&self, cx: &App) -> Vec<LayoutSort>

The sort by column id, most significant first; empty when unsorted.

pub fn set_sort( &self, sort: impl IntoIterator<Item = LayoutSort>, cx: &mut App, ) -> bool

Replaces the sort, as LiveGridState::set_sort does. Returns false, changing nothing, if a column is unknown.

pub fn group_by(&self, cx: &App) -> Vec<LayoutGroup>

The grouping levels by id, the top level first: a column level by its column’s id, a GroupKey level by its own.

pub fn set_group_by( &self, levels: impl IntoIterator<Item = LayoutGroup>, cx: &mut App, ) -> bool

Replaces the grouping by column levels, as LiveGridState::set_group_by does; no levels turn grouping off. Returns false, changing nothing, if a column is unknown: a GroupKey level needs the typed state.

pub fn expand_depth(&self, cx: &App) -> ExpandDepth

How deep groups and tree rows are expanded by default.

pub fn set_expand_depth(&self, depth: ExpandDepth, cx: &mut App)

Sets the default depth and clears every toggle (LiveGridState::set_expand_depth).

pub fn quick_filter(&self, cx: &App) -> SharedString

The quick filter text; empty when the filter is off.

pub fn set_quick_filter(&self, text: impl Into<SharedString>, cx: &mut App)

Sets the quick filter text (LiveGridState::set_quick_filter).

pub fn row_count(&self, cx: &App) -> usize

The data rows of the shown order (Projection::row_count): rows of collapsed groups count, pinned rows do not.

pub fn total_row_count(&self, cx: &App) -> usize

The live rows of the shown snapshot: the “4000” of “120 of 4000”.

pub fn selected_count(&self, cx: &App) -> usize

The selected rows, those a filter hides included.

pub fn is_order_held(&self, cx: &App) -> bool

Returns true if a newer order is ready but held by the reorder policy.

pub fn apply_held_order(&self, cx: &mut App)

Shows the held order now.

pub fn set_reorder_policy(&self, policy: impl ReorderPolicy, cx: &mut App)

Replaces the reorder policy, as LiveGridState::set_reorder_policy does: a held order is offered to the new policy at once. A toolbar’s Live / Hold / Manual switch, without the delegate type.

pub fn copy_scope(&self, scope: ExportScope, cx: &mut App) -> bool

Copies scope to the clipboard (LiveGridState::copy_scope). Returns false, leaving the clipboard alone, if there is nothing to copy.

pub fn is_export_empty(&self, scope: ExportScope, cx: &App) -> bool

Returns true if an export of scope would have nothing to write (LiveGridState::is_export_empty).

pub fn export_to_path( &self, scope: ExportScope, format: CsvFormat, path: impl Into<PathBuf>, cx: &mut App, ) -> Result<ExportJob<PathBuf>, ExportError>

Exports scope as CSV to a file at path, with a header line and the grid’s cell export (LiveGridState::export_to_path). Other formats and requests go through the typed state. Not on the web.

pub fn subscribe( &self, cx: &mut App, on_event: impl FnMut(&GridHandleEvent, &mut App) + 'static, ) -> Subscription

Calls on_event with what each event of the grid says without keys and columns (GridHandleEvent), until the subscription is dropped. Events with keys (Click, Confirm, FocusChange, edits) need the typed subscription.

pub fn observe( &self, cx: &mut App, on_notify: impl FnMut(&mut App) + 'static, ) -> Subscription

Calls on_notify whenever the grid notifies, until the subscription is dropped: for a status bar that reads the counts again.

pub fn show_column_chooser(&self, window: &mut Window, cx: &mut App)

Opens the grid’s column chooser, as LiveGridState::show_column_chooser does.

pub fn is_column_chooser_open(&self, cx: &App) -> bool

Returns true while the grid shows its column chooser.

Trait Implementations

impl Clone for LiveGridHandle

fn clone(&self) -> LiveGridHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LiveGridHandle

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

Formats the value using the given formatter.

impl<D: LiveGridDelegate> From<&Entity<LiveGridState<D>>> for LiveGridHandle

fn from(grid: &Entity<LiveGridState<D>>) -> Self

Converts to this type from the input type.