summaryrefslogtreecommitdiff
path: root/specs/CH06.xml
diff options
context:
space:
mode:
Diffstat (limited to 'specs/CH06.xml')
-rwxr-xr-xspecs/CH06.xml136
1 files changed, 68 insertions, 68 deletions
diff --git a/specs/CH06.xml b/specs/CH06.xml
index a0a0f23..6df6892 100755
--- a/specs/CH06.xml
+++ b/specs/CH06.xml
@@ -29,15 +29,15 @@ Parents, children, and clients each initiate geometry changes differently.
Because a parent has absolute control of its children's geometry,
it changes the geometry directly by calling
<function>XtMove\%Widget</function>,
-<function>XtResizeWidget</function>,
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>,
or
-<function>XtConfigureWidget</function>.
+<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>.
A child must ask its parent for a geometry change by calling
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
or
-<function>XtMakeResizeRequest</function>.
+<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>.
An application or other client code initiates a geometry change by calling
-<function>XtSetValues</function>
+<xref linkend='XtSetValues' xrefstyle='select: title'/>
on the appropriate geometry fields,
thereby giving the widget the opportunity to modify or reject the client
request before it gets propagated to the parent and the opportunity
@@ -57,14 +57,14 @@ When the geometry manager is asked to change the geometry of a child,
the geometry manager may also rearrange and resize any or all
of the other children that it controls.
The geometry manager can move children around freely using
-<function>XtMoveWidget</function>.
+<xref linkend='XtMoveWidget' xrefstyle='select: title'/>.
When it resizes a child (that is, changes the width, height, or
border width) other than the one making the request,
it should do so by calling
-<function>XtResizeWidget</function>.
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>.
The requesting child may be given special treatment; see Section 6.5.
It can simultaneously move and resize a child with a single call to
-<function>XtConfigureWidget</function>.
+<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>.
</para>
<para>
@@ -93,7 +93,7 @@ see Sections 2.5 and 2.6.
The Intrinsics treatment of stacking requests is deficient in several areas.
Stacking requests for unrealized widgets are granted but will have no effect.
In addition, there is no way to do an
-<function>XtSetValues</function>
+<xref linkend='XtSetValues' xrefstyle='select: title'/>
that will generate a stacking geometry request.
</para>
</listitem>
@@ -132,7 +132,7 @@ typedef struct {
<para>
To make a general geometry manager request from a widget, use
-<function>XtMakeGeometryRequest</function>.
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>.
</para>
<funcsynopsis id='XtMakeGeometryRequest'>
@@ -182,7 +182,7 @@ if the requesting widget is not interested in handling
<para>
Depending on the condition,
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
performs the following:
</para>
@@ -229,7 +229,7 @@ and if
<function>XtCWQueryOnly</function>
is not set in <emphasis remap='I'>request-&gt;request_mode</emphasis>
and if the widget is realized,
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
calls the
<function>XConfigureWindow</function>
Xlib function to reconfigure the widget's window (set its size, location,
@@ -242,10 +242,10 @@ If the geometry manager returns
<function>XtGeometryDone</function>,
the change has been approved and actually has been done.
In this case,
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
does no configuring and returns
<function>XtGeometryYes</function>.
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
never returns
<function>XtGeometryDone</function>.
</para>
@@ -253,7 +253,7 @@ never returns
<listitem>
<para>
Otherwise,
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
just returns the resulting value from the parent's geometry manager.
</para>
</listitem>
@@ -261,7 +261,7 @@ just returns the resulting value from the parent's geometry manager.
<para>
Children of primitive widgets are always unmanaged; therefore,
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
always returns
<function>XtGeometryYes</function>
when called by a child of a primitive widget.
@@ -357,7 +357,7 @@ and that no widgets should actually be changed.
</para>
<para>
-<function>XtMakeGeometryRequest</function>,
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>,
like the
<function>XConfigureWindow</function>
Xlib function, uses <emphasis remap='I'>request_mode</emphasis> to determine which fields in the
@@ -442,9 +442,9 @@ indicates that the widget wants its current stacking order preserved.
<title>Resize Requests</title>
<para>
To make a simple resize request from a widget, you can use
-<function>XtMakeResizeRequest</function>
+<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>
as an alternative to
-<function>XtMakeGeometryRequest</function>.
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>.
</para>
<funcsynopsis id='XtMakeResizeRequest'>
@@ -507,9 +507,9 @@ Return the allowed widget width and height.
<para>
The
-<function>XtMakeResizeRequest</function>
+<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>
function, a simple interface to
-<function>XtMakeGeometryRequest</function>,
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>,
creates an
<function>XtWidgetGeometry</function>
structure and specifies that width and height should change
@@ -524,7 +524,7 @@ If the return value is
<emphasis remap='I'>width_return</emphasis> and <emphasis remap='I'>height_return</emphasis> contain a compromise width and height.
If these are acceptable,
the widget should immediately call
-<function>XtMakeResizeRequest</function>
+<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>
again and request that the compromise width and height be applied.
If the widget is not interested in
<function>XtGeometryAlmost</function>
@@ -595,7 +595,7 @@ therefore, a cache of size 1 is sufficient.
<title>Child Geometry Management: The geometry_manager Procedure</title>
<para>
The geometry_manager procedure pointer in a composite widget class is of type
-<function>XtGeometryHandler</function>.
+<xref linkend='XtGeometryHandler' xrefstyle='select: title'/>.
</para>
<funcsynopsis id='XtGeometryHandler'>
@@ -666,16 +666,16 @@ Then, it returns
<function>XtGeometryYes</function>,
and the values pointed to by the <emphasis remap='I'>geometry_return</emphasis> argument are undefined.
The widget's window is moved and resized automatically by
-<function>XtMakeGeometryRequest</function>.
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>.
</para>
<para>
Homogeneous composite widgets often find it convenient to treat the widget
making the request the same as any other widget, including reconfiguring
it using
-<function>XtConfigureWidget</function>
+<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>
or
-<function>XtResizeWidget</function>
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>
as part of its layout process, unless
<function>XtCWQueryOnly</function>
is specified.
@@ -683,7 +683,7 @@ If it does this,
it should return
<function>XtGeometryDone</function>
to inform
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
that it does not need to do the configuration itself.
</para>
@@ -693,9 +693,9 @@ To remain
compatible with layout techniques used in older widgets (before
<function>XtGeometryDone</function>
was added to the Intrinsics), a geometry manager should avoid using
-<function>XtResizeWidget</function>
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>
or
-<function>XtConfigureWidget</function>
+<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>
on the child making
the request because the layout process of the child may be in an
intermediate state in which it is not prepared to handle a call to its
@@ -707,7 +707,7 @@ clearly warns widget developers of the compatibility consequences.
<para>
Although
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
resizes the widget's window
(if the geometry
manager returns
@@ -759,7 +759,7 @@ the widget must decide if the compromise suggested in <emphasis remap='I'>geomet
is acceptable.
If it is, the widget must not change its geometry directly;
rather, it must make another call to
-<function>XtMakeGeometryRequest</function>.
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>.
</para>
<para>
@@ -782,12 +782,12 @@ To return
<function>XtGeometryYes</function>,
the geometry manager frequently rearranges the position of other managed
children by calling
-<function>XtMoveWidget</function>.
+<xref linkend='XtMoveWidget' xrefstyle='select: title'/>.
However, a few geometry managers may sometimes change the
size of other managed children by calling
-<function>XtResizeWidget</function>
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>
or
-<function>XtConfigureWidget</function>.
+<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>.
If
<function>XtCWQueryOnly</function>
is specified,
@@ -810,7 +810,7 @@ if necessary.
<para>
To move a sibling widget of the child making the geometry request,
the parent uses
-<function>XtMoveWidget</function>.
+<xref linkend='XtMoveWidget' xrefstyle='select: title'/>.
</para>
<funcsynopsis id='XtMoveWidget'>
@@ -854,11 +854,11 @@ Specify the new widget x and y coordinates.
</variablelist>
<para>
The
-<function>XtMoveWidget</function>
+<xref linkend='XtMoveWidget' xrefstyle='select: title'/>
function returns immediately if the specified geometry fields
are the same as the old values.
Otherwise,
-<function>XtMoveWidget</function>
+<xref linkend='XtMoveWidget' xrefstyle='select: title'/>
writes the new <emphasis remap='I'>x</emphasis> and <emphasis remap='I'>y</emphasis> values into the object
and, if the object is a widget and is realized, issues an Xlib
<function>XMoveWindow</function>
@@ -868,7 +868,7 @@ call on the widget's window.
<para>
To resize a sibling widget of the child making the geometry request,
the parent uses
-<function>XtResizeWidget</function>.
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>.
</para>
<funcsynopsis id='XtResizeWidget'>
@@ -921,11 +921,11 @@ Specify the new widget size.
</variablelist>
<para>
The
-<function>XtResizeWidget</function>
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>
function returns immediately if the specified geometry fields
are the same as the old values.
Otherwise,
-<function>XtResizeWidget</function>
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>
writes the new <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, and <emphasis remap='I'>border_width</emphasis> values into
the object and, if the object is a widget and is realized, issues an
<function>XConfigureWindow</function>
@@ -934,14 +934,14 @@ call on the widget's window.
<para>
If the new width or height is different from the old values,
-<function>XtResizeWidget</function>
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>
calls the object's resize procedure to notify it of the size change.
</para>
<para>
To move and resize the sibling widget of the child making the geometry request,
the parent uses
-<function>XtConfigureWidget</function>.
+<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>.
</para>
<funcsynopsis id='XtConfigureWidget'>
@@ -1014,11 +1014,11 @@ Specify the new widget size.
</variablelist>
<para>
The
-<function>XtConfigureWidget</function>
+<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>
function returns immediately if the specified new geometry fields
are all equal to the current values.
Otherwise,
-<function>XtConfigureWidget</function>
+<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>
writes the new <emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>, <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>,
and <emphasis remap='I'>border_width</emphasis> values
into the object and, if the object is a widget and is realized, makes an Xlib
@@ -1028,7 +1028,7 @@ call on the widget's window.
<para>
If the new width or height is different from its old value,
-<function>XtConfigureWidget</function>
+<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>
calls the object's resize procedure to notify it of the size change;
otherwise, it simply returns.
</para>
@@ -1036,7 +1036,7 @@ otherwise, it simply returns.
<para>
To resize a child widget that already has the new values of its width,
height, and border width, the parent uses
-<function>XtResizeWindow</function>.
+<xref linkend='XtResizeWindow' xrefstyle='select: title'/>.
</para>
<funcsynopsis id='XtResizeWindow'>
@@ -1060,7 +1060,7 @@ Specifies the widget. Must be of class Core or any subclass thereof.
</variablelist>
<para>
The
-<function>XtResizeWindow</function>
+<xref linkend='XtResizeWindow' xrefstyle='select: title'/>
function calls the
<function>XConfigureWindow</function>
Xlib function to make the window of the specified widget match its width,
@@ -1073,9 +1073,9 @@ Note that the widget's resize procedure is not called.
<para>
There are very few times to use
-<function>XtResizeWindow</function>;
+<xref linkend='XtResizeWindow' xrefstyle='select: title'/>;
instead, the parent should use
-<function>XtResizeWidget</function>.
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>.
</para>
</sect1>
@@ -1085,14 +1085,14 @@ instead, the parent should use
Some parents may be willing to adjust their layouts to accommodate the
preferred geometries of their children.
They can use
-<function>XtQueryGeometry</function>
+<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>
to obtain the preferred geometry
and, as they see fit, can use or ignore any portion of the response.
</para>
<para>
To query a child widget's preferred geometry, use
-<function>XtQueryGeometry</function>.
+<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>.
</para>
<funcsynopsis id='XtQueryGeometry'>
@@ -1143,23 +1143,23 @@ the child's parent stores the new
geometry in the corresponding fields of
the intended structure, sets the corresponding bits in <emphasis remap='I'>intended.request_mode</emphasis>,
and calls
-<function>XtQueryGeometry</function>.
+<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>.
The parent should set only those fields that are important to it so
that the child can determine whether it may be able to attempt changes to
other fields.
</para>
<para>
-<function>XtQueryGeometry</function>
+<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>
clears all bits in the <emphasis remap='I'>preferred_return-&gt;request_mode</emphasis>
field and checks the
<emphasis remap='I'>query_geometry</emphasis> field of the specified widget's class record.
If <emphasis remap='I'>query_geometry</emphasis> is not NULL,
-<function>XtQueryGeometry</function>
+<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>
calls the query_geometry procedure and passes as arguments the
specified widget, <emphasis remap='I'>intended</emphasis>, and <emphasis remap='I'>preferred_return</emphasis> structures.
If the <emphasis remap='I'>intended</emphasis> argument is NULL,
-<function>XtQueryGeometry</function>
+<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>
replaces it with a pointer to an
<function>XtWidgetGeometry</function>
structure with <emphasis remap='I'>request_mode</emphasis> equal to zero before calling the
@@ -1169,12 +1169,12 @@ query_geometry procedure.
<note>
<para>
If
-<function>XtQueryGeometry</function>
+<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>
is called from within a geometry_manager
procedure for the widget that issued
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
or
-<function>XtMakeResizeRequest</function>,
+<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>,
the results
are not guaranteed to be consistent with the requested changes. The
change request passed to the geometry manager takes precedence over
@@ -1184,7 +1184,7 @@ the preferred geometry.
<para>
The query_geometry procedure pointer is of type
-<function>XtGeometryHandler</function>.
+<xref linkend='XtGeometryHandler' xrefstyle='select: title'/>.
</para>
<funcsynopsis id='_XtGeometryHandler'>
@@ -1250,9 +1250,9 @@ the query_geometry procedure should return
<function>XtGeometryNo</function>.
The query_geometry procedure may assume
that no
-<function>XtMakeResizeRequest</function>
+<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>
or
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
is in progress
for the specified widget; that is, it is not required to construct
a reply consistent with the requested geometry if such a request
@@ -1262,7 +1262,7 @@ were actually outstanding.
<para>
After calling the query_geometry procedure
or if the <emphasis remap='I'>query_geometry</emphasis> field is NULL,
-<function>XtQueryGeometry</function>
+<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>
examines all the unset bits in <emphasis remap='I'>preferred_return-&gt;request_mode</emphasis>
and sets the corresponding fields in <emphasis remap='I'>preferred_return</emphasis>
to the current values from the widget instance.
@@ -1271,7 +1271,7 @@ If
is not set,
the <emphasis remap='I'>stack_mode</emphasis> field is set to
<function>XtSMDontChange</function>.
-<function>XtQueryGeometry</function>
+<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>
returns the value returned by the query_geometry procedure or
<function>XtGeometryYes</function>
if the <emphasis remap='I'>query_geometry</emphasis> field is NULL.
@@ -1300,7 +1300,7 @@ geometry information for the child.
<para>
Parents are expected to call
-<function>XtQueryGeometry</function>
+<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>
in their layout routine and wherever else the information is significant
after change_managed has been called.
The first time it is invoked,
@@ -1318,12 +1318,12 @@ A child can be resized by its parent at any time.
Widgets usually need to know when they have changed size
so that they can lay out their displayed data again to match the new size.
When a parent resizes a child, it calls
-<function>XtResizeWidget</function>,
+<xref linkend='XtResizeWidget' xrefstyle='select: title'/>,
which updates the geometry fields in the widget,
configures the window if the widget is realized,
and calls the child's resize procedure to notify the child.
The resize procedure pointer is of type
-<function>XtWidgetProc</function>.
+<xref linkend='XtWidgetProc' xrefstyle='select: title'/>.
</para>
<para>
@@ -1340,9 +1340,9 @@ as needed.
should recalculate the starting position of the text.)
The widget must obey resize as a command and must not treat it as a request.
A widget must not issue an
-<function>XtMakeGeometryRequest</function>
+<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>
or
-<function>XtMakeResizeRequest</function>
+<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>
call from its resize procedure.
</para>
</sect1>
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-08 09:40:37 +0000