diff options
Diffstat (limited to 'specs/CH03.xml')
| -rwxr-xr-x | specs/CH03.xml | 148 |
1 files changed, 74 insertions, 74 deletions
diff --git a/specs/CH03.xml b/specs/CH03.xml index 59fe18f..6fb9dc8 100755 --- a/specs/CH03.xml +++ b/specs/CH03.xml @@ -33,13 +33,13 @@ Mapping and unmapping of a subset of the managed children. </itemizedlist> <para> Overall management is handled by the generic procedures -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> and -<function>XtDestroyWidget</function>. -<function>XtCreateWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/>. +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> adds children to their parent by calling the parent's insert_child procedure. -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> removes children from their parent by calling the parent's delete_child procedure and ensures that all children of a destroyed composite widget also get destroyed. @@ -60,20 +60,20 @@ and, by definition, are not mapped by the Intrinsics. <para> Children are added to and removed from their parent's managed set by using -<function>XtManageChild</function>, -<function>XtManageChildren</function>, -<function>XtUnmanageChild</function>, -<function>XtUnmanageChildren</function>, +<xref linkend='XtManageChild' xrefstyle='select: title'/>, +<xref linkend='XtManageChildren' xrefstyle='select: title'/>, +<xref linkend='XtUnmanageChild' xrefstyle='select: title'/>, +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/>, and -<function>XtChangeManagedSet</function>, +<xref linkend='XtChangeManagedSet' xrefstyle='select: title'/>, which notify the parent to recalculate the physical layout of its children by calling the parent's change_managed procedure. The -<function>XtCreateManagedWidget</function> +<xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/> convenience function calls -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> and -<function>XtManageChild</function> +<xref linkend='XtManageChild' xrefstyle='select: title'/> on the result. </para> @@ -87,7 +87,7 @@ if their <emphasis remap='I'>map_when_managed</emphasis> field is The default is <function>True</function> and is changed by using -<function>XtSetMappedWhenManaged</function>. +<xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/>. </para> <para> @@ -151,10 +151,10 @@ events when the window size is changed by the window manager. <para> To add a child to the parent's list of children, the -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> function calls the parent's class routine insert_child. The insert_child procedure pointer in a composite widget is of type -<function>XtWidgetProc</function>. +<xref linkend='XtWidgetProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtWidgetProc_2'> @@ -233,7 +233,7 @@ supplying an XtNinsertPosition resource. The insert_position procedure pointer in a composite widget instance is of type -<function>XtOrderProc</function>. +<xref linkend='XtOrderProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtOrderProc'> @@ -282,11 +282,11 @@ or by the argument list provided when the composite widget is created. <para> To remove the child from the parent's <emphasis remap='I'>children</emphasis> list, the -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> function eventually causes a call to the Composite parent's class delete_child procedure. The delete_child procedure pointer is of type -<function>XtWidgetProc</function>. +<xref linkend='XtWidgetProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='_XtWidgetProc'> @@ -324,7 +324,7 @@ widgets to or the removal of widgets from a composite widget's managed set. These generic routines eventually call the composite widget's change_managed procedure if the procedure pointer is non-NULL. The change_managed procedure pointer is of type -<function>XtWidgetProc</function>. +<xref linkend='XtWidgetProc' xrefstyle='select: title'/>. The widget argument specifies the composite widget whose managed child set has been modified. </para> @@ -334,7 +334,7 @@ set has been modified. <para> To add a list of widgets to the geometry-managed (and hence displayable) subset of their Composite parent, use -<function>XtManageChildren</function>. +<xref linkend='XtManageChildren' xrefstyle='select: title'/>. </para> <para>typedef Widget *WidgetList;</para> @@ -372,7 +372,7 @@ Specifies the number of children in the list. </variablelist> <para> The -<function>XtManageChildren</function> +<xref linkend='XtManageChildren' xrefstyle='select: title'/> function performs the following: </para> <itemizedlist> @@ -387,7 +387,7 @@ if the parent's class is not a subclass of <para> Returns immediately if the common parent is being destroyed; otherwise, for each unique child on the list, -<function>XtManageChildren</function> +<xref linkend='XtManageChildren' xrefstyle='select: title'/> ignores the child if it already is managed or is being destroyed, and marks it if not. </para> @@ -408,7 +408,7 @@ Calls the change_managed routine of the widgets' parent. <listitem> <para> Calls -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> on each previously unmanaged child that is unrealized. </para> </listitem> @@ -429,7 +429,7 @@ should consider children whose <emphasis remap='I'>managed</emphasis> field is <function>True</function> and should ignore all other children. Note that some composite widgets, especially fixed boxes, call -<function>XtManageChild</function> +<xref linkend='XtManageChild' xrefstyle='select: title'/> from their insert_child procedure. </para> @@ -439,7 +439,7 @@ its change_managed procedure is called to notify it that its set of managed children has changed. The parent can reposition and resize any of its children. It moves each child as needed by calling -<function>XtMoveWidget</function>, +<xref linkend='XtMoveWidget' xrefstyle='select: title'/>, which first updates the <emphasis remap='I'>x</emphasis> and <emphasis remap='I'>y</emphasis> fields and which then calls <function>XMoveWindow</function>. </para> @@ -447,19 +447,19 @@ which first updates the <emphasis remap='I'>x</emphasis> and <emphasis remap='I' <para> If the composite widget wishes to change the size or border width of any of its children, it calls -<function>XtResizeWidget</function>, +<xref linkend='XtResizeWidget' xrefstyle='select: title'/>, which first updates the <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, and <emphasis remap='I'>border_width</emphasis> fields and then calls <function>XConfigureWindow</function>. Simultaneous repositioning and resizing may be done with -<function>XtConfigureWidget</function>; +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>; see Section 6.6. </para> <para> To add a single child to its parent widget's set of managed children, use -<function>XtManageChild</function>. +<xref linkend='XtManageChild' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtManageChild'> @@ -483,18 +483,18 @@ Specifies the child. Must be of class RectObj or any subclass thereof. </variablelist> <para> The -<function>XtManageChild</function> +<xref linkend='XtManageChild' xrefstyle='select: title'/> function constructs a <function>WidgetList</function> of length 1 and calls -<function>XtManageChildren</function>. +<xref linkend='XtManageChildren' xrefstyle='select: title'/>. </para> <para> To create and manage a child widget in a single procedure, use -<function>XtCreateManagedWidget</function> +<xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/> or -<function>XtVaCreateManagedWidget</function>. +<xref linkend='XtVaCreateManagedWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCreateManagedWidget'> @@ -563,11 +563,11 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtCreateManagedWidget</function> +<xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/> function is a convenience routine that calls -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> and -<function>XtManageChild</function>. +<xref linkend='XtManageChild' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaCreateManagedWidget'> @@ -624,9 +624,9 @@ resource specifications. </varlistentry> </variablelist> <para> -<function>XtVaCreateManagedWidget</function> +<xref linkend='XtVaCreateManagedWidget' xrefstyle='select: title'/> is identical in function to -<function>XtCreateManagedWidget</function> +<xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/> with the <emphasis remap='I'>args</emphasis> and <emphasis remap='I'>num_args</emphasis> parameters replaced by a varargs list, as described in Section 2.5.1. </para> @@ -636,7 +636,7 @@ by a varargs list, as described in Section 2.5.1. <title>Unmanaging Children</title> <para> To remove a list of children from a parent widget's managed list, use -<function>XtUnmanageChildren</function>. +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtUnmanageChildren'> @@ -672,7 +672,7 @@ Specifies the number of children. </variablelist> <para> The -<function>XtUnmanageChildren</function> +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/> function performs the following: </para> <itemizedlist> @@ -691,7 +691,7 @@ or if the parent is not a subclass of <listitem> <para> For each unique child on the list, -<function>XtUnmanageChildren</function> +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/> ignores the child if it is unmanaged; otherwise it performs the following: </para> </listitem> @@ -719,19 +719,19 @@ calls the change_managed routine of the widgets' parent. </listitem> </itemizedlist> <para> -<function>XtUnmanageChildren</function> +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/> does not destroy the child widgets. Removing widgets from a parent's managed set is often a temporary banishment, and some time later the client may manage the children again. To destroy widgets entirely, -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> should be called instead; see Section 2.9. </para> <para> To remove a single child from its parent widget's managed set, use -<function>XtUnmanageChild</function>. +<xref linkend='XtUnmanageChild' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtUnmanageChild'> @@ -755,10 +755,10 @@ Specifies the child. Must be of class RectObj or any subclass thereof. </variablelist> <para> The -<function>XtUnmanageChild</function> +<xref linkend='XtUnmanageChild' xrefstyle='select: title'/> function constructs a widget list of length 1 and calls -<function>XtUnmanageChildren</function>. +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/>. </para> <para> @@ -784,7 +784,7 @@ manage, or in just a single invocation. <para> To simultaneously remove from and add to the geometry-managed set of children of a composite parent, use -<function>XtChangeManagedSet</function>. +<xref linkend='XtChangeManagedSet' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtChangeManagedSet'> @@ -864,7 +864,7 @@ Specifies the number of entries in the <emphasis remap='I'>manage_children</emph </variablelist> <para> The -<function>XtChangeManagedSet</function> +<xref linkend='XtChangeManagedSet' xrefstyle='select: title'/> function performs the following: </para> <itemizedlist> @@ -895,7 +895,7 @@ If <emphasis remap='I'>do_change_proc</emphasis> is not NULL and the parent's <emphasis remap='I'>allows_change_managed_set</emphasis> field is <function>False</function>, then -<function>XtChangeManagedSet</function> +<xref linkend='XtChangeManagedSet' xrefstyle='select: title'/> performs the following: </para> </listitem> @@ -904,7 +904,7 @@ performs the following: <listitem> <para> Calls -<function>XtUnmanageChildren</function> +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/> (<emphasis remap='I'>unmanage_children</emphasis>, <emphasis remap='I'>num_unmanage_children</emphasis>). </para> </listitem> @@ -916,7 +916,7 @@ Calls the <emphasis remap='I'>do_change_proc</emphasis>. <listitem> <para> Calls -<function>XtManageChildren</function> +<xref linkend='XtManageChildren' xrefstyle='select: title'/> (<emphasis remap='I'>manage_children</emphasis>, <emphasis remap='I'>num_manage_children</emphasis>). </para> </listitem> @@ -955,7 +955,7 @@ marked as managed. If the parent is realized and after all children have been marked, the change_managed method of the parent is invoked, and subsequently some of the newly managed children are made viewable by calling -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> on each previously unmanaged child that is unrealized and mapping each previously unmanaged child that has <emphasis remap='I'>map_when_managed</emphasis> <function>True</function>. @@ -989,7 +989,7 @@ able to affect the child while it is in an unmanaged state. <para> The <emphasis remap='I'>do_change_proc</emphasis> is of type -<function>XtDoChangeProc</function>. +<xref linkend='XtDoChangeProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtDoChangeProc'> @@ -1063,18 +1063,18 @@ Passes the number of entries in the <emphasis remap='I'>manage_children</emphasi <listitem> <para> Passes the client data passed to -<function>XtChangeManagedSet</function>. +<xref linkend='XtChangeManagedSet' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> </variablelist> <para> The <emphasis remap='I'>do_change_proc</emphasis> procedure is used by the caller of -<function>XtChangeManagedSet</function> +<xref linkend='XtChangeManagedSet' xrefstyle='select: title'/> to make changes to one or more children at the point when the managed set contains the fewest entries. These changes may involve geometry requests, and in this case the caller of -<function>XtChangeManagedSet</function> +<xref linkend='XtChangeManagedSet' xrefstyle='select: title'/> may take advantage of the fact that the Intrinsics internally grant geometry requests made by unmanaged children without invoking the parent's geometry manager. To achieve this advantage, if @@ -1089,7 +1089,7 @@ that child should be included in the <emphasis remap='I'>unmanage_children</emph <title>Determining if a Widget Is Managed</title> <para> To determine the managed state of a given child widget, use -<function>XtIsManaged</function>. +<xref linkend='XtIsManaged' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtIsManaged'> @@ -1113,7 +1113,7 @@ Specifies the widget. Must be of class Object or any subclass thereof. </variablelist> <para> The -<function>XtIsManaged</function> +<xref linkend='XtIsManaged' xrefstyle='select: title'/> function returns <function>True</function> if the specified widget is of class RectObj or any subclass thereof @@ -1137,7 +1137,7 @@ or by setting the <emphasis remap='I'>map_when_managed</emphasis> field to <para> To change the value of a given widget's <emphasis remap='I'>map_when_managed</emphasis> field, use -<function>XtSetMappedWhenManaged</function>. +<xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetMappedWhenManaged'> @@ -1176,33 +1176,33 @@ field. If the widget is realized and managed, and if <emphasis remap='I'>map_when_managed</emphasis> is <function>True</function>, -<function>XtSetMappedWhenManaged</function> +<xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/> maps the window. If the widget is realized and managed, and if <emphasis remap='I'>map_when_managed</emphasis> is <function>False</function>, it unmaps the window. -<function>XtSetMappedWhenManaged</function> +<xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/> is a convenience function that is equivalent to (but slightly faster than) calling -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> and setting the new value for the XtNmappedWhenManaged resource then mapping the widget as appropriate. As an alternative to using -<function>XtSetMappedWhenManaged</function> +<xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/> to control mapping, a client may set <emphasis remap='I'>mapped_when_managed</emphasis> to <function>False</function> and use -<function>XtMapWidget</function> +<xref linkend='XtMapWidget' xrefstyle='select: title'/> and -<function>XtUnmapWidget</function> +<xref linkend='XtUnmapWidget' xrefstyle='select: title'/> explicitly. </para> <para> To map a widget explicitly, use -<function>XtMapWidget</function>. +<xref linkend='XtMapWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtMapWidget'> @@ -1226,7 +1226,7 @@ Specifies the widget. Must be of class Core or any subclass thereof. </variablelist> <para> To unmap a widget explicitly, use -<function>XtUnmapWidget</function>. +<xref linkend='XtUnmapWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtUnmapWidget'> @@ -1337,10 +1337,10 @@ but they are called whenever actions are performed on the parent's children. <para> The -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> function uses the <emphasis remap='I'>constraint_size</emphasis> field in the parent's class record to allocate a constraint record when a child is created. -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> also uses the constraint resources to fill in resource fields in the constraint record associated with a child. It then calls the constraint initialize procedure so that the parent @@ -1350,13 +1350,13 @@ and can possibly move or resize the child to conform to the given constraints. <para> When the -<function>XtGetValues</function> +<xref linkend='XtGetValues' xrefstyle='select: title'/> and -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> functions are executed on a child, they use the constraint resources to get the values or set the values of constraints associated with that child. -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> then calls the constraint set_values procedures so that the parent can recompute derived constraint fields and move or resize the child as appropriate. @@ -1371,19 +1371,19 @@ fields with a record type of <function>\s-1NULLQUARK\s+1</function> and the <emphasis remap='I'>get_values_hook</emphasis> field in the extension record is non-NULL, -<function>XtGetValues</function> +<xref linkend='XtGetValues' xrefstyle='select: title'/> calls the get_values_hook procedure(s) to allow the parent to return derived constraint fields. </para> <para> The -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> function calls the constraint destroy procedure to deallocate any dynamic storage associated with a constraint record. The constraint record itself must not be deallocated by the constraint destroy procedure; -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> does this automatically. </para> </sect1> |