diff options
author | Matt Dew <marcoz@osource.org> | 2011-10-21 22:37:06 -0600 |
---|---|---|
committer | Matt Dew <marcoz@osource.org> | 2011-10-21 22:37:06 -0600 |
commit | 6b4bcb3177919183bb6feb43054e6d85537d0e34 (patch) | |
tree | e6ffe5b793efca85ea8889f9861704fb1f8eb9de | |
parent | 626aa4bb299b936ee604082adfe9456c8217034d (diff) |
CH06.xml updated
-rw-r--r-- | specs/CH06.xml | 1001 |
1 files changed, 247 insertions, 754 deletions
diff --git a/specs/CH06.xml b/specs/CH06.xml index 4251af1..657df1f 100644 --- a/specs/CH06.xml +++ b/specs/CH06.xml @@ -1,77 +1,17 @@ -<!-- .\" $Xorg: CH06,v 1.3 2000/08/17 19:42:45 cpqbld Exp $ --> -<!-- .\" Copyright \(co 1985, 1986, 1987, 1988, 1991, 1994 --> -<!-- .\" X Consortium --> -<!-- .\" --> -<!-- .\" Permission is hereby granted, free of charge, to any person obtaining --> -<!-- .\" a copy of this software and associated documentation files (the --> -<!-- .\" "Software"), to deal in the Software without restriction, including --> -<!-- .\" without limitation the rights to use, copy, modify, merge, publish, --> -<!-- .\" distribute, sublicense, and/or sell copies of the Software, and to --> -<!-- .\" permit persons to whom the Software is furnished to do so, subject to --> -<!-- .\" the following conditions: --> -<!-- .\" --> -<!-- .\" The above copyright notice and this permission notice shall be included --> -<!-- .\" in all copies or substantial portions of the Software. --> -<!-- .\" --> -<!-- .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS --> -<!-- .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF --> -<!-- .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. --> -<!-- .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR --> -<!-- .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, --> -<!-- .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR --> -<!-- .\" OTHER DEALINGS IN THE SOFTWARE. --> -<!-- .\" --> -<!-- .\" Except as contained in this notice, the name of the X Consortium shall --> -<!-- .\" not be used in advertising or otherwise to promote the sale, use or --> -<!-- .\" other dealings in this Software without prior written authorization --> -<!-- .\" from the X Consortium. --> -<!-- .\" --> -<!-- .\" Copyright \(co 1985, 1986, 1987, 1988, 1991, 1994 --> -<!-- .\" Digital Equipment Corporation, Maynard, Massachusetts. --> -<!-- .\" --> -<!-- .\" Permission to use, copy, modify and distribute this documentation for any --> -<!-- .\" purpose and without fee is hereby granted, provided that the above copyright --> -<!-- .\" notice appears in all copies and that both that copyright notice and this --> -<!-- .\" permission notice appear in supporting documentation, and that the name of --> -<!-- .\" Digital not be used in in advertising or publicity pertaining --> -<!-- .\" to distribution of the software without specific, written prior permission. --> -<!-- .\" Digital makes no representations about the suitability of the --> -<!-- .\" software described herein for any purpose. --> -<!-- .\" It is provided ``as is'' without express or implied warranty. --> -<!-- .\" --> -\& -<!-- .sp 1 --> -<!-- .ce 3 --> -\s+1<function>Chapter 6</function>\s-1 - -\s+1<function>Geometry Management</function>\s-1 -<!-- .sp 2 --> -<!-- .nr H1 6 --> -<!-- .nr H2 0 --> -<!-- .nr H3 0 --> -<!-- .nr H4 0 --> -<!-- .nr H5 0 --> -<para> -<!-- .LP --> -<!-- .XS --> -<!-- Chapter 6 \(em Geometry Management --> -<!-- .XE --> -</para> +<chapter id='Geometry_Management'> +<title>Geometry Management</title> + <para> -<!-- .LP --> -<!-- .IN "geometry_manager procedure" --> -<!-- .IN "Geometry Management" --> -<!-- .IN "Configure Window" --> A widget does not directly control its size and location; rather, its parent is responsible for controlling them. Although the position of children is usually left up to their parent, the widgets themselves often have the best idea of their optimal sizes and, possibly, preferred locations. </para> + <para> -<!-- .LP --> To resolve physical layout conflicts between sibling widgets and between -a widget and its parent, the (xI provide the geometry management mechanism. +a widget and its parent, the Intrinsics provide the geometry management mechanism. Almost all composite widgets have a geometry manager specified in the <emphasis remap='I'>geometry_manager</emphasis> field @@ -80,26 +20,22 @@ stacking order of the widget's children. The only exception is fixed boxes, which create their children themselves and can ensure that their children will never make a geometry request. - </para> -<sect2 id="Initiating_Geometry_Changes"> + +<sect1 id="Initiating_Geometry_Changes"> <title>Initiating Geometry Changes</title> <para> -<!-- .LP --> -<!-- .XS --> -<!-- (SN Initiating Geometry Changes --> -<!-- .XE --> 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> +<function>XtMove\%Widget</function>, +<function>XtResizeWidget</function>, or -<function>XtConfigureWidget .</function> +<function>XtConfigureWidget</function>. A child must ask its parent for a geometry change by calling <function>XtMakeGeometryRequest</function> or -<function>XtMakeResizeRequest .</function> +<function>XtMakeResizeRequest</function>. An application or other client code initiates a geometry change by calling <function>XtSetValues</function> on the appropriate geometry fields, @@ -107,31 +43,31 @@ thereby giving the widget the opportunity to modify or reject the client request before it gets propagated to the parent and the opportunity to respond appropriately to the parent's reply. </para> + <para> -<!-- .LP --> When a widget that needs to change its size, position, border width, or stacking depth asks its parent's geometry manager to make the desired changes, the geometry manager can allow the request, disallow the request, or suggest a compromise. </para> + <para> -<!-- .LP --> 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> +<function>XtMoveWidget</function>. 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> +<function>XtResizeWidget</function>. 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> +<function>XtConfigureWidget</function>. </para> + <para> -<!-- .LP --> Often, geometry managers find that they can satisfy a request only if they can reconfigure a widget that they are not in control of; in particular, the @@ -141,19 +77,20 @@ In this case, the geometry manager makes a request to its parent's geometry manager. Geometry requests can cascade this way to arbitrary depth. </para> + <para> -<!-- .LP --> Because such cascaded arbitration of widget geometry can involve extended negotiation, windows are not actually allocated to widgets at application startup until all widgets are satisfied with their geometry; see Sections 2.5 and 2.6. -<!-- .NT Notes --> </para> + +<note> <itemizedlist> <listitem> <para> -The (xI treatment of stacking requests is deficient in several areas. +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> @@ -167,33 +104,22 @@ After a successful geometry request (one that returned a widget does not know whether its resize procedure has been called. Widgets should have resize procedures that can be called more than once without ill effects. -<!-- .NE --> - </para> </listitem> </itemizedlist> -</sect2> -<sect2 id="General_Geometry_Manager_Requests"> +</note> +</sect1> + +<sect1 id="General_Geometry_Manager_Requests"> <title>General Geometry Manager Requests</title> -<!-- .XS --> -<!-- (SN General Geometry Manager Requests --> -<!-- .XE --> <para> -<!-- .LP --> When making a geometry request, the child specifies an <function>XtWidgetGeometry</function> structure. </para> -<para> -<!-- .LP --> -<!-- .IN "XtGeometryMask" --> -<!-- .KS --> -<!-- .sM --> + <literallayout class="monospaced"> -<!-- .TA .5i 3i --> -<!-- .ta .5i 3i --> typedef unsigned long XtGeometryMask; - typedef struct { XtGeometryMask request_mode; Position x, y; @@ -203,29 +129,21 @@ typedef struct { int stack_mode; } XtWidgetGeometry; </literallayout> -<!-- .eM --> -<!-- .KE --> -</para> + <para> -<!-- .LP --> To make a general geometry manager request from a widget, use -<function>XtMakeGeometryRequest .</function> +<function>XtMakeGeometryRequest</function>. </para> -<para> -<!-- .LP --> -<!-- .IN "XtMakeGeometryRequest" "" "@DEF@" --> -<!-- .sM --> -</para> -<!-- .FD 0 --> -XtGeometryResult XtMakeGeometryRequest(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>request</emphasis>, \ -<emphasis remap='I'>reply_return</emphasis>) -<!-- .br --> - Widget <emphasis remap='I'>w</emphasis>; -<!-- .br --> - XtWidgetGeometry *<emphasis remap='I'>request</emphasis>; -<!-- .br --> - XtWidgetGeometry *<emphasis remap='I'>reply_return</emphasis>; -<!-- .FN --> + +<funcsynopsis id='XtMakeGeometryRequest'> +<funcprototype> +<funcdef>XtGeometryResult <function>XtMakeGeometryRequest</function></funcdef> + <paramdef>Widget <parameter>w</parameter></paramdef> + <paramdef>XtWidgetGeometry *<parameter>request</parameter></paramdef> + <paramdef>XtWidgetGeometry *<parameter>reply_return</parameter></paramdef> +</funcprototype> +</funcsynopsis> + <variablelist> <varlistentry> <term> @@ -233,7 +151,7 @@ XtGeometryResult XtMakeGeometryRequest(<emphasis remap='I'>w</emphasis>, <emphas </term> <listitem> <para> -Specifies the widget making the request. (rI +Specifies the widget making the request. Must be of class RectObj or any subclass thereof. </para> </listitem> </varlistentry> @@ -256,24 +174,24 @@ and stacking order). <para> Returns the allowed widget size, or may be NULL if the requesting widget is not interested in handling -<function>XtGeometryAlmost .</function> +<function>XtGeometryAlmost</function>. </para> </listitem> </varlistentry> </variablelist> + <para> -<!-- .LP --> -<!-- .eM --> Depending on the condition, <function>XtMakeGeometryRequest</function> performs the following: </para> + <itemizedlist> <listitem> <para> If the widget is unmanaged or the widget's parent is not realized, it makes the changes and returns -<function>XtGeometryYes .</function> +<function>XtGeometryYes</function>. </para> </listitem> <listitem> @@ -287,9 +205,9 @@ it issues an error. <listitem> <para> If the widget's <emphasis remap='I'>being_destroyed</emphasis> field is -<function>True ,</function> +<function>True</function>, it returns -<function>XtGeometryNo .</function> +<function>XtGeometryNo</function>. </para> </listitem> <listitem> @@ -298,7 +216,7 @@ If the widget <emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis> <emphasis remap='I'>border_width</emphasis> fields are all equal to the requested values, it returns -<function>XtGeometryYes ;</function> +<function>XtGeometryYes</function>; otherwise, it calls the parent's geometry_manager procedure with the given parameters. </para> @@ -321,15 +239,15 @@ and stacking order as appropriate). <listitem> <para> If the geometry manager returns -<function>XtGeometryDone ,</function> +<function>XtGeometryDone</function>, the change has been approved and actually has been done. In this case, <function>XtMakeGeometryRequest</function> does no configuring and returns -<function>XtGeometryYes .</function> +<function>XtGeometryYes</function>. <function>XtMakeGeometryRequest</function> never returns -<function>XtGeometryDone .</function> +<function>XtGeometryDone</function>. </para> </listitem> <listitem> @@ -340,26 +258,20 @@ just returns the resulting value from the parent's geometry manager. </para> </listitem> </itemizedlist> + <para> -<!-- .LP --> Children of primitive widgets are always unmanaged; therefore, <function>XtMakeGeometryRequest</function> always returns <function>XtGeometryYes</function> when called by a child of a primitive widget. </para> + <para> -<!-- .LP --> The return codes from geometry managers are -<!-- .IN "XtGeometryResult" --> </para> -<para> -<!-- .LP --> -<!-- .KS --> -<!-- .sM --> + <literallayout class="monospaced"> -<!-- .TA .5i 1.75i --> -<!-- .ta .5i 1.75i --> typedef enum { XtGeometryYes, XtGeometryNo, @@ -367,17 +279,12 @@ typedef enum { XtGeometryDone } XtGeometryResult; </literallayout> -<!-- .eM --> -<!-- .KE --> -</para> + <para> -<!-- .LP --> The <emphasis remap='I'>request_mode</emphasis> definitions are from <function>< X11/X.h >.</function> </para> -<para> -<!-- .LP --> -<!-- .sM --> + <informaltable> <tgroup cols='3' align='center'> <colspec colname='c1'/> @@ -385,181 +292,48 @@ The <emphasis remap='I'>request_mode</emphasis> definitions are from <colspec colname='c3'/> <tbody> <row> - <entry>lw(.5i) lw(2.5i) lw(.75i).</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>CWX</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>(1<<0)</entry> </row> <row> - <entry>T}</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>CWY</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>(1<<1)</entry> </row> <row> - <entry>T}</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>CWWidth</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>(1<<2)</entry> </row> <row> - <entry>T}</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>CWHeight</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>(1<<3)</entry> </row> <row> - <entry>T}</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>CWBorderWidth</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>(1<<4)</entry> </row> <row> - <entry>T}</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>CWSibling</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>(1<<5)</entry> </row> <row> - <entry>T}</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>CWStackMode</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>(1<<6)</entry> </row> - <row> - <entry>T}</entry> - </row> </tbody> </tgroup> </informaltable> -</para> + <para> -<!-- .LP --> -<!-- .eM --> -The (xI also support the following value. +The Intrinsics also support the following value. </para> -<para> -<!-- .LP --> -<!-- .sM --> + <informaltable> <tgroup cols='3' align='center'> <colspec colname='c1'/> @@ -567,60 +341,35 @@ The (xI also support the following value. <colspec colname='c3'/> <tbody> <row> - <entry>lw(.5i) lw(2.5i) lw(.75i).</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>XtCWQueryOnly</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>(1<<7)</entry> </row> - <row> - <entry>T}</entry> - </row> </tbody> </tgroup> </informaltable> -</para> + <para> -<!-- .LP --> -<!-- .eM --> <function>XtCWQueryOnly</function> indicates that the corresponding geometry request is only a query as to what would happen if this geometry request were made and that no widgets should actually be changed. </para> + <para> -<!-- .LP --> -<function>XtMakeGeometryRequest ,</function> +<function>XtMakeGeometryRequest</function>, like the <function>XConfigureWindow</function> Xlib function, uses <emphasis remap='I'>request_mode</emphasis> to determine which fields in the <function>XtWidgetGeometry</function> structure the caller wants to specify. </para> + <para> -<!-- .LP --> The <emphasis remap='I'>stack_mode</emphasis> definitions are from <function>< X11/X.h >:</function> </para> -<para> -<!-- .LP --> -<!-- .sM --> + <informaltable> <tgroup cols='3' align='center'> <colspec colname='c1'/> @@ -628,135 +377,38 @@ The <emphasis remap='I'>stack_mode</emphasis> definitions are from <colspec colname='c3'/> <tbody> <row> - <entry>lw(.5i) lw(2.5i) lw(.75i).</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>Above</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>0</entry> </row> <row> - <entry>T}</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>Below</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>1</entry> </row> <row> - <entry>T}</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>TopIf</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>2</entry> </row> <row> - <entry>T}</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>BottomIf</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>3</entry> </row> <row> - <entry>T}</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>Opposite</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>4</entry> </row> - <row> - <entry>T}</entry> - </row> </tbody> </tgroup> </informaltable> -</para> + <para> -<!-- .LP --> -<!-- .eM --> -The (xI also support the following value. +The Intrinsics also support the following value. </para> -<para> -<!-- .LP --> -<!-- .sM --> + <informaltable> <tgroup cols='3' align='center'> <colspec colname='c1'/> @@ -764,78 +416,46 @@ The (xI also support the following value. <colspec colname='c3'/> <tbody> <row> - <entry>lw(.5i) lw(2.5i) lw(.75i).</entry> - </row> - <row> - <entry>T{</entry> - </row> - <row> <entry>#define</entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry><function>XtSMDontChange</function></entry> - </row> - <row> - <entry>T}</entry> - <entry>T{</entry> - </row> - <row> <entry>5</entry> </row> - <row> - <entry>T}</entry> - </row> </tbody> </tgroup> </informaltable> -</para> + <para> -<!-- .LP --> -<!-- .eM --> For definition and behavior of -<function>Above ,</function> -<function>Below ,</function> -<function>TopIf ,</function> -<function>BottomIf ,</function> +<function>Above</function>, +<function>Below</function>, +<function>TopIf</function>, +<function>BottomIf</function>, and -<function>Opposite ,</function> -see Section 3.7 in <emphasis remap='I'>(xL</emphasis>. +<function>Opposite</function>, +see Section 3.7 in <emphasis remap='I'>Xlib — C Language X Interface.</emphasis>. <function>XtSMDontChange</function> indicates that the widget wants its current stacking order preserved. - </para> -</sect2> -<sect2 id="Resize_Requests"> +</sect1> + +<sect1 id="Resize_Requests"> <title>Resize Requests</title> -<!-- .XS --> -<!-- (SN Resize Requests --> -<!-- .XE --> <para> -<!-- .LP --> To make a simple resize request from a widget, you can use <function>XtMakeResizeRequest</function> as an alternative to -<function>XtMakeGeometryRequest .</function> -</para> -<para> -<!-- .LP --> -<!-- .IN "XtMakeResizeRequest" "" "@DEF@" --> -<!-- .sM --> +<function>XtMakeGeometryRequest</function>. </para> -<!-- .FD 0 --> -XtGeometryResult XtMakeResizeRequest(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, \ -<emphasis remap='I'>width_return</emphasis>, <emphasis remap='I'>height_return</emphasis>) -<!-- .br --> - Widget <emphasis remap='I'>w</emphasis>; -<!-- .br --> - Dimension <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>; -<!-- .br --> - Dimension *<emphasis remap='I'>width_return</emphasis>, *<emphasis remap='I'>height_return</emphasis>; -<!-- .FN --> + +<funcsynopsis id='XtMakeResizeRequest'> +<funcprototype> +<funcdef>XtGeometryResult <function>XtMakeResizeRequest</function></funcdef> + <paramdef>Widget <parameter>w</parameter></paramdef> + <paramdef>Dimension <parameter>width</parameter></paramdef> + <paramdef>Dimension *<parameter>width_return</parameter></paramdef> +</funcprototype> +</funcsynopsis> + <variablelist> <varlistentry> <term> @@ -843,7 +463,7 @@ XtGeometryResult XtMakeResizeRequest(<emphasis remap='I'>w</emphasis>, <emphasis </term> <listitem> <para> -Specifies the widget making the request. (rI +Specifies the widget making the request. Must be of class RectObj or any subclass thereof. </para> </listitem> </varlistentry> @@ -854,8 +474,6 @@ Specifies the widget making the request. (rI <listitem> <para> Specify the desired widget width and height. -<!-- .br --> -<!-- .ns --> </para> </listitem> </varlistentry> @@ -864,8 +482,7 @@ Specify the desired widget width and height. <emphasis remap='I'>height</emphasis> </term> <listitem> - <para> - </para> + <para></para> </listitem> </varlistentry> <varlistentry> @@ -875,8 +492,6 @@ Specify the desired widget width and height. <listitem> <para> Return the allowed widget width and height. -<!-- .br --> -<!-- .ns --> </para> </listitem> </varlistentry> @@ -885,29 +500,27 @@ Return the allowed widget width and height. <emphasis remap='I'>height_return</emphasis> </term> <listitem> - <para> - </para> + <para></para> </listitem> </varlistentry> </variablelist> + <para> -<!-- .LP --> -<!-- .eM --> The <function>XtMakeResizeRequest</function> function, a simple interface to -<function>XtMakeGeometryRequest ,</function> +<function>XtMakeGeometryRequest</function>, creates an <function>XtWidgetGeometry</function> structure and specifies that width and height should change by setting <emphasis remap='I'>request_mode</emphasis> to <function>CWWidth</function> <function>|</function> -<function>CWHeight .</function> +<function>CWHeight</function>. The geometry manager is free to modify any of the other window attributes (position or stacking order) to satisfy the resize request. If the return value is -<function>XtGeometryAlmost ,</function> +<function>XtGeometryAlmost</function>, <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 @@ -917,16 +530,12 @@ If the widget is not interested in <function>XtGeometryAlmost</function> replies, it can pass NULL for <emphasis remap='I'>width_return</emphasis> and <emphasis remap='I'>height_return</emphasis>. - </para> -</sect2> -<sect2 id="Potential_Geometry_Changes"> +</sect1> + +<sect1 id="Potential_Geometry_Changes"> <title>Potential Geometry Changes</title> -<!-- .XS --> -<!-- (SN Potential Geometry Changes --> -<!-- .XE --> <para> -<!-- .LP --> Sometimes a geometry manager cannot respond to a geometry request from a child without first making a geometry request to the widget's own parent (the original requestor's grandparent). @@ -945,21 +554,21 @@ To accomplish this, the geometry manager uses <function>XtCWQueryOnly</function> in the intermediate request. </para> + <para> -<!-- .LP --> When <function>XtCWQueryOnly</function> is used, the geometry manager needs to cache enough information to exactly reconstruct the intermediate request. If the grandparent's response to the intermediate query was -<function>XtGeometryAlmost ,</function> +<function>XtGeometryAlmost</function>, the geometry manager needs to cache the entire reply geometry in the event the child accepts the parent's compromise. </para> + <para> -<!-- .LP --> If the grandparent's response was -<function>XtGeometryAlmost ,</function> +<function>XtGeometryAlmost</function>, it may also be necessary to cache the entire reply geometry from the grandparent when <function>XtCWQueryOnly</function> @@ -973,40 +582,31 @@ a different compromise to the child, the grandparent's compromise should not be accepted until the child has accepted the new compromise. </para> + <para> -<!-- .LP --> Note that a compromise geometry returned with <function>XtGeometryAlmost</function> is guaranteed only for the next call to the same widget; therefore, a cache of size 1 is sufficient. - </para> -</sect2> -<sect2 id="Child_Geometry_Management_The_geometry_manager_Procedure"> +</sect1> + +<sect1 id="Child_Geometry_Management_The_geometry_manager_Procedure"> <title>Child Geometry Management: The geometry_manager Procedure</title> -<!-- .XS --> -<!-- (SN Child Geometry Management: The geometry_manager Procedure --> -<!-- .XE --> <para> -<!-- .LP --> The geometry_manager procedure pointer in a composite widget class is of type -<function>XtGeometryHandler .</function> -</para> -<para> -<!-- .LP --> -<!-- .IN "XtGeometryHandler" "" "@DEF@" --> -<!-- .sM --> +<function>XtGeometryHandler</function>. </para> -<!-- .FD 0 --> -typedef XtGeometryResult (*XtGeometryHandler)(Widget, XtWidgetGeometry*, \ -XtWidgetGeometry*); -<!-- .br --> - Widget <emphasis remap='I'>w</emphasis>; -<!-- .br --> - XtWidgetGeometry *<emphasis remap='I'>request</emphasis>; -<!-- .br --> - XtWidgetGeometry *<emphasis remap='I'>geometry_return</emphasis>; -<!-- .FN --> + +<funcsynopsis id='XtGeometryHandler'> +<funcprototype> +<funcdef>XtGeometryResult <function>*XtGeometryHandler</function></funcdef> + <paramdef>Widget <parameter>w</parameter></paramdef> + <paramdef>XtWidgetGeometry *<parameter>request</parameter></paramdef> + <paramdef>XtWidgetGeometry *<parameter>geometry_return</parameter></paramdef> +</funcprototype> +</funcsynopsis> + <variablelist> <varlistentry> <term> @@ -1041,13 +641,11 @@ compromise. </varlistentry> </variablelist> <para> -<!-- .LP --> -<!-- .eM --> A class can inherit its superclass's geometry manager during class initialization. </para> + <para> -<!-- .LP --> A bit set to zero in the request's <emphasis remap='I'>request_mode</emphasis> field means that the child widget does not care about the value of the corresponding field, @@ -1055,8 +653,8 @@ so the geometry manager can change this field as it wishes. A bit set to 1 means that the child wants that geometry element set to the value in the corresponding field. </para> + <para> -<!-- .LP --> If the geometry manager can satisfy all changes requested and if <function>XtCWQueryOnly</function> @@ -1065,13 +663,13 @@ it updates the widget's <emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y< and <emphasis remap='I'>border_width</emphasis> fields appropriately. Then, it returns -<function>XtGeometryYes ,</function> +<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> +<function>XtMakeGeometryRequest</function>. </para> + <para> -<!-- .LP --> Homogeneous composite widgets often find it convenient to treat the widget making the request the same as any other widget, including reconfiguring it using @@ -1087,11 +685,10 @@ it should return to inform <function>XtMakeGeometryRequest</function> that it does not need to do the configuration itself. -<!-- .NT --> To remain compatible with layout techniques used in older widgets (before <function>XtGeometryDone</function> -was added to the (xI), a geometry manager should avoid using +was added to the Intrinsics), a geometry manager should avoid using <function>XtResizeWidget</function> or <function>XtConfigureWidget</function> @@ -1101,10 +698,9 @@ intermediate state in which it is not prepared to handle a call to its resize procedure. A self-contained widget set may choose this alternative geometry management scheme, however, provided that it clearly warns widget developers of the compatibility consequences. -<!-- .NE --> </para> + <para> -<!-- .LP --> Although <function>XtMakeGeometryRequest</function> resizes the widget's window @@ -1115,16 +711,16 @@ it does not call the widget class's resize procedure. The requesting widget must perform whatever resizing calculations are needed explicitly. </para> + <para> -<!-- .LP --> If the geometry manager disallows the request, the widget cannot change its geometry. The values pointed to by <emphasis remap='I'>geometry_return</emphasis> are undefined, and the geometry manager returns -<function>XtGeometryNo .</function> +<function>XtGeometryNo</function>. </para> + <para> -<!-- .LP --> Sometimes the geometry manager cannot satisfy the request exactly but may be able to satisfy a similar request. That is, @@ -1136,7 +732,7 @@ In such cases, the geometry manager fills in the structure pointed to by <emphasis remap='I'>geometry_return</emphasis> with the actual changes it is willing to make, including an appropriate <emphasis remap='I'>request_mode</emphasis> mask, and returns -<function>XtGeometryAlmost .</function> +<function>XtGeometryAlmost</function>. If a bit in <emphasis remap='I'>geometry_return->request_mode</emphasis> is zero, the geometry manager agrees not to change the corresponding value if <emphasis remap='I'>geometry_return</emphasis> is used immediately @@ -1149,8 +745,8 @@ than in the original request if the geometry manager intends to change other fields should the child accept the compromise. </para> + <para> -<!-- .LP --> When <function>XtGeometryAlmost</function> is returned, @@ -1158,10 +754,10 @@ 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> +<function>XtMakeGeometryRequest</function>. </para> + <para> -<!-- .LP --> If the next geometry request from this child uses the <emphasis remap='I'>geometry_return</emphasis> values filled in by the geometry manager with an <function>XtGeometryAlmost</function> @@ -1170,23 +766,23 @@ either its parent or any of its other children, the geometry manager must grant the request, if possible. That is, if the child asks immediately with the returned geometry, it should get an answer of -<function>XtGeometryYes .</function> +<function>XtGeometryYes</function>. However, dynamic behavior in the user's window manager may affect the final outcome. </para> + <para> -<!-- .LP --> To return -<function>XtGeometryYes ,</function> +<function>XtGeometryYes</function>, the geometry manager frequently rearranges the position of other managed children by calling -<function>XtMoveWidget .</function> +<function>XtMoveWidget</function>. However, a few geometry managers may sometimes change the size of other managed children by calling <function>XtResizeWidget</function> or -<function>XtConfigureWidget .</function> +<function>XtConfigureWidget</function>. If <function>XtCWQueryOnly</function> is specified, @@ -1194,41 +790,33 @@ the geometry manager must return data describing how it would react to this geometry request without actually moving or resizing any widgets. </para> + <para> -<!-- .LP --> Geometry managers must not assume that the <emphasis remap='I'>request</emphasis> and <emphasis remap='I'>geometry_return</emphasis> arguments point to independent storage. The caller is permitted to use the same field for both, and the geometry manager must allocate its own temporary storage, if necessary. - </para> -</sect2> -<sect2 id="Widget_Placement_and_Sizing"> +</sect1> + +<sect1 id="Widget_Placement_and_Sizing"> <title>Widget Placement and Sizing</title> -<!-- .XS --> -<!-- (SN Widget Placement and Sizing --> -<!-- .XE --> <para> -<!-- .LP --> To move a sibling widget of the child making the geometry request, the parent uses -<function>XtMoveWidget .</function> +<function>XtMoveWidget</function>. </para> -<para> -<!-- .LP --> -<!-- .IN "XtMoveWidget" "" "@DEF@" --> -<!-- .sM --> -</para> -<!-- .FD 0 --> -void XtMoveWidget(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>) -<!-- .br --> - Widget <emphasis remap='I'>w</emphasis>; -<!-- .br --> - Position <emphasis remap='I'>x</emphasis>; -<!-- .br --> - Position <emphasis remap='I'>y</emphasis>; -<!-- .FN --> + +<funcsynopsis id='XtMoveWidget'> +<funcprototype> +<funcdef>void <function>XtMoveWidget</function></funcdef> + <paramdef>Widget <parameter>w</parameter></paramdef> + <paramdef>Position <parameter>x</parameter></paramdef> + <paramdef>Position <parameter>y</parameter></paramdef> +</funcprototype> +</funcsynopsis> + <variablelist> <varlistentry> <term> @@ -1236,7 +824,7 @@ void XtMoveWidget(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>x</empha </term> <listitem> <para> -Specifies the widget. (rI +Specifies the widget. Must be of class RectObj or any subclass thereof. </para> </listitem> </varlistentry> @@ -1245,10 +833,7 @@ Specifies the widget. (rI <emphasis remap='I'>x</emphasis> </term> <listitem> - <para> -<!-- .br --> -<!-- .ns --> - </para> + <para></para> </listitem> </varlistentry> <varlistentry> @@ -1263,8 +848,6 @@ Specify the new widget x and y coordinates. </varlistentry> </variablelist> <para> -<!-- .LP --> -<!-- .eM --> The <function>XtMoveWidget</function> function returns immediately if the specified geometry fields @@ -1275,30 +858,24 @@ writes the new <emphasis remap='I'>x</emphasis> and <emphasis remap='I'>y</empha and, if the object is a widget and is realized, issues an Xlib <function>XMoveWindow</function> call on the widget's window. -<!-- .sp --> </para> + <para> -<!-- .LP --> To resize a sibling widget of the child making the geometry request, the parent uses -<function>XtResizeWidget .</function> -</para> -<para> -<!-- .LP --> -<!-- .IN "XtResizeWidget" "" "@DEF@" --> -<!-- .sM --> +<function>XtResizeWidget</function>. </para> -<!-- .FD 0 --> -void XtResizeWidget(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, <emphasis remap='I'>border_width</emphasis>) -<!-- .br --> - Widget <emphasis remap='I'>w</emphasis>; -<!-- .br --> - Dimension <emphasis remap='I'>width</emphasis>; -<!-- .br --> - Dimension <emphasis remap='I'>height</emphasis>; -<!-- .br --> - Dimension <emphasis remap='I'>border_width</emphasis>; -<!-- .FN --> + +<funcsynopsis id='XtResizeWidget'> +<funcprototype> +<funcdef>void <function>XtResizeWidget</function></funcdef> + <paramdef>Widget <parameter>w</parameter></paramdef> + <paramdef>Dimension <parameter>width</parameter></paramdef> + <paramdef>Dimension <parameter>height</parameter></paramdef> + <paramdef>Dimension <parameter>border_width</parameter></paramdef> +</funcprototype> +</funcsynopsis> + <variablelist> <varlistentry> <term> @@ -1306,7 +883,7 @@ void XtResizeWidget(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>width< </term> <listitem> <para> -Specifies the widget. (rI +Specifies the widget. Must be of class RectObj or any subclass thereof. </para> </listitem> </varlistentry> @@ -1315,10 +892,7 @@ Specifies the widget. (rI <emphasis remap='I'>width</emphasis> </term> <listitem> - <para> -<!-- .br --> -<!-- .ns --> - </para> + <para></para> </listitem> </varlistentry> <varlistentry> @@ -1326,10 +900,7 @@ Specifies the widget. (rI <emphasis remap='I'>height</emphasis> </term> <listitem> - <para> -<!-- .br --> -<!-- .ns --> - </para> + <para></para> </listitem> </varlistentry> <varlistentry> @@ -1344,8 +915,6 @@ Specify the new widget size. </varlistentry> </variablelist> <para> -<!-- .LP --> -<!-- .eM --> The <function>XtResizeWidget</function> function returns immediately if the specified geometry fields @@ -1357,40 +926,31 @@ the object and, if the object is a widget and is realized, issues an <function>XConfigureWindow</function> call on the widget's window. </para> + <para> -<!-- .LP --> If the new width or height is different from the old values, <function>XtResizeWidget</function> calls the object's resize procedure to notify it of the size change. -<!-- .sp --> </para> + <para> -<!-- .LP --> To move and resize the sibling widget of the child making the geometry request, the parent uses -<function>XtConfigureWidget .</function> -</para> -<para> -<!-- .LP --> -<!-- .IN "XtConfigureWidget" "" "@DEF@" --> -<!-- .sM --> +<function>XtConfigureWidget</function>. </para> -<!-- .FD 0 --> -void XtConfigureWidget(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>, <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, \ -<emphasis remap='I'>border_width</emphasis>) -<!-- .br --> - Widget <emphasis remap='I'>w</emphasis>; -<!-- .br --> - Position <emphasis remap='I'>x</emphasis>; -<!-- .br --> - Position <emphasis remap='I'>y</emphasis>; -<!-- .br --> - Dimension <emphasis remap='I'>width</emphasis>; -<!-- .br --> - Dimension <emphasis remap='I'>height</emphasis>; -<!-- .br --> - Dimension <emphasis remap='I'>border_width</emphasis>; -<!-- .FN --> + +<funcsynopsis id='XtConfigureWidget'> +<funcprototype> +<funcdef>void <function>XtConfigureWidget</function></funcdef> + <paramdef>Widget <parameter>w</parameter></paramdef> + <paramdef>Position <parameter>x</parameter></paramdef> + <paramdef>Position <parameter>y</parameter></paramdef> + <paramdef>Dimension <parameter>width</parameter></paramdef> + <paramdef>Dimension <parameter>height</parameter></paramdef> + <paramdef>Dimension <parameter>border_width</parameter></paramdef> +</funcprototype> +</funcsynopsis> + <variablelist> <varlistentry> <term> @@ -1398,7 +958,7 @@ void XtConfigureWidget(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>x</ </term> <listitem> <para> -Specifies the widget. (rI +Specifies the widget. Must be of class RectObj or any subclass thereof. </para> </listitem> </varlistentry> @@ -1407,10 +967,7 @@ Specifies the widget. (rI <emphasis remap='I'>x</emphasis> </term> <listitem> - <para> -<!-- .br --> -<!-- .ns --> - </para> + <para></para> </listitem> </varlistentry> <varlistentry> @@ -1428,10 +985,7 @@ Specify the new widget x and y coordinates. <emphasis remap='I'>width</emphasis> </term> <listitem> - <para> -<!-- .br --> -<!-- .ns --> - </para> + <para></para> </listitem> </varlistentry> <varlistentry> @@ -1439,10 +993,7 @@ Specify the new widget x and y coordinates. <emphasis remap='I'>height</emphasis> </term> <listitem> - <para> -<!-- .br --> -<!-- .ns --> - </para> + <para></para> </listitem> </varlistentry> <varlistentry> @@ -1457,8 +1008,6 @@ Specify the new widget size. </varlistentry> </variablelist> <para> -<!-- .LP --> -<!-- .eM --> The <function>XtConfigureWidget</function> function returns immediately if the specified new geometry fields @@ -1471,30 +1020,27 @@ into the object and, if the object is a widget and is realized, makes an Xlib <function>XConfigureWindow</function> call on the widget's window. </para> + <para> -<!-- .LP --> If the new width or height is different from its old value, <function>XtConfigureWidget</function> calls the object's resize procedure to notify it of the size change; otherwise, it simply returns. -<!-- .sp --> </para> + <para> -<!-- .LP --> To resize a child widget that already has the new values of its width, height, and border width, the parent uses -<function>XtResizeWindow .</function> -</para> -<para> -<!-- .LP --> -<!-- .IN "XtResizeWindow" "" "@DEF@" --> -<!-- .sM --> +<function>XtResizeWindow</function>. </para> -<!-- .FD 0 --> -void XtResizeWindow(<emphasis remap='I'>w</emphasis>) -<!-- .br --> - Widget <emphasis remap='I'>w</emphasis>; -<!-- .FN --> + +<funcsynopsis id='XtResizeWindow'> +<funcprototype> +<funcdef>void <function>XtResizeWindow</function></funcdef> + <paramdef>Widget <parameter>w</parameter></paramdef> +</funcprototype> +</funcsynopsis> + <variablelist> <varlistentry> <term> @@ -1502,14 +1048,12 @@ void XtResizeWindow(<emphasis remap='I'>w</emphasis>) </term> <listitem> <para> -Specifies the widget. (cI +Specifies the widget. Must be of class Core or any subclass thereof. </para> </listitem> </varlistentry> </variablelist> <para> -<!-- .LP --> -<!-- .eM --> The <function>XtResizeWindow</function> function calls the @@ -1521,50 +1065,40 @@ inexpensive way to tell if these values match the current values. Note that the widget's resize procedure is not called. </para> + <para> -<!-- .LP --> There are very few times to use -<function>XtResizeWindow ;</function> +<function>XtResizeWindow</function>; instead, the parent should use -<function>XtResizeWidget .</function> - +<function>XtResizeWidget</function>. </para> -</sect2> -<sect2 id="Preferred_Geometry"> +</sect1> + +<sect1 id="Preferred_Geometry"> <title>Preferred Geometry</title> -<!-- .XS --> -<!-- (SN Preferred Geometry --> -<!-- .XE --> <para> -<!-- .LP --> Some parents may be willing to adjust their layouts to accommodate the preferred geometries of their children. They can use <function>XtQueryGeometry</function> to obtain the preferred geometry and, as they see fit, can use or ignore any portion of the response. -<!-- .sp --> </para> + <para> -<!-- .LP --> To query a child widget's preferred geometry, use -<function>XtQueryGeometry .</function> +<function>XtQueryGeometry</function>. </para> -<para> -<!-- .LP --> -<!-- .IN "XtQueryGeometry" "" "@DEF@" --> -<!-- .sM --> -</para> -<!-- .FD 0 --> -XtGeometryResult XtQueryGeometry(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>intended</emphasis>, \ -<emphasis remap='I'>preferred_return</emphasis>) -<!-- .br --> - Widget <emphasis remap='I'>w</emphasis>; -<!-- .br --> - XtWidgetGeometry *<emphasis remap='I'>intended</emphasis>; -<!-- .br --> - XtWidgetGeometry *<emphasis remap='I'>preferred_return</emphasis>; -<!-- .FN --> + +<funcsynopsis id='XtQueryGeometry'> +<funcprototype> +<funcdef>XtGeometryResult <function>XtQueryGeometry</function></funcdef> + <paramdef>Widget <parameter>w</parameter></paramdef> + <paramdef>XtWidgetGeometry *<parameter>intended</parameter></paramdef> + <paramdef>XtWidgetGeometry *<parameter>preferred_return</parameter></paramdef> +</funcprototype> +</funcsynopsis> + <variablelist> <varlistentry> <term> @@ -1572,7 +1106,7 @@ XtGeometryResult XtQueryGeometry(<emphasis remap='I'>w</emphasis>, <emphasis rem </term> <listitem> <para> -Specifies the widget. (rI +Specifies the widget. Must be of class RectObj or any subclass thereof. </para> </listitem> </varlistentry> @@ -1599,20 +1133,18 @@ Returns the child widget's preferred geometry. </varlistentry> </variablelist> <para> -<!-- .LP --> -<!-- .eM --> To discover a child's preferred geometry, 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> +<function>XtQueryGeometry</function>. 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> -<!-- .LP --> <function>XtQueryGeometry</function> clears all bits in the <emphasis remap='I'>preferred_return->request_mode</emphasis> field and checks the @@ -1627,41 +1159,33 @@ replaces it with a pointer to an <function>XtWidgetGeometry</function> structure with <emphasis remap='I'>request_mode</emphasis> equal to zero before calling the query_geometry procedure. -<!-- .NT --> If <function>XtQueryGeometry</function> is called from within a geometry_manager procedure for the widget that issued <function>XtMakeGeometryRequest</function> or -<function>XtMakeResizeRequest ,</function> +<function>XtMakeResizeRequest</function>, the results are not guaranteed to be consistent with the requested changes. The change request passed to the geometry manager takes precedence over the preferred geometry. -<!-- .NE --> -<!-- .sp --> </para> + <para> -<!-- .LP --> The query_geometry procedure pointer is of type -<function>XtGeometryHandler .</function> -</para> -<para> -<!-- .LP --> -<!-- .IN "query_geometry procedure" "" "@DEF@" --> -<!-- .sM --> +<function>XtGeometryHandler</function>. </para> -<!-- .FD 0 --> -typedef XtGeometryResult (*XtGeometryHandler)(Widget, XtWidgetGeometry*, \ -XtWidgetGeometry*); -<!-- .br --> - Widget <emphasis remap='I'>w</emphasis>; -<!-- .br --> - XtWidgetGeometry *<emphasis remap='I'>request</emphasis>; -<!-- .br --> - XtWidgetGeometry *<emphasis remap='I'>preferred_return</emphasis>; -<!-- .FN --> + +<funcsynopsis id='_XtGeometryHandler'> +<funcprototype> +<funcdef>XtGeometryResult <function>*XtGeometryHandler</function></funcdef> + <paramdef>Widget <parameter>w</parameter></paramdef> + <paramdef>XtWidgetGeometry *<parameter>request</parameter></paramdef> + <paramdef>XtWidgetGeometry *<parameter>preferred_return</parameter></paramdef> +</funcprototype> +</funcsynopsis> + <variablelist> <varlistentry> <term> @@ -1695,9 +1219,6 @@ Passes a structure in which the child returns its preferred geometry. </varlistentry> </variablelist> <para> -<!-- .LP --> -<!-- .eM --> -<!-- .IN "query_geometry procedure" --> The query_geometry procedure is expected to examine the bits set in <emphasis remap='I'>request->request_mode</emphasis>, evaluate the preferred geometry of the widget, and store the result in <emphasis remap='I'>preferred_return</emphasis> @@ -1705,7 +1226,7 @@ and store the result in <emphasis remap='I'>preferred_return</emphasis> to those geometry fields that it cares about). If the proposed geometry change is acceptable without modification, the query_geometry procedure should return -<function>XtGeometryYes .</function> +<function>XtGeometryYes</function>. If at least one field in <emphasis remap='I'>preferred_return</emphasis> with a bit set in <emphasis remap='I'>preferred_return->request_mode</emphasis> is different @@ -1713,11 +1234,10 @@ from the corresponding field in <emphasis remap='I'>request</emphasis> or if a bit was set in <emphasis remap='I'>preferred_return->request_mode</emphasis> that was not set in the request, the query_geometry procedure should return -<function>XtGeometryAlmost .</function> +<function>XtGeometryAlmost</function>. If the preferred geometry is identical to the current geometry, the query_geometry procedure should return -<function>XtGeometryNo .</function> -<!-- .NT --> +<function>XtGeometryNo</function>. The query_geometry procedure may assume that no <function>XtMakeResizeRequest</function> @@ -1727,10 +1247,9 @@ 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 were actually outstanding. -<!-- .NE --> </para> + <para> -<!-- .LP --> After calling the query_geometry procedure or if the <emphasis remap='I'>query_geometry</emphasis> field is NULL, <function>XtQueryGeometry</function> @@ -1741,14 +1260,14 @@ If <function>CWStackMode</function> is not set, the <emphasis remap='I'>stack_mode</emphasis> field is set to -<function>XtSMDontChange .</function> +<function>XtSMDontChange</function>. <function>XtQueryGeometry</function> returns the value returned by the query_geometry procedure or <function>XtGeometryYes</function> if the <emphasis remap='I'>query_geometry</emphasis> field is NULL. </para> + <para> -<!-- .LP --> Therefore, the caller can interpret a return of <function>XtGeometryYes</function> as not needing to evaluate the contents of the reply and, more important, @@ -1768,8 +1287,8 @@ In addition, whether or not the caller ignores the return value or the reply mask, it is guaranteed that the <emphasis remap='I'>preferred_return</emphasis> structure contains complete geometry information for the child. </para> + <para> -<!-- .LP --> Parents are expected to call <function>XtQueryGeometry</function> in their layout routine and wherever else the information is significant @@ -1779,30 +1298,25 @@ the changed_managed procedure may assume that the child's current geometry is its preferred geometry. Thus, the child is still responsible for storing values into its own geometry during its initialize procedure. - </para> -</sect2> -<sect2 id="Size_Change_Management_The_resize_Procedure"> +</sect1> + +<sect1 id="Size_Change_Management_The_resize_Procedure"> <title>Size Change Management: The resize Procedure</title> -<!-- .XS --> -<!-- (SN Size Change Management: The resize Procedure --> -<!-- .XE --> <para> -<!-- .LP --> 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> +<function>XtResizeWidget</function>, 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> -<!-- .IN "resize procedure" "" "@DEF@" --> +<function>XtWidgetProc</function>. </para> + <para> -<!-- .LP --> If a class need not recalculate anything when a widget is resized, it can specify NULL for the <emphasis remap='I'>resize</emphasis> field in its class record. This is an unusual case and should occur only for widgets @@ -1820,27 +1334,6 @@ A widget must not issue an or <function>XtMakeResizeRequest</function> call from its resize procedure. -<!-- .bp --> - - - - - - - - - - - - - - - - - - - </para> -</sect2> +</sect1> </chapter> -</book> |