Yi.Window

Operations on Windows, in the emacs sense of the word.

Documentation

data Window

A window onto a buffer.

Constructors

Window

Fields

isMini :: !Bool

regular or mini window?

bufkey :: !BufferRef

the buffer this window opens to

bufAccessList :: ![BufferRef]

list of last accessed buffers (former bufKeys). Last accessed one is first element

height :: !Int

height of the window (in number of screen lines displayed)

width :: !Int

width of the window (in number of chars)

winRegion :: !Region

view area. note that the top point is also available as a buffer mark.

wkey :: !WindowRef

identifier for the window (for UI sync) This is required for accurate scrolling. Scrolling depends on the actual number of buffer lines displayed. Line wrapping changes that number relative to the height so we can't use height for that purpose.

actualLines :: !Int

The actual number of buffer lines displayed. Taking into account line wrapping

jumpList :: !JumpList

Instances

Eq Window

Show Window

Typeable Window

Binary Window

MonadReader Window BufferM

wkeyA :: Lens' Window WindowRef

winRegionA :: Lens' Window Region

widthA :: Lens' Window Int

jumpListA :: Lens' Window JumpList

isMiniA :: Lens' Window Bool

heightA :: Lens' Window Int

bufkeyA :: Lens' Window BufferRef

bufAccessListA :: Lens' Window [BufferRef]

actualLinesA :: Lens' Window Int

winkey :: Window -> (Bool, BufferRef)

Get the identification of a window.

dummyWindow :: BufferRef -> Window

Return a fake window onto a buffer.