Modern Tui TuiFrame Clip

Home › Terminal TUI Library › Buffer and Frame › TuiFrame.Clip

TuiFrame.Clip

Returns the rectangle that drawing is currently limited to.

Syntax

TuiFrame.Clip( ) as TuiRect

Description

The rect writes are currently confined to. Equal to Area until something pushes a clip.

Example

#import "std/tui"
using tui

dim as TuiScreen scr
scr.Resize( 40, 10 )
dim as TuiFrame ptr f = scr.BeginFrame( )
print f->Clip( ).Equals( f->Area( ) )       '' true

dim as TuiRect saved = f->PushClip( TuiRectOf( 5, 2, 10, 4 ) )
print f->Clip( ).w                          '' 10
f->PopClip( saved )
print f->Clip( ).w                          '' 40

See also

TuiCell	TuiCell.Equals	TuiBuffer	TuiBuffer.Clear	TuiBuffer.At	TuiFrame
TuiCell.SetChar	TuiCellBlank	TuiBuffer.Resize	TuiBuffer.InBounds	TuiBuffer.Count	TuiFrame.Area

---

Library: Terminal TUI Library
Category: Terminal TUI Library
Documented under: Buffer and Frame
Working examples: hello.tiko · form.tiko · dashboard.tiko

---

Home · Keyword Index