DESIGN (xvobjects) functions


LIBRARY ROUTINE

xvw_create_console - create a console object

LIBRARY CALL

xvobject xvw_create_console(
   xvobject parent,
   char     *name)

INPUT

OUTPUT

none

RETURN VALUE

The console object on success, NULL on failure

DESCRIPTION

The console object supports display of text files.

For files that were output from roff interpreters, the console object will format the text as specified by the control characters produced by the roff interpreter. In other words, the console object cannot format files with roff commands still in them; rather, it supports display of files that were output by a roff interpreter such as nroff or roff, after such a proram was already run on the file with the roff commands in it.

Of course, the console object also supports display of plain ascii text files.

The console object supports specification of five different fonts, the roman font that is used with "normal" text, as well as bold, italic, and helvetica fonts for emphasis and a symbol font for use with equations.

The console object can also be used to support hypertext-type functionality. The console object is capable of keepin a special list of words that miht appear in the text; such "special" words will appear in a different color from the rest of the text. A callback can be installed on the console object which will be fired when the user clicks on a word that is part of the console list of "special" words. Thus, the application can use this capability to display a new text file determined by the word selected by the user.

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

none

MODIFICATION

none

FILES

$DESIGN/objects/library/xvobjects/src/Console.c

SEE ALSO

xvobjects(3)

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.