specs/AsciiText.xml

   1 <sect1 id="Ascii_Text_Widget">
   2 <title>Ascii Text Widget</title>
   3 <para>
   4 <!-- .LP -->
   5 <!-- .XS -->
   6 <!--    AsciiText Widget -->
   7 <!-- .XE -->
   8 <!-- .IN "AsciiText widget" "" "@DEF@" -->
   9 </para>
  10 <para>
  11 <!-- .LP -->
  12 <literallayout class="monospaced">
  13 <!-- .TA 2.0i -->
  14 <!-- .ta 2.0i -->
  15 Application Header file &lt;X11/Xaw/AsciiText.h&gt;
  16 <!-- .IN "AsciiText.h" "" -->
  17 ClassHeader file        &lt;X11/Xaw/AsciiTextP.h&gt;
  18 <!-- .IN "AsciiTextP.h" "" -->
  19 Class           asciiTextWidgetClass
  20 <!-- .IN "asciiTextWidgetClass" "" -->
  21 Class Name      Text
  22 <!-- .IN "AsciiText widget" "class name" -->
  23 Superclass      Text
  24 Sink Name       textSink
  25 Source Name     textSource
  26 </literallayout>
  27 <!-- .sp 1 -->
  28 </para>
  29 <para>
  30 <!-- .LP -->
  31 For the ease of internationalization, the AsciiText widget class name has not
  32 been changed, although it is actually able to support non-ASCII locales.
  33 The AsciiText widget is really a collection of smaller parts.  It
  34 includes the Text widget itself, a ``Source'' (which supports memory management),
  35 and a ``Sink'' (which handles the display).  There are currently two supported
  36 sources, the AsciiSrc and MultiSrc, and two supported sinks, the AsciiSink and
  37 <!-- .IN "AsciiSrc object" "" -->
  38 <!-- .IN "AsciiSink object" "" -->
  39 <!-- .IN "MultiSrc object" "" -->
  40 <!-- .IN "MultiSink object" "" -->
  41 MultiSink.  Some of
  42 the resources listed below are not actually resources of the
  43 AsciiText, but belong to the associated source or sink.  This is
  44 is noted in the explanation of each resource where it applies.  When
  45 specifying these resources in a resource file it is necessary to use
  46 <emphasis remap='I'>*AsciiText*resource_name</emphasis> instead of
  47 <emphasis remap='I'>*AsciiText.resource_name</emphasis>, since they actually belong to the
  48 children of the AsciiText widget, and not the AsciiText widget itself.
  49 However, these resources may be set directly on the AsciiText widget at
  50 widget creation time, or via <xref linkend='XtSetValues' xrefstyle='select: title'/>.
  51 </para>
  52 <sect2 id='AsciiText::Resources'>
  53 <title>Resources</title>
  54 <para>
  55 <!-- .LP -->
  56 When creating an AsciiText widget instance, the following resources are
  57 retrieved from the argument list or from the resource database:
  58 </para>
  59 <para>
  60 <!-- .LP -->
  61 <!-- .IN "AsciiText widget" "resources" -->
  62 <informaltable>
  63   <tgroup cols='5' align='center'>
  64   <colspec colname='c1'/>
  65   <colspec colname='c2'/>
  66   <colspec colname='c3'/>
  67   <colspec colname='c4'/>
  68   <colspec colname='c5'/>
  69   <thead>
  70     <row>
  71       <entry>Name</entry>
  72       <entry>Class</entry>
  73       <entry>Type</entry>
  74       <entry>Notes</entry>
  75       <entry>Default Value</entry>
  76     </row>
  77   </thead>
  78   <tbody>
  79     <row>
  80       <entry>accelerators</entry>
  81       <entry>Accelerators</entry>
  82       <entry>AcceleratorTable</entry>
  83       <entry></entry>
  84       <entry>NULL</entry>
  85     </row>
  86     <row>
  87       <entry>ancestorSensitive</entry>
  88       <entry>AncestorSensitive</entry>
  89       <entry>Boolean</entry>
  90       <entry>D</entry>
  91       <entry>True</entry>
  92     </row>
  93     <row>
  94       <entry>autoFill</entry>
  95       <entry>AutoFill</entry>
  96       <entry>Boolean</entry>
  97       <entry></entry>
  98       <entry>False</entry>
  99     </row>
 100     <row>
 101       <entry>background</entry>
 102       <entry>Background</entry>
 103       <entry>Pixel</entry>
 104       <entry></entry>
 105       <entry>XtDefaultBackground</entry>
 106     </row>
 107     <row>
 108       <entry>backgroundPixmap</entry>
 109       <entry>Pixmap</entry>
 110       <entry>Pixmap</entry>
 111       <entry></entry>
 112       <entry>XtUnspecifiedPixmap</entry>
 113     </row>
 114     <row>
 115       <entry>borderColor</entry>
 116       <entry>BorderColor</entry>
 117       <entry>Pixel</entry>
 118       <entry></entry>
 119       <entry>XtDefaultForeground</entry>
 120     </row>
 121     <row>
 122       <entry>borderPixmap</entry>
 123       <entry>Pixmap</entry>
 124       <entry>Pixmap</entry>
 125       <entry></entry>
 126       <entry>XtUnspecifiedPixmap</entry>
 127     </row>
 128     <row>
 129       <entry>borderWidth</entry>
 130       <entry>BorderWidth</entry>
 131       <entry>Dimension</entry>
 132       <entry></entry>
 133       <entry>1</entry>
 134     </row>
 135     <row>
 136       <entry>bottomMargin</entry>
 137       <entry>Margin</entry>
 138       <entry>Position</entry>
 139       <entry></entry>
 140       <entry>2</entry>
 141     </row>
 142     <row>
 143       <entry>callback</entry>
 144       <entry>Callback</entry>
 145       <entry>XtCallbackList</entry>
 146       <entry></entry>
 147       <entry>NULL</entry>
 148     </row>
 149     <row>
 150       <entry>colormap</entry>
 151       <entry>Colormap</entry>
 152       <entry>Colormap</entry>
 153       <entry></entry>
 154       <entry>Parent's Colormap</entry>
 155     </row>
 156     <row>
 157       <entry>cursor</entry>
 158       <entry>Cursor</entry>
 159       <entry>Cursor</entry>
 160       <entry></entry>
 161       <entry>XC_xterm</entry>
 162     </row>
 163     <row>
 164       <entry>cursorName</entry>
 165       <entry>Cursor</entry>
 166       <entry>String</entry>
 167       <entry></entry>
 168       <entry>NULL</entry>
 169     </row>
 170     <row>
 171       <entry>dataCompression</entry>
 172       <entry>DataCompression</entry>
 173       <entry>Boolean</entry>
 174       <entry></entry>
 175       <entry>True</entry>
 176     </row>
 177     <row>
 178       <entry>depth</entry>
 179       <entry>Depth</entry>
 180       <entry>int</entry>
 181       <entry>C</entry>
 182       <entry>Parent's Depth</entry>
 183     </row>
 184     <row>
 185       <entry>destroyCallback</entry>
 186       <entry>Callback</entry>
 187       <entry>XtCallbackList</entry>
 188       <entry></entry>
 189       <entry>NULL</entry>
 190     </row>
 191     <row>
 192       <entry>displayCaret</entry>
 193       <entry>Output</entry>
 194       <entry>Boolean</entry>
 195       <entry></entry>
 196       <entry>True</entry>
 197     </row>
 198     <row>
 199       <entry>displayNonprinting</entry>
 200       <entry>Output</entry>
 201       <entry>Boolean</entry>
 202       <entry></entry>
 203       <entry>True</entry>
 204     </row>
 205     <row>
 206       <entry>displayPosition</entry>
 207       <entry>TextPosition</entry>
 208       <entry>XawTextPosition</entry>
 209       <entry></entry>
 210       <entry>0</entry>
 211     </row>
 212     <row>
 213       <entry>echo</entry>
 214       <entry>Output</entry>
 215       <entry>Boolean</entry>
 216       <entry></entry>
 217       <entry>True</entry>
 218     </row>
 219     <row>
 220       <entry>editType</entry>
 221       <entry>EditType</entry>
 222       <entry>XawTextEditType</entry>
 223       <entry></entry>
 224       <entry>XawtextRead</entry>
 225     </row>
 226     <row>
 227       <entry>font</entry>
 228       <entry>Font</entry>
 229       <entry>XFontStruct*</entry>
 230       <entry></entry>
 231       <entry>XtDefaultFont</entry>
 232     </row>
 233     <row>
 234       <entry>fontSet</entry>
 235       <entry>FontSet</entry>
 236       <entry>XFontSet</entry>
 237       <entry></entry>
 238       <entry>XtDefaultFontSet</entry>
 239     </row>
 240     <row>
 241       <entry>foreground</entry>
 242       <entry>Foreground</entry>
 243       <entry>Pixel</entry>
 244       <entry></entry>
 245       <entry>XtDefaultForeground</entry>
 246     </row>
 247     <row>
 248       <entry>height</entry>
 249       <entry>Height</entry>
 250       <entry>Dimension</entry>
 251       <entry>A</entry>
 252       <entry>Font height + margins</entry>
 253     </row>
 254     <row>
 255       <entry>insensitiveBorder</entry>
 256       <entry>Insensitive</entry>
 257       <entry>Pixmap</entry>
 258       <entry></entry>
 259       <entry>GreyPixmap</entry>
 260     </row>
 261     <row>
 262       <entry>insertPosition</entry>
 263       <entry>TextPosition</entry>
 264       <entry>int</entry>
 265       <entry></entry>
 266       <entry>0</entry>
 267     </row>
 268     <row>
 269       <entry>international</entry>
 270       <entry>International</entry>
 271       <entry>Boolean</entry>
 272       <entry>C</entry>
 273       <entry>False</entry>
 274     </row>
 275     <row>
 276       <entry>leftMargin</entry>
 277       <entry>Margin</entry>
 278       <entry>Dimension</entry>
 279       <entry></entry>
 280       <entry>2</entry>
 281     </row>
 282     <row>
 283       <entry>length</entry>
 284       <entry>Length</entry>
 285       <entry>int</entry>
 286       <entry>A</entry>
 287       <entry>length of <function>string</function></entry>
 288     </row>
 289     <row>
 290       <entry>mappedWhenManaged</entry>
 291       <entry>MappedWhenManaged</entry>
 292       <entry>Boolean</entry>
 293       <entry></entry>
 294       <entry>True</entry>
 295     </row>
 296     <row>
 297       <entry>pieceSize</entry>
 298       <entry>PieceSize</entry>
 299       <entry>XawTextPosition</entry>
 300       <entry></entry>
 301       <entry>BUFSIZ</entry>
 302     </row>
 303     <row>
 304       <entry>pointerColor</entry>
 305       <entry>Foreground</entry>
 306       <entry>Pixel</entry>
 307       <entry></entry>
 308       <entry>XtDefaultForeground</entry>
 309     </row>
 310     <row>
 311       <entry>pointerColorBackground</entry>
 312       <entry>Background</entry>
 313       <entry>Pixel</entry>
 314       <entry></entry>
 315       <entry>XtDefaultBackground</entry>
 316     </row>
 317     <row>
 318       <entry>resize</entry>
 319       <entry>Resize</entry>
 320       <entry>XawTextResizeMode</entry>
 321       <entry></entry>
 322       <entry>XawtextResizeNever</entry>
 323     </row>
 324     <row>
 325       <entry>rightMargin</entry>
 326       <entry>Margin</entry>
 327       <entry>Position</entry>
 328       <entry></entry>
 329       <entry>2</entry>
 330     </row>
 331     <row>
 332       <entry>screen</entry>
 333       <entry>Screen</entry>
 334       <entry>Screen</entry>
 335       <entry>R</entry>
 336       <entry>Parent's Screen</entry>
 337     </row>
 338     <row>
 339       <entry>scrollHorizontal</entry>
 340       <entry>Scroll</entry>
 341       <entry>XawTextScrollMode</entry>
 342       <entry></entry>
 343       <entry>XawtextScrollNever</entry>
 344     </row>
 345     <row>
 346       <entry>scrollVertical</entry>
 347       <entry>Scroll</entry>
 348       <entry>XawTextScrollMode</entry>
 349       <entry></entry>
 350       <entry>XawtextScrollNever</entry>
 351     </row>
 352     <row>
 353       <entry>selectTypes</entry>
 354       <entry>SelectTypes</entry>
 355       <entry>XawTextSelectType*</entry>
 356       <entry></entry>
 357       <entry>See above</entry>
 358     </row>
 359     <row>
 360       <entry>sensitive</entry>
 361       <entry>Sensitive</entry>
 362       <entry>Boolean</entry>
 363       <entry></entry>
 364       <entry>True</entry>
 365     </row>
 366     <row>
 367       <entry>string</entry>
 368       <entry>String</entry>
 369       <entry>String</entry>
 370       <entry></entry>
 371       <entry>NULL</entry>
 372     </row>
 373     <row>
 374       <entry>textSink</entry>
 375       <entry>TextSink</entry>
 376       <entry>Widget</entry>
 377       <entry></entry>
 378       <entry>An AsciiSink</entry>
 379     </row>
 380     <row>
 381       <entry>textSource</entry>
 382       <entry>TextSource</entry>
 383       <entry>Widget</entry>
 384       <entry></entry>
 385       <entry>An AsciiSrc</entry>
 386     </row>
 387     <row>
 388       <entry>topMargin</entry>
 389       <entry>Margin</entry>
 390       <entry>Position</entry>
 391       <entry></entry>
 392       <entry>2</entry>
 393     </row>
 394     <row>
 395       <entry>translations</entry>
 396       <entry>Translations</entry>
 397       <entry>TranslationTable</entry>
 398       <entry></entry>
 399       <entry>See above</entry>
 400     </row>
 401     <row>
 402       <entry>type</entry>
 403       <entry>Type</entry>
 404       <entry>XawAsciiType</entry>
 405       <entry></entry>
 406       <entry>XawAsciiString</entry>
 407     </row>
 408     <row>
 409       <entry>useStringInPlace</entry>
 410       <entry>UseStringInPlace</entry>
 411       <entry>Boolean</entry>
 412       <entry></entry>
 413       <entry>False</entry>
 414     </row>
 415     <row>
 416       <entry>width</entry>
 417       <entry>Width</entry>
 418       <entry>Dimension</entry>
 419       <entry></entry>
 420       <entry>100</entry>
 421     </row>
 422     <row>
 423       <entry>wrap</entry>
 424       <entry>Wrap</entry>
 425       <entry>WrapMode</entry>
 426       <entry></entry>
 427       <entry>XawtextWrapNever</entry>
 428     </row>
 429     <row>
 430       <entry>x</entry>
 431       <entry>Position</entry>
 432       <entry>Position</entry>
 433       <entry></entry>
 434       <entry>0</entry>
 435     </row>
 436     <row>
 437       <entry>y</entry>
 438       <entry>Position</entry>
 439       <entry>Position</entry>
 440       <entry></entry>
 441       <entry>0</entry>
 442     </row>
 443   </tbody>
 444   </tgroup>
 445 </informaltable>
 446
 447
 448 </para>
 449 </sect2>
 450 </sect1>