specs/Text.xml

   1 <sect1 id='Text_Widget'>
   2 <title>Text Widget</title>
   3
   4 <literallayout class="monospaced">
   5 Application Header file     &lt;X11/Xaw/Text.h&gt;
   6 Class Header file           &lt;X11/Xaw/TextP.h&gt;
   7 Class                       textWidgetClass
   8 Class Name                  Text
   9 Superclass                  Simple
  10 </literallayout>
  11
  12
  13 <para>
  14 The Text widget is the glue that binds all the other pieces together, it
  15 maintains the internal state of the displayed text, and acts as a
  16 mediator between the source and sink.
  17 </para>
  18
  19 <para>
  20 This section lists the resources that are actually part of the
  21 Text widget, and explains the functionality provided by each.
  22 </para>
  23 <sect2 id='Text::Resources'>
  24 <title>Resources</title>
  25
  26 <para>
  27 When creating a Text widget instance, the following resources are
  28 retrieved from the argument list or from the resource database:
  29 </para>
  30
  31 <informaltable>
  32   <tgroup cols='5' align='center'>
  33   <colspec colname='c1'/>
  34   <colspec colname='c2'/>
  35   <colspec colname='c3'/>
  36   <colspec colname='c4'/>
  37   <colspec colname='c5'/>
  38   <thead>
  39     <row>
  40       <entry>Name</entry>
  41       <entry>Class</entry>
  42       <entry>Type</entry>
  43       <entry>Notes</entry>
  44       <entry>Default Value</entry>
  45     </row>
  46   </thead>
  47   <tbody>
  48     <row>
  49       <entry>accelerators</entry>
  50       <entry>Accelerators</entry>
  51       <entry>AcceleratorTable</entry>
  52       <entry></entry>
  53       <entry>NULL</entry>
  54     </row>
  55     <row>
  56       <entry>ancestorSensitive</entry>
  57       <entry>AncestorSensitive</entry>
  58       <entry>Boolean</entry>
  59       <entry>D</entry>
  60       <entry>True</entry>
  61     </row>
  62     <row>
  63       <entry>autoFill</entry>
  64       <entry>AutoFill</entry>
  65       <entry>Boolean</entry>
  66       <entry></entry>
  67       <entry>False</entry>
  68     </row>
  69     <row>
  70       <entry>background</entry>
  71       <entry>Background</entry>
  72       <entry>Pixel</entry>
  73       <entry></entry>
  74       <entry>XtDefaultBackground</entry>
  75     </row>
  76     <row>
  77       <entry>backgroundPixmap</entry>
  78       <entry>Pixmap</entry>
  79       <entry>Pixmap</entry>
  80       <entry></entry>
  81       <entry>XtUnspecifiedPixmap</entry>
  82     </row>
  83     <row>
  84       <entry>borderColor</entry>
  85       <entry>BorderColor</entry>
  86       <entry>Pixel</entry>
  87       <entry></entry>
  88       <entry>XtDefaultForeground</entry>
  89     </row>
  90     <row>
  91       <entry>borderPixmap</entry>
  92       <entry>Pixmap</entry>
  93       <entry>Pixmap</entry>
  94       <entry></entry>
  95       <entry>XtUnspecifiedPixmap</entry>
  96     </row>
  97     <row>
  98       <entry>borderWidth</entry>
  99       <entry>BorderWidth</entry>
 100       <entry>Dimension</entry>
 101       <entry></entry>
 102       <entry>1</entry>
 103     </row>
 104     <row>
 105       <entry>bottomMargin</entry>
 106       <entry>Margin</entry>
 107       <entry>Position</entry>
 108       <entry></entry>
 109       <entry>2</entry>
 110     </row>
 111     <row>
 112       <entry>colormap</entry>
 113       <entry>Colormap</entry>
 114       <entry>Colormap</entry>
 115       <entry></entry>
 116       <entry>Parent's Colormap</entry>
 117     </row>
 118     <row>
 119       <entry>cursor</entry>
 120       <entry>Cursor</entry>
 121       <entry>Cursor</entry>
 122       <entry></entry>
 123       <entry>XC_xterm</entry>
 124     </row>
 125     <row>
 126       <entry>cursorName</entry>
 127       <entry>Cursor</entry>
 128       <entry>String</entry>
 129       <entry></entry>
 130       <entry>NULL</entry>
 131     </row>
 132     <row>
 133       <entry>depth</entry>
 134       <entry>Depth</entry>
 135       <entry>int</entry>
 136       <entry>C</entry>
 137       <entry>Parent's Depth</entry>
 138     </row>
 139     <row>
 140       <entry>destroyCallback</entry>
 141       <entry>Callback</entry>
 142       <entry>XtCallbackList</entry>
 143       <entry></entry>
 144       <entry>NULL</entry>
 145     </row>
 146     <row>
 147       <entry>displayCaret</entry>
 148       <entry>Output</entry>
 149       <entry>Boolean</entry>
 150       <entry></entry>
 151       <entry>True</entry>
 152     </row>
 153     <row>
 154       <entry>displayPosition</entry>
 155       <entry>TextPosition</entry>
 156       <entry>XawTextPosition</entry>
 157       <entry></entry>
 158       <entry>0</entry>
 159     </row>
 160     <row>
 161       <entry>height</entry>
 162       <entry>Height</entry>
 163       <entry>Dimension</entry>
 164       <entry>A</entry>
 165       <entry>Font height + margins</entry>
 166     </row>
 167     <row>
 168       <entry>insensitiveBorder</entry>
 169       <entry>Insensitive</entry>
 170       <entry>Pixmap</entry>
 171       <entry></entry>
 172       <entry>GreyPixmap</entry>
 173     </row>
 174     <row>
 175       <entry>insertPosition</entry>
 176       <entry>TextPosition</entry>
 177       <entry>int</entry>
 178       <entry></entry>
 179       <entry>0</entry>
 180     </row>
 181     <row>
 182       <entry>leftMargin</entry>
 183       <entry>Margin</entry>
 184       <entry>Position</entry>
 185       <entry></entry>
 186       <entry>2</entry>
 187     </row>
 188     <row>
 189       <entry>mappedWhenManaged</entry>
 190       <entry>MappedWhenManaged</entry>
 191       <entry>Boolean</entry>
 192       <entry></entry>
 193       <entry>True</entry>
 194     </row>
 195     <row>
 196       <entry>pointerColor</entry>
 197       <entry>Foreground</entry>
 198       <entry>Pixel</entry>
 199       <entry></entry>
 200       <entry>XtDefaultForeground</entry>
 201     </row>
 202     <row>
 203       <entry>pointerColorBackground</entry>
 204       <entry>Background</entry>
 205       <entry>Pixel</entry>
 206       <entry></entry>
 207       <entry>XtDefaultBackground</entry>
 208     </row>
 209     <row>
 210       <entry>resize</entry>
 211       <entry>Resize</entry>
 212       <entry>XawTextResizeMode</entry>
 213       <entry></entry>
 214       <entry>XawtextResizeNever</entry>
 215     </row>
 216     <row>
 217       <entry>rightMargin</entry>
 218       <entry>Margin</entry>
 219       <entry>Position</entry>
 220       <entry></entry>
 221       <entry>4</entry>
 222     </row>
 223     <row>
 224       <entry>screen</entry>
 225       <entry>Screen</entry>
 226       <entry>Pointer</entry>
 227       <entry>R</entry>
 228       <entry>Parent's Screen</entry>
 229     </row>
 230     <row>
 231       <entry>scrollHorizontal</entry>
 232       <entry>Scroll</entry>
 233       <entry>ScrollMode</entry>
 234       <entry></entry>
 235       <entry>XawtextScrollNever</entry>
 236     </row>
 237     <row>
 238       <entry>scrollVertical</entry>
 239       <entry>Scroll</entry>
 240       <entry>XawTextScrollMode</entry>
 241       <entry></entry>
 242       <entry>XawtextScrollNever</entry>
 243     </row>
 244     <row>
 245       <entry>selectTypes</entry>
 246       <entry>SelectTypes</entry>
 247       <entry>XawTextSelectType*</entry>
 248       <entry></entry>
 249       <entry>See above</entry>
 250     </row>
 251     <row>
 252       <entry>sensitive</entry>
 253       <entry>Sensitive</entry>
 254       <entry>Boolean</entry>
 255       <entry></entry>
 256       <entry>True</entry>
 257     </row>
 258     <row>
 259       <entry>textSink</entry>
 260       <entry>TextSink</entry>
 261       <entry>Widget</entry>
 262       <entry></entry>
 263       <entry>NULL</entry>
 264     </row>
 265     <row>
 266       <entry>textSource</entry>
 267       <entry>TextSource</entry>
 268       <entry>Widget</entry>
 269       <entry></entry>
 270       <entry>NULL</entry>
 271     </row>
 272     <row>
 273       <entry>topMargin</entry>
 274       <entry>Margin</entry>
 275       <entry>Position</entry>
 276       <entry></entry>
 277       <entry>2</entry>
 278     </row>
 279     <row>
 280       <entry>translations</entry>
 281       <entry>Translations</entry>
 282       <entry>TranslationTable</entry>
 283       <entry></entry>
 284       <entry>See above</entry>
 285     </row>
 286     <row>
 287       <entry>unrealizeCallback</entry>
 288       <entry>Callback</entry>
 289       <entry>XtCallbackList</entry>
 290       <entry></entry>
 291       <entry>NULL</entry>
 292     </row>
 293     <row>
 294       <entry>width</entry>
 295       <entry>Width</entry>
 296       <entry>Dimension</entry>
 297       <entry></entry>
 298       <entry>100</entry>
 299     </row>
 300     <row>
 301       <entry>wrap</entry>
 302       <entry>Wrap</entry>
 303       <entry>WrapMode</entry>
 304       <entry></entry>
 305       <entry>XawtextWrapNever</entry>
 306     </row>
 307     <row>
 308       <entry>x</entry>
 309       <entry>Position</entry>
 310       <entry>Position</entry>
 311       <entry></entry>
 312       <entry>0</entry>
 313     </row>
 314     <row>
 315       <entry>y</entry>
 316       <entry>Position</entry>
 317       <entry>Position</entry>
 318       <entry></entry>
 319       <entry>0</entry>
 320     </row>
 321   </tbody>
 322   </tgroup>
 323 </informaltable>
 324
 325 </sect2>
 326 </sect1>