| Application Header file | <X11/XawPlus/AsciiSink.h> or <X11/XawPlus/MultiSink.h> |
| Class Header file | <X11/XawPlus/AsciiSinkP.h> or <X11/XawPlus/MultiSinkP.h> |
| Class | asciiSinkObjectClass or multiSinkObjectClass |
| Class Name | AsciiSink or MultiSink |
| Superclass | TextSink |
The AsciiSink or MultiSink object is used by a text widget to render the text. Depending on its international resource, a AsciiText will create one or the other of these when the AsciiText itself is created. Both types are nearly identical; the following discussion applies to both, with MultiSink differences noted only as they occur.
The AsciiText will display all characters in an 8 bit font, along with handling Tab and Carriage Return. The name has left as AsciiSink for compatibility. The MultiSink will display all printing characters in a font set, along with handling Tab and Carriage Return. These objects also reports the text window metrics to the text widgets.
The background color is changed from XtDefaultBackground to grey75.
When creating a AsciiSink or MultiSink object instance, the following resources are retrieved from the argument list of XtSetValues() or XtVaSetValues() or from the resource database:
| Name | Class | Type | Default Value |
| OBJECT: | |||
| destroyCallback | Callback | Pointer | NULL |
| TEXTSINK OBJECT: | |||
| foreground background |
Foreground Background |
Pixel Pixel |
XtDefaultForeground grey75 |
| ASCIISINK OBJECT: | |||
| font fontSet echo displayNonprinting |
Font FontSet Output Output |
XFontStruct * XFontSet Boolean Boolean |
XtDefaultFont XtDefaultFontSet True True |
| font | Only in AsciiSink: The text font to use when displaying the string. |
| fontSet | Only in MultiSink: The text font set to use when displaying the string. |
| echo | Whether or not to echo characters to the screen. The buffer can still be edited but nothing is displayed. This mode is useful for entering passwords or other sensitive information. |
| displayNonprinting | If this resource is True, the Sink object will display all non-printable characters as the string ^@. Otherwise the Sink object will just leave a blank space. |