diff options
| author | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2021-08-09 17:51:46 +0000 |
|---|---|---|
| committer | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2021-08-09 17:51:46 +0000 |
| commit | 12450a96cc8ed9d0442062cc77a69aaefe98f3f5 (patch) | |
| tree | 46168cb038fff76345cc1af67afd7f65157ce5a4 /lib/libXaw/specs | |
| parent | 32207585e8391a525723e468eff64411b1dcd62b (diff) | |
Update to libXaw 1.0.14
Diffstat (limited to 'lib/libXaw/specs')
47 files changed, 956 insertions, 958 deletions
diff --git a/lib/libXaw/specs/AsciiSink.xml b/lib/libXaw/specs/AsciiSink.xml index aba588b6c..88a4343f8 100644 --- a/lib/libXaw/specs/AsciiSink.xml +++ b/lib/libXaw/specs/AsciiSink.xml @@ -5,7 +5,7 @@ <!-- .XS --> <!-- AsciiSink Object --> <!-- .XE --> -<!-- .IN "AsciiSink object" "" "@DEF@" --> +<indexterm significance="preferred"><primary>AsciiSink object</primary></indexterm> </para> <para> <!-- .LP --> @@ -13,13 +13,13 @@ <!-- .TA 2.0i --> <!-- .ta 2.0i --> Application Header file <X11/Xaw/AsciiSink.h> -<!-- .IN "AsciiSink.h" "" --> +<indexterm><primary>AsciiSink.h</primary></indexterm> Class Header file <X11/Xaw/AsciiSinkP.h> -<!-- .IN "AsciiSinkP.h" "" --> +<indexterm><primary>AsciiSinkP.h</primary></indexterm> Class asciiSinkObjectClass -<!-- .IN "asciiSinkObjectClass" "" --> +<indexterm><primary>asciiSinkObjectClass</primary></indexterm> Class Name AsciiSink -<!-- .IN "AsciiSink object" "class name" --> +<indexterm><primary>AsciiSink object</primary><secondary>class name</secondary></indexterm> Superclass TextSink </literallayout> </para> @@ -32,10 +32,10 @@ itself is created. Both types are nearly identical; the following discussion applies to both, with MultiSink differences noted only as they occur. The AsciiSink will display all printing characters in an 8 bit font, along with handling Tab -and Carriage Return. The name has been left as ``AsciiSink'' for compatibility. -\fIThe MultiSink will display all printing characters in a font set, along with -handling Tab and Carriage -Return.\fP The source object also reports the text window metrics to the +and Carriage Return. The name has been left as <quote>AsciiSink</quote> for compatibility. +<emphasis remap='I'>The MultiSink will display all printing characters in a +font set, along with handling Tab and Carriage Return.</emphasis> +The source object also reports the text window metrics to the text widgets. </para> <sect2 id='AsciiSink::Resources'> @@ -47,7 +47,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "AsciiSink object" "resources" --> +<indexterm><primary>AsciiSink object</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> diff --git a/lib/libXaw/specs/AsciiSource.xml b/lib/libXaw/specs/AsciiSource.xml index b3ca6da12..89628c58a 100644 --- a/lib/libXaw/specs/AsciiSource.xml +++ b/lib/libXaw/specs/AsciiSource.xml @@ -5,7 +5,7 @@ <!-- .XS --> <!-- AsciiSrc Object --> <!-- .XE --> -<!-- .IN "AsciiSrc object" "" "@DEF@" --> +<indexterm significance="preferred"><primary>AsciiSrc object</primary></indexterm> </para> <para> <!-- .LP --> @@ -13,13 +13,13 @@ <!-- .TA 2.0i --> <!-- .ta 2.0i --> Application Header file <X11/Xaw/AsciiSrc.h> or <X11/Xaw/MultiSrc.h> -<!-- .IN "AsciiSrc.h" "" --> +<indexterm><primary>AsciiSrc.h</primary></indexterm> Class Header file <X11/Xaw/AsciiSrcP.h> or <X11/Xaw/MultiSrcP.h> -<!-- .IN "AsciiSrcP.h" "" --> +<indexterm><primary>AsciiSrcP.h</primary></indexterm> Class asciiSrcObjectClass or multiSrcObjectClass -<!-- .IN "asciiSrcObjectClass" "" --> +<indexterm><primary>asciiSrcObjectClass</primary></indexterm> Class Name AsciiSrc or MultiSrc -<!-- .IN "AsciiSrc object" "class name" --> +<indexterm><primary>AsciiSrc object</primary><secondary>class name</secondary></indexterm> Superclass TextSource </literallayout> </para> @@ -33,9 +33,9 @@ applies to both, with MultiSrc differences noted only as they occur. </para> <para> <!-- .LP --> -The AsciiSrc understands all Latin1 characters plus Tab -and Carriage Return. \fIThe MultiSrc understands any set of character sets that -the underlying X implementation's internationalization handles.\fP +The AsciiSrc understands all Latin1 characters plus Tab and Carriage Return. +<emphasis remap='I'>The MultiSrc understands any set of character sets that +the underlying X implementation's internationalization handles.</emphasis> </para> <para> <!-- .LP --> @@ -57,8 +57,8 @@ source is in this mode the <function>useStringInPlace</function> resource is ign <!-- .LP --> AsciiSrc objects of type <function>XawAsciiString</function> have the text buffer implemented as a string. -\fIMultiSrc objects of type <function>XawAsciiString</function> have the text buffer -implemented as a wide character string.\fP +<emphasis remap='I'>MultiSrc objects of type <function>XawAsciiString</function> +have the text buffer implemented as a wide character string.</emphasis> The string owner is responsible for allocating and managing storage for the string. </para> @@ -108,7 +108,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "AsciiSrc object" "resources" --> +<indexterm><primary>AsciiSrc object</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -333,7 +333,7 @@ This function returns <function>True</function> if the save was successful. <!-- .LP --> To find out if the text buffer in an AsciiSrc object has changed since the last time it was saved with <xref linkend='XawAsciiSave' xrefstyle='select: title'/> or queried -<!-- .IN "XawAsciiSave" "" --> +<indexterm><primary>XawAsciiSave</primary></indexterm> use <xref linkend='XawAsciiSourceChanged' xrefstyle='select: title'/>. <funcsynopsis id='XawAsciiSourceChanged'> <funcprototype> diff --git a/lib/libXaw/specs/AsciiText.xml b/lib/libXaw/specs/AsciiText.xml index 156e0c029..8dec8c2e2 100644 --- a/lib/libXaw/specs/AsciiText.xml +++ b/lib/libXaw/specs/AsciiText.xml @@ -5,7 +5,7 @@ <!-- .XS --> <!-- AsciiText Widget --> <!-- .XE --> -<!-- .IN "AsciiText widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>AsciiText widget</primary></indexterm> </para> <para> <!-- .LP --> @@ -13,13 +13,13 @@ <!-- .TA 2.0i --> <!-- .ta 2.0i --> Application Header file <X11/Xaw/AsciiText.h> -<!-- .IN "AsciiText.h" "" --> +<indexterm><primary>AsciiText.h</primary></indexterm> ClassHeader file <X11/Xaw/AsciiTextP.h> -<!-- .IN "AsciiTextP.h" "" --> +<indexterm><primary>AsciiTextP.h</primary></indexterm> Class asciiTextWidgetClass -<!-- .IN "asciiTextWidgetClass" "" --> +<indexterm><primary>asciiTextWidgetClass</primary></indexterm> Class Name Text -<!-- .IN "AsciiText widget" "class name" --> +<indexterm><primary>AsciiText widget</primary><secondary>class name</secondary></indexterm> Superclass Text Sink Name textSink Source Name textSource @@ -31,13 +31,13 @@ Source Name textSource For the ease of internationalization, the AsciiText widget class name has not been changed, although it is actually able to support non-ASCII locales. The AsciiText widget is really a collection of smaller parts. It -includes the Text widget itself, a ``Source'' (which supports memory management), -and a ``Sink'' (which handles the display). There are currently two supported +includes the Text widget itself, a <quote>Source</quote> (which supports memory management), +and a <quote>Sink</quote> (which handles the display). There are currently two supported sources, the AsciiSrc and MultiSrc, and two supported sinks, the AsciiSink and -<!-- .IN "AsciiSrc object" "" --> -<!-- .IN "AsciiSink object" "" --> -<!-- .IN "MultiSrc object" "" --> -<!-- .IN "MultiSink object" "" --> +<indexterm><primary>AsciiSrc object</primary></indexterm> +<indexterm><primary>AsciiSink object</primary></indexterm> +<indexterm><primary>MultiSrc object</primary></indexterm> +<indexterm><primary>MultiSink object</primary></indexterm> MultiSink. Some of the resources listed below are not actually resources of the AsciiText, but belong to the associated source or sink. This is @@ -58,7 +58,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "AsciiText widget" "resources" --> +<indexterm><primary>AsciiText widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> diff --git a/lib/libXaw/specs/Box.xml b/lib/libXaw/specs/Box.xml index 692d7d236..9796c9957 100644 --- a/lib/libXaw/specs/Box.xml +++ b/lib/libXaw/specs/Box.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- Box Widget --> <!-- .XE --> -<!-- .IN "Box widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Box widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application Header file <X11/Xaw/Box.h> -<!-- .IN "Box.h" "" --> +<indexterm><primary>Box.h</primary></indexterm> Class Header file <X11/Xaw/BoxP.h> -<!-- .IN "BoxP.h" "" --> +<indexterm><primary>BoxP.h</primary></indexterm> Class boxWidgetClass -<!-- .IN "boxWidgetClass" "" --> +<indexterm><primary>boxWidgetClass</primary></indexterm> Class Name Box -<!-- .IN "Box widget" "class name" --> +<indexterm><primary>Box widget</primary><secondary>class name</secondary></indexterm> Superclass Composite <!-- .sp --> </literallayout> @@ -47,7 +47,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Box widget" "resources" --> +<indexterm><primary>Box widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -279,9 +279,9 @@ children and the edge of the box. Specifies whether the preferred shape of the box (i.e. the result returned by the query_geometry class method) is tall and narrow <function>XtorientVertical</function> or short and wide <function>XtorientHorizontal</function>. -<!-- .IN "XtorientVertical" "" --> -<!-- .IN "XtorientHorizontal" "" --> -<!-- .IN "conversions" "Orientation" --> +<indexterm><primary>XtorientVertical</primary></indexterm> +<indexterm><primary>XtorientHorizontal</primary></indexterm> +<indexterm><primary>conversions</primary><secondary>Orientation</secondary></indexterm> When the Box is a child of a parent which enforces width constraints, it is usually better to specify <function>XtorientVertical</function> (the default). When the parent enforces height constraints, it is usually better to @@ -299,7 +299,7 @@ specify <function>XtorientHorizontal</function>. </sect2> <sect2 id="Layout_Semantics"> <title>Layout Semantics</title> -<!-- .IN "Box widget" "layout semantics" --> +<indexterm><primary>Box widget</primary><secondary>layout semantics</secondary></indexterm> <para> <!-- .LP --> Each time a child is managed or unmanaged, the Box widget will attempt @@ -313,7 +313,7 @@ algorithm used depends on the <function>orientation</function> of the Box. </term> <listitem> <para> -<!-- .IN "XtorientVertical" "" @DEF@ --> +<indexterm significance="preferred"><primary>XtorientVertical</primary></indexterm> When the next child does not fit on the current row, a new row is started. If a child is wider than the width of the box, the box will request a larger width from its parent and will begin the layout @@ -327,7 +327,7 @@ process from the beginning if a new width is granted. </term> <listitem> <para> -<!-- .IN "XtorientHorizontal" "" @DEF@ --> +<indexterm significance="preferred"><primary>XtorientHorizontal</primary></indexterm> When the next child does not fit on the current row, the Box widens if possible (so as to keep children on a single row); otherwise a new row is started. diff --git a/lib/libXaw/specs/CH1.xml b/lib/libXaw/specs/CH1.xml index 8d913b8a7..38065d9e2 100644 --- a/lib/libXaw/specs/CH1.xml +++ b/lib/libXaw/specs/CH1.xml @@ -13,7 +13,8 @@ sets it may be possible to use widgets from the Athena widget set with other widget sets based upon the Intrinsics. Since widget sets may also implement private protocols, all functionality may not be available when mixing and matching widget sets. For information about the Intrinsics, see -the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +the <olink targetdoc='intrinsics' targetptr='intrinsics' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> <para> The Athena widget set is a library package layered on top of the Intrinsics @@ -49,7 +50,7 @@ of radically differing widget implementations. <!-- .XS --> <!-- Introduction to the X Toolkit --> <!-- .XE --> -<!-- .IN "introduction" "" "@DEF@" --> +<indexterm significance="preferred"><primary>introduction</primary></indexterm> The X Toolkit provides tools that simplify the design of application user interfaces in the X Window System programming environment. It assists application programmers by providing a set of common @@ -84,7 +85,8 @@ A widget set for application programming While the majority of the Intrinsics functions are intended for the widget programmer, a subset of the Intrinsics functions are to be used by application programmers -(see <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>). +(see <olink targetdoc='intrinsics' targetptr='intrinsics' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>). The architectural model lets the widget programmer design new widgets by using the Intrinsics and by combining other widgets. The application interface layers built on top of the X Toolkit include a @@ -122,124 +124,97 @@ Format of the Widget Reference Chapters </sect1> <sect1 id="Terminology"> <title>Terminology</title> -<para> <!-- .LP --> <!-- .XS --> <!-- Terminology --> <!-- .XE --> -</para> <para> <!-- .LP --> In addition to the terms already defined for X programming (see -<emphasis remap='I'>Xlib - C Language Interface</emphasis>), +<olink targetdoc='libX11' targetptr='glossary' +><citetitle>Xlib - C Language Interface</citetitle></olink>), the following terms are specific to the Intrinsics and Athena widget set and used throughout this document. </para> -<para> -<!-- .LP --> -<function>Application programmer</function> -<!-- .IN "application programmer" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> +<glosslist> +<glossentry> + <glossterm>Application programmer</glossterm> +<indexterm significance="preferred"><primary>application programmer</primary></indexterm> + <glossdef> <para> A programmer who uses the X Toolkit to produce an application user interface. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Child</function> -<!-- .IN "child" "" "@DEF" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Child</glossterm> +<indexterm significance="preferred"><primary>child</primary></indexterm> + <glossdef> <para> A widget that is contained within another "parent" widget. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Class</function> -<!-- .IN "class" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Class</glossterm> +<indexterm significance="preferred"><primary>class</primary></indexterm> + <glossdef> <para> The general group to which a specific object belongs. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Client</function> -<!-- .IN "client" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Client</glossterm> +<indexterm significance="preferred"><primary>client</primary></indexterm> + <glossdef> <para> A function that uses a widget in an application or for composing other widgets. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>FullName</function> -<!-- .IN "FullName" "" "@DEF" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>FullName</glossterm> +<indexterm significance="preferred"><primary>FullName</primary></indexterm> + <glossdef> <para> The name of a widget instance appended to the full name of its parent. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Instance</function> -<!-- .IN "instance" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Instance</glossterm> +<indexterm significance="preferred"><primary>instance</primary></indexterm> + <glossdef> <para> A specific widget object as opposed to a general widget class. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Method</function> -<!-- .IN "method" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Method</glossterm> +<indexterm significance="preferred"><primary>method</primary></indexterm> + <glossdef> <para> A function or procedure implemented by a widget class. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Name</function> -<!-- .IN "name" "widget" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Name</glossterm> +<indexterm significance="preferred"><primary>name</primary><secondary>widget</secondary></indexterm> + <glossdef> <para> The name that is specific to an instance of a widget for a given client. This name is specified at creation time and cannot be modified. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Object</function> -<!-- .IN "object" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Object</glossterm> +<indexterm significance="preferred"><primary>object</primary></indexterm> + <glossdef> <para> A data abstraction consisting of private data and private and public functions that operate on the private data. @@ -255,97 +230,77 @@ types of widgets. If a function is unique to a single widget type, the widget exports the function. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Parent</function> -<!-- .IN "parent" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Parent</glossterm> +<indexterm significance="preferred"><primary>parent</primary></indexterm> + <glossdef> <para> A widget that contains at least one other ("child") widget. A parent widget is also known as a composite widget. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Resource</function> -<!-- .IN "resource" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Resource</glossterm> +<indexterm significance="preferred"><primary>resource</primary></indexterm> + <glossdef> <para> A named piece of data in a widget that can be set by a client, by an application, or by user defaults. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Superclass</function> -<!-- .IN "superclass" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Superclass</glossterm> +<indexterm significance="preferred"><primary>superclass</primary></indexterm> + <glossdef> <para> A larger class of which a specific class is a member. All members of a class are also members of the superclass. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>User</function> -<!-- .IN "user" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>User</glossterm> +<indexterm significance="preferred"><primary>user</primary></indexterm> + <glossdef> <para> A person interacting with a workstation. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Widget</function> -<!-- .IN "widget" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Widget</glossterm> +<indexterm significance="preferred"><primary>widget</primary></indexterm> + <glossdef> <para> An object providing a user-interface abstraction (for example, a Scrollbar widget). </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Widget class</function> -<!-- .IN "widget class" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Widget class</glossterm> +<indexterm significance="preferred"><primary>widget class</primary></indexterm> + <glossdef> <para> The general group to which a specific widget belongs, otherwise known as the type of the widget. </para> - </listitem> -</itemizedlist> -<para> -<!-- .LP --> -<function>Widget programmer</function> -<!-- .IN "widget programmer" "" "@DEF@" --> -</para> -<itemizedlist> - <listitem> + </glossdef> +</glossentry> +<glossentry> + <glossterm>Widget programmer</glossterm> +<indexterm significance="preferred"><primary>widget programmer</primary></indexterm> + <glossdef> <para> A programmer who adds new widgets to the X Toolkit. </para> - </listitem> -</itemizedlist> + </glossdef> +</glossentry> +</glosslist> </sect1> <sect1 id="Underlying_Model"> <title>Underlying Model</title> @@ -354,15 +309,13 @@ A programmer who adds new widgets to the X Toolkit. <!-- .XS --> <!-- Underlying Model --> <!-- .XE --> -<!-- .IN "underlying model" "" "@DEF@" --> +<indexterm significance="preferred"><primary>underlying model</primary></indexterm> The underlying architectural model is based on the following premises: <!-- .KS --> </para> -<itemizedlist> - <listitem> - <para> - </para> - </listitem> +<variablelist><?dbfo list-presentation="blocks"?> +<varlistentry> + <term>Widgets are X windows</term> <listitem> <para> Every user-interface widget is associated with an X window. @@ -373,10 +326,9 @@ output operations. <!-- .KS --> </para> </listitem> - <listitem> - <para> - </para> - </listitem> +</varlistentry> +<varlistentry> + <term>Information hiding</term> <listitem> <para> The data for every widget is private to the widget and its subclasses. @@ -388,10 +340,9 @@ All program interaction with the widget is performed by a set of operations <!-- .KS --> </para> </listitem> - <listitem> - <para> - </para> - </listitem> +</varlistentry> +<varlistentry> + <term>Widget semantics and widget layout geometry</term> <listitem> <para> Widget semantics are clearly separated from widget layout geometry. @@ -403,14 +354,15 @@ suggestions about their own geometry. <!-- .KE --> </para> </listitem> -</itemizedlist> +</varlistentry> +</variablelist> </sect1> <sect1 id="Conventions_Used_in_this_Manual"> <title>Conventions Used in this Manual</title> <itemizedlist> <listitem> <para> -<!-- .IN "conventions" "used in manual" "@DEF@" --> +<indexterm significance="preferred"><primary>conventions</primary><secondary>used in manual</secondary></indexterm> All resources available to the widgets are listed with each widget. Many of these are available to more than one widget class due to the object oriented nature of the Intrinsics. The new resources for each widget are @@ -454,8 +406,8 @@ All other pointers passed to these functions are used for reading only. A few arguments use pointers to structures that are used for both input and output and are indicated by using the <emphasis remap='I'>_in_out</emphasis> suffix. -<!-- .IN "_return" "" "@DEF@" --> -<!-- .IN "_in_out" "" "@DEF@" --> +<indexterm significance="preferred"><primary>_return</primary></indexterm> +<indexterm significance="preferred"><primary>_in_out</primary></indexterm> </para> </listitem> </itemizedlist> @@ -464,8 +416,8 @@ suffix. <title>Format of the Widget Reference Chapters</title> <para> <!-- .LP --> -<!-- .IN "conventions" "chapter format" "@DEF@" --> -<!-- .IN "chapter format" "" "@DEF@" --> +<indexterm significance="preferred"><primary>conventions</primary><secondary>chapter format</secondary></indexterm> +<indexterm significance="preferred"><primary>chapter format</primary></indexterm> The majority of this document is a reference guide for the Athena widget set. Chapters three through six give the programmer all information necessary to use the widgets. The layout of the chapters @@ -476,48 +428,12 @@ desired information. <!-- .LP --> The first few pages of every chapter give an overview of the widgets in that section. Widgets are grouped into chapters by functionality. -<variablelist> - <varlistentry> - <term> - "Chapter <!-- xref --> - </term> - <listitem> - <para> -Simple Widgets - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - "Chapter <!-- xref --> - </term> - <listitem> - <para> -Menus - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - "Chapter <!-- xref --> - </term> - <listitem> - <para> -Text Widgets - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - "Chapter <!-- xref --> - </term> - <listitem> - <para> -Composite and Constraint Widget - </para> - </listitem> - </varlistentry> -</variablelist> +<itemizedlist> + <listitem><para><xref linkend='Simple_Widgets'/></para></listitem> + <listitem><para><xref linkend='Menus'/></para></listitem> + <listitem><para><xref linkend='Text_Widgets'/></para></listitem> + <listitem><para><xref linkend='Composite_and_Constraint_Widgets'/></para></listitem> +</itemizedlist> </para> <para> <!-- .LP --> @@ -548,11 +464,11 @@ Superclass Composite </term> <listitem> <para> -<!-- .IN "application header file" "" "@DEF@" --> +<indexterm significance="preferred"><primary>application header file</primary></indexterm> This file must be included when an application uses this widget. It usually contains the class definition, and some resource macros. -This is often called the ``public'' header file. -<!-- .IN "class header file" "" "@DEF@" --> +This is often called the <quote>public</quote> header file. +<indexterm significance="preferred"><primary>class header file</primary></indexterm> </para> </listitem> </varlistentry> @@ -564,8 +480,8 @@ This is often called the ``public'' header file. <para> This file will only be used by widget programmers. It will need to be included by any widget that subclasses this widget. This is often -called the ``private'' header file. -<!-- .IN "class" "" "@DEF@" --> +called the <quote>private</quote> header file. +<indexterm significance="preferred"><primary>class</primary></indexterm> </para> </listitem> </varlistentry> @@ -578,7 +494,7 @@ called the ``private'' header file. This is the widget class of this widget. This global symbol is passed to <function>XtCreateWidget</function> so that the Intrinsics will know which type of widget to create. -<!-- .IN "class name" "" "@DEF@" --> +<indexterm significance="preferred"><primary>class name</primary></indexterm> </para> </listitem> </varlistentry> @@ -590,7 +506,7 @@ to create. <para> This is the resource name of this class. This name can be used in a resource file to match any widget of this class. -<!-- .IN "superclass" "" --> +<indexterm><primary>superclass</primary></indexterm> </para> </listitem> </varlistentry> @@ -622,11 +538,11 @@ The next section is a table showing the name, class, type and default value of each resource that is available to this widget. There is also a column containing notes describing special restrictions placed upon individual resources. -<!-- .IN "notes" "" "@DEF@" --> -<!-- .IN "A, note" "" "@DEF@" --> -<!-- .IN "D, note" "" "@DEF@" --> -<!-- .IN "C, note" "" "@DEF@" --> -<!-- .IN "R, note" "" "@DEF@" --> +<indexterm significance="preferred"><primary>notes</primary></indexterm> +<indexterm significance="preferred"><primary>A, note</primary></indexterm> +<indexterm significance="preferred"><primary>D, note</primary></indexterm> +<indexterm significance="preferred"><primary>C, note</primary></indexterm> +<indexterm significance="preferred"><primary>R, note</primary></indexterm> <variablelist> <varlistentry> <term> @@ -704,9 +620,9 @@ the widget. <!-- .XS --> <!-- Input Focus --> <!-- .XE --> -<!-- .IN "input focus" "" "@DEF@" --> -<!-- .IN "input" "" "@DEF@" --> -<!-- .IN "XtNinput" "" "@DEF@" --> +<indexterm significance="preferred"><primary>input focus</primary></indexterm> +<indexterm significance="preferred"><primary>input</primary></indexterm> +<indexterm significance="preferred"><primary>XtNinput</primary></indexterm> <para> <!-- .LP --> The Intrinsics define a resource on all Shell widgets that interact with @@ -717,7 +633,8 @@ default to <function>True</function> when an application is using the Athena wid set. An application programmer may override this default and set the resource back to <function>False</function> if the application does not need the window manager to give it the input focus. See the -<emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis> for details +<olink targetdoc='intrinsics' targetptr='Shell_Widgets' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink> for details on the <emphasis remap='I'>input</emphasis> resource. </para> diff --git a/lib/libXaw/specs/CH2.xml b/lib/libXaw/specs/CH2.xml index 98ac97ee1..ee242e01f 100644 --- a/lib/libXaw/specs/CH2.xml +++ b/lib/libXaw/specs/CH2.xml @@ -23,7 +23,8 @@ examples provided use the Athena widgets, though most of the concepts will apply to all widget sets. Although there are several programming interfaces to the X Toolkit, only one is described here. A full description of the programming interface is provided in the document -<emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +<olink targetdoc='intrinsics' targetptr='intrinsics' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> <sect2 id="Setting_the_Locale"> <title>Setting the Locale</title> @@ -35,16 +36,23 @@ description of the programming interface is provided in the document If it is desirable that the application take advantage of internationalization (i18n), you must establish locale with <function>XtSetLanguageProc</function> -before <function>XtDisplayInitialize</function> or <xref linkend='XtAppInitialize' xrefstyle='select: title'/> -is called. For full details, please refer to the document -<emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>, section 2.2. However, the following simplest-case +prior to calling +<xref linkend='XtOpenApplication' xrefstyle='select: title'/>, +<function>XtOpenDisplay</function>, +<function>XtDisplayInitialize</function>, +or +<function>XtAppInitialize</function>. +For full details, please refer to the document +<olink targetdoc='intrinsics' targetptr='Establishing_the_Locale' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle>, +section 2.2</olink>. However, the following simplest-case call is sufficient in many or most applications. </para> <para> <!-- .LP --> -<!-- .IN "internationalization" "" "" --> -<!-- .IN "XtSetLanguageProc" "" "@DEF@" --> -<!-- .IN "locale" "" "" --> +<indexterm><primary>internationalization</primary></indexterm> +<indexterm significance="preferred"><primary>XtSetLanguageProc</primary></indexterm> +<indexterm><primary>locale</primary></indexterm> <literallayout class="monospaced"> <!-- .TA .5i 2i --> <!-- .ta .5i 2i --> @@ -69,33 +77,34 @@ of programs in the default "C" locale. <!-- .XE --> You must call a toolkit initialization function before invoking any other toolkit routines (besides locale setting, above). -<xref linkend='XtAppInitialize' xrefstyle='select: title'/> +<xref linkend='XtOpenApplication' xrefstyle='select: title'/>, opens the X server connection, parses the command line, and creates an initial widget that will serve as the root of a tree of widgets created by this application. -<!-- .IN "initialization" "" "@DEF@" --> -<!-- .IN "toolkit initialization" "" "@DEF@" --> -<!-- .IN "XtAppInitialize" "" "@DEF@" --> -<!-- .IN "fallback resources" "" "@DEF@" --> -<funcsynopsis id='XtAppInitialize'> +<indexterm significance="preferred"><primary>initialization</primary></indexterm> +<indexterm significance="preferred"><primary>toolkit initialization</primary></indexterm> +<indexterm significance="preferred"><primary>XtOpenApplication</primary></indexterm> +<indexterm significance="preferred"><primary>fallback resources</primary></indexterm> +<funcsynopsis id='XtOpenApplication'> <funcprototype> - <funcdef>Widget<function> XtAppInitialize</function></funcdef> - <paramdef>XtAppContext<parameter> app_context_return</parameter></paramdef> - <paramdef>String<parameter> application_class</parameter></paramdef> - <paramdef>XrmOptionDescRec<parameter> options</parameter></paramdef> - <paramdef>Cardinal<parameter> num_options</parameter></paramdef> - <paramdef>int<parameter> *argc_in_out</parameter></paramdef> - <paramdef>String<parameter> *argv_in_out</parameter></paramdef> - <paramdef>String<parameter> *fallback_resources</parameter></paramdef> - <paramdef>ArgList<parameter> args</parameter></paramdef> - <paramdef>Cardinal<parameter> num_args</parameter></paramdef> +<funcdef>Widget <function>XtOpenApplication</function></funcdef> + <paramdef>XtAppContext *<parameter>app_context_return</parameter></paramdef> + <paramdef>String <parameter>application_class</parameter></paramdef> + <paramdef>XrmOptionDescList <parameter>options</parameter></paramdef> + <paramdef>Cardinal <parameter>num_options</parameter></paramdef> + <paramdef>int *<parameter>argc_in_out</parameter></paramdef> + <paramdef>String *<parameter>argv_in_out</parameter></paramdef> + <paramdef>String *<parameter>fallback_resources</parameter></paramdef> + <paramdef>WidgetClass <parameter>widget_class</parameter></paramdef> + <paramdef>ArgList <parameter>args</parameter></paramdef> + <paramdef>Cardinal <parameter>num_args</parameter></paramdef> </funcprototype> </funcsynopsis> <!-- .FN --> <variablelist> <varlistentry> <term> - <emphasis remap='I'>app_con_return</emphasis> + <emphasis remap='I'>app_context_return</emphasis> </term> <listitem> <para> @@ -113,7 +122,7 @@ Specifies the class name of this application, which is usually the generic name for all instances of this application. A useful convention is to form the class name by capitalizing the first letter of the application name. For example, the application named -``xman'' has a class name of ``Xman''. +<quote>xman</quote> has a class name of <quote>Xman</quote>. </para> </listitem> </varlistentry> @@ -128,7 +137,8 @@ resources. The options argument is passed as a parameter to <olink targetdoc='libX11' targetptr='XrmParseCommand'><function>XrmParseCommand</function></olink>. For further information, -see <emphasis remap='I'>Xlib - C Language Interface</emphasis>. +see <olink targetdoc='libX11' targetptr='XrmParseCommand' +><citetitle>Xlib - C Language Interface</citetitle></olink>. </para> </listitem> </varlistentry> @@ -175,6 +185,17 @@ defaults file cannot be opened, or NULL. </varlistentry> <varlistentry> <term> + <emphasis remap='I'>widget_class</emphasis> + </term> + <listitem> + <para> +Specifies the class of the widget to be created. Must be shellWidgetClass +or a subclass. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> <emphasis remap='I'>args</emphasis> </term> <listitem> @@ -213,9 +234,9 @@ widget to be used as the root of the application's widget tree. <!-- .XS --> <!-- Creating a Widget --> <!-- .XE --> -<!-- .IN "widget creation" "" "@DEF@" --> -<!-- .IN "creating widgets" "" "@DEF@" --> -<!-- .IN "XtRealizeWidget" "" "" --> +<indexterm significance="preferred"><primary>widget creation</primary></indexterm> +<indexterm significance="preferred"><primary>creating widgets</primary></indexterm> +<indexterm><primary>XtRealizeWidget</primary></indexterm> Creating a widget is a three-step process. First, the widget instance is allocated, and various instance-specific attributes are set by using <function>XtCreateWidget</function>. Second, the widget's parent is informed @@ -229,8 +250,8 @@ managed if the parent is already realized. <para> <!-- .LP --> To allocate, initialize, and manage a widget, use -<function>XtCreateManagedWidget .</function> -<!-- .IN "XtCreateManagedWidget" "" "@DEF@" --> +<function>XtCreateManagedWidget</function>. +<indexterm significance="preferred"><primary>XtCreateManagedWidget</primary></indexterm> <funcsynopsis id='XtCreateManagedWidget'> <funcprototype> <funcdef>Widget<function> XtCreateManagedWidget</function></funcdef> @@ -306,11 +327,13 @@ When a widget instance is successfully created, the widget identifier is returned to the application. If an error is encountered, the <function>XtError</function> routine is invoked to inform the user of the error. -<!-- .IN "XtError" "" "" --> +<indexterm><primary>XtError</primary></indexterm> </para> <para> <!-- .LP --> -For further information, see <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +For further information, see +<olink targetdoc='intrinsics' targetptr='Creating_Widgets' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> </sect2> <sect2 id="Common_Resources"> @@ -318,7 +341,7 @@ For further information, see <emphasis remap='I'>X Toolkit Intrinsics - C Langua <!-- .XS --> <!-- Common Resources --> <!-- .XE --> -<!-- .IN "resource" "" --> +<indexterm><primary>resource</primary></indexterm> <para> <!-- .LP --> Although a widget can have unique arguments that it understands, all @@ -457,8 +480,8 @@ or from the resource database by all of the Athena widgets: </tbody> </tgroup> </informaltable> -<!-- .IN "XtDefaultForeground" "" "" --> -<!-- .IN "XtDefaultBackground" "" "" --> +<indexterm><primary>XtDefaultForeground</primary></indexterm> +<indexterm><primary>XtDefaultBackground</primary></indexterm> </para> <para> <!-- .LP --> @@ -506,7 +529,7 @@ or from the resource database by many of the Athena widgets: </tbody> </tgroup> </informaltable> -<!-- .IN "XtDefaultForeground" "" "" --> +<indexterm><primary>XtDefaultForeground</primary></indexterm> </para> </sect2> <sect2 id="Resource_Conversions"> @@ -514,9 +537,9 @@ or from the resource database by many of the Athena widgets: <!-- .XS --> <!-- Resource Conversions --> <!-- .XE --> -<!-- .IN "conversions" "" "@DEF@" --> -<!-- .IN "string conversions" "" "@DEF@" --> -<!-- .IN "type conversions" "" "@DEF@" --> +<indexterm significance="preferred"><primary>conversions</primary></indexterm> +<indexterm significance="preferred"><primary>string conversions</primary></indexterm> +<indexterm significance="preferred"><primary>type conversions</primary></indexterm> <para> <!-- .LP --> Most resources in the Athena widget set have a converter registered that @@ -550,9 +573,9 @@ will describe the converter. </para> <sect3 id="Cursor_Conversion"> <title>Cursor Conversion</title> -<!-- .IN "conversions" "ColorCursor" "@DEF@" --> -<!-- .IN "conversions" "Cursor" "@DEF@" --> -<!-- .IN "cursor" "" "" --> +<indexterm significance="preferred"><primary>conversions</primary><secondary>ColorCursor</secondary></indexterm> +<indexterm significance="preferred"><primary>conversions</primary><secondary>Cursor</secondary></indexterm> +<indexterm><primary>cursor</primary></indexterm> <para> <!-- .LP --> The value for the <function>cursorName</function> resource is specified in the resource @@ -561,7 +584,7 @@ database as a string, and is of the following forms: <itemizedlist> <listitem> <para> -A standard X cursor name from <function>< X11/cursorfont.h ></function>. +A standard X cursor name from <filename class="headerfile"><X11/cursorfont.h></filename>. The names in <function>cursorfont.h</function> each describe a specific cursor. The resource names for these cursors are exactly like the names in this file except the <function>XC_</function> is not used. The cursor definition <function>XC_gumby</function> @@ -594,22 +617,25 @@ file path is used (see section 2.4.3). <!-- xref --> <title>Pixel Conversion</title> <para> <!-- .LP --> -<!-- .IN "conversions" "Pixel" "@DEF@" --> -<!-- .IN "pixel" "" "" --> -<!-- .IN "rgb.txt" "" "" --> -<!-- .IN "XtDefaultForeground" "" "" --> -<!-- .IN "XtDefaultBackground" "" "" --> +<indexterm significance="preferred"><primary>conversions</primary><secondary>Pixel</secondary></indexterm> +<indexterm><primary>pixel</primary></indexterm> +<indexterm><primary>rgb.txt</primary></indexterm> +<indexterm><primary>XtDefaultForeground</primary></indexterm> +<indexterm><primary>XtDefaultBackground</primary></indexterm> The string-to-pixel converter takes any name that is acceptable to -XParseColor (see <emphasis remap='I'>Xlib - C Language Interface</emphasis>). In addition this routine understands +XParseColor (see <olink targetdoc='libX11' targetptr='Color_Strings' +><citetitle>Xlib - C Language Interface</citetitle></olink>). In addition this routine understands the special toolkit symbols `XtDefaultForeground' and -`XtDefaultBackground', described in <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. In short the acceptable +`XtDefaultBackground', described in +<olink targetdoc='intrinsics' targetptr='Predefined_Resource_Converters' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. In short the acceptable pixel names are: </para> <itemizedlist> <listitem> <para> Any color name for the rgb.txt file (typically in the directory -/usr/lib/X11 on POSIX systems). +/usr/share/X11 on POSIX systems). </para> </listitem> <listitem> @@ -627,11 +653,11 @@ The special strings `XtDefaultForeground' and `XtDefaultBackground' </sect3> <sect3 id="Bitmap_Conversion"> <title>Bitmap Conversion</title> -<!-- .IN "bitmap conversions" "" "@DEF@" --> -<!-- .IN "conversions" "Bitmap" "@DEF@" --> -<!-- .IN "bitmapFilePath" "" "@DEF@" --> -<!-- .IN "BitmapFilePath" "" "@DEF@" --> -<!-- .IN "/usr/include/X11/bitmaps" "" "" --> +<indexterm significance="preferred"><primary>bitmap conversions</primary></indexterm> +<indexterm significance="preferred"><primary>conversions</primary><secondary>Bitmap</secondary></indexterm> +<indexterm significance="preferred"><primary>bitmapFilePath</primary></indexterm> +<indexterm significance="preferred"><primary>BitmapFilePath</primary></indexterm> +<indexterm><primary>/usr/include/X11/bitmaps</primary></indexterm> <para> <!-- .LP --> The string-to-bitmap converter attempts to locate a file containing @@ -646,7 +672,7 @@ for each widget that wishes to convert a cursor to bitmap. In addition to the directories specified in the <function>bitmapFilePath</function> resource a default directory is searched. When using POSIX the default directory is -<function>/usr/include/X11/bitmaps .</function> +<function>/usr/include/X11/bitmaps</function>. </para> </sect3> </sect2> @@ -657,7 +683,7 @@ directory is <!-- .XS --> <!-- Realizing a Widget --> <!-- .XE --> -<!-- .IN "realizing widgets" "" "@DEF@" --> +<indexterm significance="preferred"><primary>realizing widgets</primary></indexterm> The <xref linkend='XtRealizeWidget' xrefstyle='select: title'/> function performs two tasks: @@ -674,7 +700,7 @@ for performance reasons. <para> Creates an X window for the widget and, if it is a composite widget, realizes each of its managed children. -<!-- .IN "XtRealizeWidget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XtRealizeWidget</primary></indexterm> <funcsynopsis id='XtRealizeWidget'> <funcprototype> <funcdef>void<function> XtRealizeWidget</function></funcdef> @@ -693,7 +719,8 @@ Specifies the widget. <para> <!-- .LP --> For further information about this function, -see the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +see the <olink targetdoc='intrinsics' targetptr='XtRealizeWidget' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> </sect2> <sect2 id="Processing_Events"> @@ -703,13 +730,13 @@ see the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasi <!-- .XS --> <!-- Processing Events --> <!-- .XE --> -<!-- .IN "events" "" "" --> -<!-- .IN "XtAppInitialize" "" "" --> +<indexterm><primary>events</primary></indexterm> +<indexterm><primary>XtAppInitialize</primary></indexterm> Now that the application has created, managed and realized its widgets, it is ready to process the events that will be delivered by the X Server to this client. A function call that will process the events is <xref linkend='XtAppMainLoop' xrefstyle='select: title'/>. -<!-- .IN "XtAppMainLoop" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XtAppMainLoop</primary></indexterm> <funcsynopsis id='XtAppMainLoop'> <funcprototype> <funcdef>void<function> XtAppMainLoop</function></funcdef> @@ -725,7 +752,7 @@ events is <xref linkend='XtAppMainLoop' xrefstyle='select: title'/>. <listitem> <para> Specifies the application context of this application. The value is -normally returned by <xref linkend='XtAppInitialize' xrefstyle='select: title'/>. +normally returned by <xref linkend='XtOpenApplication' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> @@ -736,7 +763,8 @@ normally returned by <xref linkend='XtAppInitialize' xrefstyle='select: title'/> This function never returns: it is an infinite loop that processes the X events. User input can be handled through callback procedures and application defined action routines. More details are provided in -<emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +<olink targetdoc='intrinsics' targetptr='Event_Management' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> </sect2> <sect2 id="Standard_Widget_Manipulation_Functions"> @@ -789,9 +817,9 @@ widget windows are mapped (made viewable) automatically by <xref linkend='XtRealizeWidget' xrefstyle='select: title'/>. This behavior can be disabled by using <xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/>, making the client responsible for calling <xref linkend='XtMapWidget' xrefstyle='select: title'/> to make the widget viewable. -<!-- .IN "XtSetMappedWhenManaged" "" "@DEF@" --> -<!-- .IN "XtMapWidget" "" "" --> -<!-- .IN "XtRealizeWidget" "" "" --> +<indexterm significance="preferred"><primary>XtSetMappedWhenManaged</primary></indexterm> +<indexterm><primary>XtMapWidget</primary></indexterm> +<indexterm><primary>XtRealizeWidget</primary></indexterm> <funcsynopsis id='XtSetMappedWhenManaged'> <funcprototype> <funcdef>void<function> XtSetMappedWhenManaged</function></funcdef> @@ -836,7 +864,7 @@ to cause the child window to be mapped. The definition for <xref linkend='XtMapWidget' xrefstyle='select: title'/> is: -<!-- .IN "XtMapWidget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XtMapWidget</primary></indexterm> <funcsynopsis id='XtMapWidget'> <funcprototype> <funcdef>void<function> XtMapWidget</function></funcdef> @@ -865,9 +893,9 @@ list of children as they are created (using <function>XtCreateWidget</function>) then use <xref linkend='XtManageChildren' xrefstyle='select: title'/> to request that their parent managed them all at once. By managing a list of children at one time, the parent can avoid wasteful duplication of geometry processing and the -associated ``screen flash''. -<!-- .IN "XtManageChildren" "" "@DEF@" --> -<!-- .IN "XtCreateWidget" "" "" --> +associated <quote>screen flash</quote>. +<indexterm significance="preferred"><primary>XtManageChildren</primary></indexterm> +<indexterm><primary>XtCreateWidget</primary></indexterm> <funcsynopsis id='XtManageChildren'> <funcprototype> <funcdef>void<function> XtManageChildren</function></funcdef> @@ -908,7 +936,8 @@ reconfiguration is performed. <para> <!-- .LP --> For further information about these functions, -see the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +see the <olink targetdoc='intrinsics' targetptr='intrinsics' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> </sect3> <sect3 id="Destroying_Widgets"> @@ -917,7 +946,7 @@ see the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasi <!-- .LP --> To destroy a widget instance of any type, use <xref linkend='XtDestroyWidget' xrefstyle='select: title'/> -<!-- .IN "XtDestroyWidget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XtDestroyWidget</primary></indexterm> <funcsynopsis id='XtDestroyWidget'> <funcprototype> <funcdef>void<function> XtDestroyWidget</function></funcdef> @@ -944,7 +973,7 @@ Specifies the widget. destroys the widget and recursively destroys any children that it may have, including the windows created by its children. After calling -<function>XtDestroyWidget ,</function> +<function>XtDestroyWidget</function>, no further references should be made to the widget or any children that the destroyed widget may have had. </para> @@ -955,8 +984,8 @@ that the destroyed widget may have had. <!-- .LP --> To retrieve the current value of a resource attribute associated with a widget instance, use -<function>XtGetValues .</function> -<!-- .IN "XtGetValues" "" "@DEF@" --> +<function>XtGetValues</function>. +<indexterm significance="preferred"><primary>XtGetValues</primary></indexterm> <funcsynopsis id='XtGetValues'> <funcprototype> <funcdef>void<function> XtGetValues</function></funcdef> @@ -1007,7 +1036,9 @@ The arguments and values passed in the argument list are dependent on the widget. Note that the caller is responsible for providing space into which the returned resource value is copied; the <function>ArgList</function> contains a pointer to this storage (e.g. x and y must be -allocated as Position). For further information, see the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +allocated as Position). For further information, see the +<olink targetdoc='intrinsics' targetptr='Reading_and_Writing_Widget_State' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> </sect3> <sect3 id="Modifying_Widget_Resource_Values"> @@ -1016,8 +1047,8 @@ allocated as Position). For further information, see the <emphasis remap='I'>X <!-- .LP --> To modify the current value of a resource attribute associated with a widget instance, use -<function>XtSetValues .</function> -<!-- .IN "XtSetValues" "" "@DEF@" --> +<function>XtSetValues</function>. +<indexterm significance="preferred"><primary>XtSetValues</primary></indexterm> <funcsynopsis id='XtSetValues'> <funcprototype> <funcdef>void<function> XtSetValues</function></funcdef> @@ -1071,15 +1102,17 @@ ignored. </para> <para> <!-- .LP --> -For further information about these functions, see the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. -<!-- .IN "XtGetValues" "" "" --> -<!-- .IN "XtSetValues" "" "" --> +For further information about these functions, see the +<olink targetdoc='intrinsics' targetptr='Reading_and_Writing_Widget_State' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. +<indexterm><primary>XtGetValues</primary></indexterm> +<indexterm><primary>XtSetValues</primary></indexterm> <!-- .NT --> The argument list entry for <xref linkend='XtGetValues' xrefstyle='select: title'/> specifies the address to which the caller wants the value copied. The argument list entry for -<function>XtSetValues ,</function> +<function>XtSetValues</function>, however, contains the new value itself, if the size of value is less than sizeof(XtArgVal) (architecture dependent, but at least sizeof(long)); otherwise, it is a pointer to the value. String resources are always @@ -1095,11 +1128,11 @@ passed as pointers, regardless of the length of the string. <!-- .XS --> <!-- Using the Client Callback Interface --> <!-- .XE --> -<!-- .IN "callbacks" "" "" --> +<indexterm><primary>callbacks</primary></indexterm> Widgets can communicate changes in their state to their clients by means of a callback facility. The format for a client's callback handler is: -<!-- .IN "CallbackProc" "" "@DEF@" --> +<indexterm significance="preferred"><primary>CallbackProc</primary></indexterm> <funcsynopsis id='CallbackProc'> <funcprototype> <funcdef>void<function> CallbackProc</function></funcdef> @@ -1157,14 +1190,14 @@ the callback list described below or by using the special convenience routines <xref linkend='XtAddCallback' xrefstyle='select: title'/> and <function>XtAddCallbacks</function>. When the widget is created, a pointer to a list of callback procedure and data pairs can be passed in the argument list to -<function>XtCreateWidget .</function> +<function>XtCreateWidget</function>. The list is of type <function>XtCallbackList :</function> -<!-- .IN "XtCallbackProc" --> -<!-- .IN "XtAddCallbacks" --> -<!-- .IN "XtAddCallback" --> -<!-- .IN "XtCallbackList" "" "@DEF@" --> -<!-- .IN "XtCallbackRec" "" "@DEF@" --> +<indexterm><primary>XtCallbackProc</primary></indexterm> +<indexterm><primary>XtAddCallbacks</primary></indexterm> +<indexterm><primary>XtAddCallback</primary></indexterm> +<indexterm significance="preferred"><primary>XtCallbackList</primary></indexterm> +<indexterm significance="preferred"><primary>XtCallbackRec</primary></indexterm> </para> <para> <!-- .LP --> @@ -1180,8 +1213,8 @@ typedef struct { <para> <!-- .LP --> The callback list must be allocated and initialized before calling -<function>XtCreateWidget .</function> -<!-- .IN "XtCreateWidget" --> +<function>XtCreateWidget</function>. +<indexterm><primary>XtCreateWidget</primary></indexterm> The end of the list is identified by an entry containing NULL in callback and closure. Once the widget is created, the client can change or de-allocate this list; the widget itself makes no further reference @@ -1193,7 +1226,7 @@ callback when the callback list is executed. The second method for registering callbacks is to use <xref linkend='XtAddCallback' xrefstyle='select: title'/> after the widget has been created. -<!-- .IN "XtAddCallback" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XtAddCallback</primary></indexterm> <funcsynopsis id='XtAddCallback'> <funcprototype> <funcdef>void<function> XtAddCallback</function></funcdef> @@ -1256,7 +1289,7 @@ adds the specified callback to the list for the named widget. <!-- .LP --> All widgets provide a callback list named <function>destroyCallback</function> -<!-- .IN "destroyCallback" "" "@DEF@" --> +<indexterm significance="preferred"><primary>destroyCallback</primary></indexterm> where clients can register procedures that are to be executed when the widget is destroyed. The destroy callbacks are executed when the widget or an ancestor is destroyed. The <emphasis remap='I'>call_data</emphasis> argument is unused for @@ -1277,9 +1310,9 @@ program that uses the X Toolkit. <title>Writing Applications</title> <para> <!-- .LP --> -<!-- .IN "writing applications" --> -<!-- .IN "StringDefs.h" --> -<!-- .IN "Intrinsic.h" --> +<indexterm><primary>writing applications</primary></indexterm> +<indexterm><primary>StringDefs.h</primary></indexterm> +<indexterm><primary>Intrinsic.h</primary></indexterm> When writing an application that uses the X Toolkit, you should make sure that your application performs the following: </para> @@ -1287,12 +1320,12 @@ you should make sure that your application performs the following: <listitem> <para> Include -<function>< X11/Intrinsic.h ></function> +<filename class="headerfile"><X11/Intrinsic.h></filename> in your application programs. This header file automatically includes -<function>< X11/Xlib.h >,</function> +<filename class="headerfile"><X11/Xlib.h></filename>, so all Xlib functions also are defined. -It may also be necessary to include <function>< X11/StringDefs.h ></function> when setting +It may also be necessary to include <filename class="headerfile"><X11/StringDefs.h></filename> when setting up argument lists, as many of the XtN<emphasis remap='I'>something</emphasis> definitions are only defined in this file. </para> @@ -1302,19 +1335,21 @@ only defined in this file. Include the widget-specific header files for each widget type that you need to use. For example, -<function>< X11/Xaw/Label.h ></function> +<filename class="headerfile"><X11/Xaw/Label.h></filename> and -<function>< X11/Xaw/Command.h >.</function> +<filename class="headerfile"><X11/Xaw/Command.h></filename>. </para> </listitem> <listitem> <para> Call the -<xref linkend='XtAppInitialize' xrefstyle='select: title'/> -<!-- .IN "XtAppInitialize" --> +<xref linkend='XtOpenApplication' xrefstyle='select: title'/> +<indexterm><primary>XtOpenApplication</primary></indexterm> function before invoking any other toolkit or Xlib functions. For further information, -see Section 2.1 and the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +see Section 2.1 and the +<olink targetdoc='intrinsics' targetptr='Widget_Instantiation' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> </listitem> <listitem> @@ -1325,10 +1360,8 @@ document, a list of valid argument names is provided in the discussion of each widget. The names each have a global symbol defined that begins with <function>XtN</function> to help catch spelling errors. For example, <function>XtNlabel</function> is defined for the <function>label</function> resource of many widgets. -<!-- .IN "XtN" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XtN</primary></indexterm> </para> - </listitem> - <listitem> <para> For further information, see Section 2.9.2.2. <!-- xref --> </para> @@ -1337,8 +1370,10 @@ For further information, see Section 2.9.2.2. <!-- xref --> <para> When the argument list is set up, create the widget with the <xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/> function. For further information, see -Section 2.2 and the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. -<!-- .IN "XtCreateManagedWidget" --> +Section 2.2 and the +<olink targetdoc='intrinsics' targetptr='XtCreateManagedWidget' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. +<indexterm><primary>XtCreateManagedWidget</primary></indexterm> </para> </listitem> <listitem> @@ -1348,7 +1383,7 @@ If the widget has any callback routines, set by the argument or the <xref linkend='XtAddCallback' xrefstyle='select: title'/> function, declare these routines within the application. -<!-- .IN "XtAddCallback" --> +<indexterm><primary>XtAddCallback</primary></indexterm> </para> </listitem> <listitem> @@ -1357,19 +1392,15 @@ After creating the initial widget hierarchy, windows must be created for each widget by calling <xref linkend='XtRealizeWidget' xrefstyle='select: title'/> on the top level widget. -<!-- .IN "XtRealizeWidget" --> +<indexterm><primary>XtRealizeWidget</primary></indexterm> </para> </listitem> <listitem> <para> Most applications now sit in a loop processing events using -<function>XtAppMainLoop ,</function> +<function>XtAppMainLoop</function>, for example: -<!-- .IN "XtAppMainLoop" --> - </para> - </listitem> - <listitem> - <para> +<indexterm><primary>XtAppMainLoop</primary></indexterm> <literallayout class="monospaced"> XtCreateManagedWidget(<emphasis remap='I'>name</emphasis>, <emphasis remap='I'>class</emphasis>, <emphasis remap='I'>parent</emphasis>, <emphasis remap='I'>args</emphasis>, <emphasis remap='I'>num_args</emphasis>); XtRealizeWidget(<emphasis remap='I'>shell</emphasis>); @@ -1379,7 +1410,9 @@ XtAppMainLoop(<emphasis remap='I'>app_context</emphasis>); </listitem> <listitem> <para> -For information about this function, see the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +For information about this function, see the +<olink targetdoc='intrinsics' targetptr='Event_Management' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> </listitem> <listitem> @@ -1401,22 +1434,21 @@ rounded Command buttons), and <function>libX11</function> (the core X library). The following provides a sample command line: -<!-- .IN "libXaw" --> -<!-- .IN "libXmu" --> -<!-- .IN "libXt" --> -<!-- .IN "libSM" --> -<!-- .IN "libICE" --> -<!-- .IN "libXext" --> -<!-- .IN "libX11" --> -<!-- .IN "linking applications" --> -<!-- .IN "compiling applications" --> +<indexterm><primary>libXaw</primary></indexterm> +<indexterm><primary>libXmu</primary></indexterm> +<indexterm><primary>libXt</primary></indexterm> +<indexterm><primary>libSM</primary></indexterm> +<indexterm><primary>libICE</primary></indexterm> +<indexterm><primary>libXext</primary></indexterm> +<indexterm><primary>libX11</primary></indexterm> +<indexterm><primary>linking applications</primary></indexterm> +<indexterm><primary>compiling applications</primary></indexterm> </para> </listitem> <listitem> <para> <literallayout class="monospaced"> -cc -o <emphasis remap='I'>application</emphasis> <emphasis remap='I'>application</emphasis>.c \-lXaw \-lXmu \-lXt \ -\-lSM \-lICE \-lXext \-lX11 +cc -o <emphasis remap='I'>application</emphasis> <emphasis remap='I'>application</emphasis>.c -lXaw -lXmu -lXt -lSM -lICE -lXext -lX11 </literallayout> </para> </listitem> @@ -1424,7 +1456,7 @@ cc -o <emphasis remap='I'>application</emphasis> <emphasis remap='I'>application </sect3> <sect3 id="Changing_Resource_Values"> <title>Changing Resource Values</title> -<!-- .IN "resource" "" --> +<indexterm><primary>resource</primary></indexterm> <para> <!-- .LP --> The Intrinsics support two methods of changing the default resource @@ -1437,10 +1469,15 @@ functionality. <term>Resource Manager</term> <listitem> <para> -This method picks up resource definitions described in <emphasis remap='I'>Xlib - C Language Interface</emphasis> from +This method picks up resource definitions described in +<olink targetdoc='libX11' targetptr='Resource_Manager_Functions' +><citetitle>Xlib - C Language Interface</citetitle></olink> from many different locations at run time. The locations most important to the application programmer are the <emphasis remap='I'>fallback resources</emphasis> and the -<emphasis remap='I'>app-defaults</emphasis> file, (see <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis> for the complete list). +<emphasis remap='I'>app-defaults</emphasis> file, (see +<olink targetdoc='intrinsics' targetptr='Loading_the_Resource_Database' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink> +for the complete list). Since these resource are loaded at run time, they can be overridden by the user, allowing an application to be customized to fit the particular needs of each individual user. These values can also be @@ -1473,7 +1510,7 @@ understand how to use the X Resource Manager to specify resources for widgets in an X application. This section will describe the most common methods used to specify these resources, and how to use the X Resource manager. -<!-- .IN "xrdb" --> +<indexterm><primary>xrdb</primary></indexterm> <variablelist> <varlistentry> <term> @@ -1485,9 +1522,9 @@ The <function>xrdb</function> utility may be used to load a file containing resources into the X server. Once the resources are loaded, the resources will affect any new applications started on the display that they were loaded onto. -<!-- .IN "application defaults" --> -<!-- .IN "app-defaults" --> -<!-- .IN "/usr/lib/X11/app-defaults" --> +<indexterm><primary>application defaults</primary></indexterm> +<indexterm><primary>app-defaults</primary></indexterm> +<indexterm><primary>/usr/share/X11/app-defaults</primary></indexterm> </para> </listitem> </varlistentry> @@ -1496,7 +1533,7 @@ they were loaded onto. <listitem> <para> The application defaults (app-defaults) file (normally in -/usr/lib/X11/app-defaults/<emphasis remap='I'>classname</emphasis>) for an application is loaded +/usr/share/X11/app-defaults/<emphasis remap='I'>classname</emphasis>) for an application is loaded whenever the application is started. </para> </listitem> @@ -1591,7 +1628,7 @@ This matches any widget in the Foo application that is named <emphasis remap='I' <para> <!-- .LP --> The root of all application widget trees is the widget returned by -<xref linkend='XtAppInitialize' xrefstyle='select: title'/>. Even though this is actually an +<xref linkend='XtOpenApplication' xrefstyle='select: title'/>. Even though this is actually an ApplicationShell widget, the toolkit replaces its widget class with the class name of the application. The name of this widget is either the name used to invoke the application (<function>argv[0]</function>) or the name of @@ -1661,7 +1698,7 @@ An application programmer may add new resources to their application. These resources are associated with the global application, and not any particular widget. The X Toolkit function used for adding the application resources is <function>XtGetApplicationResources</function>. -<!-- .IN "XtGetApplicationResources" --> +<indexterm><primary>XtGetApplicationResources</primary></indexterm> </para> </listitem> <listitem> @@ -1702,26 +1739,30 @@ will override program defaults. <para> <!-- .LP --> For a complete explanation of the rules of precedence, and -other specific topics see <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis> and <emphasis remap='I'>Xlib - C Language Interface</emphasis>. +other specific topics see +<olink targetdoc='intrinsics' targetptr='Loading_the_Resource_Database' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink> and <olink targetdoc='libX11' targetptr='Resource_Manager_Functions' +><citetitle>Xlib - C Language Interface</citetitle></olink>. </para> </sect4> <sect4 id="Creating_Argument_Lists"> <title>Creating Argument Lists</title> -<!-- .IN "argument lists" "" "@DEF@" --> +<indexterm significance="preferred"><primary>argument lists</primary></indexterm> <para> <!-- .LP --> To set up an argument list for the inline specification of widget attributes, you may use any of the four approaches discussed in this section. Each resource name has a global symbol associated with it. This global symbol has the form XtN<emphasis remap='I'>resource name</emphasis>. For example, the -symbol for ``foreground'' is <function>XtNforeground</function>. For further information, -see the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +symbol for <quote>foreground</quote> is <function>XtNforeground</function>. For further information, +see the <olink targetdoc='intrinsics' targetptr='intrinsics' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> <para> <!-- .LP --> Argument are specified by using the following structure: -<!-- .IN "ArgList" "" "@DEF@" --> -<!-- .IN "Arg" "" "@DEF@" --> +<indexterm significance="preferred"><primary>ArgList</primary></indexterm> +<indexterm significance="preferred"><primary>Arg</primary></indexterm> </para> <para> <!-- .LP --> @@ -1755,7 +1796,7 @@ static Arg arglist[] = { This approach is convenient for lists that do not need to be computed at runtime and makes adding or deleting new elements easy. The -<!-- .IN "XtNumber" --> +<indexterm><primary>XtNumber</primary></indexterm> <function>XtNumber</function> macro is used to compute the number of elements in the argument list, preventing simple programming errors: @@ -1765,7 +1806,7 @@ preventing simple programming errors: <literallayout class="monospaced"> XtCreateWidget(<emphasis remap='I'>name</emphasis>, <emphasis remap='I'>class</emphasis>, <emphasis remap='I'>parent</emphasis>, <emphasis remap='I'>arglist</emphasis>, XtNumber(<emphasis remap='I'>arglist</emphasis>)); </literallayout> -<!-- .IN "XtSetArg" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XtSetArg</primary></indexterm> </para> <para> <!-- .LP --> @@ -1805,13 +1846,13 @@ XtSetArg(arglist[i], XtNheight, 300); i++; The i variable can then be used as the argument list count in the widget create function. In this example, -<!-- .IN "XtNumber" --> +<indexterm><primary>XtNumber</primary></indexterm> <function>XtNumber</function> would return 10, not 2, and therefore is not useful. <!-- .NT --> You should not use auto-increment or auto-decrement within the first argument to -<function>XtSetArg .</function> +<function>XtSetArg</function>. As it is currently implemented, <function>XtSetArg</function> is a macro that dereferences the first argument twice. @@ -1837,7 +1878,7 @@ arglist[1].value = (XtArgVal) 300; <para> <!-- .LP --> Note that in this example, as in the previous example, -<!-- .IN "XtNumber" --> +<indexterm><primary>XtNumber</primary></indexterm> <function>XtNumber</function> would return 10, not 2, and therefore would not be useful. </para> @@ -1862,7 +1903,7 @@ arglist[1].value = (XtArgVal) 300; <para> <!-- .LP --> In this example, -<!-- .IN "XtNumber" --> +<indexterm><primary>XtNumber</primary></indexterm> <function>XtNumber</function> can be used, as in the first approach, for easier code maintenance. </para> @@ -1874,7 +1915,7 @@ can be used, as in the first approach, for easier code maintenance. <!-- .XS --> <!-- Example Programs --> <!-- .XE --> -<!-- .IN "examples" --> +<indexterm><primary>examples</primary></indexterm> <para> <!-- .LP --> The best way to understand how to use any programming library is by diff --git a/lib/libXaw/specs/CH3.xml b/lib/libXaw/specs/CH3.xml index 37ee8b5ae..563f92edb 100644 --- a/lib/libXaw/specs/CH3.xml +++ b/lib/libXaw/specs/CH3.xml @@ -4,7 +4,8 @@ <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="CH3.intro.xml"/> --> <para> Each of these widgets performs a specific user interface function. They -are <emphasis remap='I'>simple</emphasis> because they cannot have widget children\(emthey may only +are <emphasis remap='I'>simple</emphasis> because they cannot have widget +children—they may only be used as leaves of the widget tree. These widgets display information or take user input. </para> diff --git a/lib/libXaw/specs/CH4.xml b/lib/libXaw/specs/CH4.xml index 0546af551..90b510938 100644 --- a/lib/libXaw/specs/CH4.xml +++ b/lib/libXaw/specs/CH4.xml @@ -68,7 +68,7 @@ also provided as part of the Athena widget set. <!-- .XS --> <!-- Using the Menus --> <!-- .XE --> -<!-- .IN "Menus" "using" --> +<indexterm><primary>Menus</primary><secondary>using</secondary></indexterm> <para> <!-- .LP --> The default configuration for the menus is press-drag-release. @@ -76,10 +76,10 @@ The menus will typically be activated by clicking a pointer button while the pointer is over a MenuButton, causing the menu to appear in a fixed location relative to that button; this is a <function>pulldown</function> menu. Menus may also be activated -<!-- .IN "Menus" "pulldown" --> +<indexterm><primary>Menus</primary><secondary>pulldown</secondary></indexterm> when a specific pointer and/or key sequence is used anywhere in the application; this is a <function>popup</function> menu (e.g. clicking Ctrl-<pointer -<!-- .IN "Menus" "popup" --> +<indexterm><primary>Menus</primary><secondary>popup</secondary></indexterm> button 1> in the common application <function>xterm</function>). In this case the menu should be positioned under the cursor. Typically menus will be placed so the pointer cursor is on @@ -96,7 +96,9 @@ and causes any mechanism associated with this entry to be invoked. </para> </sect1> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Sme.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="SimpleMenu.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="SmeBSB.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="SmeLine.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Sme.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="MenuButton.xml"/> </chapter> diff --git a/lib/libXaw/specs/CH5.xml b/lib/libXaw/specs/CH5.xml index 2636aff1e..caa9dfa0d 100644 --- a/lib/libXaw/specs/CH5.xml +++ b/lib/libXaw/specs/CH5.xml @@ -13,8 +13,9 @@ ease customization. The AsciiText widget class (actually not limited to ASCII but so named for compatibility) is be general enough to most needs. If more flexibility, special features, or extra functionality is needed, they can be added by implementing a new TextSource or TextSink, or -by subclassing the Text Widget (See Section 5.8 for customization -details.) <!-- xref --> +by subclassing the Text Widget +(<link linkend='Customizing_the_Text_Widget'>See Section 5.8</link> +for customization details.) </para> <para> The words <emphasis remap='I'>insertion point</emphasis> are used in this chapter to refer to the text @@ -45,7 +46,7 @@ append-only mode. </para> <sect1 id="Text_Widget_for_Users"> <title>Text Widget for Users</title> -<!-- .IN "Text widget" "User's Guide to the Text widget" --> +<indexterm><primary>Text widget</primary><secondary>User's Guide to the Text widget</secondary></indexterm> <!-- .XS --> <!-- Text Widget for Users --> <!-- .XE --> @@ -58,7 +59,7 @@ read-only text widget), the X server will beep. </para> <sect2 id="Default_Key_Bindings"> <title>Default Key Bindings</title> -<!-- .IN "Text widget" "default key bindings" --> +<indexterm><primary>Text widget</primary><secondary>default key bindings</secondary></indexterm> <para> <!-- .LP --> The default key bindings are patterned after those in the EMACS text editor: @@ -125,8 +126,8 @@ programmer can modify them by changing the Text widget's </sect2> <sect2 id="Search_and_Replace"> <title>Search and Replace</title> -<!-- .IN "Text widget" "search" --> -<!-- .IN "Text widget" "query replace" --> +<indexterm><primary>Text widget</primary><secondary>search</secondary></indexterm> +<indexterm><primary>Text widget</primary><secondary>query replace</secondary></indexterm> <para> <!-- .LP --> The Text widget provides a search popup that can be used to search for a @@ -259,7 +260,7 @@ Text <name of Text widget> <title>File Insertion</title> <para> <!-- .LP --> -<!-- .IN "Text widget" "file insertion" --> +<indexterm><primary>Text widget</primary><secondary>file insertion</secondary></indexterm> To insert a file into a text widget, type the key sequence <emphasis remap='I'>Meta-i</emphasis>, which will activate the file insert popup. This popup will appear under the pointer, and any text typed while the focus is in this popup will be @@ -295,7 +296,7 @@ Text <name of Text widget> <title>Text Selections for Users</title> <para> <!-- .LP --> -<!-- .IN "Text widget" "Text Selections for Users" --> +<indexterm><primary>Text widget</primary><secondary>Text Selections for Users</secondary></indexterm> The text widgets have a text selection mechanism that allows the user to copy pieces of the text into the <function>PRIMARY</function> selection, and paste @@ -387,11 +388,12 @@ To unset the text selection, click pointer button 1 without moving it. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="TextActions_text_widget_actions.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="TextActions_default_translation_bindings.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="TextFuncs.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AsciiText.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AsciiSource.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AsciiSink.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="TextCustom.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Text.xml"/> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="TextSink.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="TextSource.xml"/> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AsciiSink.xml"/> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AsciiSource.xml"/> -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AsciiText.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="TextSink.xml"/> + </chapter> diff --git a/lib/libXaw/specs/CH6.xml b/lib/libXaw/specs/CH6.xml index 84243870f..19a32af90 100644 --- a/lib/libXaw/specs/CH6.xml +++ b/lib/libXaw/specs/CH6.xml @@ -88,21 +88,23 @@ application programmer. <!-- .LP --> If the application wishes to change the size or location of any widget it should make a call to <xref linkend='XtSetValues' xrefstyle='select: title'/>. This will -<!-- .IN "XtSetValues" "" --> +<indexterm><primary>XtSetValues</primary></indexterm> allow the widget to ask its parent for the new size or location. As noted above the parent is allowed to refuse this request, and the child must live with the result. If the application is unable to achieve the desired semantics, then perhaps it should use a different composite widget. Under no circumstances should an application programmer resort to <function>XtMoveWidget</function> or -<!-- .IN "XtMoveWidget" "" --> +<indexterm><primary>XtMoveWidget</primary></indexterm> <function>XtResizeWidget</function>; these functions are exclusively for the use of -<!-- .IN "XtResizeWidget" "" --> +<indexterm><primary>XtResizeWidget</primary></indexterm> Composite widget implementors. </para> <para> <!-- .LP --> -For more information on geometry management consult the <emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +For more information on geometry management consult the +<olink targetdoc='intrinsics' targetptr='Geometry_Management' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> </note> diff --git a/lib/libXaw/specs/CH7.xml b/lib/libXaw/specs/CH7.xml index a84e3cf5a..3b015b611 100644 --- a/lib/libXaw/specs/CH7.xml +++ b/lib/libXaw/specs/CH7.xml @@ -64,7 +64,7 @@ writing the new widget if an existing widget class Expose, Resize and/or GeometryManager method can be used by the subclass. </para> <para> -Note that some trivial uses of a ``bare-bones'' widget may be achieved by +Note that some trivial uses of a <quote>bare-bones</quote> widget may be achieved by simply creating an instance of the Core widget. The class variable to use when creating a Core widget is <function>widgetClass</function>. @@ -112,9 +112,12 @@ un-necessarily waste many resources. In this section, an outline will be given of the procedure to follow to construct a special-purpose widget to address the items listed above. The reader should refer to the appropriate sections of the -<emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis> -for complete details of the material outlined here. Section 1.4 of -the <emphasis remap='I'>Intrinsics</emphasis> should be read in +<olink targetdoc='intrinsics' targetptr='intrinsics' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink> +for complete details of the material outlined here. +<olink targetdoc='intrinsics' targetptr='Widgets' +>Section 1.4 of the <citetitle>Intrinsics</citetitle></olink> +should be read in conjunction with this section. </para> <para> @@ -150,11 +153,11 @@ widget implementation can be merged into other application code. <para> In the following example, the public header file -<function>< X11/Xaw/Template.h ></function>, +<filename class="headerfile"><X11/Xaw/Template.h></filename>, the private header file -<function>< X11/Xaw/TemplateP.h ></function> +<filename class="headerfile"><X11/Xaw/TemplateP.h></filename> and the source code file -<function>< X11/Xaw/Template.c ></function> +<filename class="headerfile"><X11/Xaw/Template.c></filename> will be modified to produce the "WindowWidget" described above. In each case, the files have been designed so that a global string replacement of "Template" and "template" diff --git a/lib/libXaw/specs/Command.xml b/lib/libXaw/specs/Command.xml index 92d1b7253..d9f0ce7bd 100644 --- a/lib/libXaw/specs/Command.xml +++ b/lib/libXaw/specs/Command.xml @@ -3,19 +3,19 @@ <!-- .XS --> <!-- Command Widget --> <!-- .XE --> -<!-- .IN "Command widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Command widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application header file <X11/Xaw/Command.h> -<!-- .IN "Command.h" "" --> +<indexterm><primary>Command.h</primary></indexterm> Class header file <X11/Xaw/CommandP.h> -<!-- .IN "CommandP.h" "" --> +<indexterm><primary>CommandP.h</primary></indexterm> Class commandWidgetClass -<!-- .IN "commandWidgetClass" "" --> +<indexterm><primary>commandWidgetClass</primary></indexterm> Class Name Command -<!-- .IN "Command widget" "class name" --> +<indexterm><primary>Command widget</primary><secondary>class name</secondary></indexterm> Superclass Label <!-- .sp --> </literallayout> @@ -23,7 +23,7 @@ Superclass Label <!-- .LP --> The Command widget is an area, often rectangular, that contains text or a graphical image. Command widgets are often referred to as -``push buttons.'' When the pointer is over a Command widget, the +<quote>push buttons.</quote> When the pointer is over a Command widget, the widget becomes highlighted by drawing a rectangle around its perimeter. This highlighting indicates that the widget is ready for selection. When mouse button 1 is pressed, the Command widget indicates that @@ -44,7 +44,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Command widget" "resources" --> +<indexterm><primary>Command widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -334,7 +334,7 @@ retrieved from the argument list or from the resource database: </tbody> </tgroup> </informaltable> -\" Resource Descriptions +<!-- \" Resource Descriptions --> <!-- .Ac --> <!-- .As --> <!-- .Bg --> @@ -375,7 +375,7 @@ retrieved from the argument list or from the resource database: </sect2> <sect2 id="Command_Actions"> <title>Command Actions</title> -<!-- .IN "Command widget" "actions" --> +<indexterm><primary>Command widget</primary><secondary>actions</secondary></indexterm> <para> <!-- .LP --> The Command widget supports the following actions: @@ -401,7 +401,7 @@ and unhighlighted states with <function>highlight</function> and <function>unhig </itemizedlist> <para> <!-- .LP --> -<!-- .IN "Command widget" "translation bindings" --> +<indexterm><primary>Command widget</primary><secondary>translation bindings</secondary></indexterm> The following are the default translation bindings used by the Command widget: </para> @@ -410,10 +410,10 @@ Command widget: <literallayout class="monospaced"> <!-- .TA .5i 2.25i --> <!-- .ta .5i 2.25i --> - <EnterWindow>: highlight(\|) - <LeaveWindow>: reset(\|) - <Btn1Down>: set(\|) - <Btn1Up>: notify(\|) unset(\|) + <EnterWindow>: highlight( ) + <LeaveWindow>: reset( ) + <Btn1Down>: set( ) + <Btn1Up>: notify( ) unset( ) </literallayout> </para> <para> @@ -436,7 +436,7 @@ understood by this action procedure. If no argument is passed, </varlistentry> <varlistentry> <term> - <function>unhighlight</function>(\|) + <function>unhighlight</function>( ) </term> <listitem> <para> @@ -448,7 +448,7 @@ Command widget. </varlistentry> <varlistentry> <term> - <function>set</function>(\|) + <function>set</function>( ) </term> <listitem> <para> @@ -461,7 +461,7 @@ action causes the button to display its interior in the </varlistentry> <varlistentry> <term> - <function>unset</function>(\|) + <function>unset</function>( ) </term> <listitem> <para> @@ -473,7 +473,7 @@ Cancels the <emphasis remap='I'>set</emphasis> state and displays the interior o </varlistentry> <varlistentry> <term> - <function>reset</function>(\|) + <function>reset</function>( ) </term> <listitem> <para> @@ -485,7 +485,7 @@ in the <function>foreground</function> color. </varlistentry> <varlistentry> <term> - <function>notify</function>(\|) + <function>notify</function>( ) </term> <listitem> <para> diff --git a/lib/libXaw/specs/Dialog.xml b/lib/libXaw/specs/Dialog.xml index aff03d7ec..dad555784 100644 --- a/lib/libXaw/specs/Dialog.xml +++ b/lib/libXaw/specs/Dialog.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- Dialog Widget --> <!-- .XE --> -<!-- .IN "Dialog widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Dialog widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application Header file <X11/Xaw/Dialog.h> -<!-- .IN "Dialog.h" "" --> +<indexterm><primary>Dialog.h</primary></indexterm> Class Header file <X11/Xaw/DialogP.h> -<!-- .IN "DialogP.h" "" --> +<indexterm><primary>DialogP.h</primary></indexterm> Class dialogWidgetClass -<!-- .IN "dialogWidgetClass" "" --> +<indexterm><primary>dialogWidgetClass</primary></indexterm> Class Name Dialog -<!-- .IN "Dialog widget" "class name" --> +<indexterm><primary>Dialog widget</primary><secondary>class name</secondary></indexterm> Superclass Form <!-- .sp --> </literallayout> @@ -46,7 +46,7 @@ areas may be omitted by the application. <!-- .LP --> When creating a Dialog widget instance, the following resources are retrieved from the argument list or the resource database: -<!-- .IN "Dialog widget" "resources" --> +<indexterm><primary>Dialog widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -300,7 +300,7 @@ specified then set this resource to "" (empty string). <title>Constraint Resources</title> <para> <!-- .LP --> -<!-- .IN "Dialog widget" "constraint resources" --> +<indexterm><primary>Dialog widget</primary><secondary>constraint resources</secondary></indexterm> Each child of the Dialog widget may request special layout resources be applied to it. These <emphasis remap='I'>constraint</emphasis> resources allow the Dialog widget's children to specify individual layout requirements. @@ -424,7 +424,7 @@ resizable If this resource is False then the parent </sect2> <sect2 id='Dialog::Layout_Semantics'> <title>Layout Semantics</title> -<!-- .IN "Dialog widget" "layout semantics" --> +<indexterm><primary>Dialog widget</primary><secondary>layout semantics</secondary></indexterm> <para> The Dialog widget uses two different sets of layout seman- tics. One is used when initially laying out the children. @@ -530,7 +530,7 @@ edges of the Dialog, and to never resize. </sect3> <sect3 id="Special_Considerations"> <title>Special Considerations</title> -<!-- .IN "Dialog widget" "special considerations" --> +<indexterm><primary>Dialog widget</primary><secondary>special considerations</secondary></indexterm> <para> <!-- .LP --> The Dialog widget automatically sets the <function>top</function> and <function>bottom</function> @@ -544,7 +544,7 @@ Command button without having to specify its constraints. <para> <!-- .LP --> The Dialog will also set <function>fromLeft</function> to the last button in the -<!-- .IN "fromLeft" "" --> +<indexterm><primary>fromLeft</primary></indexterm> Dialog for each new button added to the Dialog widget. </para> <para> @@ -558,14 +558,14 @@ own Dialog policy. </sect2> <sect2 id='Automatically_Created_Children'> <title>Automatically Created Children.</title> -<!-- .IN "Dialog widget" "automatically created children" --> +<indexterm><primary>Dialog widget</primary><secondary>automatically created children</secondary></indexterm> <para> <!-- .LP --> The Dialog uses Label widgets to contain the <function>label</function> and <function>icon</function>. These widgets are named <emphasis remap='I'>label</emphasis> and <emphasis remap='I'>icon</emphasis> respectively. The Dialog <function>value</function> is contained in an AsciiText widget whose name is <function>value</function>. Using <function>XtNameToWidget</function> the application can change -<!-- .IN "XtNameToWidget" "" --> +<indexterm><primary>XtNameToWidget</primary></indexterm> those resources associated with each of these widgets that are not available through the Dialog widget itself. </para> @@ -579,7 +579,7 @@ available through the Dialog widget itself. <!-- .LP --> To return the character string in the text field, use <!-- .PN XawDialogGetValueString . --> -<!-- .IN "XawDialogGetValueString" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawDialogGetValueString</primary></indexterm> <funcsynopsis id='XawDialogGetValueString'> <funcprototype> <funcdef>String<function> XawDialogGetValueString</function></funcdef> @@ -609,14 +609,14 @@ remain valid and unchanged until another call to <function>value</function> widget, when the string will be automatically freed, and a new string is returned. This string may be freed earlier by calling the function <xref linkend='XawAsciiSourceFreeString' xrefstyle='select: title'/>. -<!-- .IN "XawAsciiSourceFreeString" "" --> +<indexterm><primary>XawAsciiSourceFreeString</primary></indexterm> </para> <para> <!-- .LP --> <!-- .sp --> To add a new button to the Dialog widget use <xref linkend='XawDialogAddButton' xrefstyle='select: title'/>. -<!-- .IN "XawDialogAddButton" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawDialogAddButton</primary></indexterm> <funcsynopsis id='XawDialogAddButton'> <funcprototype> <funcdef>void<function> XawDialogAddButton</function></funcdef> diff --git a/lib/libXaw/specs/Form.xml b/lib/libXaw/specs/Form.xml index a6e0a0c3b..c0370a871 100644 --- a/lib/libXaw/specs/Form.xml +++ b/lib/libXaw/specs/Form.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- Form Widget --> <!-- .XE --> -<!-- .IN "Form widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Form widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application Header file <X11/Xaw/Form.h> -<!-- .IN "Form.h" "" --> +<indexterm><primary>Form.h</primary></indexterm> Class Header file <X11/Xaw/FormP.h> -<!-- .IN "FormP.h" "" --> +<indexterm><primary>FormP.h</primary></indexterm> Class formWidgetClass -<!-- .IN "formWidgetClass" "" --> +<indexterm><primary>formWidgetClass</primary></indexterm> Class Name Form -<!-- .IN "Form widget" "class name" --> +<indexterm><primary>Form widget</primary><secondary>class name</secondary></indexterm> Superclass Constraint <!-- .sp --> </literallayout> @@ -51,7 +51,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Form widget" "resources" --> +<indexterm><primary>Form widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -247,7 +247,7 @@ retrieved from the argument list or from the resource database: <title>Constraint Resources</title> <para> <!-- .LP --> -<!-- .IN "Form widget" "constraint resources" --> +<indexterm><primary>Form widget</primary><secondary>constraint resources</secondary></indexterm> Each child of the Form widget may request special layout resources be applied to it. These <emphasis remap='I'>constraint</emphasis> resources allow the Form widget's children to specify individual layout requirements. @@ -486,8 +486,8 @@ Form, and never to resize. <!-- .LP --> To force or defer a re-layout of the Form, use <!-- .PN XawFormDoLayout . --> -<!-- .IN "Form widget" "re-layout" --> -<!-- .IN "XawFormDoLayout" "" "@DEF@" --> +<indexterm><primary>Form widget</primary><secondary>re-layout</secondary></indexterm> +<indexterm significance="preferred"><primary>XawFormDoLayout</primary></indexterm> <funcsynopsis id='XawFormDoLayout'> <funcprototype> <funcdef>void<function> XawFormDoLayout</function></funcdef> diff --git a/lib/libXaw/specs/Grip.xml b/lib/libXaw/specs/Grip.xml index 73dd5a7ad..76ad5590d 100644 --- a/lib/libXaw/specs/Grip.xml +++ b/lib/libXaw/specs/Grip.xml @@ -3,19 +3,19 @@ <!-- .XS --> <!-- Grip Widget --> <!-- .XE --> -<!-- .IN "Grip widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Grip widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application header file <X11/Xaw/Grip.h> -<!-- .IN "Grip.h" "" --> +<indexterm><primary>Grip.h</primary></indexterm> Class header file <X11/Xaw/GripP.h> -<!-- .IN "GripP.h" "" --> +<indexterm><primary>GripP.h</primary></indexterm> Class gripWidgetClass -<!-- .IN "gripWidgetClass" "" --> +<indexterm><primary>gripWidgetClass</primary></indexterm> Class Name Grip -<!-- .IN "Grip widget" "class name" --> +<indexterm><primary>Grip widget</primary><secondary>class name</secondary></indexterm> Superclass Simple <!-- .sp --> </literallayout> @@ -35,7 +35,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Grip widget" "resources" --> +<indexterm><primary>Grip widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -290,12 +290,12 @@ used to flood fill the entire Grip widget. </sect2> <sect2 id="Grip_Actions"> <title>Grip Actions</title> -<!-- .IN "Grip widget" "actions" --> +<indexterm><primary>Grip widget</primary><secondary>actions</secondary></indexterm> <para> <!-- .LP --> The Grip widget does not declare any default event translation bindings, but it does declare a single action routine named <function>GripAction</function>. The -<!-- .IN "Grip widget" "GripAction routine" --> +<indexterm><primary>Grip widget</primary><secondary>GripAction routine</secondary></indexterm> client specifies an arbitrary event translation table, optionally giving parameters to the <function>GripAction</function> routine. </para> @@ -311,8 +311,8 @@ header file. <literallayout class="monospaced"> <!-- .TA .5i 2.25i --> <!-- .ta .5i 2.25i --> -<!-- .IN "XawGripCallData" "" "@DEF@" --> -<!-- .IN "XawGripCallDataRec" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawGripCallData</primary></indexterm> +<indexterm significance="preferred"><primary>XawGripCallDataRec</primary></indexterm> <!-- .sp --> typedef struct _XawGripCallData { XEvent *event; @@ -320,9 +320,9 @@ typedef struct _XawGripCallData { Cardinal num_params; } XawGripCallDataRec, *XawGripCallData, GripCallDataRec, *GripCallData; /* supported for R4 compatibility */ -<!-- .IN "XawGripCallDataRec" "" --> -<!-- .IN "XawGripCallData" "" --> -<!-- .IN "GripCallData" "" --> +<indexterm><primary>XawGripCallDataRec</primary></indexterm> +<indexterm><primary>XawGripCallData</primary></indexterm> +<indexterm><primary>GripCallData</primary></indexterm> <!-- .sp --> </literallayout> </para> @@ -332,7 +332,7 @@ In this structure, the <emphasis remap='I'>event</emphasis> is a pointer to the triggered the action. <emphasis remap='I'>params</emphasis> and <emphasis remap='I'>num_params</emphasis> give the string parameters specified in the translation table for the particular event binding. -<!-- .IN "Grip widget" "GripAction table" --> +<indexterm><primary>Grip widget</primary><secondary>GripAction table</secondary></indexterm> </para> <para> <!-- .LP --> @@ -350,7 +350,8 @@ The following is an example of a translation table that uses the GripAction: <!-- .sp --> </literallayout> For a complete description of the format of translation tables, see the -<emphasis remap='I'>X Toolkit Intrinsics - C Language Interface</emphasis>. +<olink targetdoc='intrinsics' targetptr='Translation_Management' +><citetitle>X Toolkit Intrinsics - C Language Interface</citetitle></olink>. </para> </sect2> diff --git a/lib/libXaw/specs/Label.xml b/lib/libXaw/specs/Label.xml index 65c4a9261..0b145db33 100644 --- a/lib/libXaw/specs/Label.xml +++ b/lib/libXaw/specs/Label.xml @@ -3,19 +3,19 @@ <!-- .XS --> <!-- Label Widget --> <!-- .XE --> -<!-- .IN "Label widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Label widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application header file <X11/Xaw/Label.h> -<!-- .IN "Label.h" "" --> +<indexterm><primary>Label.h</primary></indexterm> Class header file <X11/Xaw/LabelP.h> -<!-- .IN "LabelP.h" "" --> +<indexterm><primary>LabelP.h</primary></indexterm> Class labelWidgetClass -<!-- .IN "labelWidgetClass" "" --> +<indexterm><primary>labelWidgetClass</primary></indexterm> Class Name Label -<!-- .IN "Label widget" "class name" --> +<indexterm><primary>Label widget</primary><secondary>class name</secondary></indexterm> Superclass Simple <!-- .sp --> </literallayout> @@ -41,7 +41,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Label widget" "resources" --> +<indexterm><primary>Label widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> diff --git a/lib/libXaw/specs/List.xml b/lib/libXaw/specs/List.xml index 2c541dcd0..acf20cbcd 100644 --- a/lib/libXaw/specs/List.xml +++ b/lib/libXaw/specs/List.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- List Widget --> <!-- .XE --> -<!-- .IN "List widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>List widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application header file <X11/Xaw/List.h> -<!-- .IN "List.h" "" --> +<indexterm><primary>List.h</primary></indexterm> Class header file <X11/Xaw/ListP.h> -<!-- .IN "ListP.h" "" --> +<indexterm><primary>ListP.h</primary></indexterm> Class listWidgetClass -<!-- .IN "listWidgetClass" "" --> +<indexterm><primary>listWidgetClass</primary></indexterm> Class Name List -<!-- .IN "List widget" "class name" --> +<indexterm><primary>List widget</primary><secondary>class name</secondary></indexterm> Superclass Simple <!-- .sp --> </literallayout> @@ -39,7 +39,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "List widget" "resources" --> +<indexterm><primary>List widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -443,7 +443,7 @@ used to paint the text of the list elements. </varlistentry> <varlistentry> <term> - \fPinternalHeight\fP + <function>internalHeight</function> </term> <listitem> <para> @@ -454,7 +454,7 @@ used to paint the text of the list elements. </varlistentry> <varlistentry> <term> - \fPinternalWidth\fP + <function>internalWidth</function> </term> <listitem> <para> @@ -541,7 +541,7 @@ presented in column major order. </sect2> <sect2 id="List_Actions"> <title>List Actions</title> -<!-- .IN "List widget" "actions" --> +<indexterm><primary>List widget</primary><secondary>actions</secondary></indexterm> <para> <!-- .LP --> The List widget supports the following actions: @@ -562,14 +562,14 @@ Processing application callbacks with <function>Notify</function> <para> <!-- .LP --> The following is the default translation table used by the List Widget: -<!-- .IN "List widget" "default translation table" --> +<indexterm><primary>List widget</primary><secondary>default translation table</secondary></indexterm> </para> <para> <!-- .LP --> <literallayout class="monospaced"> <!-- .TA .5i 2.25i --> <!-- .ta .5i 2.25i --> -<Btn1Down>,<Btn1Up>: Set(\|) Notify(\|) +<Btn1Down>,<Btn1Up>: Set( ) Notify( ) <!-- .sp --> </literallayout> </para> @@ -579,7 +579,7 @@ The full list of actions supported by List widget is: <variablelist> <varlistentry> <term> - <function>Set</function>(\|) + <function>Set</function>( ) </term> <listitem> <para> @@ -593,7 +593,7 @@ element will be <emphasis remap='I'>unset</emphasis>. </varlistentry> <varlistentry> <term> - <function>Unset</function>(\|) + <function>Unset</function>( ) </term> <listitem> <para> @@ -604,7 +604,7 @@ and redraws it with normal foreground and background colors. </varlistentry> <varlistentry> <term> - <function>Notify</function>(\|) + <function>Notify</function>( ) </term> <listitem> <para> @@ -619,7 +619,7 @@ about the currently selected list element is passed in the </sect2> <sect2 id="List_Callbacks"> <title>List Callbacks</title> -<!-- .IN "List widget" "callbacks" --> +<indexterm><primary>List widget</primary><secondary>callbacks</secondary></indexterm> <para> <!-- .LP --> All procedures on the List widget's callback list will have a @@ -630,12 +630,12 @@ structure is defined in the List widget's application header file. <literallayout class="monospaced"> <!-- .TA .5i 2.25i --> <!-- .ta .5i 2.25i --> -<!-- .IN "XawListReturnStruct" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawListReturnStruct</primary></indexterm> typedef struct _XawListReturnStruct { String string; /* string shown in the list. */ int list_index; /* index of the item selected. */ } XawListReturnStruct; -<!-- .IN "XawListReturnStruct" "" --> +<indexterm><primary>XawListReturnStruct</primary></indexterm> <!-- .NT --> </literallayout> <note><para> @@ -650,8 +650,8 @@ operating systems, and had to be changed. <para> <!-- .LP --> To change the list that is displayed, use -<function>XawListChange .</function> -<!-- .IN "XawListChange" "" "@DEF@" --> +<function>XawListChange</function>. +<indexterm significance="preferred"><primary>XawListChange</primary></indexterm> <funcsynopsis id='XawListChange'> <funcprototype> <funcdef>void<function> XawListChange</function></funcdef> @@ -736,8 +736,8 @@ has been changed again with this function or with <xref linkend='XtSetValues' xr <para> <!-- .LP --> To highlight an item in the list, use -<function>XawListHighlight .</function> -<!-- .IN "XawListHighlight" "" "@DEF@" --> +<function>XawListHighlight</function>. +<indexterm significance="preferred"><primary>XawListHighlight</primary></indexterm> <funcsynopsis id='XawListHighlight'> <funcprototype> <funcdef>void<function> XawListHighlight</function></funcdef> @@ -784,8 +784,8 @@ the highlighted item is unhighlighted before the new item is highlighted. <para> <!-- .LP --> To unhighlight the currently highlighted item in the list, use -<function>XawListUnhighlight .</function> -<!-- .IN "XawListUnhighlight" "" "@DEF@" --> +<function>XawListUnhighlight</function>. +<indexterm significance="preferred"><primary>XawListUnhighlight</primary></indexterm> <funcsynopsis id='XawListUnhighlight'> <funcprototype> <funcdef>void<function> XawListUnhighlight</function></funcdef> @@ -812,8 +812,8 @@ Specifies the List widget. <para> <!-- .LP --> To retrieve the list element that is currently <emphasis remap='I'>set</emphasis>, use -<function>XawListShowCurrent .</function> -<!-- .IN "XawListShowCurrent" "" "@DEF@" --> +<function>XawListShowCurrent</function>. +<indexterm significance="preferred"><primary>XawListShowCurrent</primary></indexterm> <funcsynopsis id='XawListShowCurrent'> <funcprototype> <funcdef>XawListReturnStruct<function> *XawListShowCurrent</function></funcdef> @@ -842,7 +842,7 @@ returns a pointer to an structure, containing the currently highlighted item. If the value of the index member is XAW_LIST_NONE, -<!-- .IN "XAW_LIST_NONE" --> +<indexterm><primary>XAW_LIST_NONE</primary></indexterm> the string member is undefined, and no item is currently selected. </para> </sect2> @@ -850,11 +850,11 @@ the string member is undefined, and no item is currently selected. <title>Restrictions</title> <para> <!-- .LP --> -Many programmers create a ``scrolled list'' by putting a List +Many programmers create a <quote>scrolled list</quote> by putting a List widget with many entries as a child of a Viewport widget. The List continues to create a window as big as its contents, but that big window is only visible where it intersects the parent -Viewport's window. (I.e., it is ``clipped.'') +Viewport's window. (I.e., it is <quote>clipped.</quote>) </para> <para> <!-- .LP --> diff --git a/lib/libXaw/specs/Makefile.in b/lib/libXaw/specs/Makefile.in index ef1ae100c..4044162f9 100644 --- a/lib/libXaw/specs/Makefile.in +++ b/lib/libXaw/specs/Makefile.in @@ -67,7 +67,8 @@ POST_UNINSTALL = : build_triplet = @build@ host_triplet = @host@ DIST_COMMON = $(am__dist_shelf_DATA_DIST) $(srcdir)/Makefile.am \ - $(srcdir)/Makefile.in $(top_srcdir)/docbook.am + $(srcdir)/Makefile.in $(srcdir)/libXaw.ent.in \ + $(top_srcdir)/docbook.am @ENABLE_SPECS_TRUE@@HAVE_STYLESHEETS_TRUE@@HAVE_XMLTO_TRUE@am__append_1 = $(docbook:.xml=.html) @ENABLE_SPECS_TRUE@@HAVE_STYLESHEETS_TRUE@@HAVE_XMLTO_TEXT_TRUE@@HAVE_XMLTO_TRUE@am__append_2 = $(docbook:.xml=.txt) @ENABLE_SPECS_TRUE@@HAVE_FOP_TRUE@@HAVE_STYLESHEETS_TRUE@@HAVE_XMLTO_TRUE@am__append_3 = $(docbook:.xml=.pdf) \ @@ -81,7 +82,7 @@ am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/config.h -CONFIG_CLEAN_FILES = +CONFIG_CLEAN_FILES = libXaw.ent CONFIG_CLEAN_VPATH_FILES = AM_V_P = $(am__v_P_@AM_V@) am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) @@ -285,6 +286,7 @@ pdfdir = @pdfdir@ prefix = @prefix@ program_transform_name = @program_transform_name@ psdir = @psdir@ +runstatedir = @runstatedir@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ @@ -439,6 +441,8 @@ $(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) $(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh $(am__aclocal_m4_deps): +libXaw.ent: $(top_builddir)/config.status $(srcdir)/libXaw.ent.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ mostlyclean-libtool: -rm -f *.lo diff --git a/lib/libXaw/specs/MenuButton.xml b/lib/libXaw/specs/MenuButton.xml index b7df723bb..c73b0e0d8 100644 --- a/lib/libXaw/specs/MenuButton.xml +++ b/lib/libXaw/specs/MenuButton.xml @@ -1,21 +1,21 @@ -<sect2 id="MenuButton_Widget"> +<sect1 id="MenuButton_Widget"> <title>MenuButton Widget</title> <!-- .XS --> <!-- MenuButton Widget --> <!-- .XE --> -<!-- .IN "MenuButton widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>MenuButton widget</primary></indexterm> <!-- .sp --> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> Application Header file <X11/Xaw/MenuButton.h> -<!-- .IN "MenuButton.h" "" --> +<indexterm><primary>MenuButton.h</primary></indexterm> Class Header file <X11/Xaw/MenuButtonP.h> -<!-- .IN "MenuButtonP.h" "" --> +<indexterm><primary>MenuButtonP.h</primary></indexterm> Class menuButtonWidgetClass -<!-- .IN "menuButtonWidgetClass" "" --> +<indexterm><primary>menuButtonWidgetClass</primary></indexterm> Class Name MenuButton -<!-- .IN "MenuButton widget" "class name" --> +<indexterm><primary>MenuButton widget</primary><secondary>class name</secondary></indexterm> Superclass Command </literallayout> <para> @@ -38,7 +38,7 @@ that the MenuButton is ready for selection. When a pointer button is pressed, the MenuButton widget will pop up the menu named in the <function>menuName</function> resource. </para> -<sect3 id="Resources"> +<sect2 id="MenuButton::Resources"> <title>Resources</title> <para> <!-- .LP --> @@ -48,7 +48,7 @@ or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "MenuButton widget" "resources" --> +<indexterm><primary>MenuButton widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -410,10 +410,10 @@ nonvolatile memory. </varlistentry> </variablelist> </para> -</sect3> -<sect3 id="MenuButton_Actions"> +</sect2> +<sect2 id="MenuButton_Actions"> <title>MenuButton Actions</title> -<!-- .IN "MenuButton widget" "actions" --> +<indexterm><primary>MenuButton widget</primary><secondary>actions</secondary></indexterm> <para> <!-- .LP --> The MenuButton widget supports the following actions: @@ -453,13 +453,13 @@ MenuButton widget: <literallayout class="monospaced"> <!-- .TA .5i 2.25i --> <!-- .ta .5i 2.25i --> - <EnterWindow>: highlight(\|) - <LeaveWindow>: reset(\|) - <BtnDown>: reset(\|) PopupMenu(\) + <EnterWindow>: highlight( ) + <LeaveWindow>: reset( ) + <BtnDown>: reset( ) PopupMenu(\) </literallayout> </para> -</sect3> -<sect3 id='MenuButton_Actions_b'> +</sect2> +<sect2 id='MenuButton_Actions_b'> <title>MenuButton Actions</title> <para> <!-- .LP --> @@ -481,7 +481,7 @@ understood by this action procedure. If no argument is passed, </varlistentry> <varlistentry> <term> - <function>unhighlight</function>(\|) + <function>unhighlight</function>( ) </term> <listitem> <para> @@ -493,7 +493,7 @@ MenuButton widget. </varlistentry> <varlistentry> <term> - <function>set</function>(\|) + <function>set</function>( ) </term> <listitem> <para> @@ -506,7 +506,7 @@ action causes the button to display its interior in the </varlistentry> <varlistentry> <term> - <function>unset</function>(\|) + <function>unset</function>( ) </term> <listitem> <para> @@ -518,7 +518,7 @@ Cancels the <emphasis remap='I'>set</emphasis> state and displays the interior o </varlistentry> <varlistentry> <term> - <function>reset</function>(\|) + <function>reset</function>( ) </term> <listitem> <para> @@ -530,7 +530,7 @@ button in the <function>background</function> color, with the label displayed in </varlistentry> <varlistentry> <term> - <function>notify</function>(\|) + <function>notify</function>( ) </term> <listitem> <para> @@ -542,7 +542,7 @@ the call_data argument in these callback functions is undefined. </varlistentry> <varlistentry> <term> - <function>PopupMenu</function>(\|) + <function>PopupMenu</function>( ) </term> <listitem> <para> @@ -563,5 +563,5 @@ in the application initialization routine, or use a different translation. <!-- .bp --> </para> -</sect3> </sect2> +</sect1> diff --git a/lib/libXaw/specs/Paned.xml b/lib/libXaw/specs/Paned.xml index 6ab2f1d90..e23802bcf 100644 --- a/lib/libXaw/specs/Paned.xml +++ b/lib/libXaw/specs/Paned.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- Paned Widget --> <!-- .XE --> -<!-- .IN "Paned widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Paned widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application Header file <X11/Xaw/Paned.h> -<!-- .IN "Paned.h" "" --> +<indexterm><primary>Paned.h</primary></indexterm> Class Header file <X11/Xaw/PanedP.h> -<!-- .IN "PanedP.h" "" --> +<indexterm><primary>PanedP.h</primary></indexterm> Class panedWidgetClass -<!-- .IN "panedWidgetClass" "" --> +<indexterm><primary>panedWidgetClass</primary></indexterm> Class Name Paned -<!-- .IN "Paned widget" "class name" --> +<indexterm><primary>Paned widget</primary><secondary>class name</secondary></indexterm> Superclass Constraint <!-- .sp --> </literallayout> @@ -37,7 +37,7 @@ adding a Grip as its own pane will confuse the Paned widget. </para> <sect2 id="Using_the_Paned_Widget"> <title>Using the Paned Widget</title> -<!-- .IN "Paned widget" "using" --> +<indexterm><primary>Paned widget</primary><secondary>using</secondary></indexterm> <para> <!-- .LP --> The grips allow the panes to be resized by the user. The semantics of @@ -104,7 +104,7 @@ retrieved from the argument list or the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Paned widget" "resources" --> +<indexterm><primary>Paned widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -578,9 +578,9 @@ number of panes. <para> The orientation to stack the panes. This value can be either <function>XtorientVertical</function> or <function>XtorientHorizontal</function>. -<!-- .IN "XtorientVertical" "" --> -<!-- .IN "XtorientHorizontal" "" --> -<!-- .IN "conversions" "Orientation" --> +<indexterm><primary>XtorientVertical</primary></indexterm> +<indexterm><primary>XtorientHorizontal</primary></indexterm> +<indexterm><primary>conversions</primary><secondary>Orientation</secondary></indexterm> <!-- .Rs "vertical \fPand\fB horizontal" --> </para> </listitem> @@ -609,7 +609,7 @@ widget. <title>Constraint Resources</title> <para> <!-- .LP --> -<!-- .IN "Paned widget" "constraint resources" --> +<indexterm><primary>Paned widget</primary><secondary>constraint resources</secondary></indexterm> Each child of the Paned widget may request special layout resources be applied to it. These <emphasis remap='I'>constraint</emphasis> resources allow the Paned widget's children to specify individual layout requirements. @@ -779,7 +779,7 @@ forced to be resized. See <function>Layout Semantics</function> for details. <title>Layout Semantics</title> <para> <!-- .LP --> -<!-- .IN "Paned widget" "layout semantics" --> +<indexterm><primary>Paned widget</primary><secondary>layout semantics</secondary></indexterm> In order to make effective use of the Paned widget it is helpful to know the rules it uses to determine which child will be resized in any given situation. There are three rules used to determine which child is @@ -913,7 +913,7 @@ Translation table. <!-- .TA .5i 2.25i --> <!-- .ta .5i 2.25i --> <Btn1Down>: GripAction(Start, UpLeftPane) -<!-- .IN "GripAction" "" --> +<indexterm><primary>GripAction</primary></indexterm> <Btn2Down>: GripAction(Start, ThisBorderOnly) <Btn3Down>: GripAction(Start, LowRightPane) <Btn1Motion>: GripAction(Move, UpLeftPane) @@ -926,7 +926,7 @@ Translation table. <para> <!-- .LP --> The Paned widget interprets the <function>GripAction</function> as taking two arguments. -<!-- .IN "GripAction" "" --> +<indexterm><primary>GripAction</primary></indexterm> The first argument may be any of the following: <variablelist> <varlistentry> @@ -974,12 +974,12 @@ grip's inactive cursor. No second argument is needed in this case. <title>Convenience Routines</title> <para> <!-- .LP --> -<!-- .IN "Paned widget" "enable pane resizing" --> -<!-- .IN "Paned widget" "disable pane resizing" --> +<indexterm><primary>Paned widget</primary><secondary>enable pane resizing</secondary></indexterm> +<indexterm><primary>Paned widget</primary><secondary>disable pane resizing</secondary></indexterm> To enable or disable a child's request for pane resizing, use <function>XawPanedAllowResize :</function> -<!-- .IN "XawPanedAllowResize" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawPanedAllowResize</primary></indexterm> <funcsynopsis id='XawPanedAllowResize'> <funcprototype> <funcdef>void<function> XawPanedAllowResize</function></funcdef> @@ -1025,10 +1025,10 @@ constraint resource for the child. <para> <!-- .LP --> <!-- .sp --> -<!-- .IN "Paned widget" "change height settings" --> +<indexterm><primary>Paned widget</primary><secondary>change height settings</secondary></indexterm> To change the minimum and maximum height settings for a pane, use <function>XawPanedSetMinMax :</function> -<!-- .IN "XawPanedSetMinMax" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawPanedSetMinMax</primary></indexterm> <funcsynopsis id='XawPanedSetMinMax'> <funcprototype> <funcdef>void<function> XawPanedSetMinMax</function></funcdef> @@ -1078,10 +1078,10 @@ constraint resources for the child. <para> <!-- .LP --> <!-- .sp --> -<!-- .IN "Paned widget" "get height settings" --> +<indexterm><primary>Paned widget</primary><secondary>get height settings</secondary></indexterm> To retrieve the minimum and maximum height settings for a pane, use <function>XawPanedGetMinMax :</function> -<!-- .IN "XawPanedGetMinMax" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawPanedGetMinMax</primary></indexterm> <funcsynopsis id='XawPanedGetMinMax'> <funcprototype> <funcdef>void<function> XawPanedGetMinMax</function></funcdef> @@ -1131,12 +1131,12 @@ resources for this child child. <para> <!-- .LP --> <!-- .sp --> -<!-- .IN "Paned widget" "enable auto-reconfiguring" --> -<!-- .IN "Paned widget" "disable auto-reconfiguring" --> +<indexterm><primary>Paned widget</primary><secondary>enable auto-reconfiguring</secondary></indexterm> +<indexterm><primary>Paned widget</primary><secondary>disable auto-reconfiguring</secondary></indexterm> To enable or disable automatic recalculation of pane sizes and positions, use <function>XawPanedSetRefigureMode :</function> -<!-- .IN "XawPanedSetRefigureMode" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawPanedSetRefigureMode</primary></indexterm> <funcsynopsis id='XawPanedSetRefigureMode'> <funcprototype> <funcdef>void<function> XawPanedSetRefigureMode</function></funcdef> @@ -1178,10 +1178,10 @@ relayout until after all changes have been made. <para> <!-- .LP --> <!-- .sp --> -<!-- .IN "Paned widget" "getting the number of children" --> +<indexterm><primary>Paned widget</primary><secondary>getting the number of children</secondary></indexterm> To retrieve the number of panes in a paned widget use <xref linkend='XawPanedGetNumSub' xrefstyle='select: title'/>: -<!-- .IN "XawPanedGetNumSub" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawPanedGetNumSub</primary></indexterm> <funcsynopsis id='XawPanedGetNumSub'> <funcprototype> <funcdef>int<function> XawPanedGetNumSub</function></funcdef> diff --git a/lib/libXaw/specs/Panner.xml b/lib/libXaw/specs/Panner.xml index f886af0dd..60f08bbb9 100644 --- a/lib/libXaw/specs/Panner.xml +++ b/lib/libXaw/specs/Panner.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- Panner Widget --> <!-- .XE --> -<!-- .IN "Panner widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Panner widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application header file <X11/Xaw/Panner.h> -<!-- .IN "Panner.h" "" --> +<indexterm><primary>Panner.h</primary></indexterm> Class header file <X11/Xaw/PannerP.h> -<!-- .IN "PannerP.h" "" --> +<indexterm><primary>PannerP.h</primary></indexterm> Class pannerWidgetClass -<!-- .IN "pannerWidgetClass" "" --> +<indexterm><primary>pannerWidgetClass</primary></indexterm> Class Name Panner -<!-- .IN "Panner widget" "class name" --> +<indexterm><primary>Panner widget</primary><secondary>class name</secondary></indexterm> Superclass Simple <!-- .sp --> </literallayout> @@ -25,9 +25,9 @@ Superclass Simple <para> <!-- .LP --> A Panner widget is a rectangle, called the -``canvas,'' on which another rectangle, the ``slider,'' moves in two +<quote>canvas,</quote> on which another rectangle, the <quote>slider,</quote> moves in two dimensions. It is often used with a Porthole widget to move, or -``scroll,'' a third widget in two dimensions, in which case the +<quote>scroll,</quote> a third widget in two dimensions, in which case the slider's size and position gives feedback as to what portion of the third widget is visible. </para> @@ -50,7 +50,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Panner widget" "resources" --> +<indexterm><primary>Panner widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -563,7 +563,7 @@ The size of the slider. </sect2> <sect2 id="Panner_Actions"> <title>Panner Actions</title> -<!-- .IN "Panner widget" "actions" --> +<indexterm><primary>Panner widget</primary><secondary>actions</secondary></indexterm> <para> <!-- .LP --> The actions supported by the Panner widget are: @@ -620,7 +620,7 @@ action procedure). <para> This action moves the slider by the specified amounts. The format for the amounts is a signed or unsigned floating-point number (e.g., +1.0 -or \-.5) followed +or -.5) followed by either <function>p</function> indicating pages (slider sizes), or <function>c</function> indicating canvas sizes. Thus, <emphasis remap='I'>page(+0,+.5p)</emphasis> represents vertical movement down one-half the height of the slider and <emphasis remap='I'>page(0,0)</emphasis> represents moving to @@ -658,23 +658,23 @@ may have one of the values <function>on</function>, <function>off</function>, or <!-- .LP --> <!-- .sp --> The default bindings for Panner are: -<!-- .IN "Panner widget" "default translation table" --> +<indexterm><primary>Panner widget</primary><secondary>default translation table</secondary></indexterm> </para> <!-- .LP --> <literallayout class="monospaced"> <!-- .TA .5i 1.75i --> <!-- .ta .5i 1.75i --> - <Btn1Down>: start(\|) - <Btn1Motion>: move(\|) - <Btn1Up>: notify(\|) stop(\|) - <Btn2Down>: abort(\|) + <Btn1Down>: start( ) + <Btn1Motion>: move( ) + <Btn1Up>: notify( ) stop( ) + <Btn2Down>: abort( ) <Key>KP_Enter: set(rubberband,toggle) <Key>space: page(+1p,+1p) - <Key>Delete: page(\-1p,\-1p) - <Key>BackSpace: page(\-1p,\-1p) - <Key>Left: page(\-.5p,+0) + <Key>Delete: page(-1p,-1p) + <Key>BackSpace: page(-1p,-1p) + <Key>Left: page(-.5p,+0) <Key>Right: page(+.5p,+0) - <Key>Up: page(+0,\-.5p) + <Key>Up: page(+0,-.5p) <Key>Down: page(+0,+.5p) <Key>Home: page(0,0) </literallayout> @@ -682,12 +682,12 @@ The default bindings for Panner are: <sect2 id="Panner_Callbacks"> <title>Panner Callbacks</title> -<!-- .IN "Panner widget" "callbacks" --> +<indexterm><primary>Panner widget</primary><secondary>callbacks</secondary></indexterm> <para> <!-- .LP --> The functions registered on the <function>reportCallback</function> list are invoked by the <function>notify</function> action as follows: -<!-- .IN "ReportProc" "" "@DEF@" --> +<indexterm significance="preferred"><primary>ReportProc</primary></indexterm> <funcsynopsis id='Panner::ReportProc'> <funcprototype> <funcdef>void<function> ReportProc</function></funcdef> diff --git a/lib/libXaw/specs/Porthole.xml b/lib/libXaw/specs/Porthole.xml index 04525780c..fba03265a 100644 --- a/lib/libXaw/specs/Porthole.xml +++ b/lib/libXaw/specs/Porthole.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- Porthole Widget --> <!-- .XE --> -<!-- .IN "Porthole widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Porthole widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application Header file <X11/Xaw/Porthole.h> -<!-- .IN "Porthole.h" "" --> +<indexterm><primary>Porthole.h</primary></indexterm> Class Header file <X11/Xaw/PortholeP.h> -<!-- .IN "PortholeP.h" "" --> +<indexterm><primary>PortholeP.h</primary></indexterm> Class portholeWidgetClass -<!-- .IN "portholeWidgetClass" "" --> +<indexterm><primary>portholeWidgetClass</primary></indexterm> Class Name Porthole -<!-- .IN "Porthole widget" "class name" --> +<indexterm><primary>Porthole widget</primary><secondary>class name</secondary></indexterm> Superclass Composite <!-- .sp --> </literallayout> @@ -38,7 +38,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Porthole widget" "resources" --> +<indexterm><primary>Porthole widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -244,7 +244,7 @@ size or position. </sect2> <sect2 id='Porthole::Layout_Semantics'> <title>Layout Semantics</title> -<!-- .IN "Porthole widget" "layout semantics" --> +<indexterm><primary>Porthole widget</primary><secondary>layout semantics</secondary></indexterm> <para> <!-- .LP --> The Porthole widget allows its managed child to request any size @@ -256,12 +256,12 @@ Panner widget. </sect2> <sect2 id="Porthole_Callbacks"> <title>Porthole Callbacks</title> -<!-- .IN "Porthole widget" "callbacks" --> +<indexterm><primary>Porthole widget</primary><secondary>callbacks</secondary></indexterm> <para> <!-- .LP --> The functions registered on the <function>reportCallback</function> list are invoked whenever the managed child changes size or position: -<!-- .IN "ReportProc" "" "@DEF@" --> +<indexterm significance="preferred"><primary>ReportProc</primary></indexterm> <funcsynopsis id='Porthole::ReportProc'> <funcprototype> <funcdef>void<function> ReportProc</function></funcdef> diff --git a/lib/libXaw/specs/Repeater.xml b/lib/libXaw/specs/Repeater.xml index 289e14dd6..8eaa64ce5 100644 --- a/lib/libXaw/specs/Repeater.xml +++ b/lib/libXaw/specs/Repeater.xml @@ -3,26 +3,27 @@ <!-- .XS --> <!-- Repeater Widget --> <!-- .XE --> -<!-- .IN "Repeater widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Repeater widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application header file <X11/Xaw/Repeater.h> -<!-- .IN "Repeater.h" "" --> +<indexterm><primary>Repeater.h</primary></indexterm> Class header file <X11/Xaw/RepeaterP.h> -<!-- .IN "RepeaterP.h" "" --> +<indexterm><primary>RepeaterP.h</primary></indexterm> Class repeaterWidgetClass -<!-- .IN "repeaterWidgetClass" "" --> +<indexterm><primary>repeaterWidgetClass</primary></indexterm> Class Name Repeater -<!-- .IN "Repeater widget" "class name" --> +<indexterm><primary>Repeater widget</primary><secondary>class name</secondary></indexterm> Superclass Command <!-- .sp --> </literallayout> <para> <!-- .LP --> -The Repeater widget is a subclass of the Command widget; see the <!-- xref --> -Command documentation for details. The difference is that the Repeater can call its +The Repeater widget is a subclass of the Command widget; see the +<link linkend='Command_Widget'>Command documentation</link> +for details. The difference is that the Repeater can call its registered callbacks repeatedly, at an increasing rate. The default translation does so for the duration the user holds down pointer button 1 while the pointer is on the Repeater. @@ -36,7 +37,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Repeater widget" "resources" --> +<indexterm><primary>Repeater widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -500,7 +501,7 @@ is set to NULL. </sect2> <sect2 id="Repeater_Actions"> <title>Repeater Actions</title> -<!-- .IN "Repeater widget" "actions" --> +<indexterm><primary>Repeater widget</primary><secondary>actions</secondary></indexterm> <para> <!-- .LP --> The Repeater widget supports the following actions beyond those of the Command @@ -535,7 +536,7 @@ further timers from occuring until the next <function>start</function> action. <para> <!-- .LP --> <!-- .sp --> -<!-- .IN "Repeater widget" "translation bindings" --> +<indexterm><primary>Repeater widget</primary><secondary>translation bindings</secondary></indexterm> The following are the default translation bindings used by the Repeater widget: </para> @@ -544,10 +545,10 @@ Repeater widget: <literallayout class="monospaced"> <!-- .TA .5i 2.25i --> <!-- .ta .5i 2.25i --> - <EnterWindow>: highlight(\|) - <LeaveWindow>: unhighlight(\|) - <Btn1Down>: set(\|) start(\|) - <Btn1Up>: stop(\|) unset(\|) + <EnterWindow>: highlight( ) + <LeaveWindow>: unhighlight( ) + <Btn1Down>: set( ) start( ) + <Btn1Up>: stop( ) unset( ) </literallayout> </para> <para> diff --git a/lib/libXaw/specs/Scrollbar.xml b/lib/libXaw/specs/Scrollbar.xml index f5d055343..a9f1ff634 100644 --- a/lib/libXaw/specs/Scrollbar.xml +++ b/lib/libXaw/specs/Scrollbar.xml @@ -10,12 +10,12 @@ Superclass Simple </literallayout> <para> -A Scrollbar widget is a rectangle, called the ``canvas,'' on -which another rectangle, the ``thumb,'' moves in one +A Scrollbar widget is a rectangle, called the <quote>canvas,</quote> on +which another rectangle, the <quote>thumb,</quote> moves in one dimension, either vertically or horizontally. A Scrollbar can be used alone, as a value generator, or it can be used within a composite widget (for example, a Viewport). When a -Scrollbar is used to move, or ``scroll,'' the contents of +Scrollbar is used to move, or <quote>scroll,</quote> the contents of another widget, the size and the position of the thumb usually give feedback as to what portion of the other widget's contents are visible. @@ -389,8 +389,8 @@ used to draw the thumb. <listitem> <para> All functions on this callback list are called when the -<function>NotifyThumb</function> action is invoked. See the <function>Scrollbar -Actions</function> section for details. +<function>NotifyThumb</function> action is invoked. See +<xref linkend="Scrollbar_Actions" /> for details. </para> </listitem> </varlistentry> @@ -463,8 +463,8 @@ This cursor is used when scrolling forward in a horizontal scrollbar. <listitem> <para> All functions on this callback list may be called when the -<function>NotifyScroll</function> action is invoked. See the \fBScrollbar -Actions\fP section for details. +<function>NotifyScroll</function> action is invoked. See +<xref linkend="Scrollbar_Actions" /> for details. </para> </listitem> </varlistentry> @@ -590,7 +590,7 @@ callbacks. </varlistentry> <varlistentry> <term> - <function>EndScroll</function>(\^) + <function>EndScroll</function>( ) </term> <listitem> <para> @@ -600,7 +600,7 @@ This must be the last action after a movement is complete. </varlistentry> <varlistentry> <term> - <function>MoveThumb</function>(\^) + <function>MoveThumb</function>( ) </term> <listitem> <para> @@ -610,7 +610,7 @@ Repositions the Scrollbar's thumb to the current pointer location. </varlistentry> <varlistentry> <term> - <function>NotifyThumb</function>(\^)\ + <function>NotifyThumb</function>( )\ </term> <listitem> <para> @@ -624,15 +624,15 @@ pointer as a percentage of the scroll bar length. </variablelist> <para> The default bindings for Scrollbar are: -<!-- .IN "Scrollbar widget" "default translation table" --> +<indexterm><primary>Scrollbar widget</primary><secondary>default translation table</secondary></indexterm> </para> <literallayout class="monospaced"> <Btn1Down>: StartScroll(Forward) - <Btn2Down>: StartScroll(Continuous) MoveThumb(\|) NotifyThumb(\|) + <Btn2Down>: StartScroll(Continuous) MoveThumb( ) NotifyThumb( ) <Btn3Down>: StartScroll(Backward) - <Btn2Motion>: MoveThumb(\|) NotifyThumb(\|) - <BtnUp>: NotifyScroll(Proportional) EndScroll(\|) + <Btn2Motion>: MoveThumb( ) NotifyThumb( ) + <BtnUp>: NotifyScroll(Proportional) EndScroll( ) </literallayout> <para> @@ -644,14 +644,14 @@ resource file are: *Scrollbar.Translations: \\ ~Meta<Key>space: StartScroll(Forward) NotifyScroll(FullLength) \\n\\ Meta<Key>space: StartScroll(Backward) NotifyScroll(FullLength) \\n\\ - EndScroll(\|) + EndScroll( ) </literallayout> </sect2> <sect2 id="Scrollbar_Callbacks"> <title>Scrollbar Callbacks</title> -<!-- .IN "Scrollbar widget" "callbacks" --> +<indexterm><primary>Scrollbar widget</primary><secondary>callbacks</secondary></indexterm> <para> <!-- .LP --> There are two callback lists provided by the Scrollbar widget. @@ -661,7 +661,7 @@ The procedural interface for these functions is described here. <para> <!-- .LP --> The calling interface to the <function>scrollProc</function> callback procedure is: -<!-- .IN "ScrollProc" "" "@DEF@" --> +<indexterm significance="preferred"><primary>ScrollProc</primary></indexterm> </para> <funcsynopsis id='ScrollProc'> <funcprototype> @@ -719,7 +719,7 @@ be greater than the length of the Scrollbar. <para> The calling interface to the <function>jumpProc</function> callback procedure is: </para> -<!-- .IN "jumpProc" "" "@DEF@" --> +<indexterm significance="preferred"><primary>jumpProc</primary></indexterm> <funcsynopsis id='JumpProc'> <funcprototype> <funcdef>void<function> JumpProc</function></funcdef> @@ -757,7 +757,7 @@ Specifies the client data. </term> <listitem> <para> -Specifies the floating point position of the thumb (0.0 \- 1.0). +Specifies the floating point position of the thumb (0.0 – 1.0). </para> </listitem> </varlistentry> @@ -787,10 +787,10 @@ Scrollbar. <sect2 id="Convenience_Routines"> <title>Convenience Routines</title> <para> -<!-- .IN "Scrollbar widget" "setting thumb values" --> +<indexterm><primary>Scrollbar widget</primary><secondary>setting thumb values</secondary></indexterm> To set the position and length of a Scrollbar thumb, use <!-- .PN XawScrollbarSetThumb . --> -<!-- .IN "XawScrollbarSetThumb" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawScrollbarSetThumb</primary></indexterm> </para> <funcsynopsis id='XawScrollbarSetThumb'> <funcprototype> @@ -838,8 +838,8 @@ of the Scrollbar. <para> <function>XawScrollbarThumb</function> -moves the visible thumb to a new position (0.0 \- 1.0) and length (0.0 \- 1.0). -Either the top or shown arguments can be specified as \-1.0, +moves the visible thumb to a new position (0.0 – 1.0) and length (0.0 – 1.0). +Either the top or shown arguments can be specified as -1.0, in which case the current value is left unchanged. Values greater than 1.0 are truncated to 1.0. </para> @@ -852,7 +852,7 @@ If called from <function>jumpProc</function>, <xref linkend='XawScrollbarSetThum <sect2 id="Setting_Float_Resources"> <title>Setting Float Resources</title> -<!-- .IN "float resources" "setting" --> +<indexterm><primary>float resources</primary><secondary>setting</secondary></indexterm> <para> The <function>shown</function> and <function>topOfThumb</function> resources are of type <emphasis remap='I'>float</emphasis>. These resources can be difficult to get into an @@ -865,16 +865,16 @@ getting a float into an argument list. top = 0.5; if (sizeof(float) > sizeof(XtArgVal)) { /* - \ * If a float is larger than an XtArgVal then pass this - \ * resource value by reference. - \ */ + * If a float is larger than an XtArgVal then pass this + * resource value by reference. + */ XtSetArg(args[0], XtNshown, &top); } else { /* - \ * Convince C not to perform an automatic conversion, which - \ * would truncate 0.5 to 0. - \ */ + * Convince C not to perform an automatic conversion, which + * would truncate 0.5 to 0. + */ XtArgVal * l_top = (XtArgVal *) &top; XtSetArg(args[0], XtNshown, *l_top); } diff --git a/lib/libXaw/specs/Simple.xml b/lib/libXaw/specs/Simple.xml index 0d32f744c..d2206978d 100644 --- a/lib/libXaw/specs/Simple.xml +++ b/lib/libXaw/specs/Simple.xml @@ -3,19 +3,19 @@ <!-- .XS --> <!-- Simple Widget --> <!-- .XE --> -<!-- .IN "Simple widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Simple widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application Header file <Xaw/Simple.h> -<!-- .IN "Simple.h" "" --> +<indexterm><primary>Simple.h</primary></indexterm> Class Header file <Xaw/SimpleP.h> -<!-- .IN "SimpleP.h" "" --> +<indexterm><primary>SimpleP.h</primary></indexterm> Class simpleWidgetClass -<!-- .IN "simpleWidgetClass" --> +<indexterm><primary>simpleWidgetClass</primary></indexterm> Class Name Simple -<!-- .IN "Simple widget" "class name" --> +<indexterm><primary>Simple widget</primary><secondary>class name</secondary></indexterm> Superclass Core <!-- .sp --> </literallayout> @@ -35,7 +35,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Simple widget" "resources" --> +<indexterm><primary>Simple widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> diff --git a/lib/libXaw/specs/SimpleMenu.xml b/lib/libXaw/specs/SimpleMenu.xml index a99608d67..a9572dd7b 100644 --- a/lib/libXaw/specs/SimpleMenu.xml +++ b/lib/libXaw/specs/SimpleMenu.xml @@ -1,21 +1,21 @@ -<sect2 id="SimpleMenu_Widget"> +<sect1 id="SimpleMenu_Widget"> <title>SimpleMenu Widget</title> <!-- .XS --> <!-- SimpleMenu Widget --> <!-- .XE --> -<!-- .IN "SimpleMenu widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>SimpleMenu widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application Header file <X11/Xaw/SimpleMenu.h> -<!-- .IN "SimpleMenu.h" "" --> +<indexterm><primary>SimpleMenu.h</primary></indexterm> Class Header file <X11/Xaw/SimpleMenP.h> -<!-- .IN "SimpleMenP.h" "" --> +<indexterm><primary>SimpleMenP.h</primary></indexterm> Class simpleMenuWidgetClass -<!-- .IN "simpleMenuWidgetClass" "" --> +<indexterm><primary>simpleMenuWidgetClass</primary></indexterm> Class Name SimpleMenu -<!-- .IN "SimpleMenu widget" "class name" --> +<indexterm><primary>SimpleMenu widget</primary><secondary>class name</secondary></indexterm> Superclass OverrideShell <!-- .sp --> </literallayout> @@ -28,11 +28,11 @@ only part of the menu that actually is associated with a window. The SimpleMenu serves as the glue to bind the individual menu entries together into a menu. </para> -<sect3 id="Resources"> +<sect2 id="SimpleMenu::Resources"> <title>Resources</title> <para> <!-- .LP --> -<!-- .IN "SimpleMenu widget" "resources" --> +<indexterm><primary>SimpleMenu widget</primary><secondary>resources</secondary></indexterm> </para> <para> <!-- .LP --> @@ -326,7 +326,7 @@ that will affect the entire menu. </term> <listitem> <para> -<!-- .IN "conversions" "BackingStore" --> +<indexterm><primary>conversions</primary><secondary>BackingStore</secondary></indexterm> Determines what type of backing store will be used for the menu. Legal values for this resource are <function>NotUseful</function>, <function>WhenMapped</function>, and <function>Always</function>. These values are the backing-store integers defined in @@ -440,7 +440,8 @@ Determines the value of the override_redirect attribute of the SimpleMenu's window. The override_redirect attribute of a window determines whether or not a window manager may interpose itself between this window and the root window of the display. For more information -see the <emphasis remap='I'>Interclient Communications Conventions Manual</emphasis>. +see the <olink targetdoc='icccm' targetptr='icccm' +><citetitle>Interclient Communications Conventions Manual</citetitle></olink>. </para> </listitem> </varlistentry> @@ -510,10 +511,10 @@ If this is <function>True</function> then save unders will be active on the menu </varlistentry> </variablelist> </para> -</sect3> -<sect3 id="SimpleMenu_Actions"> +</sect2> +<sect2 id="SimpleMenu_Actions"> <title>SimpleMenu Actions</title> -<!-- .IN "SimpleMenu widget" "actions" --> +<indexterm><primary>SimpleMenu widget</primary><secondary>actions</secondary></indexterm> <para> <!-- .LP --> The SimpleMenu widget supports the following actions: @@ -535,7 +536,7 @@ Processing menu entry callbacks with <function>notify</function> </itemizedlist> <para> <!-- .LP --> -<!-- .IN "SimpleMenu widget" "default translations" --> +<indexterm><primary>SimpleMenu widget</primary><secondary>default translations</secondary></indexterm> The following are the default translation bindings used by the SimpleMenu widget: </para> @@ -545,16 +546,16 @@ by the SimpleMenu widget: <literallayout class="monospaced"> <!-- .TA .5i 2.25i --> <!-- .ta .5i 2.25i --> - <EnterWindow>: highlight(\|) - <LeaveWindow>: unhighlight(\|) - <BtnMotion>: highlight(\|) - <BtnUp>: MenuPopdown(\|) notify(\|) unhighlight(\|) + <EnterWindow>: highlight( ) + <LeaveWindow>: unhighlight( ) + <BtnMotion>: highlight( ) + <BtnUp>: MenuPopdown( ) notify( ) unhighlight( ) </literallayout> <!-- .sp --> </para> <para> <!-- .LP --> -<!-- .IN "SimpleMenu widget" "MenuPopdown routine" --> +<indexterm><primary>SimpleMenu widget</primary><secondary>MenuPopdown routine</secondary></indexterm> The user can pop down the menu without activating any of the callback functions by releasing the pointer button when no menu item is highlighted. @@ -579,7 +580,7 @@ the menu entry. </varlistentry> <varlistentry> <term> - <function>unhighlight</function>(\|) + <function>unhighlight</function>( ) </term> <listitem> <para> @@ -590,7 +591,7 @@ its normal look. </varlistentry> <varlistentry> <term> - <function>notify</function>(\|) + <function>notify</function>( ) </term> <listitem> <para> @@ -607,17 +608,17 @@ appropriate action. <listitem> <para> This action is defined in <emphasis remap='I'>(xT</emphasis>. -<!-- .IN "SimpleMenu widget" "MenuPopdown routine" --> +<indexterm><primary>SimpleMenu widget</primary><secondary>MenuPopdown routine</secondary></indexterm> </para> </listitem> </varlistentry> </variablelist> </para> -</sect3> -<sect3 id="Positioning_the_SimpleMenu"> +</sect2> +<sect2 id="Positioning_the_SimpleMenu"> <title>Positioning the SimpleMenu</title> -<!-- .IN "XawPositionSimpleMenu" "" "@DEF@" --> -<!-- .IN "SimpleMenu widget" "positioning" "@DEF@" --> +<indexterm significance="preferred"><primary>XawPositionSimpleMenu</primary></indexterm> +<indexterm significance="preferred"><primary>SimpleMenu widget</primary><secondary>positioning</secondary></indexterm> <para> <!-- .LP --> If the SimpleMenu widget is to be used as a pulldown menu then the @@ -637,7 +638,7 @@ routine <xref linkend='XawSimpleMenuAddGlobalActions' xrefstyle='select: title'/ <para> <!-- .LP --> Translation writers should be aware that Xt does not register grabs on -``don't care'' modifiers, and therefore the left hand side of the +<quote>don't care</quote> modifiers, and therefore the left hand side of the production should be written to exclude unspecified modifiers. For example these are the translations needed to popup some of <function>xterm's</function> menus: @@ -677,20 +678,20 @@ placed so that the pointer cursor is centered on the entry named by the </varlistentry> </variablelist> </para> -</sect3> -<sect3 id="Convenience_Routines"> +</sect2> +<sect2 id="SimpleMenu::Convenience_Routines"> <title>Convenience Routines</title> -<sect4 id="Registering_the_Global_Action_Routines"> +<sect3 id="Registering_the_Global_Action_Routines"> <title>Registering the Global Action Routines</title> <para> <!-- .LP --> -<!-- .IN "XawPositionSimpleMenu" "" --> +<indexterm><primary>XawPositionSimpleMenu</primary></indexterm> The <function>XawPositionSimpleMenu</function> action routine may often be invoked before any menus have been created. This can occur when an application uses dynamic menu creation. In these cases an application will need to register this global action routine by calling <xref linkend='XawSimpleMenuAddGlobalActions' xrefstyle='select: title'/>: -<!-- .IN "XawSimpleMenuAddGlobalActions" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawSimpleMenuAddGlobalActions</primary></indexterm> <funcsynopsis id='XawSimpleMenuAddGlobalActions'> <funcprototype> <funcdef>void<function> XawSimpleMenuAddGlobalActions</function></funcdef> @@ -717,14 +718,14 @@ This function need only be called once per application and must be called before any widget that uses <function>XawPositionSimpleMenu</function> action is realized. </para> -</sect4> -<sect4 id="Getting_and_Clearing_the_Current_Menu_Entry"> +</sect3> +<sect3 id="Getting_and_Clearing_the_Current_Menu_Entry"> <title>Getting and Clearing the Current Menu Entry</title> <para> <!-- .LP --> To get the currently highlighted menu entry use <xref linkend='XawSimpleMenuGetActiveEntry' xrefstyle='select: title'/>: -<!-- .IN "XawSimpleMenuGetActiveEntry" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawSimpleMenuGetActiveEntry</primary></indexterm> <funcsynopsis id='XawSimpleMenuGetActiveEntry'> <funcprototype> <funcdef>Widget<function> XawSimpleMenuGetActiveEntry</function></funcdef> @@ -756,7 +757,7 @@ currently highlighted, or NULL if no entry is highlighted. To clear the SimpleMenu widget's internal information about the currently highlighted menu entry use <xref linkend='XawSimpleMenuClearActiveEntry' xrefstyle='select: title'/>: -<!-- .IN "XawSimpleMenuClearActiveEntry" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawSimpleMenuClearActiveEntry</primary></indexterm> <funcsynopsis id='XawSimpleMenuClearActiveEntry'> <funcprototype> <funcdef>Widget<function> XawSimpleMenuClearActiveEntry</function></funcdef> @@ -785,6 +786,6 @@ alter the appearance of the active entry. This function is primarily for use by implementors of menu entries. </para> -</sect4> </sect3> </sect2> +</sect1> diff --git a/lib/libXaw/specs/Sme.xml b/lib/libXaw/specs/Sme.xml index da3c4d15f..1e0d0e559 100644 --- a/lib/libXaw/specs/Sme.xml +++ b/lib/libXaw/specs/Sme.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- Sme Object --> <!-- .XE --> -<!-- .IN "Sme object" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Sme object</primary></indexterm> <!-- .sp --> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> Application Header file <X11/Xaw/Sme.h> -<!-- .IN "Sme.h" "" --> +<indexterm><primary>Sme.h</primary></indexterm> Class Header file <X11/Xaw/SmeP.h> -<!-- .IN "SmeP.h" "" --> +<indexterm><primary>SmeP.h</primary></indexterm> Class smeObjectClass -<!-- .IN "smeObjectClass" "" --> +<indexterm><primary>smeObjectClass</primary></indexterm> Class Name Sme -<!-- .IN "Sme object" "class name" --> +<indexterm><primary>Sme object</primary><secondary>class name</secondary></indexterm> Superclass RectObj </literallayout> <!-- .sp --> @@ -30,7 +30,7 @@ add blank space between menu entries. </para> <sect2 id='Sme::Resources'> <title>Resources</title> -<!-- .IN "SmeLine object" "resources" --> +<indexterm><primary>SmeLine object</primary><secondary>resources</secondary></indexterm> <para> <!-- .LP --> The resources associated with the SmeLine object are defined in this @@ -120,7 +120,7 @@ be the width of the widest entry. </sect2> <sect2 id="Subclassing_the_Sme_Object"> <title>Subclassing the Sme Object</title> -<!-- .IN "Sme object" "subclassing" "@DEF" --> +<indexterm significance="preferred"><primary>Sme object</primary><secondary>subclassing</secondary></indexterm> <para> <!-- .LP --> <!-- .sp --> @@ -135,33 +135,33 @@ semantics are not very interesting. <variablelist> <varlistentry> <term> - <function>Highlight</function>(\|) + <function>Highlight</function>( ) </term> <listitem> <para> -<!-- .IN "Sme object" "Highlight method" --> +<indexterm><primary>Sme object</primary><secondary>Highlight method</secondary></indexterm> Called to put the menu entry into the highlighted state. </para> </listitem> </varlistentry> <varlistentry> <term> - <function>Unhighlight</function>(\|) + <function>Unhighlight</function>( ) </term> <listitem> <para> -<!-- .IN "Sme object" "Unhighlight method" --> +<indexterm><primary>Sme object</primary><secondary>Unhighlight method</secondary></indexterm> Called to return the widget to its normal (unhighlighted) state. </para> </listitem> </varlistentry> <varlistentry> <term> - <function>Notify</function>(\|) + <function>Notify</function>( ) </term> <listitem> <para> -<!-- .IN "Sme object" "Notify method" --> +<indexterm><primary>Sme object</primary><secondary>Notify method</secondary></indexterm> Called when the user selects this menu entry. </para> </listitem> diff --git a/lib/libXaw/specs/SmeBSB.xml b/lib/libXaw/specs/SmeBSB.xml index 3636e2e02..c8168fa5f 100644 --- a/lib/libXaw/specs/SmeBSB.xml +++ b/lib/libXaw/specs/SmeBSB.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- SmeBSB Object --> <!-- .XE --> -<!-- .IN "SmeBSB object" "" "@DEF@" --> +<indexterm significance="preferred"><primary>SmeBSB object</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application Header file <X11/Xaw/SmeBSB.h> -<!-- .IN "SmeBSB.h" "" --> +<indexterm><primary>SmeBSB.h</primary></indexterm> Class Header file <X11/Xaw/SmeBSBP.h> -<!-- .IN "SmeBSBP.h" "" --> +<indexterm><primary>SmeBSBP.h</primary></indexterm> Class smeBSBObjectClass -<!-- .IN "smeBSBObjectClass" "" --> +<indexterm><primary>smeBSBObjectClass</primary></indexterm> Class Name SmeBSB -<!-- .IN "SmeBSB object" "class name" --> +<indexterm><primary>SmeBSB object</primary><secondary>class name</secondary></indexterm> Superclass Sme <!-- .sp --> </literallayout> @@ -34,7 +34,7 @@ of the 8 bit <function>font</function> utilized, or in a multi-byte encoding for </para> <sect2 id='SmeBSB::Resources'> <title>Resources</title> -<!-- .IN "SmeBSB object" "resources" --> +<indexterm><primary>SmeBSB object</primary><secondary>resources</secondary></indexterm> <para> <!-- .LP --> The resources associated with the SmeBSB object are defined in this section, diff --git a/lib/libXaw/specs/SmeLine.xml b/lib/libXaw/specs/SmeLine.xml index 96c920b70..433bc0f4d 100644 --- a/lib/libXaw/specs/SmeLine.xml +++ b/lib/libXaw/specs/SmeLine.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- SmeLine Object --> <!-- .XE --> -<!-- .IN "SmeLine object" "" "@DEF@" --> +<indexterm significance="preferred"><primary>SmeLine object</primary></indexterm> <!-- .sp --> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> Application Header file <X11/Xaw/SmeLine.h> -<!-- .IN "SmeLine.h" "" --> +<indexterm><primary>SmeLine.h</primary></indexterm> Class Header file <X11/Xaw/SmeLineP.h> -<!-- .IN "SmeLineP.h" "" --> +<indexterm><primary>SmeLineP.h</primary></indexterm> Class smeLineObjectClass -<!-- .IN "smeLineObjectClass" "" --> +<indexterm><primary>smeLineObjectClass</primary></indexterm> Class Name SmeLine -<!-- .IN "SmeLine object" "class name" --> +<indexterm><primary>SmeLine object</primary><secondary>class name</secondary></indexterm> Superclass Sme </literallayout> <!-- .sp --> @@ -32,7 +32,7 @@ will not highlight when the pointer cursor is over it. </para> <sect2 id='SmeLine::Resources'> <title>Resources</title> -<!-- .IN "SmeLine object" "resources" --> +<indexterm><primary>SmeLine object</primary><secondary>resources</secondary></indexterm> <para> <!-- .LP --> The resources associated with the SmeLine object are defined in this section, diff --git a/lib/libXaw/specs/StripChart.xml b/lib/libXaw/specs/StripChart.xml index 8d5c0648a..d892acebb 100644 --- a/lib/libXaw/specs/StripChart.xml +++ b/lib/libXaw/specs/StripChart.xml @@ -3,19 +3,19 @@ <!-- .XS --> <!-- StripChart Widget --> <!-- .XE --> -<!-- .IN "StripChart widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>StripChart widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application Header file <Xaw/StripChart.h> -<!-- .IN "StripChart.h" "" --> +<indexterm><primary>StripChart.h</primary></indexterm> Class Header file <Xaw/StripCharP.h> -<!-- .IN "StripCharP.h" "" --> +<indexterm><primary>StripCharP.h</primary></indexterm> Class stripChartWidgetClass -<!-- .IN "stripChartWidgetClass" "" --> +<indexterm><primary>stripChartWidgetClass</primary></indexterm> Class Name StripChart -<!-- .IN "StripChart widget" "class name" --> +<indexterm><primary>StripChart widget</primary><secondary>class name</secondary></indexterm> Superclass Simple <!-- .sp --> </literallayout> @@ -37,7 +37,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "StripChart widget" "resources" --> +<indexterm><primary>StripChart widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -369,7 +369,7 @@ and this point will be added to the right end of the StripChart. </sect2> <sect2 id="Getting_the_StripChart_Value"> <title>Getting the StripChart Value</title> -<!-- .IN "StripChart widget" "getting the value" --> +<indexterm><primary>StripChart widget</primary><secondary>getting the value</secondary></indexterm> <para> <!-- .LP --> The StripChart widget will call the application routine passed to it @@ -379,7 +379,7 @@ obtain another point for the StripChart graph. <para> <!-- .LP --> The calling interface for the <function>getValue</function> callback is: -<!-- .IN "StripChart widget" "getValue callback" "@DEF@" --> +<indexterm significance="preferred"><primary>StripChart widget</primary><secondary>getValue callback</secondary></indexterm> <funcsynopsis> <funcprototype> <funcdef><function> void</function>(*getValueProc)</funcdef> diff --git a/lib/libXaw/specs/TPage_Credits.xml b/lib/libXaw/specs/TPage_Credits.xml index bc07351ab..b141ad2eb 100644 --- a/lib/libXaw/specs/TPage_Credits.xml +++ b/lib/libXaw/specs/TPage_Credits.xml @@ -87,4 +87,12 @@ Frank Sheeran Omron Corporation 1994 </literallayout> +<para> +This document is made available to you in modern formats such as HTML and PDF +thanks to the efforts of Matt Dew, who converted the original troff sources to +DocBook/XML and edited them into shape; along with Gaetan Nadon and +Alan Coopersmith, who set up the formatting machinery in the libXaw builds and +performed further editing of the DocBook markup. +</para> + </chapter> diff --git a/lib/libXaw/specs/Template.xml b/lib/libXaw/specs/Template.xml index d9e2fc53d..6809acb08 100644 --- a/lib/libXaw/specs/Template.xml +++ b/lib/libXaw/specs/Template.xml @@ -10,7 +10,7 @@ operation, or to call a public routine implemented by the widget class. <para> <!-- .LP --> The contents of the Template public header file, -<function>< X11/Xaw/Template.h >, </function> +<filename class="headerfile"><X11/Xaw/Template.h></filename>, are: </para> <literallayout class="monospaced"> @@ -96,9 +96,9 @@ convenience procedures, so we need to add #define XtNdrawingColor2 "drawingColor2" #define XtNexposeCallback "exposeCallback" -extern Pixel WindowColor1(\|/* Widget */\|); -extern Pixel WindowColor2(\|/* Widget */\|); -extern Font\ \ WindowFont(\|/* Widget */\|); +extern Pixel WindowColor1( /* Widget */ ); +extern Pixel WindowColor2( /* Widget */ ); +extern Font WindowFont( /* Widget */ ); <!-- .CE --> </literallayout> <para> @@ -120,12 +120,12 @@ that will be required by anticipated subclasses of the widget. Information in the private header file is normally hidden from the application and is designed to be accessed only through other public procedures; e.g. -<function>XtSetValues .</function> +<function>XtSetValues</function>. </para> <para> <!-- .LP --> The contents of the Template private header file, -<function>< X11/Xaw/TemplateP.h >, </function> +<filename class="headerfile"><X11/Xaw/TemplateP.h></filename>, are: </para> <!-- .CB --> @@ -209,7 +209,7 @@ action routines added by the widget class. <para> <!-- .LP --> The contents of the Template implementation file, -<function>< X11/Xaw/Template.c >,</function> +<filename class="headerfile"><X11/Xaw/Template.c></filename>, are: </para> <!-- .CB --> @@ -239,46 +239,46 @@ static XtActionsRec actions[] = }; static char translations[] = -" <Key>: template(\|) \\n\\ +" <Key>: template( ) \\n\\ "; TemplateClassRec templateClassRec = { { /* core fields */ - /* superclass */ (WidgetClass) &widgetClassRec, - /* class_name */ "Template", - /* widget_size */ sizeof(TemplateRec), - /* class_initialize */ NULL, - /* class_part_initialize */ NULL, - /* class_inited */ FALSE, - /* initialize */ NULL, - /* initialize_hook */ NULL, - /* realize */ XtInheritRealize, - /* actions */ actions, - /* num_actions */ XtNumber(actions), - /* resources */ resources, - /* num_resources */ XtNumber(resources), - /* xrm_class */ NULLQUARK, - /* compress_motion */ TRUE, - /* compress_exposure */ TRUE, - /* compress_enterleave */ TRUE, - /* visible_interest */ FALSE, - /* destroy */ NULL, - /* resize */ NULL, - /* expose */ NULL, - /* set_values */ NULL, - /* set_values_hook */ NULL, - /* set_values_almost */ XtInheritSetValuesAlmost, - /* get_values_hook */ NULL, - /* accept_focus */ NULL, - /* version */ XtVersion, - /* callback_private */ NULL, - /* tm_table */ translations, - /* query_geometry */ XtInheritQueryGeometry, - /* display_accelerator */ XtInheritDisplayAccelerator, - /* extension */ NULL + /* superclass */ (WidgetClass) &widgetClassRec, + /* class_name */ "Template", + /* widget_size */ sizeof(TemplateRec), + /* class_initialize */ NULL, + /* class_part_initialize */ NULL, + /* class_inited */ FALSE, + /* initialize */ NULL, + /* initialize_hook */ NULL, + /* realize */ XtInheritRealize, + /* actions */ actions, + /* num_actions */ XtNumber(actions), + /* resources */ resources, + /* num_resources */ XtNumber(resources), + /* xrm_class */ NULLQUARK, + /* compress_motion */ TRUE, + /* compress_exposure */ TRUE, + /* compress_enterleave */ TRUE, + /* visible_interest */ FALSE, + /* destroy */ NULL, + /* resize */ NULL, + /* expose */ NULL, + /* set_values */ NULL, + /* set_values_hook */ NULL, + /* set_values_almost */ XtInheritSetValuesAlmost, + /* get_values_hook */ NULL, + /* accept_focus */ NULL, + /* version */ XtVersion, + /* callback_private */ NULL, + /* tm_table */ translations, + /* query_geometry */ XtInheritQueryGeometry, + /* display_accelerator */ XtInheritDisplayAccelerator, + /* extension */ NULL }, { /* template fields */ - /* empty */ 0 + /* empty */ 0 } }; @@ -339,8 +339,8 @@ and the default input binding will be to execute the input callbacks on </para> <literallayout class="monospaced"> static char translations[] = -" <Key>: input(\|) \\n\\ - <BtnDown>: input(\|) \\ +" <Key>: input( ) \\n\\ + <BtnDown>: input( ) \\ "; </literallayout> <!-- .CE --> @@ -399,7 +399,7 @@ Font WindowFont(w) <para> The "WindowWidget" is now complete. The application can retrieve the two drawing colors from the widget instance by calling either -<function>XtGetValues ,</function> +<function>XtGetValues</function>, or the <function>WindowColor</function> functions. The actual window created for the "WindowWidget" is available by calling the <function>XtWindow</function> function. diff --git a/lib/libXaw/specs/Template_private_header_file.xml b/lib/libXaw/specs/Template_private_header_file.xml index a26e92eef..b5f004254 100644 --- a/lib/libXaw/specs/Template_private_header_file.xml +++ b/lib/libXaw/specs/Template_private_header_file.xml @@ -8,12 +8,12 @@ that will be required by anticipated subclasses of the widget. Information in the private header file is normally hidden from the application and is designed to be accessed only through other public procedures; e.g. -<function>XtSetValues .</function> +<function>XtSetValues</function>. </para> <para> <!-- .LP --> The contents of the Template private header file, -<function>< X11/Xaw/TemplateP.h >, </function> +<filename class="headerfile"><X11/Xaw/TemplateP.h></filename>, are: </para> <!-- .CB --> diff --git a/lib/libXaw/specs/Template_public_header_file.xml b/lib/libXaw/specs/Template_public_header_file.xml index 6e8d609bc..eced84090 100644 --- a/lib/libXaw/specs/Template_public_header_file.xml +++ b/lib/libXaw/specs/Template_public_header_file.xml @@ -10,7 +10,7 @@ operation, or to call a public routine implemented by the widget class. <para> <!-- .LP --> The contents of the Template public header file, -<function>< X11/Xaw/Template.h >, </function> +<filename class="headerfile"><X11/Xaw/Template.h></filename>, are: </para> <literallayout class="monospaced"> @@ -30,18 +30,18 @@ are: /* Resources: - Name Class RepType Default Value - ---- ----- ------- ------------- - background Background Pixel XtDefaultBackground - border BorderColor Pixel XtDefaultForeground - borderWidth BorderWidth Dimension 1 - destroyCallback Callback Pointer NULL - height Height Dimension 0 - mappedWhenManaged MappedWhenManaged Boolean True - sensitive Sensitive Boolean True - width Width Dimension 0 - x Position Position 0 - y Position Position 0 + Name Class RepType Default Value + ---- ----- ------- ------------- + background Background Pixel XtDefaultBackground + border BorderColor Pixel XtDefaultForeground + borderWidth BorderWidth Dimension 1 + destroyCallback Callback Pointer NULL + height Height Dimension 0 + mappedWhenManaged MappedWhenManaged Boolean True + sensitive Sensitive Boolean True + width Width Dimension 0 + x Position Position 0 + y Position Position 0 */ @@ -84,11 +84,11 @@ convenience procedures, so we need to add <!-- .CB --> /* Resources: ... - callback Callback Callback NULL - drawingColor1 Color Pixel XtDefaultForeground - drawingColor2 Color Pixel XtDefaultForeground - exposeCallback Callback Callback NULL - font Font XFontStruct* XtDefaultFont + callback Callback Callback NULL + drawingColor1 Color Pixel XtDefaultForeground + drawingColor2 Color Pixel XtDefaultForeground + exposeCallback Callback Callback NULL + font Font XFontStruct* XtDefaultFont ... */ @@ -96,9 +96,9 @@ convenience procedures, so we need to add #define XtNdrawingColor2 "drawingColor2" #define XtNexposeCallback "exposeCallback" -extern Pixel WindowColor1(\|/* Widget */\|); -extern Pixel WindowColor2(\|/* Widget */\|); -extern Font\ \ WindowFont(\|/* Widget */\|); +extern Pixel WindowColor1( /* Widget */ ); +extern Pixel WindowColor2( /* Widget */ ); +extern Font WindowFont( /* Widget */ ); <!-- .CE --> </literallayout> <para> diff --git a/lib/libXaw/specs/Template_widget_source_file.xml b/lib/libXaw/specs/Template_widget_source_file.xml index 62ad1b69c..d446eee35 100644 --- a/lib/libXaw/specs/Template_widget_source_file.xml +++ b/lib/libXaw/specs/Template_widget_source_file.xml @@ -10,7 +10,7 @@ action routines added by the widget class. <para> <!-- .LP --> The contents of the Template implementation file, -<function>< X11/Xaw/Template.c >,</function> +<filename class="headerfile"><X11/Xaw/Template.c></filename>, are: </para> <!-- .CB --> @@ -40,46 +40,46 @@ static XtActionsRec actions[] = }; static char translations[] = -" <Key>: template(\|) \\n\\ +" <Key>: template( ) \\n\\ "; TemplateClassRec templateClassRec = { { /* core fields */ - /* superclass */ (WidgetClass) &widgetClassRec, - /* class_name */ "Template", - /* widget_size */ sizeof(TemplateRec), + /* superclass */ (WidgetClass) &widgetClassRec, + /* class_name */ "Template", + /* widget_size */ sizeof(TemplateRec), /* class_initialize */ NULL, - /* class_part_initialize */ NULL, - /* class_inited */ FALSE, - /* initialize */ NULL, + /* class_part_initialize */ NULL, + /* class_inited */ FALSE, + /* initialize */ NULL, /* initialize_hook */ NULL, - /* realize */ XtInheritRealize, - /* actions */ actions, - /* num_actions */ XtNumber(actions), - /* resources */ resources, + /* realize */ XtInheritRealize, + /* actions */ actions, + /* num_actions */ XtNumber(actions), + /* resources */ resources, /* num_resources */ XtNumber(resources), - /* xrm_class */ NULLQUARK, + /* xrm_class */ NULLQUARK, /* compress_motion */ TRUE, /* compress_exposure */ TRUE, - /* compress_enterleave */ TRUE, + /* compress_enterleave */ TRUE, /* visible_interest */ FALSE, - /* destroy */ NULL, - /* resize */ NULL, - /* expose */ NULL, - /* set_values */ NULL, + /* destroy */ NULL, + /* resize */ NULL, + /* expose */ NULL, + /* set_values */ NULL, /* set_values_hook */ NULL, /* set_values_almost */ XtInheritSetValuesAlmost, /* get_values_hook */ NULL, - /* accept_focus */ NULL, - /* version */ XtVersion, + /* accept_focus */ NULL, + /* version */ XtVersion, /* callback_private */ NULL, - /* tm_table */ translations, + /* tm_table */ translations, /* query_geometry */ XtInheritQueryGeometry, /* display_accelerator */ XtInheritDisplayAccelerator, - /* extension */ NULL + /* extension */ NULL }, { /* template fields */ - /* empty */ 0 + /* empty */ 0 } }; @@ -140,8 +140,8 @@ and the default input binding will be to execute the input callbacks on </para> <literallayout class="monospaced"> static char translations[] = -" <Key>: input(\|) \\n\\ - <BtnDown>: input(\|) \\ +" <Key>: input( ) \\n\\ + <BtnDown>: input( ) \\ "; </literallayout> <!-- .CE --> @@ -200,7 +200,7 @@ Font WindowFont(w) <para> The "WindowWidget" is now complete. The application can retrieve the two drawing colors from the widget instance by calling either -<function>XtGetValues ,</function> +<function>XtGetValues</function>, or the <function>WindowColor</function> functions. The actual window created for the "WindowWidget" is available by calling the <function>XtWindow</function> function. diff --git a/lib/libXaw/specs/TextActions.xml b/lib/libXaw/specs/TextActions.xml index 0e54582df..cfa8ca655 100644 --- a/lib/libXaw/specs/TextActions.xml +++ b/lib/libXaw/specs/TextActions.xml @@ -2,11 +2,11 @@ <title>Text Widget Actions</title> <para> <!-- .LP --> -<!-- .IN "Text widget" "actions" --> +<indexterm><primary>Text widget</primary><secondary>actions</secondary></indexterm> <!-- .XS --> <!-- Actions Supported by all Text Widgets --> <!-- .XE --> -<!-- .IN "Text widget" "actions" "@DEF@" --> +<indexterm significance="preferred"><primary>Text widget</primary><secondary>actions</secondary></indexterm> All editing functions are performed by translation manager actions that may be specified through the <function>translations</function> resource in the Text widget. @@ -64,7 +64,7 @@ may assume this to be the case. <!-- .LP --> </para> <sect3 id='Cursor_Movement_Actions'> -<title>Cursor Movement Actions\fP</title> +<title>Cursor Movement Actions</title> <para> <!-- .LP --> <!-- .sp --> @@ -363,8 +363,8 @@ triggered by a button event) or text cursor location (if triggered by a key event). It will then begin a selection at this location. If many of these selection actions occur quickly in succession then the selection count -mechanism will be invoked (see the section titled \fBText Selections for -Application Programmers\fP for details). <!-- xref --> +mechanism will be invoked (see +<xref linkend="Text_Selections_for_Application_Programmers"/> for details). </para> </listitem> </varlistentry> @@ -711,10 +711,11 @@ The multiply action allows the user to multiply the effects of many of the text actions. Thus the following action sequence <emphasis remap='I'>multiply(10) delete-next-word()</emphasis> will delete 10 words. It does not matter whether these actions take place in one event or many events. -Using the default translations the key sequence \fIControl-u, -Control-d\fP will delete 4 characters. -Multiply actions can be chained, thus \fImultiply(5) -multiply(5)\fP is the same as <emphasis remap='I'>multiply(25)</emphasis>. If the string +Using the default translations the key sequence +<emphasis remap='I'>Control-u, Control-d</emphasis> will delete 4 characters. +Multiply actions can be chained, thus +<emphasis remap='I'>multiply(5) multiply(5)</emphasis> is the same as +<emphasis remap='I'>multiply(25)</emphasis>. If the string <function>reset</function> is passed to the multiply action the effects of all previous multiplies are removed and a beep is sent to the display. </para> @@ -764,7 +765,7 @@ this argument is <emphasis remap='I'>RingBell</emphasis> then a beep is sent to </term> <listitem> <para> -<!-- .IN "XawWMProtocols" --> +<indexterm><primary>XawWMProtocols</primary></indexterm> <!-- .sp --> This action is written specifically for the file insertion and the search and replace @@ -775,7 +776,7 @@ popups, and may support other window manager protocols if necessary in the future. The popup will be dismissed if the window manager sends a WM_DELETE_WINDOW request and there are no parameters in the action call, which is the default. The popup will also be dismissed if the -parameters include the string ``wm_delete_window,'' and the event is a +parameters include the string <quote>wm_delete_window,</quote> and the event is a ClientMessage event requesting dismissal or is not a ClientMessage event. This action is not sensitive to the case of the strings passed as parameters. </para> @@ -787,7 +788,7 @@ This action is not sensitive to the case of the strings passed as parameters. </term> <listitem> <para> -<!-- .IN "Input Method" --> +<indexterm><primary>Input Method</primary></indexterm> When the <function>international</function> resource is <function>true</function>, input is usually passed to an input method, a separate process, for composing. Sometimes the connection to @@ -805,7 +806,7 @@ started before the input method. </sect3> <sect3 id="Text_Selections_for_Application_Programmers"> <title>Text Selections for Application Programmers</title> -<!-- .IN "Text widget" "Text Selections for Application Programmers" --> +<indexterm><primary>Text widget</primary><secondary>Text Selections for Application Programmers</secondary></indexterm> <para> <!-- .LP --> The default behavior of the text selection array is described in the @@ -814,7 +815,7 @@ a programmer must construct a <function>XawTextSelectType</function> array (call selection array), containing the selections desired, and pass this as the new value for the <function>selectionTypes</function> resource. The selection array may also be modified using the <xref linkend='XawTextSetSelectionArray' xrefstyle='select: title'/> -<!-- .IN "XawTextSetSelectionArray" "" --> +<indexterm><primary>XawTextSetSelectionArray</primary></indexterm> function. All selection arrays must end with the value <function>XawselectNull</function>. The <function>selectionTypes</function> resource has no converter registered and cannot be modified through the resource manager. @@ -896,7 +897,7 @@ array is set. <!-- .XS --> <!-- Default Translation Bindings --> <!-- .XE --> -<!-- .IN "Text widget" "default translations" --> +<indexterm><primary>Text widget</primary><secondary>default translations</secondary></indexterm> The following translations are defaults built into every Text widget. They can be overridden, or replaced by specifying a new value for the Text widget's <function>translations</function> resource. @@ -947,9 +948,9 @@ Text widget's <function>translations</function> resource. :Meta<Key>]: forward-paragraph() \\n\\ :Meta<Key>[: backward-paragraph() \\n\\ ~Shift Meta<Key>Delete: delete-previous-word() \\n\\ - \ Shift Meta<Key>Delete: backward-kill-word() \\n\\ + Shift Meta<Key>Delete: backward-kill-word() \\n\\ ~Shift Meta<Key>Backspace: delete-previous-word() \\n\\ - \ Shift Meta<Key>Backspace: backward-kill-word() \\n\\ + Shift Meta<Key>Backspace: backward-kill-word() \\n\\ <Key>Right: forward-character() \\n\\ <Key>Left: backward-character() \\n\\ <Key>Down: next-line() \\n\\ diff --git a/lib/libXaw/specs/TextActions_default_translation_bindings.xml b/lib/libXaw/specs/TextActions_default_translation_bindings.xml index 731881104..ae4e56c75 100644 --- a/lib/libXaw/specs/TextActions_default_translation_bindings.xml +++ b/lib/libXaw/specs/TextActions_default_translation_bindings.xml @@ -5,7 +5,7 @@ <!-- .XS --> <!-- Default Translation Bindings --> <!-- .XE --> -<!-- .IN "Text widget" "default translations" --> +<indexterm><primary>Text widget</primary><secondary>default translations</secondary></indexterm> The following translations are defaults built into every Text widget. They can be overridden, or replaced by specifying a new value for the Text widget's <function>translations</function> resource. @@ -56,9 +56,9 @@ Text widget's <function>translations</function> resource. :Meta<Key>]: forward-paragraph() \\n\\ :Meta<Key>[: backward-paragraph() \\n\\ ~Shift Meta<Key>Delete: delete-previous-word() \\n\\ - \ Shift Meta<Key>Delete: backward-kill-word() \\n\\ + Shift Meta<Key>Delete: backward-kill-word() \\n\\ ~Shift Meta<Key>Backspace: delete-previous-word() \\n\\ - \ Shift Meta<Key>Backspace: backward-kill-word() \\n\\ + Shift Meta<Key>Backspace: backward-kill-word() \\n\\ <Key>Right: forward-character() \\n\\ <Key>Left: backward-character() \\n\\ <Key>Down: next-line() \\n\\ diff --git a/lib/libXaw/specs/TextActions_text_widget_actions.xml b/lib/libXaw/specs/TextActions_text_widget_actions.xml index af7705204..215783f89 100644 --- a/lib/libXaw/specs/TextActions_text_widget_actions.xml +++ b/lib/libXaw/specs/TextActions_text_widget_actions.xml @@ -2,11 +2,11 @@ <title>Text Widget Actions</title> <para> <!-- .LP --> -<!-- .IN "Text widget" "actions" --> +<indexterm><primary>Text widget</primary><secondary>actions</secondary></indexterm> <!-- .XS --> <!-- Actions Supported by all Text Widgets --> <!-- .XE --> -<!-- .IN "Text widget" "actions" "@DEF@" --> +<indexterm significance="preferred"><primary>Text widget</primary><secondary>actions</secondary></indexterm> All editing functions are performed by translation manager actions that may be specified through the <function>translations</function> resource in the Text widget. @@ -64,7 +64,7 @@ may assume this to be the case. <!-- .LP --> </para> <sect2 id='Cursor_Movement_Actions'> -<title>Cursor Movement Actions\fP</title> +<title>Cursor Movement Actions</title> <para> <!-- .LP --> <!-- .sp --> @@ -363,8 +363,9 @@ triggered by a button event) or text cursor location (if triggered by a key event). It will then begin a selection at this location. If many of these selection actions occur quickly in succession then the selection count -mechanism will be invoked (see the section titled \fBText Selections for -Application Programmers\fP for details). <!-- xref --> +mechanism will be invoked (see +<xref linkend="Text_Selections_for_Application_Programmers"/> +for details). </para> </listitem> </varlistentry> @@ -711,10 +712,11 @@ The multiply action allows the user to multiply the effects of many of the text actions. Thus the following action sequence <emphasis remap='I'>multiply(10) delete-next-word()</emphasis> will delete 10 words. It does not matter whether these actions take place in one event or many events. -Using the default translations the key sequence \fIControl-u, -Control-d\fP will delete 4 characters. -Multiply actions can be chained, thus \fImultiply(5) -multiply(5)\fP is the same as <emphasis remap='I'>multiply(25)</emphasis>. If the string +Using the default translations the key sequence +<emphasis remap='I'>Control-u, Control-d</emphasis> will delete 4 characters. +Multiply actions can be chained, thus +<emphasis remap='I'>multiply(5) multiply(5)</emphasis> is the same as +<emphasis remap='I'>multiply(25)</emphasis>. If the string <function>reset</function> is passed to the multiply action the effects of all previous multiplies are removed and a beep is sent to the display. </para> @@ -764,7 +766,7 @@ this argument is <emphasis remap='I'>RingBell</emphasis> then a beep is sent to </term> <listitem> <para> -<!-- .IN "XawWMProtocols" --> +<indexterm><primary>XawWMProtocols</primary></indexterm> <!-- .sp --> This action is written specifically for the file insertion and the search and replace @@ -775,7 +777,7 @@ popups, and may support other window manager protocols if necessary in the future. The popup will be dismissed if the window manager sends a WM_DELETE_WINDOW request and there are no parameters in the action call, which is the default. The popup will also be dismissed if the -parameters include the string ``wm_delete_window,'' and the event is a +parameters include the string <quote>wm_delete_window,</quote> and the event is a ClientMessage event requesting dismissal or is not a ClientMessage event. This action is not sensitive to the case of the strings passed as parameters. </para> @@ -787,7 +789,7 @@ This action is not sensitive to the case of the strings passed as parameters. </term> <listitem> <para> -<!-- .IN "Input Method" --> +<indexterm><primary>Input Method</primary></indexterm> When the <function>international</function> resource is <function>true</function>, input is usually passed to an input method, a separate process, for composing. Sometimes the connection to @@ -805,7 +807,7 @@ started before the input method. </sect2> <sect2 id="Text_Selections_for_Application_Programmers"> <title>Text Selections for Application Programmers</title> -<!-- .IN "Text widget" "Text Selections for Application Programmers" --> +<indexterm><primary>Text widget</primary><secondary>Text Selections for Application Programmers</secondary></indexterm> <para> <!-- .LP --> The default behavior of the text selection array is described in the @@ -814,7 +816,7 @@ a programmer must construct a <function>XawTextSelectType</function> array (call selection array), containing the selections desired, and pass this as the new value for the <function>selectionTypes</function> resource. The selection array may also be modified using the <xref linkend='XawTextSetSelectionArray' xrefstyle='select: title'/> -<!-- .IN "XawTextSetSelectionArray" "" --> +<indexterm><primary>XawTextSetSelectionArray</primary></indexterm> function. All selection arrays must end with the value <function>XawselectNull</function>. The <function>selectionTypes</function> resource has no converter registered and cannot be modified through the resource manager. diff --git a/lib/libXaw/specs/TextCustom.xml b/lib/libXaw/specs/TextCustom.xml index 7ca2d5f78..647dba914 100644 --- a/lib/libXaw/specs/TextCustom.xml +++ b/lib/libXaw/specs/TextCustom.xml @@ -5,7 +5,7 @@ <!-- .XS --> <!-- Customizing the Text Widget --> <!-- .XE --> -<!-- .IN "Text widget" "customizing" "@DEF@" --> +<indexterm significance="preferred"><primary>Text widget</primary><secondary>customizing</secondary></indexterm> </para> <para> <!-- .LP --> @@ -29,7 +29,7 @@ a Text widget. <!-- .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" "" --> +<indexterm><primary>Text widget</primary></indexterm> </para> <para> <variablelist> @@ -43,11 +43,11 @@ 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> +<indexterm><primary>TextSink object</primary></indexterm> 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 @@ -55,62 +55,62 @@ its drawing on the Text widget's window. </para> </listitem> </varlistentry> -<!-- .IN "TextSrc object" "" --> <varlistentry> <term><function>TextSrc</function></term> <listitem> <para> +<indexterm><primary>TextSrc object</primary></indexterm> 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> +<indexterm><primary>AsciiSink object</primary></indexterm> 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> +<indexterm><primary>MultiSink object</primary></indexterm> 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> +<indexterm><primary>AsciiSrc object</primary></indexterm> 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> +<indexterm><primary>MultiSrc object</primary></indexterm> 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> +<indexterm><primary>AsciiText widget</primary></indexterm> 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 diff --git a/lib/libXaw/specs/TextFuncs.xml b/lib/libXaw/specs/TextFuncs.xml index d7d3580b7..f566660c5 100644 --- a/lib/libXaw/specs/TextFuncs.xml +++ b/lib/libXaw/specs/TextFuncs.xml @@ -16,7 +16,7 @@ These data structures are defined in the Text widget's public header file, </para> <para> <!-- .LP --> -<!-- .IN "XawTextPosition" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextPosition</primary></indexterm> typedef long XawTextPosition; <!-- .sp --> </para> @@ -27,7 +27,7 @@ n is the number of characters in the Text source widget. </para> <para> <!-- .LP --> -<!-- .IN "XawTextBlock" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextBlock</primary></indexterm> <literallayout class="monospaced"> <!-- .TA .5i 1.5i 2.25i --> <!-- .ta .5i 1.5i 2.25i --> @@ -41,7 +41,7 @@ typedef struct { </para> <para> <!-- .LP --> -<!-- .IN "XawTextBlockPtr" "" --> +<indexterm><primary>XawTextBlockPtr</primary></indexterm> <variablelist> <varlistentry> <term> @@ -97,7 +97,7 @@ either XawFmt8Bit or XawFmtWide. <para> <!-- .LP --> Note: Previous versions of Xaw used -<function>FMT8BIT ,</function> +<function>FMT8BIT</function>, which has been retained for backwards compatibility. <function>FMT8BIT</function> is deprecated and will eventually be removed from the implementation. </para> @@ -108,7 +108,7 @@ deprecated and will eventually be removed from the implementation. <!-- .LP --> To select a piece of text, use <function>XawTextSetSelection : </function> -<!-- .IN "XawTextSetSelection" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextSetSelection</primary></indexterm> <funcsynopsis id='XawTextSetSelection'> <funcprototype> <funcdef>void<function> XawTextSetSelection</function></funcdef> @@ -152,7 +152,8 @@ Specifies the character position at which the selection ends. </para> <para> <!-- .LP --> -See section 5.4 for a description of <function>XawTextPosition</function>. <!-- xref --> +<link linkend="Text_Functions">See section 5.4</link> +for a description of <function>XawTextPosition</function>. If redisplay is enabled, this function highlights the text and makes it the <function>PRIMARY</function> selection. This function does not have any effect on <function>CUT_BUFFER0</function>. @@ -167,7 +168,7 @@ effect on <function>CUT_BUFFER0</function>. <!-- .LP --> To unhighlight previously highlighted text in a widget, use <xref linkend='XawTextUnsetSelection' xrefstyle='select: title'/>: -<!-- .IN "XawTextUnsetSelection" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextUnsetSelection</primary></indexterm> <funcsynopsis id='XawTextUnsetSelection'> <funcprototype> <funcdef>void<function> XawTextUnsetSelection</function></funcdef> @@ -195,7 +196,7 @@ Specifies the Text widget. <!-- .LP --> To retrieve the text that has been selected by this text widget use <xref linkend='XawTextGetSelectionPos' xrefstyle='select: title'/>: -<!-- .IN "XawTextGetSelectionPos" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextGetSelectionPos</primary></indexterm> <funcsynopsis id='XawTextGetSelectionPos'> <funcprototype> <funcdef>void<function> XawTextGetSelectionPos</function></funcdef> @@ -239,7 +240,8 @@ Returns the end of the text selection. </para> <para> <!-- .LP --> -See section 5.4 for a description of <function>XawTextPosition</function>. <!-- xref --> +<link linkend="Text_Functions">See section 5.4</link> +for a description of <function>XawTextPosition</function>. If the returned values are equal, no text is currently selected. </para> </sect2> @@ -248,7 +250,7 @@ If the returned values are equal, no text is currently selected. <para> <!-- .LP --> To modify the text in an editable Text widget use <xref linkend='XawTextReplace' xrefstyle='select: title'/>: -<!-- .IN "XawTextReplace" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextReplace</primary></indexterm> <funcsynopsis id='XawTextReplace'> <funcprototype> <funcdef>int<function> XawTextReplace</function></funcdef> @@ -309,7 +311,8 @@ be able to append text to an append-only text widget. </para> <para> <!-- .LP --> -See section 5.4 for a description of <function>XawTextPosition</function> and <!-- xref --> +<link linkend="Text_Functions">See section 5.4</link> +for a description of <function>XawTextPosition</function> and <function>XawTextBlock</function>. </para> <para> @@ -322,7 +325,7 @@ This function may return the following values: </term> <listitem> <para> -<!-- .IN "XawEditDone" "" --> +<indexterm><primary>XawEditDone</primary></indexterm> The text replacement was successful. </para> </listitem> @@ -333,7 +336,7 @@ The text replacement was successful. </term> <listitem> <para> -<!-- .IN "XawPositionError" "" --> +<indexterm><primary>XawPositionError</primary></indexterm> The edit mode is <function>XawtextAppend</function> and <function>start</function> is not the position of the last character of the source. </para> @@ -345,7 +348,7 @@ the last character of the source. </term> <listitem> <para> -<!-- .IN "XawEditError" "" --> +<indexterm><primary>XawEditError</primary></indexterm> Either the Source was read-only or the range to be deleted is larger than the length of the Source. @@ -372,7 +375,7 @@ text is inserted after <emphasis remap='I'>start</emphasis>. <!-- .LP --> To search for a string in the Text widget, use <xref linkend='XawTextSearch' xrefstyle='select: title'/>: -<!-- .IN "XawTextSearch" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextSearch</primary></indexterm> <funcsynopsis id='XawTextSearch'> <funcprototype> <funcdef>XawTextPosition<function> XawTextSearch</function></funcdef> @@ -418,7 +421,8 @@ Specifies a text block structure that contains the text to search for. </para> <para> <!-- .LP --> -See section 5.4 for a description of <function>XawTextPosition</function> and <function>XawTextBlock</function>. <!-- xref --> +<link linkend="Text_Functions">See section 5.4</link> for a description of +<function>XawTextPosition</function> and <function>XawTextBlock</function>. The <xref linkend='XawTextSearch' xrefstyle='select: title'/> function will begin at the insertion point and search in the direction specified for a string that matches the one passed in @@ -432,7 +436,7 @@ found then the value <function>XawTextSearchError</function> is returned. <para> <!-- .LP --> To redisplay a range of characters, use <xref linkend='XawTextInvalidate' xrefstyle='select: title'/>: -<!-- .IN "XawTextInvalidate" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextInvalidate</primary></indexterm> <funcsynopsis id='XawTextInvalidate'> <funcprototype> <funcdef>void<function> XawTextInvalidate</function></funcdef> @@ -476,7 +480,8 @@ Specifies the end of the text to redisplay. </para> <para> <!-- .LP --> -See section 5.4 for a description of <function>XawTextPosition</function>. <!-- xref --> +<link linkend="Text_Functions">See section 5.4</link> +for a description of <function>XawTextPosition</function>. The <xref linkend='XawTextInvalidate' xrefstyle='select: title'/> function causes the specified range of characters to be redisplayed immediately if redisplay is enabled or the next time that redisplay is @@ -486,7 +491,7 @@ enabled. <!-- .LP --> <!-- .sp 1 --> To enable redisplay, use <xref linkend='XawTextEnableRedisplay' xrefstyle='select: title'/>: -<!-- .IN "XawTextEnableRedisplay" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextEnableRedisplay</primary></indexterm> <funcsynopsis id='XawTextEnableRedisplay'> <funcprototype> <funcdef>void<function> XawTextEnableRedisplay</function></funcdef> @@ -518,7 +523,7 @@ was called and allows future changes to be reflected immediately. <!-- .sp 1 --> To disable redisplay while making several changes, use <xref linkend='XawTextDisableRedisplay' xrefstyle='select: title'/>. -<!-- .IN "XawTextDisableRedisplay" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextDisableRedisplay</primary></indexterm> <funcsynopsis id='XawTextDisableRedisplay'> <funcprototype> <funcdef>void<function> XawTextDisableRedisplay</function></funcdef> @@ -549,7 +554,7 @@ is called. <!-- .LP --> <!-- .sp 1 --> To display batched updates, use <xref linkend='XawTextDisplay' xrefstyle='select: title'/>: -<!-- .IN "XawTextDisplay" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextDisplay</primary></indexterm> <funcsynopsis id='XawTextDisplay'> <funcprototype> <funcdef>void<function> XawTextDisplay</function></funcdef> @@ -583,7 +588,7 @@ displayed. To obtain the character position of the left-most character on the first line displayed in the widget (the value of the <function>displayPosition</function> resource), use <xref linkend='XawTextTopPosition' xrefstyle='select: title'/>. -<!-- .IN "XawTextTopPosition" "" @DEF@" --> +<indexterm significance="preferred"><primary>XawTextTopPosition</primary></indexterm> <funcsynopsis id='XawTextTopPosition'> <funcprototype> <funcdef>XawTextPosition<function> XawTextTopPosition</function></funcdef> @@ -609,7 +614,7 @@ Specifies the Text widget. <!-- .sp 1 --> To assign a new selection array to a text widget use <xref linkend='XawTextSetSelectionArray' xrefstyle='select: title'/>: -<!-- .IN "XawTextSetSelectionArray" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextSetSelectionArray</primary></indexterm> <funcsynopsis id='XawTextSetSelectionArray'> <funcprototype> <funcdef>void<function> XawTextSetSelectionArray</function></funcdef> @@ -635,8 +640,8 @@ Specifies the Text widget. </term> <listitem> <para> -Specifies a selection array as defined in the section called \fBText -Selections for Application Programmers\fP. +Specifies a selection array as defined in +<xref linkend="Text_Selections_for_Application_Programmers"/>. </para> </listitem> </varlistentry> @@ -652,7 +657,7 @@ Calling this function is equivalent to setting the value of the <!-- .sp 1 --> To move the insertion point to the specified source position, use <xref linkend='XawTextSetInsertionPoint' xrefstyle='select: title'/>: -<!-- .IN "XawTextSetInsertionPoint" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextSetInsertionPoint</primary></indexterm> <funcsynopsis id='XawTextSetInsertionPoint'> <funcprototype> <funcdef>void<function> XawTextSetInsertionPoint</function></funcdef> @@ -686,7 +691,8 @@ Specifies the new position for the insertion point. </para> <para> <!-- .LP --> -See section 5.4 for a description of <function>XawTextPosition</function>. <!-- xref --> +<link linkend="Text_Functions">See section 5.4</link> +for a description of <function>XawTextPosition</function>. The text will be scrolled vertically if necessary to make the line containing the insertion point visible. Calling this function is equivalent to setting the <function>insertPosition</function> resource. @@ -696,7 +702,7 @@ equivalent to setting the <function>insertPosition</function> resource. <!-- .sp 1 --> To obtain the current position of the insertion point, use <xref linkend='XawTextGetInsertionPoint' xrefstyle='select: title'/>: -<!-- .IN "XawTextGetInsertionPoint" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextGetInsertionPoint</primary></indexterm> <funcsynopsis id='XawTextGetInsertionPoint'> <funcprototype> <funcdef>XawTextPosition<function> XawTextGetInsertionPoint</function></funcdef> @@ -719,7 +725,8 @@ Specifies the Text widget. </para> <para> <!-- .LP --> -See section 5.4 for a description of <function>XawTextPosition</function>. <!-- xref --> +<link linkend="Text_Functions">See section 5.4</link> +for a description of <function>XawTextPosition</function>. The result is equivalent to retrieving the value of the <function>insertPosition</function> resource. </para> @@ -728,7 +735,7 @@ The result is equivalent to retrieving the value of the <!-- .sp 1 --> To replace the text source in the specified widget, use <xref linkend='XawTextSetSource' xrefstyle='select: title'/>: -<!-- .IN "XawTextSetSource" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextSetSource</primary></indexterm> <funcsynopsis id='XawTextSetSource'> <funcprototype> <funcdef>void<function> XawTextSetSource</function></funcdef> @@ -774,7 +781,8 @@ of the displayed text. This is usually set to zero. </para> <para> <!-- .LP --> -See section 5.4 for a description of <function>XawTextPosition</function>. <!-- xref --> +<link linkend="Text_Functions">See section 5.4</link> +for a description of <function>XawTextPosition</function>. A display update will be performed if redisplay is enabled. </para> <para> @@ -782,7 +790,7 @@ A display update will be performed if redisplay is enabled. <!-- .sp 1 --> To obtain the current text source for the specified widget, use <xref linkend='XawTextGetSource' xrefstyle='select: title'/>: -<!-- .IN "XawTextGetSource" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextGetSource</primary></indexterm> <funcsynopsis id='XawTextGetSource'> <funcprototype> <funcdef>Widget<function> XawTextGetSource</function></funcdef> @@ -813,7 +821,7 @@ using. <!-- .sp --> To enable and disable the insertion point, use <xref linkend='XawTextDisplayCaret' xrefstyle='select: title'/>: -<!-- .IN "XawTextDisplayCaret" "" "@DEF@" --> +<indexterm significance="preferred"><primary>XawTextDisplayCaret</primary></indexterm> <funcsynopsis id='XawTextDisplayCaret'> <funcprototype> <funcdef>void<function> XawTextDisplayCaret</function></funcdef> diff --git a/lib/libXaw/specs/TextSink.xml b/lib/libXaw/specs/TextSink.xml index 93a2e0ef6..78218b260 100644 --- a/lib/libXaw/specs/TextSink.xml +++ b/lib/libXaw/specs/TextSink.xml @@ -5,7 +5,7 @@ <!-- .XS --> <!-- TextSink Object --> <!-- .XE --> -<!-- .IN "TextSink object" "" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSink object</primary></indexterm> </para> <para> <!-- .LP --> @@ -13,13 +13,13 @@ <!-- .TA 2.0i --> <!-- .ta 2.0i --> Application Header file <X11/Xaw/TextSink.h> -<!-- .IN "TextSink.h" "" --> +<indexterm><primary>TextSink.h</primary></indexterm> Class Header file <X11/Xaw/TextSinkP.h> -<!-- .IN "TextSinkP.h" "" --> +<indexterm><primary>TextSinkP.h</primary></indexterm> Class textSinkObjectClass -<!-- .IN "textSinkObjectClass" "" --> +<indexterm><primary>textSinkObjectClass</primary></indexterm> Class Name TextSink -<!-- .IN "TextSink object" "class name" --> +<indexterm><primary>TextSink object</primary><secondary>class name</secondary></indexterm> Superclass Object </literallayout> </para> @@ -44,7 +44,7 @@ retrieved from the argument list or from the resource database: </para> <para> <!-- .LP --> -<!-- .IN "AsciiSink object" "resources" --> +<indexterm><primary>AsciiSink object</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -96,7 +96,7 @@ retrieved from the argument list or from the resource database: </sect2> <sect2 id="Subclassing_the_TextSink"> <title>Subclassing the TextSink</title> -<!-- .IN "TextSink object" "subclassing" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSink object</primary><secondary>subclassing</secondary></indexterm> <para> <!-- .LP --> The only purpose of the TextSink Object is to be subclassed. It @@ -191,7 +191,7 @@ to be used as a sink by itself. <!-- .LP --> To display a section of the text buffer contained in the text source use the function <xref linkend='DisplayText' xrefstyle='select: title'/>: -<!-- .IN "TextSink object" "DisplayText" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSink object</primary><secondary>DisplayText</secondary></indexterm> <funcsynopsis id='DisplayText'> <funcprototype> <funcdef>void<function> DisplayText</function></funcdef> @@ -352,8 +352,8 @@ defines this function as calling on the region passed. This behavior will be used if you specify <function>XtInheritClearToBackground</function> for this method. -<!-- .IN "XtInheritClearToBackground" "" --> -<!-- .IN "TextSink object" "ClearToBackground" "@DEF@" --> +<indexterm><primary>XtInheritClearToBackground</primary></indexterm> +<indexterm significance="preferred"><primary>TextSink object</primary><secondary>ClearToBackground</secondary></indexterm> <funcsynopsis id='ClearToBackground'> <funcprototype> <funcdef>void<function> ClearToBackground</function></funcdef> @@ -427,7 +427,7 @@ Specifies the height, in pixels, of the Region to clear. <!-- .LP --> To find the text character position that will be rendered at a given x location the Text widget uses the function <xref linkend='FindPosition' xrefstyle='select: title'/>: -<!-- .IN "TextSink object" "FindPosition" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSink object</primary><secondary>FindPosition</secondary></indexterm> <funcsynopsis id='FindPosition'> <funcprototype> <funcdef>void<function> FindPosition</function></funcdef> @@ -541,7 +541,7 @@ widget will only call it one line at a time. <!-- .sp --> Another means of finding a text position is provided by the <xref linkend='Resolve' xrefstyle='select: title'/> function: -<!-- .IN "TextSink object" "Resolve" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSink object</primary><secondary>Resolve</secondary></indexterm> <funcsynopsis id='Resolve'> <funcprototype> <funcdef>void<function> Resolve</function></funcdef> @@ -617,7 +617,7 @@ This function need make no attempt to deal with line feeds. The text widget will only call it one line at a time. This is a more convenient interface to the <xref linkend='FindPosition' xrefstyle='select: title'/> function, and provides a subset of its functionality. -<!-- .IN "FindPosition" "" --> +<indexterm><primary>FindPosition</primary></indexterm> </para> </sect3> <sect3 id="Finding_the_Distance_Between_two_Text_Positions"> @@ -626,7 +626,7 @@ functionality. <!-- .LP --> To find the distance in pixels between two text positions on the same line use the function <xref linkend='FindDistance' xrefstyle='select: title'/>. -<!-- .IN "TextSink object" "FindDistance" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSink object</primary><secondary>FindDistance</secondary></indexterm> <funcsynopsis id='FindDistance'> <funcprototype> <funcdef>void<function> FindDistance</function></funcdef> @@ -732,7 +732,7 @@ To find the maximum number of lines that will fit into the current Text widget, use the function <xref linkend='MaxLines' xrefstyle='select: title'/>. The TextSink already defines this function to compute the maximum number of lines by using the height of <function>font</function>. -<!-- .IN "TextSink object" "MaxLines" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSink object</primary><secondary>MaxLines</secondary></indexterm> <funcsynopsis id='MaxLines'> <funcprototype> <funcdef>int<function> MaxLines</function></funcdef> @@ -775,7 +775,7 @@ To find the height required for a given number of text lines, use the function <xref linkend='MaxHeight' xrefstyle='select: title'/>. The TextSink already defines this function to compute the maximum height of the window by using the height of <function>font</function>. -<!-- .IN "TextSink object" "MaxHeight" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSink object</primary><secondary>MaxHeight</secondary></indexterm> <funcsynopsis id='MaxHeight'> <funcprototype> <funcdef>int<function> MaxHeight</function></funcdef> @@ -820,7 +820,7 @@ To set the tab stops for a text sink use the <xref linkend='SetTabs' xrefstyle=' The TextSink already defines this function to set the tab x location in pixels to be the number of characters times the figure width of <function>font</function>. -<!-- .IN "TextSink object" "SetTabs" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSink object</primary><secondary>SetTabs</secondary></indexterm> <funcsynopsis id='SetTabs'> <funcprototype> <funcdef>void<function> SetTabs</function></funcdef> @@ -874,7 +874,7 @@ to it into whatever internal positions the TextSink uses for tab placement. <!-- .LP --> To get the size and location of the insert point use the <xref linkend='GetCursorBounds' xrefstyle='select: title'/> function. -<!-- .IN "TextSink object" "GetCursorBounds" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSink object</primary><secondary>GetCursorBounds</secondary></indexterm> <funcsynopsis id='GetCursorBounds'> <funcprototype> <funcdef>void<function> GetCursorBounds</function></funcdef> diff --git a/lib/libXaw/specs/TextSource.xml b/lib/libXaw/specs/TextSource.xml index c90ae2960..4c49720e2 100644 --- a/lib/libXaw/specs/TextSource.xml +++ b/lib/libXaw/specs/TextSource.xml @@ -138,7 +138,7 @@ used as a source by itself and bad things will probably happen. <para> <!-- .LP --> To read the text in a text source use the <xref linkend='Read' xrefstyle='select: title'/> function: -<!-- .IN "TextSrc object" "Read" "@DEF@" --> +<indexterm significance="preferred"><primary>TextSrc object</primary><secondary>Read</secondary></indexterm> </para> <funcsynopsis id='Read'> <funcprototype> @@ -273,7 +273,7 @@ The text replacement was successful. <term><function>XawPositionError</function></term> <listitem> <para> -<!-- .IN "XawPositionError" "" --> +<indexterm><primary>XawPositionError</primary></indexterm> The edit mode is <function>XawtextAppend</function> and <function>start</function> is not the last character of the source. </para> @@ -283,7 +283,7 @@ character of the source. <term><function>XawEditError</function></term> <listitem> <para> -<!-- .IN "XawEditError" "" --> +<indexterm><primary>XawEditError</primary></indexterm> Either the Source was read-only or the range to be deleted is larger than the length of the Source. </para> @@ -356,9 +356,9 @@ boundaries is left up to the individual text source. <listitem> <para> Specifies the direction to scan, may be either <function>XawsdLeft</function> to search -<!-- .IN "XawsdLeft" "" --> +<indexterm><primary>XawsdLeft</primary></indexterm> backward, or <function>XawsdRight</function> to search forward. -<!-- .IN "XawsdRight" "" --> +<indexterm><primary>XawsdRight</primary></indexterm> </para> </listitem> </varlistentry> @@ -428,9 +428,9 @@ Specifies the position to begin the search. <listitem> <para> Specifies the direction to search, may be either <function>XawsdLeft</function> to search -<!-- .IN "XawsdLeft" "" --> +<indexterm><primary>XawsdLeft</primary></indexterm> backward, or <function>XawsdRight</function> to search forward. -<!-- .IN "XawsdRight" "" --> +<indexterm><primary>XawsdRight</primary></indexterm> </para> </listitem> </varlistentry> diff --git a/lib/libXaw/specs/Toggle.xml b/lib/libXaw/specs/Toggle.xml index 227aba2dc..a7944fa65 100644 --- a/lib/libXaw/specs/Toggle.xml +++ b/lib/libXaw/specs/Toggle.xml @@ -34,7 +34,7 @@ the user to cancel the operation. </para> <para> -Toggle widgets may also be part of a ``radio group.'' A radio group is a +Toggle widgets may also be part of a <quote>radio group.</quote> A radio group is a list of at least two Toggle widgets in which no more than one Toggle may be set at any time. A radio group is identified by the widget ID of any one of @@ -566,7 +566,7 @@ multi-plane pixmap. <para> There are typically two types of radio groups desired by applications. The default translations for the Toggle widget implement a "zero or one -<!-- .IN "Radio groups" "zero or one of many" --> +<indexterm><primary>Radio groups</primary><secondary>zero or one of many</secondary></indexterm> of many" radio group. This means that there may be no more than one Toggle widget active, but there need not be any Toggle widgets active. </para> diff --git a/lib/libXaw/specs/Tree.xml b/lib/libXaw/specs/Tree.xml index 71cadd126..65bc94493 100644 --- a/lib/libXaw/specs/Tree.xml +++ b/lib/libXaw/specs/Tree.xml @@ -152,7 +152,7 @@ retrieved from the argument list or from the resource database: <entry>Height</entry> <entry>Dimension</entry> <entry>A</entry> - <entry>see <function>Layout Semantics</function></entry> <!-- xref --> + <entry>see <xref linkend='Tree::Layout_Semantics'/></entry> </row> <row> <entry>hSpace</entry> @@ -215,7 +215,7 @@ retrieved from the argument list or from the resource database: <entry>Width</entry> <entry>Dimension</entry> <entry>A</entry> - <entry>see <function>Layout Semantics</function></entry> <!-- xref --> + <entry>see <xref linkend='Tree::Layout_Semantics'/></entry> </row> <row> <entry>x</entry> diff --git a/lib/libXaw/specs/Viewport.xml b/lib/libXaw/specs/Viewport.xml index 767dc07a3..1f4aeb61e 100644 --- a/lib/libXaw/specs/Viewport.xml +++ b/lib/libXaw/specs/Viewport.xml @@ -5,19 +5,19 @@ <!-- .XS --> <!-- Viewport Widget --> <!-- .XE --> -<!-- .IN "Viewport widget" "" "@DEF@" --> +<indexterm significance="preferred"><primary>Viewport widget</primary></indexterm> <literallayout class="monospaced"> <!-- .TA 2.0i --> <!-- .ta 2.0i --> <!-- .sp --> Application Header file <X11/Xaw/Viewport.h> -<!-- .IN "Viewport.h" "" --> +<indexterm><primary>Viewport.h</primary></indexterm> Class Header file <X11/Xaw/ViewportP.h> -<!-- .IN "ViewportP.h" "" --> +<indexterm><primary>ViewportP.h</primary></indexterm> Class viewportWidgetClass -<!-- .IN "viewportWidgetClass" "" --> +<indexterm><primary>viewportWidgetClass</primary></indexterm> Class Name Viewport -<!-- .IN "Viewport widget" "class name" --> +<indexterm><primary>Viewport widget</primary><secondary>class name</secondary></indexterm> Superclass Form <!-- .sp --> </literallayout> @@ -48,7 +48,7 @@ retrieved from the argument list or the resource database: </para> <para> <!-- .LP --> -<!-- .IN "Viewport widget" "resources" --> +<indexterm><primary>Viewport widget</primary><secondary>resources</secondary></indexterm> <informaltable> <tgroup cols='5' align='center'> <colspec colname='c1'/> @@ -351,7 +351,7 @@ the Viewport. <title>Layout Semantics</title> <para> <!-- .LP --> -<!-- .IN "Viewport widget" "layout semantics" --> +<indexterm><primary>Viewport widget</primary><secondary>layout semantics</secondary></indexterm> The Viewport widget manages a single child widget. When the size of the child is larger than the size of the Viewport, the user can interactively move the child within the Viewport by repositioning the scrollbars. @@ -377,7 +377,7 @@ The scrollbar children of the Viewport are named <function>horizontal</function> for the individual scrollbars. <xref linkend='XtSetValues' xrefstyle='select: title'/> can be used to modify the resources dynamically once the widget ID has been obtained with <function>XtNameToWidget</function>. -<!-- .IN "XtNameToWidget" "" --> +<indexterm><primary>XtNameToWidget</primary></indexterm> <!-- .NT --> </para> <note><para> diff --git a/lib/libXaw/specs/libXaw.ent.in b/lib/libXaw/specs/libXaw.ent.in new file mode 100644 index 000000000..ea4326fd4 --- /dev/null +++ b/lib/libXaw/specs/libXaw.ent.in @@ -0,0 +1,2 @@ +<!-- define version entity for libXaw documentation via configure.ac --> +<!ENTITY xawvers "@PACKAGE_VERSION@"> diff --git a/lib/libXaw/specs/libXaw.xml b/lib/libXaw/specs/libXaw.xml index 75880ad55..2def204a0 100644 --- a/lib/libXaw/specs/libXaw.xml +++ b/lib/libXaw/specs/libXaw.xml @@ -3,6 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ <!ENTITY % defs SYSTEM "defs.ent"> %defs; +<!ENTITY % xawdefs SYSTEM "libXaw.ent"> %xawdefs; ]> <book id="libXaw"> @@ -10,7 +11,7 @@ <bookinfo> <title>Athena Widget Set - C Language Interface</title> <subtitle>X Consortium Standard</subtitle> - <releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo> + <releaseinfo>libXaw Version &xawvers;</releaseinfo> <authorgroup> <author> <firstname>Chris</firstname><othername>D.</othername><surname>Peterson</surname> @@ -85,5 +86,6 @@ It is provided “as is” without express or implied warranty. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="CH6.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="CH7.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="TPage_Credits.xml"/> +<index /> </book> |