Class Documentation

Name:Terminal
Version:1.0
ID:ID_TERMINAL
Status:Stable
Category:Tool
Date:May 2004
Author:Rocklyte Systems
Copyright:  Rocklyte Systems (c) 2004. All rights reserved.
Short:  A terminal emulator for Unix based systems running Athene.



Description

The Terminal class provides a complete terminal emulator for Athene, based on the iterm library for Linux. The Terminal class does not work on any other platform besides Linux. The Terminal class is often used to enhance applications where a commandline that accesses the underlying operating system may be useful.

The Terminal class is used like a standard GUI object. It takes ownership of the entire drawable that you put it in, so you must enclose the terminal within a private drawing space. You can overlay graphics on top of the terminal if you wish. The following DML script illustrates typical usage:

  <dml type="program">
    <window name="win{id}" title="ZTerm" flags="nomargins"
      insidewidth="600" height="480" icon="icons:programs/shell">
      <render x="[owner.leftmargin]" y="[owner.topmargin]"
        xoffset="[owner.rightmargin]" yoffset="[owner.bottommargin]">
        <terminal/>
      </render>
    </window>
  </dml>

Actions

The Terminal class supports the following actions:

Focus  Activates keyboard monitoring (by force).
LostFocus  Deactivates keyboard monitoring (by force).

Structure

The Terminal object consists of the following public fields:

Message  If set, prints a message to the console on startup.
Field:Message
Short:If set, prints a message to the console on startup.
Type:STRING
Status:Read/Set

If you would like to print a splash message to the console when it is opened, set the Message field with a string that you would like to display. The string may include escape codes and other character sequences that are valid through VT100 terminals.