aboutsummaryrefslogtreecommitdiff
path: root/libXaw/spec/AsciiSink
blob: 56dc20ea6e489db62d29853748dd1f565a661bd9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
.\" $Xorg: AsciiSink,v 1.3 2000/08/17 19:42:25 cpqbld Exp $
.LP
.NH 2
Ascii Sink Object and Multi Sink Object
.LP
.XS
	AsciiSink Object
.XE
.IN "AsciiSink object" "" "@DEF@"
.LP
.Ds 0
.TA 2.0i
.ta 2.0i
Application Header file	<X11/Xaw/AsciiSink.h>
.IN "AsciiSink.h" ""
Class Header file	<X11/Xaw/AsciiSinkP.h>
.IN "AsciiSinkP.h" ""
Class		asciiSinkObjectClass
.IN "asciiSinkObjectClass" ""
Class Name	AsciiSink
.IN "AsciiSink object" "class name"
Superclass	TextSink
.De
.LP
The AsciiSink or MultiSink object is used by a text widget to render the text.
Depending on its \fBinternational\fP resource, a
AsciiText widget 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 AsciiSink
will display all printing characters in an 8 bit font, along with handling Tab
and Carriage Return.  The name has been left as ``AsciiSink'' for compatibility.
\fIThe MultiSink will display all printing characters in a font set, along with
handling Tab and Carriage
Return.\fP    The source object also reports the text window metrics to the
text widgets.
.NH 3
Resources
.LP
When creating an AsciiSink object instance, the following resources are
retrieved from the argument list or from the resource database:
.LP
.IN "AsciiSink object" "resources"
.TS H
lw(1i) lw(1i) lw(1i) lw(.5i) lw(2i).
_
.sp 3p
.TB
Name	Class	Type	Notes	Default Value
.sp 3p
_
.TH
.R
.sp 3p
background	Background	Pixel		XtDefaultBackground
destroyCallback	Callback	XtCallbackList		NULL
displayNonprinting	Output	Boolean		True
echo	Output	Boolean		True
font	Font	XFontStruct*		XtDefaultFont
fontSet	FontSet	XFontSet		XtDefaultFontSet
foreground	Foreground	Pixel		XtDefaultForeground
.sp 3p
_
.TE
.Bg Bold
This resource is retrieved by the AsciiSink instead of being copied
from the Text widget.
.Dc
.Sd Bold
.Sh Bold
.IP \fBfont\fP 1.5i
The text font to use when displaying the \fBstring\fP.
(This resource is present in the AsciiSink, but not the MultiSink.)
.IP \fBfontSet\fP 1.5i
The text font set to use when displaying the \fBstring\fP.
(This resource is present in the MultiSink, but not the AsciiSink.)