diff options
Diffstat (limited to 'specs/CH09.xml')
| -rwxr-xr-x | specs/CH09.xml | 308 |
1 files changed, 154 insertions, 154 deletions
diff --git a/specs/CH09.xml b/specs/CH09.xml index 9a6bdfc..338539c 100755 --- a/specs/CH09.xml +++ b/specs/CH09.xml @@ -6,12 +6,12 @@ resource entry in the <emphasis remap='I'>resources</emphasis> list of the widge superclasses. This means that the field is settable by -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> (by naming the field in the argument list), by an entry in a resource file (by using either the name or class), and by -<function>XtSetValues</function>. +<xref linkend='XtSetValues' xrefstyle='select: title'/>. In addition, it is readable by -<function>XtGetValues</function>. +<xref linkend='XtGetValues' xrefstyle='select: title'/>. Not all fields in a widget record are resources. Some are for bookkeeping use by the generic routines (like <emphasis remap='I'>managed</emphasis> and <emphasis remap='I'>being_destroyed</emphasis>). @@ -24,7 +24,7 @@ and still others are derived from resources Widgets typically need to obtain a large set of resources at widget creation time. Some of the resources come from the argument list supplied in the call to -<function>XtCreateWidget</function>, +<xref linkend='XtCreateWidget' xrefstyle='select: title'/>, some from the resource database, and some from the internal defaults specified by the widget. Resources are obtained first from the argument list, @@ -382,7 +382,7 @@ compiler fills in the value. The <emphasis remap='I'>resource_offset</emphasis> field is the offset in bytes of the field within the widget. You should use the -<function>XtOffsetOf</function> +<xref linkend='XtOffsetOf' xrefstyle='select: title'/> macro to retrieve this value. The <emphasis remap='I'>default_type</emphasis> field is the representation type of the default resource value. @@ -433,7 +433,7 @@ This procedure is automatically invoked with the widget, in which to store the result. XtRCallProc procedure pointers are of type -<function>XtResourceDefaultProc</function>. +<xref linkend='XtResourceDefaultProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtResourceDefaultProc'> @@ -479,14 +479,14 @@ Specifies the resource value descriptor to return. </variablelist> <para> The -<function>XtResourceDefaultProc</function> +<xref linkend='XtResourceDefaultProc' xrefstyle='select: title'/> procedure should fill in the <emphasis remap='I'>value->addr</emphasis> field with a pointer to the resource value in its correct representation type. </para> <para> To get the resource list structure for a particular class, use -<function>XtGetResourceList</function>. +<xref linkend='XtGetResourceList' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetResourceList'> @@ -535,24 +535,24 @@ Returns the number of entries in the resource list. </variablelist> <para> If -<function>XtGetResourceList</function> +<xref linkend='XtGetResourceList' xrefstyle='select: title'/> is called before the class is initialized, it returns the resource list as specified in the class record. If it is called after the class has been initialized, -<function>XtGetResourceList</function> +<xref linkend='XtGetResourceList' xrefstyle='select: title'/> returns a merged resource list that includes the resources for all superclasses. The list returned by -<function>XtGetResourceList</function> +<xref linkend='XtGetResourceList' xrefstyle='select: title'/> should be freed using -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> when it is no longer needed. </para> <para> To get the constraint resource list structure for a particular widget class, use -<function>XtGetConstraintResourceList</function>. +<xref linkend='XtGetConstraintResourceList' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetConstraintResourceList'> @@ -600,11 +600,11 @@ Returns the number of entries in the constraint resource list. </variablelist> <para> If -<function>XtGetConstraintResourceList</function> +<xref linkend='XtGetConstraintResourceList' xrefstyle='select: title'/> is called before the widget class is initialized, the resource list as specified in the widget class Constraint part is returned. If -<function>XtGetConstraintResourceList</function> +<xref linkend='XtGetConstraintResourceList' xrefstyle='select: title'/> is called after the widget class has been initialized, the merged resource list for the class and all Constraint superclasses is returned. If the @@ -613,17 +613,17 @@ specified class is not a subclass of *<emphasis remap='I'>resources_return</emphasis> is set to NULL and *<emphasis remap='I'>num_resources_return</emphasis> is set to zero. The list returned by -<function>XtGetConstraintResourceList</function> +<xref linkend='XtGetConstraintResourceList' xrefstyle='select: title'/> should be freed using -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> when it is no longer needed. </para> <para> The routines -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> and -<function>XtGetValues</function> +<xref linkend='XtGetValues' xrefstyle='select: title'/> also use the resource list to set and get widget state; see Sections 9.7.1 and 9.7.2. </para> @@ -668,7 +668,7 @@ and the resource class of the specified field of the widget. <title>Byte Offset Calculations</title> <para> To determine the byte offset of a field within a structure type, use -<function>XtOffsetOf</function>. +<xref linkend='XtOffsetOf' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtOffsetOf'> @@ -705,18 +705,18 @@ Specifies the name of a member within the structure. </variablelist> <para> The -<function>XtOffsetOf</function> +<xref linkend='XtOffsetOf' xrefstyle='select: title'/> macro expands to a constant expression that gives the offset in bytes to the specified structure member from the beginning of the structure. It is normally used to statically initialize resource lists and is more portable than -<function>XtOffset</function>, +<xref linkend='XtOffset' xrefstyle='select: title'/>, which serves the same function. </para> <para> To determine the byte offset of a field within a structure pointer type, use -<function>XtOffset</function>. +<xref linkend='XtOffset' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtOffset'> @@ -751,14 +751,14 @@ Specifies the name of a member within the structure. </variablelist> <para> The -<function>XtOffset</function> +<xref linkend='XtOffset' xrefstyle='select: title'/> macro expands to a constant expression that gives the offset in bytes to the specified structure member from the beginning of the structure. It may be used to statically initialize resource lists. -<function>XtOffset</function> +<xref linkend='XtOffset' xrefstyle='select: title'/> is less portable than -<function>XtOffsetOf</function>. +<xref linkend='XtOffsetOf' xrefstyle='select: title'/>. </para> </sect1> @@ -766,7 +766,7 @@ is less portable than <title>Superclass-to-Subclass Chaining of Resource Lists</title> <para> The -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> function gets resources as a superclass-to-subclass chained operation. That is, the resources specified in the <function>objectClass</function> @@ -818,7 +818,7 @@ class_initialize procedure has returned. <para> A widget does not do anything to retrieve its own resources; instead, -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> does this automatically before calling the class initialize procedure. </para> @@ -826,7 +826,7 @@ does this automatically before calling the class initialize procedure. Some widgets have subparts that are not widgets but for which the widget would like to fetch resources. Such widgets call -<function>XtGetSubresources</function> +<xref linkend='XtGetSubresources' xrefstyle='select: title'/> to accomplish this. </para> @@ -930,7 +930,7 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtGetSubresources</function> +<xref linkend='XtGetSubresources' xrefstyle='select: title'/> function constructs a name and class list from the application name and class, the names and classes of all the object's ancestors, and the object itself. Then it appends to this list the <emphasis remap='I'>name</emphasis> and <emphasis remap='I'>class</emphasis> pair passed in. @@ -944,14 +944,14 @@ the argument list is not referenced. </para> <para> -<function>XtGetSubresources</function> +<xref linkend='XtGetSubresources' xrefstyle='select: title'/> may overwrite the specified resource list with an equivalent representation in an internal format, which optimizes access time if the list is used repeatedly. The resource list must be allocated in writable storage, and the caller must not modify the list contents after the call if the same list is to be used again. Resources fetched by -<function>XtGetSubresources</function> +<xref linkend='XtGetSubresources' xrefstyle='select: title'/> are reference-counted as if they were referenced by the specified object. Subresources might therefore be freed from the conversion cache and destroyed @@ -960,7 +960,7 @@ when the object is destroyed, but not before then. <para> To fetch resources for widget subparts using varargs lists, use -<function>XtVaGetSubresources</function>. +<xref linkend='XtVaGetSubresources' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaGetSubresources'> @@ -1051,9 +1051,9 @@ resource specifications. </varlistentry> </variablelist> <para> -<function>XtVaGetSubresources</function> +<xref linkend='XtVaGetSubresources' xrefstyle='select: title'/> is identical in function to -<function>XtGetSubresources</function> +<xref linkend='XtGetSubresources' 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> @@ -1064,7 +1064,7 @@ described in Section 2.5.1. <para> To retrieve resources that are not specific to a widget but apply to the overall application, use -<function>XtGetApplicationResources</function>. +<xref linkend='XtGetApplicationResources' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetApplicationResources'> @@ -1145,7 +1145,7 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtGetApplicationResources</function> +<xref linkend='XtGetApplicationResources' xrefstyle='select: title'/> function first uses the passed object, which is usually an application shell widget, to construct a resource name and class list. @@ -1155,7 +1155,7 @@ front of each resource name and class. Then it retrieves the resources from the argument list, the resource database, or the resource list default values. After adding base to each address, -<function>XtGetApplicationResources</function> +<xref linkend='XtGetApplicationResources' xrefstyle='select: title'/> copies the resources into the addresses obtained by adding <emphasis remap='I'>base</emphasis> to each <emphasis remap='I'>offset</emphasis> in the resource list. If <emphasis remap='I'>args</emphasis> is NULL, @@ -1168,20 +1168,20 @@ as the <emphasis remap='I'>base</emphasis> argument. </para> <para> -<function>XtGetApplicationResources</function> +<xref linkend='XtGetApplicationResources' xrefstyle='select: title'/> may overwrite the specified resource list with an equivalent representation in an internal format, which optimizes access time if the list is used repeatedly. The resource list must be allocated in writable storage, and the caller must not modify the list contents after the call if the same list is to be used again. Any per-display resources fetched by -<function>XtGetApplicationResources</function> +<xref linkend='XtGetApplicationResources' xrefstyle='select: title'/> will not be freed from the resource cache until the display is closed. </para> <para> To retrieve resources for the overall application using varargs lists, use -<function>XtVaGetApplicationResources</function>. +<xref linkend='XtVaGetApplicationResources' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaGetApplicationResources'> @@ -1250,9 +1250,9 @@ resource specifications. </varlistentry> </variablelist> <para> -<function>XtVaGetApplicationResources</function> +<xref linkend='XtVaGetApplicationResources' xrefstyle='select: title'/> is identical in function to -<function>XtGetApplicationResources</function> +<xref linkend='XtGetApplicationResources' 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> @@ -1590,7 +1590,7 @@ matching Visual on the list. The widget resource list must be certain to specify any resource of type <function>XtRVisual</function> after the depth resource. -The allowed string values are the visual class names defined in <emphasis remap='I'>X Window System Protocol</emphasis>, +The allowed string values are the visual class names defined in <emphasis remap='I'>(xP</emphasis>, Section 8; <function>StaticGray</function>, <function>StaticColor</function>, @@ -1745,7 +1745,7 @@ includes the NULL-terminating byte. <para> A resource converter procedure pointer is of type -<function>XtTypeConverter</function>. +<xref linkend='XtTypeConverter' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtTypeConverter'> @@ -1869,7 +1869,7 @@ if the conversion was successful and <function>False</function> otherwise. If the conversion cannot be performed because of an improper source value, a warning message should also be issued with -<function>XtAppWarningMsg</function>. +<xref linkend='XtAppWarningMsg' xrefstyle='select: title'/>. </para> <para> @@ -1889,9 +1889,9 @@ valid after the converter returns. Static variables may be used, as in the following example. If the converter modifies the resource database, the changes affect any in-progress widget creation, -<function>XtGetApplicationResources</function>, +<xref linkend='XtGetApplicationResources' xrefstyle='select: title'/>, or -<function>XtGetSubresources</function> +<xref linkend='XtGetSubresources' xrefstyle='select: title'/> in an implementation-defined manner; however, insertion of new entries or changes to existing entries is allowed and will not directly cause an error. @@ -1997,7 +1997,7 @@ converters, a resource destructor procedure may also be provided. <para> A resource destructor procedure pointer is of type -<function>XtDestructor</function>. +<xref linkend='XtDestructor' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtDestructor'> @@ -2077,7 +2077,7 @@ by <emphasis remap='I'>args</emphasis>. <title>Issuing Conversion Warnings</title> <para> The -<function>XtDisplayStringConversionWarning</function> +<xref linkend='XtDisplayStringConversionWarning' xrefstyle='select: title'/> procedure is a convenience routine for resource type converters that convert from string values. </para> @@ -2124,9 +2124,9 @@ Specifies the target representation type requested. </variablelist> <para> The -<function>XtDisplayStringConversionWarning</function> +<xref linkend='XtDisplayStringConversionWarning' xrefstyle='select: title'/> procedure issues a warning message using -<function>XtAppWarningMsg</function> +<xref linkend='XtAppWarningMsg' xrefstyle='select: title'/> with <emphasis remap='I'>name</emphasis> ``conversionError'', <emphasis remap='I'>type</emphasis> ``string'', <emphasis remap='I'>class</emphasis> ``XtToolkitError'', and the default message ``Cannot convert "<emphasis remap='I'>from_value</emphasis>" to type <emphasis remap='I'>to_type</emphasis>''. @@ -2135,15 +2135,15 @@ with <emphasis remap='I'>name</emphasis> ``conversionError'', <para> To issue other types of warning or error messages, the type converter should use -<function>XtAppWarningMsg</function> +<xref linkend='XtAppWarningMsg' xrefstyle='select: title'/> or -<function>XtAppErrorMsg</function>. +<xref linkend='XtAppErrorMsg' xrefstyle='select: title'/>. </para> <para> To retrieve the application context associated with a given display connection, use -<function>XtDisplayToApplicationContext</function>. +<xref linkend='XtDisplayToApplicationContext' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtDisplayToApplicationContext'> @@ -2167,7 +2167,7 @@ Specifies an open and initialized display connection. </variablelist> <para> The -<function>XtDisplayToApplicationContext</function> +<xref linkend='XtDisplayToApplicationContext' xrefstyle='select: title'/> function returns the application context in which the specified <emphasis remap='I'>display</emphasis> was initialized. If the display is not known to the Intrinsics, an error message is issued. @@ -2227,7 +2227,7 @@ Specifies that the results of a previous conversion should be used as for <function>XtCacheAll</function> but the destructor will be called, if specified, if -<function>XtCloseDisplay</function> +<xref linkend='XtCloseDisplay' xrefstyle='select: title'/> is called for the display connection associated with the converted value, and the value will be removed from the conversion cache. @@ -2240,11 +2240,11 @@ The qualifier may be ORed with any of the above values. If <function>XtCacheRefCount</function> is specified, calls to -<function>XtCreateWidget</function>, -<function>XtCreateManagedWidget</function>, -<function>XtGetApplicationResources</function>, +<xref linkend='XtCreateWidget' xrefstyle='select: title'/>, +<xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/>, +<xref linkend='XtGetApplicationResources' xrefstyle='select: title'/>, and -<function>XtGetSubresources</function> +<xref linkend='XtGetSubresources' xrefstyle='select: title'/> that use the converted value will be counted. When a widget using the converted value is destroyed, the count is decremented, and, if the count reaches zero, the destructor procedure will be called and the @@ -2254,9 +2254,9 @@ converted value will be removed from the conversion cache. <para> To register a type converter for all application contexts in a process, use -<function>XtSetTypeConverter</function>, +<xref linkend='XtSetTypeConverter' xrefstyle='select: title'/>, and to register a type converter in a single application context, use -<function>XtAppSetTypeConverter</function>. +<xref linkend='XtAppSetTypeConverter' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetTypeConverter'> @@ -2450,11 +2450,11 @@ required to deallocate resources produced by the converter. </varlistentry> </variablelist> <para> -<function>XtSetTypeConverter</function> +<xref linkend='XtSetTypeConverter' xrefstyle='select: title'/> registers the specified type converter and destructor in all application contexts created by the calling process, including any future application contexts that may be created. -<function>XtAppSetTypeConverter</function> +<xref linkend='XtAppSetTypeConverter' xrefstyle='select: title'/> registers the specified type converter in the single application context specified. If the same <emphasis remap='I'>from_type</emphasis> and <emphasis remap='I'>to_type</emphasis> are specified in multiple calls to either function, the most @@ -2523,7 +2523,7 @@ be invoked to return the conversion argument. If <function>XtProcedureArg</function> is specified, <emphasis remap='I'>address_id</emphasis> must contain the address of a function of type -<function>XtConvertArgProc</function>. +<xref linkend='XtConvertArgProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtConvertArgProc'> @@ -2603,8 +2603,8 @@ by <emphasis remap='I'>args</emphasis>. <title>Resource Converter Invocation</title> <para> All resource-fetching routines (for example, -<function>XtGetSubresources</function>, -<function>XtGetApplicationResources</function>, +<xref linkend='XtGetSubresources' xrefstyle='select: title'/>, +<xref linkend='XtGetApplicationResources' xrefstyle='select: title'/>, and so on) call resource converters if the resource database or varargs list specifies a value that has a different representation from the desired representation or if the @@ -2614,9 +2614,9 @@ representation. <para> To invoke explicit resource conversions, use -<function>XtConvertAndStore</function> +<xref linkend='XtConvertAndStore' xrefstyle='select: title'/> or -<function>XtCallConverter</function>. +<xref linkend='XtCallConverter' xrefstyle='select: title'/>. </para> <literallayout class="monospaced"> typedef XtPointer XtCacheRef; @@ -2710,7 +2710,7 @@ Returns a conversion cache id. </variablelist> <para> The -<function>XtCallConverter</function> +<xref linkend='XtCallConverter' xrefstyle='select: title'/> function looks up the specified type converter in the application context associated with the display and, if the converter was not registered or was registered @@ -2722,7 +2722,7 @@ looks in the conversion cache to see if this conversion procedure has been called with the specified conversion arguments. If so, it checks the success status of the prior call, and if the conversion failed, -<function>XtCallConverter</function> +<xref linkend='XtCallConverter' xrefstyle='select: title'/> returns <function>False</function> immediately; @@ -2733,17 +2733,17 @@ information stored in the cache into the location specified by <function>True</function>. If the size specified in the <emphasis remap='I'>to</emphasis> argument is smaller than the size stored in the cache, -<function>XtCallConverter</function> +<xref linkend='XtCallConverter' xrefstyle='select: title'/> copies the cache size into <emphasis remap='I'>to->size</emphasis> and returns <function>False</function>. If the converter was registered with cache type <function>XtCacheNone</function> or no value was found in the conversion cache, -<function>XtCallConverter</function> +<xref linkend='XtCallConverter' xrefstyle='select: title'/> calls the converter, and if it was not registered with cache type <function>XtCacheNone</function>, enters the result in the cache. -<function>XtCallConverter</function> +<xref linkend='XtCallConverter' xrefstyle='select: title'/> then returns what the converter returned. </para> @@ -2764,9 +2764,9 @@ value. <para> To explicitly decrement the reference counts for resources obtained from -<function>XtCallConverter</function>, +<xref linkend='XtCallConverter' xrefstyle='select: title'/>, use -<function>XtAppReleaseCacheRefs</function>. +<xref linkend='XtAppReleaseCacheRefs' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppReleaseCacheRefs'> @@ -2800,7 +2800,7 @@ Specifies the list of cache references to be released. </varlistentry> </variablelist> <para> -<function>XtAppReleaseCacheRefs</function> +<xref linkend='XtAppReleaseCacheRefs' xrefstyle='select: title'/> decrements the reference count for the conversion entries identified by the <emphasis remap='I'>refs</emphasis> argument. This argument is a @@ -2815,9 +2815,9 @@ the resource removed from the conversion cache. As a convenience to clients needing to explicitly decrement reference counts via a callback function, the Intrinsics define two callback procedures, -<function>XtCallbackReleaseCacheRef</function> +<xref linkend='XtCallbackReleaseCacheRef' xrefstyle='select: title'/> and -<function>XtCallbackReleaseCacheRefList</function>. +<xref linkend='XtCallbackReleaseCacheRefList' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCallbackReleaseCacheRef'> @@ -2927,7 +2927,7 @@ values. <para> To lookup and call a resource converter, copy the resulting value, and free a cached resource when a widget is destroyed, use -<function>XtConvertAndStore</function>. +<xref linkend='XtConvertAndStore' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtConvertAndStore'> @@ -2997,17 +2997,17 @@ will be returned. </variablelist> <para> The -<function>XtConvertAndStore</function> +<xref linkend='XtConvertAndStore' xrefstyle='select: title'/> function looks up the type converter registered to convert <emphasis remap='I'>from_type</emphasis> to <emphasis remap='I'>to_type</emphasis>, computes any additional arguments needed, and then calls -<function>XtCallConverter</function> +<xref linkend='XtCallConverter' xrefstyle='select: title'/> (or -<function>XtDirectConvert</function> +<xref linkend='XtDirectConvert' xrefstyle='select: title'/> if an old-style converter was registered with -<function>XtAddConverter</function> +<xref linkend='XtAddConverter' xrefstyle='select: title'/> or -<function>XtAppAddConverter</function>; +<xref linkend='XtAppAddConverter' xrefstyle='select: title'/>; see Appendix C) with the <emphasis remap='I'>from</emphasis> and <emphasis remap='I'>to_in_out</emphasis> arguments. The <emphasis remap='I'>to_in_out</emphasis> argument specifies the size and location into which the converted value will be stored and is passed directly to the @@ -3021,7 +3021,7 @@ descriptor. The <emphasis remap='I'>size</emphasis> field will be modified on return to indicate the actual size of the converted data. If the conversion succeeds, -<function>XtConvertAndStore</function> +<xref linkend='XtConvertAndStore' xrefstyle='select: title'/> returns <function>True</function>; otherwise, it returns @@ -3029,9 +3029,9 @@ otherwise, it returns </para> <para> -<function>XtConvertAndStore</function> +<xref linkend='XtConvertAndStore' xrefstyle='select: title'/> adds -<function>XtCallbackReleaseCacheRef</function> +<xref linkend='XtCallbackReleaseCacheRef' xrefstyle='select: title'/> to the destroyCallback list of the specified object if the conversion returns an <function>XtCacheRef</function> @@ -3040,9 +3040,9 @@ after the object has been destroyed. </para> <para> -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> performs processing equivalent to -<function>XtConvertAndStore</function> +<xref linkend='XtConvertAndStore' xrefstyle='select: title'/> when initializing the object instance. Because there is extra memory overhead required to implement reference counting, clients may distinguish those objects that are never destroyed before the @@ -3063,7 +3063,7 @@ XtCInitialResourcesPersistent. <para> When -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> is called, if this resource is not specified as <function>False</function> in either the arglist or the resource database, then the @@ -3080,7 +3080,7 @@ XtNinitialResourcesPersistent. <para> The resources are still freed and destructors called when -<function>XtCloseDisplay</function> +<xref linkend='XtCloseDisplay' xrefstyle='select: title'/> is called if the conversion was registered as <function>XtCacheByDisplay</function>. </para> @@ -3100,7 +3100,7 @@ derived fields appropriately. <para> To retrieve the current values of resources associated with a widget instance, use -<function>XtGetValues</function>. +<xref linkend='XtGetValues' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetValues'> @@ -3149,7 +3149,7 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtGetValues</function> +<xref linkend='XtGetValues' xrefstyle='select: title'/> function starts with the resources specified for the Object class and proceeds down the subclass chain to the class of the object. The <emphasis remap='I'>value</emphasis> field of a passed argument list must contain the @@ -3217,7 +3217,7 @@ resource representation type used within the object. <para> If the class of the object's parent is a subclass of <function>constraintWidgetClass</function>, -<function>XtGetValues</function> +<xref linkend='XtGetValues' xrefstyle='select: title'/> then fetches the values for any constraint resources requested. It starts with the constraint resources specified for <function>constraintWidgetClass</function> @@ -3229,7 +3229,7 @@ If any get_values_hook procedures in the object's class or superclass records are non-NULL, they are called in superclass-to-subclass order after all the resource values have been fetched by -<function>XtGetValues</function>. +<xref linkend='XtGetValues' xrefstyle='select: title'/>. Finally, if the object's parent is a subclass of <function>constraintWidgetClass</function>, @@ -3240,11 +3240,11 @@ records in the Constraint class part <emphasis remap='I'>extension</emphasis> field with a record type of <function>\s-1NULLQUARK\s+1</function>, and if 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 procedures in superclass-to-subclass order. This permits a Constraint parent to provide nonresource data via -<function>XtGetValues</function>. +<xref linkend='XtGetValues' xrefstyle='select: title'/>. </para> <para> @@ -3259,7 +3259,7 @@ object resource may invalidate the pointed-to data. <para> To retrieve the current values of resources associated with a widget instance using varargs lists, use -<function>XtVaGetValues</function>. +<xref linkend='XtVaGetValues' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaGetValues'> @@ -3294,9 +3294,9 @@ be returned. </varlistentry> </variablelist> <para> -<function>XtVaGetValues</function> +<xref linkend='XtVaGetValues' xrefstyle='select: title'/> is identical in function to -<function>XtGetValues</function> +<xref linkend='XtGetValues' 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. All value entries in the list must specify pointers to @@ -3314,10 +3314,10 @@ and the list entry is skipped. <title>Widget Subpart Resource Data: The get_values_hook Procedure</title> <para> Widgets that have subparts can return resource values from them through -<function>XtGetValues</function> +<xref linkend='XtGetValues' xrefstyle='select: title'/> by supplying a get_values_hook procedure. The get_values_hook procedure pointer is of type -<function>XtArgsProc</function>. +<xref linkend='XtArgsProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='_XtArgsProc'> @@ -3348,9 +3348,9 @@ Specifies the widget whose subpart resource values are to be retrieved. <listitem> <para> Specifies the argument list that was passed to -<function>XtGetValues</function> +<xref linkend='XtGetValues' xrefstyle='select: title'/> or the transformed varargs list passed to -<function>XtVaGetValues</function>. +<xref linkend='XtVaGetValues' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> @@ -3367,7 +3367,7 @@ Specifies the number of entries in the argument list. </variablelist> <para> The widget with subpart resources should call -<function>XtGetSubvalues</function> +<xref linkend='XtGetSubvalues' xrefstyle='select: title'/> in the get_values_hook procedure and pass in its subresource list and the <emphasis remap='I'>args</emphasis> and <emphasis remap='I'>num_args</emphasis> parameters. </para> @@ -3377,7 +3377,7 @@ and pass in its subresource list and the <emphasis remap='I'>args</emphasis> and <para> To retrieve the current values of subpart resource data associated with a widget instance, use -<function>XtGetSubvalues</function>. +<xref linkend='XtGetSubvalues' xrefstyle='select: title'/>. For a discussion of subpart resources, see Section 9.4. </para> @@ -3450,7 +3450,7 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtGetSubvalues</function> +<xref linkend='XtGetSubvalues' xrefstyle='select: title'/> function obtains resource values from the structure identified by <emphasis remap='I'>base</emphasis>. The <emphasis remap='I'>value</emphasis> field in each argument entry must contain the address into which to store the corresponding resource value. It is the caller's @@ -3463,7 +3463,7 @@ resource list, the value at the corresponding address is not modified. <para> To retrieve the current values of subpart resources associated with a widget instance using varargs lists, use -<function>XtVaGetSubvalues</function>. +<xref linkend='XtVaGetSubvalues' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaGetSubvalues'> @@ -3522,15 +3522,15 @@ values are to be stored. </varlistentry> </variablelist> <para> -<function>XtVaGetSubvalues</function> +<xref linkend='XtVaGetSubvalues' xrefstyle='select: title'/> is identical in function to -<function>XtGetSubvalues</function> +<xref linkend='XtGetSubvalues' 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. <function>XtVaTypedArg</function> is not supported for -<function>XtVaGetSubvalues</function>. +<xref linkend='XtVaGetSubvalues' xrefstyle='select: title'/>. If <function>XtVaTypedArg</function> is specified in the list, a warning message is issued @@ -3544,7 +3544,7 @@ and the entry is then ignored. <para> To modify the current values of resources associated with a widget instance, use -<function>XtSetValues</function>. +<xref linkend='XtSetValues' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetValues'> @@ -3591,26 +3591,26 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> function starts with the resources specified for the Object class fields and proceeds down the subclass chain to the object. At each stage, it replaces the <emphasis remap='I'>object</emphasis> resource fields with any values specified in the argument list. -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> then calls the set_values procedures for the object in superclass-to-subclass order. If the object has any non-NULL <emphasis remap='I'>set_values_hook</emphasis> fields, these are called immediately after the corresponding set_values procedure. This procedure permits subclasses to set subpart data via -<function>XtSetValues</function>. +<xref linkend='XtSetValues' xrefstyle='select: title'/>. </para> <para> If the class of the object's parent is a subclass of <function>constraintWidgetClass</function>, -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> also updates the object's constraints. It starts with the constraint resources specified for <function>constraintWidgetClass</function> @@ -3630,31 +3630,31 @@ do not match a resource list entry are silently ignored. <para> If the object is of a subclass of RectObj, -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> determines if a geometry request is needed by comparing the old object to the new object. If any geometry changes are required, -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> restores the original geometry and makes the request on behalf of the widget. If the geometry manager returns <function>XtGeometryYes</function>, -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> calls the object's resize procedure. If the geometry manager returns <function>XtGeometryDone</function>, -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> continues, as the object's resize procedure should have been called by the geometry manager. If the geometry manager returns <function>XtGeometryNo</function>, -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> ignores the geometry request and continues. If the geometry manager returns <function>XtGeometryAlmost</function>, -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> calls the set_values_almost procedure, which determines what should be done. -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> then repeats this process, deciding once more whether the geometry manager should be called. </para> @@ -3663,7 +3663,7 @@ deciding once more whether the geometry manager should be called. Finally, if any of the set_values procedures returned <function>True</function>, and the widget is realized, -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> causes the widget's expose procedure to be invoked by calling <function>XClearArea</function> on the widget's window. @@ -3672,7 +3672,7 @@ on the widget's window. <para> To modify the current values of resources associated with a widget instance using varargs lists, use -<function>XtVaSetValues</function>. +<xref linkend='XtVaSetValues' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaSetValues'> @@ -3707,9 +3707,9 @@ contain the resources to be modified and their new values. </varlistentry> </variablelist> <para> -<function>XtVaSetValues</function> +<xref linkend='XtVaSetValues' xrefstyle='select: title'/> is identical in function to -<function>XtSetValues</function> +<xref linkend='XtSetValues' 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> @@ -3717,7 +3717,7 @@ described in Section 2.5.1. <title>Widget State: The set_values Procedure</title> <para> The set_values procedure pointer in a widget class is of type -<function>XtSetValuesFunc</function>. +<xref linkend='XtSetValuesFunc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetValuesFunc'> @@ -3740,7 +3740,7 @@ The set_values procedure pointer in a widget class is of type <listitem> <para> Specifies a copy of the widget as it was before the -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> call. </para> </listitem> @@ -3752,7 +3752,7 @@ call. <listitem> <para> Specifies a copy of the widget with all values changed as asked for by the -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> call before any class set_values procedures have been called. </para> </listitem> @@ -3774,9 +3774,9 @@ Specifies the widget with the new values that are actually allowed. <listitem> <para> Specifies the argument list passed to -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> or the transformed argument list passed to -<function>XtVaSetValues</function>. +<xref linkend='XtVaSetValues' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> @@ -3881,7 +3881,7 @@ the X server will eventually generate an <function>Expose</function> event, if necessary. After calling all the set_values procedures, -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> forces a redisplay by calling <function>XClearArea</function> if any of the set_values procedures returned @@ -3892,18 +3892,18 @@ Therefore, a set_values procedure should not try to do its own redisplaying. <para> Set_values procedures should not do any work in response to changes in geometry because -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> eventually will perform a geometry request, and that request might be denied. If the widget actually changes size in response to a call to -<function>XtSetValues</function>, +<xref linkend='XtSetValues' xrefstyle='select: title'/>, its resize procedure is called. Widgets should do any geometry-related work in their resize procedure. </para> <para> Note that it is permissible to call -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> before a widget is realized. Therefore, the set_values procedure must not assume that the widget is realized. </para> @@ -3912,7 +3912,7 @@ Therefore, the set_values procedure must not assume that the widget is realized. <title>Widget State: The set_values_almost Procedure</title> <para> The set_values_almost procedure pointer in the widget class record is of type -<function>XtAlmostProc</function>. +<xref linkend='XtAlmostProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAlmostProc'> @@ -3934,7 +3934,7 @@ The set_values_almost procedure pointer in the widget class record is of type <listitem> <para> Specifies a copy of the object as it was before the -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> call. </para> </listitem> @@ -3989,7 +3989,7 @@ accepts the compromise suggested. <para> The set_values_almost procedure is called when a client tries to set a widget's geometry by means of a call to -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> and the geometry manager cannot satisfy the request but instead returns <function>XtGeometryNo</function> @@ -4000,7 +4000,7 @@ The <emphasis remap='I'>new</emphasis> object is the actual instance record. Th <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, and <emphasis remap='I'>border_width</emphasis> fields contain the original values as they were before the -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> call, and all other fields contain the new values. The <emphasis remap='I'>request</emphasis> parameter contains the new geometry request that was made to the parent. The <emphasis remap='I'>reply</emphasis> parameter contains @@ -4026,7 +4026,7 @@ directly. <title>Widget State: The ConstraintClassPart set_values Procedure</title> <para> The constraint set_values procedure pointer is of type -<function>XtSetValuesFunc</function>. +<xref linkend='XtSetValuesFunc' xrefstyle='select: title'/>. The values passed to the parent's constraint set_values procedure are the same as those passed to the child's class set_values procedure. @@ -4050,7 +4050,7 @@ widget. <para> To set the current values of subpart resources associated with a widget instance, use -<function>XtSetSubvalues</function>. +<xref linkend='XtSetSubvalues' xrefstyle='select: title'/>. For a discussion of subpart resources, see Section 9.4. </para> @@ -4122,7 +4122,7 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtSetSubvalues</function> +<xref linkend='XtSetSubvalues' xrefstyle='select: title'/> function updates the resource fields of the structure identified by <emphasis remap='I'>base</emphasis>. Any specified arguments that do not match an entry in the resource list are silently ignored. @@ -4131,7 +4131,7 @@ resource list are silently ignored. <para> To set the current values of subpart resources associated with a widget instance using varargs lists, use -<function>XtVaSetSubvalues</function>. +<xref linkend='XtVaSetSubvalues' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaSetSubvalues'> @@ -4188,14 +4188,14 @@ contain the resources to be modified and their new values. </varlistentry> </variablelist> <para> -<function>XtVaSetSubvalues</function> +<xref linkend='XtVaSetSubvalues' xrefstyle='select: title'/> is identical in function to -<function>XtSetSubvalues</function> +<xref linkend='XtSetSubvalues' 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. <function>XtVaTypedArg</function> is not supported for -<function>XtVaSetSubvalues</function>. +<xref linkend='XtVaSetSubvalues' xrefstyle='select: title'/>. If an entry containing <function>XtVaTypedArg</function> is specified in the list, a warning message is issued @@ -4213,10 +4213,10 @@ retained for those widgets that used it in versions prior to Release 4. </note> <para> Widgets that have a subpart can set the subpart resource values through -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> by supplying a set_values_hook procedure. The set_values_hook procedure pointer in a widget class is of type -<function>XtArgsFunc</function>. +<xref linkend='XtArgsFunc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtArgsFunc'> @@ -4246,9 +4246,9 @@ Specifies the widget whose subpart resource values are to be changed. <listitem> <para> Specifies the argument list that was passed to -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> or the transformed varargs list passed to -<function>XtVaSetValues</function>. +<xref linkend='XtVaSetValues' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> @@ -4265,7 +4265,7 @@ Specifies the number of entries in the argument list. </variablelist> <para> The widget with subpart resources may call -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> from the set_values_hook procedure and pass in its subresource list and the <emphasis remap='I'>args</emphasis> and <emphasis remap='I'>num_args</emphasis> parameters. |