Class: IQFrame

core/frame.IQFrame

IQFrame - Windowed content area

Table of contents

Constructors

• constructor

Methods

• blank
• center
• clear
• close
• cycle
• draw
• getContentArea
• gotoxy
• input
• inputPassword
• open
• popup
• say
• sayMCI
• separator
• waitKey

Constructors

constructor

• new IQFrame(options, output)

Parameters

Name	Type
options	IQFrameOptions
output	IQOutput

Defined in

core/src/frame.ts:134

Methods

blank

▸ blank(): IQFrame

Add a blank line

Returns

IQFrame

Defined in

core/src/frame.ts:317

---

center

▸ center(text): IQFrame

Center text within the frame

Parameters

Name	Type
text	string

Returns

IQFrame

Defined in

core/src/frame.ts:307

---

clear

▸ clear(): IQFrame

Clear the frame content (but keep frame open)

Returns

IQFrame

Defined in

core/src/frame.ts:348

---

close

▸ close(): void

Close the frame and restore the background If screen buffer management is active, redraws the saved region

Returns

void

Defined in

core/src/frame.ts:225

---

cycle

▸ cycle(): void

Cycle through content (for animation effects)

Returns

void

Defined in

core/src/frame.ts:334

---

draw

▸ draw(): void

Draw the buffered content inside the frame

Returns

void

Defined in

core/src/frame.ts:264

---

getContentArea

▸ getContentArea(): Object

Get the interior content area dimensions

Returns

Object

Name	Type
height	number
width	number
x	number
y	number

Defined in

core/src/frame.ts:365

---

gotoxy

▸ gotoxy(relX, relY): IQFrame

Position cursor inside the frame at relative coordinates

Parameters

Name	Type
relX	number
relY	number

Returns

IQFrame

Defined in

core/src/frame.ts:377

---

input

▸ input(prompt?, maxLength?): Promise<string>

Get text input within the frame at current content position

Parameters

Name	Type	Description
prompt?	string	Optional prompt text to display before input
maxLength?	number	Maximum input length (defaults to content width)

Returns

Promise<string>

The user’s input

Defined in

core/src/frame.ts:407

---

inputPassword

▸ inputPassword(prompt?, maxLength?): Promise<string>

Get password input (masked with asterisks)

Parameters

Name	Type	Description
prompt?	string	Optional prompt text
maxLength?	number	Maximum input length

Returns

Promise<string>

The user’s input

Defined in

core/src/frame.ts:468

---

open

▸ open(): void

Open the frame (draw border) Automatically saves the background region if screen buffer is available

Returns

void

Defined in

core/src/frame.ts:153

---

popup

▸ popup(): Promise<string>

Show a popup message and wait for key press Convenience method for quick modal dialogs

Returns

Promise<string>

Defined in

core/src/frame.ts:393

---

say

▸ say(text): IQFrame

Add content to the frame buffer

Parameters

Name	Type
text	string

Returns

IQFrame

Defined in

core/src/frame.ts:247

---

sayMCI

▸ sayMCI(text): IQFrame

Add content with MCI processing

Parameters

Name	Type
text	string

Returns

IQFrame

Defined in

core/src/frame.ts:256

---

separator

▸ separator(char?, color?): IQFrame

Add a horizontal separator line

Parameters

Name	Type	Default value
char	string	"\xC4"
color?	string	undefined

Returns

IQFrame

Defined in

core/src/frame.ts:324

---

waitKey

▸ waitKey(): Promise<string>

Wait for a key press (convenience method)

Returns

Promise<string>

Defined in

core/src/frame.ts:385