Caution: This version of this document is no longer maintained. For the latest documentation, see http://www.qnx.com/developers/docs.

PgSetUnderline(), PgSetUnderlineCx()

Set colors for underlining text

Synopsis:

void PgSetUnderline( PgColor_t c1,
                     PgColor_t c2,
                     int flags );

void PgSetUnderlineCx( PhGC_t *gc,
                       PgColor_t c1,
                       PgColor_t c2,
                       int flags );

Library:

ph

Description:

These functions set the color or colors used for underlining text:

c1 c2 Underline
Pg_TRANSPARENT N/A Disabled
Any color Pg_TRANSPARENT Single underline
Any color Any color Double underline

You should find double underlining useful for scored underlining (where c2 is a shadow color) or for thick underlining (where both c1 and c2 are the same color).

No flags are currently defined.

These functions affect only the drawing operations that involve text:

PgSetUnderline() works on the current graphics context, while you can specify the graphics context gc for PgSetUnderlineCx().

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PgColor_t, PgDefaultText(), PgDrawMultiTextArea*(), PgDrawString*(), PgDrawText*(), PgDrawTextArea*(), PgExtentMultiText*(), PgExtentText(), PgSetDrawMode*(), PgSetFont*(), PgSetTextColor*(), PgSetTextDither*(), PgSetTextTransPat*(), PgSetTextXORColor*()

Drawing attributes and Text in the Raw Drawing and Animation chapter of the Photon Programmer's Guide