1<sect1 id="Ascii_Sink_Object_and_Multi_Sink_Object">
2<title>Ascii Sink Object and Multi Sink Object</title>
3<para>
4<!-- .LP -->
5<!-- .XS -->
6<!-- 	AsciiSink Object -->
7<!-- .XE -->
8<indexterm significance="preferred"><primary>AsciiSink object</primary></indexterm>
9</para>
10<para>
11<!-- .LP -->
12<literallayout class="monospaced">
13<!-- .TA 2.0i -->
14<!-- .ta 2.0i -->
15Application Header file	&lt;X11/Xaw/AsciiSink.h&gt;
16<indexterm><primary>AsciiSink.h</primary></indexterm>
17Class Header file	&lt;X11/Xaw/AsciiSinkP.h&gt;
18<indexterm><primary>AsciiSinkP.h</primary></indexterm>
19Class		asciiSinkObjectClass
20<indexterm><primary>asciiSinkObjectClass</primary></indexterm>
21Class Name	AsciiSink
22<indexterm><primary>AsciiSink object</primary><secondary>class name</secondary></indexterm>
23Superclass	TextSink
24</literallayout>
25</para>
26<para>
27<!-- .LP -->
28The AsciiSink or MultiSink object is used by a text widget to render the text.
29Depending on its <function>international</function> resource, a
30AsciiText widget will create one or the other of these when the AsciiText
31itself is created.  Both types are nearly identical; the following discussion
32applies to both, with MultiSink differences noted only as they occur.
33The AsciiSink
34will display all printing characters in an 8 bit font, along with handling Tab
35and Carriage Return.  The name has been left as <quote>AsciiSink</quote> for compatibility.
36<emphasis remap='I'>The MultiSink will display all printing characters in a
37font set, along with handling Tab and Carriage Return.</emphasis>
38The source object also reports the text window metrics to the
39text widgets.
40</para>
41<sect2 id='AsciiSink::Resources'>
42<title>Resources</title>
43<para>
44<!-- .LP -->
45When creating an AsciiSink object instance, the following resources are
46retrieved from the argument list or from the resource database:
47</para>
48<para>
49<!-- .LP -->
50<indexterm><primary>AsciiSink object</primary><secondary>resources</secondary></indexterm>
51<informaltable>
52  <tgroup cols='5' align='center'>
53  <colspec colname='c1'/>
54  <colspec colname='c2'/>
55  <colspec colname='c3'/>
56  <colspec colname='c4'/>
57  <colspec colname='c5'/>
58  <thead>
59    <row>
60      <entry>Name</entry>
61      <entry>Class</entry>
62      <entry>Type</entry>
63      <entry>Notes</entry>
64      <entry>Default Value</entry>
65    </row>
66  </thead>
67  <tbody>
68    <row>
69      <entry>background</entry>
70      <entry>Background</entry>
71      <entry>Pixel</entry>
72      <entry></entry>
73      <entry>XtDefaultBackground</entry>
74    </row>
75    <row>
76      <entry>destroyCallback</entry>
77      <entry>Callback</entry>
78      <entry>XtCallbackList</entry>
79      <entry></entry>
80      <entry>NULL</entry>
81    </row>
82    <row>
83      <entry>displayNonprinting</entry>
84      <entry>Output</entry>
85      <entry>Boolean</entry>
86      <entry></entry>
87      <entry>True</entry>
88    </row>
89    <row>
90      <entry>echo</entry>
91      <entry>Output</entry>
92      <entry>Boolean</entry>
93      <entry></entry>
94      <entry>True</entry>
95    </row>
96    <row>
97      <entry>font</entry>
98      <entry>Font</entry>
99      <entry>XFontStruct*</entry>
100      <entry></entry>
101      <entry>XtDefaultFont</entry>
102    </row>
103    <row>
104      <entry>fontSet</entry>
105      <entry>FontSet</entry>
106      <entry>XFontSet</entry>
107      <entry></entry>
108      <entry>XtDefaultFontSet</entry>
109    </row>
110    <row>
111      <entry>foreground</entry>
112      <entry>Foreground</entry>
113      <entry>Pixel</entry>
114      <entry></entry>
115      <entry>XtDefaultForeground</entry>
116    </row>
117    <row>
118      <entry>_</entry>
119    </row>
120  </tbody>
121  </tgroup>
122</informaltable>
123<!-- .Bg Bold -->
124This resource is retrieved by the AsciiSink instead of being copied
125from the Text widget.
126<!-- .Dc -->
127<!-- .Sd Bold -->
128<!-- .Sh Bold -->
129</para>
130<para>
131<!-- .IP <function>font</function> 1.5i -->
132The text font to use when displaying the <function>string</function>.
133(This resource is present in the AsciiSink, but not the MultiSink.)
134<!-- .IP <function>fontSet</function> 1.5i -->
135</para>
136<para>
137The text font set to use when displaying the <function>string</function>.
138(This resource is present in the MultiSink, but not the AsciiSink.)
139</para>
140</sect2>
141</sect1>
142