xenocara/lib/libXaw/specs/Text.xml
2012-04-08 14:59:44 +00:00

327 lines
7.6 KiB
XML

<sect1 id='Text_Widget'>
<title>Text Widget</title>
<literallayout class="monospaced">
Application Header file &lt;X11/Xaw/Text.h&gt;
Class Header file &lt;X11/Xaw/TextP.h&gt;
Class textWidgetClass
Class Name Text
Superclass Simple
</literallayout>
<para>
The Text widget is the glue that binds all the other pieces together, it
maintains the internal state of the displayed text, and acts as a
mediator between the source and sink.
</para>
<para>
This section lists the resources that are actually part of the
Text widget, and explains the functionality provided by each.
</para>
<sect2 id='Text::Resources'>
<title>Resources</title>
<para>
When creating a Text widget instance, the following resources are
retrieved from the argument list or from the resource database:
</para>
<informaltable>
<tgroup cols='5' align='center'>
<colspec colname='c1'/>
<colspec colname='c2'/>
<colspec colname='c3'/>
<colspec colname='c4'/>
<colspec colname='c5'/>
<thead>
<row>
<entry>Name</entry>
<entry>Class</entry>
<entry>Type</entry>
<entry>Notes</entry>
<entry>Default Value</entry>
</row>
</thead>
<tbody>
<row>
<entry>accelerators</entry>
<entry>Accelerators</entry>
<entry>AcceleratorTable</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>ancestorSensitive</entry>
<entry>AncestorSensitive</entry>
<entry>Boolean</entry>
<entry>D</entry>
<entry>True</entry>
</row>
<row>
<entry>autoFill</entry>
<entry>AutoFill</entry>
<entry>Boolean</entry>
<entry></entry>
<entry>False</entry>
</row>
<row>
<entry>background</entry>
<entry>Background</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultBackground</entry>
</row>
<row>
<entry>backgroundPixmap</entry>
<entry>Pixmap</entry>
<entry>Pixmap</entry>
<entry></entry>
<entry>XtUnspecifiedPixmap</entry>
</row>
<row>
<entry>borderColor</entry>
<entry>BorderColor</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultForeground</entry>
</row>
<row>
<entry>borderPixmap</entry>
<entry>Pixmap</entry>
<entry>Pixmap</entry>
<entry></entry>
<entry>XtUnspecifiedPixmap</entry>
</row>
<row>
<entry>borderWidth</entry>
<entry>BorderWidth</entry>
<entry>Dimension</entry>
<entry></entry>
<entry>1</entry>
</row>
<row>
<entry>bottomMargin</entry>
<entry>Margin</entry>
<entry>Position</entry>
<entry></entry>
<entry>2</entry>
</row>
<row>
<entry>colormap</entry>
<entry>Colormap</entry>
<entry>Colormap</entry>
<entry></entry>
<entry>Parent's Colormap</entry>
</row>
<row>
<entry>cursor</entry>
<entry>Cursor</entry>
<entry>Cursor</entry>
<entry></entry>
<entry>XC_xterm</entry>
</row>
<row>
<entry>cursorName</entry>
<entry>Cursor</entry>
<entry>String</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>depth</entry>
<entry>Depth</entry>
<entry>int</entry>
<entry>C</entry>
<entry>Parent's Depth</entry>
</row>
<row>
<entry>destroyCallback</entry>
<entry>Callback</entry>
<entry>XtCallbackList</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>displayCaret</entry>
<entry>Output</entry>
<entry>Boolean</entry>
<entry></entry>
<entry>True</entry>
</row>
<row>
<entry>displayPosition</entry>
<entry>TextPosition</entry>
<entry>XawTextPosition</entry>
<entry></entry>
<entry>0</entry>
</row>
<row>
<entry>height</entry>
<entry>Height</entry>
<entry>Dimension</entry>
<entry>A</entry>
<entry>Font height + margins</entry>
</row>
<row>
<entry>insensitiveBorder</entry>
<entry>Insensitive</entry>
<entry>Pixmap</entry>
<entry></entry>
<entry>GreyPixmap</entry>
</row>
<row>
<entry>insertPosition</entry>
<entry>TextPosition</entry>
<entry>int</entry>
<entry></entry>
<entry>0</entry>
</row>
<row>
<entry>leftMargin</entry>
<entry>Margin</entry>
<entry>Position</entry>
<entry></entry>
<entry>2</entry>
</row>
<row>
<entry>mappedWhenManaged</entry>
<entry>MappedWhenManaged</entry>
<entry>Boolean</entry>
<entry></entry>
<entry>True</entry>
</row>
<row>
<entry>pointerColor</entry>
<entry>Foreground</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultForeground</entry>
</row>
<row>
<entry>pointerColorBackground</entry>
<entry>Background</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultBackground</entry>
</row>
<row>
<entry>resize</entry>
<entry>Resize</entry>
<entry>XawTextResizeMode</entry>
<entry></entry>
<entry>XawtextResizeNever</entry>
</row>
<row>
<entry>rightMargin</entry>
<entry>Margin</entry>
<entry>Position</entry>
<entry></entry>
<entry>4</entry>
</row>
<row>
<entry>screen</entry>
<entry>Screen</entry>
<entry>Pointer</entry>
<entry>R</entry>
<entry>Parent's Screen</entry>
</row>
<row>
<entry>scrollHorizontal</entry>
<entry>Scroll</entry>
<entry>ScrollMode</entry>
<entry></entry>
<entry>XawtextScrollNever</entry>
</row>
<row>
<entry>scrollVertical</entry>
<entry>Scroll</entry>
<entry>XawTextScrollMode</entry>
<entry></entry>
<entry>XawtextScrollNever</entry>
</row>
<row>
<entry>selectTypes</entry>
<entry>SelectTypes</entry>
<entry>XawTextSelectType*</entry>
<entry></entry>
<entry>See above</entry>
</row>
<row>
<entry>sensitive</entry>
<entry>Sensitive</entry>
<entry>Boolean</entry>
<entry></entry>
<entry>True</entry>
</row>
<row>
<entry>textSink</entry>
<entry>TextSink</entry>
<entry>Widget</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>textSource</entry>
<entry>TextSource</entry>
<entry>Widget</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>topMargin</entry>
<entry>Margin</entry>
<entry>Position</entry>
<entry></entry>
<entry>2</entry>
</row>
<row>
<entry>translations</entry>
<entry>Translations</entry>
<entry>TranslationTable</entry>
<entry></entry>
<entry>See above</entry>
</row>
<row>
<entry>unrealizeCallback</entry>
<entry>Callback</entry>
<entry>XtCallbackList</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>width</entry>
<entry>Width</entry>
<entry>Dimension</entry>
<entry></entry>
<entry>100</entry>
</row>
<row>
<entry>wrap</entry>
<entry>Wrap</entry>
<entry>WrapMode</entry>
<entry></entry>
<entry>XawtextWrapNever</entry>
</row>
<row>
<entry>x</entry>
<entry>Position</entry>
<entry>Position</entry>
<entry></entry>
<entry>0</entry>
</row>
<row>
<entry>y</entry>
<entry>Position</entry>
<entry>Position</entry>
<entry></entry>
<entry>0</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
</sect1>