← All compilation units

Flyology_TUI.Views

Description

Cursor_Description

type Cursor_Description is record
   Visible : Boolean := False;
   X       : Natural := 0;
   Y       : Natural := 0;
   Shape   : Cursor_Shape := Cursor_Block;
   Blink   : Boolean := True;
end record;
Record fields
Visible
X
Y
Shape
Blink

Cursor_Shape

type Cursor_Shape is
  (Cursor_Block, Cursor_Underline, Cursor_Bar);
Enumeration literals
Cursor_Block
Cursor_Underline
Cursor_Bar

From_Surface

function From_Surface (Frame : Flyology_TUI.Surfaces.Surface) return View
Parameters
Frame
Return value

Mouse_Mode

type Mouse_Mode is
  (Mouse_Disabled,
   Button_Events,
   Cell_Motion,
   All_Motion);
Enumeration literals
Mouse_Disabled
Button_Events
Cell_Motion
All_Motion

Plain

function Plain (Content : Wide_Wide_String) return View
Parameters
Content
Return value

Styled

function Styled
  (Content    : Wide_Wide_String;
   Appearance : Flyology_TUI.Styles.Style) return View
Parameters
Content
Appearance
Return value

View

type View is tagged record
   Frame             : Flyology_TUI.Surfaces.Surface;
   Alternate_Screen  : Boolean := False;
   Mouse             : Mouse_Mode := Mouse_Disabled;
   Report_Focus      : Boolean := False;
   Bracketed_Paste   : Boolean := True;
   Window_Title      : Text.Unbounded_Wide_Wide_String;
   Cursor            : Cursor_Description;
end record;

A complete declaration of the desired terminal view. Backends reconcile these fields with terminal state and must restore any enabled modes when they close, including after an exception.

Record fields
Frame
Alternate_Screen
Mouse
Report_Focus
Bracketed_Paste
Window_Title
Cursor