Struct GridMenuContext 

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

What LiveGridDelegate::context_menu and LiveGridDelegate::primary_command know: the target, the command scope and the rows of the snapshot shown when the menu opened.

Implementations

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

pub fn grouping_items(&self, menu: PopupMenu) -> PopupMenu

“Group by this column” (GroupByColumn), “Ungroup” (UngroupColumn) for the target column, then “Ungroup all” (ClearGrouping). Items that would do nothing are disabled: grouping by a column that is not groupable or already a level, or in a tree view (a tree and a grouping exclude each other, as in AG Grid and DevExpress); ungrouping a column that is no level; ungrouping all without a grouping. Without a target column, only “Ungroup all”. Self::column_items ends with them.

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

pub fn target(&self) -> &GridTarget<R::Key, R::Column>

Where the menu was opened.

pub fn selection(&self) -> &ScopedSelection<R::Key>

The command scope of the target when the menu opened, in display order: a caption’s group rows, else scoped_selection(), as the selection policy decides. For labels and enabled states only: a command handler reads the scope again when it runs.

pub fn group(&self) -> Option<GroupInfo<'a>>

The group of a caption or footer target, in the projection shown when the menu opened.

pub fn row(&self, key: &R::Key) -> Option<&'a Arc<R>>

A data row of the snapshot shown when the menu opened.

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

The row the target is in, as the snapshot shown when the menu opened has it: the data row of a cell target, the pinned row of a pinned target; None for a header, the empty area and the lines the grid makes (captions, footers, totals).

pub fn standard_items( &self, menu: PopupMenu, window: &mut Window, cx: &mut Context<'_, PopupMenu>, ) -> PopupMenu

The built-in items for the target, in the standard order:

• a cell: Copy, Copy all; the Sort and Column submenus for its column, so the keyboard reaches the header’s commands (Shift+F10 on the focused cell);
• a header: the sort items, the column items, Copy, Copy all;
• a group caption: the group items, Copy (the group’s rows), Copy all;
• a pinned row, a group footer, the totals row and elsewhere: Copy, Copy all (Copy copies the selection of data rows; Copy all takes the bands and the totals too).

The grid puts the primary command above them.

pub fn group_items(&self, menu: PopupMenu) -> PopupMenu

Expand or Collapse for a caption target (by its state), then Expand all, Collapse all and Captions only (checked while the default depth is ExpandDepth::Captions). They dispatch ExpandRow, CollapseRow, ExpandAll, CollapseAll and ShowCaptionsOnly to the grid, whose focus is on the caption a press opened the menu for.

pub fn copy_items(&self, menu: PopupMenu) -> PopupMenu

Copy (Copy, disabled when the command scope is empty) and Copy all (CopyAll).

pub fn sort_items(&self, menu: PopupMenu) -> PopupMenu

Sort ascending, Sort descending and Clear sort for the target column, then Clear all sorting (ClearAllSorting); nothing without a target column. The first three are disabled for a column that is not sortable; the current direction is checked; Clear sort is disabled for a column outside the sort, Clear all sorting when nothing is sorted.

pub fn column_items(&self, menu: PopupMenu) -> PopupMenu

Autofit, hide, show all, choose (ShowColumnChooser), freeze, unfreeze and reset columns for the target column, then the grouping items (Self::grouping_items). Without a target column, only the items for every column. “Hide column” is disabled for the last visible column and for a column the user may not hide (GridColumn::with_hideable).