diff options
author | Matt Dew <marcoz@osource.org> | 2011-10-28 21:54:31 -0600 |
---|---|---|
committer | Matt Dew <marcoz@osource.org> | 2011-10-28 21:54:31 -0600 |
commit | ba6dd48929114560d838aa29ce4111d8fdbf96e1 (patch) | |
tree | 1c5517ea6311e423cae3306ab552c68c61a13b67 | |
parent | 9dd4f4d51c31e4d89f5057cae23e49991594939a (diff) |
added xref links
-rwxr-xr-x | specs/CH01.xml | 58 | ||||
-rwxr-xr-x | specs/CH02.xml | 388 | ||||
-rwxr-xr-x | specs/CH03.xml | 148 | ||||
-rwxr-xr-x | specs/CH04.xml | 62 | ||||
-rwxr-xr-x | specs/CH05.xml | 130 | ||||
-rwxr-xr-x | specs/CH06.xml | 136 | ||||
-rwxr-xr-x | specs/CH07.xml | 552 | ||||
-rwxr-xr-x | specs/CH08.xml | 38 | ||||
-rwxr-xr-x | specs/CH09.xml | 308 | ||||
-rwxr-xr-x | specs/CH10.xml | 176 | ||||
-rwxr-xr-x | specs/CH11.xml | 672 | ||||
-rwxr-xr-x | specs/CH12.xml | 274 | ||||
-rwxr-xr-x | specs/CH13.xml | 116 | ||||
-rwxr-xr-x | specs/appB.xml | 4 | ||||
-rwxr-xr-x | specs/appC.xml | 286 | ||||
-rwxr-xr-x | specs/appF.xml | 2 |
16 files changed, 1675 insertions, 1675 deletions
diff --git a/specs/CH01.xml b/specs/CH01.xml index 4dab491..3fb7385 100755 --- a/specs/CH01.xml +++ b/specs/CH01.xml @@ -115,13 +115,13 @@ arbitrary expressions may be used as arguments. The following symbols are macros that do not have function equivalents and that may expand their arguments in a manner other than that described above: -<function>XtCheckSubclass</function>, -<function>XtNew</function>, -<function>XtNumber</function>, -<function>XtOffsetOf</function>, -<function>XtOffset</function>, +<xref linkend='XtCheckSubclass' xrefstyle='select: title'/>, +<xref linkend='XtNew' xrefstyle='select: title'/>, +<xref linkend='XtNumber' xrefstyle='select: title'/>, +<xref linkend='XtOffsetOf' xrefstyle='select: title'/>, +<xref linkend='XtOffset' xrefstyle='select: title'/>, and -<function>XtSetArg</function>. +<xref linkend='XtSetArg' xrefstyle='select: title'/>. </para> </sect1> @@ -470,13 +470,13 @@ from the resource lists, and by the initialize procedures, are <row> <entry>widget_class</entry> <entry><emphasis remap='I'>widget_class</emphasis> argument to - <function>XtCreateWidget</function> + <xref linkend='XtCreateWidget' xrefstyle='select: title'/> (may not be changed).</entry> </row> <row> <entry>parent</entry> <entry><emphasis remap='I'>parent</emphasis> argument to - <function>XtCreateWidget</function> + <xref linkend='XtCreateWidget' xrefstyle='select: title'/> (may not be changed).</entry> </row> <row> @@ -547,7 +547,7 @@ from the resource lists, and by the initialize procedures, are <row> <entry>name</entry> <entry><emphasis remap='I'>name</emphasis> argument to - <function>XtCreateWidget</function> + <xref linkend='XtCreateWidget' xrefstyle='select: title'/> (may not be changed).</entry> </row> <row> @@ -1806,7 +1806,7 @@ void LabelSetText(w, text) <title>Widget Class and Superclass Look Up</title> <para> To obtain the class of a widget, use -<function>XtClass</function>. +<xref linkend='XtClass' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtClass'> @@ -1830,7 +1830,7 @@ Specifies the widget. Must be of class Object or any subclass thereof. </variablelist> <para> The -<function>XtClass</function> +<xref linkend='XtClass' xrefstyle='select: title'/> function returns a pointer to the widget's class structure. </para> @@ -1869,7 +1869,7 @@ function returns a pointer to the widget's superclass class structure. <title>Widget Subclass Verification</title> <para> To check the subclass to which a widget belongs, use -<function>XtIsSubclass</function>. +<xref linkend='XtIsSubclass' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtIsSubclass'> @@ -1905,7 +1905,7 @@ Specifies the widget class for which to test. (oC <para> The -<function>XtIsSubclass</function> +<xref linkend='XtIsSubclass' xrefstyle='select: title'/> function returns <function>True</function> if the class of the specified widget is equal to @@ -1914,14 +1914,14 @@ The widget's class can be any number of subclasses down the chain and need not be an immediate subclass of the specified class. Composite widgets that need to restrict the class of the items they contain can use -<function>XtIsSubclass</function> +<xref linkend='XtIsSubclass' xrefstyle='select: title'/> to find out if a widget belongs to the desired class of objects. </para> <para> To test if a given widget belongs to a subclass of an Intrinsics-defined class, the Intrinsics define macros or functions equivalent to -<function>XtIsSubclass</function> +<xref linkend='XtIsSubclass' xrefstyle='select: title'/> for each of the built-in classes. These procedures are <function>XtIsObject</function>, <function>XtIsRectObj</function>, @@ -1964,14 +1964,14 @@ Specifies the widget or object instance whose class is to be checked. Must be o </variablelist> <para> These procedures may be faster than calling -<function>XtIsSubclass</function> +<xref linkend='XtIsSubclass' xrefstyle='select: title'/> directly for the built-in classes. </para> <para> To check a widget's class and to generate a debugging error message, use -<function>XtCheckSubclass</function>, +<xref linkend='XtCheckSubclass' xrefstyle='select: title'/>, defined in <function>< X11/IntrinsicP.h >:</function> </para> @@ -2019,23 +2019,23 @@ Specifies the message to be used. </variablelist> <para> The -<function>XtCheckSubclass</function> +<xref linkend='XtCheckSubclass' xrefstyle='select: title'/> macro determines if the class of the specified widget is equal to or is a subclass of the specified class. The widget's class can be any number of subclasses down the chain and need not be an immediate subclass of the specified class. If the specified widget's class is not a subclass, -<function>XtCheckSubclass</function> +<xref linkend='XtCheckSubclass' xrefstyle='select: title'/> constructs an error message from the supplied message, the widget's actual class, and the expected class and calls -<function>XtErrorMsg</function>. -<function>XtCheckSubclass</function> +<xref linkend='XtErrorMsg' xrefstyle='select: title'/>. +<xref linkend='XtCheckSubclass' xrefstyle='select: title'/> should be used at the entry point of exported routines to ensure that the client has passed in a valid widget class for the exported operation. </para> <para> -<function>XtCheckSubclass</function> +<xref linkend='XtCheckSubclass' xrefstyle='select: title'/> is only executed when the module has been compiled with the compiler symbol DEBUG defined; otherwise, it is defined as the empty string and generates no code. @@ -2244,7 +2244,7 @@ must start with their <emphasis remap='I'>class_inited</emphasis> field <para> The first time a widget of a class is created, -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> ensures that the widget class and all superclasses are initialized, in superclass-to-subclass order, by checking each <emphasis remap='I'>class_inited</emphasis> field and, if it is @@ -2274,7 +2274,7 @@ static void ClassInitialize() A class is initialized when the first widget of that class or any subclass is created. To initialize a widget class without creating any widgets, use -<function>XtInitializeWidgetClass</function>. +<xref linkend='XtInitializeWidgetClass' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtInitializeWidgetClass'> @@ -2300,7 +2300,7 @@ or any subclass thereof. </variablelist> <para> If the specified widget class is already initialized, -<function>XtInitializeWidgetClass</function> +<xref linkend='XtInitializeWidgetClass' xrefstyle='select: title'/> returns immediately. </para> @@ -2308,7 +2308,7 @@ returns immediately. If the class initialization procedure registers type converters, these type converters are not available until the first object of the class or subclass is created or -<function>XtInitializeWidgetClass</function> +<xref linkend='XtInitializeWidgetClass' xrefstyle='select: title'/> is called (see Section 9.6). </para> @@ -2531,7 +2531,7 @@ For example, a Composite class with predefined managed children can implement insert_child by first calling its superclass's <emphasis remap='I'>insert_child</emphasis> and then calling -<function>XtManageChild</function> +<xref linkend='XtManageChild' xrefstyle='select: title'/> to add the child to the managed set. </para> @@ -2685,7 +2685,7 @@ and the offset of the <emphasis remap='I'>extension</emphasis> field in the clas <para> To locate a class extension record, use -<function>XtGetClassExtension</function>. +<xref linkend='XtGetClassExtension' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetClassExtension'> @@ -2759,7 +2759,7 @@ The list of extension records at the specified offset in the specified object class will be searched for a match on the specified type, a version greater than or equal to the specified version, and a record size greater than or equal the specified record_size if it is nonzero. -<function>XtGetClassExtension</function> +<xref linkend='XtGetClassExtension' xrefstyle='select: title'/> returns a pointer to a matching extension record or NULL if no match is found. The returned extension record must not be modified or freed by the caller if the caller is not the extension owner. diff --git a/specs/CH02.xml b/specs/CH02.xml index b3a8115..017b2d9 100755 --- a/specs/CH02.xml +++ b/specs/CH02.xml @@ -3,7 +3,7 @@ <para> A hierarchy of widget instances constitutes a widget tree. The shell widget returned by -<function>XtAppCreateShell</function> +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/> is the root of the widget tree instance. The widgets with one or more children are the intermediate nodes of that tree, and the widgets with no children of any kind are the leaves of the widget tree. @@ -50,15 +50,15 @@ to perform the recursive operations themselves on behalf of their children. <para> A widget tree is manipulated by several Intrinsics functions. For example, -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> traverses the tree downward and recursively realizes all pop-up widgets and children of composite widgets. -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> traverses the tree downward and destroys all pop-up widgets and children of composite widgets. The functions that fetch and modify resources traverse the tree upward and determine the inheritance of resources from a widget's ancestors. -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> traverses the tree up one level and calls the geometry manager that is responsible for a widget child's geometry. </para> @@ -69,7 +69,7 @@ each widget has a pointer to its parent widget. The Shell widget that -<function>XtAppCreateShell</function> +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/> returns has a <emphasis remap='I'>parent</emphasis> pointer of NULL. </para> @@ -94,49 +94,49 @@ Before an application can call any Intrinsics function other than <function>XtSetLanguageProc</function> and -<function>XtToolkitThreadInitialize</function>, +<xref linkend='XtToolkitThreadInitialize' xrefstyle='select: title'/>, it must initialize the Intrinsics by using </para> <itemizedlist> <listitem> <para> -<function>XtToolkitInitialize</function>, +<xref linkend='XtToolkitInitialize' xrefstyle='select: title'/>, which initializes the Intrinsics internals </para> </listitem> <listitem> <para> -<function>XtCreateApplicationContext</function>, +<xref linkend='XtCreateApplicationContext' xrefstyle='select: title'/>, which initializes the per-application state </para> </listitem> <listitem> <para> -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> or -<function>XtOpenDisplay</function>, +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/>, which initializes the per-display state </para> </listitem> <listitem> <para> -<function>XtAppCreateShell</function>, +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/>, which creates the root of a widget tree </para> </listitem> </itemizedlist> <para> Or an application can call the convenience procedure -<function>XtOpenApplication</function>, +<xref linkend='XtOpenApplication' xrefstyle='select: title'/>, which combines the functions of the preceding procedures. An application wishing to use the ANSI C locale mechanism should call <function>XtSetLanguageProc</function> prior to calling -<function>XtDisplayInitialize</function>, -<function>XtOpenDisplay</function>, -<function>XtOpenApplication</function>, +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>, +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/>, +<xref linkend='XtOpenApplication' xrefstyle='select: title'/>, or -<function>XtAppInitialize</function>. +<xref linkend='XtAppInitialize' xrefstyle='select: title'/>. </para> <para> @@ -165,7 +165,7 @@ is opaque to clients. <para> To initialize the Intrinsics internals, use -<function>XtToolkitInitialize</function>. +<xref linkend='XtToolkitInitialize' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtToolkitInitialize'> @@ -177,19 +177,19 @@ To initialize the Intrinsics internals, use <para> If -<function>XtToolkitInitialize</function> +<xref linkend='XtToolkitInitialize' xrefstyle='select: title'/> was previously called, it returns immediately. When -<function>XtToolkitThreadInitialize</function> +<xref linkend='XtToolkitThreadInitialize' xrefstyle='select: title'/> is called before -<function>XtToolkitInitialize</function>, +<xref linkend='XtToolkitInitialize' xrefstyle='select: title'/>, the latter is protected against simultaneous activation by multiple threads. </para> <para> To create an application context, use -<function>XtCreateApplicationContext</function>. +<xref linkend='XtCreateApplicationContext' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCreateApplicationContext'> @@ -202,7 +202,7 @@ To create an application context, use <para> The -<function>XtCreateApplicationContext</function> +<xref linkend='XtCreateApplicationContext' xrefstyle='select: title'/> function returns an application context, which is an opaque type. Every application must have at least one application context. @@ -211,7 +211,7 @@ Every application must have at least one application context. <para> To destroy an application context and close any remaining display connections in it, use -<function>XtDestroyApplicationContext</function>. +<xref linkend='XtDestroyApplicationContext' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtDestroyApplicationContext'> @@ -235,16 +235,16 @@ Specifies the application context. </variablelist> <para> The -<function>XtDestroyApplicationContext</function> +<xref linkend='XtDestroyApplicationContext' xrefstyle='select: title'/> function destroys the specified application context. If called from within an event dispatch (for example, in a callback procedure), -<function>XtDestroyApplicationContext</function> +<xref linkend='XtDestroyApplicationContext' xrefstyle='select: title'/> does not destroy the application context until the dispatch is complete. </para> <para> To get the application context in which a given widget was created, use -<function>XtWidgetToApplicationContext</function>. +<xref linkend='XtWidgetToApplicationContext' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtWidgetToApplicationContext'> @@ -268,13 +268,13 @@ Specifies the widget for which you want the application context. Must be of cla </variablelist> <para> The -<function>XtWidgetToApplicationContext</function> +<xref linkend='XtWidgetToApplicationContext' xrefstyle='select: title'/> function returns the application context for the specified widget. </para> <para> To initialize a display and add it to an application context, use -<function>XtDisplayInitialize</function>. +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtDisplayInitialize'> @@ -381,7 +381,7 @@ Specifies the list of command line parameters. </variablelist> <para> The -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> function retrieves the language string to be used for the specified display (see Section 11.11), calls the language procedure (if set) with that language string, @@ -402,7 +402,7 @@ On POSIX-based systems, the application name is usually the final component of <emphasis remap='I'>argv</emphasis>[0]. If the synchronous resource is <function>True</function>, -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> calls the Xlib <function>XSynchronize</function> function to put Xlib into synchronous mode for this display connection @@ -412,7 +412,7 @@ See Sections 2.3 and 2.4 for details on the <emphasis remap='I'>application_name </para> <para> -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> calls <function>XrmSetDatabase</function> to associate the resource database of the default screen with the @@ -422,7 +422,7 @@ display before returning. <para> To open a display, initialize it, and then add it to an application context, use -<function>XtOpenDisplay</function>. +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtOpenDisplay'> @@ -529,12 +529,12 @@ Specifies the list of command line parameters. </variablelist> <para> The -<function>XtOpenDisplay</function> +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/> function calls <function>XOpenDisplay</function> with the specified <emphasis remap='I'>display_string</emphasis>. If <emphasis remap='I'>display_string</emphasis> is NULL, -<function>XtOpenDisplay</function> +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/> uses the current value of the \-display option specified in <emphasis remap='I'>argv</emphasis>. If no display is specified in <emphasis remap='I'>argv</emphasis>, the user's default display is retrieved from the environment. @@ -546,15 +546,15 @@ environment variable. <para> If this succeeds, -<function>XtOpenDisplay</function> +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/> then calls -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> and passes it the opened display and the value of the \-name option specified in <emphasis remap='I'>argv</emphasis> as the application name. If no \-name option is specified and <emphasis remap='I'>application_name</emphasis> is non-NULL, <emphasis remap='I'>application_name</emphasis> is passed to -<function>XtDisplayInitialize</function>. +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>. If <emphasis remap='I'>application_name</emphasis> is NULL and if the environment variable <emphasis role='bold'>RESOURCE_NAME</emphasis> is set, the value of @@ -565,19 +565,19 @@ conform to ANSI C Hosted Environment support, the application name will be <emphasis remap='I'>argv</emphasis>[0] less any directory and file type components, that is, the final component of <emphasis remap='I'>argv</emphasis>[0], if specified. If <emphasis remap='I'>argv</emphasis>[0] does not exist or is the empty string, the application name is ``main''. -<function>XtOpenDisplay</function> +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/> returns the newly opened display or NULL if it failed. </para> <para> See Section 7.12 for information regarding the use of -<function>XtOpenDisplay</function> +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/> in multiple threads. </para> <para> To close a display and remove it from an application context, use -<function>XtCloseDisplay</function>. +<xref linkend='XtCloseDisplay' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCloseDisplay'> @@ -601,23 +601,23 @@ Specifies the display. </variablelist> <para> The -<function>XtCloseDisplay</function> +<xref linkend='XtCloseDisplay' xrefstyle='select: title'/> function calls <function>XCloseDisplay</function> with the specified <emphasis remap='I'>display</emphasis> as soon as it is safe to do so. If called from within an event dispatch (for example, a callback procedure), -<function>XtCloseDisplay</function> +<xref linkend='XtCloseDisplay' xrefstyle='select: title'/> does not close the display until the dispatch is complete. Note that applications need only call -<function>XtCloseDisplay</function> +<xref linkend='XtCloseDisplay' xrefstyle='select: title'/> if they are to continue executing after closing the display; otherwise, they should call -<function>XtDestroyApplicationContext</function>. +<xref linkend='XtDestroyApplicationContext' xrefstyle='select: title'/>. </para> <para> See Section 7.12 for information regarding the use of -<function>XtCloseDisplay</function> +<xref linkend='XtCloseDisplay' xrefstyle='select: title'/> in multiple threads. </para> </sect1> @@ -683,10 +683,10 @@ Passes the additional client data specified in the call to <para> The language procedure allows an application to set the locale to the value of the language resource determined by -<function>XtDisplayInitialize</function>. +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>. The function returns a new language string that will be subsequently used by -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> to establish the path for loading resource files. The returned string will be copied by the Intrinsics into new memory. </para> @@ -694,7 +694,7 @@ string will be copied by the Intrinsics into new memory. <para> Initially, no language procedure is set by the Intrinsics. To set the language procedure for use by -<function>XtDisplayInitialize</function>, +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>, use <function>XtSetLanguageProc</function>. </para> @@ -745,7 +745,7 @@ procedure when it is called. <para> <function>XtSetLanguageProc</function> sets the language procedure that will be called from -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> for all subsequent Displays initialized in the specified application context. If <emphasis remap='I'>app_context</emphasis> is NULL, the specified language procedure is registered in all application contexts created by the @@ -772,7 +772,7 @@ systems this is done by calling <function>LC_ALL</function>, <emphasis remap='I'>language</emphasis> ). If an error is encountered, a warning message is issued with -<function>XtWarning</function>. +<xref linkend='XtWarning' xrefstyle='select: title'/>. </para> </listitem> <listitem> @@ -781,7 +781,7 @@ Calls <function>XSupportsLocale</function> to verify that the current locale is supported. If the locale is not supported, a warning message is issued with -<function>XtWarning</function> +<xref linkend='XtWarning' xrefstyle='select: title'/> and the locale is set to ``C''. </para> </listitem> @@ -807,7 +807,7 @@ A client wishing to use this mechanism to establish locale can do so by calling <function>XtSetLanguageProc</function> prior to -<function>XtDisplayInitialize</function>, +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>, as in the following example. </para> <literallayout class="monospaced"> @@ -822,7 +822,7 @@ as in the following example. <title>Loading the Resource Database</title> <para> The -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> function first determines the language string to be used for the specified display. It then creates a resource database for the default screen of the display by @@ -865,7 +865,7 @@ Application-specific class resource file on the local host. <para> When the resource database for a particular screen on the display is needed (either internally, or when -<function>XtScreenDatabase</function> +<xref linkend='XtScreenDatabase' xrefstyle='select: title'/> is called), it is created in the following manner using the sources listed above in the same order: @@ -886,21 +886,21 @@ preference resource file is $HOME/<function>.Xdefaults</function>. <listitem> <para> If a language procedure has been set, -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> first searches the command line for the option ``-xnlLanguage'', or for a -xrm option that specifies the xnlLanguage/XnlLanguage resource, as specified by Section 2.4. If such a resource is found, the value is assumed to be entirely in XPCS, the X Portable Character Set. If neither option is specified on the command line, -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> queries the server resource database (which is assumed to be entirely in XPCS) for the resource <emphasis remap='I'>name</emphasis><function>.xnlLanguage</function>, class <emphasis remap='I'>Class</emphasis><function>.XnlLanguage</function> where <emphasis remap='I'>name</emphasis> and <emphasis remap='I'>Class</emphasis> are the <emphasis remap='I'>application_name</emphasis> and <emphasis remap='I'>application_class</emphasis> specified to -<function>XtDisplayInitialize</function>. +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>. The language procedure is then invoked with the resource value if found, else the empty string. The string returned from the language procedure is saved for all future @@ -977,7 +977,7 @@ The file name is found by calling <function>XrmSetDatabase</function> with the current screen resource database, after preserving the original display-associated database, then calling -<function>XtResolvePathname</function> +<xref linkend='XtResolvePathname' xrefstyle='select: title'/> with the parameters (<emphasis remap='I'>display</emphasis>, NULL, NULL, NULL, <emphasis remap='I'>path</emphasis>, NULL, 0, NULL), where <emphasis remap='I'>path</emphasis> is defined in an operating-system-specific way. @@ -1048,7 +1048,7 @@ This file is owned by the application and is usually installed in a system directory when the application is installed. It may contain sitewide customizations specified by the system manager. The name of the application class resource file is found by calling -<function>XtResolvePathname</function> +<xref linkend='XtResolvePathname' xrefstyle='select: title'/> with the parameters (<emphasis remap='I'>display</emphasis>, ``app-defaults'', NULL, NULL, NULL, NULL, 0, NULL). This file is expected to be provided by the developer of the application @@ -1056,15 +1056,15 @@ and may be required for the application to function properly. A simple application that wants to be assured of having a minimal set of resources in the absence of its class resource file can declare fallback resource specifications with -<function>XtAppSetFallbackResources</function>. +<xref linkend='XtAppSetFallbackResources' xrefstyle='select: title'/>. Note that the customization substitution string is retrieved dynamically by -<function>XtResolvePathname</function> +<xref linkend='XtResolvePathname' xrefstyle='select: title'/> so that the resolved file name of the application class resource file can be affected by any of the earlier sources for the screen resource database, even though the contents of the class resource file have lowest precedence. After calling -<function>XtResolvePathname</function>, +<xref linkend='XtResolvePathname' xrefstyle='select: title'/>, the original display-associated database is restored. </para> </listitem> @@ -1072,7 +1072,7 @@ the original display-associated database is restored. <para> To obtain the resource database for a particular screen, use -<function>XtScreenDatabase</function>. +<xref linkend='XtScreenDatabase' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtScreenDatabase'> @@ -1097,19 +1097,19 @@ Specifies the screen whose resource database is to be returned. </variablelist> <para> The -<function>XtScreenDatabase</function> +<xref linkend='XtScreenDatabase' xrefstyle='select: title'/> function returns the fully merged resource database as specified above, associated with the specified screen. If the specified <emphasis remap='I'>screen</emphasis> does not belong to a <function>Display</function> initialized by -<function>XtDisplayInitialize</function>, +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>, the results are undefined. </para> <para> To obtain the default resource database associated with a particular display, use -<function>XtDatabase</function>. +<xref linkend='XtDatabase' xrefstyle='select: title'/>. </para> @@ -1135,7 +1135,7 @@ Specifies the display. </variablelist> <para> The -<function>XtDatabase</function> +<xref linkend='XtDatabase' xrefstyle='select: title'/> function is equivalent to <function>XrmGetDatabase</function>. It returns the database associated with the specified display, or @@ -1147,7 +1147,7 @@ To specify a default set of resource values that will be used to initialize the resource database if no application-specific class resource file is found (the last of the six sources listed above), use -<function>XtAppSetFallbackResources</function>. +<xref linkend='XtAppSetFallbackResources' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppSetFallbackResources'> @@ -1187,7 +1187,7 @@ the database, or NULL. Each entry in <emphasis remap='I'>specification_list</emphasis> points to a string in the format of <function>XrmPutLineResource</function>. Following a call to -<function>XtAppSetFallbackResources</function>, +<xref linkend='XtAppSetFallbackResources' xrefstyle='select: title'/>, when a resource database is being created for a particular screen and the Intrinsics are not able to find or read an application-specific class resource file according to the @@ -1195,12 +1195,12 @@ rules given above and if <emphasis remap='I'>specification_list</emphasis> is no resource specifications in <emphasis remap='I'>specification_list</emphasis> will be merged into the screen resource database in place of the application-specific class resource file. -<function>XtAppSetFallbackResources</function> +<xref linkend='XtAppSetFallbackResources' xrefstyle='select: title'/> is not required to copy <emphasis remap='I'>specification_list</emphasis>; the caller must ensure that the contents of the list and of the strings addressed by the list remain valid until all displays are initialized or until -<function>XtAppSetFallbackResources</function> +<xref linkend='XtAppSetFallbackResources' xrefstyle='select: title'/> is called again. The value NULL for <emphasis remap='I'>specification_list</emphasis> removes any previous fallback resource specification for the application context. The intended use for fallback resources @@ -1215,7 +1215,7 @@ exists in finding and loading the application defaults file. <title>Parsing the Command Line</title> <para> The -<function>XtOpenDisplay</function> +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/> function first parses the command line for the following options: <variablelist> <varlistentry> @@ -1233,7 +1233,7 @@ Specifies the display name for <para> Sets the resource name prefix, which overrides the application name passed to -<function>XtOpenDisplay</function>. +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> @@ -1250,7 +1250,7 @@ and for finding application class resource files. </para> <para> -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> has a table of standard command line options that are passed to <function>XrmParseCommand</function> for adding resources to the resource database, @@ -1457,7 +1457,7 @@ are exchanged for all screens on the Display. The value of the synchronous resource specifies whether or not Xlib is put into synchronous mode. If a value is found in the resource database during display initialization, -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> makes a call to <function>XSynchronize</function> for all display @@ -1488,7 +1488,7 @@ xmh -xrm 'xmh*Command.background: red' </literallayout> <para> When it parses the command line, -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> merges the application option table with the standard option table before calling the Xlib <function>XrmParseCommand</function> @@ -1530,10 +1530,10 @@ The widgets create X windows, which then are mapped. <para> To start the first phase, the application calls -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> for all its widgets and adds some (usually, most or all) of its widgets to their respective parents' managed set by calling -<function>XtManageChild</function>. +<xref linkend='XtManageChild' xrefstyle='select: title'/>. To avoid an O(n<superscript>2</superscript>) creation process where each composite widget lays itself out each time a widget is created and managed, parent widgets are not notified of changes in their managed set @@ -1543,9 +1543,9 @@ during this phase. <para> After all widgets have been created, the application calls -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> with the top-level widget to execute the second and third phases. -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> first recursively traverses the widget tree in a postorder (bottom-up) traversal and then notifies each composite widget with one or more managed children by means of its change_managed procedure. @@ -1576,7 +1576,7 @@ This avoids unnecessary requests to the X server. <para> Finally, -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> starts the third phase by making a preorder (top-down) traversal of the widget tree, allocates an X window to each widget by means of its realize procedure, and finally maps the widgets that are managed. @@ -1614,7 +1614,7 @@ otherwise, a pointer to it is stored in <emphasis remap='I'>value</emphasis>. To set values in an <function>ArgList</function>, use -<function>XtSetArg</function>. +<xref linkend='XtSetArg' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetArg'> @@ -1663,7 +1663,7 @@ else the address. </variablelist> <para> The -<function>XtSetArg</function> +<xref linkend='XtSetArg' xrefstyle='select: title'/> function is usually used in a highly stylized manner to minimize the probability of making a mistake; for example: </para> @@ -1678,7 +1678,7 @@ XtSetValues(widget, args, n); <para> Alternatively, an application can statically declare the argument list and use -<function>XtNumber</function>: +<xref linkend='XtNumber' xrefstyle='select: title'/>: </para> <literallayout class="monospaced"> static Args args[] = { @@ -1691,15 +1691,15 @@ XtSetValues(Widget, args, XtNumber(args)); Note that you should not use expressions with side effects such as auto-increment or auto-decrement within the first argument to -<function>XtSetArg</function>. -<function>XtSetArg</function> +<xref linkend='XtSetArg' xrefstyle='select: title'/>. +<xref linkend='XtSetArg' xrefstyle='select: title'/> can be implemented as a macro that evaluates the first argument twice. </para> <para> To merge two arglist arrays, use -<function>XtMergeArgLists</function>. +<xref linkend='XtMergeArgLists' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtMergeArgLists'> @@ -1757,7 +1757,7 @@ Specifies the number of entries in the second argument list. </variablelist> <para> The -<function>XtMergeArgLists</function> +<xref linkend='XtMergeArgLists' xrefstyle='select: title'/> function allocates enough storage to hold the combined arglist arrays and copies them into it. Note that it does not check for duplicate entries. @@ -1765,7 +1765,7 @@ The length of the returned list is the sum of the lengths of the specified lists. When it is no longer needed, free the returned storage by using -<function>XtFree</function>. +<xref linkend='XtFree' xrefstyle='select: title'/>. </para> <para> @@ -1778,7 +1778,7 @@ calling convention. The name of the analog is formed by prefixing ``Va'' to the name of the corresponding <function>ArgList</function> procedure; e.g., -<function>XtVaCreateWidget</function>. +<xref linkend='XtVaCreateWidget' xrefstyle='select: title'/>. Each procedure named <function>XtVa</function><emphasis remap='I'>something</emphasis> takes as its last arguments, in place of the corresponding <function>ArgList</function>/ @@ -1849,7 +1849,7 @@ name entry containing NULL. Varargs lists may nest to any depth. To dynamically allocate a varargs list for use with <function>XtVaNestedList</function> in multiple calls, use -<function>XtVaCreateArgsList</function>. +<xref linkend='XtVaCreateArgsList' xrefstyle='select: title'/>. </para> <literallayout class="monospaced"> typedef XtPointer XtVarArgsList; @@ -1888,7 +1888,7 @@ name and value pairs. </variablelist> <para> The -<function>XtVaCreateArgsList</function> +<xref linkend='XtVaCreateArgsList' xrefstyle='select: title'/> function allocates memory and copies its arguments into a single list pointer, which may be used with <function>XtVaNestedList</function>. @@ -1901,7 +1901,7 @@ conversions. Data passed by reference (including Strings) are not copied, only the pointers themselves; the caller must ensure that the data remain valid for the lifetime of the created varargs list. The list should be freed using -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> when no longer needed. </para> @@ -1916,7 +1916,7 @@ order to permit modification without recompilation. <title>Creating a Widget Instance</title> <para> To create an instance of a widget, use -<function>XtCreateWidget</function>. +<xref linkend='XtCreateWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCreateWidget'> @@ -1988,7 +1988,7 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> function performs all the boilerplate operations of widget creation, doing the following in order: </para> @@ -2014,7 +2014,7 @@ the parent's composite class part extension field exists with the or the <emphasis remap='I'>accepts_objects</emphasis> field in the extension record is <function>False</function>, -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> issues a fatal error; see Section 3.1 and Chapter 12. </para> </listitem> @@ -2096,7 +2096,7 @@ see Section 3.1. </itemizedlist> <para> To create an instance of a widget using varargs lists, use -<function>XtVaCreateWidget</function>. +<xref linkend='XtVaCreateWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaCreateWidget'> @@ -2155,9 +2155,9 @@ resource specifications. </variablelist> <para> The -<function>XtVaCreateWidget</function> +<xref linkend='XtVaCreateWidget' xrefstyle='select: title'/> procedure is identical in function to -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' 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. @@ -2171,7 +2171,7 @@ An application can have multiple top-level widgets, each of which specifies a unique widget tree that can potentially be on different screens or displays. An application uses -<function>XtAppCreateShell</function> +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/> to create independent widget trees. </para> @@ -2198,7 +2198,7 @@ to create independent widget trees. Specifies the instance name of the shell widget. If <emphasis remap='I'>name</emphasis> is NULL, the application name passed to -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> is used. </para> </listitem> @@ -2263,7 +2263,7 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtAppCreateShell</function> +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/> function creates a new shell widget instance as the root of a widget tree. The screen resource for this widget is determined by first scanning @@ -2311,7 +2311,7 @@ you can use one of two methods: <para> Designate one shell as the real top-level shell and create the others as pop-up children of it by using -<function>XtCreatePopupShell</function>. +<xref linkend='XtCreatePopupShell' xrefstyle='select: title'/>. </para> </listitem> <listitem> @@ -2343,7 +2343,7 @@ xmail.compose.geometry:... (the compose window) <para> To create a top-level widget that is the root of a widget tree using varargs lists, use -<function>XtVaAppCreateShell</function>. +<xref linkend='XtVaAppCreateShell' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaAppCreateShell'> @@ -2366,7 +2366,7 @@ varargs lists, use Specifies the instance name of the shell widget. If <emphasis remap='I'>name</emphasis> is NULL, the application name passed to -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> is used. </para> </listitem> @@ -2421,9 +2421,9 @@ resource specifications. </variablelist> <para> The -<function>XtVaAppCreateShell</function> +<xref linkend='XtVaAppCreateShell' xrefstyle='select: title'/> procedure is identical in function to -<function>XtAppCreateShell</function> +<xref linkend='XtAppCreateShell' 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> @@ -2435,9 +2435,9 @@ described in Section 2.5.1. To initialize the Intrinsics internals, create an application context, open and initialize a display, and create the initial root shell instance, an application may use -<function>XtOpenApplication</function> +<xref linkend='XtOpenApplication' xrefstyle='select: title'/> or -<function>XtVaOpenApplication</function>. +<xref linkend='XtVaOpenApplication' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtOpenApplication'> @@ -2563,16 +2563,16 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtOpenApplication</function> +<xref linkend='XtOpenApplication' xrefstyle='select: title'/> function calls -<function>XtToolkitInitialize</function> +<xref linkend='XtToolkitInitialize' xrefstyle='select: title'/> followed by -<function>XtCreateApplicationContext</function>, +<xref linkend='XtCreateApplicationContext' xrefstyle='select: title'/>, then calls -<function>XtOpenDisplay</function> +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/> with <emphasis remap='I'>display_string</emphasis> NULL and <emphasis remap='I'>application_name</emphasis> NULL, and finally calls -<function>XtAppCreateShell</function> +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/> with <emphasis remap='I'>name</emphasis> NULL, the specified <emphasis remap='I'>widget_class</emphasis>, an argument list and count, and returns the created shell. @@ -2582,16 +2582,16 @@ The argument list and count are created by merging the specified <emphasis remap='I'>args</emphasis> and <emphasis remap='I'>num_args</emphasis> with a list containing the specified <emphasis remap='I'>argc</emphasis> and <emphasis remap='I'>argv</emphasis>. The modified <emphasis remap='I'>argc</emphasis> and <emphasis remap='I'>argv</emphasis> returned by -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> are returned in <emphasis remap='I'>argc_in_out</emphasis> and <emphasis remap='I'>argv_in_out</emphasis>. If <emphasis remap='I'>app_context_return</emphasis> is not NULL, the created application context is also returned. If the display specified by the command line cannot be opened, an error message is issued and -<function>XtOpenApplication</function> +<xref linkend='XtOpenApplication' xrefstyle='select: title'/> terminates the application. If <emphasis remap='I'>fallback_resources</emphasis> is non-NULL, -<function>XtAppSetFallbackResources</function> +<xref linkend='XtAppSetFallbackResources' xrefstyle='select: title'/> is called with the value prior to calling -<function>XtOpenDisplay</function>. +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaOpenApplication'> @@ -2705,9 +2705,9 @@ resource specifications for the created shell. </variablelist> <para> The -<function>XtVaOpenApplication</function> +<xref linkend='XtVaOpenApplication' xrefstyle='select: title'/> procedure is identical in function to -<function>XtOpenApplication</function> +<xref linkend='XtOpenApplication' 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. @@ -2741,7 +2741,7 @@ typedef struct { The allocate procedure pointer in the <function>ObjectClassExtension</function> record is of type -<function>XtAllocateProc</function>. +<xref linkend='XtAllocateProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAllocateProc'> @@ -2858,7 +2858,7 @@ equal to <emphasis role='bold'>NULLQUARK</emphasis> is located through the object class part <emphasis remap='I'>extension</emphasis> field and the <emphasis remap='I'>allocate</emphasis> field is not NULL, the -<function>XtAllocateProc</function> +<xref linkend='XtAllocateProc' xrefstyle='select: title'/> will be invoked to allocate memory for the widget. If no ObjectClassPart extension record is declared with <emphasis remap='I'>record_type equal</emphasis> to <emphasis role='bold'>NULLQUARK</emphasis>, @@ -2868,13 +2868,13 @@ and <function>XtInheritDeallocate</function> are assumed. If no -<function>XtAllocateProc</function> +<xref linkend='XtAllocateProc' xrefstyle='select: title'/> is found, the Intrinsics will allocate memory for the widget. </para> <para> An -<function>XtAllocateProc</function> +<xref linkend='XtAllocateProc' xrefstyle='select: title'/> must perform the following: </para> <itemizedlist> @@ -2918,7 +2918,7 @@ instance part of any superclass. <title>Widget Instance Initialization: The initialize Procedure</title> <para> The initialize procedure pointer in a widget class is of type -<function>XtInitProc</function>. +<xref linkend='XtInitProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtInitProc'> @@ -3111,7 +3111,7 @@ it should specify <emphasis remap='I'>new</emphasis> as the widget instance. The constraint initialization procedure pointer, found in the <function>ConstraintClassPart</function> <emphasis remap='I'>initialize</emphasis> field of the widget class record, is of type -<function>XtInitProc</function>. +<xref linkend='XtInitProc' xrefstyle='select: title'/>. The values passed to the parent constraint initialization procedures are the same as those passed to the child's class widget initialization procedures. @@ -3151,7 +3151,7 @@ retained for those widgets that used it in previous releases. <para> The initialize_hook procedure pointer is of type -<function>XtArgsProc</function>: +<xref linkend='XtArgsProc' xrefstyle='select: title'/>: </para> <funcsynopsis id='XtArgsProc'> @@ -3220,7 +3220,7 @@ as if it were a resource. <title>Realizing Widgets</title> <para> To realize a widget instance, use -<function>XtRealizeWidget</function>. +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRealizeWidget'> @@ -3244,7 +3244,7 @@ Specifies the widget. Must be of class Core or any subclass thereof. </variablelist> <para> If the widget is already realized, -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> simply returns. Otherwise it performs the following: </para> @@ -3277,7 +3277,7 @@ which adds any widget-specific attributes and creates the X window. If the widget is not a subclass of <function>compositeWidgetClass</function>, -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> returns; otherwise it continues and performs the following: </para> </listitem> @@ -3307,18 +3307,18 @@ the widget is allocated visual space but is not displayed. If the widget is a top-level shell widget (that is, it has no parent), and <emphasis remap='I'>mapped_when_managed</emphasis> is <function>True</function>, -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> maps the widget window. </para> <para> -<function>XtCreateWidget</function>, -<function>XtVaCreateWidget</function>, -<function>XtRealizeWidget</function>, -<function>XtManageChildren</function>, +<xref linkend='XtCreateWidget' xrefstyle='select: title'/>, +<xref linkend='XtVaCreateWidget' xrefstyle='select: title'/>, +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/>, +<xref linkend='XtManageChildren' xrefstyle='select: title'/>, <function>XtUnmanage\%Children</function>, -<function>XtUnrealizeWidget</function>, -<function>XtSetMappedWhenManaged</function>, +<xref linkend='XtUnrealizeWidget' xrefstyle='select: title'/>, +<xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/>, and <function>XtDestroy\%Widget</function> maintain the following invariants: @@ -3344,7 +3344,7 @@ either realized or unrealized widgets. When calling the realize or change_managed procedures for children of a composite widget, -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> calls the procedures in reverse order of appearance in the <function>CompositePart</function> @@ -3357,7 +3357,7 @@ recently created child will be at the bottom. <para> To check whether or not a widget has been realized, use -<function>XtIsRealized</function>. +<xref linkend='XtIsRealized' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtIsRealized'> @@ -3381,7 +3381,7 @@ Specifies the widget. Must be of class Object or any subclass thereof. </variablelist> <para> The -<function>XtIsRealized</function> +<xref linkend='XtIsRealized' xrefstyle='select: title'/> function returns <function>True</function> if the widget has been realized, @@ -3399,7 +3399,7 @@ after the widget has been realized. <title>Widget Instance Window Creation: The realize Procedure</title> <para> The realize procedure pointer in a widget class is of type -<function>XtRealizeProc</function>. +<xref linkend='XtRealizeProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRealizeProc'> @@ -3451,7 +3451,7 @@ The realize procedure must create the widget's window. <para> Before calling the class realize procedure, the generic -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> function fills in a mask and a corresponding <function>XSetWindowAttributes</function> structure. @@ -3517,7 +3517,7 @@ during class initialization. The realize procedure defined for <function>coreWidgetClass</function> calls -<function>XtCreateWindow</function> +<xref linkend='XtCreateWindow' xrefstyle='select: title'/> with the passed <emphasis remap='I'>value_mask</emphasis> and <emphasis remap='I'>attributes</emphasis> and with <emphasis remap='I'>window_class</emphasis> and <emphasis remap='I'>visual</emphasis> set to <function>CopyFromParent</function>. @@ -3548,7 +3548,7 @@ If a composite widget's children should be realized in an order other than that specified (to control the stacking order, for example), it should call -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> on its children itself in the appropriate order from within its own realize procedure. </para> @@ -3557,7 +3557,7 @@ realize procedure. Widgets that have children and whose class is not a subclass of <function>compositeWidgetClass</function> are responsible for calling -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> on their children, usually from within the realize procedure. </para> @@ -3572,7 +3572,7 @@ Realize procedures cannot manage or unmanage their descendants. Rather than call the Xlib <function>XCreateWindow</function> function explicitly, a realize procedure should normally call the Intrinsics analog -<function>XtCreateWindow</function>, +<xref linkend='XtCreateWindow' xrefstyle='select: title'/>, which simplifies the creation of windows for widgets. </para> @@ -3648,7 +3648,7 @@ call. </variablelist> <para> The -<function>XtCreateWindow</function> +<xref linkend='XtCreateWindow' xrefstyle='select: title'/> function calls the Xlib <function>XCreateWindow</function> function with values from the widget structure and the passed parameters. @@ -3656,7 +3656,7 @@ Then, it assigns the created window to the widget's <emphasis remap='I'>window</ </para> <para> -<function>XtCreateWindow</function> +<xref linkend='XtCreateWindow' xrefstyle='select: title'/> evaluates the following fields of the widget core structure: <emphasis remap='I'>depth</emphasis>, <emphasis remap='I'>screen</emphasis>, <emphasis remap='I'>parent->core.window</emphasis>, <emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>, <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, and @@ -3750,7 +3750,7 @@ Specifies the widget. Must be of class Core or any subclass thereof. </varlistentry> </variablelist> <para> -<function>XtScreen</function> +<xref linkend='XtScreen' xrefstyle='select: title'/> returns the screen pointer for the specified widget. </para> @@ -3774,7 +3774,7 @@ Specifies the widget. Must be of class Core or any subclass thereof. </varlistentry> </variablelist> <para> -<function>XtWindow</function> +<xref linkend='XtWindow' xrefstyle='select: title'/> returns the window of the specified widget. </para> @@ -3782,10 +3782,10 @@ returns the window of the specified widget. The display pointer, screen pointer, and window of a widget or of the closest widget ancestor of a nonwidget object are available by means of -<function>XtDisplayOfObject</function>, -<function>XtScreenOfObject</function>, +<xref linkend='XtDisplayOfObject' xrefstyle='select: title'/>, +<xref linkend='XtScreenOfObject' xrefstyle='select: title'/>, and -<function>XtWindowOfObject</function>. +<xref linkend='XtWindowOfObject' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtDisplayOfObject'> @@ -3808,11 +3808,11 @@ Specifies the object. Must be of class Object or any subclass thereof. </varlistentry> </variablelist> <para> -<function>XtDisplayOfObject</function> +<xref linkend='XtDisplayOfObject' xrefstyle='select: title'/> is identical in function to <function>XtDisplay</function> if the object is a widget; otherwise -<function>XtDisplayOfObject</function> +<xref linkend='XtDisplayOfObject' xrefstyle='select: title'/> returns the display pointer for the nearest ancestor of <emphasis remap='I'>object</emphasis> that is of class Widget or a subclass thereof. @@ -3839,11 +3839,11 @@ Specifies the object. Must be of class Object or any subclass thereof. </varlistentry> </variablelist> <para> -<function>XtScreenOfObject</function> +<xref linkend='XtScreenOfObject' xrefstyle='select: title'/> is identical in function to -<function>XtScreen</function> +<xref linkend='XtScreen' xrefstyle='select: title'/> if the object is a widget; otherwise -<function>XtScreenOfObject</function> +<xref linkend='XtScreenOfObject' xrefstyle='select: title'/> returns the screen pointer for the nearest ancestor of <emphasis remap='I'>object</emphasis> that is of class Widget or a subclass thereof. @@ -3869,18 +3869,18 @@ Specifies the object. Must be of class Object or any subclass thereof. </varlistentry> </variablelist> <para> -<function>XtWindowOfObject</function> +<xref linkend='XtWindowOfObject' xrefstyle='select: title'/> is identical in function to -<function>XtWindow</function> +<xref linkend='XtWindow' xrefstyle='select: title'/> if the object is a widget; otherwise -<function>XtWindowOfObject</function> +<xref linkend='XtWindowOfObject' xrefstyle='select: title'/> returns the window for the nearest ancestor of <emphasis remap='I'>object</emphasis> that is of class Widget or a subclass thereof. </para> <para> To retrieve the instance name of an object, use -<function>XtName</function>. +<xref linkend='XtName' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtName'> @@ -3903,7 +3903,7 @@ Specifies the object whose name is desired. Must be of class Object or any subc </varlistentry> </variablelist> <para> -<function>XtName</function> +<xref linkend='XtName' xrefstyle='select: title'/> returns a pointer to the instance name of the specified object. The storage is owned by the Intrinsics and must not be modified. The name is not qualified by the names of any of the object's ancestors. @@ -3912,11 +3912,11 @@ name is not qualified by the names of any of the object's ancestors. <para> Several window attributes are locally cached in the widget instance. Thus, they can be set by the resource manager and -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> as well as used by routines that derive structures from these values (for example, <emphasis remap='I'>depth</emphasis> for deriving pixmaps, <emphasis remap='I'>background_pixel</emphasis> for deriving GCs, and so on) or in the -<function>XtCreateWindow</function> +<xref linkend='XtCreateWindow' xrefstyle='select: title'/> call. </para> @@ -3949,7 +3949,7 @@ for window sizes whenever they need to lay out their managed children <para> To destroy the windows associated with a widget and its non-pop-up descendants, use -<function>XtUnrealizeWidget</function>. +<xref linkend='XtUnrealizeWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtUnrealizeWidget'> @@ -3973,7 +3973,7 @@ Specifies the widget. Must be of class Core or any subclass thereof. </variablelist> <para> If the widget is currently unrealized, -<function>XtUnrealizeWidget</function> +<xref linkend='XtUnrealizeWidget' xrefstyle='select: title'/> simply returns. Otherwise it performs the following: </para> <itemizedlist> @@ -4002,7 +4002,7 @@ with the specified widget's <emphasis remap='I'>window</emphasis> field. </itemizedlist> <para> Any events in the queue or which arrive following a call to -<function>XtUnrealizeWidget</function> +<xref linkend='XtUnrealizeWidget' xrefstyle='select: title'/> will be dispatched as if the window(s) of the unrealized widget(s) had never existed. </para> @@ -4047,7 +4047,7 @@ calls when destroying a widget tree. </itemizedlist> <para> To destroy a widget instance, use -<function>XtDestroyWidget</function>. +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/>. </para> @@ -4072,7 +4072,7 @@ Specifies the widget. Must be of class Object or any subclass thereof. </variablelist> <para> The -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> function provides the only method of destroying a widget, including widgets that need to destroy themselves. It can be called at any time, @@ -4083,7 +4083,7 @@ references to destroyed widgets. <para> In phase 1, -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> performs the following: </para> <itemizedlist> @@ -4120,14 +4120,14 @@ Phase 2 occurs when all procedures that should execute as a result of the current event have been called, including all procedures registered with the event and translation managers, that is, when the current invocation of -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> is about to return, or immediately if not in -<function>XtDispatchEvent</function>. +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/>. </para> <para> In phase 2, -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> performs the following on each entry in the destroy list in the order specified: </para> @@ -4138,7 +4138,7 @@ If the widget is not a pop-up child and the widget's parent is a subclass of <function>composite\%WidgetClass</function>, and if the parent is not being destroyed, it calls -<function>XtUnmanageChild</function> +<xref linkend='XtUnmanageChild' xrefstyle='select: title'/> on the widget and then calls the widget's parent's delete_child procedure (see Section 3.3). </para> @@ -4153,7 +4153,7 @@ callbacks before parent callbacks). </itemizedlist> <para> The -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> function then makes second traversal of the widget and all normal and pop-up descendants to perform the following three items on each widget in postorder: @@ -4220,7 +4220,7 @@ XtNdestroyCallback. <para> For example, the following adds an application-supplied destroy callback procedure <emphasis remap='I'>ClientDestroy</emphasis> with client data to a widget by calling -<function>XtAddCallback</function>. +<xref linkend='XtAddCallback' xrefstyle='select: title'/>. </para> <literallayout class="monospaced"> @@ -4230,7 +4230,7 @@ XtAddCallback(<emphasis remap='I'>w</emphasis>, XtNdestroyCallback, <emphasis re <para> Similarly, the following removes the application-supplied destroy callback procedure <emphasis remap='I'>ClientDestroy</emphasis> by calling -<function>XtRemoveCallback</function>. +<xref linkend='XtRemoveCallback' xrefstyle='select: title'/>. </para> <literallayout class="monospaced"> @@ -4238,7 +4238,7 @@ XtRemoveCallback(<emphasis remap='I'>w</emphasis>, XtNdestroyCallback, <emphasis </literallayout> <para> The <emphasis remap='I'>ClientDestroy</emphasis> argument is of type -<function>XtCallbackProc</function>; +<xref linkend='XtCallbackProc' xrefstyle='select: title'/>; see Section 8.1. </para> </sect2> @@ -4252,7 +4252,7 @@ The destroy procedure pointers in the and <function>CoreClassPart</function> structures are of type -<function>XtWidgetProc</function>. +<xref linkend='XtWidgetProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtWidgetProc'> @@ -4296,10 +4296,10 @@ the following steps: <listitem> <para> Calling -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> on dynamic storage allocated with -<function>XtMalloc</function>, -<function>XtCalloc</function>, +<xref linkend='XtMalloc' xrefstyle='select: title'/>, +<xref linkend='XtCalloc' xrefstyle='select: title'/>, and so on. </para> </listitem> @@ -4313,9 +4313,9 @@ on pixmaps created with direct X calls. <listitem> <para> Calling -<function>XtReleaseGC</function> +<xref linkend='XtReleaseGC' xrefstyle='select: title'/> on GCs allocated with -<function>XtGetGC</function>. +<xref linkend='XtGetGC' xrefstyle='select: title'/>. </para> </listitem> <listitem> @@ -4328,22 +4328,22 @@ on GCs allocated with direct X calls. <listitem> <para> Calling -<function>XtRemoveEventHandler</function> +<xref linkend='XtRemoveEventHandler' xrefstyle='select: title'/> on event handlers added to other widgets. </para> </listitem> <listitem> <para> Calling -<function>XtRemoveTimeOut</function> +<xref linkend='XtRemoveTimeOut' xrefstyle='select: title'/> on timers created with -<function>XtAppAddTimeOut</function>. +<xref linkend='XtAppAddTimeOut' xrefstyle='select: title'/>. </para> </listitem> <listitem> <para> Calling -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> for each child if the widget has children and is not a subclass of <function>compositeWidgetClass</function>. @@ -4365,7 +4365,7 @@ The constraint destroy procedure identified in the <function>ConstraintClassPart</function> <function>constraintWidgetClass</function>. This constraint destroy procedure pointer is of type -<function>XtWidgetProc</function>. +<xref linkend='XtWidgetProc' xrefstyle='select: title'/>. The constraint destroy procedures are called in subclass-to-superclass order, starting at the class of the widget's parent and ending at <function>constraint\%WidgetClass</function>. @@ -4459,14 +4459,14 @@ originally allocated the memory and is responsible for freeing it. <para> All X Toolkit applications should terminate by calling -<function>XtDestroyApplicationContext</function> +<xref linkend='XtDestroyApplicationContext' xrefstyle='select: title'/> and then exiting using the standard method for their operating system (typically, by calling <function>exit</function> for POSIX-based systems). The quickest way to make the windows disappear while exiting is to call -<function>XtUnmapWidget</function> +<xref linkend='XtUnmapWidget' xrefstyle='select: title'/> on each top-level shell widget. The Intrinsics have no resources beyond those in the program image, and the X server will free its resources when its connection @@ -4476,9 +4476,9 @@ to the application is broken. <para> Depending upon the widget set in use, it may be necessary to explicitly destroy individual widgets or widget trees with -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> before calling -<function>XtDestroyApplicationContext</function> +<xref linkend='XtDestroyApplicationContext' xrefstyle='select: title'/> in order to ensure that any required widget cleanup is properly executed. The application developer must refer to the widget documentation to learn if a widget needs to 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> diff --git a/specs/CH04.xml b/specs/CH04.xml index 098c389..d796019 100755 --- a/specs/CH04.xml +++ b/specs/CH04.xml @@ -397,9 +397,9 @@ version identifier is The root_geometry_manager procedure acts as the parent geometry manager for geometry requests made by shell widgets. When a shell widget calls either -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> or -<function>XtMakeResizeRequest</function>, +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>, the root_geometry_manager procedure is invoked to negotiate the new geometry with the window manager. If the window manager permits the new geometry, the root_geometry_manager @@ -1195,21 +1195,21 @@ Shell classes; a client specifying the string in an arglist or varargs list must ensure that the value remains valid until the shell widget is realized. For further information on the geometry string, see Section 16.4 -in <emphasis remap='I'>Xlib — C Language X Interface</emphasis>. +in <emphasis remap='I'>(xL</emphasis>. </para> <para> The <emphasis remap='I'>create_popup_child_proc</emphasis> procedure is called by the -<function>XtPopup</function> +<xref linkend='XtPopup' xrefstyle='select: title'/> procedure and may remain NULL. The <emphasis remap='I'>grab_kind</emphasis>, <emphasis remap='I'>spring_loaded</emphasis>, and <emphasis remap='I'>popped_up</emphasis> fields maintain widget state information as described under -<function>XtPopup</function>, -<function>XtMenuPopup</function>, -<function>XtPopdown</function>, +<xref linkend='XtPopup' xrefstyle='select: title'/>, +<xref linkend='XtMenuPopup' xrefstyle='select: title'/>, +<xref linkend='XtPopdown' xrefstyle='select: title'/>, and -<function>XtMenuPopdown</function>. +<xref linkend='XtMenuPopdown' xrefstyle='select: title'/>. The <emphasis remap='I'>allow_shell_resize</emphasis> field controls whether the widget contained by the shell is allowed to try to resize itself. If allow_shell_resize is @@ -1229,17 +1229,17 @@ determines whether the window manager can intercede when the shell window is mapped. For further information on override_redirect, -see Section 3.2 in <emphasis remap='I'>Xlib — C Language X Interface</emphasis> and Sections 4.1.10 and 4.2.2 in the -<emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis>. +see Section 3.2 in <emphasis remap='I'>(xL</emphasis> and Sections 4.1.10 and 4.2.2 in the +<emphasis remap='I'>(xC</emphasis>. The pop-up and pop-down callbacks are called during -<function>XtPopup</function> +<xref linkend='XtPopup' xrefstyle='select: title'/> and -<function>XtPopdown</function>. +<xref linkend='XtPopdown' xrefstyle='select: title'/>. The default value of the <emphasis remap='I'>visual</emphasis> resource is the symbolic value <function>CopyFromParent</function>. The Intrinsics do not need to query the parent's visual type when the default value is used; if a client using -<function>XtGetValues</function> +<xref linkend='XtGetValues' xrefstyle='select: title'/> to examine the visual type receives the value <function>CopyFromParent</function>, it must then use @@ -1420,7 +1420,7 @@ the property will be stored on the shell window with a value as specified below. The interpretation of this property is specific to the window manager -under which the application is run; see the <emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis> for more details. +under which the application is run; see the <emphasis remap='I'>(xC</emphasis> for more details. </para> <para> @@ -1616,13 +1616,13 @@ that the window manager iconify or deiconify the shell; the TopLevelShell set_values procedure will send the appropriate <emphasis role='bold'>WM_CHANGE_STATE</emphasis> -message (as specified by the <emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis>) +message (as specified by the <emphasis remap='I'>(xC</emphasis>) if this resource is changed from <function>False</function> to <function>True</function> and will call -<function>XtPopup</function> +<xref linkend='XtPopup' xrefstyle='select: title'/> specifying <emphasis remap='I'>grab_kind</emphasis> as <function>XtGrabNone</function> if <emphasis remap='I'>iconic</emphasis> is changed from @@ -1669,7 +1669,7 @@ shells have the following additional resources: The <emphasis remap='I'>argc</emphasis> and <emphasis remap='I'>argv</emphasis> fields are used to initialize the standard property <emphasis role='bold'>WM_COMMAND</emphasis>. -See the <emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis> for more information. +See the <emphasis remap='I'>(xC</emphasis> for more information. </para> <para> @@ -1917,7 +1917,7 @@ Session shell will take over management of the session connection. When a successful connection has been established, <emphasis remap='I'>connection</emphasis> contains the session connection ID for the session participant. When the shell begins to manage the connection, it will call -<function>XtAppAddInput</function> +<xref linkend='XtAppAddInput' xrefstyle='select: title'/> to register the handler which watches for protocol messages from the session manager. When the attempt to connect fails, a warning message is issued @@ -2095,7 +2095,7 @@ and these additional tokens must be returned by an explicit call. <para> To request an additional token for a save callback response that has a deferred outcome, use -<function>XtSessionGetToken</function>. +<xref linkend='XtSessionGetToken' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSessionGetToken'> @@ -2120,7 +2120,7 @@ Specifies the Session shell widget which manages session participation. <para> The -<function>XtSessionGetToken</function> +<xref linkend='XtSessionGetToken' xrefstyle='select: title'/> function will return NULL if no checkpoint operation is currently under way. </para> @@ -2130,7 +2130,7 @@ interaction, the application must signal the Session shell by returning all tokens. (See Sections 4.2.2.2 and 4.2.2.4). To return a token, use -<function>XtSessionReturnToken</function>. +<xref linkend='XtSessionReturnToken' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSessionReturnToken'> @@ -2149,7 +2149,7 @@ To return a token, use <para> Specifies a token that was received as the <emphasis remap='I'>call_data</emphasis> by a procedure on the interact callback list or a token that was received by a call to -<function>XtSessionGetToken</function>. +<xref linkend='XtSessionGetToken' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> @@ -2159,7 +2159,7 @@ on the interact callback list or a token that was received by a call to Tokens passed as <emphasis remap='I'>call_data</emphasis> to save callbacks are implicitly returned when the save callback procedure returns. A save callback procedure should not call -<function>XtSessionReturnToken</function> +<xref linkend='XtSessionReturnToken' xrefstyle='select: title'/> on the token passed in its <emphasis remap='I'>call_data</emphasis>. </para> @@ -2174,7 +2174,7 @@ Applications request permission to interact with the user during the checkpointing operation by registering a procedure on the Session shell's interact callback list. When all save callback procedures have returned, and each time a token that was granted by a call to -<function>XtSessionGetToken</function> +<xref linkend='XtSessionGetToken' xrefstyle='select: title'/> is returned, the Session shell examines the interact callback list. If interaction is permitted and the interact callback list is not empty, the shell will send an @@ -2213,7 +2213,7 @@ The <emphasis remap='I'>request_cancel</emphasis> field is a return value for in Upon return from a procedure on the save callback list, the value of the token's <emphasis remap='I'>request_cancel</emphasis> field is not examined by the shell. This is also true of tokens received through a call to -<function>XtSessionGetToken</function>. +<xref linkend='XtSessionGetToken' xrefstyle='select: title'/>. </para> </sect3> @@ -2234,7 +2234,7 @@ and executing it with a token passed in the <emphasis remap='I'>call_data</empha The interact callback will typically pop up a dialog box and return. When the user interaction and associated application checkpointing has completed, the application must return the token by calling -<function>XtSessionReturnToken</function>. +<xref linkend='XtSessionReturnToken' xrefstyle='select: title'/>. Returning the token completes the current step and triggers the next step in the sequence. </para> @@ -2311,15 +2311,15 @@ When there is no user interaction, the shell regards the application as having finished saving state when all callback procedures on the save callback list have returned, and any additional tokens passed out by -<function>XtSessionGetToken</function> +<xref linkend='XtSessionGetToken' xrefstyle='select: title'/> have been returned by corresponding calls to -<function>XtSessionReturnToken</function>. +<xref linkend='XtSessionReturnToken' xrefstyle='select: title'/>. If the save operation involved user interaction, the above completion conditions apply, and in addition, all requests for interaction have been granted or cancelled, and all tokens passed to interact callbacks have been returned through calls to -<function>XtSessionReturnToken</function>. +<xref linkend='XtSessionReturnToken' xrefstyle='select: title'/>. If the save operation involved a manager client that requested the second phase, the above conditions apply to both the first and second phase of the save operation. @@ -2369,7 +2369,7 @@ that was watching for session protocol messages. <para> When -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> is used to set <emphasis remap='I'>join_session</emphasis> to <function>False</function>, the set_values method of the Session shell will close the @@ -2388,7 +2388,7 @@ before exiting. <para> When -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> is used to set <emphasis remap='I'>connection</emphasis> to NULL, the Session shell will stop managing the connection, if one exists. However, that session connection will not be closed. diff --git a/specs/CH05.xml b/specs/CH05.xml index 303255e..54317ad 100755 --- a/specs/CH05.xml +++ b/specs/CH05.xml @@ -17,7 +17,7 @@ The <emphasis remap='I'>popup_list</emphasis> field in the structure contains the list of its pop-up children. This pop-up list exists mainly to provide the proper place in the widget hierarchy for the pop-up to get resources and to provide a place for -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> to look for all extant children. </para> @@ -125,7 +125,7 @@ not the child. <para> To create a pop-up shell, use -<function>XtCreatePopupShell</function>. +<xref linkend='XtCreatePopupShell' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCreatePopupShell'> @@ -193,7 +193,7 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtCreatePopupShell</function> +<xref linkend='XtCreatePopupShell' xrefstyle='select: title'/> function ensures that the specified class is a subclass of Shell and, rather than using insert_child to attach the widget to the parent's @@ -219,7 +219,7 @@ all remaining resources for the widget not specified in <para> A spring-loaded pop-up invoked from a translation table via -<function>XtMenuPopup</function> +<xref linkend='XtMenuPopup' xrefstyle='select: title'/> must already exist at the time that the translation is invoked, so the translation manager can find the shell by name. @@ -233,7 +233,7 @@ currently popped up) exists and create a new shell if needed. <para> To create a pop-up shell using varargs lists, use -<function>XtVaCreatePopupShell</function>. +<xref linkend='XtVaCreatePopupShell' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaCreatePopupShell'> @@ -289,9 +289,9 @@ resource specifications. </variablelist> <para> -<function>XtVaCreatePopupShell</function> +<xref linkend='XtVaCreatePopupShell' xrefstyle='select: title'/> is identical in function to -<function>XtCreatePopupShell</function> +<xref linkend='XtCreatePopupShell' xrefstyle='select: title'/> with <emphasis remap='I'>the</emphasis> args and <emphasis remap='I'>num_args</emphasis> parameters replaced by a varargs list as described in Section 2.5.1. </para> @@ -314,13 +314,13 @@ The application can change the state of the subparts of the pop-up child as the application state changes. For example, if an application creates a static menu, it can call -<function>XtSetSensitive</function> +<xref linkend='XtSetSensitive' xrefstyle='select: title'/> (or, in general, -<function>XtSetValues</function>) +<xref linkend='XtSetValues' xrefstyle='select: title'/>) on any of the buttons that make up the menu. Creating the pop-up child early means that pop-up time is minimized, especially if the application calls -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> on the pop-up shell at startup. When the menu is needed, all the widgets that make up the menu already exist and need only be mapped. @@ -340,7 +340,7 @@ to find out if it should change the sensitivity of any of its subparts. <para> Pop-up child creation does not map the pop-up, even if you create the child and call -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> on the pop-up shell. </para> @@ -362,24 +362,24 @@ Pop-ups can be popped up through several mechanisms: <listitem> <para> A call to -<function>XtPopup</function> +<xref linkend='XtPopup' xrefstyle='select: title'/> or -<function>XtPopupSpringLoaded</function>. +<xref linkend='XtPopupSpringLoaded' xrefstyle='select: title'/>. </para> </listitem> <listitem> <para> One of the supplied callback procedures -<function>XtCallbackNone</function>, -<function>XtCallbackNonexclusive</function>, +<xref linkend='XtCallbackNone' xrefstyle='select: title'/>, +<xref linkend='XtCallbackNonexclusive' xrefstyle='select: title'/>, or -<function>XtCallbackExclusive</function>. +<xref linkend='XtCallbackExclusive' xrefstyle='select: title'/>. </para> </listitem> <listitem> <para> The standard translation action -<function>XtMenuPopup</function>. +<xref linkend='XtMenuPopup' xrefstyle='select: title'/>. </para> </listitem> </itemizedlist> @@ -396,7 +396,7 @@ typedef enum {XtGrabNone, XtGrabNonexclusive, XtGrabExclusive} XtGrabKind; <para> The create_popup_child_proc procedure pointer in the shell widget instance record is of type -<function>XtCreatePopupChildProc</function>. +<xref linkend='XtCreatePopupChildProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCreatePopupChildProc'> @@ -421,7 +421,7 @@ Specifies the shell widget being popped up. <para> To map a pop-up from within an application, use -<function>XtPopup</function>. +<xref linkend='XtPopup' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtPopup'> @@ -456,14 +456,14 @@ Specifies the way in which user events should be constrained. </variablelist> <para> The -<function>XtPopup</function> +<xref linkend='XtPopup' xrefstyle='select: title'/> function performs the following: </para> <itemizedlist> <listitem> <para> Calls -<function>XtCheckSubclass</function> +<xref linkend='XtCheckSubclass' xrefstyle='select: title'/> to ensure <emphasis remap='I'>popup_shell</emphasis>'s class is a subclass of <function>shellWidgetClass</function>. </para> @@ -493,7 +493,7 @@ and the shell <emphasis remap='I'>grab_kind</emphasis> field from <emphasis rema <listitem> <para> If the shell's <emphasis remap='I'>create_popup_child_proc</emphasis> field is non-NULL, -<function>XtPopup</function> +<xref linkend='XtPopup' xrefstyle='select: title'/> calls it with <emphasis remap='I'>popup_shell</emphasis> as the parameter. </para> </listitem> @@ -512,7 +512,7 @@ XtAddGrab(<emphasis remap='I'>popup_shell</emphasis>, (<emphasis remap='I'>grab_ <listitem> <para> Calls -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> with <emphasis remap='I'>popup_shell</emphasis> specified. </para> </listitem> @@ -526,7 +526,7 @@ with the window of <emphasis remap='I'>popup_shell</emphasis>. </itemizedlist> <para> To map a spring-loaded pop-up from within an application, use -<function>XtPopupSpringLoaded</function>. +<xref linkend='XtPopupSpringLoaded' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtPopupSpringLoaded'> @@ -550,13 +550,13 @@ Specifies the shell widget to be popped up. </variablelist> <para> The -<function>XtPopupSpringLoaded</function> +<xref linkend='XtPopupSpringLoaded' xrefstyle='select: title'/> function performs exactly as -<function>XtPopup</function> +<xref linkend='XtPopup' xrefstyle='select: title'/> except that it sets the shell <emphasis remap='I'>spring_loaded</emphasis> field to <function>True</function> and always calls -<function>XtAddGrab</function> +<xref linkend='XtAddGrab' xrefstyle='select: title'/> with <emphasis remap='I'>exclusive</emphasis> <function>True</function> and <emphasis remap='I'>spring-loaded</emphasis> @@ -566,10 +566,10 @@ and <emphasis remap='I'>spring-loaded</emphasis> <para> To map a pop-up from a given widget's callback list, you also can register one of the -<function>XtCallbackNone</function>, -<function>XtCallbackNonexclusive</function>, +<xref linkend='XtCallbackNone' xrefstyle='select: title'/>, +<xref linkend='XtCallbackNonexclusive' xrefstyle='select: title'/>, or -<function>XtCallbackExclusive</function> +<xref linkend='XtCallbackExclusive' xrefstyle='select: title'/> convenience routines as callbacks, using the pop-up shell widget as the client data. </para> @@ -704,18 +704,18 @@ which is not used by this procedure. </variablelist> <para> The -<function>XtCallbackNone</function>, -<function>XtCallbackNonexclusive</function>, +<xref linkend='XtCallbackNone' xrefstyle='select: title'/>, +<xref linkend='XtCallbackNonexclusive' xrefstyle='select: title'/>, and -<function>XtCallbackExclusive</function> +<xref linkend='XtCallbackExclusive' xrefstyle='select: title'/> functions call -<function>XtPopup</function> +<xref linkend='XtPopup' xrefstyle='select: title'/> with the shell specified by the <emphasis remap='I'>client_data</emphasis> argument and <emphasis remap='I'>grab_kind</emphasis> set as the name specifies. -<function>XtCallbackNone</function>, -<function>XtCallbackNonexclusive</function>, +<xref linkend='XtCallbackNone' xrefstyle='select: title'/>, +<xref linkend='XtCallbackNonexclusive' xrefstyle='select: title'/>, and -<function>XtCallbackExclusive</function> +<xref linkend='XtCallbackExclusive' xrefstyle='select: title'/> specify <function>XtGrabNone</function>, <function>XtGrabNonexclusive</function>, @@ -724,7 +724,7 @@ and respectively. Each function then sets the widget that executed the callback list to be insensitive by calling -<function>XtSetSensitive</function>. +<xref linkend='XtSetSensitive' xrefstyle='select: title'/>. Using these functions in callbacks is not required. In particular, an application must provide customized code for @@ -736,7 +736,7 @@ desensitizing the button. Within a translation table, to pop up a menu when a key or pointer button is pressed or when the pointer is moved into a widget, use -<function>XtMenuPopup</function>, +<xref linkend='XtMenuPopup' xrefstyle='select: title'/>, or its synonym, <function>MenuPopup</function>. From a translation writer's point of view, @@ -763,12 +763,12 @@ Specifies the name of the shell widget to pop up. </varlistentry> </variablelist> <para> -<function>XtMenuPopup</function> +<xref linkend='XtMenuPopup' xrefstyle='select: title'/> is known to the translation manager, which registers the corresponding built-in action procedure <function>XtMenuPopupAction</function> using -<function>XtRegisterGrabAction</function> +<xref linkend='XtRegisterGrabAction' xrefstyle='select: title'/> specifying <emphasis remap='I'>owner_events</emphasis> <function>True</function>, <emphasis remap='I'>event_mask</emphasis> @@ -781,20 +781,20 @@ and <emphasis remap='I'>pointer_mode</emphasis> and <emphasis remap='I'>keyboard <para> If -<function>XtMenuPopup</function> +<xref linkend='XtMenuPopup' xrefstyle='select: title'/> is invoked on <function>ButtonPress</function>, it calls -<function>XtPopupSpringLoaded</function> +<xref linkend='XtPopupSpringLoaded' xrefstyle='select: title'/> on the specified shell widget. If -<function>XtMenuPopup</function> +<xref linkend='XtMenuPopup' xrefstyle='select: title'/> is invoked on <function>KeyPress</function> or <function>EnterWindow</function>, it calls -<function>XtPopup</function> +<xref linkend='XtPopup' xrefstyle='select: title'/> on the specified shell widget with <emphasis remap='I'>grab_kind</emphasis> set to <function>XtGrabNonexclusive</function>. Otherwise, the translation manager generates a @@ -802,7 +802,7 @@ warning message and ignores the action. </para> <para> -<function>XtMenuPopup</function> +<xref linkend='XtMenuPopup' xrefstyle='select: title'/> tries to find the shell by searching the widget tree starting at the widget in which it is invoked. If it finds a shell with the specified name in the pop-up children of @@ -810,7 +810,7 @@ that widget, it pops up the shell with the appropriate parameters. Otherwise, it moves up the parent chain to find a pop-up child with the specified name. If -<function>XtMenuPopup</function> +<xref linkend='XtMenuPopup' xrefstyle='select: title'/> gets to the application top-level shell widget and has not found a matching shell, it generates a warning and returns immediately. </para> @@ -825,25 +825,25 @@ Pop-ups can be popped down through several mechanisms: <listitem> <para> A call to -<function>XtPopdown</function> +<xref linkend='XtPopdown' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> The supplied callback procedure -<function>XtCallbackPopdown</function> +<xref linkend='XtCallbackPopdown' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> The standard translation action -<function>XtMenuPopdown</function> +<xref linkend='XtMenuPopdown' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> <para> To unmap a pop-up from within an application, use -<function>XtPopdown</function>. +<xref linkend='XtPopdown' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtPopdown'> @@ -867,14 +867,14 @@ Specifies the shell widget to pop down. </variablelist> <para> The -<function>XtPopdown</function> +<xref linkend='XtPopdown' xrefstyle='select: title'/> function performs the following: </para> <itemizedlist> <listitem> <para> Calls -<function>XtCheckSubclass</function> +<xref linkend='XtCheckSubclass' xrefstyle='select: title'/> to ensure <emphasis remap='I'>popup_shell</emphasis>'s class is a subclass of <function>shellWidgetClass</function>. </para> @@ -892,7 +892,7 @@ Unmaps <emphasis remap='I'>popup_shell</emphasis>'s window and, if <emphasis rem <function>False</function>, sends a synthetic <function>UnmapNotify</function> -event as specified by the <emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis>. +event as specified by the <emphasis remap='I'>(xC</emphasis>. </para> </listitem> <listitem> @@ -902,7 +902,7 @@ If <emphasis remap='I'>popup_shell</emphasis>'s <emphasis remap='I'>grab_kind</e or <function>XtGrabExclusive</function>, it calls -<function>XtRemoveGrab</function>. +<xref linkend='XtRemoveGrab' xrefstyle='select: title'/>. </para> </listitem> <listitem> @@ -921,7 +921,7 @@ as the <emphasis remap='I'>call_data</emphasis> argument. </itemizedlist> <para> To pop down a pop-up from a callback list, you may use the callback -<function>XtCallbackPopdown</function>. +<xref linkend='XtCallbackPopdown' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCallbackPopdown'> @@ -970,7 +970,7 @@ which is not used by this procedure. </variablelist> <para> The -<function>XtCallbackPopdown</function> +<xref linkend='XtCallbackPopdown' xrefstyle='select: title'/> function casts the <emphasis remap='I'>client_data</emphasis> parameter to a pointer of type <function>XtPopdownID</function>. </para> @@ -987,12 +987,12 @@ in one of the pop-up callback convenience procedures. </para> <para> -<function>XtCallbackPopdown</function> +<xref linkend='XtCallbackPopdown' xrefstyle='select: title'/> calls -<function>XtPopdown</function> +<xref linkend='XtPopdown' xrefstyle='select: title'/> with the specified <emphasis remap='I'>shell_widget</emphasis> and then calls -<function>XtSetSensitive</function> +<xref linkend='XtSetSensitive' xrefstyle='select: title'/> to resensitize <emphasis remap='I'>enable_widget</emphasis>. </para> @@ -1001,7 +1001,7 @@ Within a translation table, to pop down a spring-loaded menu when a key or pointer button is released or when the pointer is moved into a widget, use -<function>XtMenuPopdown</function> +<xref linkend='XtMenuPopdown' xrefstyle='select: title'/> or its synonym, <function>MenuPopdown</function>. From a translation writer's point of view, @@ -1029,12 +1029,12 @@ Specifies the name of the shell widget to pop down. </variablelist> <para> If a shell name is not given, -<function>XtMenuPopdown</function> +<xref linkend='XtMenuPopdown' xrefstyle='select: title'/> calls -<function>XtPopdown</function> +<xref linkend='XtPopdown' xrefstyle='select: title'/> with the widget for which the translation is specified. If <emphasis remap='I'>shell_name</emphasis> is specified in the translation table, -<function>XtMenuPopdown</function> +<xref linkend='XtMenuPopdown' xrefstyle='select: title'/> tries to find the shell by looking up the widget tree starting at the widget in which it is invoked. If it finds a shell with the specified name in the pop-up children @@ -1042,7 +1042,7 @@ of that widget, it pops down the shell; otherwise, it moves up the parent chain to find a pop-up child with the specified name. If -<function>XtMenuPopdown</function> +<xref linkend='XtMenuPopdown' xrefstyle='select: title'/> gets to the application top-level shell widget and cannot find a matching shell, it generates a warning and returns immediately. diff --git a/specs/CH06.xml b/specs/CH06.xml index a0a0f23..6df6892 100755 --- a/specs/CH06.xml +++ b/specs/CH06.xml @@ -29,15 +29,15 @@ Parents, children, and clients each initiate geometry changes differently. Because a parent has absolute control of its children's geometry, it changes the geometry directly by calling <function>XtMove\%Widget</function>, -<function>XtResizeWidget</function>, +<xref linkend='XtResizeWidget' xrefstyle='select: title'/>, or -<function>XtConfigureWidget</function>. +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>. A child must ask its parent for a geometry change by calling -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> or -<function>XtMakeResizeRequest</function>. +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>. An application or other client code initiates a geometry change by calling -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> on the appropriate geometry fields, thereby giving the widget the opportunity to modify or reject the client request before it gets propagated to the parent and the opportunity @@ -57,14 +57,14 @@ When the geometry manager is asked to change the geometry of a child, the geometry manager may also rearrange and resize any or all of the other children that it controls. The geometry manager can move children around freely using -<function>XtMoveWidget</function>. +<xref linkend='XtMoveWidget' xrefstyle='select: title'/>. When it resizes a child (that is, changes the width, height, or border width) other than the one making the request, it should do so by calling -<function>XtResizeWidget</function>. +<xref linkend='XtResizeWidget' xrefstyle='select: title'/>. The requesting child may be given special treatment; see Section 6.5. It can simultaneously move and resize a child with a single call to -<function>XtConfigureWidget</function>. +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>. </para> <para> @@ -93,7 +93,7 @@ see Sections 2.5 and 2.6. The Intrinsics treatment of stacking requests is deficient in several areas. Stacking requests for unrealized widgets are granted but will have no effect. In addition, there is no way to do an -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> that will generate a stacking geometry request. </para> </listitem> @@ -132,7 +132,7 @@ typedef struct { <para> To make a general geometry manager request from a widget, use -<function>XtMakeGeometryRequest</function>. +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtMakeGeometryRequest'> @@ -182,7 +182,7 @@ if the requesting widget is not interested in handling <para> Depending on the condition, -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> performs the following: </para> @@ -229,7 +229,7 @@ and if <function>XtCWQueryOnly</function> is not set in <emphasis remap='I'>request->request_mode</emphasis> and if the widget is realized, -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> calls the <function>XConfigureWindow</function> Xlib function to reconfigure the widget's window (set its size, location, @@ -242,10 +242,10 @@ If the geometry manager returns <function>XtGeometryDone</function>, the change has been approved and actually has been done. In this case, -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> does no configuring and returns <function>XtGeometryYes</function>. -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> never returns <function>XtGeometryDone</function>. </para> @@ -253,7 +253,7 @@ never returns <listitem> <para> Otherwise, -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> just returns the resulting value from the parent's geometry manager. </para> </listitem> @@ -261,7 +261,7 @@ just returns the resulting value from the parent's geometry manager. <para> Children of primitive widgets are always unmanaged; therefore, -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> always returns <function>XtGeometryYes</function> when called by a child of a primitive widget. @@ -357,7 +357,7 @@ and that no widgets should actually be changed. </para> <para> -<function>XtMakeGeometryRequest</function>, +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>, like the <function>XConfigureWindow</function> Xlib function, uses <emphasis remap='I'>request_mode</emphasis> to determine which fields in the @@ -442,9 +442,9 @@ indicates that the widget wants its current stacking order preserved. <title>Resize Requests</title> <para> To make a simple resize request from a widget, you can use -<function>XtMakeResizeRequest</function> +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/> as an alternative to -<function>XtMakeGeometryRequest</function>. +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtMakeResizeRequest'> @@ -507,9 +507,9 @@ Return the allowed widget width and height. <para> The -<function>XtMakeResizeRequest</function> +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/> function, a simple interface to -<function>XtMakeGeometryRequest</function>, +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>, creates an <function>XtWidgetGeometry</function> structure and specifies that width and height should change @@ -524,7 +524,7 @@ If the return value is <emphasis remap='I'>width_return</emphasis> and <emphasis remap='I'>height_return</emphasis> contain a compromise width and height. If these are acceptable, the widget should immediately call -<function>XtMakeResizeRequest</function> +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/> again and request that the compromise width and height be applied. If the widget is not interested in <function>XtGeometryAlmost</function> @@ -595,7 +595,7 @@ therefore, a cache of size 1 is sufficient. <title>Child Geometry Management: The geometry_manager Procedure</title> <para> The geometry_manager procedure pointer in a composite widget class is of type -<function>XtGeometryHandler</function>. +<xref linkend='XtGeometryHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGeometryHandler'> @@ -666,16 +666,16 @@ Then, it returns <function>XtGeometryYes</function>, and the values pointed to by the <emphasis remap='I'>geometry_return</emphasis> argument are undefined. The widget's window is moved and resized automatically by -<function>XtMakeGeometryRequest</function>. +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>. </para> <para> Homogeneous composite widgets often find it convenient to treat the widget making the request the same as any other widget, including reconfiguring it using -<function>XtConfigureWidget</function> +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/> or -<function>XtResizeWidget</function> +<xref linkend='XtResizeWidget' xrefstyle='select: title'/> as part of its layout process, unless <function>XtCWQueryOnly</function> is specified. @@ -683,7 +683,7 @@ If it does this, it should return <function>XtGeometryDone</function> to inform -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> that it does not need to do the configuration itself. </para> @@ -693,9 +693,9 @@ To remain compatible with layout techniques used in older widgets (before <function>XtGeometryDone</function> was added to the Intrinsics), a geometry manager should avoid using -<function>XtResizeWidget</function> +<xref linkend='XtResizeWidget' xrefstyle='select: title'/> or -<function>XtConfigureWidget</function> +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/> on the child making the request because the layout process of the child may be in an intermediate state in which it is not prepared to handle a call to its @@ -707,7 +707,7 @@ clearly warns widget developers of the compatibility consequences. <para> Although -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> resizes the widget's window (if the geometry manager returns @@ -759,7 +759,7 @@ the widget must decide if the compromise suggested in <emphasis remap='I'>geomet is acceptable. If it is, the widget must not change its geometry directly; rather, it must make another call to -<function>XtMakeGeometryRequest</function>. +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>. </para> <para> @@ -782,12 +782,12 @@ To return <function>XtGeometryYes</function>, the geometry manager frequently rearranges the position of other managed children by calling -<function>XtMoveWidget</function>. +<xref linkend='XtMoveWidget' xrefstyle='select: title'/>. However, a few geometry managers may sometimes change the size of other managed children by calling -<function>XtResizeWidget</function> +<xref linkend='XtResizeWidget' xrefstyle='select: title'/> or -<function>XtConfigureWidget</function>. +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>. If <function>XtCWQueryOnly</function> is specified, @@ -810,7 +810,7 @@ if necessary. <para> To move a sibling widget of the child making the geometry request, the parent uses -<function>XtMoveWidget</function>. +<xref linkend='XtMoveWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtMoveWidget'> @@ -854,11 +854,11 @@ Specify the new widget x and y coordinates. </variablelist> <para> The -<function>XtMoveWidget</function> +<xref linkend='XtMoveWidget' xrefstyle='select: title'/> function returns immediately if the specified geometry fields are the same as the old values. Otherwise, -<function>XtMoveWidget</function> +<xref linkend='XtMoveWidget' xrefstyle='select: title'/> writes the new <emphasis remap='I'>x</emphasis> and <emphasis remap='I'>y</emphasis> values into the object and, if the object is a widget and is realized, issues an Xlib <function>XMoveWindow</function> @@ -868,7 +868,7 @@ call on the widget's window. <para> To resize a sibling widget of the child making the geometry request, the parent uses -<function>XtResizeWidget</function>. +<xref linkend='XtResizeWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtResizeWidget'> @@ -921,11 +921,11 @@ Specify the new widget size. </variablelist> <para> The -<function>XtResizeWidget</function> +<xref linkend='XtResizeWidget' xrefstyle='select: title'/> function returns immediately if the specified geometry fields are the same as the old values. Otherwise, -<function>XtResizeWidget</function> +<xref linkend='XtResizeWidget' xrefstyle='select: title'/> writes the new <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, and <emphasis remap='I'>border_width</emphasis> values into the object and, if the object is a widget and is realized, issues an <function>XConfigureWindow</function> @@ -934,14 +934,14 @@ call on the widget's window. <para> If the new width or height is different from the old values, -<function>XtResizeWidget</function> +<xref linkend='XtResizeWidget' xrefstyle='select: title'/> calls the object's resize procedure to notify it of the size change. </para> <para> To move and resize the sibling widget of the child making the geometry request, the parent uses -<function>XtConfigureWidget</function>. +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtConfigureWidget'> @@ -1014,11 +1014,11 @@ Specify the new widget size. </variablelist> <para> The -<function>XtConfigureWidget</function> +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/> function returns immediately if the specified new geometry fields are all equal to the current values. Otherwise, -<function>XtConfigureWidget</function> +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/> writes the new <emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>, <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, and <emphasis remap='I'>border_width</emphasis> values into the object and, if the object is a widget and is realized, makes an Xlib @@ -1028,7 +1028,7 @@ call on the widget's window. <para> If the new width or height is different from its old value, -<function>XtConfigureWidget</function> +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/> calls the object's resize procedure to notify it of the size change; otherwise, it simply returns. </para> @@ -1036,7 +1036,7 @@ otherwise, it simply returns. <para> To resize a child widget that already has the new values of its width, height, and border width, the parent uses -<function>XtResizeWindow</function>. +<xref linkend='XtResizeWindow' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtResizeWindow'> @@ -1060,7 +1060,7 @@ Specifies the widget. Must be of class Core or any subclass thereof. </variablelist> <para> The -<function>XtResizeWindow</function> +<xref linkend='XtResizeWindow' xrefstyle='select: title'/> function calls the <function>XConfigureWindow</function> Xlib function to make the window of the specified widget match its width, @@ -1073,9 +1073,9 @@ Note that the widget's resize procedure is not called. <para> There are very few times to use -<function>XtResizeWindow</function>; +<xref linkend='XtResizeWindow' xrefstyle='select: title'/>; instead, the parent should use -<function>XtResizeWidget</function>. +<xref linkend='XtResizeWidget' xrefstyle='select: title'/>. </para> </sect1> @@ -1085,14 +1085,14 @@ instead, the parent should use Some parents may be willing to adjust their layouts to accommodate the preferred geometries of their children. They can use -<function>XtQueryGeometry</function> +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/> to obtain the preferred geometry and, as they see fit, can use or ignore any portion of the response. </para> <para> To query a child widget's preferred geometry, use -<function>XtQueryGeometry</function>. +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtQueryGeometry'> @@ -1143,23 +1143,23 @@ the child's parent stores the new geometry in the corresponding fields of the intended structure, sets the corresponding bits in <emphasis remap='I'>intended.request_mode</emphasis>, and calls -<function>XtQueryGeometry</function>. +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/>. The parent should set only those fields that are important to it so that the child can determine whether it may be able to attempt changes to other fields. </para> <para> -<function>XtQueryGeometry</function> +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/> clears all bits in the <emphasis remap='I'>preferred_return->request_mode</emphasis> field and checks the <emphasis remap='I'>query_geometry</emphasis> field of the specified widget's class record. If <emphasis remap='I'>query_geometry</emphasis> is not NULL, -<function>XtQueryGeometry</function> +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/> calls the query_geometry procedure and passes as arguments the specified widget, <emphasis remap='I'>intended</emphasis>, and <emphasis remap='I'>preferred_return</emphasis> structures. If the <emphasis remap='I'>intended</emphasis> argument is NULL, -<function>XtQueryGeometry</function> +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/> replaces it with a pointer to an <function>XtWidgetGeometry</function> structure with <emphasis remap='I'>request_mode</emphasis> equal to zero before calling the @@ -1169,12 +1169,12 @@ query_geometry procedure. <note> <para> If -<function>XtQueryGeometry</function> +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/> is called from within a geometry_manager procedure for the widget that issued -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> or -<function>XtMakeResizeRequest</function>, +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>, the results are not guaranteed to be consistent with the requested changes. The change request passed to the geometry manager takes precedence over @@ -1184,7 +1184,7 @@ the preferred geometry. <para> The query_geometry procedure pointer is of type -<function>XtGeometryHandler</function>. +<xref linkend='XtGeometryHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='_XtGeometryHandler'> @@ -1250,9 +1250,9 @@ the query_geometry procedure should return <function>XtGeometryNo</function>. The query_geometry procedure may assume that no -<function>XtMakeResizeRequest</function> +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/> or -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> is in progress for the specified widget; that is, it is not required to construct a reply consistent with the requested geometry if such a request @@ -1262,7 +1262,7 @@ were actually outstanding. <para> After calling the query_geometry procedure or if the <emphasis remap='I'>query_geometry</emphasis> field is NULL, -<function>XtQueryGeometry</function> +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/> examines all the unset bits in <emphasis remap='I'>preferred_return->request_mode</emphasis> and sets the corresponding fields in <emphasis remap='I'>preferred_return</emphasis> to the current values from the widget instance. @@ -1271,7 +1271,7 @@ If is not set, the <emphasis remap='I'>stack_mode</emphasis> field is set to <function>XtSMDontChange</function>. -<function>XtQueryGeometry</function> +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/> returns the value returned by the query_geometry procedure or <function>XtGeometryYes</function> if the <emphasis remap='I'>query_geometry</emphasis> field is NULL. @@ -1300,7 +1300,7 @@ geometry information for the child. <para> Parents are expected to call -<function>XtQueryGeometry</function> +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/> in their layout routine and wherever else the information is significant after change_managed has been called. The first time it is invoked, @@ -1318,12 +1318,12 @@ A child can be resized by its parent at any time. Widgets usually need to know when they have changed size so that they can lay out their displayed data again to match the new size. When a parent resizes a child, it calls -<function>XtResizeWidget</function>, +<xref linkend='XtResizeWidget' xrefstyle='select: title'/>, which updates the geometry fields in the widget, configures the window if the widget is realized, and calls the child's resize procedure to notify the child. The resize procedure pointer is of type -<function>XtWidgetProc</function>. +<xref linkend='XtWidgetProc' xrefstyle='select: title'/>. </para> <para> @@ -1340,9 +1340,9 @@ as needed. should recalculate the starting position of the text.) The widget must obey resize as a command and must not treat it as a request. A widget must not issue an -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> or -<function>XtMakeResizeRequest</function> +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/> call from its resize procedure. </para> </sect1> diff --git a/specs/CH07.xml b/specs/CH07.xml index ca60ba4..a5050b4 100755 --- a/specs/CH07.xml +++ b/specs/CH07.xml @@ -13,7 +13,7 @@ A typical application consists of startup code followed by an event loop that reads events and dispatches them by calling the procedures that widgets have registered. The default event loop provided by the Intrinsics is -<function>XtAppMainLoop</function>. +<xref linkend='XtAppMainLoop' xrefstyle='select: title'/>. </para> <para> @@ -71,7 +71,7 @@ The normal interface to X events is through the higher-level translation manager, which maps sequences of X events, with modifiers, into procedure calls. Applications rarely use any of the event manager routines besides -<function>XtAppMainLoop</function>. +<xref linkend='XtAppMainLoop' xrefstyle='select: title'/>. </para> <sect1 id="Adding_and_Deleting_Additional_Event_Sources"> <title>Adding and Deleting Additional Event Sources</title> @@ -93,7 +93,7 @@ the registered callback procedures are invoked. <title>Adding and Removing Input Sources</title> <para> To register a new file as an input source for a given application context, use -<function>XtAppAddInput</function>. +<xref linkend='XtAppAddInput' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppAddInput'> @@ -164,12 +164,12 @@ when it is called. </variablelist> <para> The -<function>XtAppAddInput</function> +<xref linkend='XtAppAddInput' xrefstyle='select: title'/> function registers with the Intrinsics read routine a new source of events, which is usually file input but can also be file output. Note that <emphasis remap='I'>file</emphasis> should be loosely interpreted to mean any sink or source of data. -<function>XtAppAddInput</function> +<xref linkend='XtAppAddInput' xrefstyle='select: title'/> also specifies the conditions under which the source can generate events. When an event is pending on this source, the callback procedure is called. @@ -218,7 +218,7 @@ exception data. <para> Callback procedure pointers used to handle file events are of type -<function>XtInputCallbackProc</function>. +<xref linkend='XtInputCallbackProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtInputCallbackProc'> @@ -259,7 +259,7 @@ Passes the source file descriptor generating the event. <listitem> <para> Passes the id returned from the corresponding -<function>XtAppAddInput</function> +<xref linkend='XtAppAddInput' xrefstyle='select: title'/> call. </para> </listitem> @@ -267,13 +267,13 @@ call. </variablelist> <para> See Section 7.12 for information regarding the use of -<function>XtAppAddInput</function> +<xref linkend='XtAppAddInput' xrefstyle='select: title'/> in multiple threads. </para> <para> To discontinue a source of input, use -<function>XtRemoveInput</function>. +<xref linkend='XtRemoveInput' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveInput'> @@ -291,7 +291,7 @@ To discontinue a source of input, use <listitem> <para> Specifies the id returned from the corresponding -<function>XtAppAddInput</function> +<xref linkend='XtAppAddInput' xrefstyle='select: title'/> call. </para> </listitem> @@ -299,14 +299,14 @@ call. </variablelist> <para> The -<function>XtRemoveInput</function> +<xref linkend='XtRemoveInput' xrefstyle='select: title'/> function causes the Intrinsics read routine to stop watching for events from the file source specified by <emphasis remap='I'>id</emphasis>. </para> <para> See Section 7.12 for information regarding the use of -<function>XtRemoveInput</function> +<xref linkend='XtRemoveInput' xrefstyle='select: title'/> in multiple threads. </para> </sect2> @@ -322,7 +322,7 @@ in an operating system call. <para> To register a hook that is called immediately prior to event blocking, use -<function>XtAppAddBlockHook</function>. +<xref linkend='XtAppAddBlockHook' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppAddBlockHook'> @@ -368,7 +368,7 @@ Specifies an argument passed to the specified procedure when it is called. </variablelist> <para> The -<function>XtAppAddBlockHook</function> +<xref linkend='XtAppAddBlockHook' xrefstyle='select: title'/> function registers the specified procedure and returns an identifier for it. The hook procedure <emphasis remap='I'>proc</emphasis> is called at any time in the future when the Intrinsics are about to block pending some input. @@ -377,7 +377,7 @@ the Intrinsics are about to block pending some input. <para> The procedure pointers used to provide notification of event blocking are of type -<function>XtBlockHookProc</function>. +<xref linkend='XtBlockHookProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtBlockHookProc'> @@ -402,7 +402,7 @@ Passes the client data argument that was registered for this procedure in </variablelist> <para> To discontinue the use of a procedure for blocking notification, use -<function>XtRemoveBlockHook</function>. +<xref linkend='XtRemoveBlockHook' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveBlockHook'> @@ -420,14 +420,14 @@ To discontinue the use of a procedure for blocking notification, use <listitem> <para> Specifies the identifier returned from the corresponding call to -<function>XtAppAddBlockHook</function>. +<xref linkend='XtAppAddBlockHook' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> </variablelist> <para> The -<function>XtRemoveBlockHook</function> +<xref linkend='XtRemoveBlockHook' xrefstyle='select: title'/> function removes the specified procedure from the list of procedures that are called by the Intrinsics read routine before blocking on event sources. </para> @@ -443,7 +443,7 @@ Timeout values are uniquely identified by an interval id. <para> To register a timeout callback, use -<function>XtAppAddTimeOut</function>. +<xref linkend='XtAppAddTimeOut' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppAddTimeOut'> @@ -501,13 +501,13 @@ when it is called. </variablelist> <para> The -<function>XtAppAddTimeOut</function> +<xref linkend='XtAppAddTimeOut' xrefstyle='select: title'/> function creates a timeout and returns an identifier for it. The timeout value is set to <emphasis remap='I'>interval</emphasis>. The callback procedure <emphasis remap='I'>proc</emphasis> is called when -<function>XtAppNextEvent</function> +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/> or -<function>XtAppProcessEvent</function> +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/> is next called after the time interval elapses, and then the timeout is removed. </para> @@ -515,7 +515,7 @@ and then the timeout is removed. <para> Callback procedure pointers used with timeouts are of type -<function>XtTimerCallbackProc</function>. +<xref linkend='XtTimerCallbackProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtTimerCallbackProc'> @@ -545,7 +545,7 @@ Passes the client data argument that was registered for this procedure in <listitem> <para> Passes the id returned from the corresponding -<function>XtAppAddTimeOut</function> +<xref linkend='XtAppAddTimeOut' xrefstyle='select: title'/> call. </para> </listitem> @@ -553,13 +553,13 @@ call. </variablelist> <para> See Section 7.12 for information regarding the use of -<function>XtAppAddTimeOut</function> +<xref linkend='XtAppAddTimeOut' xrefstyle='select: title'/> in multiple threads. </para> <para> To clear a timeout value, use -<function>XtRemoveTimeOut</function>. +<xref linkend='XtRemoveTimeOut' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveTimeOut'> @@ -583,14 +583,14 @@ Specifies the id for the timeout request to be cleared. </variablelist> <para> The -<function>XtRemoveTimeOut</function> +<xref linkend='XtRemoveTimeOut' xrefstyle='select: title'/> function removes the pending timeout. Note that timeouts are automatically removed once they trigger. </para> <para> Please refer to Section 7.12 for information regarding the use of -<function>XtRemoveTimeOut</function> +<xref linkend='XtRemoveTimeOut' xrefstyle='select: title'/> in multiple threads. </para> </sect2> @@ -607,13 +607,13 @@ by a signal id. <para> Prior to establishing a signal handler, the application or widget should call -<function>XtAppAddSignal</function> +<xref linkend='XtAppAddSignal' xrefstyle='select: title'/> and store the resulting identifier in a place accessible to the signal handler. When a signal arrives, the signal handler should call -<function>XtNoticeSignal</function> +<xref linkend='XtNoticeSignal' xrefstyle='select: title'/> to notify the Intrinsics that a signal has occured. To register a signal callback use -<function>XtAppAddSignal</function>. +<xref linkend='XtAppAddSignal' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppAddSignal'> @@ -659,7 +659,7 @@ Specifies an argument passed to the specified procedure when it is called. </variablelist> <para> The callback procedure pointers used to handle signal events are of type -<function>XtSignalCallbackProc</function>. +<xref linkend='XtSignalCallbackProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSignalCallbackProc'> @@ -678,7 +678,7 @@ The callback procedure pointers used to handle signal events are of type <listitem> <para> Passes the client data argument that was registered for this procedure in -<function>XtAppAddSignal</function>. +<xref linkend='XtAppAddSignal' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> @@ -689,7 +689,7 @@ Passes the client data argument that was registered for this procedure in <listitem> <para> Passes the id returned from the corresponding -<function>XtAppAddSignal</function> +<xref linkend='XtAppAddSignal' xrefstyle='select: title'/> call. </para> </listitem> @@ -697,7 +697,7 @@ call. </variablelist> <para> To notify the Intrinsics that a signal has occured, use -<function>XtNoticeSignal</function>. +<xref linkend='XtNoticeSignal' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtNoticeSignal'> @@ -715,7 +715,7 @@ To notify the Intrinsics that a signal has occured, use <listitem> <para> Specifies the id returned from the corresponding -<function>XtAppAddSignal</function> +<xref linkend='XtAppAddSignal' xrefstyle='select: title'/> call. </para> </listitem> @@ -723,10 +723,10 @@ call. </variablelist> <para> On a POSIX-based system, -<function>XtNoticeSignal</function> +<xref linkend='XtNoticeSignal' xrefstyle='select: title'/> is the only Intrinsics function that can safely be called from a signal handler. If -<function>XtNoticeSignal</function> +<xref linkend='XtNoticeSignal' xrefstyle='select: title'/> is invoked multiple times before the Intrinsics are able to invoke the registered callback, the callback is only called once. Logically, the Intrinsics maintain ``pending'' flag for each registered callback. @@ -735,11 +735,11 @@ This flag is initially and is set to <function>True</function> by -<function>XtNoticeSignal</function>. +<xref linkend='XtNoticeSignal' xrefstyle='select: title'/>. When -<function>XtAppNextEvent</function> +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/> or -<function>XtAppProcessEvent</function> +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/> (with a mask including <function>XtIMSignal</function>) is called, all registered callbacks with ``pending'' @@ -768,7 +768,7 @@ callback must also be prepared to handle this case. <para> To remove a registered signal callback, call -<function>XtRemoveSignal</function>. +<xref linkend='XtRemoveSignal' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveSignal'> @@ -786,22 +786,22 @@ To remove a registered signal callback, call <listitem> <para> Specifies the id returned by the corresponding call to -<function>XtAppAddSignal</function>. +<xref linkend='XtAppAddSignal' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> </variablelist> <para> The client should typically disable the source of the signal before calling -<function>XtRemoveSignal</function>. +<xref linkend='XtRemoveSignal' xrefstyle='select: title'/>. If the signal could have been raised again before the source was disabled and the client wants to process it, then after disabling the source but before calling -<function>XtRemoveSignal</function> +<xref linkend='XtRemoveSignal' xrefstyle='select: title'/> the client can test for signals with -<function>XtAppPending</function> +<xref linkend='XtAppPending' xrefstyle='select: title'/> and process them by calling -<function>XtAppProcessEvent</function> +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/> with the mask <function>XtIMSignal</function>. </para> @@ -817,7 +817,7 @@ lock out user input to the application. <para> When a modal menu or modal dialog box is popped up using -<function>XtPopup</function>, +<xref linkend='XtPopup' xrefstyle='select: title'/>, user events (keyboard and pointer events) that occur outside the modal widget should be delivered to the modal widget or ignored. In no case will user events be delivered to a widget outside @@ -860,18 +860,18 @@ events. </para> <para> -<function>XtPopup</function> +<xref linkend='XtPopup' xrefstyle='select: title'/> uses the -<function>XtAddGrab</function> +<xref linkend='XtAddGrab' xrefstyle='select: title'/> and -<function>XtRemoveGrab</function> +<xref linkend='XtRemoveGrab' xrefstyle='select: title'/> functions to constrain user events to a modal cascade and subsequently to remove a grab when the modal widget is popped down. </para> <para> To constrain or redirect user input to a modal widget, use -<function>XtAddGrab</function>. +<xref linkend='XtAddGrab' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAddGrab'> @@ -919,23 +919,23 @@ a pointer button. </variablelist> <para> The -<function>XtAddGrab</function> +<xref linkend='XtAddGrab' xrefstyle='select: title'/> function appends the widget to the modal cascade and checks that <emphasis remap='I'>exclusive</emphasis> is <function>True</function> if <emphasis remap='I'>spring_loaded</emphasis> is <function>True</function>. If this condition is not met, -<function>XtAddGrab</function> +<xref linkend='XtAddGrab' xrefstyle='select: title'/> generates a warning message. </para> <para> The modal cascade is used by -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> when it tries to dispatch a user event. When at least one modal widget is in the widget cascade, -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> first determines if the event should be delivered. It starts at the most recent cascade entry and follows the cascade up to and including the most recent cascade entry added with the <emphasis remap='I'>exclusive</emphasis> parameter @@ -974,7 +974,7 @@ the contents of the event. <para> To remove the redirection of user input to a modal widget, use -<function>XtRemoveGrab</function>. +<xref linkend='XtRemoveGrab' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveGrab'> @@ -998,7 +998,7 @@ Specifies the widget to remove from the modal cascade. </variablelist> <para> The -<function>XtRemoveGrab</function> +<xref linkend='XtRemoveGrab' xrefstyle='select: title'/> function removes widgets from the modal cascade starting at the most recent widget up to and including the specified widget. It issues a warning if the specified widget is not on the modal cascade. @@ -1017,7 +1017,7 @@ routines. <para> To passively grab a single key of the keyboard, use -<function>XtGrabKey</function>. +<xref linkend='XtGrabKey' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGrabKey'> @@ -1091,7 +1091,7 @@ see Section 12.2 in <emphasis remap='I'>Xlib — C Language X Interface.</emphas </varlistentry> </variablelist> <para> -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> calls <function>XGrabKey</function> specifying the widget's window as the grab @@ -1103,7 +1103,7 @@ If the widget is not realized, or is later unrealized, the call to is performed (again) when the widget is realized and its window becomes mapped. In the future, if -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> is called with a <function>KeyPress</function> event matching the specified keycode and modifiers (which may be @@ -1112,7 +1112,7 @@ or <function>AnyModifier</function>, respectively) for the widget's window, the Intrinsics will call -<function>XtUngrabKeyboard</function> +<xref linkend='XtUngrabKeyboard' xrefstyle='select: title'/> with the timestamp from the <function>KeyPress</function> event if either of the following conditions is true: @@ -1135,7 +1135,7 @@ returns </itemizedlist> <para> To cancel a passive key grab, use -<function>XtUngrabKey</function>. +<xref linkend='XtUngrabKey' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtUngrabKey'> @@ -1182,7 +1182,7 @@ see Section 12.2 in <emphasis remap='I'>Xlib — C Language X Interface.</emphas </variablelist> <para> The -<function>XtUngrabKey</function> +<xref linkend='XtUngrabKey' xrefstyle='select: title'/> procedure calls <function>XUngrabKey</function> specifying the widget's @@ -1190,15 +1190,15 @@ window as the ungrab window if the widget is realized. The remaining arguments are exactly as for <function>XUngrabKey</function>. If the widget is not realized, -<function>XtUngrabKey</function> +<xref linkend='XtUngrabKey' xrefstyle='select: title'/> removes a deferred -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> request, if any, for the specified widget, keycode, and modifiers. </para> <para> To actively grab the keyboard, use -<function>XtGrabKeyboard</function>. +<xref linkend='XtGrabKeyboard' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGrabKeyboard'> @@ -1265,23 +1265,23 @@ see Section 12.2 in <emphasis remap='I'>Xlib — C Language X Interface.</emphas </variablelist> <para> If the specified widget is realized, -<function>XtGrabKeyboard</function> +<xref linkend='XtGrabKeyboard' xrefstyle='select: title'/> calls <function>XGrabKeyboard</function> specifying the widget's window as the grab window. The remaining arguments and return value are exactly as for <function>XGrabKeyboard</function>. If the widget is not realized, -<function>XtGrabKeyboard</function> +<xref linkend='XtGrabKeyboard' xrefstyle='select: title'/> immediately returns <function>GrabNotViewable</function>. No future automatic ungrab is implied by -<function>XtGrabKeyboard</function>. +<xref linkend='XtGrabKeyboard' xrefstyle='select: title'/>. </para> <para> To cancel an active keyboard grab, use -<function>XtUngrabKeyboard</function>. +<xref linkend='XtUngrabKeyboard' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtUngrabKeyboard'> @@ -1317,7 +1317,7 @@ see Section 12.2 in <emphasis remap='I'>Xlib — C Language X Interface.</emphas </varlistentry> </variablelist> <para> -<function>XtUngrabKeyboard</function> +<xref linkend='XtUngrabKeyboard' xrefstyle='select: title'/> calls <function>XUngrabKeyboard</function> with the specified time. @@ -1325,7 +1325,7 @@ with the specified time. <para> To passively grab a single pointer button, use -<function>XtGrabButton</function>. +<xref linkend='XtGrabButton' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGrabButton'> @@ -1429,7 +1429,7 @@ see Section 12.1 in <emphasis remap='I'>Xlib — C Language X Interface.</emphas </varlistentry> </variablelist> <para> -<function>XtGrabButton</function> +<xref linkend='XtGrabButton' xrefstyle='select: title'/> calls <function>XGrabButton</function> specifying the widget's window as the @@ -1441,7 +1441,7 @@ If the widget is not realized, or is later unrealized, the call to is performed (again) when the widget is realized and its window becomes mapped. In the future, if -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> is called with a <function>ButtonPress</function> event matching the specified button and modifiers (which may be @@ -1450,7 +1450,7 @@ or <function>AnyModifier</function>, respectively) for the widget's window, the Intrinsics will call -<function>XtUngrabPointer</function> +<xref linkend='XtUngrabPointer' xrefstyle='select: title'/> with the timestamp from the <function>ButtonPress</function> event if either of the following conditions is true: @@ -1473,7 +1473,7 @@ returns </itemizedlist> <para> To cancel a passive button grab, use -<function>XtUngrabButton</function>. +<xref linkend='XtUngrabButton' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtUngrabButton'> @@ -1519,7 +1519,7 @@ see Section 12.1 in <emphasis remap='I'>Xlib — C Language X Interface.</emphas </variablelist> <para> The -<function>XtUngrabButton</function> +<xref linkend='XtUngrabButton' xrefstyle='select: title'/> procedure calls <function>XUngrabButton</function> specifying the @@ -1527,15 +1527,15 @@ widget's window as the ungrab window if the widget is realized. The remaining arguments are exactly as for <function>XUngrabButton</function>. If the widget is not realized, -<function>XtUngrabButton</function> +<xref linkend='XtUngrabButton' xrefstyle='select: title'/> removes a deferred -<function>XtGrabButton</function> +<xref linkend='XtGrabButton' xrefstyle='select: title'/> request, if any, for the specified widget, button, and modifiers. </para> <para> To actively grab the pointer, use -<function>XtGrabPointer</function>. +<xref linkend='XtGrabPointer' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGrabPointer'> @@ -1625,23 +1625,23 @@ see Section 12.1 in <emphasis remap='I'>Xlib — C Language X Interface.</emphas </variablelist> <para> If the specified widget is realized, -<function>XtGrabPointer</function> +<xref linkend='XtGrabPointer' xrefstyle='select: title'/> calls <function>XGrabPointer</function>, specifying the widget's window as the grab window. The remaining arguments and return value are exactly as for <function>XGrabPointer</function>. If the widget is not realized, -<function>XtGrabPointer</function> +<xref linkend='XtGrabPointer' xrefstyle='select: title'/> immediately returns <function>GrabNotViewable</function>. No future automatic ungrab is implied by -<function>XtGrabPointer</function>. +<xref linkend='XtGrabPointer' xrefstyle='select: title'/>. </para> <para> To cancel an active pointer grab, use -<function>XtUngrabPointer</function>. +<xref linkend='XtUngrabPointer' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtUngrabPointer'> @@ -1677,7 +1677,7 @@ see Section 12.1 in <emphasis remap='I'>Xlib — C Language X Interface.</emphas </varlistentry> </variablelist> <para> -<function>XtUngrabPointer</function> +<xref linkend='XtUngrabPointer' xrefstyle='select: title'/> calls <function>XUngrabPointer</function> with the specified time. @@ -1692,7 +1692,7 @@ To redirect keyboard input to a normal descendant of a widget without calling <function>XSetInputFocus</function>, use -<function>XtSetKeyboardFocus</function>. +<xref linkend='XtSetKeyboardFocus' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetKeyboardFocus'> @@ -1731,9 +1731,9 @@ when no input focus was previously set. Must be of class Object or any subclass </varlistentry> </variablelist> <para> -<function>XtSetKeyboardFocus</function> +<xref linkend='XtSetKeyboardFocus' xrefstyle='select: title'/> causes -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> to remap keyboard events occurring within the specified subtree and dispatch them to the specified descendant widget or to an ancestor. If the descendant's class is not a subclass of Core, the descendant is @@ -1752,14 +1752,14 @@ keyboard grabs, or pointer position). If neither E nor any of E's ancestors have redirected the keyboard focus, or if the event activated a grab for E as specified by a call to -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> with any value of <emphasis remap='I'>owner_events</emphasis>, or if the keyboard is actively grabbed by E with <emphasis remap='I'>owner_events</emphasis> <function>False</function> via -<function>XtGrabKeyboard</function> +<xref linkend='XtGrabKeyboard' xrefstyle='select: title'/> or -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> on a previous key press, the event is dispatched to E. </para> </listitem> @@ -1784,9 +1784,9 @@ event is dispatched to E. <para> If E is not F, an ancestor of F, or a descendant of F, and the event activated a grab for E as specified by a call to -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> for E, -<function>XtUngrabKeyboard</function> +<xref linkend='XtUngrabKeyboard' xrefstyle='select: title'/> is called. </para> </listitem> @@ -1800,7 +1800,7 @@ If E is an ancestor of F, and the event is a key press, and either <listitem> <para> E has grabbed the key with -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> and <emphasis remap='I'>owner_events</emphasis> <function>False</function>, or @@ -1809,7 +1809,7 @@ or <listitem> <para> E has grabbed the key with -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> and <emphasis remap='I'>owner_events</emphasis> <function>True</function>, and the coordinates of the event are outside the rectangle specified @@ -1829,13 +1829,13 @@ Otherwise, define A as the closest common ancestor of E and F: <listitem> <para> If there is an active keyboard grab for any widget via either -<function>XtGrabKeyboard</function> +<xref linkend='XtGrabKeyboard' xrefstyle='select: title'/> or -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> on a previous key press, or if no widget between F and A (noninclusive) has grabbed the key and modifier combination with -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> and any value of <emphasis remap='I'>owner_events</emphasis>, the event is dispatched to F. </para> </listitem> @@ -1843,7 +1843,7 @@ and any value of <emphasis remap='I'>owner_events</emphasis>, the event is dispa <para> Else, the event is dispatched to the ancestor of F closest to A that has grabbed the key and modifier combination with -<function>XtGrabKey</function>. +<xref linkend='XtGrabKey' xrefstyle='select: title'/>. </para> </listitem> </itemizedlist> @@ -1883,7 +1883,7 @@ do so, a widget class specifies an accept_focus procedure. <para> The accept_focus procedure pointer is of type -<function>XtAcceptFocusProc</function>. +<xref linkend='XtAcceptFocusProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAcceptFocusProc'> @@ -1940,7 +1940,7 @@ Widgets classes that never want the input focus should set the <para> To call a widget's accept_focus procedure, use -<function>XtCallAcceptFocus</function>. +<xref linkend='XtCallAcceptFocus' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCallAcceptFocus'> @@ -1975,12 +1975,12 @@ Specifies the X time of the event that is causing the focus change. </variablelist> <para> The -<function>XtCallAcceptFocus</function> +<xref linkend='XtCallAcceptFocus' xrefstyle='select: title'/> function calls the specified widget's accept_focus procedure, passing it the specified widget and time, and returns what the accept_focus procedure returns. If <emphasis remap='I'>accept_focus</emphasis> is NULL, -<function>XtCallAcceptFocus</function> +<xref linkend='XtCallAcceptFocus' xrefstyle='select: title'/> returns <function>False</function>. </para> @@ -1999,7 +1999,7 @@ events on the root window. <para> To register a drawable with the Intrinsics event dispatching, use -<function>XtRegisterDrawable</function>. +<xref linkend='XtRegisterDrawable' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRegisterDrawable'> @@ -2044,10 +2044,10 @@ Specifies the widget to register the drawable for. </varlistentry> </variablelist> <para> -<function>XtRegisterDrawable</function> +<xref linkend='XtRegisterDrawable' xrefstyle='select: title'/> associates the specified drawable with the specified widget so that future calls to -<function>XtWindowToWidget</function> +<xref linkend='XtWindowToWidget' xrefstyle='select: title'/> with the drawable will return the widget. The default event dispatcher will dispatch future events that arrive for the drawable to the widget in the same manner as @@ -2058,13 +2058,13 @@ events that contain the widget's window. If the drawable is already registered with another widget, or if the drawable is the window of a widget in the client's widget tree, the results of calling -<function>XtRegisterDrawable</function> +<xref linkend='XtRegisterDrawable' xrefstyle='select: title'/> are undefined. </para> <para> To unregister a drawable with the Intrinsics event dispatching, use -<function>XtUnregisterDrawable</function>. +<xref linkend='XtUnregisterDrawable' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtUnregisterDrawable'> @@ -2098,12 +2098,12 @@ Specifies the drawable to unregister. </varlistentry> </variablelist> <para> -<function>XtUnregisterDrawable</function> +<xref linkend='XtUnregisterDrawable' xrefstyle='select: title'/> removes an association created with -<function>XtRegisterDrawable</function>. +<xref linkend='XtRegisterDrawable' xrefstyle='select: title'/>. If the drawable is the window of a widget in the client's widget tree the results of calling -<function>XtUnregisterDrawable</function> +<xref linkend='XtUnregisterDrawable' xrefstyle='select: title'/> are undefined. </para> </sect2> @@ -2125,7 +2125,7 @@ Xlib calls. <para> To determine if there are any events on the input queue for a given application, use -<function>XtAppPending</function>. +<xref linkend='XtAppPending' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppPending'> @@ -2149,7 +2149,7 @@ Specifies the application context that identifies the application to check. </variablelist> <para> The -<function>XtAppPending</function> +<xref linkend='XtAppPending' xrefstyle='select: title'/> function returns a nonzero value if there are events pending from the X server, timer pending, other input sources pending, or signal sources pending. The @@ -2162,7 +2162,7 @@ and (see <function>XtAppProcessEvent ).</function> If there are no events pending, -<function>XtAppPending</function> +<xref linkend='XtAppPending' xrefstyle='select: title'/> flushes the output buffers of each Display in the application context and returns zero. </para> @@ -2170,7 +2170,7 @@ and returns zero. <para> To return the event from the head of a given application's input queue without removing input from the queue, use -<function>XtAppPeekEvent</function>. +<xref linkend='XtAppPeekEvent' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppPeekEvent'> @@ -2205,29 +2205,29 @@ Returns the event information to the specified event structure. </variablelist> <para> If there is an X event in the queue, -<function>XtAppPeekEvent</function> +<xref linkend='XtAppPeekEvent' xrefstyle='select: title'/> copies it into <emphasis remap='I'>event_return</emphasis> and returns <function>True</function>. If no X input is on the queue, -<function>XtAppPeekEvent</function> +<xref linkend='XtAppPeekEvent' xrefstyle='select: title'/> flushes the output buffers of each Display in the application context and blocks until some input is available (possibly calling some timeout callbacks in the interim). If the next available input is an X event, -<function>XtAppPeekEvent</function> +<xref linkend='XtAppPeekEvent' xrefstyle='select: title'/> fills in <emphasis remap='I'>event_return</emphasis> and returns <function>True</function>. Otherwise, the input is for an input source registered with -<function>XtAppAddInput</function>, +<xref linkend='XtAppAddInput' xrefstyle='select: title'/>, and -<function>XtAppPeekEvent</function> +<xref linkend='XtAppPeekEvent' xrefstyle='select: title'/> returns <function>False</function>. The sample implementations provides XtAppPeekEvent as described. Timeout callbacks are called while blocking for input. If some input for an input source is available, -<function>XtAppPeekEvent</function> +<xref linkend='XtAppPeekEvent' xrefstyle='select: title'/> will return <function>True</function> without returning an event. @@ -2237,7 +2237,7 @@ without returning an event. To remove and return the event from the head of a given application's X event queue, use -<function>XtAppNextEvent</function>. +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppNextEvent'> @@ -2272,7 +2272,7 @@ Returns the event information to the specified event structure. </variablelist> <para> If the X event queue is empty, -<function>XtAppNextEvent</function> +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/> flushes the X output buffers of each Display in the application context and waits for an X event while looking at the other input sources and timeout values and calling any callback procedures triggered by them. @@ -2287,7 +2287,7 @@ see Section 7.8. The Intrinsics provide functions that dispatch events to widgets or other application code. Every client interested in X events on a widget uses -<function>XtAddEventHandler</function> +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/> to register which events it is interested in and a procedure (event handler) to be called when the event happens in that window. @@ -2298,7 +2298,7 @@ that use translation tables; see Chapter 10. <para> Applications that need direct control of the processing of different types of input should use -<function>XtAppProcessEvent</function>. +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppProcessEvent'> @@ -2345,28 +2345,28 @@ to be the bitwise inclusive OR of these four event types. </variablelist> <para> The -<function>XtAppProcessEvent</function> +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/> function processes one timer, input source, signal source, or X event. If there is no event or input of the appropriate type to process, then -<function>XtAppProcessEvent</function> +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/> blocks until there is. If there is more than one type of input available to process, it is undefined which will get processed. Usually, this procedure is not called by client applications; see -<function>XtAppMainLoop</function>. -<function>XtAppProcessEvent</function> +<xref linkend='XtAppMainLoop' xrefstyle='select: title'/>. +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/> processes timer events by calling any appropriate timer callbacks, input sources by calling any appropriate input callbacks, signal source by calling any appropriate signal callbacks, and X events by calling -<function>XtDispatchEvent</function>. +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/>. </para> <para> When an X event is received, it is passed to -<function>XtDispatchEvent</function>, +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/>, which calls the appropriate event handlers and passes them the widget, the event, and client-specific data registered with each procedure. @@ -2376,10 +2376,10 @@ the event is ignored and the dispatcher simply returns. <para> To dispatch an event returned by -<function>XtAppNextEvent</function>, +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/>, retrieved directly from the Xlib queue, or synthetically constructed, to any registered event filters or event handlers, call -<function>XtDispatchEvent</function>. +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtDispatchEvent'> @@ -2404,7 +2404,7 @@ to the appropriate event handlers. </variablelist> <para> The -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> function first calls <function>XFilterEvent</function> with the <emphasis remap='I'>event</emphasis> and the window of the widget to which the @@ -2416,14 +2416,14 @@ returns <function>True</function> and the event activated a server grab as identified by a previous call to -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> or -<function>XtGrabButton</function>, -<function>XtDispatchEvent</function> +<xref linkend='XtGrabButton' xrefstyle='select: title'/>, +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> calls -<function>XtUngrabKeyboard</function> +<xref linkend='XtUngrabKeyboard' xrefstyle='select: title'/> or -<function>XtUngrabPointer</function> +<xref linkend='XtUngrabPointer' xrefstyle='select: title'/> with the timestamp from the event and immediately returns <function>True</function>. If @@ -2431,14 +2431,14 @@ If returns <function>True</function> and a grab was not activated, -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> just immediately returns <function>True</function>. Otherwise, -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> sends the event to the event handler functions that have been previously registered with the dispatch routine. -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> returns <function>True</function> if @@ -2448,7 +2448,7 @@ returned or if the event was dispatched to some handler, and <function>False</function> if it found no handler to which to dispatch the event. -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> records the last timestamp in any event that contains a timestamp (see <function>XtLastTimestampProcessed ),</function> @@ -2456,10 +2456,10 @@ regardless of whether it was filtered or dispatched. If a modal cascade is active with <emphasis remap='I'>spring_loaded</emphasis> <function>True</function>, and if the event is a remap event as defined by -<function>XtAddGrab</function>, -<function>XtDispatchEvent</function> +<xref linkend='XtAddGrab' xrefstyle='select: title'/>, +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> may dispatch the event a second time. If it does so, -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> will call <function>XFilterEvent</function> again with the window of the spring-loaded widget prior to the second @@ -2476,7 +2476,7 @@ the second dispatch will not be performed. <para> To process all input from a given application in a continuous loop, use the convenience procedure -<function>XtAppMainLoop</function>. +<xref linkend='XtAppMainLoop' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppMainLoop'> @@ -2500,34 +2500,34 @@ Specifies the application context that identifies the application. </variablelist> <para> The -<function>XtAppMainLoop</function> +<xref linkend='XtAppMainLoop' xrefstyle='select: title'/> function first reads the next incoming X event by calling -<function>XtAppNextEvent</function> +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/> and then dispatches the event to the appropriate registered procedure by calling -<function>XtDispatchEvent</function>. +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/>. This constitutes the main loop of X Toolkit applications. There is nothing special about -<function>XtAppMainLoop</function>; +<xref linkend='XtAppMainLoop' xrefstyle='select: title'/>; it simply calls -<function>XtAppNextEvent</function> +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/> and then -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> in a conditional loop. At the bottom of the loop, it checks to see if the specified application context's destroy flag is set. If the flag is set, the loop breaks. The whole loop is enclosed between a matching -<function>XtAppLock</function> +<xref linkend='XtAppLock' xrefstyle='select: title'/> and -<function>XtAppUnlock</function>. +<xref linkend='XtAppUnlock' xrefstyle='select: title'/>. </para> <para> Applications can provide their own version of this loop, which tests some global termination flag or tests that the number of top-level widgets is larger than zero before circling back to the call to -<function>XtAppNextEvent</function>. +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/>. </para> </sect1> @@ -2573,7 +2573,7 @@ Pop-up shells will have <function>False</function> if the parent was insensitive when the shell was created. Since -<function>XtSetSensitive</function> +<xref linkend='XtSetSensitive' xrefstyle='select: title'/> on the parent will not modify the resource of the pop-up child, clients are advised to include a resource specification of the form @@ -2586,7 +2586,7 @@ sensitive when creating pop-up shells. <para> To set the sensitivity state of a widget, use -<function>XtSetSensitive</function>. +<xref linkend='XtSetSensitive' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetSensitive'> @@ -2622,19 +2622,19 @@ keyboard, pointer, and focus events. </variablelist> <para> The -<function>XtSetSensitive</function> +<xref linkend='XtSetSensitive' xrefstyle='select: title'/> function first calls -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> on the current widget with an argument list specifying the XtNsensitive resource and the new value. If <emphasis remap='I'>sensitive</emphasis> is <function>False</function> and the widget's class is a subclass of Composite, -<function>XtSetSensitive</function> +<xref linkend='XtSetSensitive' xrefstyle='select: title'/> recursively propagates the new value down the child tree by calling -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> on each child to set <emphasis remap='I'>ancestor_sensitive</emphasis> to <function>False</function>. If <emphasis remap='I'>sensitive</emphasis> is @@ -2643,20 +2643,20 @@ and the widget's class is a subclass of Composite and the widget's <emphasis remap='I'>ancestor_sensitive</emphasis> field is <function>True</function>, -<function>XtSetSensitive</function> +<xref linkend='XtSetSensitive' xrefstyle='select: title'/> sets the <emphasis remap='I'>ancestor_sensitive</emphasis> of each child to <function>True</function> and then recursively calls -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> on each normal descendant that is now sensitive to set <emphasis remap='I'>ancestor_sensitive</emphasis> to <function>True</function>. </para> <para> -<function>XtSetSensitive</function> +<xref linkend='XtSetSensitive' xrefstyle='select: title'/> calls -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> to change the <emphasis remap='I'>sensitive</emphasis> and <emphasis remap='I'>ancestor_sensitive</emphasis> fields of each affected widget. Therefore, when one of these changes, @@ -2666,7 +2666,7 @@ take whatever display actions are needed </para> <para> -<function>XtSetSensitive</function> +<xref linkend='XtSetSensitive' xrefstyle='select: title'/> maintains the invariant that, if the parent has either <emphasis remap='I'>sensitive</emphasis> or <emphasis remap='I'>ancestor_sensitive</emphasis> <function>False</function>, @@ -2677,7 +2677,7 @@ then all children have <emphasis remap='I'>ancestor_sensitive</emphasis> <para> To check the current sensitivity state of a widget, use -<function>XtIsSensitive</function>. +<xref linkend='XtIsSensitive' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtIsSensitive'> @@ -2701,7 +2701,7 @@ Specifies the object. Must be of class Object or any subclass thereof. </variablelist> <para> The -<function>XtIsSensitive</function> +<xref linkend='XtIsSensitive' xrefstyle='select: title'/> function returns <function>True</function> or @@ -2710,7 +2710,7 @@ to indicate whether user input events are being dispatched. If object's class is a subclass of RectObj and both <emphasis remap='I'>sensitive</emphasis> and <emphasis remap='I'>ancestor_sensitive</emphasis> are <function>True</function>, -<function>XtIsSensitive</function> +<xref linkend='XtIsSensitive' xrefstyle='select: title'/> returns <function>True</function>; otherwise, it returns @@ -2725,11 +2725,11 @@ The Intrinsics have some limited support for background processing. Because most applications spend most of their time waiting for input, you can register an idle-time work procedure that is called when the toolkit would otherwise block in -<function>XtAppNextEvent</function> +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/> or -<function>XtAppProcessEvent</function>. +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/>. Work procedure pointers are of type -<function>XtWorkProc</function>. +<xref linkend='XtWorkProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtWorkProc'> @@ -2768,7 +2768,7 @@ interactive feel is likely to suffer. <para> To register a work procedure for a given application, use -<function>XtAppAddWorkProc</function>. +<xref linkend='XtAppAddWorkProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppAddWorkProc'> @@ -2815,7 +2815,7 @@ when it is called. </variablelist> <para> The -<function>XtAppAddWorkProc</function> +<xref linkend='XtAppAddWorkProc' xrefstyle='select: title'/> function adds the specified work procedure for the application identified by <emphasis remap='I'>app_context</emphasis> and returns an opaque unique identifier for this work procedure. @@ -2829,7 +2829,7 @@ the newly added one has lower priority than the current one. To remove a work procedure, either return <function>True</function> from the procedure when it is called or use -<function>XtRemoveWorkProc</function> +<xref linkend='XtRemoveWorkProc' xrefstyle='select: title'/> outside of the procedure. </para> @@ -2854,7 +2854,7 @@ Specifies which work procedure to remove. </variablelist> <para> The -<function>XtRemoveWorkProc</function> +<xref linkend='XtRemoveWorkProc' xrefstyle='select: title'/> function explicitly removes the specified background work procedure. </para> </sect1> @@ -3102,7 +3102,7 @@ of it if a portion is obscured and then reexposed. <title>Redisplay of a Widget: The expose Procedure</title> <para> The expose procedure pointer in a widget class is of type -<function>XtExposeProc</function>. +<xref linkend='XtExposeProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtExposeProc'> @@ -3158,7 +3158,7 @@ and have no expose procedure. <note> <para> If the <emphasis remap='I'>expose</emphasis> procedure is NULL, -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> fills in a default bit gravity of <function>NorthWestGravity</function> before it calls the widget's realize procedure. @@ -3286,7 +3286,7 @@ occur in a widget. Most widgets need not use event handlers explicitly. Instead, they use the Intrinsics translation manager. Event handler procedure pointers are of the type -<function>XtEventHandler</function>. +<xref linkend='XtEventHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtEventHandler'> @@ -3367,7 +3367,7 @@ into the <emphasis remap='I'>continue_to_dispatch</emphasis> argument can lead t <title>Event Handlers That Select Events</title> <para> To register an event handler procedure with the dispatch mechanism, use -<function>XtAddEventHandler</function>. +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAddEventHandler'> @@ -3444,7 +3444,7 @@ Specifies additional data to be passed to the event handler. </variablelist> <para> The -<function>XtAddEventHandler</function> +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/> function registers a procedure with the dispatch mechanism that is to be called when an event that matches the mask occurs on the specified widget. @@ -3455,7 +3455,7 @@ If the procedure is already registered with the same <emphasis remap='I'>client_ value, the specified mask augments the existing mask. If the widget is realized, -<function>XtAddEventHandler</function> +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/> calls <function>XSelectInput</function>, if necessary. @@ -3465,7 +3465,7 @@ registered for the same event is not defined. <para> To remove a previously registered event handler, use -<function>XtRemoveEventHandler</function>. +<xref linkend='XtRemoveEventHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveEventHandler'> @@ -3542,46 +3542,46 @@ Specifies the registered client data. </variablelist> <para> The -<function>XtRemoveEventHandler</function> +<xref linkend='XtRemoveEventHandler' xrefstyle='select: title'/> function unregisters an event handler registered with -<function>XtAddEventHandler</function> +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/> or -<function>XtInsertEventHandler</function> +<xref linkend='XtInsertEventHandler' xrefstyle='select: title'/> for the specified events. The request is ignored if <emphasis remap='I'>client_data</emphasis> does not match the value given when the handler was registered. If the widget is realized and no other event handler requires the event, -<function>XtRemoveEventHandler</function> +<xref linkend='XtRemoveEventHandler' xrefstyle='select: title'/> calls <function>XSelectInput</function>. If the specified procedure has not been registered or if it has been registered with a different value of <emphasis remap='I'>client_data</emphasis>, -<function>XtRemoveEventHandler</function> +<xref linkend='XtRemoveEventHandler' xrefstyle='select: title'/> returns without reporting an error. </para> <para> To stop a procedure registered with -<function>XtAddEventHandler</function> +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/> or -<function>XtInsertEventHandler</function> +<xref linkend='XtInsertEventHandler' xrefstyle='select: title'/> from receiving all selected events, call -<function>XtRemoveEventHandler</function> +<xref linkend='XtRemoveEventHandler' xrefstyle='select: title'/> with an <emphasis remap='I'>event_mask</emphasis> of <function>XtAllEvents</function> and <emphasis remap='I'>nonmaskable</emphasis> <function>True</function>. The procedure will continue to receive any events that have been specified in calls to -<function>XtAddRawEventHandler</function> +<xref linkend='XtAddRawEventHandler' xrefstyle='select: title'/> or -<function>XtInsertRawEventHandler</function>. +<xref linkend='XtInsertRawEventHandler' xrefstyle='select: title'/>. </para> <para> To register an event handler procedure that receives events before or after all previously registered event handlers, use -<function>XtInsertEventHandler</function>. +<xref linkend='XtInsertEventHandler' xrefstyle='select: title'/>. </para> <literallayout class="monospaced"> typedef enum {XtListHead, XtListTail} XtListPosition; @@ -3672,9 +3672,9 @@ relative to other previously registered handlers. </varlistentry> </variablelist> <para> -<function>XtInsertEventHandler</function> +<xref linkend='XtInsertEventHandler' xrefstyle='select: title'/> is identical to -<function>XtAddEventHandler</function> +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/> with the additional <emphasis remap='I'>position</emphasis> argument. If <emphasis remap='I'>position</emphasis> is <function>XtListHead</function>, the event @@ -3698,7 +3698,7 @@ clients need to register an event handler procedure with the dispatch mechanism without explicitly causing the X server to select for that event. To do this, use -<function>XtAddRawEventHandler</function>. +<xref linkend='XtAddRawEventHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAddRawEventHandler'> @@ -3775,9 +3775,9 @@ Specifies additional data to be passed to the client's event handler. </variablelist> <para> The -<function>XtAddRawEventHandler</function> +<xref linkend='XtAddRawEventHandler' xrefstyle='select: title'/> function is similar to -<function>XtAddEventHandler</function> +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/> except that it does not affect the widget's event mask and never causes an <function>XSelectInput</function> for its events. @@ -3791,7 +3791,7 @@ registered for the same event is not defined. <para> To remove a previously registered raw event handler, use -<function>XtRemoveRawEventHandler</function>. +<xref linkend='XtRemoveRawEventHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveRawEventHandler'> @@ -3868,45 +3868,45 @@ Specifies the registered client data. </variablelist> <para> The -<function>XtRemoveRawEventHandler</function> +<xref linkend='XtRemoveRawEventHandler' xrefstyle='select: title'/> function unregisters an event handler registered with -<function>XtAddRawEventHandler</function> +<xref linkend='XtAddRawEventHandler' xrefstyle='select: title'/> or -<function>XtInsertRawEventHandler</function> +<xref linkend='XtInsertRawEventHandler' xrefstyle='select: title'/> for the specified events without changing the window event mask. The request is ignored if <emphasis remap='I'>client_data</emphasis> does not match the value given when the handler was registered. If the specified procedure has not been registered or if it has been registered with a different value of <emphasis remap='I'>client_data</emphasis>, -<function>XtRemoveRawEventHandler</function> +<xref linkend='XtRemoveRawEventHandler' xrefstyle='select: title'/> returns without reporting an error. </para> <para> To stop a procedure registered with -<function>XtAddRawEventHandler</function> +<xref linkend='XtAddRawEventHandler' xrefstyle='select: title'/> or -<function>XtInsertRawEventHandler</function> +<xref linkend='XtInsertRawEventHandler' xrefstyle='select: title'/> from receiving all nonselected events, call -<function>XtRemoveRawEventHandler</function> +<xref linkend='XtRemoveRawEventHandler' xrefstyle='select: title'/> with an <emphasis remap='I'>event_mask</emphasis> of <function>XtAllEvents</function> and <emphasis remap='I'>nonmaskable</emphasis> <function>True</function>. The procedure will continue to receive any events that have been specified in calls to -<function>XtAddEventHandler</function> +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/> or -<function>XtInsertEventHandler</function>. +<xref linkend='XtInsertEventHandler' xrefstyle='select: title'/>. </para> <para> To register an event handler procedure that receives events before or after all previously registered event handlers without selecting for the events, use -<function>XtInsertRawEventHandler</function>. +<xref linkend='XtInsertRawEventHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtInsertRawEventHandler'> @@ -3995,9 +3995,9 @@ relative to other previously registered handlers. </variablelist> <para> The -<function>XtInsertRawEventHandler</function> +<xref linkend='XtInsertRawEventHandler' xrefstyle='select: title'/> function is similar to -<function>XtInsertEventHandler</function> +<xref linkend='XtInsertEventHandler' xrefstyle='select: title'/> except that it does not modify the widget's event mask and never causes an <function>XSelectInput</function> @@ -4013,7 +4013,7 @@ repositioned in the list. <title>Current Event Mask</title> <para> To retrieve the event mask for a given widget, use -<function>XtBuildEventMask</function>. +<xref linkend='XtBuildEventMask' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtBuildEventMask'> @@ -4037,18 +4037,18 @@ Specifies the widget. Must be of class Core or any subclass thereof. </variablelist> <para> The -<function>XtBuildEventMask</function> +<xref linkend='XtBuildEventMask' xrefstyle='select: title'/> function returns the event mask representing the logical OR of all event masks for event handlers registered on the widget with -<function>XtAddEventHandler</function> +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/> and -<function>XtInsertEventHandler</function> +<xref linkend='XtInsertEventHandler' xrefstyle='select: title'/> and all event translations, including accelerators, installed on the widget. This is the same event mask stored into the <function>XSetWindowAttributes</function> structure by -<function>XtRealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/> and sent to the server when event handlers and translations are installed or removed on the realized widget. </para> @@ -4059,7 +4059,7 @@ removed on the realized widget. <para> To register an event handler procedure with the Intrinsics dispatch mechanism according to an event type, use -<function>XtInsertEventTypeHandler</function>. +<xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtInsertEventTypeHandler'> @@ -4139,7 +4139,7 @@ previously registered handlers. </varlistentry> </variablelist> <para> -<function>XtInsertEventTypeHandler</function> +<xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/> registers a procedure with the dispatch mechanism that is to be called when an event that matches the specified <emphasis remap='I'>event_type</emphasis> is dispatched to the specified <emphasis remap='I'>widget</emphasis>. @@ -4152,15 +4152,15 @@ If <emphasis remap='I'>event_type</emphasis> specifies one of the core X protoco indicating the event mask to be used to select for the desired event. This event mask is included in the value returned by -<function>XtBuildEventMask</function>. +<xref linkend='XtBuildEventMask' xrefstyle='select: title'/>. If the widget is realized, -<function>XtInsertEventTypeHandler</function> +<xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/> calls <function>XSelectInput</function> if necessary. Specifying NULL for <emphasis remap='I'>select_data</emphasis> is equivalent to specifying a pointer to an event mask containing 0. This is similar to the -<function>XtInsertRawEventHandler</function> +<xref linkend='XtInsertRawEventHandler' xrefstyle='select: title'/> function. </para> @@ -4190,7 +4190,7 @@ registered handlers for this event type. Each widget has a single registered event handler list, which will contain any procedure/client_data pair exactly once if it is registered with -<function>XtInsertEventTypeHandler</function>, +<xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/>, regardless of the manner in which it is registered and regardless of the value(s) of <emphasis remap='I'>select_data</emphasis>. If the procedure is already registered with the @@ -4200,9 +4200,9 @@ mask and the procedure is repositioned in the list. <para> To remove an event handler registered with -<function>XtInsertEventTypeHandler</function>, +<xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/>, use -<function>XtRemoveEventTypeHandler</function>. +<xref linkend='XtRemoveEventTypeHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveEventTypeHandler'> @@ -4271,10 +4271,10 @@ Specifies the additional client data with which the procedure was registered. </variablelist> <para> The -<function>XtRemoveEventTypeHandler</function> +<xref linkend='XtRemoveEventTypeHandler' xrefstyle='select: title'/> function unregisters an event handler registered with -<function>XtInsertEventTypeHandler</function> +<xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/> for the specified event type. The request is ignored if <emphasis remap='I'>client_data</emphasis> does not match the value given when the handler was registered. @@ -4286,13 +4286,13 @@ If <emphasis remap='I'>event_type</emphasis> specifies one of the core X protoco <function>EventMask, indicating the event</function> mask to be used to deselect for the appropriate event. If the widget is realized, -<function>XtRemoveEventTypeHandler</function> +<xref linkend='XtRemoveEventTypeHandler' xrefstyle='select: title'/> calls <function>XSelectInput</function> if necessary. Specifying NULL for <emphasis remap='I'>select_data</emphasis> is equivalent to specifying a pointer to an event mask containing 0. This is similar to the -<function>XtRemoveRawEventHandler</function> +<xref linkend='XtRemoveRawEventHandler' xrefstyle='select: title'/> function. </para> @@ -4304,7 +4304,7 @@ selector registered for the specified event type. <para> To register a procedure to select extension events for a widget, use -<function>XtRegisterExtensionSelector</function>. +<xref linkend='XtRegisterExtensionSelector' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRegisterExtensionSelector'> @@ -4370,7 +4370,7 @@ Specifies additional data to be passed to the extension selector. </variablelist> <para> The -<function>XtRegisterExtensionSelector</function> +<xref linkend='XtRegisterExtensionSelector' xrefstyle='select: title'/> function registers a procedure to arrange for the delivery of extension events to widgets. </para> @@ -4378,7 +4378,7 @@ for the delivery of extension events to widgets. <para> If <emphasis remap='I'>min_event_type</emphasis> and <emphasis remap='I'>max_event_type</emphasis> match the parameters to a previous call to -<function>XtRegisterExtensionSelector</function> +<xref linkend='XtRegisterExtensionSelector' xrefstyle='select: title'/> for the same <emphasis remap='I'>display</emphasis>, then <emphasis remap='I'>proc</emphasis> and <emphasis remap='I'>client_data</emphasis> replace the previously registered values. If the range specified by <emphasis remap='I'>min_event_type</emphasis> @@ -4403,7 +4403,7 @@ required by the widget. <para> An extension selector is of type -<function>XtExtensionSelectProc</function>. +<xref linkend='XtExtensionSelectProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtExtensionSelectProc'> @@ -4448,7 +4448,7 @@ registered event handlers for. <listitem> <para> Specifies a list of the select_data parameters specified in -<function>XtInsertEventTypeHandler</function>. +<xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> @@ -4478,14 +4478,14 @@ Specifies the additional client data with which the procedure was registered. The <emphasis remap='I'>event_types</emphasis> and <emphasis remap='I'>select_data</emphasis> lists will always have the same number of elements, specified by <emphasis remap='I'>count</emphasis>. Each event type/select data pair represents one call to -<function>XtInsertEventTypeHandler</function>. +<xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/>. </para> <para> To register a procedure to dispatch events of a specific type within -<function>XtDispatchEvent</function>, +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/>, use -<function>XtSetEventDispatcher</function>. +<xref linkend='XtSetEventDispatcher' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetEventDispatcher'> @@ -4531,7 +4531,7 @@ Specifies the event dispatcher procedure. </variablelist> <para> The -<function>XtSetEventDispatcher</function> +<xref linkend='XtSetEventDispatcher' xrefstyle='select: title'/> function registers the event dispatcher procedure specified by <emphasis remap='I'>proc</emphasis> for events with the type <emphasis remap='I'>event_type</emphasis>. The previously registered dispatcher (or the default dispatcher if there was no previously registered @@ -4541,7 +4541,7 @@ restored for the specified type. <para> In the future, when -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> is called with an event type of <emphasis remap='I'>event_type</emphasis>, the specified <emphasis remap='I'>proc</emphasis> (or the default dispatcher) is invoked to determine a widget to which to dispatch the event. @@ -4555,7 +4555,7 @@ and <emphasis remap='I'>compress_motion</emphasis>, and discards all extension e <para> An event dispatcher procedure pointer is of type -<function>XtEventDispatchProc</function>. +<xref linkend='XtEventDispatchProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtEventDispatchProc'> @@ -4594,13 +4594,13 @@ if the event is to be discarded, and if returns <function>False</function>, dispatch the event to the widget using -<function>XtDispatchEventToWidget</function>. +<xref linkend='XtDispatchEventToWidget' xrefstyle='select: title'/>. The procedure should return <function>True</function> if either <function>XFilterEvent</function> or -<function>XtDispatchEventToWidget</function> +<xref linkend='XtDispatchEventToWidget' xrefstyle='select: title'/> returned <function>True</function> and @@ -4622,7 +4622,7 @@ otherwise. Some dispatchers for extension events may wish to forward events according to the Intrinsics' keyboard focus mechanism. To determine which widget is the end result of keyboard event forwarding, use -<function>XtGetKeyboardFocusWidget</function>. +<xref linkend='XtGetKeyboardFocusWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetKeyboardFocusWidget'> @@ -4646,14 +4646,14 @@ Specifies the widget to get forwarding information for. </variablelist> <para> The -<function>XtGetKeyboardFocusWidget</function> +<xref linkend='XtGetKeyboardFocusWidget' xrefstyle='select: title'/> function returns the widget that would be the end result of keyboard event forwarding for a keyboard event for the specified widget. </para> <para> To dispatch an event to a specified widget, use -<function>XtDispatchEventToWidget</function>. +<xref linkend='XtDispatchEventToWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtDispatchEventToWidget'> @@ -4688,7 +4688,7 @@ Specifies a pointer to the event to be dispatched. </variablelist> <para> The -<function>XtDispatchEventToWidget</function> +<xref linkend='XtDispatchEventToWidget' xrefstyle='select: title'/> function scans the list of registered event handlers for the specified widget and calls each handler that has been registered for the specified event type, subject to the <emphasis remap='I'>continue_to_dispatch</emphasis> @@ -4709,7 +4709,7 @@ These internal event handlers never set <emphasis remap='I'>continue_to_dispatch </para> <para> -<function>XtDispatchEventToWidget</function> +<xref linkend='XtDispatchEventToWidget' xrefstyle='select: title'/> returns <function>True</function> if any event handler was called and @@ -4726,14 +4726,14 @@ The Intrinsics may be used in environments that offer multiple threads of execution within the context of a single process. A multi-threaded application using the Intrinsics must explicitly initialize the toolkit for mutually exclusive access by calling -<function>XtToolkitThreadInitialize</function>. +<xref linkend='XtToolkitThreadInitialize' xrefstyle='select: title'/>. </para> <sect2 id="Initializing_a_Multi_Threaded_xI_Application"> <title>Initializing a Multi-Threaded Intrinsics Application</title> <para> To test and initialize Intrinsics support for mutually exclusive thread access, call -<function>XtToolkitThreadInitialize</function>. +<xref linkend='XtToolkitThreadInitialize' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtToolkitThreadInitialize'> @@ -4744,16 +4744,16 @@ access, call </funcsynopsis> <para> -<function>XtToolkitThreadInitialize</function> +<xref linkend='XtToolkitThreadInitialize' xrefstyle='select: title'/> returns <function>True</function> if the Intrinsics support mutually exclusive thread -access, otherwise it returns <function>False</function>. <function>XtToolkitThreadInitialize</function> +access, otherwise it returns <function>False</function>. <xref linkend='XtToolkitThreadInitialize' xrefstyle='select: title'/> must be called before -<function>XtCreateApplicationContext</function>, -<function>XtAppInitialize</function>, -<function>XtOpenApplication</function>, +<xref linkend='XtCreateApplicationContext' xrefstyle='select: title'/>, +<xref linkend='XtAppInitialize' xrefstyle='select: title'/>, +<xref linkend='XtOpenApplication' xrefstyle='select: title'/>, or <function>XtSetLanguageProc</function> -is called. <function>XtToolkitThreadInitialize</function> may be called more than once; +is called. <xref linkend='XtToolkitThreadInitialize' xrefstyle='select: title'/> may be called more than once; however, the application writer must ensure that it is not called simultaneously by two or more threads. </para> @@ -4792,7 +4792,7 @@ before the application can safely call them directly, for example: </literallayout> <para> When the application relies upon -<function>XtConvertAndStore</function> +<xref linkend='XtConvertAndStore' xrefstyle='select: title'/> or a converter to provide the storage for the results of a conversion, the application should acquire the process lock before calling out and hold the lock until the results have been copied. @@ -4856,7 +4856,7 @@ Specifies the application context to lock. </varlistentry> </variablelist> <para> -<function>XtAppLock</function> blocks until it is able to acquire the lock. Locking the +<xref linkend='XtAppLock' xrefstyle='select: title'/> blocks until it is able to acquire the lock. Locking the application context also ensures that only the thread holding the lock makes Xlib calls from within Xt. An application that makes its own direct Xlib calls must either lock the application context around every @@ -4905,14 +4905,14 @@ widget writer must use </funcsynopsis> <para> -<function>XtProcessLock</function> blocks until it is able to acquire the lock. +<xref linkend='XtProcessLock' xrefstyle='select: title'/> blocks until it is able to acquire the lock. Widget writers may use XtProcessLock to guarantee mutually exclusive access to widget static data. </para> <para> To unlock a locked process, use -<function>XtProcessUnlock</function>. +<xref linkend='XtProcessUnlock' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtProcessUnlock'> @@ -4925,13 +4925,13 @@ To unlock a locked process, use <para> To lock both an application context and the process at the same time, call -<function>XtAppLock</function> +<xref linkend='XtAppLock' xrefstyle='select: title'/> first and then -<function>XtProcessLock</function>. +<xref linkend='XtProcessLock' xrefstyle='select: title'/>. To release both locks, call -<function>XtProcessUnlock</function> +<xref linkend='XtProcessUnlock' xrefstyle='select: title'/> first and then -<function>XtAppUnlock</function>. +<xref linkend='XtAppUnlock' xrefstyle='select: title'/>. The order is important to avoid deadlock. </para> </sect3> @@ -4950,7 +4950,7 @@ event-processing loop without necessarily terminating its thread. <para> To indicate that the event loop should terminate after the current event dispatch has completed, use -<function>XtAppSetExitFlag</function>. +<xref linkend='XtAppSetExitFlag' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppSetExitFlag'> @@ -4973,14 +4973,14 @@ Specifies the application context. </varlistentry> </variablelist> <para> -<function>XtAppMainLoop</function> +<xref linkend='XtAppMainLoop' xrefstyle='select: title'/> tests the value of the flag and will return if the flag is <function>True</function>. </para> <para> Application writers who implement their own main loop may test the value of the exit flag with -<function>XtAppGetExitFlag</function>. +<xref linkend='XtAppGetExitFlag' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppGetExitFlag'> @@ -5003,20 +5003,20 @@ Specifies the application context. </varlistentry> </variablelist> <para> -<function>XtAppGetExitFlag</function> +<xref linkend='XtAppGetExitFlag' xrefstyle='select: title'/> will normally return <function>False</function>, indicating that event processing may continue. When -<function>XtAppGetExitFlag</function> +<xref linkend='XtAppGetExitFlag' xrefstyle='select: title'/> returns <function>True</function>, the loop must terminate and return to the caller, which might then destroy the application context. </para> <para> Application writers should be aware that, if a thread is blocked in -<function>XtAppNextEvent</function>, -<function>XtAppPeekEvent</function>, +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/>, +<xref linkend='XtAppPeekEvent' xrefstyle='select: title'/>, or -<function>XtAppProcessEvent</function> +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/> and another thread in the same application context opens a new display, adds an alternate input, or a timeout, any new source(s) will not normally be "noticed" by the blocked thread. Any new sources are @@ -5026,10 +5026,10 @@ normally be "noticed" by the blocked thread. Any new sources are <para> The Intrinsics manage access to events on a last-in, first-out basis. If multiple threads in the same application context block in -<function>XtAppNextEvent</function>, -<function>XtAppPeekEvent</function>, +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/>, +<xref linkend='XtAppPeekEvent' xrefstyle='select: title'/>, or -<function>XtAppProcessEvent</function>, +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/>, the last thread to call one of these functions is the first thread to return. </para> diff --git a/specs/CH08.xml b/specs/CH08.xml index fa1f066..01b1fed 100755 --- a/specs/CH08.xml +++ b/specs/CH08.xml @@ -25,7 +25,7 @@ procedures, action routines, and event handlers. <title>Using Callback Procedure and Callback List Definitions</title> <para> Callback procedure pointers for use in callback lists are of type -<function>XtCallbackProc</function>. +<xref linkend='XtCallbackProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCallbackProc'> @@ -81,7 +81,7 @@ The <emphasis remap='I'>client_data</emphasis> value may be NULL if all necessary information is in the widget. The <emphasis remap='I'>call_data</emphasis> argument is a convenience to avoid having simple cases where the client could otherwise always call -<function>XtGetValues</function> +<xref linkend='XtGetValues' xrefstyle='select: title'/> or a widget-specific function to retrieve data from the widget. Widgets should generally avoid putting complex state information in <emphasis remap='I'>call_data</emphasis>. @@ -90,10 +90,10 @@ The client can use the more general data retrieval methods, if necessary. <para> Whenever a client wants to pass a callback list as an argument in an -<function>XtCreateWidget</function>, -<function>XtSetValues</function>, +<xref linkend='XtCreateWidget' xrefstyle='select: title'/>, +<xref linkend='XtSetValues' xrefstyle='select: title'/>, or -<function>XtGetValues</function> +<xref linkend='XtGetValues' xrefstyle='select: title'/> call, it should specify the address of a NULL-terminated array of type <function>XtCallbackList</function>. @@ -139,7 +139,7 @@ Instead, they always identify the desired callback list by using the exported resource name. All the callback manipulation functions described in this chapter except -<function>XtCallCallbackList</function> +<xref linkend='XtCallCallbackList' xrefstyle='select: title'/> check to see that the requested callback list is indeed implemented by the widget. </para> @@ -163,7 +163,7 @@ through other Intrinsics procedures. <title>Adding Callback Procedures</title> <para> To add a callback procedure to a widget's callback list, use -<function>XtAddCallback</function>. +<xref linkend='XtAddCallback' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAddCallback'> @@ -226,7 +226,7 @@ A callback will be invoked as many times as it occurs in the callback list. <para> To add a list of callback procedures to a given widget's callback list, use -<function>XtAddCallbacks</function>. +<xref linkend='XtAddCallbacks' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAddCallbacks'> @@ -278,7 +278,7 @@ client data. <title>Removing Callback Procedures</title> <para> To delete a callback procedure from a widget's callback list, use -<function>XtRemoveCallback</function>. +<xref linkend='XtRemoveCallback' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveCallback'> @@ -335,14 +335,14 @@ Specifies the client data to match with the registered callback entry. </variablelist> <para> The -<function>XtRemoveCallback</function> +<xref linkend='XtRemoveCallback' xrefstyle='select: title'/> function removes a callback only if both the procedure and the client data match. </para> <para> To delete a list of callback procedures from a given widget's callback list, use -<function>XtRemoveCallbacks</function>. +<xref linkend='XtRemoveCallbacks' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveCallbacks'> @@ -390,7 +390,7 @@ client data. <para> To delete all callback procedures from a given widget's callback list and free all storage associated with the callback list, use -<function>XtRemoveAllCallbacks</function>. +<xref linkend='XtRemoveAllCallbacks' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveAllCallbacks'> @@ -431,7 +431,7 @@ Specifies the callback list to be cleared. <para> To execute the procedures in a given widget's callback list, specifying the callback list by resource name, use -<function>XtCallCallbacks</function>. +<xref linkend='XtCallCallbacks' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCallCallbacks'> @@ -478,7 +478,7 @@ procedure in the list, or NULL. </variablelist> <para> -<function>XtCallCallbacks</function> +<xref linkend='XtCallCallbacks' xrefstyle='select: title'/> calls each of the callback procedures in the list named by <emphasis remap='I'>callback_name</emphasis> in the specified widget, passing the client data registered with the procedure and <emphasis remap='I'>call-data</emphasis>. @@ -487,7 +487,7 @@ data registered with the procedure and <emphasis remap='I'>call-data</emphasis>. <para> To execute the procedures in a callback list, specifying the callback list by address, use -<function>XtCallCallbackList</function>. +<xref linkend='XtCallCallbackList' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCallCallbackList'> @@ -537,7 +537,7 @@ The <emphasis remap='I'>callbacks</emphasis> parameter must specify the contents object resource declared with representation type <function>XtRCallback</function>. If <emphasis remap='I'>callbacks</emphasis> is NULL, -<function>XtCallCallbackList</function> +<xref linkend='XtCallCallbackList' xrefstyle='select: title'/> returns immediately; otherwise it calls each of the callback procedures in the list, passing the client data and <emphasis remap='I'>call_data</emphasis>. </para> @@ -547,7 +547,7 @@ procedures in the list, passing the client data and <emphasis remap='I'>call_dat <title>Checking the Status of a Callback List</title> <para> To find out the status of a given widget's callback list, use -<function>XtHasCallbacks</function>. +<xref linkend='XtHasCallbacks' xrefstyle='select: title'/>. </para> <para> @@ -586,11 +586,11 @@ Specifies the callback list to be checked. </variablelist> <para> The -<function>XtHasCallbacks</function> +<xref linkend='XtHasCallbacks' xrefstyle='select: title'/> function first checks to see if the widget has a callback list identified by <emphasis remap='I'>callback_name</emphasis>. If the callback list does not exist, -<function>XtHasCallbacks</function> +<xref linkend='XtHasCallbacks' xrefstyle='select: title'/> returns <function>XtCallbackNoList</function>. If the callback list exists but is empty, 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. diff --git a/specs/CH10.xml b/specs/CH10.xml index b472e03..f05d2a6 100755 --- a/specs/CH10.xml +++ b/specs/CH10.xml @@ -52,7 +52,7 @@ an application can register its own action tables with the translation manager so that the translation tables it provides to widget instances can access application functionality directly. The translation action procedure pointer is of type -<function>XtActionProc</function>. +<xref linkend='XtActionProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtActionProc'> @@ -209,7 +209,7 @@ list into an internal representation. <para> To declare an action table within an application and register it with the translation manager, use -<function>XtAppAddActions</function>. +<xref linkend='XtAppAddActions' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppAddActions'> @@ -259,11 +259,11 @@ the most recently registered action is used. If duplicate actions exist in an action table, the first is used. The Intrinsics register an action table containing -<function>XtMenuPopup</function> +<xref linkend='XtMenuPopup' xrefstyle='select: title'/> and -<function>XtMenuPopdown</function> +<xref linkend='XtMenuPopdown' xrefstyle='select: title'/> as part of -<function>XtCreateApplicationContext</function>. +<xref linkend='XtCreateApplicationContext' xrefstyle='select: title'/>. </para> </sect2> @@ -294,9 +294,9 @@ order, then on up the ancestor tree. <listitem> <para> The action tables registered with -<function>XtAppAddActions</function> +<xref linkend='XtAppAddActions' xrefstyle='select: title'/> and -<function>XtAddActions</function> +<xref linkend='XtAddActions' xrefstyle='select: title'/> from the most recently added table to the oldest table. </para> </listitem> @@ -315,7 +315,7 @@ the translation manager generates a warning message. An application can specify a procedure that will be called just before every action routine is dispatched by the translation manager. To do so, the application supplies a procedure pointer of type -<function>XtActionHookProc</function>. +<xref linkend='XtActionHookProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtActionHookProc'> @@ -402,7 +402,7 @@ arguments other than the <emphasis remap='I'>client_data</emphasis> argument. <para> To add an action hook, use -<function>XtAppAddActionHook</function>. +<xref linkend='XtAppAddActionHook' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppAddActionHook'> @@ -447,12 +447,12 @@ Specifies application-specific data to be passed to the action hook. </varlistentry> </variablelist> <para> -<function>XtAppAddActionHook</function> +<xref linkend='XtAppAddActionHook' xrefstyle='select: title'/> adds the specified procedure to the front of a list maintained in the application context. In the future, when an action routine is about to be invoked for any widget in this application context, either through the translation manager or via -<function>XtCallActionProc</function>, +<xref linkend='XtCallActionProc' xrefstyle='select: title'/>, the action hook procedures will be called in reverse order of registration just prior to invoking the action routine. </para> @@ -467,7 +467,7 @@ they were added is destroyed. <para> To remove an action hook procedure without destroying the application context, use -<function>XtRemoveActionHook</function>. +<xref linkend='XtRemoveActionHook' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRemoveActionHook'> @@ -485,13 +485,13 @@ context, use <listitem> <para> Specifies the action hook id returned by -<function>XtAppAddActionHook</function>. +<xref linkend='XtAppAddActionHook' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> </variablelist> <para> -<function>XtRemoveActionHook</function> +<xref linkend='XtRemoveActionHook' xrefstyle='select: title'/> removes the specified action hook procedure from the list in which it was registered. </para> @@ -572,7 +572,7 @@ string translation tables that are specified in the resource database. If a client uses translation tables that are not retrieved via a resource conversion, it must compile them itself using -<function>XtParseTranslationTable</function>. +<xref linkend='XtParseTranslationTable' xrefstyle='select: title'/>. </para> <para> @@ -623,13 +623,13 @@ be specified as an application resource with name ``multiClickTime'' and class ``MultiClickTime'' and may also be modified dynamically by the application. The multi-click time is unique for each Display value and is retrieved from the resource database by -<function>XtDisplayInitialize</function>. +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>. If no value is specified, the initial value is 200 milliseconds. </para> <para> To set the multi-click time dynamically, use -<function>XtSetMultiClickTime</function>. +<xref linkend='XtSetMultiClickTime' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetMultiClickTime'> @@ -663,7 +663,7 @@ Specifies the multi-click time in milliseconds. </varlistentry> </variablelist> <para> -<function>XtSetMultiClickTime</function> +<xref linkend='XtSetMultiClickTime' xrefstyle='select: title'/> sets the time interval used by the translation manager to determine when multiple events are interpreted as a repeated event. When a repeat count is specified in a translation @@ -676,7 +676,7 @@ multi-click time in order for the translation actions to be taken. <para> To read the multi-click time, use -<function>XtGetMultiClickTime</function>. +<xref linkend='XtGetMultiClickTime' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetMultiClickTime'> @@ -699,7 +699,7 @@ Specifies the display connection. </varlistentry> </variablelist> <para> -<function>XtGetMultiClickTime</function> +<xref linkend='XtGetMultiClickTime' xrefstyle='select: title'/> returns the time in milliseconds that the translation manager uses to determine if multiple events are to be interpreted as a repeated event for purposes of matching a translation @@ -770,7 +770,7 @@ Three Intrinsics functions support this merging: <para> To compile a translation table, use -<function>XtParseTranslationTable</function>. +<xref linkend='XtParseTranslationTable' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtParseTranslationTable'> @@ -794,20 +794,20 @@ Specifies the translation table to compile. </variablelist> <para> The -<function>XtParseTranslationTable</function> +<xref linkend='XtParseTranslationTable' xrefstyle='select: title'/> function compiles the translation table, provided in the format given in Appendix B, into an opaque internal representation of type <function>XtTranslations</function>. Note that if an empty translation table is required for any purpose, one can be obtained by calling -<function>XtParseTranslationTable</function> +<xref linkend='XtParseTranslationTable' xrefstyle='select: title'/> and passing an empty string. </para> <para> To merge additional translations into an existing translation table, use -<function>XtAugmentTranslations</function>. +<xref linkend='XtAugmentTranslations' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAugmentTranslations'> @@ -842,7 +842,7 @@ Specifies the compiled translation table to merge in. </variablelist> <para> The -<function>XtAugmentTranslations</function> +<xref linkend='XtAugmentTranslations' xrefstyle='select: title'/> function merges the new translations into the existing widget translations, ignoring any <function>#replace</function>, @@ -852,7 +852,7 @@ or directive that may have been specified in the translation string. The translation table specified by <emphasis remap='I'>translations</emphasis> is not altered by this process. -<function>XtAugmentTranslations</function> +<xref linkend='XtAugmentTranslations' xrefstyle='select: title'/> logically appends the string representation of the new translations to the string representation of the widget's current translations and reparses the result with no warning messages about duplicate left-hand sides, then @@ -864,7 +864,7 @@ the new translation is ignored. <para> To overwrite existing translations with new translations, use -<function>XtOverrideTranslations</function>. +<xref linkend='XtOverrideTranslations' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtOverrideTranslations'> @@ -899,7 +899,7 @@ Specifies the compiled translation table to merge in. </variablelist> <para> The -<function>XtOverrideTranslations</function> +<xref linkend='XtOverrideTranslations' xrefstyle='select: title'/> function merges the new translations into the existing widget translations, ignoring any <function>#replace</function>, @@ -909,7 +909,7 @@ or directive that may have been specified in the translation string. The translation table specified by <emphasis remap='I'>translations</emphasis> is not altered by this process. -<function>XtOverrideTranslations</function> +<xref linkend='XtOverrideTranslations' xrefstyle='select: title'/> logically appends the string representation of the widget's current translations to the string representation of the new translations and reparses the result with no warning messages about duplicate left-hand @@ -921,7 +921,7 @@ the new translation overrides the widget's translation. <para> To replace a widget's translations completely, use -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> on the XtNtranslations resource and specify a compiled translation table as the value. </para> @@ -965,7 +965,7 @@ the class translation table is copied into the widget instance. <para> To completely remove existing translations, use -<function>XtUninstallTranslations</function>. +<xref linkend='XtUninstallTranslations' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtUninstallTranslations'> @@ -989,7 +989,7 @@ Specifies the widget from which the translations are to be removed. Must be of </variablelist> <para> The -<function>XtUninstallTranslations</function> +<xref linkend='XtUninstallTranslations' xrefstyle='select: title'/> function causes the entire translation table for the widget to be removed. </para> </sect1> @@ -1026,7 +1026,7 @@ so that widgets can display their current accelerators. The representation is the accelerator table in canonical translation table form (see Appendix B). The display_accelerator procedure pointer is of type -<function>XtStringProc</function>. +<xref linkend='XtStringProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtStringProc'> @@ -1082,7 +1082,7 @@ directive is ignored for accelerator tables. <para> To parse an accelerator table, use -<function>XtParseAcceleratorTable</function>. +<xref linkend='XtParseAcceleratorTable' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtParseAcceleratorTable'> @@ -1106,7 +1106,7 @@ Specifies the accelerator table to compile. </variablelist> <para> The -<function>XtParseAcceleratorTable</function> +<xref linkend='XtParseAcceleratorTable' xrefstyle='select: title'/> function compiles the accelerator table into an opaque internal representation. The client should set the XtNaccelerators resource of @@ -1116,7 +1116,7 @@ to the returned value. <para> To install accelerators from a widget on another widget, use -<function>XtInstallAccelerators</function>. +<xref linkend='XtInstallAccelerators' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtInstallAccelerators'> @@ -1151,12 +1151,12 @@ Specifies the widget from which the accelerators are to come. Must be of class </variablelist> <para> The -<function>XtInstallAccelerators</function> +<xref linkend='XtInstallAccelerators' xrefstyle='select: title'/> function installs the <emphasis remap='I'>accelerators</emphasis> resource value from <emphasis remap='I'>source</emphasis> onto <emphasis remap='I'>destination</emphasis> by merging the source accelerators into the destination translations. If the source <emphasis remap='I'>display_accelerator</emphasis> field is non-NULL, -<function>XtInstallAccelerators</function> +<xref linkend='XtInstallAccelerators' xrefstyle='select: title'/> calls it with the source widget and a string representation of the accelerator table, which indicates that its accelerators have been installed @@ -1168,7 +1168,7 @@ canonical translation table representation. <para> As a convenience for installing all accelerators from a widget and all its descendants onto one destination, use -<function>XtInstallAllAccelerators</function>. +<xref linkend='XtInstallAllAccelerators' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtInstallAllAccelerators'> @@ -1204,12 +1204,12 @@ from which the accelerators are to come. Must be of class Core or any subclass </variablelist> <para> The -<function>XtInstallAllAccelerators</function> +<xref linkend='XtInstallAllAccelerators' xrefstyle='select: title'/> function recursively descends the widget tree rooted at <emphasis remap='I'>source</emphasis> and installs the accelerators resource value of each widget encountered onto <emphasis remap='I'>destination</emphasis>. A common use is to call -<function>XtInstallAllAccelerators</function> +<xref linkend='XtInstallAllAccelerators' xrefstyle='select: title'/> and pass the application main window as the source. </para> </sect1> @@ -1220,7 +1220,7 @@ and pass the application main window as the source. The translation manager provides support for automatically translating KeyCodes in incoming key events into KeySyms. KeyCode-to-KeySym translator procedure pointers are of type -<function>XtKeyProc</function>. +<xref linkend='XtKeyProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtKeyProc'> @@ -1301,7 +1301,7 @@ The KeyCode-to-KeySym translator procedure must be implemented such that multiple calls with the same <emphasis remap='I'>display</emphasis>, <emphasis remap='I'>keycode</emphasis>, and <emphasis remap='I'>modifiers</emphasis> return the same result until either a new case converter, an -<function>XtCaseProc</function>, +<xref linkend='XtCaseProc' xrefstyle='select: title'/>, is installed or a <function>MappingNotify</function> event is received. @@ -1316,7 +1316,7 @@ share a single copy of this table to perform the same mapping. <para> To return a pointer to the KeySym-to-KeyCode mapping table for a particular display, use -<function>XtGetKeysymTable</function>. +<xref linkend='XtGetKeysymTable' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetKeysymTable'> @@ -1361,7 +1361,7 @@ Returns the number of KeySyms stored for each KeyCode. </varlistentry> </variablelist> <para> -<function>XtGetKeysymTable</function> +<xref linkend='XtGetKeysymTable' xrefstyle='select: title'/> returns a pointer to the Intrinsics' copy of the server's KeyCode-to-KeySym table. This table must not be modified. There are <emphasis remap='I'>keysyms_per_keycode_return</emphasis> KeySyms associated with each @@ -1375,7 +1375,7 @@ for KeyCode <emphasis remap='I'>test_keycode</emphasis>. Any entries that have with them contain the value <function>NoSymbol</function>. Clients should not cache the KeySym table but should call -<function>XtGetKeysymTable</function> +<xref linkend='XtGetKeysymTable' xrefstyle='select: title'/> each time the value is needed, as the table may change prior to dispatching each event. </para> @@ -1386,7 +1386,7 @@ For more information on this table, see Section 12.7 in <emphasis remap='I'>Xlib <para> To register a key translator, use -<function>XtSetKeyTranslator</function>. +<xref linkend='XtSetKeyTranslator' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetKeyTranslator'> @@ -1421,14 +1421,14 @@ Specifies the procedure to perform key translations. </variablelist> <para> The -<function>XtSetKeyTranslator</function> +<xref linkend='XtSetKeyTranslator' xrefstyle='select: title'/> function sets the specified procedure as the current key translator. The default translator is <function>XtTranslateKey</function>, an -<function>XtKeyProc</function> +<xref linkend='XtKeyProc' xrefstyle='select: title'/> that uses the Shift, Lock, numlock, and group modifiers -with the interpretations defined in <emphasis remap='I'>X Window System Protocol</emphasis>, Section 5. +with the interpretations defined in <emphasis remap='I'>(xP</emphasis>, Section 5. It is provided so that new translators can call it to get default KeyCode-to-KeySym translations and so that the default translator can be reinstalled. @@ -1437,7 +1437,7 @@ can be reinstalled. <para> To invoke the currently registered KeyCode-to-KeySym translator, use -<function>XtTranslateKeycode</function>. +<xref linkend='XtTranslateKeycode' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtTranslateKeycode'> @@ -1506,7 +1506,7 @@ Returns the resulting KeySym. </variablelist> <para> The -<function>XtTranslateKeycode</function> +<xref linkend='XtTranslateKeycode' xrefstyle='select: title'/> function passes the specified arguments directly to the currently registered KeyCode-to-KeySym translator. </para> @@ -1515,7 +1515,7 @@ directly to the currently registered KeyCode-to-KeySym translator. To handle capitalization of nonstandard KeySyms, the Intrinsics allow clients to register case conversion routines. Case converter procedure pointers are of type -<function>XtCaseProc</function>. +<xref linkend='XtCaseProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCaseProc'> @@ -1579,7 +1579,7 @@ this procedure should store the KeySym into both return values. <para> To register a case converter, use -<function>XtRegisterCaseConverter</function>. +<xref linkend='XtRegisterCaseConverter' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRegisterCaseConverter'> @@ -1610,7 +1610,7 @@ Specifies the display from which the key events are to come. <listitem> <para> Specifies the -<function>XtCaseProc</function> +<xref linkend='XtCaseProc' xrefstyle='select: title'/> to do the conversions. </para> </listitem> @@ -1638,7 +1638,7 @@ Specifies the last KeySym for which this converter is valid. </variablelist> <para> The -<function>XtRegisterCaseConverter</function> +<xref linkend='XtRegisterCaseConverter' xrefstyle='select: title'/> registers the specified case converter. The <emphasis remap='I'>start</emphasis> and <emphasis remap='I'>stop</emphasis> arguments provide the inclusive range of KeySyms for which this converter is to be called. @@ -1648,12 +1648,12 @@ you need to register an identity converter. When a new converter is registered, the Intrinsics refresh the keyboard state if necessary. The default converter understands case conversion for all -Latin KeySyms defined in <emphasis remap='I'>X Window System Protocol</emphasis>, Appendix A. +Latin KeySyms defined in <emphasis remap='I'>(xP</emphasis>, Appendix A. </para> <para> To determine uppercase and lowercase equivalents for a KeySym, use -<function>XtConvertCase</function>. +<xref linkend='XtConvertCase' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtConvertCase'> @@ -1710,10 +1710,10 @@ Returns the uppercase equivalent of the KeySym. </variablelist> <para> The -<function>XtConvertCase</function> +<xref linkend='XtConvertCase' xrefstyle='select: title'/> function calls the appropriate converter and returns the results. A user-supplied -<function>XtKeyProc</function> +<xref linkend='XtKeyProc' xrefstyle='select: title'/> may need to use this function. </para> </sect1> @@ -1736,7 +1736,7 @@ available to the client. <para> To retrieve the KeySym and modifiers that matched the final event specification in the translation table entry, use -<function>XtGetActionKeysym</function>. +<xref linkend='XtGetActionKeysym' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetActionKeysym'> @@ -1771,7 +1771,7 @@ Returns the modifiers that caused the match, if non-NULL. </variablelist> <para> If -<function>XtGetActionKeysym</function> +<xref linkend='XtGetActionKeysym' xrefstyle='select: title'/> is called after an action procedure has been invoked by the Intrinsics and before that action procedure returns, and if the event pointer has the same value as the event pointer passed to @@ -1780,7 +1780,7 @@ that action routine, and if the event is a or <function>KeyRelease</function> event, then -<function>XtGetActionKeysym</function> +<xref linkend='XtGetActionKeysym' xrefstyle='select: title'/> returns the KeySym that matched the final event specification in the translation table and, if <emphasis remap='I'>modifiers_return</emphasis> is non-NULL, the modifier state actually used to generate this KeySym; @@ -1789,9 +1789,9 @@ otherwise, if the event is a or <function>KeyRelease</function> event, then -<function>XtGetActionKeysym</function> +<xref linkend='XtGetActionKeysym' xrefstyle='select: title'/> calls -<function>XtTranslateKeycode</function> +<xref linkend='XtTranslateKeycode' xrefstyle='select: title'/> and returns the results; else it returns <function>NoSymbol</function> @@ -1801,9 +1801,9 @@ and does not examine <emphasis remap='I'>modifiers_return</emphasis>. <para> Note that if an action procedure invoked by the Intrinsics invokes a subsequent action procedure (and so on) via -<function>XtCallActionProc</function>, +<xref linkend='XtCallActionProc' xrefstyle='select: title'/>, the nested action procedure may also call -<function>XtGetActionKeysym</function> +<xref linkend='XtGetActionKeysym' xrefstyle='select: title'/> to retrieve the Intrinsics' KeySym and modifiers. </para> </sect1> @@ -1813,7 +1813,7 @@ to retrieve the Intrinsics' KeySym and modifiers. <para> To return the list of KeyCodes that map to a particular KeySym in the keyboard mapping table maintained by the Intrinsics, use -<function>XtKeysymToKeycodeList</function>. +<xref linkend='XtKeysymToKeycodeList' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtKeysymToKeycodeList'> @@ -1871,21 +1871,21 @@ Returns the number of KeyCodes in the keycode list. </variablelist> <para> The -<function>XtKeysymToKeycodeList</function> +<xref linkend='XtKeysymToKeycodeList' xrefstyle='select: title'/> procedure returns all the KeyCodes that have <emphasis remap='I'>keysym</emphasis> in their entry for the keyboard mapping table associated with <emphasis remap='I'>display</emphasis>. For each entry in the table, the first four KeySyms (groups 1 and 2) are interpreted as -specified by <emphasis remap='I'>X Window System Protocol</emphasis>, Section 5. If no KeyCodes map to the +specified by <emphasis remap='I'>(xP</emphasis>, Section 5. If no KeyCodes map to the specified KeySym, <emphasis remap='I'>keycount_return</emphasis> is zero and *<emphasis remap='I'>keycodes_return</emphasis> is NULL. </para> <para> The caller should free the storage pointed to by <emphasis remap='I'>keycodes_return</emphasis> using -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> when it is no longer useful. If the caller needs to examine the KeyCode-to-KeySym table for a particular KeyCode, it should call -<function>XtGetKeysymTable</function>. +<xref linkend='XtGetKeysymTable' xrefstyle='select: title'/>. </para> </sect1> @@ -1894,7 +1894,7 @@ the KeyCode-to-KeySym table for a particular KeyCode, it should call <para> To register button and key grabs for a widget's window according to the event bindings in the widget's translation table, use -<function>XtRegisterGrabAction</function>. +<xref linkend='XtRegisterGrabAction' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRegisterGrabAction'> @@ -1951,15 +1951,15 @@ Specifies the action procedure to search for in translation tables. <listitem> <para> Specify arguments to -<function>XtGrabButton</function> +<xref linkend='XtGrabButton' xrefstyle='select: title'/> or -<function>XtGrabKey</function>. +<xref linkend='XtGrabKey' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> </variablelist> <para> -<function>XtRegisterGrabAction</function> +<xref linkend='XtRegisterGrabAction' xrefstyle='select: title'/> adds the specified <emphasis remap='I'>action_proc</emphasis> to a list known to the translation manager. When a widget is realized, or when the translations of a realized widget or the accelerators installed on a @@ -1971,9 +1971,9 @@ or <function>KeyPress</function> events as the only or final event in a sequence, the Intrinsics will call -<function>XtGrabButton</function> +<xref linkend='XtGrabButton' xrefstyle='select: title'/> or -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> for the widget with every button or KeyCode which maps to the event detail field, passing the specified <emphasis remap='I'>owner_events</emphasis>, <emphasis remap='I'>event_mask</emphasis>, <emphasis remap='I'>pointer_mode</emphasis>, and <emphasis remap='I'>keyboard_mode</emphasis>. For @@ -1987,7 +1987,7 @@ For events, if the translation table entry specifies colon (:) in the modifier list, the modifiers are determined by calling the key translator procedure registered for the display and calling -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> for every combination of standard modifiers which map the KeyCode to the specified event detail KeySym, and ORing any modifiers specified in the translation table entry, and <emphasis remap='I'>event_mask</emphasis> is ignored. If the @@ -2013,9 +2013,9 @@ When translations or installed accelerators are modified for a realized widget, any previous key or button grabs registered as a result of the old bindings are released if they do not appear in the new bindings and are not explicitly grabbed by the client with -<function>XtGrabKey</function> +<xref linkend='XtGrabKey' xrefstyle='select: title'/> or -<function>XtGrabButton</function>. +<xref linkend='XtGrabButton' xrefstyle='select: title'/>. </para> </sect1> @@ -2026,7 +2026,7 @@ Normally action procedures are invoked by the Intrinsics when an event or event sequence arrives for a widget. To invoke an action procedure directly, without generating (or synthesizing) events, use -<function>XtCallActionProc</function>. +<xref linkend='XtCallActionProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCallActionProc'> @@ -2093,12 +2093,12 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </varlistentry> </variablelist> <para> -<function>XtCallActionProc</function> +<xref linkend='XtCallActionProc' xrefstyle='select: title'/> searches for the named action routine in the same manner and order as translation tables are bound, as described in Section 10.1.2, except that application action tables are searched, if necessary, as of the time of the call to -<function>XtCallActionProc</function>. +<xref linkend='XtCallActionProc' xrefstyle='select: title'/>. If found, the action routine is invoked with the specified widget, event pointer, and parameters. It is the responsibility of the caller to ensure that @@ -2106,7 +2106,7 @@ the contents of the <emphasis remap='I'>event</emphasis>, <emphasis remap='I'>pa appropriate for the specified action routine and, if necessary, that the specified widget is realized or sensitive. If the named action routine cannot be found, -<function>XtCallActionProc</function> +<xref linkend='XtCallActionProc' xrefstyle='select: title'/> generates a warning message and returns. </para> </sect1> @@ -2119,7 +2119,7 @@ its superclass's action procedures. This would be needed, for example, in order to envelop the superclass's action. To retrieve the list of action procedures registered in the superclass's <emphasis remap='I'>actions</emphasis> field, use -<function>XtGetActionList</function>. +<xref linkend='XtGetActionList' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetActionList'> @@ -2164,7 +2164,7 @@ Returns the number of action procedures declared by the class. </varlistentry> </variablelist> <para> -<function>XtGetActionList</function> +<xref linkend='XtGetActionList' xrefstyle='select: title'/> returns the action table defined by the specified widget class. This table does not include actions defined by the superclasses. If <emphasis remap='I'>widget_class</emphasis> is not initialized, or is not @@ -2174,7 +2174,7 @@ or a subclass thereof, or if the class does not define any actions, will be zero. If *<emphasis remap='I'>actions_return</emphasis> is non-NULL the client is responsible for freeing the table using -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> when it is no longer needed. </para> </sect1> diff --git a/specs/CH11.xml b/specs/CH11.xml index 7dc837c..f445af4 100755 --- a/specs/CH11.xml +++ b/specs/CH11.xml @@ -75,7 +75,7 @@ Locate all the displays of an application context. <title>Determining the Number of Elements in an Array</title> <para> To determine the number of elements in a fixed-size array, use -<function>XtNumber</function>. +<xref linkend='XtNumber' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtNumber'> @@ -99,7 +99,7 @@ Specifies a fixed-size array of arbitrary type. </variablelist> <para> The -<function>XtNumber</function> +<xref linkend='XtNumber' xrefstyle='select: title'/> macro returns the number of elements allocated to the array. </para> </sect1> @@ -108,7 +108,7 @@ macro returns the number of elements allocated to the array. <title>Translating Strings to Widget Instances</title> <para> To translate a widget name to a widget instance, use -<function>XtNameToWidget</function>. +<xref linkend='XtNameToWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtNameToWidget'> @@ -143,12 +143,12 @@ Specifies the partially qualified name of the desired widget. </variablelist> <para> The -<function>XtNameToWidget</function> +<xref linkend='XtNameToWidget' xrefstyle='select: title'/> function searches for a descendant of the <emphasis remap='I'>reference</emphasis> widget whose name matches the specified names. The <emphasis remap='I'>names</emphasis> parameter specifies a simple object name or a series of simple object name components separated by periods or asterisks. -<function>XtNameToWidget</function> +<xref linkend='XtNameToWidget' xrefstyle='select: title'/> returns the descendant with the shortest name matching the specification according to the following rules, where child is either a pop-up child or a normal child if the widget's class is a subclass of @@ -184,7 +184,7 @@ shortest matching name (i.e., the fewest number of components), if any, will always be returned. However, since the order of enumeration of children is undefined and since the Intrinsics do not require that all children of a widget have unique names, -<function>XtNameToWidget</function> +<xref linkend='XtNameToWidget' xrefstyle='select: title'/> may return any child that matches if there are multiple objects in the subtree with the same name. Consecutive separators (periods or asterisks) @@ -210,22 +210,22 @@ with the following added functionality: <itemizedlist> <listitem> <para> -<function>XtMalloc</function>, -<function>XtCalloc</function>, +<xref linkend='XtMalloc' xrefstyle='select: title'/>, +<xref linkend='XtCalloc' xrefstyle='select: title'/>, and -<function>XtRealloc</function> +<xref linkend='XtRealloc' xrefstyle='select: title'/> give an error if there is not enough memory. </para> </listitem> <listitem> <para> -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> simply returns if passed a NULL pointer. </para> </listitem> <listitem> <para> -<function>XtRealloc</function> +<xref linkend='XtRealloc' xrefstyle='select: title'/> simply allocates new storage if passed a NULL pointer. </para> </listitem> @@ -242,7 +242,7 @@ for more information. <para> To allocate storage, use -<function>XtMalloc</function>. +<xref linkend='XtMalloc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtMalloc'> @@ -266,18 +266,18 @@ Specifies the number of bytes desired. </variablelist> <para> The -<function>XtMalloc</function> +<xref linkend='XtMalloc' xrefstyle='select: title'/> function returns a pointer to a block of storage of at least the specified <emphasis remap='I'>size</emphasis> bytes. If there is insufficient memory to allocate the new block, -<function>XtMalloc</function> +<xref linkend='XtMalloc' xrefstyle='select: title'/> calls -<function>XtErrorMsg</function>. +<xref linkend='XtErrorMsg' xrefstyle='select: title'/>. </para> <para> To allocate and initialize an array, use -<function>XtCalloc</function>. +<xref linkend='XtCalloc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCalloc'> @@ -312,20 +312,20 @@ Specifies the size of each array element in bytes. </variablelist> <para> The -<function>XtCalloc</function> +<xref linkend='XtCalloc' xrefstyle='select: title'/> function allocates space for the specified number of array elements of the specified size and initializes the space to zero. If there is insufficient memory to allocate the new block, -<function>XtCalloc</function> +<xref linkend='XtCalloc' xrefstyle='select: title'/> calls -<function>XtErrorMsg</function>. -<function>XtCalloc</function> +<xref linkend='XtErrorMsg' xrefstyle='select: title'/>. +<xref linkend='XtCalloc' xrefstyle='select: title'/> returns the address of the allocated storage. </para> <para> To change the size of an allocated block of storage, use -<function>XtRealloc</function>. +<xref linkend='XtRealloc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtRealloc'> @@ -344,10 +344,10 @@ To change the size of an allocated block of storage, use <listitem> <para> Specifies a pointer to the old storage allocated with -<function>XtMalloc</function>, -<function>XtCalloc</function>, +<xref linkend='XtMalloc' xrefstyle='select: title'/>, +<xref linkend='XtCalloc' xrefstyle='select: title'/>, or -<function>XtRealloc</function>, +<xref linkend='XtRealloc' xrefstyle='select: title'/>, or NULL. </para> </listitem> @@ -365,25 +365,25 @@ Specifies number of bytes desired in new storage. </variablelist> <para> The -<function>XtRealloc</function> +<xref linkend='XtRealloc' xrefstyle='select: title'/> function changes the size of a block of storage, possibly moving it. Then it copies the old contents (or as much as will fit) into the new block and frees the old block. If there is insufficient memory to allocate the new block, -<function>XtRealloc</function> +<xref linkend='XtRealloc' xrefstyle='select: title'/> calls -<function>XtErrorMsg</function>. +<xref linkend='XtErrorMsg' xrefstyle='select: title'/>. If <emphasis remap='I'>ptr</emphasis> is NULL, -<function>XtRealloc</function> +<xref linkend='XtRealloc' xrefstyle='select: title'/> simply calls -<function>XtMalloc</function>. -<function>XtRealloc</function> +<xref linkend='XtMalloc' xrefstyle='select: title'/>. +<xref linkend='XtRealloc' xrefstyle='select: title'/> then returns the address of the new block. </para> <para> To free an allocated block of storage, use -<function>XtFree</function>. +<xref linkend='XtFree' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtFree'> @@ -401,10 +401,10 @@ To free an allocated block of storage, use <listitem> <para> Specifies a pointer to a block of storage allocated with -<function>XtMalloc</function>, -<function>XtCalloc</function>, +<xref linkend='XtMalloc' xrefstyle='select: title'/>, +<xref linkend='XtCalloc' xrefstyle='select: title'/>, or -<function>XtRealloc</function>, +<xref linkend='XtRealloc' xrefstyle='select: title'/>, or NULL. </para> </listitem> @@ -412,16 +412,16 @@ or NULL. </variablelist> <para> The -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> function returns storage, allowing it to be reused. If <emphasis remap='I'>ptr</emphasis> is NULL, -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> returns immediately. </para> <para> To allocate storage for a new instance of a type, use -<function>XtNew</function>. +<xref linkend='XtNew' xrefstyle='select: title'/>. </para> @@ -445,15 +445,15 @@ Specifies a previously declared type. </varlistentry> </variablelist> <para> -<function>XtNew</function> +<xref linkend='XtNew' xrefstyle='select: title'/> returns a pointer to the allocated storage. If there is insufficient memory to allocate the new block, -<function>XtNew</function> +<xref linkend='XtNew' xrefstyle='select: title'/> calls -<function>XtErrorMsg</function>. -<function>XtNew</function> +<xref linkend='XtErrorMsg' xrefstyle='select: title'/>. +<xref linkend='XtNew' xrefstyle='select: title'/> is a convenience macro that calls -<function>XtMalloc</function> +<xref linkend='XtMalloc' xrefstyle='select: title'/> with the following arguments specified: </para> <literallayout class="monospaced"> @@ -461,14 +461,14 @@ with the following arguments specified: </literallayout> <para> The storage allocated by -<function>XtNew</function> +<xref linkend='XtNew' xrefstyle='select: title'/> should be freed using -<function>XtFree</function>. +<xref linkend='XtFree' xrefstyle='select: title'/>. </para> <para> To copy an instance of a string, use -<function>XtNewString</function>. +<xref linkend='XtNewString' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtNewString'> @@ -491,15 +491,15 @@ Specifies a previously declared string. </varlistentry> </variablelist> <para> -<function>XtNewString</function> +<xref linkend='XtNewString' xrefstyle='select: title'/> returns a pointer to the allocated storage. If there is insufficient memory to allocate the new block, -<function>XtNewString</function> +<xref linkend='XtNewString' xrefstyle='select: title'/> calls -<function>XtErrorMsg</function>. -<function>XtNewString</function> +<xref linkend='XtErrorMsg' xrefstyle='select: title'/>. +<xref linkend='XtNewString' xrefstyle='select: title'/> is a convenience macro that calls -<function>XtMalloc</function> +<xref linkend='XtMalloc' xrefstyle='select: title'/> with the following arguments specified: </para> <literallayout class="monospaced"> @@ -507,9 +507,9 @@ with the following arguments specified: </literallayout> <para> The storage allocated by -<function>XtNewString</function> +<xref linkend='XtNewString' xrefstyle='select: title'/> should be freed using -<function>XtFree</function>. +<xref linkend='XtFree' xrefstyle='select: title'/>. </para> </sect1> @@ -526,7 +526,7 @@ fields of the shared GCs. <para> To obtain a shareable GC with modifiable fields, use -<function>XtAllocateGC</function>. +<xref linkend='XtAllocateGC' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAllocateGC'> @@ -606,7 +606,7 @@ Specifies fields of the GC that will not be needed by the caller. </variablelist> <para> The -<function>XtAllocateGC</function> +<xref linkend='XtAllocateGC' xrefstyle='select: title'/> function returns a shareable GC that may be modified by the client. The <emphasis remap='I'>screen</emphasis> field of the specified widget or of the nearest widget ancestor of the specified @@ -638,19 +638,19 @@ is set in <emphasis remap='I'>unused_mask</emphasis> and also in either <emphasi </para> <para> -<function>XtAllocateGC</function> +<xref linkend='XtAllocateGC' xrefstyle='select: title'/> tries to minimize the number of unique GCs created by comparing the arguments with those of previous calls and returning an existing GC when there are no conflicts. -<function>XtAllocateGC</function> +<xref linkend='XtAllocateGC' xrefstyle='select: title'/> may modify and return an existing GC if it was allocated with a nonzero <emphasis remap='I'>unused_mask</emphasis>. </para> <para> To obtain a shareable GC with no modifiable fields, use -<function>XtGetGC</function>. +<xref linkend='XtGetGC' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetGC'> @@ -697,19 +697,19 @@ Specifies the actual values for this GC. </variablelist> <para> The -<function>XtGetGC</function> +<xref linkend='XtGetGC' xrefstyle='select: title'/> function returns a shareable, read-only GC. The parameters to this function are the same as those for <function>XCreateGC</function> except that an Object is passed instead of a Display. -<function>XtGetGC</function> +<xref linkend='XtGetGC' xrefstyle='select: title'/> is equivalent to -<function>XtAllocateGC</function> +<xref linkend='XtAllocateGC' xrefstyle='select: title'/> with <emphasis remap='I'>depth</emphasis>, <emphasis remap='I'>dynamic_mask</emphasis>, and <emphasis remap='I'>unused_mask</emphasis> all zero. </para> <para> -<function>XtGetGC</function> +<xref linkend='XtGetGC' xrefstyle='select: title'/> shares only GCs in which all values in the GC returned by <function>XCreateGC</function> are the same. @@ -721,7 +721,7 @@ filled in from <emphasis remap='I'>values</emphasis> and which it should fill in <para> To deallocate a shared GC when it is no longer needed, use -<function>XtReleaseGC</function>. +<xref linkend='XtReleaseGC' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtReleaseGC'> @@ -750,9 +750,9 @@ Specifies any object on the Display for which the GC was created. Must be of cl <listitem> <para> Specifies the shared GC obtained with either -<function>XtAllocateGC</function> +<xref linkend='XtAllocateGC' xrefstyle='select: title'/> or -<function>XtGetGC</function>. +<xref linkend='XtGetGC' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> @@ -798,7 +798,7 @@ was requested atomically. <title>Setting and Getting the Selection Timeout Value</title> <para> To set the Intrinsics selection timeout, use -<function>XtAppSetSelectionTimeout</function>. +<xref linkend='XtAppSetSelectionTimeout' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppSetSelectionTimeout'> @@ -833,7 +833,7 @@ Specifies the selection timeout in milliseconds. </variablelist> <para> To get the current selection timeout value, use -<function>XtAppGetSelectionTimeout</function>. +<xref linkend='XtAppGetSelectionTimeout' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppGetSelectionTimeout'> @@ -857,14 +857,14 @@ Specifies the application context. </variablelist> <para> The -<function>XtAppGetSelectionTimeout</function> +<xref linkend='XtAppGetSelectionTimeout' xrefstyle='select: title'/> function returns the current selection timeout value in milliseconds. The selection timeout is the time within which the two communicating applications must respond to one another. The initial timeout value is set by the selectionTimeout application resource as retrieved by -<function>XtDisplayInitialize</function>. +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>. If selectionTimeout is not specified, @@ -892,7 +892,7 @@ providing selection data in a single unit. <para> The procedure pointer specified by the owner to supply the selection data to the Intrinsics is of type -<function>XtConvertSelectionProc</function>. +<xref linkend='XtConvertSelectionProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtConvertSelectionProc'> @@ -968,12 +968,12 @@ Specifies a pointer into which a pointer to the converted value of the selection is to be stored. The selection owner is responsible for allocating this storage. If the selection owner has provided an -<function>XtSelectionDoneProc</function> +<xref linkend='XtSelectionDoneProc' xrefstyle='select: title'/> for the selection, this storage is owned by the selection owner; otherwise, it is owned by the Intrinsics selection mechanism, which frees it by calling -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> when it is done with it. </para> </listitem> @@ -1014,7 +1014,7 @@ If the procedure returns <function>False</function>, the values of the return arguments are undefined. Each -<function>XtConvertSelectionProc</function> +<xref linkend='XtConvertSelectionProc' xrefstyle='select: title'/> should respond to target value <function>TARGETS</function> by returning a value containing the list of the targets @@ -1034,18 +1034,18 @@ series of calls to this procedure, one for each target type, and a selection request with the TIMESTAMP target value is answered automatically by the Intrinsics using the time specified in the call to -<function>XtOwnSelection</function> +<xref linkend='XtOwnSelection' xrefstyle='select: title'/> or -<function>XtOwnSelectionIncremental</function>. +<xref linkend='XtOwnSelectionIncremental' xrefstyle='select: title'/>. </para> <para> To retrieve the <function>SelectionRequest</function> event that triggered the -<function>XtConvertSelectionProc</function> +<xref linkend='XtConvertSelectionProc' xrefstyle='select: title'/> procedure, use -<function>XtGetSelectionRequest</function>. +<xref linkend='XtGetSelectionRequest' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetSelectionRequest'> @@ -1091,9 +1091,9 @@ selections, or NULL in the case of atomic transfers. </varlistentry> </variablelist> <para> -<function>XtGetSelectionRequest</function> +<xref linkend='XtGetSelectionRequest' xrefstyle='select: title'/> may be called only from within an -<function>XtConvertSelectionProc</function> +<xref linkend='XtConvertSelectionProc' xrefstyle='select: title'/> procedure and returns a pointer to the <function>SelectionRequest</function> event that caused the conversion procedure to be invoked. @@ -1103,14 +1103,14 @@ transfers, <emphasis remap='I'>request_id</emphasis> must be specified as NULL. <function>SelectionRequest</function> event is being processed for the specified <emphasis remap='I'>widget</emphasis>, <emphasis remap='I'>selection</emphasis>, and <emphasis remap='I'>request_id</emphasis>, -<function>XtGetSelectionRequest</function> +<xref linkend='XtGetSelectionRequest' xrefstyle='select: title'/> returns NULL. </para> <para> The procedure pointer specified by the owner when it desires notification upon losing ownership is of type -<function>XtLoseSelectionProc</function>. +<xref linkend='XtLoseSelectionProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtLoseSelectionProc'> @@ -1154,7 +1154,7 @@ selection ownership; it is merely informative. The procedure pointer specified by the owner when it desires notification of receipt of the data or when it manages the storage containing the data is of type -<function>XtSelectionDoneProc</function>. +<xref linkend='XtSelectionDoneProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSelectionDoneProc'> @@ -1203,12 +1203,12 @@ This procedure is called by the Intrinsics selection mechanism to inform the selection owner that a selection requestor has successfully retrieved a selection value. If the selection owner has registered an -<function>XtSelectionDoneProc</function>, +<xref linkend='XtSelectionDoneProc' xrefstyle='select: title'/>, it should expect it to be called once for each conversion that it performs, after the converted value has been successfully transferred to the requestor. If the selection owner has registered an -<function>XtSelectionDoneProc</function>, +<xref linkend='XtSelectionDoneProc' xrefstyle='select: title'/>, it also owns the storage containing the converted selection value. </para> @@ -1218,7 +1218,7 @@ selection value. <para> The procedure pointer specified by the requestor to receive the selection data from the Intrinsics is of type -<function>XtSelectionCallbackProc</function>. +<xref linkend='XtSelectionCallbackProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSelectionCallbackProc'> @@ -1294,7 +1294,7 @@ interval. Specifies a pointer to the selection value. The requesting client owns this storage and is responsible for freeing it by calling -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> when it is done with it. </para> </listitem> @@ -1338,9 +1338,9 @@ of NULL and a length of zero. <para> To obtain the selection value in a single logical unit, use -<function>XtGetSelectionValue</function> +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/> or -<function>XtGetSelectionValues</function>. +<xref linkend='XtGetSelectionValues' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetSelectionValue'> @@ -1428,14 +1428,14 @@ is not acceptable. </variablelist> <para> The -<function>XtGetSelectionValue</function> +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/> function requests the value of the selection converted to the target type. The specified callback is called at some time after -<function>XtGetSelectionValue</function> +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/> is called, when the selection value is received from the X server. It may be called before or after -<function>XtGetSelectionValue</function> +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/> returns. For more information about <emphasis remap='I'>selection</emphasis>, <emphasis remap='I'>target</emphasis>, and <emphasis remap='I'>time</emphasis>, see Section 2.6 in the <emphasis remap='I'>Inter-Client Communication Conventions Manual.</emphasis>. @@ -1537,9 +1537,9 @@ is not acceptable. </variablelist> <para> The -<function>XtGetSelectionValues</function> +<xref linkend='XtGetSelectionValues' xrefstyle='select: title'/> function is similar to multiple calls to -<function>XtGetSelectionValue</function> +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/> except that it guarantees that no other client can assert ownership between requests and therefore that all the conversions will refer to the same selection value. The callback is invoked once for each @@ -1553,7 +1553,7 @@ For more information about <emphasis remap='I'>selection</emphasis>, <emphasis r <para> To set the selection owner and indicate that the selection value will be provided in one piece, use -<function>XtOwnSelection</function>. +<xref linkend='XtOwnSelection' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtOwnSelection'> @@ -1644,7 +1644,7 @@ interested in being called back. </variablelist> <para> The -<function>XtOwnSelection</function> +<xref linkend='XtOwnSelection' xrefstyle='select: title'/> function informs the Intrinsics selection mechanism that a widget wishes to own a selection. It returns @@ -1665,10 +1665,10 @@ if the widget fails to obtain selection ownership in the first place. If a done_proc is specified, the client owns the storage allocated for passing the value to the Intrinsics. If <emphasis remap='I'>done_proc</emphasis> is NULL, the convert_proc must allocate storage using -<function>XtMalloc</function>, -<function>XtRealloc</function>, +<xref linkend='XtMalloc' xrefstyle='select: title'/>, +<xref linkend='XtRealloc' xrefstyle='select: title'/>, or -<function>XtCalloc</function>, +<xref linkend='XtCalloc' xrefstyle='select: title'/>, and the value specified is freed by the Intrinsics when the transfer is complete. </para> @@ -1682,7 +1682,7 @@ However, in response to some user actions (for example, when a user deletes the information selected), the application may wish to explicitly inform the Intrinsics by using -<function>XtDisownSelection</function> +<xref linkend='XtDisownSelection' xrefstyle='select: title'/> that it no longer is to be the selection owner. </para> @@ -1730,26 +1730,26 @@ relinquish selection ownership was initiated. </variablelist> <para> The -<function>XtDisownSelection</function> +<xref linkend='XtDisownSelection' xrefstyle='select: title'/> function informs the Intrinsics selection mechanism that the specified widget is to lose ownership of the selection. If the widget does not currently own the selection, either because it lost the selection or because it never had the selection to begin with, -<function>XtDisownSelection</function> +<xref linkend='XtDisownSelection' xrefstyle='select: title'/> does nothing. </para> <para> After a widget has called -<function>XtDisownSelection</function>, +<xref linkend='XtDisownSelection' xrefstyle='select: title'/>, its convert procedure is not called even if a request arrives later with a timestamp during the period that this widget owned the selection. However, its done procedure is called if a conversion that started before the call to -<function>XtDisownSelection</function> +<xref linkend='XtDisownSelection' xrefstyle='select: title'/> finishes after the call to -<function>XtDisownSelection</function>. +<xref linkend='XtDisownSelection' xrefstyle='select: title'/>. </para> </sect3> </sect2> @@ -1800,7 +1800,7 @@ provide the selection data in multiple segments. <para> The procedure pointer specified by the incremental owner to supply the selection data to the Intrinsics is of type -<function>XtConvertSelectionIncrProc</function>. +<xref linkend='XtConvertSelectionIncrProc' xrefstyle='select: title'/>. </para> <literallayout class="monospaced"> typedef XtPointer XtRequestId; @@ -1938,7 +1938,7 @@ Specifies an opaque identification for a specific request. This procedure is called repeatedly by the Intrinsics selection mechanism to get the next incremental chunk of data from a selection owner who has called -<function>XtOwnSelectionIncremental</function>. +<xref linkend='XtOwnSelectionIncremental' xrefstyle='select: title'/>. It must return <function>True</function> if the procedure has succeeded in converting the selection data or @@ -1960,7 +1960,7 @@ new transfer. To retrieve the <function>SelectionRequest</function> event that triggered the selection conversion procedure, use -<function>XtGetSelectionRequest</function>, +<xref linkend='XtGetSelectionRequest' xrefstyle='select: title'/>, described in Section 11.5.2.1. </para> @@ -1968,7 +1968,7 @@ described in Section 11.5.2.1. The procedure pointer specified by the incremental selection owner when it desires notification upon no longer having ownership is of type -<function>XtLoseSelectionIncrProc</function>. +<xref linkend='XtLoseSelectionIncrProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtLoseSelectionIncrProc'> @@ -2022,7 +2022,7 @@ inform the selection owner that it no longer owns the selection. The procedure pointer specified by the incremental selection owner when it desires notification of receipt of the data or when it manages the storage containing the data is of type -<function>XtSelectionDoneIncrProc</function>. +<xref linkend='XtSelectionDoneIncrProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSelectionDoneIncrProc'> @@ -2095,13 +2095,13 @@ the requestor has retrieved the final (zero-length) segment of the incremental transfer to indicate that the entire transfer is complete. If this procedure is not specified, the Intrinsics will free only the final value returned by the selection owner using -<function>XtFree</function>. +<xref linkend='XtFree' xrefstyle='select: title'/>. </para> <para> The procedure pointer specified by the incremental selection owner to notify it if a transfer should be terminated prematurely is of type -<function>XtCancelConvertSelectionProc</function>. +<xref linkend='XtCancelConvertSelectionProc' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCancelConvertSelectionProc'> @@ -2181,9 +2181,9 @@ allocated for the transfer. <title>Getting the Selection Value Incrementally</title> <para> To obtain the value of the selection using incremental transfers, use -<function>XtGetSelectionValueIncremental</function> +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/> or -<function>XtGetSelectionValuesIncremental</function>. +<xref linkend='XtGetSelectionValuesIncremental' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetSelectionValueIncremental'> @@ -2270,9 +2270,9 @@ is not acceptable. </variablelist> <para> The -<function>XtGetSelectionValueIncremental</function> +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/> function is similar to -<function>XtGetSelectionValue</function> +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/> except that the selection_callback procedure will be called repeatedly upon delivery of multiple segments of the selection value. The end of the selection value is indicated when @@ -2388,19 +2388,19 @@ is not acceptable. </variablelist> <para> The -<function>XtGetSelectionValuesIncremental</function> +<xref linkend='XtGetSelectionValuesIncremental' xrefstyle='select: title'/> function is similar to -<function>XtGetSelectionValueIncremental</function> +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/> except that it takes a list of targets and client data. -<function>XtGetSelectionValuesIncremental</function> +<xref linkend='XtGetSelectionValuesIncremental' xrefstyle='select: title'/> is equivalent to calling -<function>XtGetSelectionValueIncremental</function> +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/> successively for each <emphasis remap='I'>target/client_data</emphasis> pair except that -<function>XtGetSelectionValuesIncremental</function> +<xref linkend='XtGetSelectionValuesIncremental' xrefstyle='select: title'/> does guarantee that all the conversions will use the same selection value because the ownership of the selection cannot change in the middle of the list, as would be possible when calling -<function>XtGetSelectionValueIncremental</function> +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/> repeatedly. For more information about <emphasis remap='I'>selection</emphasis>, <emphasis remap='I'>target</emphasis>, and <emphasis remap='I'>time</emphasis>, see Section 2.6 in the <emphasis remap='I'>Inter-Client Communication Conventions Manual.</emphasis>. @@ -2410,7 +2410,7 @@ For more information about <emphasis remap='I'>selection</emphasis>, <emphasis r <title>Setting the Selection Owner for Incremental Transfers</title> <para> To set the selection owner when using incremental transfers, use -<function>XtOwnSelectionIncremental</function>. +<xref linkend='XtOwnSelectionIncremental' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtOwnSelectionIncremental'> @@ -2523,7 +2523,7 @@ the callback procedures when they are called. </variablelist> <para> The -<function>XtOwnSelectionIncremental</function> +<xref linkend='XtOwnSelectionIncremental' xrefstyle='select: title'/> procedure informs the Intrinsics incremental selection mechanism that the specified widget wishes to own the selection. It returns @@ -2539,10 +2539,10 @@ For more information about <emphasis remap='I'>selection</emphasis>, <emphasis r If a done_callback procedure is specified, the client owns the storage allocated for passing the value to the Intrinsics. If <emphasis remap='I'>done_callback</emphasis> is NULL, the convert_callback procedure must allocate storage using -<function>XtMalloc</function>, -<function>XtRealloc</function>, +<xref linkend='XtMalloc' xrefstyle='select: title'/>, +<xref linkend='XtRealloc' xrefstyle='select: title'/>, or -<function>XtCalloc</function>, +<xref linkend='XtCalloc' xrefstyle='select: title'/>, and the final value specified is freed by the Intrinsics when the transfer is complete. After a selection transfer has started, only one of the done_callback or cancel_callback @@ -2559,9 +2559,9 @@ expected to continue. <para> A widget that becomes the selection owner using -<function>XtOwnSelectionIncremental</function> +<xref linkend='XtOwnSelectionIncremental' xrefstyle='select: title'/> may use -<function>XtDisownSelection</function> +<xref linkend='XtDisownSelection' xrefstyle='select: title'/> to relinquish selection ownership. </para> </sect3> @@ -2572,7 +2572,7 @@ to relinquish selection ownership. <para> To specify target parameters for a selection request with a single target, use -<function>XtSetSelectionParameters</function>. +<xref linkend='XtSetSelectionParameters' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetSelectionParameters'> @@ -2655,13 +2655,13 @@ The specified parameters are copied and stored in a new property of the specified type and format on the requestor's window. To initiate a selection request with a target and these parameters, a subsequent call to -<function>XtGetSelectionValue</function> +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/> or to -<function>XtGetSelectionValueIncremental</function> +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/> specifying the same requestor widget and selection atom will generate a <function>ConvertSelection</function> request referring to the property containing the parameters. If -<function>XtSetSelectionParameters</function> +<xref linkend='XtSetSelectionParameters' xrefstyle='select: title'/> is called more than once with the same widget and selection without a call to specify a request, the most recently specified parameters are used in the subsequent request. @@ -2677,25 +2677,25 @@ if 16, sizeof(short); if 32, sizeof(long). To generate a MULTIPLE target request with parameters for any of the multiple targets of the selection request, precede individual calls to -<function>XtGetSelectionValue</function> +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/> and -<function>XtGetSelectionValueIncremental</function> +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/> with corresponding individual calls to -<function>XtSetSelectionParameters</function>, +<xref linkend='XtSetSelectionParameters' xrefstyle='select: title'/>, and enclose these all within -<function>XtCreateSelectionRequest</function> +<xref linkend='XtCreateSelectionRequest' xrefstyle='select: title'/> and <function>XtSendSelectionRequest.</function> -<function>XtGetSelectionValues</function> +<xref linkend='XtGetSelectionValues' xrefstyle='select: title'/> and -<function>XtGetSelectionValuesIncremental</function> +<xref linkend='XtGetSelectionValuesIncremental' xrefstyle='select: title'/> cannot be used to make selection requests with parameterized targets. </para> <para> To retrieve any target parameters needed to perform a selection conversion, the selection owner calls -<function>XtGetSelectionParameters</function>. +<xref linkend='XtGetSelectionParameters' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetSelectionParameters'> @@ -2789,17 +2789,17 @@ in the elements of <emphasis remap='I'>value</emphasis> is stored. </varlistentry> </variablelist> <para> -<function>XtGetSelectionParameters</function> +<xref linkend='XtGetSelectionParameters' xrefstyle='select: title'/> may be called only from within an -<function>XtConvertSelectionProc</function> +<xref linkend='XtConvertSelectionProc' xrefstyle='select: title'/> or from within the first call to an -<function>XtConvertSelectionIncrProc</function> +<xref linkend='XtConvertSelectionIncrProc' xrefstyle='select: title'/> with a new request_id. </para> <para> It is the responsibility of the caller to free the returned parameters using -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> when the parameters are no longer needed. </para> </sect2> @@ -2809,9 +2809,9 @@ when the parameters are no longer needed. <para> To have the Intrinsics bundle multiple calls to make selection requests into a single request using a <emphasis role='bold'>MULTIPLE</emphasis> target, use -<function>XtCreateSelectionRequest</function> +<xref linkend='XtCreateSelectionRequest' xrefstyle='select: title'/> and -<function>XtSendSelectionRequest</function>. +<xref linkend='XtSendSelectionRequest' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCreateSelectionRequest'> @@ -2846,18 +2846,18 @@ Specifies the particular selection desired. </variablelist> <para> When -<function>XtCreateSelectionRequest</function> +<xref linkend='XtCreateSelectionRequest' xrefstyle='select: title'/> is called, subsequent calls to -<function>XtGetSelectionValue</function>, -<function>XtGetSelectionValueIncremental</function>, -<function>XtGetSelectionValues</function>, +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/>, +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/>, +<xref linkend='XtGetSelectionValues' xrefstyle='select: title'/>, and -<function>XtGetSelectionValuesIncremental</function>, +<xref linkend='XtGetSelectionValuesIncremental' xrefstyle='select: title'/>, with the requestor and selection as specified to -<function>XtCreateSelectionRequest</function>, +<xref linkend='XtCreateSelectionRequest' xrefstyle='select: title'/>, are bundled into a single selection request with multiple targets. The request is made by calling -<function>XtSendSelectionRequest</function>. +<xref linkend='XtSendSelectionRequest' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSendSelectionRequest'> @@ -2906,29 +2906,29 @@ is not acceptable. </variablelist> <para> When -<function>XtSendSelectionRequest</function> +<xref linkend='XtSendSelectionRequest' xrefstyle='select: title'/> is called with a value of <emphasis remap='I'>requestor</emphasis> and <emphasis remap='I'>selection</emphasis> matching a previous call to -<function>XtCreateSelectionRequest</function>, +<xref linkend='XtCreateSelectionRequest' xrefstyle='select: title'/>, a selection request is sent to the selection owner. If a single target request is queued, that request is made. If multiple targets are queued, they are bundled into a single request with a target of MULTIPLE using the specified timestamp. As the values are returned, the callbacks specified in -<function>XtGetSelectionValue</function>, -<function>XtGetSelectionValueIncremental</function>, -<function>XtGetSelectionValues</function>, +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/>, +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/>, +<xref linkend='XtGetSelectionValues' xrefstyle='select: title'/>, and -<function>XtGetSelectionValueIncremental</function> +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/> are invoked. </para> <para> Multi-threaded applications should lock the application context before calling -<function>XtCreateSelectionRequest</function> +<xref linkend='XtCreateSelectionRequest' xrefstyle='select: title'/> and release the lock after calling -<function>XtSendSelectionRequest</function> +<xref linkend='XtSendSelectionRequest' xrefstyle='select: title'/> to ensure that the thread assembling the request is safe from interference by another thread assembling a different request naming the same widget and selection. @@ -2936,7 +2936,7 @@ and selection. <para> To relinquish the composition of a MULTIPLE request without sending it, use -<function>XtCancelSelectionRequest</function>. +<xref linkend='XtCancelSelectionRequest' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtCancelSelectionRequest'> @@ -2971,20 +2971,20 @@ Specifies the particular selection desired. </variablelist> <para> When -<function>XtCancelSelectionRequest</function> +<xref linkend='XtCancelSelectionRequest' xrefstyle='select: title'/> is called, any requests queued since the last call to -<function>XtCreateSelectionRequest</function> +<xref linkend='XtCreateSelectionRequest' xrefstyle='select: title'/> for the same widget and selection are discarded and any resources reserved are released. A subsequent call to -<function>XtSendSelectionRequest</function> +<xref linkend='XtSendSelectionRequest' xrefstyle='select: title'/> will not result in any request being made. Subsequent calls to -<function>XtGetSelectionValue</function>, -<function>XtGetSelectionValues</function>, -<function>XtGetSelectionValueIncremental</function>, +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/>, +<xref linkend='XtGetSelectionValues' xrefstyle='select: title'/>, +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/>, or -<function>XtGetSelectionValuesIncremental</function> +<xref linkend='XtGetSelectionValuesIncremental' xrefstyle='select: title'/> will not be deferred. </para> </sect2> @@ -3002,7 +3002,7 @@ the Intrinsics provides two interfaces for acquiring temporary property names. <para> To acquire a temporary property name atom for use in a selection request, the client may call -<function>XtReservePropertyAtom</function>. +<xref linkend='XtReservePropertyAtom' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtReservePropertyAtom'> @@ -3025,7 +3025,7 @@ Specifies the widget making a selection request. </varlistentry> </variablelist> <para> -<function>XtReservePropertyAtom</function> +<xref linkend='XtReservePropertyAtom' xrefstyle='select: title'/> returns an atom that may be used as a property name during selection requests involving the specified widget. As long as the atom remains reserved, it is unique with respect to all @@ -3035,7 +3035,7 @@ other reserved atoms for the widget. <para> To return a temporary property name atom for reuse and to delete the property named by that atom, use -<function>XtReleasePropertyAtom</function>. +<xref linkend='XtReleasePropertyAtom' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtReleasePropertyAtom'> @@ -3064,19 +3064,19 @@ Specifies the widget used to reserve the property name atom. <listitem> <para> Specifies the property name atom returned by -<function>XtReservePropertyAtom</function> +<xref linkend='XtReservePropertyAtom' xrefstyle='select: title'/> that is to be released for reuse. </para> </listitem> </varlistentry> </variablelist> <para> -<function>XtReleasePropertyAtom</function> +<xref linkend='XtReleasePropertyAtom' xrefstyle='select: title'/> marks the specified property name atom as no longer in use and ensures that any property having that name on the specified widget's window is deleted. If <emphasis remap='I'>atom</emphasis> does not specify a value returned by -<function>XtReservePropertyAtom</function> +<xref linkend='XtReservePropertyAtom' xrefstyle='select: title'/> for the specified widget, the results are undefined. </para> </sect2> @@ -3085,9 +3085,9 @@ for the specified widget, the results are undefined. <title>Retrieving the Most Recent Timestamp</title> <para> To retrieve the timestamp from the most recent call to -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> that contained a timestamp, use -<function>XtLastTimestampProcessed</function>. +<xref linkend='XtLastTimestampProcessed' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtLastTimestampProcessed'> @@ -3122,9 +3122,9 @@ If no or <function>SelectionClear</function> event has yet been passed to -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> for the specified display, -<function>XtLastTimestampProcessed</function> +<xref linkend='XtLastTimestampProcessed' xrefstyle='select: title'/> returns zero. </para> </sect2> @@ -3133,9 +3133,9 @@ returns zero. <title>Retrieving the Most Recent Event</title> <para> To retrieve the event from the most recent call to -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> for a specific display, use -<function>XtLastEventProcessed</function>. +<xref linkend='XtLastEventProcessed' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtLastEventProcessed'> @@ -3159,7 +3159,7 @@ Specifies the display connection from which to retrieve the event. </variablelist> <para> Returns the last event passed to -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> for the specified display. Returns NULL if there is no such event. The client must not modify the contents of the returned event. </para> @@ -3170,7 +3170,7 @@ The client must not modify the contents of the returned event. <title>Merging Exposure Events into a Region</title> <para> The Intrinsics provide an -<function>XtAddExposureToRegion</function> +<xref linkend='XtAddExposureToRegion' xrefstyle='select: title'/> utility function that merges <function>Expose</function> and @@ -3187,7 +3187,7 @@ To merge and <function>GraphicsExpose</function> events into a region, use -<function>XtAddExposureToRegion</function>. +<xref linkend='XtAddExposureToRegion' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAddExposureToRegion'> @@ -3227,7 +3227,7 @@ Specifies the region object (as defined in </variablelist> <para> The -<function>XtAddExposureToRegion</function> +<xref linkend='XtAddExposureToRegion' xrefstyle='select: title'/> function computes the union of the rectangle defined by the exposure event and the specified region. Then it stores the results back in <emphasis remap='I'>region</emphasis>. @@ -3236,7 +3236,7 @@ If the event argument is not an or <function>GraphicsExpose</function> event, -<function>XtAddExposureToRegion</function> +<xref linkend='XtAddExposureToRegion' xrefstyle='select: title'/> returns without an error and without modifying <emphasis remap='I'>region</emphasis>. </para> @@ -3251,7 +3251,7 @@ see Section 7.9.3. <para> To translate an x-y coordinate pair from widget coordinates to root window absolute coordinates, use -<function>XtTranslateCoords</function>. +<xref linkend='XtTranslateCoords' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtTranslateCoords'> @@ -3313,7 +3313,7 @@ Return the root-relative x and y coordinates. </variablelist> <para> While -<function>XtTranslateCoords</function> +<xref linkend='XtTranslateCoords' xrefstyle='select: title'/> is similar to the Xlib <function>XTranslateCoordinates</function> function, it does not generate a server request because all the required @@ -3325,7 +3325,7 @@ information already is in the widget's data structures. <title>Translating a Window to a Widget</title> <para> To translate a given window and display pointer into a widget instance, use -<function>XtWindowToWidget</function>. +<xref linkend='XtWindowToWidget' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtWindowToWidget'> @@ -3361,11 +3361,11 @@ Specifies the drawable for which you want the widget. <para> If there is a realized widget whose window is the specified drawable on the specified <emphasis remap='I'>display</emphasis>, -<function>XtWindowToWidget</function> +<xref linkend='XtWindowToWidget' xrefstyle='select: title'/> returns that widget. If not and if the drawable has been associated with a widget through -<function>XtRegisterDrawable</function>, -<function>XtWindowToWidget</function> +<xref linkend='XtRegisterDrawable' xrefstyle='select: title'/>, +<xref linkend='XtWindowToWidget' xrefstyle='select: title'/> returns the widget associated with the drawable. In other cases it returns NULL. </para> @@ -3420,7 +3420,7 @@ the ones registered last will prevail. <para> To obtain the error database (for example, to merge with an application- or widget-specific database), use -<function>XtAppGetErrorDatabase</function>. +<xref linkend='XtAppGetErrorDatabase' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppGetErrorDatabase'> @@ -3443,11 +3443,11 @@ Specifies the application context. </variablelist> <para> The -<function>XtAppGetErrorDatabase</function> +<xref linkend='XtAppGetErrorDatabase' xrefstyle='select: title'/> function returns the address of the error database. The Intrinsics do a lazy binding of the error database and do not merge in the database file until the first call to -<function>XtAppGetErrorDatabaseText</function>. +<xref linkend='XtAppGetErrorDatabaseText' xrefstyle='select: title'/>. </para> <para> @@ -3457,7 +3457,7 @@ that can be generated by the Intrinsics, see Appendix D. <para> The high-level error and warning handler procedure pointers are of type -<function>XtErrorMsgHandler</function>. +<xref linkend='XtErrorMsgHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtErrorMsgHandler'> @@ -3549,7 +3549,7 @@ notation is used to substitute the parameters into the message. <para> An error message handler can obtain the error database text for an error or a warning by calling -<function>XtAppGetErrorDatabaseText</function>. +<xref linkend='XtAppGetErrorDatabaseText' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppGetErrorDatabaseText'> @@ -3648,7 +3648,7 @@ or NULL if the application context's error database is to be used. </variablelist> <para> The -<function>XtAppGetErrorDatabaseText</function> +<xref linkend='XtAppGetErrorDatabaseText' xrefstyle='select: title'/> returns the appropriate message from the error database or returns the specified default message if one is not found in the error database. @@ -3660,9 +3660,9 @@ single "." if it does not already contain a ".". <para> To return the application name and class as passed to -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> for a particular Display, use -<function>XtGetApplicationNameAndClass</function>. +<xref linkend='XtGetApplicationNameAndClass' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetApplicationNameAndClass'> @@ -3682,7 +3682,7 @@ for a particular Display, use <listitem> <para> Specifies an open display connection that has been initialized with -<function>XtDisplayInitialize</function>. +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>. </para> </listitem> </varlistentry> @@ -3708,9 +3708,9 @@ Returns the application class. </varlistentry> </variablelist> <para> -<function>XtGetApplicationNameAndClass</function> +<xref linkend='XtGetApplicationNameAndClass' xrefstyle='select: title'/> returns the application name and class passed to -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> for the specified display. If the display was never initialized or has been closed, the result is undefined. The returned strings are owned by the Intrinsics and must not be modified @@ -3719,7 +3719,7 @@ or freed by the caller. <para> To register a procedure to be called on fatal error conditions, use -<function>XtAppSetErrorMsgHandler</function>. +<xref linkend='XtAppSetErrorMsgHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppSetErrorMsgHandler'> @@ -3753,13 +3753,13 @@ Specifies the new fatal error procedure, which should not return. </varlistentry> </variablelist> <para> -<function>XtAppSetErrorMsgHandler</function> +<xref linkend='XtAppSetErrorMsgHandler' xrefstyle='select: title'/> returns a pointer to the previously installed high-level fatal error handler. The default high-level fatal error handler provided by the Intrinsics is named <function>_XtDefaultErrorMsg</function> and constructs a string from the error resource database and calls -<function>XtError</function>. +<xref linkend='XtError' xrefstyle='select: title'/>. Fatal error message handlers should not return. If one does, subsequent Intrinsics behavior is undefined. @@ -3767,7 +3767,7 @@ subsequent Intrinsics behavior is undefined. <para> To call the high-level error handler, use -<function>XtAppErrorMsg</function>. +<xref linkend='XtAppErrorMsg' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppErrorMsg'> @@ -3862,7 +3862,7 @@ The Intrinsics internal errors all have class <para> To register a procedure to be called on nonfatal error conditions, use -<function>XtAppSetWarningMsgHandler</function>. +<xref linkend='XtAppSetWarningMsgHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppSetWarningMsgHandler'> @@ -3896,19 +3896,19 @@ Specifies the new nonfatal error procedure, which usually returns. </varlistentry> </variablelist> <para> -<function>XtAppSetWarningMsgHandler</function> +<xref linkend='XtAppSetWarningMsgHandler' xrefstyle='select: title'/> returns a pointer to the previously installed high-level warning handler. The default high-level warning handler provided by the Intrinsics is named <function>_XtDefaultWarningMsg</function> and constructs a string from the error resource database and calls -<function>XtWarning</function>. +<xref linkend='XtWarning' xrefstyle='select: title'/>. </para> <para> To call the installed high-level warning handler, use -<function>XtAppWarningMsg</function>. +<xref linkend='XtAppWarningMsg' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppWarningMsg'> @@ -4003,7 +4003,7 @@ The Intrinsics internal warnings all have class <para> The low-level error and warning handler procedure pointers are of type -<function>XtErrorHandler</function>. +<xref linkend='XtErrorHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtErrorHandler'> @@ -4031,7 +4031,7 @@ The error handler should display the message string in some appropriate fashion. <para> To register a procedure to be called on fatal error conditions, use -<function>XtAppSetErrorHandler</function>. +<xref linkend='XtAppSetErrorHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppSetErrorHandler'> @@ -4065,7 +4065,7 @@ Specifies the new fatal error procedure, which should not return. </varlistentry> </variablelist> <para> -<function>XtAppSetErrorHandler</function> +<xref linkend='XtAppSetErrorHandler' xrefstyle='select: title'/> returns a pointer to the previously installed low-level fatal error handler. The default low-level error handler provided by the Intrinsics is @@ -4079,7 +4079,7 @@ subsequent Intrinsics behavior is undefined. <para> To call the installed fatal error procedure, use -<function>XtAppError</function>. +<xref linkend='XtAppError' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppError'> @@ -4114,15 +4114,15 @@ Specifies the message to be reported. </variablelist> <para> Most programs should use -<function>XtAppErrorMsg</function>, +<xref linkend='XtAppErrorMsg' xrefstyle='select: title'/>, not -<function>XtAppError</function>, +<xref linkend='XtAppError' xrefstyle='select: title'/>, to provide for customization and internationalization of error messages. </para> <para> To register a procedure to be called on nonfatal error conditions, use -<function>XtAppSetWarningHandler</function>. +<xref linkend='XtAppSetWarningHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppSetWarningHandler'> @@ -4156,7 +4156,7 @@ Specifies the new nonfatal error procedure, which usually returns. </varlistentry> </variablelist> <para> -<function>XtAppSetWarningHandler</function> +<xref linkend='XtAppSetWarningHandler' xrefstyle='select: title'/> returns a pointer to the previously installed low-level warning handler. The default low-level warning handler provided by the Intrinsics is @@ -4167,7 +4167,7 @@ it prints the message to standard error and returns to the caller. <para> To call the installed nonfatal error procedure, use -<function>XtAppWarning</function>. +<xref linkend='XtAppWarning' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppWarning'> @@ -4202,9 +4202,9 @@ Specifies the nonfatal error message to be reported. </variablelist> <para> Most programs should use -<function>XtAppWarningMsg</function>, +<xref linkend='XtAppWarningMsg' xrefstyle='select: title'/>, not -<function>XtAppWarning</function>, +<xref linkend='XtAppWarning' xrefstyle='select: title'/>, to provide for customization and internationalization of warning messages. </para> </sect1> @@ -4214,7 +4214,7 @@ to provide for customization and internationalization of warning messages. <para> A client may set the value of the <emphasis role='bold'>WM_COLORMAP_WINDOWS</emphasis> property on a widget's window by calling -<function>XtSetWMColormapWindows</function>. +<xref linkend='XtSetWMColormapWindows' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetWMColormapWindows'> @@ -4261,10 +4261,10 @@ Specifies the number of widgets in <emphasis remap='I'>list</emphasis>. </varlistentry> </variablelist> <para> -<function>XtSetWMColormapWindows</function> +<xref linkend='XtSetWMColormapWindows' xrefstyle='select: title'/> returns immediately if <emphasis remap='I'>widget</emphasis> is not realized or if <emphasis remap='I'>count</emphasis> is 0. Otherwise, -<function>XtSetWMColormapWindows</function> +<xref linkend='XtSetWMColormapWindows' xrefstyle='select: title'/> constructs an ordered list of windows by examining each widget in <emphasis remap='I'>list</emphasis> in turn and ignoring the widget if it is not realized, or @@ -4275,7 +4275,7 @@ resources of all widgets whose windows are already on the window list. <para> Finally, -<function>XtSetWMColormapWindows</function> +<xref linkend='XtSetWMColormapWindows' xrefstyle='select: title'/> stores the resulting window list in the <emphasis role='bold'>WM_COLORMAP_WINDOWS</emphasis> property on the specified widget's window. Refer to Section 4.1.8 in the <emphasis remap='I'>Inter-Client Communication Conventions Manual.</emphasis> for details of @@ -4289,16 +4289,16 @@ the semantics of the <emphasis role='bold'>WM_COLORMAP_WINDOWS</emphasis> proper The Intrinsics provide procedures to look for a file by name, allowing string substitutions in a list of file specifications. Two routines are provided for this: -<function>XtFindFile</function> +<xref linkend='XtFindFile' xrefstyle='select: title'/> and -<function>XtResolvePathname</function>. -<function>XtFindFile</function> +<xref linkend='XtResolvePathname' xrefstyle='select: title'/>. +<xref linkend='XtFindFile' xrefstyle='select: title'/> uses an arbitrary set of client-specified substitutions, and -<function>XtResolvePathname</function> +<xref linkend='XtResolvePathname' xrefstyle='select: title'/> uses a set of standard substitutions corresponding to the <emphasis remap='I'>X/Open Portability Guide</emphasis> language localization conventions. Most applications should use -<function>XtResolvePathname</function>. +<xref linkend='XtResolvePathname' xrefstyle='select: title'/>. </para> <para> @@ -4315,7 +4315,7 @@ typedef struct { <para> File name evaluation is handled in an operating-system-dependent fashion by an -<function>XtFilePredicate</function> +<xref linkend='XtFilePredicate' xrefstyle='select: title'/> procedure. </para> @@ -4349,7 +4349,7 @@ otherwise. <para> To search for a file using substitutions in a path list, use -<function>XtFindFile</function>. +<xref linkend='XtFindFile' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtFindFile'> @@ -4414,7 +4414,7 @@ single colon. The character sequence "%%" specifies a percent character that does not introduce a substitution; the sequence is replaced by a single percent character. If a percent character is followed by any other character, -<function>XtFindFile</function> +<xref linkend='XtFindFile' xrefstyle='select: title'/> looks through the specified <emphasis remap='I'>substitutions</emphasis> for that character in the <emphasis remap='I'>match</emphasis> field and, if found, @@ -4423,22 +4423,22 @@ corresponding <emphasis remap='I'>substitution</emphasis> field. A <emphasis re is equivalent to a pointer to an empty string. If the operating system does not interpret multiple embedded name separators in the path (i.e., "/" in POSIX) the same way as a single separator, -<function>XtFindFile</function> +<xref linkend='XtFindFile' xrefstyle='select: title'/> will collapse multiple separators into a single one after performing all string substitutions. Except for collapsing embedded separators, the contents of the string substitutions are not interpreted by -<function>XtFindFile</function> +<xref linkend='XtFindFile' xrefstyle='select: title'/> and may therefore contain any operating-system-dependent characters, including additional name separators. Each resulting string is passed to the predicate procedure until a string is found for which the procedure returns <function>True</function>; this string is the return value for -<function>XtFindFile</function>. +<xref linkend='XtFindFile' xrefstyle='select: title'/>. If no string yields a <function>True</function> return from the predicate, -<function>XtFindFile</function> +<xref linkend='XtFindFile' xrefstyle='select: title'/> returns NULL. </para> @@ -4449,13 +4449,13 @@ if the file exists, is readable, and is not a directory is used. <para> It is the responsibility of the caller to free the returned string using -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> when it is no longer needed. </para> <para> To search for a file using standard substitutions in a path list, use -<function>XtResolvePathname</function>. +<xref linkend='XtResolvePathname' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtResolvePathname'> @@ -4550,9 +4550,9 @@ Specifies a procedure called to judge each potential file name, or NULL. </variablelist> <para> The substitutions specified by -<function>XtResolvePathname</function> +<xref linkend='XtResolvePathname' xrefstyle='select: title'/> are determined from the value of the language string retrieved by -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> for the specified display. To set the language for all applications specify "*xnlLanguage: <emphasis remap='I'>lang</emphasis>" in the @@ -4567,12 +4567,12 @@ than to use them in substitutions as described below. </para> <para> -<function>XtResolvePathname</function> +<xref linkend='XtResolvePathname' xrefstyle='select: title'/> calls -<function>XtFindFile</function> +<xref linkend='XtFindFile' xrefstyle='select: title'/> with the following substitutions in addition to any passed by the caller and returns the value returned by -<function>XtFindFile</function>: +<xref linkend='XtFindFile' xrefstyle='select: title'/>: </para> <itemizedlist> <listitem> @@ -4625,13 +4625,13 @@ The value of the implementation-specific default path. </itemizedlist> <para> If a path is passed to -<function>XtResolvePathname</function>, +<xref linkend='XtResolvePathname' xrefstyle='select: title'/>, it is passed along to -<function>XtFindFile</function>. +<xref linkend='XtFindFile' xrefstyle='select: title'/>. If the <emphasis remap='I'>path</emphasis> argument is NULL, the value of the <emphasis role='bold'>XFILESEARCHPATH</emphasis> environment variable is passed to -<function>XtFindFile</function>. +<xref linkend='XtFindFile' xrefstyle='select: title'/>. If <emphasis role='bold'>XFILESEARCHPATH</emphasis> is not defined, an implementation-specific default path is used @@ -4709,13 +4709,13 @@ currently associated with the display (the database returned by for the resource <emphasis remap='I'>application_name</emphasis>.customization, class <emphasis remap='I'>application_class</emphasis>.Customization, where <emphasis remap='I'>application_name</emphasis> and <emphasis remap='I'>application_class</emphasis> are the values returned by -<function>XtGetApplicationNameAndClass</function>. +<xref linkend='XtGetApplicationNameAndClass' xrefstyle='select: title'/>. If no value is specified in the database, the empty string is used. </para> <para> It is the responsibility of the caller to free the returned string using -<function>XtFree</function> +<xref linkend='XtFree' xrefstyle='select: title'/> when it is no longer needed. </para> </sect1> @@ -4735,7 +4735,7 @@ in a "hook registration" object. <para> To retrieve the hook registration widget, use -<function>XtHooksOfDisplay</function>. +<xref linkend='XtHooksOfDisplay' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtHooksOfDisplay'> @@ -4775,22 +4775,22 @@ as an argument: <itemizedlist> <listitem> <para> -<function>XtAddCallback</function>, -<function>XtAddCallbacks</function>, -<function>XtRemoveCallback</function>, -<function>XtRemoveCallbacks</function>, -<function>XtRemoveAllCallbacks</function>, -<function>XtCallCallbacks</function>, -<function>XtHasCallbacks</function>, -<function>XtCallCallbackList</function> +<xref linkend='XtAddCallback' xrefstyle='select: title'/>, +<xref linkend='XtAddCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtRemoveCallback' xrefstyle='select: title'/>, +<xref linkend='XtRemoveCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtRemoveAllCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtCallCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtHasCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtCallCallbackList' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtClass</function>, +<xref linkend='XtClass' xrefstyle='select: title'/>, <function>XtSuperclass</function>, -<function>XtIsSubclass</function>, -<function>XtCheckSubclass</function>, +<xref linkend='XtIsSubclass' xrefstyle='select: title'/>, +<xref linkend='XtCheckSubclass' xrefstyle='select: title'/>, <function>XtIsObject</function>, <function>XtIsRectObj</function>, <function>XtIsWidget</function>, @@ -4808,23 +4808,23 @@ as an argument: </listitem> <listitem> <para> -<function>XtWidgetToApplicationContext</function> +<xref linkend='XtWidgetToApplicationContext' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtName</function>, +<xref linkend='XtName' xrefstyle='select: title'/>, <function>XtParent</function>, -<function>XtDisplayOfObject</function>, -<function>XtScreenOfObject</function> +<xref linkend='XtDisplayOfObject' xrefstyle='select: title'/>, +<xref linkend='XtScreenOfObject' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtSetValues</function>, -<function>XtGetValues</function>, -<function>XtVaSetValues</function>, -<function>XtVaGetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/>, +<xref linkend='XtGetValues' xrefstyle='select: title'/>, +<xref linkend='XtVaSetValues' xrefstyle='select: title'/>, +<xref linkend='XtVaGetValues' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -4891,10 +4891,10 @@ Descriptions of each of these resources: <para> The XtNcreateHook callback list is called from: -<function>XtCreateWidget</function>, -<function>XtCreateManagedWidget</function>, -<function>XtCreatePopupShell</function>, -<function>XtAppCreateShell</function>, +<xref linkend='XtCreateWidget' xrefstyle='select: title'/>, +<xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/>, +<xref linkend='XtCreatePopupShell' xrefstyle='select: title'/>, +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/>, and their corresponding varargs versions. </para> @@ -4925,58 +4925,58 @@ The XtNchangeHook callback list is called from: <itemizedlist> <listitem> <para> -<function>XtSetValues</function>, -<function>XtVaSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/>, +<xref linkend='XtVaSetValues' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<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'/> </para> </listitem> <listitem> <para> -<function>XtRealizeWidget</function>, -<function>XtUnrealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/>, +<xref linkend='XtUnrealizeWidget' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtAddCallback</function>, -<function>XtRemoveCallback</function>, +<xref linkend='XtAddCallback' xrefstyle='select: title'/>, +<xref linkend='XtRemoveCallback' xrefstyle='select: title'/>, <function>XtAddCallbacks,</function> -<function>XtRemoveCallbacks</function>, -<function>XtRemoveAllCallbacks</function> +<xref linkend='XtRemoveCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtRemoveAllCallbacks' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtAugmentTranslations</function>, -<function>XtOverrideTranslations</function>, -<function>XtUninstallTranslations</function> +<xref linkend='XtAugmentTranslations' xrefstyle='select: title'/>, +<xref linkend='XtOverrideTranslations' xrefstyle='select: title'/>, +<xref linkend='XtUninstallTranslations' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtSetKeyboardFocus</function>, -<function>XtSetWMColormapWindows</function> +<xref linkend='XtSetKeyboardFocus' xrefstyle='select: title'/>, +<xref linkend='XtSetWMColormapWindows' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtSetMappedWhenManaged</function>, -<function>XtMapWidget</function>, -<function>XtUnmapWidget</function> +<xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/>, +<xref linkend='XtMapWidget' xrefstyle='select: title'/>, +<xref linkend='XtUnmapWidget' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtPopup</function>, -<function>XtPopupSpringLoaded</function>, -<function>XtPopdown</function> +<xref linkend='XtPopup' xrefstyle='select: title'/>, +<xref linkend='XtPopupSpringLoaded' xrefstyle='select: title'/>, +<xref linkend='XtPopdown' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -4996,9 +4996,9 @@ typedef struct { </literallayout> <para> When the changeHook callbacks are called as a result of a call to -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> or -<function>XtVaSetValues</function>, +<xref linkend='XtVaSetValues' xrefstyle='select: title'/>, <emphasis remap='I'>type</emphasis> is set to <function>XtHsetValues</function>, <emphasis remap='I'>widget</emphasis> is the new widget passed to the set_values procedure, and @@ -5020,9 +5020,9 @@ after the set_values and constraint set_values procedures have been called. <para> When the changeHook callbacks are called as a result of a call to -<function>XtManageChild</function> +<xref linkend='XtManageChild' xrefstyle='select: title'/> or -<function>XtManageChildren</function>, +<xref linkend='XtManageChildren' xrefstyle='select: title'/>, <emphasis remap='I'>type</emphasis> is set to <function>XtHmanageChildren</function>, <emphasis remap='I'>widget</emphasis> is the parent, <emphasis remap='I'>event_data</emphasis> may be cast to type @@ -5033,9 +5033,9 @@ The callbacks are called after the children have been managed. <para> When the changeHook callbacks are called as a result of a call to -<function>XtUnmanageChild</function> +<xref linkend='XtUnmanageChild' xrefstyle='select: title'/> or -<function>XtUnmanageChildren</function>, +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/>, <emphasis remap='I'>type</emphasis> is set to <function>XtHunmanageChildren</function>, <emphasis remap='I'>widget</emphasis> is the parent, <emphasis remap='I'>event_data</emphasis> may be cast to type @@ -5046,7 +5046,7 @@ The callbacks are called after the children have been unmanaged. <para> The changeHook callbacks are called twice as a result of a call to -<function>XtChangeManagedSet</function>, +<xref linkend='XtChangeManagedSet' xrefstyle='select: title'/>, once after unmanaging and again after managing. When the callbacks are called the first time, <emphasis remap='I'>type</emphasis> is set to <function>XtHunmanageSet</function>, @@ -5062,7 +5062,7 @@ WidgetList and is a list of the children being managed, and <para> When the changeHook callbacks are called as a result of a call to -<function>XtRealizeWidget</function>, +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHrealizeWidget</function> and <emphasis remap='I'>widget</emphasis> is the widget being realized. @@ -5071,7 +5071,7 @@ The callbacks are called after the widget has been realized. <para> When the changeHook callbacks are called as a result of a call to -<function>XtUnrealizeWidget</function>, +<xref linkend='XtUnrealizeWidget' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHunrealizeWidget</function>, and <emphasis remap='I'>widget</emphasis> is the widget being unrealized. @@ -5080,7 +5080,7 @@ The callbacks are called after the widget has been unrealized. <para> When the changeHook callbacks are called as a result of a call to -<function>XtAddCallback</function>, +<xref linkend='XtAddCallback' xrefstyle='select: title'/>, <emphasis remap='I'>type</emphasis> is set to <function>XtHaddCallback</function>, <emphasis remap='I'>widget</emphasis> is the widget to which the callback is being added, and @@ -5091,7 +5091,7 @@ The callbacks are called after the callback has been added to the widget. <para> When the changeHook callbacks are called as a result of a call to -<function>XtAddCallbacks</function>, +<xref linkend='XtAddCallbacks' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHaddCallbacks</function>, <emphasis remap='I'>widget</emphasis> is the widget to which the callbacks are being added, and @@ -5102,7 +5102,7 @@ The callbacks are called after the callbacks have been added to the widget. <para> When the changeHook callbacks are called as a result of a call to -<function>XtRemoveCallback</function>, +<xref linkend='XtRemoveCallback' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHremoveCallback</function>, <emphasis remap='I'>widget</emphasis> is the widget from which the callback is being removed, and @@ -5113,7 +5113,7 @@ has been removed from the widget. <para> When the changeHook callbacks are called as a result of a call to -<function>XtRemoveCallbacks</function>, +<xref linkend='XtRemoveCallbacks' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHremoveCallbacks</function>, <emphasis remap='I'>widget</emphasis> is the widget from which the callbacks are being removed, and @@ -5124,7 +5124,7 @@ have been removed from the widget. <para> When the changeHook callbacks are called as a result of a call to -<function>XtRemoveAllCallbacks</function>, +<xref linkend='XtRemoveAllCallbacks' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHremoveAllCallbacks</function> and <emphasis remap='I'>widget</emphasis> is the widget from which the callbacks are being removed. @@ -5134,7 +5134,7 @@ widget. <para> When the changeHook callbacks are called as a result of a call to -<function>XtAugmentTranslations</function>, +<xref linkend='XtAugmentTranslations' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHaugmentTranslations</function> and <emphasis remap='I'>widget</emphasis> is the widget whose translations are being modified. @@ -5144,7 +5144,7 @@ modified. <para> When the changeHook callbacks are called as a result of a call to -<function>XtOverrideTranslations</function>, +<xref linkend='XtOverrideTranslations' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHoverrideTranslations</function> and <emphasis remap='I'>widget</emphasis> is the widget whose translations are being modified. @@ -5154,7 +5154,7 @@ modified. <para> When the changeHook callbacks are called as a result of a call to -<function>XtUninstallTranslations</function>, +<xref linkend='XtUninstallTranslations' xrefstyle='select: title'/>, The <emphasis remap='I'>type</emphasis> is <function>XtHuninstallTranslations</function> and <emphasis remap='I'>widget</emphasis> is the widget whose translations are being uninstalled. @@ -5164,39 +5164,39 @@ uninstalled. <para> When the changeHook callbacks are called as a result of a call to -<function>XtSetKeyboardFocus</function>, +<xref linkend='XtSetKeyboardFocus' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHsetKeyboardFocus</function> and <emphasis remap='I'>event_data</emphasis> may be cast to type Widget and is the value of -the descendant argument passed to <function>XtSetKeyboardFocus</function>. The -callbacks are called before returning from <function>XtSetKeyboardFocus</function>. +the descendant argument passed to <xref linkend='XtSetKeyboardFocus' xrefstyle='select: title'/>. The +callbacks are called before returning from <xref linkend='XtSetKeyboardFocus' xrefstyle='select: title'/>. </para> <para> When the changeHook callbacks are called as a result of a call to -<function>XtSetWMColormapWindows</function>, +<xref linkend='XtSetWMColormapWindows' xrefstyle='select: title'/>, <emphasis remap='I'>type</emphasis> is set to <function>XtHsetWMColormapWindows</function>, <emphasis remap='I'>event_data</emphasis> may be cast to type WidgetList and is the value of -the list argument passed to <function>XtSetWMColormapWindows</function>, and +the list argument passed to <xref linkend='XtSetWMColormapWindows' xrefstyle='select: title'/>, and <emphasis remap='I'>num_event_data</emphasis> is the length of the list. The callbacks are -called before returning from <function>XtSetWMColormapWindows</function>. +called before returning from <xref linkend='XtSetWMColormapWindows' xrefstyle='select: title'/>. </para> <para> When the changeHook callbacks are called as a result of a call to -<function>XtSetMappedWhenManaged</function>, +<xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHsetMappedWhenManaged</function> and <emphasis remap='I'>event_data</emphasis> may be cast to type Boolean and is the value of -the mapped_when_managed argument passed to <function>XtSetMappedWhenManaged</function>. +the mapped_when_managed argument passed to <xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/>. The callbacks are called after setting the widget's mapped_when_managed field and before realizing or unrealizing the widget. </para> <para> When the changeHook callbacks are called as a result of a call to -<function>XtMapWidget</function>, +<xref linkend='XtMapWidget' xrefstyle='select: title'/>, the <emphasis remap='I'>type </emphasis> is set to <function>XtHmapWidget</function> and <emphasis remap='I'>widget</emphasis> is the widget being mapped. @@ -5205,7 +5205,7 @@ The callbacks are called after mapping the widget. <para> When the changeHook callbacks are called as a result of a call to -<function>XtUnmapWidget</function>, +<xref linkend='XtUnmapWidget' xrefstyle='select: title'/>, the <emphasis remap='I'>type </emphasis> is set to <function>XtHunmapWidget</function> and <emphasis remap='I'>widget</emphasis> is the widget being unmapped. @@ -5214,33 +5214,33 @@ The callbacks are called after unmapping the widget. <para> When the changeHook callbacks are called as a result of a call to -<function>XtPopup</function>, +<xref linkend='XtPopup' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHpopup</function>, <emphasis remap='I'>widget</emphasis> is the widget being popped up, and <emphasis remap='I'>event_data</emphasis> may be cast to type XtGrabKind and is the value of the grab_kind argument -passed to <function>XtPopup</function>. -The callbacks are called before returning from <function>XtPopup</function>. +passed to <xref linkend='XtPopup' xrefstyle='select: title'/>. +The callbacks are called before returning from <xref linkend='XtPopup' xrefstyle='select: title'/>. </para> <para> When the changeHook callbacks are called as a result of a call to -<function>XtPopupSpringLoaded</function>, +<xref linkend='XtPopupSpringLoaded' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHpopupSpringLoaded</function> and <emphasis remap='I'>widget</emphasis> is the widget being popped up. The callbacks are called -before returning from <function>XtPopupSpringLoaded</function>. +before returning from <xref linkend='XtPopupSpringLoaded' xrefstyle='select: title'/>. </para> <para> When the changeHook callbacks are called as a result of a call to -<function>XtPopdown</function>, +<xref linkend='XtPopdown' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is set to <function>XtHpopdown</function> and <emphasis remap='I'>widget</emphasis> is the widget being popped down. The callbacks are called -before returning from <function>XtPopdown</function>. +before returning from <xref linkend='XtPopdown' xrefstyle='select: title'/>. </para> <para> @@ -5255,7 +5255,7 @@ itself. This is done by: <para> The XtNconfigureHook callback list is called any time the Intrinsics move, resize, or configure a widget and when -<function>XtResizeWindow</function> +<xref linkend='XtResizeWindow' xrefstyle='select: title'/> is called. </para> @@ -5281,9 +5281,9 @@ are called after changes have been made to the widget. <para> The XtNgeometryHook callback list is called from -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> and -<function>XtMakeResizeRequest</function> +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/> once before and once after geometry negotiation occurs. </para> @@ -5328,7 +5328,7 @@ typedef struct { </literallayout> <para> When the destroyHook callbacks are called as a result of a call to -<function>XtDestroyWidget</function>, +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/>, the <emphasis remap='I'>type</emphasis> is <function>XtHdestroy</function> and <emphasis remap='I'>widget</emphasis> is the widget being destroyed. The callbacks are @@ -5351,7 +5351,7 @@ functions in order to avoid recursion. <para> To retrieve a list of the Displays associated with an application context, use -<function>XtGetDisplays</function>. +<xref linkend='XtGetDisplays' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetDisplays'> @@ -5397,10 +5397,10 @@ Returns the count of open Display connections in <emphasis remap='I'>dpy_return< </varlistentry> </variablelist> <para> -<function>XtGetDisplays</function> may be used by an external agent to query the +<xref linkend='XtGetDisplays' xrefstyle='select: title'/> may be used by an external agent to query the list of open displays that belong to an application context. To free the list of displays, use -<function>XtFree</function>. +<xref linkend='XtFree' xrefstyle='select: title'/>. </para> </sect2> </sect1> diff --git a/specs/CH12.xml b/specs/CH12.xml index a6f8887..cc6ded0 100755 --- a/specs/CH12.xml +++ b/specs/CH12.xml @@ -286,28 +286,28 @@ or any subclass: <itemizedlist> <listitem> <para> -<function>XtCreateWidget</function>, -<function>XtVaCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/>, +<xref linkend='XtVaCreateWidget' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtAddCallback</function>, -<function>XtAddCallbacks</function>, -<function>XtRemoveCallback</function>, -<function>XtRemoveCallbacks</function>, -<function>XtRemoveAllCallbacks</function>, -<function>XtCallCallbacks</function>, -<function>XtHasCallbacks</function>, -<function>XtCallCallbackList</function> +<xref linkend='XtAddCallback' xrefstyle='select: title'/>, +<xref linkend='XtAddCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtRemoveCallback' xrefstyle='select: title'/>, +<xref linkend='XtRemoveCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtRemoveAllCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtCallCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtHasCallbacks' xrefstyle='select: title'/>, +<xref linkend='XtCallCallbackList' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtClass</function>, +<xref linkend='XtClass' xrefstyle='select: title'/>, <function>XtSuperclass</function>, -<function>XtIsSubclass</function>, -<function>XtCheckSubclass</function>, +<xref linkend='XtIsSubclass' xrefstyle='select: title'/>, +<xref linkend='XtCheckSubclass' xrefstyle='select: title'/>, <function>XtIsObject</function>, <function>XtIsRectObj</function>, <function>XtIsWidget</function>, @@ -325,8 +325,8 @@ or any subclass: </listitem> <listitem> <para> -<function>XtIsManaged</function>, -<function>XtIsSensitive</function> +<xref linkend='XtIsManaged' xrefstyle='select: title'/>, +<xref linkend='XtIsSensitive' xrefstyle='select: title'/> (both will return <function>False</function> if argument is not a subclass of @@ -335,7 +335,7 @@ RectObj) </listitem> <listitem> <para> -<function>XtIsRealized</function> +<xref linkend='XtIsRealized' xrefstyle='select: title'/> (returns the state of the nearest windowed ancestor if class of argument is not a subclass of Core) @@ -343,59 +343,59 @@ Core) </listitem> <listitem> <para> -<function>XtWidgetToApplicationContext</function> +<xref linkend='XtWidgetToApplicationContext' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtDestroyWidget</function> +<xref linkend='XtDestroyWidget' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> <function>XtParent</function>, -<function>XtDisplayOfObject</function>, -<function>XtScreenOfObject</function>, -<function>XtWindowOfObject</function> +<xref linkend='XtDisplayOfObject' xrefstyle='select: title'/>, +<xref linkend='XtScreenOfObject' xrefstyle='select: title'/>, +<xref linkend='XtWindowOfObject' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtSetKeyboardFocus</function> +<xref linkend='XtSetKeyboardFocus' xrefstyle='select: title'/> (descendant) </para> </listitem> <listitem> <para> -<function>XtGetGC</function>, -<function>XtReleaseGC</function> +<xref linkend='XtGetGC' xrefstyle='select: title'/>, +<xref linkend='XtReleaseGC' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtName</function> +<xref linkend='XtName' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtSetValues</function>, -<function>XtGetValues</function>, -<function>XtVaSetValues</function>, -<function>XtVaGetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/>, +<xref linkend='XtGetValues' xrefstyle='select: title'/>, +<xref linkend='XtVaSetValues' xrefstyle='select: title'/>, +<xref linkend='XtVaGetValues' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtGetSubresources</function>, -<function>XtGetApplicationResources</function>, -<function>XtVaGetSubresources</function>, -<function>XtVaGetApplicationResources</function> +<xref linkend='XtGetSubresources' xrefstyle='select: title'/>, +<xref linkend='XtGetApplicationResources' xrefstyle='select: title'/>, +<xref linkend='XtVaGetSubresources' xrefstyle='select: title'/>, +<xref linkend='XtVaGetApplicationResources' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtConvert</function>, -<function>XtConvertAndStore</function> +<xref linkend='XtConvert' xrefstyle='select: title'/>, +<xref linkend='XtConvertAndStore' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -407,8 +407,8 @@ or a subclass: <itemizedlist> <listitem> <para> -<function>XtCreateWidget</function>, -<function>XtVaCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/>, +<xref linkend='XtVaCreateWidget' xrefstyle='select: title'/> </para> </listitem> <listitem> @@ -418,7 +418,7 @@ or a subclass: </listitem> <listitem> <para> -<function>XtNameToWidget</function> +<xref linkend='XtNameToWidget' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -430,7 +430,7 @@ or a subclass: <itemizedlist> <listitem> <para> -<function>XtClass</function>, +<xref linkend='XtClass' xrefstyle='select: title'/>, <function>XtSuperclass</function> </para> </listitem> @@ -456,7 +456,7 @@ set the <emphasis remap='I'>accepts_objects</emphasis> field in the <function>CompositeClassExtension</function> structure to <function>True</function>. -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> will otherwise generate an error message on an attempt to create a nonwidget child. </para> @@ -717,8 +717,8 @@ or any subclass: <itemizedlist> <listitem> <para> -<function>XtCreateManagedWidget</function>, -<function>XtVaCreateManagedWidget</function> +<xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/>, +<xref linkend='XtVaCreateManagedWidget' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -730,39 +730,39 @@ or any subclass: <itemizedlist> <listitem> <para> -<function>XtConfigureWidget</function>, -<function>XtMoveWidget</function>, -<function>XtResizeWidget</function> +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/>, +<xref linkend='XtMoveWidget' xrefstyle='select: title'/>, +<xref linkend='XtResizeWidget' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtMakeGeometryRequest</function>, -<function>XtMakeResizeRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>, +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtManageChildren</function>, -<function>XtManageChild</function>, -<function>XtUnmanageChildren</function>, -<function>XtUnmanageChild</function>, -<function>XtChangeManagedSet</function> +<xref linkend='XtManageChildren' xrefstyle='select: title'/>, +<xref linkend='XtManageChild' xrefstyle='select: title'/>, +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/>, +<xref linkend='XtUnmanageChild' xrefstyle='select: title'/>, +<xref linkend='XtChangeManagedSet' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtQueryGeometry</function> +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtSetSensitive</function> +<xref linkend='XtSetSensitive' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtTranslateCoords</function> +<xref linkend='XtTranslateCoords' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -774,8 +774,8 @@ or a subclass: <itemizedlist> <listitem> <para> -<function>XtCreateManagedWidget</function>, -<function>XtVaCreateManagedWidget</function> +<xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/>, +<xref linkend='XtVaCreateManagedWidget' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -805,9 +805,9 @@ the <emphasis remap='I'>accepts_objects</emphasis> field in the <function>CompositeClassExtension</function> extension structure to <function>True</function>. -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> or -<function>XtCreateManagedWidget</function> +<xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/> will otherwise generate an error if called to create a nonwidget child. If the composite widget supports only children of class RectObj @@ -859,7 +859,7 @@ A rectobj child is managed or unmanaged. <listitem> <para> In a call to -<function>XtSetValues</function> +<xref linkend='XtSetValues' xrefstyle='select: title'/> on a rectobj child, one or more of the set_values procedures returns <function>True</function>. </para> @@ -867,7 +867,7 @@ on a rectobj child, one or more of the set_values procedures returns <listitem> <para> In a call to -<function>XtConfigureWidget</function> +<xref linkend='XtConfigureWidget' xrefstyle='select: title'/> on a rectobj child, areas will be cleared corresponding to both the old and the new child geometries, including the border, if the geometry changes. @@ -876,7 +876,7 @@ geometries, including the border, if the geometry changes. <listitem> <para> In a call to -<function>XtMoveWidget</function> +<xref linkend='XtMoveWidget' xrefstyle='select: title'/> on a rectobj child, areas will be cleared corresponding to both the old and the new child geometries, including the border, if the geometry changes. @@ -885,7 +885,7 @@ geometries, including the border, if the geometry changes. <listitem> <para> In a call to -<function>XtResizeWidget</function> +<xref linkend='XtResizeWidget' xrefstyle='select: title'/> on a rectobj child, a single rectangle will be cleared corresponding to the larger of the old and the new child geometries if they are different. @@ -894,9 +894,9 @@ old and the new child geometries if they are different. <listitem> <para> In a call to -<function>XtMakeGeometryRequest</function> +<xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/> (or -<function>XtMakeResizeRequest</function>) +<xref linkend='XtMakeResizeRequest' xrefstyle='select: title'/>) on a rectobj child with <function>XtQueryOnly</function> not set, if the manager returns @@ -965,12 +965,12 @@ or a subclass: <itemizedlist> <listitem> <para> -<function>XtCreatePopupShell</function>, -<function>XtVaCreatePopupShell</function>, -<function>XtAppCreateShell</function>, -<function>XtVaAppCreateShell</function>, -<function>XtOpenApplication</function>, -<function>XtVaOpenApplication</function> +<xref linkend='XtCreatePopupShell' xrefstyle='select: title'/>, +<xref linkend='XtVaCreatePopupShell' xrefstyle='select: title'/>, +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/>, +<xref linkend='XtVaAppCreateShell' xrefstyle='select: title'/>, +<xref linkend='XtOpenApplication' xrefstyle='select: title'/>, +<xref linkend='XtVaOpenApplication' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -982,119 +982,119 @@ or any subclass: <itemizedlist> <listitem> <para> -<function>XtCreatePopupShell</function>, -<function>XtVaCreatePopupShell</function> +<xref linkend='XtCreatePopupShell' xrefstyle='select: title'/>, +<xref linkend='XtVaCreatePopupShell' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtAddEventHandler</function>, -<function>XtAddRawEventHandler</function>, -<function>XtRemoveEventHandler</function>, -<function>XtRemoveRawEventHandler</function>, -<function>XtInsertEventHandler</function>, -<function>XtInsertRawEventHandler</function> -<function>XtInsertEventTypeHandler</function>, -<function>XtRemoveEventTypeHandler</function>, +<xref linkend='XtAddEventHandler' xrefstyle='select: title'/>, +<xref linkend='XtAddRawEventHandler' xrefstyle='select: title'/>, +<xref linkend='XtRemoveEventHandler' xrefstyle='select: title'/>, +<xref linkend='XtRemoveRawEventHandler' xrefstyle='select: title'/>, +<xref linkend='XtInsertEventHandler' xrefstyle='select: title'/>, +<xref linkend='XtInsertRawEventHandler' xrefstyle='select: title'/> +<xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/>, +<xref linkend='XtRemoveEventTypeHandler' xrefstyle='select: title'/>, </para> </listitem> <listitem> <para> -<function>XtRegisterDrawable</function> -<function>XtDispatchEventToWidget</function> +<xref linkend='XtRegisterDrawable' xrefstyle='select: title'/> +<xref linkend='XtDispatchEventToWidget' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtAddGrab</function>, -<function>XtRemoveGrab</function>, -<function>XtGrabKey</function>, -<function>XtGrabKeyboard</function>, -<function>XtUngrabKey</function>, -<function>XtUngrabKeyboard</function>, -<function>XtGrabButton</function>, -<function>XtGrabPointer</function>, -<function>XtUngrabButton</function>, -<function>XtUngrabPointer</function> +<xref linkend='XtAddGrab' xrefstyle='select: title'/>, +<xref linkend='XtRemoveGrab' xrefstyle='select: title'/>, +<xref linkend='XtGrabKey' xrefstyle='select: title'/>, +<xref linkend='XtGrabKeyboard' xrefstyle='select: title'/>, +<xref linkend='XtUngrabKey' xrefstyle='select: title'/>, +<xref linkend='XtUngrabKeyboard' xrefstyle='select: title'/>, +<xref linkend='XtGrabButton' xrefstyle='select: title'/>, +<xref linkend='XtGrabPointer' xrefstyle='select: title'/>, +<xref linkend='XtUngrabButton' xrefstyle='select: title'/>, +<xref linkend='XtUngrabPointer' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtBuildEventMask</function> +<xref linkend='XtBuildEventMask' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtCreateWindow</function>, +<xref linkend='XtCreateWindow' xrefstyle='select: title'/>, <function>XtDisplay</function>, -<function>XtScreen</function>, -<function>XtWindow</function> +<xref linkend='XtScreen' xrefstyle='select: title'/>, +<xref linkend='XtWindow' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtNameToWidget</function> +<xref linkend='XtNameToWidget' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtGetSelectionValue</function>, -<function>XtGetSelectionValues</function>, -<function>XtOwnSelection</function>, -<function>XtDisownSelection</function>, -<function>XtOwnSelectionIncremental</function>, -<function>XtGetSelectionValueIncremental</function>, -<function>XtGetSelectionValuesIncremental</function>, -<function>XtGetSelectionRequest</function> +<xref linkend='XtGetSelectionValue' xrefstyle='select: title'/>, +<xref linkend='XtGetSelectionValues' xrefstyle='select: title'/>, +<xref linkend='XtOwnSelection' xrefstyle='select: title'/>, +<xref linkend='XtDisownSelection' xrefstyle='select: title'/>, +<xref linkend='XtOwnSelectionIncremental' xrefstyle='select: title'/>, +<xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/>, +<xref linkend='XtGetSelectionValuesIncremental' xrefstyle='select: title'/>, +<xref linkend='XtGetSelectionRequest' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtInstallAccelerators</function>, -<function>XtInstallAllAccelerators</function> +<xref linkend='XtInstallAccelerators' xrefstyle='select: title'/>, +<xref linkend='XtInstallAllAccelerators' xrefstyle='select: title'/> (both destination and source) </para> </listitem> <listitem> <para> -<function>XtAugmentTranslations</function>, -<function>XtOverrideTranslations</function>, -<function>XtUninstallTranslations</function>, -<function>XtCallActionProc</function> +<xref linkend='XtAugmentTranslations' xrefstyle='select: title'/>, +<xref linkend='XtOverrideTranslations' xrefstyle='select: title'/>, +<xref linkend='XtUninstallTranslations' xrefstyle='select: title'/>, +<xref linkend='XtCallActionProc' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtMapWidget</function>, -<function>XtUnmapWidget</function> +<xref linkend='XtMapWidget' xrefstyle='select: title'/>, +<xref linkend='XtUnmapWidget' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtRealizeWidget</function>, -<function>XtUnrealizeWidget</function> +<xref linkend='XtRealizeWidget' xrefstyle='select: title'/>, +<xref linkend='XtUnrealizeWidget' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtSetMappedWhenManaged</function> +<xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtCallAcceptFocus</function>, -<function>XtSetKeyboardFocus</function> +<xref linkend='XtCallAcceptFocus' xrefstyle='select: title'/>, +<xref linkend='XtSetKeyboardFocus' xrefstyle='select: title'/> (subtree) </para> </listitem> <listitem> <para> -<function>XtResizeWindow</function> +<xref linkend='XtResizeWindow' xrefstyle='select: title'/> </para> </listitem> <listitem> <para> -<function>XtSetWMColormapWindows</function> +<xref linkend='XtSetWMColormapWindows' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -1106,8 +1106,8 @@ or any subclass: <itemizedlist> <listitem> <para> -<function>XtCreateManagedWidget</function>, -<function>XtVaCreateManagedWidget</function> +<xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/>, +<xref linkend='XtVaCreateManagedWidget' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -1118,13 +1118,13 @@ Shell: <itemizedlist> <listitem> <para> -<function>XtPopdown</function>, -<function>XtCallbackPopdown</function>, -<function>XtPopup</function>, -<function>XtCallbackNone</function>, -<function>XtCallbackNonexclusive</function>, -<function>XtCallbackExclusive</function>, -<function>XtPopupSpringLoaded</function> +<xref linkend='XtPopdown' xrefstyle='select: title'/>, +<xref linkend='XtCallbackPopdown' xrefstyle='select: title'/>, +<xref linkend='XtPopup' xrefstyle='select: title'/>, +<xref linkend='XtCallbackNone' xrefstyle='select: title'/>, +<xref linkend='XtCallbackNonexclusive' xrefstyle='select: title'/>, +<xref linkend='XtCallbackExclusive' xrefstyle='select: title'/>, +<xref linkend='XtPopupSpringLoaded' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -1136,7 +1136,7 @@ or a subclass: <itemizedlist> <listitem> <para> -<function>XtWindowToWidget</function> +<xref linkend='XtWindowToWidget' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> @@ -1147,12 +1147,12 @@ Shell: <itemizedlist> <listitem> <para> -<function>XtAppCreateShell</function>, -<function>XtVaAppCreateShell</function>, -<function>XtAppInitialize</function>, -<function>XtVaAppInitialize</function>, -<function>XtCreatePopupShell</function>, -<function>XtVaCreatePopupShell</function> +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/>, +<xref linkend='XtVaAppCreateShell' xrefstyle='select: title'/>, +<xref linkend='XtAppInitialize' xrefstyle='select: title'/>, +<xref linkend='XtVaAppInitialize' xrefstyle='select: title'/>, +<xref linkend='XtCreatePopupShell' xrefstyle='select: title'/>, +<xref linkend='XtVaCreatePopupShell' xrefstyle='select: title'/> </para> </listitem> </itemizedlist> diff --git a/specs/CH13.xml b/specs/CH13.xml index e3292cc..b6c77cb 100755 --- a/specs/CH13.xml +++ b/specs/CH13.xml @@ -82,16 +82,16 @@ modification. <title>Additional Arguments</title> <para> Arguments were added to the procedure definitions for -<function>XtInitProc</function>, -<function>XtSetValuesFunc</function>, +<xref linkend='XtInitProc' xrefstyle='select: title'/>, +<xref linkend='XtSetValuesFunc' xrefstyle='select: title'/>, and -<function>XtEventHandler</function> +<xref linkend='XtEventHandler' xrefstyle='select: title'/> to provide more information and to allow event handlers to abort further dispatching of the current event (caution is advised!). The added arguments to -<function>XtInitProc</function> +<xref linkend='XtInitProc' xrefstyle='select: title'/> and -<function>XtSetValuesFunc</function> +<xref linkend='XtSetValuesFunc' xrefstyle='select: title'/> make the initialize_hook and set_values_hook methods obsolete, but the hooks have been retained for those widgets that used them in Release 3. @@ -124,7 +124,7 @@ specification change is small. <title>Query Geometry</title> <para> A composite widget layout routine that calls -<function>XtQueryGeometry</function> +<xref linkend='XtQueryGeometry' xrefstyle='select: title'/> is now expected to store the complete new geometry in the intended structure; previously the specification said ``store the changes it intends to make''. Only by storing the complete geometry does the child have @@ -139,7 +139,7 @@ to take advantage of the new information. <para> In order to provide a mechanism for widgets to be notified when they become unrealized through a call to -<function>XtUnrealizeWidget</function>, +<xref linkend='XtUnrealizeWidget' xrefstyle='select: title'/>, the callback list name ``unrealizeCallback'' has been defined by the Intrinsics. A widget class that requires notification on unrealize may declare a @@ -208,7 +208,7 @@ interface. In the now obsolete old type converter interface, converters are reminded that they must return the size of the converted value as well as its address. The example indicated this, but the description of -<function>XtConverter</function> +<xref linkend='XtConverter' xrefstyle='select: title'/> was incomplete. </para> </sect2> @@ -217,7 +217,7 @@ was incomplete. <title>KeySym Case Conversion Procedure</title> <para> The specification for the -<function>XtCaseProc</function> +<xref linkend='XtCaseProc' xrefstyle='select: title'/> function type has been changed to match the Release 3 implementation, which included necessary additional information required by the function (a pointer to the @@ -335,7 +335,7 @@ values when overriding the system defaults. <sect2 id="Customization_Resource"> <title>Customization Resource</title> <para> -<function>XtResolvePathname</function> +<xref linkend='XtResolvePathname' xrefstyle='select: title'/> supports a new substitution string, %C, for specifying separate application class resource files according to arbitrary user-specified categories. The primary motivation for this addition was separate @@ -366,7 +366,7 @@ description of the process by which the resource database(s) is initialized, the net effect is the same as in prior releases with the exception of the added per-screen resource specification and the new customization substitution string in -<function>XtResolvePathname</function>. +<xref linkend='XtResolvePathname' xrefstyle='select: title'/>. </para> </sect2> @@ -398,9 +398,9 @@ to do so. The internationalization additions also define event filters as a part of the Xlib Input Method specifications. The Intrinsics enable the use of event filters through additions to -<function>XtDispatchEvent</function>. +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/>. Applications that may not be dispatching all events through -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> should be reviewed in the context of this new input method mechanism. </para> @@ -444,12 +444,12 @@ on the fly. <title>Arguments to Existing Functions</title> <para> The <emphasis remap='I'>args</emphasis> argument to -<function>XtAppInitialize</function>, -<function>XtVaAppInitialize</function>, -<function>XtOpenDisplay</function>, -<function>XtDisplayInitialize</function>, +<xref linkend='XtAppInitialize' xrefstyle='select: title'/>, +<xref linkend='XtVaAppInitialize' xrefstyle='select: title'/>, +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/>, +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>, and -<function>XtInitialize</function> +<xref linkend='XtInitialize' xrefstyle='select: title'/> were changed from <function>Cardinal</function>* to int* to conform to pre-existing convention and avoid otherwise @@ -490,7 +490,7 @@ the specification now more exactly describes the process. <para> As a convenience, an interface to locate a widget class extension record on a linked list, -<function>XtGetClassExtension</function>, +<xref linkend='XtGetClassExtension' xrefstyle='select: title'/>, has been added. </para> @@ -505,7 +505,7 @@ extension record. <para> The wording of the process followed by -<function>XtUnmanageChildren</function> +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/> has changed slightly to better handle changes to the managed set during phase 2 destroy processing. </para> @@ -525,12 +525,12 @@ compute the region. <sect2 id="General_Application_Development"> <title>General Application Development</title> <para> -<function>XtOpenApplication</function> +<xref linkend='XtOpenApplication' xrefstyle='select: title'/> is a new convenience procedure to initialize the toolkit, create an application context, open an X display connection, and create the root of the widget instance tree. It is identical to the interface it replaces, -<function>XtAppInitialize</function>, +<xref linkend='XtAppInitialize' xrefstyle='select: title'/>, in all respects except that it takes an additional argument specifying the widget class of the root shell to create. This interface is now the recommended one so that clients may easily @@ -540,14 +540,14 @@ The old convenience procedures appear in the compatibility section. <para> The toolkit initialization function -<function>XtToolkitInitialize</function> +<xref linkend='XtToolkitInitialize' xrefstyle='select: title'/> may be called multiple times without penalty. </para> <para> In order to optimize changes in geometry to a set of geometry-managed children, a new interface, -<function>XtChangeManagedSet</function>, +<xref linkend='XtChangeManagedSet' xrefstyle='select: title'/>, has been added. </para> </sect2> @@ -580,9 +580,9 @@ operations by participating applications. The structures the application's notification of and responses to messages from the session manager by use of various callback lists and by use of the new interfaces -<function>XtSessionGetToken</function> +<xref linkend='XtSessionGetToken' xrefstyle='select: title'/> and -<function>XtSessionReturnToken</function>. +<xref linkend='XtSessionReturnToken' xrefstyle='select: title'/>. There is also a new command line argument, -xtsessionID, which facilitates the session manager in restarting applications based on the Intrinsics. </para> @@ -621,23 +621,23 @@ In Release 6, support is provided for registering selectors and event handlers for events generated by X protocol extensions and for dispatching those events to the appropriate widget. The new event handler registration interfaces are -<function>XtInsertEventTypeHandler</function> +<xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/> and -<function>XtRemoveEventTypeHandler</function>. +<xref linkend='XtRemoveEventTypeHandler' xrefstyle='select: title'/>. Since the mechanism to indicate selection of extension events is specific to the extension being used, the Intrinsics introduces -<function>XtRegisterExtensionSelector</function>, +<xref linkend='XtRegisterExtensionSelector' xrefstyle='select: title'/>, which allows the application to select for the events of interest. In order to change the dispatching algorithm to accommodate extension events as well as core X protocol events, the Intrinsics event dispatcher may now be replaced or enveloped by the application with -<function>XtSetEventDispatcher</function>. +<xref linkend='XtSetEventDispatcher' xrefstyle='select: title'/>. The dispatcher may wish to call -<function>XtGetKeyboardFocusWidget</function> +<xref linkend='XtGetKeyboardFocusWidget' xrefstyle='select: title'/> to determine the widget with the current Intrinsics keyboard focus. A dispatcher, after determining the destination widget, may use -<function>XtDispatchEventToWidget</function> +<xref linkend='XtDispatchEventToWidget' xrefstyle='select: title'/> to cause the event to be dispatched to the event handlers registered by a specific widget. </para> @@ -646,12 +646,12 @@ by a specific widget. To permit the dispatching of events for nonwidget drawables, such as pixmaps that are not associated with a widget's window, -<function>XtRegisterDrawable</function> +<xref linkend='XtRegisterDrawable' xrefstyle='select: title'/> and -<function>XtUnregisterDrawable</function> +<xref linkend='XtUnregisterDrawable' xrefstyle='select: title'/> have been added to the library. A related update was made to the description of -<function>XtWindowToWidget</function>. +<xref linkend='XtWindowToWidget' xrefstyle='select: title'/>. </para> <para> @@ -659,39 +659,39 @@ The library is now thread-safe, allowing one thread at a time to enter the library and protecting global data as necessary from concurrent use. Threaded toolkit applications are supported by the new interfaces -<function>XtToolkitThreadInitialize</function>, -<function>XtAppLock</function>, -<function>XtAppUnlock</function>, -<function>XtAppSetExitFlag</function>, +<xref linkend='XtToolkitThreadInitialize' xrefstyle='select: title'/>, +<xref linkend='XtAppLock' xrefstyle='select: title'/>, +<xref linkend='XtAppUnlock' xrefstyle='select: title'/>, +<xref linkend='XtAppSetExitFlag' xrefstyle='select: title'/>, and -<function>XtAppGetExitFlag</function>. +<xref linkend='XtAppGetExitFlag' xrefstyle='select: title'/>. Widget writers may also use -<function>XtProcessLock</function> +<xref linkend='XtProcessLock' xrefstyle='select: title'/> and -<function>XtProcessUnlock</function>. +<xref linkend='XtProcessUnlock' xrefstyle='select: title'/>. </para> <para> Safe handling of POSIX signals and other asynchronous notifications is now provided by use of -<function>XtAppAddSignal</function>, -<function>XtNoticeSignal</function>, +<xref linkend='XtAppAddSignal' xrefstyle='select: title'/>, +<xref linkend='XtNoticeSignal' xrefstyle='select: title'/>, and -<function>XtRemoveSignal</function>. +<xref linkend='XtRemoveSignal' xrefstyle='select: title'/>. </para> <para> The application can receive notification of an impending block in the Intrinsics event manager by registering interest through -<function>XtAppAddBlockHook</function> +<xref linkend='XtAppAddBlockHook' xrefstyle='select: title'/> and -<function>XtRemoveBlockHook</function>. +<xref linkend='XtRemoveBlockHook' xrefstyle='select: title'/>. </para> <para> -<function>XtLastEventProcessed</function> +<xref linkend='XtLastEventProcessed' xrefstyle='select: title'/> returns the most recent event passed to -<function>XtDispatchEvent</function> +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/> for a specified display. </para> </sect2> @@ -731,23 +731,23 @@ ignore NumLock and apply the normal protocol semantics. The targets of selection requests may be parameterized, as described by the revised <emphasis remap='I'>Inter-Client Communication Conventions Manual.</emphasis>. When such requests are made, -<function>XtSetSelectionParameters</function> +<xref linkend='XtSetSelectionParameters' xrefstyle='select: title'/> is used by the requestor to specify the target parameters and -<function>XtGetSelectionParameters</function> +<xref linkend='XtGetSelectionParameters' xrefstyle='select: title'/> is used by the selection owner to retrieve the parameters. When a parameterized target is specified in the context of a bundled request for multiple targets, -<function>XtCreateSelectionRequest</function>, -<function>XtCancelSelectionRequest</function>, +<xref linkend='XtCreateSelectionRequest' xrefstyle='select: title'/>, +<xref linkend='XtCancelSelectionRequest' xrefstyle='select: title'/>, and -<function>XtSendSelectionRequest</function> +<xref linkend='XtSendSelectionRequest' xrefstyle='select: title'/> are used to envelop the assembly of the request. When the parameters themselves are the names of properties, the Intrinsics provides support for the economical use of property atom names; see -<function>XtReservePropertyAtom</function> +<xref linkend='XtReservePropertyAtom' xrefstyle='select: title'/> and -<function>XtReleasePropertyAtom</function>. +<xref linkend='XtReleasePropertyAtom' xrefstyle='select: title'/>. </para> </sect2> @@ -762,9 +762,9 @@ The hook callbacks permit the external agent to register interest in groups or classes of toolkit activity and to be notified of the type and details of the activity as it occurs. The new interfaces related to this effort are -<function>XtHooksOfDisplay</function>, +<xref linkend='XtHooksOfDisplay' xrefstyle='select: title'/>, which returns the hook registration widget, and -<function>XtGetDisplays</function>, +<xref linkend='XtGetDisplays' xrefstyle='select: title'/>, which returns a list of the X displays associated with an application context. </para> </sect2> diff --git a/specs/appB.xml b/specs/appB.xml index a58c10a..1fe43aa 100755 --- a/specs/appB.xml +++ b/specs/appB.xml @@ -385,7 +385,7 @@ modifiers/KeyCode combination in an event in the following ways: <listitem> <para> If a colon (:) is used, the Intrinsics call the display's -<function>XtKeyProc</function> +<xref linkend='XtKeyProc' xrefstyle='select: title'/> with the KeyCode and modifiers. To match, (<emphasis remap='I'>modifiers</emphasis> & ~<emphasis remap='I'>modifiers_return</emphasis>) must equal <emphasis remap='I'>modifier_list</emphasis>, and <emphasis remap='I'>keysym_return</emphasis> must equal the given KeySym. @@ -398,7 +398,7 @@ modifiers. This value must be equal to <emphasis remap='I'>modifier_list</emphasis>. Then, for each possible combination of don't-care modifiers in the modifier list, the Intrinsics call the display's -<function>XtKeyProc</function> +<xref linkend='XtKeyProc' xrefstyle='select: title'/> with the KeyCode and that combination ORed with the cared-about modifier bits from the event. <emphasis remap='I'>Keysym_return</emphasis> must match the KeySym in the translation. diff --git a/specs/appC.xml b/specs/appC.xml index a93dcef..7307a67 100755 --- a/specs/appC.xml +++ b/specs/appC.xml @@ -14,7 +14,7 @@ implemented an Xt<<emphasis remap='I'>Widget</emphasis>>Create (for exampl <function>XtLabelCreate</function>) function, in which most of the code was identical from widget to widget. In the Intrinsics, a single generic -<function>XtCreateWidget</function> +<xref linkend='XtCreateWidget' xrefstyle='select: title'/> performs most of the common work and then calls the initialize procedure implemented for the particular widget class. </para> @@ -26,9 +26,9 @@ Xt<<emphasis remap='I'>Widget</emphasis>>Add and an Xt<<emphasis remap= and <function>XtButtonBoxDeleteButton</function>). In the Intrinsics, the Composite generic procedures -<function>XtManageChildren</function> +<xref linkend='XtManageChildren' xrefstyle='select: title'/> and -<function>XtUnmanageChildren</function> +<xref linkend='XtUnmanageChildren' xrefstyle='select: title'/> perform error checking and screening out of certain children. Then they call the change_managed procedure implemented for the widget's Composite class. @@ -51,30 +51,30 @@ as: <para> Pop-up shells in some of the prototypes automatically performed an -<function>XtManageChild</function> +<xref linkend='XtManageChild' xrefstyle='select: title'/> on their child within their insert_child procedure. Creators of pop-up children need to call -<function>XtManageChild</function> +<xref linkend='XtManageChild' xrefstyle='select: title'/> themselves. </para> <para> -<function>XtAppInitialize</function> +<xref linkend='XtAppInitialize' xrefstyle='select: title'/> and -<function>XtVaAppInitialize</function> +<xref linkend='XtVaAppInitialize' xrefstyle='select: title'/> have been replaced by -<function>XtOpenApplication</function> +<xref linkend='XtOpenApplication' xrefstyle='select: title'/> and -<function>XtVaOpenApplication</function>. +<xref linkend='XtVaOpenApplication' xrefstyle='select: title'/>. </para> <para> To initialize the Intrinsics internals, create an application context, open and initialize a display, and create the initial application shell instance, an application may use -<function>XtAppInitialize</function> +<xref linkend='XtAppInitialize' xrefstyle='select: title'/> or -<function>XtVaAppInitialize</function>. +<xref linkend='XtVaAppInitialize' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppInitialize'> @@ -188,30 +188,30 @@ Specifies the number of entries in the argument list. </variablelist> <para> The -<function>XtAppInitialize</function> +<xref linkend='XtAppInitialize' xrefstyle='select: title'/> function calls -<function>XtToolkitInitialize</function> +<xref linkend='XtToolkitInitialize' xrefstyle='select: title'/> followed by -<function>XtCreateApplicationContext</function>, +<xref linkend='XtCreateApplicationContext' xrefstyle='select: title'/>, then calls -<function>XtOpenDisplay</function> +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/> with <emphasis remap='I'>display_string</emphasis> NULL and <emphasis remap='I'>application_name</emphasis> NULL, and finally calls -<function>XtAppCreateShell</function> +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/> with <emphasis remap='I'>application_name</emphasis> NULL, <emphasis remap='I'>widget_class</emphasis> <function>application\%Shell\%Widget\%Class</function>, and the specified <emphasis remap='I'>args</emphasis> and <emphasis remap='I'>num_args</emphasis> and returns the created shell. The modified <emphasis remap='I'>argc</emphasis> and <emphasis remap='I'>argv</emphasis> returned by -<function>XtDisplayInitialize</function> +<xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> are returned in <emphasis remap='I'>argc_in_out</emphasis> and <emphasis remap='I'>argv_in_out</emphasis>. If <emphasis remap='I'>app_context_return</emphasis> is not NULL, the created application context is also returned. If the display specified by the command line cannot be opened, an error message is issued and -<function>XtAppInitialize</function> +<xref linkend='XtAppInitialize' xrefstyle='select: title'/> terminates the application. If <emphasis remap='I'>fallback_resources</emphasis> is non-NULL, -<function>XtAppSetFallbackResources</function> +<xref linkend='XtAppSetFallbackResources' xrefstyle='select: title'/> is called with the value prior to calling -<function>XtOpenDisplay</function>. +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtVaAppInitialize'> @@ -313,9 +313,9 @@ resource specifications for the created shell. </variablelist> <para> The -<function>XtVaAppInitialize</function> +<xref linkend='XtVaAppInitialize' xrefstyle='select: title'/> procedure is identical in function to -<function>XtAppInitialize</function> +<xref linkend='XtAppInitialize' 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. @@ -324,20 +324,20 @@ in Section 2.5.1. <para> As a convenience to people converting from earlier versions of the toolkit without application contexts, the following routines exist: -<function>XtInitialize</function>, -<function>XtMainLoop</function>, -<function>XtNextEvent</function>, -<function>XtProcessEvent</function>, -<function>XtPeekEvent</function>, -<function>XtPending</function>, -<function>XtAddInput</function>, -<function>XtAddTimeOut</function>, -<function>XtAddWorkProc</function>, -<function>XtCreateApplicationShell</function>, -<function>XtAddActions</function>, -<function>XtSetSelectionTimeout</function>, +<xref linkend='XtInitialize' xrefstyle='select: title'/>, +<xref linkend='XtMainLoop' xrefstyle='select: title'/>, +<xref linkend='XtNextEvent' xrefstyle='select: title'/>, +<xref linkend='XtProcessEvent' xrefstyle='select: title'/>, +<xref linkend='XtPeekEvent' xrefstyle='select: title'/>, +<xref linkend='XtPending' xrefstyle='select: title'/>, +<xref linkend='XtAddInput' xrefstyle='select: title'/>, +<xref linkend='XtAddTimeOut' xrefstyle='select: title'/>, +<xref linkend='XtAddWorkProc' xrefstyle='select: title'/>, +<xref linkend='XtCreateApplicationShell' xrefstyle='select: title'/>, +<xref linkend='XtAddActions' xrefstyle='select: title'/>, +<xref linkend='XtSetSelectionTimeout' xrefstyle='select: title'/>, and -<function>XtGetSelectionTimeout</function>. +<xref linkend='XtGetSelectionTimeout' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtInitialize'> @@ -417,23 +417,23 @@ Specifies the command line parameters. </varlistentry> </variablelist> <para> -<function>XtInitialize</function> +<xref linkend='XtInitialize' xrefstyle='select: title'/> calls -<function>XtToolkitInitialize</function> +<xref linkend='XtToolkitInitialize' xrefstyle='select: title'/> to initialize the toolkit internals, creates a default application context for use by the other convenience routines, calls -<function>XtOpenDisplay</function> +<xref linkend='XtOpenDisplay' xrefstyle='select: title'/> with <emphasis remap='I'>display_string</emphasis> NULL and <emphasis remap='I'>application_name</emphasis> NULL, and finally calls -<function>XtAppCreateShell</function> +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/> with <emphasis remap='I'>application_name</emphasis> NULL and returns the created shell. The semantics of calling -<function>XtInitialize</function> +<xref linkend='XtInitialize' xrefstyle='select: title'/> more than once are undefined. This routine has been replaced by -<function>XtOpenApplication</function>. +<xref linkend='XtOpenApplication' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtMainLoop'> @@ -444,13 +444,13 @@ This routine has been replaced by </funcsynopsis> <para> -<function>XtMainLoop</function> +<xref linkend='XtMainLoop' xrefstyle='select: title'/> first reads the next alternate input, timer, or X event by calling -<function>XtNextEvent</function>. +<xref linkend='XtNextEvent' xrefstyle='select: title'/>. Then it dispatches this to the appropriate registered procedure by calling -<function>XtDispatchEvent</function>. +<xref linkend='XtDispatchEvent' xrefstyle='select: title'/>. This routine has been replaced by -<function>XtAppMainLoop</function>. +<xref linkend='XtAppMainLoop' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtNextEvent'> @@ -474,13 +474,13 @@ Returns the event information to the specified event structure. </variablelist> <para> If no input is on the X input queue for the default application context, -<function>XtNextEvent</function> +<xref linkend='XtNextEvent' xrefstyle='select: title'/> flushes the X output buffer and waits for an event while looking at the alternate input sources and timeout values and calling any callback procedures triggered by them. This routine has been replaced by -<function>XtAppNextEvent</function>. -<function>XtInitialize</function> +<xref linkend='XtAppNextEvent' xrefstyle='select: title'/>. +<xref linkend='XtInitialize' xrefstyle='select: title'/> must be called before using this routine. </para> @@ -504,12 +504,12 @@ Specifies the type of input to process. </varlistentry> </variablelist> <para> -<function>XtProcessEvent</function> +<xref linkend='XtProcessEvent' xrefstyle='select: title'/> processes one X event, timeout, or alternate input source (depending on the value of <emphasis remap='I'>mask</emphasis>), blocking if necessary. It has been replaced by -<function>XtAppProcessEvent</function>. -<function>XtInitialize</function> +<xref linkend='XtAppProcessEvent' xrefstyle='select: title'/>. +<xref linkend='XtInitialize' xrefstyle='select: title'/> must be called before using this function. </para> @@ -534,21 +534,21 @@ Returns the event information to the specified event structure. </variablelist> <para> If there is an event in the queue for the default application context, -<function>XtPeekEvent</function> +<xref linkend='XtPeekEvent' xrefstyle='select: title'/> fills in the event and returns a nonzero value. If no X input is on the queue, -<function>XtPeekEvent</function> +<xref linkend='XtPeekEvent' xrefstyle='select: title'/> flushes the output buffer and blocks until input is available, possibly calling some timeout callbacks in the process. If the input is an event, -<function>XtPeekEvent</function> +<xref linkend='XtPeekEvent' xrefstyle='select: title'/> fills in the event and returns a nonzero value. Otherwise, the input is for an alternate input source, and -<function>XtPeekEvent</function> +<xref linkend='XtPeekEvent' xrefstyle='select: title'/> returns zero. This routine has been replaced by -<function>XtAppPeekEvent</function>. -<function>XtInitialize</function> +<xref linkend='XtAppPeekEvent' xrefstyle='select: title'/>. +<xref linkend='XtInitialize' xrefstyle='select: title'/> must be called before using this routine. </para> @@ -560,15 +560,15 @@ must be called before using this routine. </funcsynopsis> <para> -<function>XtPending</function> +<xref linkend='XtPending' xrefstyle='select: title'/> returns a nonzero value if there are events pending from the X server or alternate input sources in the default application context. If there are no events pending, it flushes the output buffer and returns a zero value. It has been replaced by -<function>XtAppPending</function>. -<function>XtInitialize</function> +<xref linkend='XtAppPending' xrefstyle='select: title'/>. +<xref linkend='XtInitialize' xrefstyle='select: title'/> must be called before using this routine. </para> @@ -628,19 +628,19 @@ Specifies the parameter to be passed to <emphasis remap='I'>proc</emphasis> when </variablelist> <para> The -<function>XtAddInput</function> +<xref linkend='XtAddInput' xrefstyle='select: title'/> function registers in the default application context a new source of events, which is usually file input but can also be file output. (The word <emphasis remap='I'>file</emphasis> should be loosely interpreted to mean any sink or source of data.) -<function>XtAddInput</function> +<xref linkend='XtAddInput' xrefstyle='select: title'/> also specifies the conditions under which the source can generate events. When input is pending on this source in the default application context, the callback procedure is called. This routine has been replaced by -<function>XtAppAddInput</function>. -<function>XtInitialize</function> +<xref linkend='XtAppAddInput' xrefstyle='select: title'/>. +<xref linkend='XtInitialize' xrefstyle='select: title'/> must be called before using this routine. </para> @@ -687,15 +687,15 @@ Specifies the parameter to be passed to <emphasis remap='I'>proc</emphasis> when </variablelist> <para> The -<function>XtAddTimeOut</function> +<xref linkend='XtAddTimeOut' xrefstyle='select: title'/> function creates a timeout in the default application context and returns an identifier for it. The timeout value is set to <emphasis remap='I'>interval</emphasis>. The callback procedure will be called after the time interval elapses, after which the timeout is removed. This routine has been replaced by -<function>XtAppAddTimeOut</function>. -<function>XtInitialize</function> +<xref linkend='XtAppAddTimeOut' xrefstyle='select: title'/>. +<xref linkend='XtInitialize' xrefstyle='select: title'/> must be called before using this routine. </para> @@ -732,8 +732,8 @@ Client data to pass to <emphasis remap='I'>proc</emphasis> when it is called. <para> This routine registers a work procedure in the default application context. It has been replaced by -<function>XtAppAddWorkProc</function>. -<function>XtInitialize</function> +<xref linkend='XtAppAddWorkProc' xrefstyle='select: title'/>. +<xref linkend='XtInitialize' xrefstyle='select: title'/> must be called before using this routine. </para> @@ -794,20 +794,20 @@ Specifies the number of entries in <emphasis remap='I'>args</emphasis>. </variablelist> <para> The procedure -<function>XtCreateApplicationShell</function> +<xref linkend='XtCreateApplicationShell' xrefstyle='select: title'/> calls -<function>XtAppCreateShell</function> +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/> with <emphasis remap='I'>application_name</emphasis> NULL, the application class passed to -<function>XtInitialize</function>, +<xref linkend='XtInitialize' xrefstyle='select: title'/>, and the default application context created by -<function>XtInitialize</function>. +<xref linkend='XtInitialize' xrefstyle='select: title'/>. This routine has been replaced by -<function>XtAppCreateShell</function>. +<xref linkend='XtAppCreateShell' xrefstyle='select: title'/>. </para> <para> An old-format resource type converter procedure pointer is of type -<function>XtConverter</function>. +<xref linkend='XtConverter' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtConverter'> @@ -884,7 +884,7 @@ Attempt the type conversion. <para> If successful, return the size and pointer to the data in the <emphasis remap='I'>to</emphasis> argument; otherwise, call -<function>XtWarningMsg</function> +<xref linkend='XtWarningMsg' xrefstyle='select: title'/> and return without modifying the <emphasis remap='I'>to</emphasis> argument. </para> </listitem> @@ -907,14 +907,14 @@ It should be a pointer to a static variable. <para> The procedure type -<function>XtConverter</function> +<xref linkend='XtConverter' xrefstyle='select: title'/> has been replaced by -<function>XtTypeConverter</function>. +<xref linkend='XtTypeConverter' xrefstyle='select: title'/>. </para> <para> The -<function>XtStringConversionWarning</function> +<xref linkend='XtStringConversionWarning' xrefstyle='select: title'/> function is a convenience routine for old-format resource converters that convert from strings. </para> @@ -950,19 +950,19 @@ Specifies the name of the type to which the string could not be converted. </variablelist> <para> The -<function>XtStringConversionWarning</function> +<xref linkend='XtStringConversionWarning' xrefstyle='select: title'/> function issues a warning message with name "conversionError", type "string", class "XtToolkitError, and the default message string "Cannot convert "<emphasis remap='I'>src</emphasis>" to type <emphasis remap='I'>dst_type</emphasis>". This routine has been superseded by -<function>XtDisplayStringConversionWarning</function>. +<xref linkend='XtDisplayStringConversionWarning' xrefstyle='select: title'/>. </para> <para> To register an old-format converter, use -<function>XtAddConverter</function> +<xref linkend='XtAddConverter' xrefstyle='select: title'/> or -<function>XtAppAddConverter</function>. +<xref linkend='XtAppAddConverter' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAddConverter'> @@ -1029,13 +1029,13 @@ Specifies the number of entries in <emphasis remap='I'>convert_args</emphasis>. </varlistentry> </variablelist> <para> -<function>XtAddConverter</function> +<xref linkend='XtAddConverter' xrefstyle='select: title'/> is equivalent in function to -<function>XtSetTypeConverter</function> +<xref linkend='XtSetTypeConverter' xrefstyle='select: title'/> with <emphasis remap='I'>cache_type</emphasis> equal to <function>XtCacheAll</function> for old-format type converters. It has been superseded by -<function>XtSetTypeConverter</function>. +<xref linkend='XtSetTypeConverter' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAppAddConverter'> @@ -1113,20 +1113,20 @@ Specifies the number of entries in <emphasis remap='I'>convert_args</emphasis>. </varlistentry> </variablelist> <para> -<function>XtAppAddConverter</function> +<xref linkend='XtAppAddConverter' xrefstyle='select: title'/> is equivalent in function to -<function>XtAppSetTypeConverter</function> +<xref linkend='XtAppSetTypeConverter' xrefstyle='select: title'/> with <emphasis remap='I'>cache_type</emphasis> equal to <function>XtCacheAll</function> for old-format type converters. It has been superseded by -<function>XtAppSetTypeConverter</function>. +<xref linkend='XtAppSetTypeConverter' xrefstyle='select: title'/>. </para> <para> To invoke resource conversions, a client may use -<function>XtConvert</function> +<xref linkend='XtConvert' xrefstyle='select: title'/> or, for old-format converters only, -<function>XtDirectConvert</function>. +<xref linkend='XtDirectConvert' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtConvert'> @@ -1260,14 +1260,14 @@ Returns the converted value. </variablelist> <para> The -<function>XtConvert</function> +<xref linkend='XtConvert' 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>XtDirectConvert</function> +<xref linkend='XtDirectConvert' xrefstyle='select: title'/> or -<function>XtCallConverter</function>. +<xref linkend='XtCallConverter' xrefstyle='select: title'/>. The -<function>XtDirectConvert</function> +<xref linkend='XtDirectConvert' xrefstyle='select: title'/> function looks in the converter cache to see if this conversion procedure has been called with the specified arguments. If so, it returns a descriptor for information stored in the cache; @@ -1276,29 +1276,29 @@ otherwise, it calls the converter and enters the result in the cache. <para> Before calling the specified converter, -<function>XtDirectConvert</function> +<xref linkend='XtDirectConvert' xrefstyle='select: title'/> sets the return value size to zero and the return value address to NULL. To determine if the conversion was successful, the client should check <emphasis remap='I'>to_return.addr</emphasis> for non-NULL. The data returned by -<function>XtConvert</function> +<xref linkend='XtConvert' xrefstyle='select: title'/> must be copied immediately by the caller, as it may point to static data in the type converter. </para> <para> -<function>XtConvert</function> +<xref linkend='XtConvert' xrefstyle='select: title'/> has been replaced by -<function>XtConvertAndStore</function>, +<xref linkend='XtConvertAndStore' xrefstyle='select: title'/>, and -<function>XtDirectConvert</function> +<xref linkend='XtDirectConvert' xrefstyle='select: title'/> has been superseded by -<function>XtCallConverter</function>. +<xref linkend='XtCallConverter' xrefstyle='select: title'/>. </para> <para> To deallocate a shared GC when it is no longer needed, use -<function>XtDestroyGC</function>. +<xref linkend='XtDestroyGC' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtDestroyGC'> @@ -1336,18 +1336,18 @@ Specifies the shared GC to be deallocated. References to sharable GCs are counted and a free request is generated to the server when the last user of a given GC destroys it. Note that some earlier versions of -<function>XtDestroyGC</function> +<xref linkend='XtDestroyGC' xrefstyle='select: title'/> had only a <emphasis remap='I'>gc</emphasis> argument. Therefore, this function is not very portable, and you are encouraged to use -<function>XtReleaseGC</function> +<xref linkend='XtReleaseGC' xrefstyle='select: title'/> instead. </para> <para> To declare an action table in the default application context and register it with the translation manager, use -<function>XtAddActions</function>. +<xref linkend='XtAddActions' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtAddActions'> @@ -1386,19 +1386,19 @@ the most recently registered action is used. If duplicate actions exist in an action table, the first is used. The Intrinsics register an action table for -<function>XtMenuPopup</function> +<xref linkend='XtMenuPopup' xrefstyle='select: title'/> and -<function>XtMenuPopdown</function> +<xref linkend='XtMenuPopdown' xrefstyle='select: title'/> as part of X Toolkit initialization. This routine has been replaced by -<function>XtAppAddActions</function>. -<function>XtInitialize</function> +<xref linkend='XtAppAddActions' xrefstyle='select: title'/>. +<xref linkend='XtInitialize' xrefstyle='select: title'/> must be called before using this routine. </para> <para> To set the Intrinsics selection timeout in the default application context, use -<function>XtSetSelectionTimeout</function>. +<xref linkend='XtSetSelectionTimeout' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetSelectionTimeout'> @@ -1418,8 +1418,8 @@ To set the Intrinsics selection timeout in the default application context, use <para> Specifies the selection timeout in milliseconds. This routine has been replaced by -<function>XtAppSetSelectionTimeout</function>. -<function>XtInitialize</function> +<xref linkend='XtAppSetSelectionTimeout' xrefstyle='select: title'/>. +<xref linkend='XtInitialize' xrefstyle='select: title'/> must be called before using this routine. </para> </listitem> @@ -1429,7 +1429,7 @@ must be called before using this routine. <para> To get the current selection timeout value in the default application context, use -<function>XtGetSelectionTimeout</function>. +<xref linkend='XtGetSelectionTimeout' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetSelectionTimeout'> @@ -1448,15 +1448,15 @@ the Intrinsics abort the selection request. <para> This routine has been replaced by -<function>XtAppGetSelectionTimeout</function>. -<function>XtInitialize</function> +<xref linkend='XtAppGetSelectionTimeout' xrefstyle='select: title'/>. +<xref linkend='XtInitialize' xrefstyle='select: title'/> must be called before using this routine. </para> <para> To obtain the global error database (for example, to merge with an application- or widget-specific database), use -<function>XtGetErrorDatabase</function>. +<xref linkend='XtGetErrorDatabase' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetErrorDatabase'> @@ -1468,19 +1468,19 @@ an application- or widget-specific database), use <para> The -<function>XtGetErrorDatabase</function> +<xref linkend='XtGetErrorDatabase' xrefstyle='select: title'/> function returns the address of the error database. The Intrinsics do a lazy binding of the error database and do not merge in the database file until the first call to <function>XtGetErrorDatbaseText</function>. This routine has been replaced by -<function>XtAppGetErrorDatabase</function>. +<xref linkend='XtAppGetErrorDatabase' xrefstyle='select: title'/>. </para> <para> An error message handler can obtain the error database text for an error or a warning by calling -<function>XtGetErrorDatabaseText</function>. +<xref linkend='XtGetErrorDatabaseText' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtGetErrorDatabaseText'> @@ -1556,7 +1556,7 @@ Specifies the size of the buffer in bytes. </variablelist> <para> The -<function>XtGetErrorDatabaseText</function> +<xref linkend='XtGetErrorDatabaseText' xrefstyle='select: title'/> returns the appropriate message from the error database associated with the default application context or returns the specified default message if one is not found in the @@ -1566,12 +1566,12 @@ the <emphasis remap='I'>name</emphasis> and <emphasis remap='I'>type</emphasis> between them and the <emphasis remap='I'>class</emphasis> is concatenated with itself with a single "." if it does not already contain a ".". This routine has been superseded by -<function>XtAppGetErrorDatabaseText</function>. +<xref linkend='XtAppGetErrorDatabaseText' xrefstyle='select: title'/>. </para> <para> To register a procedure to be called on fatal error conditions, use -<function>XtSetErrorMsgHandler</function>. +<xref linkend='XtSetErrorMsgHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetErrorMsgHandler'> @@ -1596,17 +1596,17 @@ Specifies the new fatal error procedure, which should not return. <para> The default error handler provided by the Intrinsics constructs a string from the error resource database and calls -<function>XtError</function>. +<xref linkend='XtError' xrefstyle='select: title'/>. Fatal error message handlers should not return. If one does, subsequent Intrinsics behavior is undefined. This routine has been superseded by -<function>XtAppSetErrorMsgHandler</function>. +<xref linkend='XtAppSetErrorMsgHandler' xrefstyle='select: title'/>. </para> <para> To call the high-level error handler, use -<function>XtErrorMsg</function>. +<xref linkend='XtErrorMsg' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtErrorMsg'> @@ -1685,12 +1685,12 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </variablelist> <para> This routine has been superseded by -<function>XtAppErrorMsg</function>. +<xref linkend='XtAppErrorMsg' xrefstyle='select: title'/>. </para> <para> To register a procedure to be called on nonfatal error conditions, use -<function>XtSetWarningMsgHandler</function>. +<xref linkend='XtSetWarningMsgHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetWarningMsgHandler'> @@ -1715,14 +1715,14 @@ Specifies the new nonfatal error procedure, which usually returns. <para> The default warning handler provided by the Intrinsics constructs a string from the error resource database and calls -<function>XtWarning</function>. +<xref linkend='XtWarning' xrefstyle='select: title'/>. This routine has been superseded by -<function>XtAppSetWarningMsgHandler</function>. +<xref linkend='XtAppSetWarningMsgHandler' xrefstyle='select: title'/>. </para> <para> To call the installed high-level warning handler, use -<function>XtWarningMsg</function>. +<xref linkend='XtWarningMsg' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtWarningMsg'> @@ -1801,12 +1801,12 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </variablelist> <para> This routine has been superseded by -<function>XtAppWarningMsg</function>. +<xref linkend='XtAppWarningMsg' xrefstyle='select: title'/>. </para> <para> To register a procedure to be called on fatal error conditions, use -<function>XtSetErrorHandler</function>. +<xref linkend='XtSetErrorHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetErrorHandler'> @@ -1837,12 +1837,12 @@ Fatal error message handlers should not return. If one does, subsequent X Toolkit behavior is undefined. This routine has been superseded by -<function>XtAppSetErrorHandler</function>. +<xref linkend='XtAppSetErrorHandler' xrefstyle='select: title'/>. </para> <para> To call the installed fatal error procedure, use -<function>XtError</function>. +<xref linkend='XtError' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtError'> @@ -1866,17 +1866,17 @@ Specifies the message to be reported. </variablelist> <para> Most programs should use -<function>XtAppErrorMsg</function>, +<xref linkend='XtAppErrorMsg' xrefstyle='select: title'/>, not -<function>XtError</function>, +<xref linkend='XtError' xrefstyle='select: title'/>, to provide for customization and internationalization of error messages. This routine has been superseded by -<function>XtAppError</function>. +<xref linkend='XtAppError' xrefstyle='select: title'/>. </para> <para> To register a procedure to be called on nonfatal error conditions, use -<function>XtSetWarningHandler</function>. +<xref linkend='XtSetWarningHandler' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtSetWarningHandler'> @@ -1904,12 +1904,12 @@ The default warning handler provided by the Intrinsics is On POSIX-based systems, it prints the message to standard error and returns to the caller. This routine has been superseded by -<function>XtAppSetWarningHandler</function>. +<xref linkend='XtAppSetWarningHandler' xrefstyle='select: title'/>. </para> <para> To call the installed nonfatal error procedure, use -<function>XtWarning</function>. +<xref linkend='XtWarning' xrefstyle='select: title'/>. </para> <funcsynopsis id='XtWarning'> @@ -1933,11 +1933,11 @@ Specifies the nonfatal error message to be reported. </variablelist> <para> Most programs should use -<function>XtAppWarningMsg</function>, +<xref linkend='XtAppWarningMsg' xrefstyle='select: title'/>, not -<function>XtWarning</function>, +<xref linkend='XtWarning' xrefstyle='select: title'/>, to provide for customization and internationalization of warning messages. This routine has been superseded by -<function>XtAppWarning</function>. +<xref linkend='XtAppWarning' xrefstyle='select: title'/>. </para> </appendix> diff --git a/specs/appF.xml b/specs/appF.xml index 1bfcec1..3af47d9 100755 --- a/specs/appF.xml +++ b/specs/appF.xml @@ -86,7 +86,7 @@ When setting the application's resource, the event handler calls functions to walk the application's widget tree, determining which widgets are affected by the resource string, and then applying the value with -<function>XtSetValues</function>. +<xref linkend='XtSetValues' xrefstyle='select: title'/>. As the widget tree is recursively descended, at each level in the widget tree a resource part is tested for a match. When the entire resource string has been matched, the value is applied |