compound

Synopsis

include "draw.m";
include "prefab.m";
prefab:= load Prefab Prefab->PATH;
Compound: adt
{
  image:   ref Draw->Image;
  environ: ref Environ;
  r:       Draw->Rect;
  title:   ref Element;
  contents:ref Element;
 
  iconbox:  fn(env: ref Environ,
               p: Draw->Point, title: string, icon,
               mask: ref Draw->Image)             :ref Compound;
  textbox:  fn(env: ref Environ,
               r: Draw->Rect, title, text: string):ref Compound;
  layoutbox: fn(env: ref Environ,
                r: Draw->Rect, title: string, lay: list of Layout)
                                                  :ref Compound;
  box:    fn(env: ref Environ, p: Draw->Point, title, elist: ref 
Element):ref Compound;
  draw:    fn(comp: self ref Compound);
  redraw:  fn(comp: self ref Compound, r: Draw->Rect);
  scroll:  fn(comp: self ref Compound, elem: ref Element, d: 
Draw->Point);
  show:    fn(comp: self ref Compound, elem: ref Element): int;
  select:  fn(comp: self ref Compound,
        elem: ref Element, i: int, c: chan of int):
        (int, int, ref Element);
  tagselect: fn(comp: self ref Compound,
        elem: ref Element, i: int, c: chan of int):
        (int, int, ref Element);
  highlight: fn(comp: self ref Compound,
        elem: ref Element, on: int);
};

Description

Compound is the abstract data type that defines boxes drawn on the screen. Each appears in a new window, Compound.image, and holds a (possibly nil) title and contents. Element. It occupies the space on the screen defined by Compound.r. Allocating a Compound creates a window but does not draw it; after the Compound is built, Compound.draw must be called to make it visible. Compounds have a border around them, drawn in Style.edgecolor and contain, from top-to-bottom, the title (if any), a horizontal line (if there is a title), and the contents.

Compound.iconbox (env, p, title, icon, mask)

Creates a Compound whose contents are made by calling Element.icon (see elem) using the icon and mask. The Compound 's upper left corner is at p; its size is determined by the size of the icon and mask.


element	The element is contained in the Compound, and may be at any level of its structure. It is most usefully a list, but may be a singleton, in which case it behaves like a list of one element.
index	The number of the element on the list
c	The channel, c, is a `chan` `of` `int` connected to an IR remote control interface, typically acquired through the program's `Context` (see context).

The arrow keys on the remote control scroll through the members of the list, using the Style.highlightcolor associated with each member element to indicate selection. A Select key on the remote control triggers select to return a tuple, (key, index, elem), where:

key

The key member is the key code of the action (here Select).

index

The index member is the number of the element in the list (ignoring separators).

elem

The elem member is the list member highlighted when the key was hit.

key	The key member is the key code of the action (here Select).
index	The index member is the number of the element in the list (ignoring separators).
elem	The elem member is the list member highlighted when the key was hit.

Any other key returns the same tuple with index -1 and the value of the key. The elem returned is always the most recently highlighted, even if the result was not a selection. When select returns, it always restores the default appearance of the list.

Compound.tagselect (element, index, c): (int, int, Element)

Like Compound.select, but rather than selecting among all the elements of a list, it selects among only those elements with defined tags in the structure contained within the specified element.

Compound.highlight (element, on)

Set the highlighting to be 'on' or 'off' for the element within the compound.

Compound.scroll (element, d)

Scroll the element within the compound. The updated image is redrawn after the scrolling.

Compound.show (elementtag, d)

Make sure the element is visible within the rectangle of the top-level Element of the Compound, that is, in effect call Element.show (Compound.contents, element).

infernosupport@lucent.com