Topic       : The ATARI Compendium
Author      : Scott Sanders / JAY Software
Version     : 1.25 (20/6/2003)
Subject     : Documentation
Nodes       : 1117
Index Size  : 32614
HCP-Version : 6
Compiled on : Atari
@charset    : UTF-8
@lang       : en
@default    : 
@help       : %About
@options    : +g -i -t4 +y +z
@width      : 100
View Ref-File
                                tedinfo


G_TEXT, G_BOXTEXT, G_FTEXT, and G_FBOXTEXT objects all reference
a TEDINFO structure in their ob_spec field. The TEDINFO structure is
defined below:

typedef struct text_edinfo
{
    char *  te_ptext;
    char *  te_ptmplt;
    char *  te_pvalid;
    WORD    te_font;
    WORD    te_fontid;
    WORD    te_just;
    WORD    te_color;
    WORD    te_fontsize;
    WORD    te_thickness;
    WORD    te_txtlen;
    WORD    te_tmplen;
} TEDINFO;

The three character pointer point to text strings required for G_FTEXT
and G_FBOXTEXT objects. te_ptext points to the actual text to be displayed
and is the only field used by all text objects. te_ptmplt points to the
text template for editable fields. For each character that the user can
enter, the text string should contain a tilde character (ASCII 126). Other
characters are displayed but cannot be overwritten by the user. te_pvalid
contains validation characters for each character the user may enter. The
current acceptable validation characters are:

Character  Allows

9          Digits 0-9

A          Uppercase letters A-Z plus space

a          Upper and lowercase letters plus space

N          Digits 0-9, uppercase letters A-Z, and space

n          Digits 0-9, upper and lowercase letters A-Z, and space

F          Valid GEMDOS filename characters plus question mark and
           asterisk

P          Valid GEMDOS pathname characters plus backslash, colon,
           question mark, and asterisk

p          Valid GEMDOS pathname characters plus backslash and colon

X          All characters



As an example the following diagram shows the correct text, template, and
validation strings for obtaining a GEMDOS filename from the user.

String     Contents

te_ptext   '\0' (NULL char)

te_ptmplt  ________.___

te_pvalid  FFFFFFFFFFF



te_font may be set to any of the following values:

Name       te_font  Meaning

GDOS_PROP  0        Use a SpeedoGDOS font (valid only with an AES version
                    of at least 4.0 and SpeedoGDOS installed).

GDOS_MONO  1        Use a SpeedoGDOS font (valid only with an AES version
                    of at least 4.1 and SpeedoGDOS installed) and force
                    monospaced output.

GDOS_BITM  2        Use a GDOS bitmap font (valid only with an AES version
                    of at least 4.1 and SpeedoGDOS installed).

IBM        3        Use the standard monospaced system font.

SMALL      5        Use the small monospaced system font.



When using a value of GDOS_PROP, GDOS_MONO, or GDOS_BITM, te_fontsize
specifies the font size in points and te_fontid specifies the SpeedoGDOS
font identification number. Selecting the IBM or SMALL font will cause
te_fontsize and te_fontid to be ignored.

te_just sets the justification of the text output as follows:

Name      te_just   Meaning

TE_LEFT      0      Left Justify

TE_RIGHT     1      Right Justify

TE_CNTR      2      Center

te_thickness sets the border thickness (positive and negative values are
acceptable) of the G_BOXTEXT or G_FBOXTEXT object. Positive te_thickness
values extend the border towards the center of the object and negative
values extend the border away from the center. te_txtlen and te_tmplen
should be set to the length of the starting text and template length
respectively.