Blitz3D+ Command Reference

LockTextArea textarea

Parameters

textarea - text area gadget to lock

Description

Makes a text area read-only so the user cannot edit its text.

A locked text area still scrolls, still lets the user select and copy text, and still responds to every program command - SetTextAreaText, AddTextAreaText and FormatTextAreaText all keep working while the lock is on. Only typing and pasting by the user are blocked.

This is the standard setup for output panes: a build log, a debug console, or the notes pane of an editor that should be display-only. Text areas start out unlocked; UnlockTextArea makes one editable again.

See it working in the world-editor shell sample.

Requires Extended mode.

See also: UnlockTextArea, CreateTextArea, SetTextAreaText, AddTextAreaText.

Index