diff options
Diffstat (limited to 'libXaw/specs/TextCustom.xml')
-rw-r--r-- | libXaw/specs/TextCustom.xml | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/libXaw/specs/TextCustom.xml b/libXaw/specs/TextCustom.xml new file mode 100644 index 000000000..7ca2d5f78 --- /dev/null +++ b/libXaw/specs/TextCustom.xml @@ -0,0 +1,123 @@ +<sect1 id="Customizing_the_Text_Widget"> +<title>Customizing the Text Widget</title> +<para> +<!-- .LP --> +<!-- .XS --> +<!-- Customizing the Text Widget --> +<!-- .XE --> +<!-- .IN "Text widget" "customizing" "@DEF@" --> +</para> +<para> +<!-- .LP --> +The remainder of this chapter will describe customizing the Text +widget. The Text widget may be customized by subclassing, or by +creating new sources and sinks. Subclassing is described in +detail in Chapter 7; this section will describe only those things that +are specific to the Text widget. Attributes of the Text widget base +class and creating new sources and sinks will be discussed. +</para> +<para> +<!-- .LP --> +The Text widget is made up of a number of different pieces, with the +Text widget as the base widget class. It and the AsciiText widget are +the only true "widgets" in the Text widget family. The other pieces +(sources and sinks) are X Toolkit objects and have no window +associated with them. No source or sink is useful unless assigned to +a Text widget. +</para> +<para> +<!-- .LP --> +Each of the following pieces of the Text widget has a specific purpose, +and will be, or has been, discussed in detail in this chapter: +<!-- .IN "Text widget" "" --> +</para> +<para> +<variablelist> + <varlistentry> + <term><function>Text</function></term> + <listitem> + <para> +This is the glue that binds everything else together. This widget reads +the text data from the source, and displays the information in the sink. +All translations and actions are handled in the Text widget itself. + </para> + </listitem> + </varlistentry> +<!-- .IN "TextSink object" "" --> + <varlistentry> + <term><function>TextSink</function></term> + <listitem> + <para> +This object is responsible for displaying and clearing the drawing area. +It also reports the configuration of the window that contains the +drawing area. The TextSink does not have its own window; instead it does +its drawing on the Text widget's window. + </para> + </listitem> + </varlistentry> +<!-- .IN "TextSrc object" "" --> + <varlistentry> + <term><function>TextSrc</function></term> + <listitem> + <para> +This object is responsible for reading, editing and searching through the +text buffer. + </para> + </listitem> + </varlistentry> +<!-- .IN "AsciiSink object" "" --> + <varlistentry> + <term><function>AsciiSink</function></term> + <listitem> + <para> +This object is a subclass of the TextSink and knows how to display +ASCII text. Support has been added to display any 8-bit character set, given +the font. + </para> + </listitem> + </varlistentry> +<!-- .IN "MultiSink object" "" --> + <varlistentry> + <term><function>MultiSink</function></term> + <listitem> + <para> +This object is a subclass of the TextSink and knows how to display +font sets. + </para> + </listitem> + </varlistentry> +<!-- .IN "AsciiSrc object" "" --> + <varlistentry> + <term><function>AsciiSrc</function></term> + <listitem> + <para> +This object is a subclass of the TextSrc and knows how to read strings +and files. + </para> + </listitem> + </varlistentry> +<!-- .IN "MultiSrc object" "" --> + <varlistentry> + <term><function>MultiSrc</function></term> + <listitem> + <para> +This object is a subclass of the TextSrc and knows how to read strings +and multibyte files, converting them to wide characters based on locale. + </para> + </listitem> + </varlistentry> +<!-- .IN "AsciiText widget" "" --> + <varlistentry> + <term><function>AsciiText</function></term> + <listitem> + <para> +This widget is a subclass of the Text widget. When created, the AsciiText +automatically creates and attaches either an AsciiSrc and AsciiSink, or a +MultiSrc and MultiSink, to itself. The AsciiText provides the simplest +interface to the Athena Text widgets. + </para> + </listitem> + </varlistentry> +</variablelist> +</para> +</sect1> |