OutputNavigation.h File Reference

The output of a cell as a tree the keyboard can walk through (GH #2382). More...

#include "cells/MatrixBlock.h"
#include <vector>

Include dependency graph for OutputNavigation.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	OutputNavigation::Item
	One node of the tree: a run of sibling cells, or one entry of a matrix. More...
struct	OutputNavigation::Location
	Where an item sits in the tree. More...
struct	OutputNavigation::RunLocation
	Where a run of several siblings sits: the level holding both of its ends. More...

Functions
Item	OutputNavigation::Run (Cell *first, Cell *last)
	The item a run of cells forms.
Item	OutputNavigation::Entry (MatrCell *matrix, MatrixEntry entry)
	The item one entry of a matrix forms.
std::vector< Item >	OutputNavigation::Results (const GroupCell *group)
	The top level: the results of this cell's output, as items.
std::vector< Item >	OutputNavigation::Children (const Item &item)
	The parts of an item, in reading order; empty if it has none.
Location	OutputNavigation::Locate (const GroupCell *group, const Item &item)
RunLocation	OutputNavigation::LocateRun (const GroupCell *group, const Cell *first, const Cell *last)

Detailed Description

The output of a cell as a tree the keyboard can walk through (GH #2382).

The worksheet's output cursor is its ordinary selection. This file only answers the structural questions the arrow keys need: what the parts of a selected expression are (Enter goes into them), which part it is itself a part of (Escape goes back out) and which parts sit next to it (Left and Right). It knows nothing about key events or the worksheet, so it can be tested on parsed output alone.

The tree follows the expression's structure, Cell::GetInnerCell(), not the draw list: whether a wide expression happens to be broken into lines must not change what a key press does. Its levels are:

• the results of a cell (GroupCell::GetOutputResults()), each a label and its expression;
• below a result, the cells of its expression, without the label;
• below a single cell, its parts: a fraction's numerator and denominator, a function's name and arguments, the contents of parentheses, ... Glyphs a cell only shows while broken into lines ("sqrt(", ",", ")") are not parts;
• below a part that is a run of several cells (the numerator of (a+b)/c), those cells;
• below a matrix, its entries. An entry is selected as a one-entry block (DocumentCellPointers::SetSelectedMatrixBlock()), so the entry is highlighted in place and Shift+arrow keys grow it into a block exactly as they grow a block selected with the mouse (GH #2370).

Anything that isn't drawn – hidden cells, empty ones, elided matrix entries – is left out.

Function Documentation

Children()

std::vector< Item > OutputNavigation::Children

(

const Item &

item

)

The parts of an item, in reading order; empty if it has none.

What Enter goes into.