Struct Ui 

pub struct Ui {

    pub grids: Vec<Grid>,
    pub draw_order: Vec<DrawItem>,
    pub float_windows_start: usize,
    pub cursor: CursorInfo,
    pub mouse: bool,
    pub highlights: Vec<Option<Attributes>>,
    pub highlight_groups: HashMap<String, HlId>,
    pub did_highlights_change: bool,
    pub current_mode: u32,
    pub modes: Vec<ModeInfo>,
    pub guifont_update: Option<GuiFont>,
    pub default_colors: DefaultColorsSet,
    pub messages: Messages,
    pub cmdline: Cmdline,
    pub popupmenu: Option<PopupmenuShow>,
    pub tabline: Option<TablineUpdate>,
    pub did_flush: bool,
    pub ignore_next_scroll: bool,
}

Manages updates to the UI state from UI events

Fields

grids: Vec<Grid>

UI grids, ordered by ID

draw_order: Vec<DrawItem>

The order in which grids should be drawn, ordered from bottom to top

float_windows_start: usize

The index into self.draw_order at which floating windows begin

cursor: CursorInfo

Cursor information

mouse: bool

Whether the mouse is enabled

highlights: Vec<Option<Attributes>>

UI highlights, indexed by their ID

highlight_groups: HashMap<String, HlId>

A lookup from highlight names to highlight IDs

did_highlights_change: bool

Whether the highlights changed since the last flush

current_mode: u32

The ID of the current mode

modes: Vec<ModeInfo>

Information about Vim modes, indexed by ID

guifont_update: Option<GuiFont>

UI options set by the option_set event

default_colors: DefaultColorsSet

Default highlight colors

messages: Messages

Manages ext_hlstate events

cmdline: Cmdline

Manages ext_cmdline events

popupmenu: Option<PopupmenuShow>

Manages ext_popupmenu events

tabline: Option<TablineUpdate>

Manages ext_tabline events

did_flush: bool

Did we receive a flush event?

ignore_next_scroll: bool

Implementations

impl Ui

pub fn new() -> Self

pub fn grid_index(&self, id: Id) -> Result<usize, usize>

Index of the grid with the given id, or else the index where the grid should be inserted

pub fn grid_mut(&mut self, id: Id) -> Option<&mut Grid>

Grid with the given ID

pub fn grid(&self, id: Id) -> Option<&Grid>

Grid with the given ID

pub fn clear_dirty(&mut self)

Reset dirty flags

pub fn process(&mut self, event: Event)

Update the UI with the given event

pub fn position(&self, grid: Id) -> Option<CellVec<f32>>

Get the position of the grid, accounting for anchor grids and other windowing details

pub fn grid_under_cursor( &self, cursor: PixelVec<u32>, cell_size: Vec2<u32>, ) -> Option<GridUnderCursor>

The grid under the cursor, accounting for anchor grids and other windowing details

Trait Implementations

impl Clone for Ui

fn clone(&self) -> Ui

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Ui

fn default() -> Ui

Returns the “default value” for a type.