Class: AnsiTerm

This method removes the callback registered by registerOnFreezeChange.

This method removes the callback registered by registerOnStatusChange.

This method removes the callback registered by registerOnTitleChange.

This method clears the selection and returns the focus to the terminal.

This method copies the selection to the clipboard. The selection is copied as text, possibly containing ANSI sequences to reproduce the character attributes of the on-screen text.

This method copies the selection to the clipboard. The selection is copied as HTML, reproducing the characters of the on-screen text and their attributes.

This method copies the selection to the clipboard. The selection is copied as Rich Text.

NOTE: this method is still under development, and its behavior may change in future releases.

The text is actually stored as HTML, but trailing spaces in lines are discarded. Since the goal of this method is to capture data suited to be pasted into word processors, some adjustments may be useful (e.g., color correction to deal with typical white backgrounds).

This method copies the selection to the clipboard. The selection is copied as plain text.

This method implements the clipboard "paste" function.

This method closes the terminal's communication channel and destroys the terminal.

This method adds a callback that the terminal will invoke each time one of these events happens:

• the terminal freezes, i.e., stops updating the screen and accumulates incoming characters instead of showing them. A "freeze" may be generated by entering the mouse selection state or programmatically by calling toggleFreezeState.
• the terminal is frozen, and new characters are received.
• the terminal exits the freeze state.

The callback receives two parameters:

• a boolean parameter, "true" if the terminal is frozen, "false" if not,
• the number of characters received since the terminal has been frozen.

Multiple callbacks may be registered in this way.

The callbacks can be removed by calling the cancelOnFreezeChange method.

Adds a callback that the terminal will invoke when the communication state changes. The callback receives a boolean parameter: "true" if the communication is established, "false" if not.

Multiple callbacks may be registered in this way. The callbacks can be removed by calling the cancelOnStatusChange method.

This method adds a callback that the terminal will invoke each time the title changes, i.e., when the "set title" ANSI sequence is received. The callback receives the new title as a parameter. Multiple callbacks may be registered in this way. The callbacks can be removed by calling the cancelOnTitleChange method.

This method selects the entire screen. It implements the "Select all" button function.

This method sends the ANSI sequence corresponding to the given keyboard event object to the communication channel used by the terminal.

A key event is an object containing key-related members as produced by a real key event. The object is not required to be a real "event", as only a subset of members is needed:

• "key",
• "code",
• "composed",
• "ctrlKey",
• "altKey",
• "metaKey".

Example: the TAB key is represented by this object:

{ key: 'Tab', code: 'Tab', composed: false, ctrlKey: false, altKey: false, metaKey: false }

This method sends the given sequence of characters to the communication channel used by the terminal.

This method writes the given sequence of characters. The sequence is processed by the ANSI interpreter, which modifies the screen accordingly.

This method retrieves the version string of "xwterm.js".