DESIGN (xvobjects) functions


LIBRARY ROUTINE

xvw_create_textdisplay - create a textdisplay object

LIBRARY CALL

xvobject xvw_create_textdisplay(
   xvobject parent,
   char     *name)

INPUT

OUTPUT

none

RETURN VALUE

The textdisplay object on success, NULL on failure

DESCRIPTION

The textdisplay object supports display of text files.

For files that were output from roff interpreters, the textdisplay object will format the text as specified by the control characters produced by the roff interpreter. In other words, the textdisplay 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 groff, after such a program was already run on the file with the roff commands in it.

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

The textdisplay 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 textdisplay object can also be used to support hypertext-type functionality. The textdisplay object is capable of keeping a special list of words that might 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 textdisplay object which will be fired when the user clicks on a word that is part of the textdisplay 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/TextDisplay.c

SEE ALSO

xvobjects(3)

COPYRIGHT

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