diff options
| author | Matt Dew <marcoz@osource.org> | 2011-11-12 02:00:18 -0700 |
|---|---|---|
| committer | Matt Dew <marcoz@osource.org> | 2011-11-12 02:00:18 -0700 |
| commit | 00a7cab4f611bf3ae3920ea0ce8bd072db7f44c8 (patch) | |
| tree | 5f255c315d7541314a671c330c11739b8f695176 | |
| parent | d97b7c1402c9843d3b038f8aa665ef48e4443be2 (diff) | |
added refentry grouping
| -rw-r--r--[-rwxr-xr-x] | specs/CH01.xml | 45 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH02.xml | 113 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH03.xml | 45 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH04.xml | 34 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH05.xml | 36 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH06.xml | 27 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH07.xml | 303 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH08.xml | 27 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH09.xml | 109 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH10.xml | 81 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH11.xml | 187 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH12.xml | 4 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/CH13.xml | 0 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/acknowledgement.xml | 0 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/appA.xml | 0 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/appB.xml | 6 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/appC.xml | 84 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/appD.xml | 4 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/appE.xml | 24 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/appF.xml | 0 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/intrinsics.xml | 0 | ||||
| -rw-r--r--[-rwxr-xr-x] | specs/preface.xml | 0 |
22 files changed, 951 insertions, 178 deletions
diff --git a/specs/CH01.xml b/specs/CH01.xml index 1f15d39..7223299 100755..100644 --- a/specs/CH01.xml +++ b/specs/CH01.xml @@ -378,18 +378,22 @@ The resource names, classes, and representation types specified in the <function>coreClassRec</function> resource list are </para> -<informaltable frame='topbot'> + +<informaltable frame='topbot' tabstyle='simpleheadertable'> + <?dbhtml class="simpleheadertable_B"?> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colname='c1' colwidth='1.0*'/> <colspec colname='c2' colwidth='1.0*'/> <colspec colname='c3' colwidth='1.0*'/> - <tbody> + <thead> <row rowsep='1'> <entry>Name</entry> <entry>Class</entry> <entry>Representation</entry> </row> + </thead> + <tbody> <row> <entry>XtNaccelerators</entry> <entry>XtCAccelerators</entry> @@ -457,7 +461,7 @@ resource lists; see <xref linkend='Object_Objects' /> and <xref linkend='Rectang The default values for the Core fields, which are filled in by the Intrinsics, from the resource lists, and by the initialize procedures, are </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colname='c1' colwidth='0.4*'/> @@ -755,7 +759,7 @@ the resource list are </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colname='c1' colwidth='1.0*'/> @@ -800,7 +804,7 @@ Composite initialize procedure, are </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <?dbfo table-width="50%" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> @@ -1821,12 +1825,13 @@ To obtain the class of a widget, use <xref linkend='XtClass' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtClass'> -<funcprototype> - <funcdef>WidgetClass <function>XtClass</function></funcdef> - <paramdef>Widget<parameter> w</parameter></paramdef> -</funcprototype> -</funcsynopsis> + <funcprototype> + <funcdef>WidgetClass <function>XtClass</function></funcdef> + <paramdef>Widget<parameter> w</parameter></paramdef> + </funcprototype> + </funcsynopsis> <variablelist spacing='compact'> <varlistentry> @@ -1840,6 +1845,8 @@ Specifies the widget. Must be of class Object or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtClass' xrefstyle='select: title'/> @@ -1851,6 +1858,7 @@ To obtain the superclass of a widget, use <function>XtSuperclass</function>. </para> +<refentry> <funcsynopsis id='XtSuperClass'> <funcprototype> <funcdef>WidgetClass <function>XtSuperClass</function></funcdef> @@ -1870,6 +1878,8 @@ Specifies the widget. Must be of class Object or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <function>XtSuperclass</function> @@ -1884,6 +1894,7 @@ To check the subclass to which a widget belongs, use <xref linkend='XtIsSubclass' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtIsSubclass'> <funcprototype> <funcdef>Boolean <function>XtIsSubclass</function></funcdef> @@ -1914,6 +1925,8 @@ Specifies the widget class for which to test. (oC </listitem> </varlistentry> </variablelist> +</refentry> + <para> The @@ -1955,6 +1968,7 @@ and All these macros and functions have the same argument description. </para> +<refentry> <funcsynopsis id='XtIs'> <funcprototype> <funcdef>Boolean <function>XtIs</function></funcdef> @@ -1974,6 +1988,8 @@ Specifies the widget or object instance whose class is to be checked. Must be o </listitem> </varlistentry> </variablelist> +</refentry> + <para> These procedures may be faster than calling <xref linkend='XtIsSubclass' xrefstyle='select: title'/> @@ -1988,6 +2004,7 @@ defined in <function><X11/IntrinsicP.h></function>: </para> +<refentry> <funcsynopsis id='XtCheckSubclass'> <funcprototype> <funcdef>void <function>XtCheckSubclass</function></funcdef> @@ -2029,6 +2046,8 @@ Specifies the message to be used. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCheckSubclass' xrefstyle='select: title'/> @@ -2289,6 +2308,7 @@ To initialize a widget class without creating any widgets, use <xref linkend='XtInitializeWidgetClass' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtInitializeWidgetClass'> <funcprototype> <funcdef>void <function>XtInitializeWidgetClass</function></funcdef> @@ -2310,6 +2330,8 @@ or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If the specified widget class is already initialized, <xref linkend='XtInitializeWidgetClass' xrefstyle='select: title'/> @@ -2700,6 +2722,7 @@ To locate a class extension record, use <xref linkend='XtGetClassExtension' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetClassExtension'> <funcprototype> <funcdef>XtPointer <function>XtGetClassExtension</function></funcdef> @@ -2766,6 +2789,8 @@ extension record required for a match, or 0. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The list of extension records at the specified offset in the specified object class will be searched for a match on the specified type, diff --git a/specs/CH02.xml b/specs/CH02.xml index 0a67fce..eacf492 100755..100644 --- a/specs/CH02.xml +++ b/specs/CH02.xml @@ -214,6 +214,7 @@ remaining display connections in it, use <xref linkend='XtDestroyApplicationContext' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtDestroyApplicationContext'> <funcprototype> <funcdef>void <function>XtDestroyApplicationContext</function></funcdef> @@ -233,6 +234,8 @@ Specifies the application context. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtDestroyApplicationContext' xrefstyle='select: title'/> @@ -247,6 +250,7 @@ To get the application context in which a given widget was created, use <xref linkend='XtWidgetToApplicationContext' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtWidgetToApplicationContext'> <funcprototype> <funcdef>XtAppContext <function>XtWidgetToApplicationContext</function></funcdef> @@ -266,6 +270,8 @@ Specifies the widget for which you want the application context. Must be of cla </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtWidgetToApplicationContext' xrefstyle='select: title'/> @@ -277,6 +283,7 @@ To initialize a display and add it to an application context, use <xref linkend='XtDisplayInitialize' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtDisplayInitialize'> <funcprototype> <funcdef>void <function>XtDisplayInitialize</function></funcdef> @@ -379,6 +386,8 @@ Specifies the list of command line parameters. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtDisplayInitialize' xrefstyle='select: title'/> @@ -427,6 +436,7 @@ add it to an application context, use <xref linkend='XtOpenDisplay' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtOpenDisplay'> <funcprototype> <funcdef>Display <function>*XtOpenDisplay</function></funcdef> @@ -529,6 +539,8 @@ Specifies the list of command line parameters. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtOpenDisplay' xrefstyle='select: title'/> @@ -583,6 +595,7 @@ To close a display and remove it from an application context, use <xref linkend='XtCloseDisplay' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCloseDisplay'> <funcprototype> <funcdef>void <function>XtCloseDisplay</function></funcdef> @@ -602,6 +615,8 @@ Specifies the display. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCloseDisplay' xrefstyle='select: title'/> @@ -703,6 +718,7 @@ use <function>XtSetLanguageProc</function>. </para> +<refentry> <funcsynopsis> <funcprototype> <funcdef>XtLanguageProc <function>XtSetLanguageProc</function></funcdef> @@ -746,6 +762,8 @@ procedure when it is called. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <function>XtSetLanguageProc</function> sets the language procedure that will be called from @@ -1079,6 +1097,7 @@ To obtain the resource database for a particular screen, use <xref linkend='XtScreenDatabase' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtScreenDatabase'> <funcprototype> <funcdef>XrmDatabase <function>XtScreenDatabase</function></funcdef> @@ -1099,6 +1118,8 @@ Specifies the screen whose resource database is to be returned. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtScreenDatabase' xrefstyle='select: title'/> @@ -1117,6 +1138,7 @@ To obtain the default resource database associated with a particular display, us </para> +<refentry> <funcsynopsis id='XtDatabase'> <funcprototype> <funcdef>XrmDatabase <function>XtDatabase</function></funcdef> @@ -1137,6 +1159,8 @@ Specifies the display. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtDatabase' xrefstyle='select: title'/> @@ -1154,6 +1178,7 @@ use <xref linkend='XtAppSetFallbackResources' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppSetFallbackResources'> <funcprototype> <funcdef>void <function>XtAppSetFallbackResources</function></funcdef> @@ -1187,6 +1212,8 @@ the database, or NULL. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Each entry in <emphasis remap='I'>specification_list</emphasis> points to a string in the format of <function>XrmPutLineResource</function>. @@ -1283,7 +1310,7 @@ typedef struct { </literallayout> <para>The standard table contains the following entries:</para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='4' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1626,6 +1653,7 @@ use <xref linkend='XtSetArg' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetArg'> <funcprototype> <funcdef>void <function>XtSetArg</function></funcdef> @@ -1670,6 +1698,8 @@ else the address. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtSetArg' xrefstyle='select: title'/> @@ -1711,6 +1741,7 @@ arglist arrays, use <xref linkend='XtMergeArgLists' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtMergeArgLists'> <funcprototype> <funcdef>ArgList <function>XtMergeArgLists</function></funcdef> @@ -1764,6 +1795,8 @@ Specifies the number of entries in the second argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtMergeArgLists' xrefstyle='select: title'/> @@ -1864,6 +1897,7 @@ in multiple calls, use typedef XtPointer XtVarArgsList; </literallayout> +<refentry> <funcsynopsis id='XtVaCreateArgsList'> <funcprototype> <funcdef>XtVarArgsList <function>XtVaCreateArgsList</function></funcdef> @@ -1895,6 +1929,8 @@ name and value pairs. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtVaCreateArgsList' xrefstyle='select: title'/> @@ -1928,6 +1964,7 @@ To create an instance of a widget, use <xref linkend='XtCreateWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCreateWidget'> <funcprototype> <funcdef>Widget <function>XtCreateWidget</function></funcdef> @@ -1995,6 +2032,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCreateWidget' xrefstyle='select: title'/> @@ -2108,6 +2147,7 @@ To create an instance of a widget using varargs lists, use <xref linkend='XtVaCreateWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaCreateWidget'> <funcprototype> <funcdef>Widget <function>XtVaCreateWidget</function></funcdef> @@ -2162,6 +2202,8 @@ resource specifications. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtVaCreateWidget' xrefstyle='select: title'/> @@ -2184,6 +2226,7 @@ An application uses to create independent widget trees. </para> +<refentry> <funcsynopsis id='XtAppCreateShell'> <funcprototype> <funcdef>Widget <function>XtAppCreateShell</function></funcdef> @@ -2270,6 +2313,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppCreateShell' xrefstyle='select: title'/> @@ -2355,6 +2400,7 @@ varargs lists, use <xref linkend='XtVaAppCreateShell' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaAppCreateShell'> <funcprototype> <funcdef>Widget <function>XtVaAppCreateShell</function></funcdef> @@ -2428,6 +2474,8 @@ resource specifications. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtVaAppCreateShell' xrefstyle='select: title'/> @@ -2449,6 +2497,7 @@ or <xref linkend='XtVaOpenApplication' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtOpenApplication'> <funcprototype> <funcdef>Widget <function>XtOpenApplication</function></funcdef> @@ -2570,6 +2619,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtOpenApplication' xrefstyle='select: title'/> @@ -2603,6 +2654,7 @@ is called with the value prior to calling <xref linkend='XtOpenDisplay' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaOpenApplication'> <funcprototype> <funcdef>Widget <function>XtVaOpenApplication</function></funcdef> @@ -2712,6 +2764,8 @@ resource specifications for the created shell. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtVaOpenApplication' xrefstyle='select: title'/> @@ -2753,6 +2807,7 @@ record is of type <xref linkend='XtAllocateProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAllocateProc'> <funcprototype> <funcdef>typedef void <function>(*AllocateProc)</function></funcdef> @@ -2861,6 +2916,8 @@ if requested and an error occurred; otherwise, unchanged. </listitem> </varlistentry> </variablelist> +</refentry> + <para> At widget allocation time, if an extension record with <emphasis remap='I'>record_type</emphasis> equal to @@ -2930,6 +2987,7 @@ The initialize procedure pointer in a widget class is of type <xref linkend='XtInitProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtInitProc'> <funcprototype> <funcdef>typedef void <function>(*XtInitProc)</function></funcdef> @@ -2992,6 +3050,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> An initialization procedure performs the following: </para> @@ -3163,6 +3223,7 @@ The initialize_hook procedure pointer is of type <xref linkend='XtArgsProc' xrefstyle='select: title'/>: </para> +<refentry> <funcsynopsis id='XtArgsProc'> <funcprototype> <funcdef>typedef void<function>(*XtArgsProc)</function></funcdef> @@ -3211,6 +3272,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If this procedure is not NULL, it is called immediately after the corresponding initialize @@ -3232,6 +3295,7 @@ To realize a widget instance, use <xref linkend='XtRealizeWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRealizeWidget'> <funcprototype> <funcdef>void <function>XtRealizeWidget</function></funcdef> @@ -3251,6 +3315,8 @@ Specifies the widget. Must be of class Core or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If the widget is already realized, <xref linkend='XtRealizeWidget' xrefstyle='select: title'/> @@ -3369,6 +3435,7 @@ To check whether or not a widget has been realized, use <xref linkend='XtIsRealized' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtIsRealized'> <funcprototype> <funcdef>Boolean <function>XtIsRealized</function></funcdef> @@ -3388,6 +3455,8 @@ Specifies the widget. Must be of class Object or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtIsRealized' xrefstyle='select: title'/> @@ -3411,6 +3480,7 @@ The realize procedure pointer in a widget class is of type <xref linkend='XtRealizeProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRealizeProc'> <funcprototype> <funcdef>typedef void <function>(*XtRealizeProc)</function></funcdef> @@ -3454,6 +3524,8 @@ call. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The realize procedure must create the widget's window. </para> @@ -3585,6 +3657,7 @@ function explicitly, a realize procedure should normally call the Intrinsics ana which simplifies the creation of windows for widgets. </para> +<refentry> <funcsynopsis id='XtCreateWindow'> <funcprototype> <funcdef>void <function>XtCreateWindow</function></funcdef> @@ -3655,6 +3728,8 @@ call. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCreateWindow' xrefstyle='select: title'/> @@ -3690,6 +3765,7 @@ and window of a widget are available to the widget writer by means of macros and to the application writer by means of functions. </para> +<refentry> <funcsynopsis> <funcprototype> <funcdef>Display <function>XtDisplay</function></funcdef> @@ -3709,11 +3785,14 @@ Specifies the widget. Must be of class Core or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <function>XtDisplay</function> returns the display pointer for the specified widget. </para> +<refentry> <funcsynopsis> <funcprototype> <funcdef>Widget <function>XtParent</function></funcdef> @@ -3733,12 +3812,15 @@ Specifies the widget. Must be of class Object or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <function>XtParent</function> returns the parent object for the specified widget. The returned object will be of class Object or a subclass. </para> +<refentry> <funcsynopsis id='XtScreen'> <funcprototype> <funcdef>Screen <function>*XtScreen</function></funcdef> @@ -3758,11 +3840,14 @@ Specifies the widget. Must be of class Core or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtScreen' xrefstyle='select: title'/> returns the screen pointer for the specified widget. </para> +<refentry> <funcsynopsis id='XtWindow'> <funcprototype> <funcdef>Window <function>XtWindow</function></funcdef> @@ -3782,6 +3867,8 @@ Specifies the widget. Must be of class Core or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtWindow' xrefstyle='select: title'/> returns the window of the specified widget. @@ -3797,6 +3884,7 @@ and <xref linkend='XtWindowOfObject' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtDisplayOfObject'> <funcprototype> <funcdef>Display <function>*XtDisplayOfObject</function></funcdef> @@ -3816,6 +3904,8 @@ Specifies the object. Must be of class Object or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtDisplayOfObject' xrefstyle='select: title'/> is identical in function to @@ -3827,6 +3917,7 @@ pointer for the nearest ancestor of <emphasis remap='I'>object</emphasis> that i Widget or a subclass thereof. </para> +<refentry> <funcsynopsis id='XtScreenOfObject'> <funcprototype> <funcdef>Screen <function>*XtScreenOfObject</function></funcdef> @@ -3847,6 +3938,8 @@ Specifies the object. Must be of class Object or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtScreenOfObject' xrefstyle='select: title'/> is identical in function to @@ -3858,6 +3951,7 @@ for the nearest ancestor of <emphasis remap='I'>object</emphasis> that is of cla Widget or a subclass thereof. </para> +<refentry> <funcsynopsis id='XtWindowOfObject'> <funcprototype> <funcdef>Window <function>XtWindowOfObject</function></funcdef> @@ -3877,6 +3971,8 @@ Specifies the object. Must be of class Object or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtWindowOfObject' xrefstyle='select: title'/> is identical in function to @@ -3892,6 +3988,7 @@ To retrieve the instance name of an object, use <xref linkend='XtName' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtName'> <funcprototype> <funcdef>String <function>XtName</function></funcdef> @@ -3911,6 +4008,8 @@ Specifies the object whose name is desired. Must be of class Object or any subc </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtName' xrefstyle='select: title'/> returns a pointer to the instance name of the specified object. @@ -3961,6 +4060,7 @@ non-pop-up descendants, use <xref linkend='XtUnrealizeWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtUnrealizeWidget'> <funcprototype> <funcdef>void <function>XtUnrealizeWidget</function></funcdef> @@ -3980,6 +4080,8 @@ Specifies the widget. Must be of class Core or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If the widget is currently unrealized, <xref linkend='XtUnrealizeWidget' xrefstyle='select: title'/> @@ -4060,6 +4162,7 @@ To destroy a widget instance, use </para> +<refentry> <funcsynopsis id='XtDestroyWidget'> <funcprototype> <funcdef>void <function>XtDestroyWidget</function></funcdef> @@ -4079,6 +4182,8 @@ Specifies the widget. Must be of class Object or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtDestroyWidget' xrefstyle='select: title'/> @@ -4265,6 +4370,7 @@ structures are of type <xref linkend='XtWidgetProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtWidgetProc'> <funcprototype> <funcdef>typedef void <function>XtWidgetProc</function></funcdef> @@ -4284,6 +4390,8 @@ Specifies the widget being destroyed. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The destroy procedures are called in subclass-to-superclass order. Therefore, a widget's destroy procedure should deallocate only storage @@ -4400,6 +4508,7 @@ record is of type <function>XtDeallocateProc</function>. </para> +<refentry> <funcsynopsis> <funcprototype> <funcdef>typedef void <function>(*XtDeallocateProc)</function></funcdef> @@ -4431,6 +4540,8 @@ along with the widget, or NULL. </listitem> </varlistentry> </variablelist> +</refentry> + <para> When a widget is destroyed, if an <function>ObjectClassExtension</function> diff --git a/specs/CH03.xml b/specs/CH03.xml index 390bb4f..81cdd10 100755..100644 --- a/specs/CH03.xml +++ b/specs/CH03.xml @@ -157,6 +157,7 @@ The insert_child procedure pointer in a composite widget is of type <xref linkend='XtWidgetProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtWidgetProc_2'> <funcprototype> <funcdef>typedef void <function>(*XtWidgetProc)</function></funcdef> @@ -176,6 +177,8 @@ Passes the newly created child. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Most composite widgets inherit their superclass's operation. The insert_child routine in @@ -237,6 +240,7 @@ The insert_position procedure pointer in a composite widget instance is of type <xref linkend='XtOrderProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtOrderProc'> <funcprototype> <funcdef>typedef Cardinal <function>(*XtOrderProc)</function></funcdef> @@ -257,6 +261,8 @@ Passes the newly created widget. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Composite widgets that allow clients to order their children (usually homogeneous boxes) can call their widget instance's insert_position @@ -290,6 +296,7 @@ The delete_child procedure pointer is of type <xref linkend='XtWidgetProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='_XtWidgetProc'> <funcprototype> <funcdef>typedef void <function>(*XtWidgetProc)</function></funcdef> @@ -309,6 +316,8 @@ Passes the child being deleted. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Most widgets inherit the delete_child procedure from their superclass. @@ -340,6 +349,7 @@ subset of their Composite parent, use <para>typedef Widget *WidgetList;</para> +<refentry> <funcsynopsis id='XtManageChildren'> <funcprototype> <funcdef>void <function>XtManageChildren</function></funcdef> @@ -371,6 +381,8 @@ Specifies the number of children in the list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtManageChildren' xrefstyle='select: title'/> @@ -463,6 +475,7 @@ To add a single child to its parent widget's set of managed children, use <xref linkend='XtManageChild' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtManageChild'> <funcprototype> <funcdef>void <function>XtManageChild</function></funcdef> @@ -482,6 +495,8 @@ Specifies the child. Must be of class RectObj or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtManageChild' xrefstyle='select: title'/> @@ -498,6 +513,7 @@ or <xref linkend='XtVaCreateManagedWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCreateManagedWidget'> <funcprototype> <funcdef>Widget <function>XtCreateManagedWidget</function></funcdef> @@ -562,6 +578,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCreateManagedWidget' xrefstyle='select: title'/> @@ -571,6 +589,7 @@ and <xref linkend='XtManageChild' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaCreateManagedWidget'> <funcprototype> <funcdef>Widget <function>XtVaCreateManagedWidget</function></funcdef> @@ -624,6 +643,8 @@ resource specifications. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtVaCreateManagedWidget' xrefstyle='select: title'/> is identical in function to @@ -640,6 +661,7 @@ To remove a list of children from a parent widget's managed list, use <xref linkend='XtUnmanageChildren' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtUnmanageChildren'> <funcprototype> <funcdef>void <function>XtUnmanageChildren</function></funcdef> @@ -671,6 +693,8 @@ Specifies the number of children. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtUnmanageChildren' xrefstyle='select: title'/> @@ -735,6 +759,7 @@ To remove a single child from its parent widget's managed set, use <xref linkend='XtUnmanageChild' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtUnmanageChild'> <funcprototype> <funcdef>void <function>XtUnmanageChild</function></funcdef> @@ -754,6 +779,8 @@ Specifies the child. Must be of class RectObj or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtUnmanageChild' xrefstyle='select: title'/> @@ -788,6 +815,7 @@ set of children of a composite parent, use <xref linkend='XtChangeManagedSet' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtChangeManagedSet'> <funcprototype> <funcdef>void <function>XtChangeManagedSet</function></funcdef> @@ -863,6 +891,8 @@ Specifies the number of entries in the <emphasis remap='I'>manage_children</emph </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtChangeManagedSet' xrefstyle='select: title'/> @@ -993,6 +1023,7 @@ The <emphasis remap='I'>do_change_proc</emphasis> is of type <xref linkend='XtDoChangeProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtDoChangeProc'> <funcprototype> <funcdef>typedef void <function>*XtDoChangeProc</function></funcdef> @@ -1069,6 +1100,8 @@ Passes the client data passed to </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <emphasis remap='I'>do_change_proc</emphasis> procedure is used by the caller of <xref linkend='XtChangeManagedSet' xrefstyle='select: title'/> @@ -1093,6 +1126,7 @@ To determine the managed state of a given child widget, use <xref linkend='XtIsManaged' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtIsManaged'> <funcprototype> <funcdef>Boolean <function>XtIsManaged</function></funcdef> @@ -1112,6 +1146,8 @@ Specifies the widget. Must be of class Object or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtIsManaged' xrefstyle='select: title'/> @@ -1141,6 +1177,7 @@ To change the value of a given widget's <emphasis remap='I'>map_when_managed</em <xref linkend='XtSetMappedWhenManaged' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetMappedWhenManaged'> <funcprototype> <funcdef>void <function>XtSetMappedWhenManaged</function></funcdef> @@ -1173,6 +1210,8 @@ field. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If the widget is realized and managed, and if <emphasis remap='I'>map_when_managed</emphasis> is @@ -1206,6 +1245,7 @@ To map a widget explicitly, use <xref linkend='XtMapWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtMapWidget'> <funcprototype> <funcdef> <function>XtMapWidget</function></funcdef> @@ -1225,11 +1265,14 @@ Specifies the widget. Must be of class Core or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> To unmap a widget explicitly, use <xref linkend='XtUnmapWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtUnmapWidget'> <funcprototype> <funcdef> <function>XtUnmapWidget</function></funcdef> @@ -1249,6 +1292,8 @@ Specifies the widget. Must be of class Core or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + </sect1> diff --git a/specs/CH04.xml b/specs/CH04.xml index 17f386f..f8f3b62 100755..100644 --- a/specs/CH04.xml +++ b/specs/CH04.xml @@ -313,7 +313,7 @@ for generic operations on widgets whose class is a subclass of Shell. </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -670,7 +670,7 @@ the resource list are: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -741,7 +741,7 @@ the resource list are: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -919,7 +919,7 @@ The resource names, classes, and representation types that are specified in the resource list are: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -948,7 +948,7 @@ The resource names, classes, and representation types that are specified in the resource list are: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -987,7 +987,7 @@ The resource names, classes, and representation types that are specified in the resource list are: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1022,7 +1022,7 @@ in the resource list are: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1143,7 +1143,7 @@ Shell initialize procedures) are: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1306,7 +1306,7 @@ WMShell and its subclasses are: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1518,7 +1518,7 @@ a flag bit is set that refers to a field with the value the value of the field is modified as follows: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1594,7 +1594,7 @@ Transient shells have the following additional resource: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1633,7 +1633,7 @@ shells have the the following additional resources: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1711,7 +1711,7 @@ Application shells have the following additional resources: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1749,7 +1749,7 @@ which are filled in from the resource lists and by the initialize procedure, are </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -2177,6 +2177,7 @@ deferred outcome, use <xref linkend='XtSessionGetToken' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSessionGetToken'> <funcprototype> <funcdef>XtCheckpointToken <function>XtSessionGetToken</function></funcdef> @@ -2196,6 +2197,8 @@ Specifies the Session shell widget which manages session participation. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The @@ -2213,6 +2216,7 @@ To return a token, use <xref linkend='XtSessionReturnToken' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSessionReturnToken'> <funcprototype> <funcdef>void <function>XtSessionReturnToken</function></funcdef> @@ -2234,6 +2238,8 @@ on the interact callback list or a token that was received by a call to </listitem> </varlistentry> </variablelist> +</refentry> + <para> Tokens passed as <emphasis remap='I'>call_data</emphasis> to save callbacks are implicitly diff --git a/specs/CH05.xml b/specs/CH05.xml index 28db10e..0aa7ed6 100755..100644 --- a/specs/CH05.xml +++ b/specs/CH05.xml @@ -128,6 +128,7 @@ To create a pop-up shell, use <xref linkend='XtCreatePopupShell' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCreatePopupShell'> <funcprototype> <funcdef>Widget <function>XtCreatePopupShell</function></funcdef> @@ -191,6 +192,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCreatePopupShell' xrefstyle='select: title'/> @@ -236,6 +239,7 @@ To create a pop-up shell using varargs lists, use <xref linkend='XtVaCreatePopupShell' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaCreatePopupShell'> <funcprototype> <funcdef>Widget <function>XtVaCreatePopupShell</function></funcdef> @@ -287,6 +291,8 @@ resource specifications. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtVaCreatePopupShell' xrefstyle='select: title'/> @@ -399,6 +405,7 @@ in the shell widget instance record is of type <xref linkend='XtCreatePopupChildProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCreatePopupChildProc'> <funcprototype> <funcdef>void <function>*XtCreatePopupChildProc</function></funcdef> @@ -418,12 +425,15 @@ Specifies the shell widget being popped up. </listitem> </varlistentry> </variablelist> +</refentry> + <para> To map a pop-up from within an application, use <xref linkend='XtPopup' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtPopup'> <funcprototype> <funcdef>void <function>XtPopup</function></funcdef> @@ -454,6 +464,8 @@ Specifies the way in which user events should be constrained. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtPopup' xrefstyle='select: title'/> @@ -529,6 +541,7 @@ To map a spring-loaded pop-up from within an application, use <xref linkend='XtPopupSpringLoaded' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtPopupSpringLoaded'> <funcprototype> <funcdef>void <function>XtPopupSpringLoaded</function></funcdef> @@ -548,6 +561,8 @@ Specifies the shell widget to be popped up. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtPopupSpringLoaded' xrefstyle='select: title'/> @@ -574,6 +589,7 @@ convenience routines as callbacks, using the pop-up shell widget as the client data. </para> +<refentry> <funcsynopsis id='XtCallbackNone'> <funcprototype> <funcdef>void <function>XtCallbackNone</function></funcdef> @@ -616,7 +632,10 @@ which is not used by this procedure. </listitem> </varlistentry> </variablelist> +</refentry> + +<refentry> <funcsynopsis id='XtCallbackNonexclusive'> <funcprototype> <funcdef>void <function>XtCallbackNonexclusive</function></funcdef> @@ -659,7 +678,10 @@ which is not used by this procedure. </listitem> </varlistentry> </variablelist> +</refentry> + +<refentry> <funcsynopsis id='XtCallbackExclusive'> <funcprototype> <funcdef>void <function>XtCallbackExclusive</function></funcdef> @@ -702,6 +724,8 @@ which is not used by this procedure. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCallbackNone' xrefstyle='select: title'/>, @@ -743,6 +767,7 @@ From a translation writer's point of view, the definition for this translation action is </para> +<refentry> <funcsynopsis id='XtMenuPopup'> <funcprototype> <funcdef>void <function>XtMenuPopup</function></funcdef> @@ -762,6 +787,8 @@ Specifies the name of the shell widget to pop up. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtMenuPopup' xrefstyle='select: title'/> is known to the translation manager, @@ -846,6 +873,7 @@ To unmap a pop-up from within an application, use <xref linkend='XtPopdown' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtPopdown'> <funcprototype> <funcdef>void <function>XtPopdown</function></funcdef> @@ -865,6 +893,8 @@ Specifies the shell widget to pop down. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtPopdown' xrefstyle='select: title'/> @@ -924,6 +954,7 @@ To pop down a pop-up from a callback list, you may use the callback <xref linkend='XtCallbackPopdown' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCallbackPopdown'> <funcprototype> <funcdef>void <function>XtCallbackPopdown</function></funcdef> @@ -968,6 +999,8 @@ which is not used by this procedure. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCallbackPopdown' xrefstyle='select: title'/> @@ -1008,6 +1041,7 @@ From a translation writer's point of view, the definition for this translation action is </para> +<refentry> <funcsynopsis id='XtMenuPopdown'> <funcprototype> <funcdef>void <function>XtMenuPopdown</function></funcdef> @@ -1027,6 +1061,8 @@ Specifies the name of the shell widget to pop down. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If a shell name is not given, <xref linkend='XtMenuPopdown' xrefstyle='select: title'/> diff --git a/specs/CH06.xml b/specs/CH06.xml index 5d884d9..7af2b54 100755..100644 --- a/specs/CH06.xml +++ b/specs/CH06.xml @@ -138,6 +138,7 @@ To make a general geometry manager request from a widget, use <xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtMakeGeometryRequest'> <funcprototype> <funcdef>XtGeometryResult <function>XtMakeGeometryRequest</function></funcdef> @@ -182,6 +183,8 @@ if the requesting widget is not interested in handling </listitem> </varlistentry> </variablelist> +</refentry> + <para> Depending on the condition, @@ -455,6 +458,7 @@ as an alternative to <xref linkend='XtMakeGeometryRequest' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtMakeResizeRequest'> <funcprototype> <funcdef>typedef XtGeometryResult <function>XtMakeResizeRequest</function></funcdef> @@ -512,6 +516,8 @@ Return the allowed widget width and height. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The @@ -606,6 +612,7 @@ The geometry_manager procedure pointer in a composite widget class is of type <xref linkend='XtGeometryHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGeometryHandler'> <funcprototype> <funcdef>XtGeometryResult <function>*XtGeometryHandler</function></funcdef> @@ -648,6 +655,8 @@ compromise. </listitem> </varlistentry> </variablelist> +</refentry> + <para> A class can inherit its superclass's geometry manager during class initialization. @@ -821,6 +830,7 @@ the parent uses <xref linkend='XtMoveWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtMoveWidget'> <funcprototype> <funcdef>void <function>XtMoveWidget</function></funcdef> @@ -860,6 +870,8 @@ Specify the new widget x and y coordinates. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtMoveWidget' xrefstyle='select: title'/> @@ -879,6 +891,7 @@ the parent uses <xref linkend='XtResizeWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtResizeWidget'> <funcprototype> <funcdef>void <function>XtResizeWidget</function></funcdef> @@ -927,6 +940,8 @@ Specify the new widget size. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtResizeWidget' xrefstyle='select: title'/> @@ -952,6 +967,7 @@ the parent uses <xref linkend='XtConfigureWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtConfigureWidget'> <funcprototype> <funcdef>void <function>XtConfigureWidget</function></funcdef> @@ -1020,6 +1036,8 @@ Specify the new widget size. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtConfigureWidget' xrefstyle='select: title'/> @@ -1047,6 +1065,7 @@ height, and border width, the parent uses <xref linkend='XtResizeWindow' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtResizeWindow'> <funcprototype> <funcdef>void <function>XtResizeWindow</function></funcdef> @@ -1066,6 +1085,8 @@ Specifies the widget. Must be of class Core or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtResizeWindow' xrefstyle='select: title'/> @@ -1103,6 +1124,7 @@ To query a child widget's preferred geometry, use <xref linkend='XtQueryGeometry' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtQueryGeometry'> <funcprototype> <funcdef>XtGeometryResult <function>XtQueryGeometry</function></funcdef> @@ -1145,6 +1167,8 @@ Returns the child widget's preferred geometry. </listitem> </varlistentry> </variablelist> +</refentry> + <para> To discover a child's preferred geometry, the child's parent stores the new @@ -1195,6 +1219,7 @@ The query_geometry procedure pointer is of type <xref linkend='XtGeometryHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='_XtGeometryHandler'> <funcprototype> <funcdef>typedef XtGeometryResult <function>(*XtGeometryHandler)</function></funcdef> @@ -1236,6 +1261,8 @@ Passes a structure in which the child returns its preferred geometry. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The query_geometry procedure is expected to examine the bits set in <emphasis remap='I'>request->request_mode</emphasis>, evaluate the preferred geometry of the widget, diff --git a/specs/CH07.xml b/specs/CH07.xml index 54fce82..822abf1 100755..100644 --- a/specs/CH07.xml +++ b/specs/CH07.xml @@ -96,6 +96,7 @@ To register a new file as an input source for a given application context, use <xref linkend='XtAppAddInput' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppAddInput'> <funcprototype> <funcdef>XtInputId <function>XtAppAddInput</function></funcdef> @@ -162,6 +163,8 @@ when it is called. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppAddInput' xrefstyle='select: title'/> @@ -221,6 +224,7 @@ type <xref linkend='XtInputCallbackProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtInputCallbackProc'> <funcprototype> <funcdef>typedef void <function>(*XtInputCallbackProc)</function></funcdef> @@ -265,6 +269,8 @@ call. </listitem> </varlistentry> </variablelist> +</refentry> + <para> See <xref linkend='Using_the_Intrinsics_in_a_Multi_Threaded_Environment' /> for information regarding the use of @@ -277,6 +283,7 @@ To discontinue a source of input, use <xref linkend='XtRemoveInput' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveInput'> <funcprototype> <funcdef>void <function>XtRemoveInput</function></funcdef> @@ -298,6 +305,8 @@ call. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRemoveInput' xrefstyle='select: title'/> @@ -327,6 +336,7 @@ To register a hook that is called immediately prior to event blocking, use <xref linkend='XtAppAddBlockHook' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppAddBlockHook'> <funcprototype> <funcdef>XtBlockHookId <function>XtAppAddBlockHook</function></funcdef> @@ -368,6 +378,8 @@ Specifies an argument passed to the specified procedure when it is called. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppAddBlockHook' xrefstyle='select: title'/> @@ -382,6 +394,7 @@ are of type <xref linkend='XtBlockHookProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtBlockHookProc'> <funcprototype> <funcdef>void <function>*XtBlockHookProc</function></funcdef> @@ -402,11 +415,14 @@ Passes the client data argument that was registered for this procedure in </listitem> </varlistentry> </variablelist> +</refentry> + <para> To discontinue the use of a procedure for blocking notification, use <xref linkend='XtRemoveBlockHook' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveBlockHook'> <funcprototype> <funcdef>void <function>XtRemoveBlockHook</function></funcdef> @@ -427,6 +443,8 @@ Specifies the identifier returned from the corresponding call to </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRemoveBlockHook' xrefstyle='select: title'/> @@ -448,6 +466,7 @@ To register a timeout callback, use <xref linkend='XtAppAddTimeOut' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppAddTimeOut'> <funcprototype> <funcdef>XtIntervalId <function>XtAppAddTimeOut</function></funcdef> @@ -501,6 +520,8 @@ when it is called. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppAddTimeOut' xrefstyle='select: title'/> @@ -520,6 +541,7 @@ type <xref linkend='XtTimerCallbackProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtTimerCallbackProc'> <funcprototype> <funcdef>void <function>*XtTimerCallbackProc</function></funcdef> @@ -553,6 +575,8 @@ call. </listitem> </varlistentry> </variablelist> +</refentry> + <para> See <xref linkend='Using_the_Intrinsics_in_a_Multi_Threaded_Environment' /> for information regarding the use of @@ -565,6 +589,7 @@ To clear a timeout value, use <xref linkend='XtRemoveTimeOut' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveTimeOut'> <funcprototype> <funcdef>void <function>XtRemoveTimeOut</function></funcdef> @@ -584,6 +609,8 @@ Specifies the id for the timeout request to be cleared. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRemoveTimeOut' xrefstyle='select: title'/> @@ -619,6 +646,7 @@ callback use <xref linkend='XtAppAddSignal' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppAddSignal'> <funcprototype> <funcdef>XtSignalId <function>XtAppAddSignal</function></funcdef> @@ -660,11 +688,14 @@ Specifies an argument passed to the specified procedure when it is called. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The callback procedure pointers used to handle signal events are of type <xref linkend='XtSignalCallbackProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSignalCallbackProc'> <funcprototype> <funcdef>typedef void <function>(*XtSignalCallbackProc)</function></funcdef> @@ -698,11 +729,14 @@ call. </listitem> </varlistentry> </variablelist> +</refentry> + <para> To notify the Intrinsics that a signal has occured, use <xref linkend='XtNoticeSignal' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtNoticeSignal'> <funcprototype> <funcdef>void <function>XtNoticeSignal</function></funcdef> @@ -724,6 +758,8 @@ call. </listitem> </varlistentry> </variablelist> +</refentry> + <para> On a POSIX-based system, <xref linkend='XtNoticeSignal' xrefstyle='select: title'/> @@ -774,6 +810,7 @@ To remove a registered signal callback, call <xref linkend='XtRemoveSignal' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveSignal'> <funcprototype> <funcdef>void <function>XtRemoveSignal</function></funcdef> @@ -794,6 +831,8 @@ Specifies the id returned by the corresponding call to </listitem> </varlistentry> </variablelist> +</refentry> + <para> The client should typically disable the source of the signal before calling <xref linkend='XtRemoveSignal' xrefstyle='select: title'/>. @@ -877,6 +916,7 @@ To constrain or redirect user input to a modal widget, use <xref linkend='XtAddGrab' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAddGrab'> <funcprototype> <funcdef>void <function>XtAddGrab</function></funcdef> @@ -920,6 +960,8 @@ a pointer button. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAddGrab' xrefstyle='select: title'/> @@ -980,6 +1022,7 @@ To remove the redirection of user input to a modal widget, use <xref linkend='XtRemoveGrab' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveGrab'> <funcprototype> <funcdef>void <function>XtRemoveGrab</function></funcdef> @@ -999,6 +1042,8 @@ Specifies the widget to remove from the modal cascade. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRemoveGrab' xrefstyle='select: title'/> @@ -1023,6 +1068,7 @@ To passively grab a single key of the keyboard, use <xref linkend='XtGrabKey' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGrabKey'> <funcprototype> <funcdef>void <function>XtGrabKey</function></funcdef> @@ -1049,38 +1095,15 @@ Specifies the widget in whose window the key is to be grabbed. Must be of class <term> <emphasis remap='I'>keycode</emphasis> </term> - <listitem> - <para></para> - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>modifiers</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>owner_events</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>pointer_mode</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>keyboard_mode</emphasis> </term> @@ -1095,6 +1118,8 @@ in <olink targetdoc='libX11' targetptr='libX11'>Xlib — C Language X Interface< </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtGrabKey' xrefstyle='select: title'/> calls @@ -1143,6 +1168,7 @@ To cancel a passive key grab, use <xref linkend='XtUngrabKey' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtUngrabKey'> <funcprototype> <funcdef>void <function>XtUngrabKey</function></funcdef> @@ -1167,12 +1193,6 @@ Specifies the widget in whose window the key was grabbed. <term> <emphasis remap='I'>keycode</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>modifiers</emphasis> </term> @@ -1186,6 +1206,8 @@ in <olink targetdoc='libX11' targetptr='libX11'>Xlib — C Language X Interface< </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtUngrabKey' xrefstyle='select: title'/> @@ -1207,6 +1229,7 @@ To actively grab the keyboard, use <xref linkend='XtGrabKeyboard' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGrabKeyboard'> <funcprototype> <funcdef>int <function>XtGrabKeyboard</function></funcdef> @@ -1233,30 +1256,12 @@ Must be of class Core or any subclass thereof. <term> <emphasis remap='I'>owner_events</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>pointer_mode</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>keyboard_mode</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>time</emphasis> </term> @@ -1270,6 +1275,8 @@ in <olink targetdoc='libX11' targetptr='libX11'>Xlib — C Language X Interface< </listitem> </varlistentry> </variablelist> +</refentry> + <para> If the specified widget is realized, <xref linkend='XtGrabKeyboard' xrefstyle='select: title'/> @@ -1291,6 +1298,7 @@ To cancel an active keyboard grab, use <xref linkend='XtUngrabKeyboard' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtUngrabKeyboard'> <funcprototype> <funcdef>void <function>XtUngrabKeyboard</function></funcdef> @@ -1324,6 +1332,8 @@ in <olink targetdoc='libX11' targetptr='libX11'>Xlib — C Language X Interface< </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtUngrabKeyboard' xrefstyle='select: title'/> calls @@ -1336,6 +1346,7 @@ To passively grab a single pointer button, use <xref linkend='XtGrabButton' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGrabButton'> <funcprototype> <funcdef>void <function>XtGrabButton</function></funcdef> @@ -1365,65 +1376,24 @@ Specifies the widget in whose window the button is to be grabbed. Must be of cl <term> <emphasis remap='I'>button</emphasis> </term> - <listitem> - <para></para> - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>modifiers</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>owner_events</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>event_mask</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>pointer_mode</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>keyboard_mode</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>confine_to</emphasis> </term> - <listitem> - <para></para> - - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>cursor</emphasis> </term> @@ -1437,6 +1407,8 @@ in <olink targetdoc='libX11' targetptr='libX11'>Xlib — C Language X Interface< </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtGrabButton' xrefstyle='select: title'/> calls @@ -1485,6 +1457,7 @@ To cancel a passive button grab, use <xref linkend='XtUngrabButton' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtUngrabButton'> <funcprototype> <funcdef>void <function>XtUngrabButton</function></funcdef> @@ -1509,11 +1482,6 @@ Specifies the widget in whose window the button was grabbed. <term> <emphasis remap='I'>button</emphasis> </term> - <listitem> - <para></para> - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>modifiers</emphasis> </term> @@ -1527,6 +1495,8 @@ in <olink targetdoc='libX11' targetptr='libX11'>Xlib — C Language X Interface< </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtUngrabButton' xrefstyle='select: title'/> @@ -1548,6 +1518,7 @@ To actively grab the pointer, use <xref linkend='XtGrabPointer' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGrabPointer'> <funcprototype> <funcdef>int <function>XtGrabPointer</function></funcdef> @@ -1576,51 +1547,21 @@ Specifies the widget for whose window the pointer is to be grabbed. Must be of <term> <emphasis remap='I'>owner_events</emphasis> </term> - <listitem> - <para></para> - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>event_mask</emphasis> </term> - <listitem> - <para></para> - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>pointer_mode</emphasis> </term> - <listitem> - <para></para> - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>keyboard_mode</emphasis> </term> - <listitem> - <para></para> - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>confine_to</emphasis> </term> - <listitem> - <para></para> - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>cursor</emphasis> </term> - <listitem> - <para></para> - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>time</emphasis> </term> @@ -1634,6 +1575,8 @@ in <olink targetdoc='libX11' targetptr='libX11'>Xlib — C Language X Interface< </listitem> </varlistentry> </variablelist> +</refentry> + <para> If the specified widget is realized, <xref linkend='XtGrabPointer' xrefstyle='select: title'/> @@ -1655,6 +1598,7 @@ To cancel an active pointer grab, use <xref linkend='XtUngrabPointer' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtUngrabPointer'> <funcprototype> <funcdef>void <function>XtUngrabPointer</function></funcdef> @@ -1688,6 +1632,8 @@ in <olink targetdoc='libX11' targetptr='libX11'>Xlib — C Language X Interface< </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtUngrabPointer' xrefstyle='select: title'/> calls @@ -1707,6 +1653,7 @@ use <xref linkend='XtSetKeyboardFocus' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetKeyboardFocus'> <funcprototype> <funcdef>void <function>XtSetKeyboardFocus</function></funcdef> @@ -1742,6 +1689,8 @@ when no input focus was previously set. Must be of class Object or any subclass </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtSetKeyboardFocus' xrefstyle='select: title'/> causes @@ -1898,6 +1847,7 @@ The accept_focus procedure pointer is of type <xref linkend='XtAcceptFocusProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAcceptFocusProc'> <funcprototype> <funcdef>Boolean <function>*XtAcceptFocusProc</function></funcdef> @@ -1929,6 +1879,8 @@ Specifies the X time of the event causing the accept focus. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Widgets that need the input focus can call <function>XSetInputFocus</function> @@ -1955,6 +1907,7 @@ To call a widget's accept_focus procedure, use <xref linkend='XtCallAcceptFocus' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCallAcceptFocus'> <funcprototype> <funcdef>Boolean <function>XtCallAcceptFocus</function></funcdef> @@ -1985,6 +1938,8 @@ Specifies the X time of the event that is causing the focus change. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCallAcceptFocus' xrefstyle='select: title'/> @@ -2014,6 +1969,7 @@ To register a drawable with the Intrinsics event dispatching, use <xref linkend='XtRegisterDrawable' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRegisterDrawable'> <funcprototype> <funcdef>void <function>XtRegisterDrawable</function></funcdef> @@ -2055,6 +2011,8 @@ Specifies the widget to register the drawable for. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtRegisterDrawable' xrefstyle='select: title'/> associates the specified drawable with the specified widget @@ -2079,6 +2037,7 @@ To unregister a drawable with the Intrinsics event dispatching, use <xref linkend='XtUnregisterDrawable' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtUnregisterDrawable'> <funcprototype> <funcdef>void <function>XtUnregisterDrawable</function></funcdef> @@ -2109,6 +2068,8 @@ Specifies the drawable to unregister. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtUnregisterDrawable' xrefstyle='select: title'/> removes an association created with @@ -2140,6 +2101,7 @@ use <xref linkend='XtAppPending' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppPending'> <funcprototype> <funcdef>XtInputMask <function>XtAppPending</function></funcdef> @@ -2159,6 +2121,8 @@ Specifies the application context that identifies the application to check. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppPending' xrefstyle='select: title'/> @@ -2185,6 +2149,7 @@ without removing input from the queue, use <xref linkend='XtAppPeekEvent' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppPeekEvent'> <funcprototype> <funcdef>Boolean <function>XtAppPeekEvent</function></funcdef> @@ -2215,6 +2180,8 @@ Returns the event information to the specified event structure. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If there is an X event in the queue, <xref linkend='XtAppPeekEvent' xrefstyle='select: title'/> @@ -2252,6 +2219,7 @@ use <xref linkend='XtAppNextEvent' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppNextEvent'> <funcprototype> <funcdef>void <function>XtAppNextEvent</function></funcdef> @@ -2282,6 +2250,8 @@ Returns the event information to the specified event structure. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If the X event queue is empty, <xref linkend='XtAppNextEvent' xrefstyle='select: title'/> @@ -2313,6 +2283,7 @@ of input should use <xref linkend='XtAppProcessEvent' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppProcessEvent'> <funcprototype> <funcdef>void <function>XtAppProcessEvent</function></funcdef> @@ -2355,6 +2326,8 @@ to be the bitwise inclusive OR of these four event types. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppProcessEvent' xrefstyle='select: title'/> @@ -2394,6 +2367,7 @@ to any registered event filters or event handlers, call <xref linkend='XtDispatchEvent' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtDispatchEvent'> <funcprototype> <funcdef>Boolean <function>XtDispatchEvent</function></funcdef> @@ -2414,6 +2388,8 @@ to the appropriate event handlers. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtDispatchEvent' xrefstyle='select: title'/> @@ -2491,6 +2467,7 @@ use the convenience procedure <xref linkend='XtAppMainLoop' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppMainLoop'> <funcprototype> <funcdef>void <function>XtAppMainLoop</function></funcdef> @@ -2510,6 +2487,8 @@ Specifies the application context that identifies the application. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppMainLoop' xrefstyle='select: title'/> @@ -2601,6 +2580,7 @@ To set the sensitivity state of a widget, use <xref linkend='XtSetSensitive' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetSensitive'> <funcprototype> <funcdef>void <function>XtSetSensitive</function></funcdef> @@ -2632,6 +2612,8 @@ keyboard, pointer, and focus events. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtSetSensitive' xrefstyle='select: title'/> @@ -2692,6 +2674,7 @@ use <xref linkend='XtIsSensitive' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtIsSensitive'> <funcprototype> <funcdef>Boolean <function>XtIsSensitive</function></funcdef> @@ -2711,6 +2694,8 @@ Specifies the object. Must be of class Object or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtIsSensitive' xrefstyle='select: title'/> @@ -2744,6 +2729,7 @@ Work procedure pointers are of type <xref linkend='XtWorkProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtWorkProc'> <funcprototype> <funcdef>typedef Boolean <function>(*XtWorkProc)</function></funcdef> @@ -2764,6 +2750,8 @@ Passes the client data specified when the work procedure was registered. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This procedure should return <function>True</function> @@ -2783,6 +2771,7 @@ To register a work procedure for a given application, use <xref linkend='XtAppAddWorkProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppAddWorkProc'> <funcprototype> <funcdef>XtWorkProcId <function>XtAppAddWorkProc</function></funcdef> @@ -2825,6 +2814,8 @@ when it is called. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppAddWorkProc' xrefstyle='select: title'/> @@ -2845,6 +2836,7 @@ from the procedure when it is called or use outside of the procedure. </para> +<refentry> <funcsynopsis id='XtRemoveWorkProc'> <funcprototype> <funcdef>void <function>XtRemoveWorkProc</function></funcdef> @@ -2864,6 +2856,8 @@ Specifies which work procedure to remove. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRemoveWorkProc' xrefstyle='select: title'/> @@ -3119,6 +3113,7 @@ The expose procedure pointer in a widget class is of type <xref linkend='XtExposeProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtExposeProc'> <funcprototype> <funcdef>typedef void <function>(*XtExposeProc)</function></funcdef> @@ -3160,6 +3155,8 @@ Specifies the union of all rectangles in this exposure sequence. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The redisplay of a widget upon exposure is the responsibility of the expose procedure in the widget's class record. @@ -3303,6 +3300,7 @@ Event handler procedure pointers are of the type <xref linkend='XtEventHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtEventHandler'> <funcprototype> <funcdef>typedef void <function>(*XtEventHandler)</function></funcdef> @@ -3358,6 +3356,8 @@ should be called. </listitem> </varlistentry> </variablelist> +</refentry> + <para> After receiving an event and before calling any event handlers, the Boolean pointed to by <emphasis remap='I'>continue_to_dispatch</emphasis> is initialized to @@ -3384,6 +3384,7 @@ To register an event handler procedure with the dispatch mechanism, use <xref linkend='XtAddEventHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAddEventHandler'> <funcprototype> <funcdef>void <function>XtAddEventHandler</function></funcdef> @@ -3456,6 +3457,8 @@ Specifies additional data to be passed to the event handler. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAddEventHandler' xrefstyle='select: title'/> @@ -3482,6 +3485,7 @@ To remove a previously registered event handler, use <xref linkend='XtRemoveEventHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveEventHandler'> <funcprototype> <funcdef>void <function>XtRemoveEventHandler</function></funcdef> @@ -3554,6 +3558,8 @@ Specifies the registered client data. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRemoveEventHandler' xrefstyle='select: title'/> @@ -3601,6 +3607,7 @@ after all previously registered event handlers, use typedef enum {XtListHead, XtListTail} XtListPosition; </literallayout> +<refentry> <funcsynopsis id='XtInsertEventHandler'> <funcprototype> <funcdef>void <function>XtInsertEventHandler</function></funcdef> @@ -3685,6 +3692,8 @@ relative to other previously registered handlers. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtInsertEventHandler' xrefstyle='select: title'/> is identical to @@ -3715,6 +3724,7 @@ To do this, use <xref linkend='XtAddRawEventHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAddRawEventHandler'> <funcprototype> <funcdef>void <function>XtAddRawEventHandler</function></funcdef> @@ -3787,6 +3797,8 @@ Specifies additional data to be passed to the client's event handler. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAddRawEventHandler' xrefstyle='select: title'/> @@ -3808,6 +3820,7 @@ To remove a previously registered raw event handler, use <xref linkend='XtRemoveRawEventHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveRawEventHandler'> <funcprototype> <funcdef>void <function>XtRemoveRawEventHandler</function></funcdef> @@ -3880,6 +3893,8 @@ Specifies the registered client data. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRemoveRawEventHandler' xrefstyle='select: title'/> @@ -3923,6 +3938,7 @@ the events, use <xref linkend='XtInsertRawEventHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtInsertRawEventHandler'> <funcprototype> <funcdef>void <function>XtInsertRawEventHandler</function></funcdef> @@ -4007,6 +4023,8 @@ relative to other previously registered handlers. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtInsertRawEventHandler' xrefstyle='select: title'/> @@ -4030,6 +4048,7 @@ To retrieve the event mask for a given widget, use <xref linkend='XtBuildEventMask' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtBuildEventMask'> <funcprototype> <funcdef>EventMask <function>XtBuildEventMask</function></funcdef> @@ -4049,6 +4068,8 @@ Specifies the widget. Must be of class Core or any subclass thereof. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtBuildEventMask' xrefstyle='select: title'/> @@ -4076,6 +4097,7 @@ mechanism according to an event type, use <xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtInsertEventTypeHandler'> <funcprototype> <funcdef>void <function>XtInsertEventTypeHandler</function></funcdef> @@ -4152,6 +4174,8 @@ previously registered handlers. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtInsertEventTypeHandler' xrefstyle='select: title'/> registers a procedure with the @@ -4219,6 +4243,7 @@ use <xref linkend='XtRemoveEventTypeHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveEventTypeHandler'> <funcprototype> <funcdef>void <function>XtRemoveEventTypeHandler</function></funcdef> @@ -4283,6 +4308,8 @@ Specifies the additional client data with which the procedure was registered. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRemoveEventTypeHandler' xrefstyle='select: title'/> @@ -4321,6 +4348,7 @@ To register a procedure to select extension events for a widget, use <xref linkend='XtRegisterExtensionSelector' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRegisterExtensionSelector'> <funcprototype> <funcdef>void <function>XtRegisterExtensionSelector</function></funcdef> @@ -4382,6 +4410,8 @@ Specifies additional data to be passed to the extension selector. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRegisterExtensionSelector' xrefstyle='select: title'/> @@ -4420,6 +4450,7 @@ An extension selector is of type <xref linkend='XtExtensionSelectProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtExtensionSelectProc'> <funcprototype> <funcdef>typedef void <function>(*XtExtensionSelectProc)</function></funcdef> @@ -4488,6 +4519,8 @@ Specifies the additional client data with which the procedure was registered. </listitem> </varlistentry> </variablelist> +</refentry> + <para> 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>. @@ -4502,6 +4535,7 @@ use <xref linkend='XtSetEventDispatcher' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetEventDispatcher'> <funcprototype> <funcdef>XtEventDispatchProc <function>XtSetEventDispatcher</function></funcdef> @@ -4543,6 +4577,8 @@ Specifies the event dispatcher procedure. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtSetEventDispatcher' xrefstyle='select: title'/> @@ -4572,6 +4608,7 @@ An event dispatcher procedure pointer is of type <xref linkend='XtEventDispatchProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtEventDispatchProc'> <funcprototype> <funcdef>typedef Boolean <function>(*XtEventDispatchProc)</function></funcdef> @@ -4591,6 +4628,8 @@ Passes the event to be dispatched. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The event dispatcher procedure should determine whether this event is of a type that should be dispatched to a widget. @@ -4639,6 +4678,7 @@ which widget is the end result of keyboard event forwarding, use <xref linkend='XtGetKeyboardFocusWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetKeyboardFocusWidget'> <funcprototype> <funcdef>Widget <function>XtGetKeyboardFocusWidget</function></funcdef> @@ -4658,6 +4698,8 @@ Specifies the widget to get forwarding information for. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetKeyboardFocusWidget' xrefstyle='select: title'/> @@ -4670,6 +4712,7 @@ To dispatch an event to a specified widget, use <xref linkend='XtDispatchEventToWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtDispatchEventToWidget'> <funcprototype> <funcdef>Boolean <function>XtDispatchEventToWidget</function></funcdef> @@ -4700,6 +4743,8 @@ Specifies a pointer to the event to be dispatched. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtDispatchEventToWidget' xrefstyle='select: title'/> @@ -4850,6 +4895,7 @@ widget internal state, use <function>XtAppLock.</function> </para> +<refentry> <funcsynopsis id='XtAppLock'> <funcprototype> <funcdef>void <function>XtAppLock</function></funcdef> @@ -4869,6 +4915,8 @@ Specifies the application context to lock. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <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 @@ -4882,6 +4930,7 @@ To unlock a locked application context, use <function>XtAppUnlock.</function> </para> +<refentry> <funcsynopsis id='XtAppUnlock'> <funcprototype> <funcdef>void <function>XtAppUnlock</function></funcdef> @@ -4901,6 +4950,8 @@ Specifies the application context that was previously locked. </listitem> </varlistentry> </variablelist> +</refentry> + </sect3> <sect3 id="Locking_the_Process"> @@ -4967,6 +5018,7 @@ event dispatch has completed, use <xref linkend='XtAppSetExitFlag' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppSetExitFlag'> <funcprototype> <funcdef>void <function>XtAppSetExitFlag</function></funcdef> @@ -4986,6 +5038,8 @@ Specifies the application context. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtAppMainLoop' xrefstyle='select: title'/> tests the value of the flag and will return if the flag is <function>True</function>. @@ -4997,6 +5051,7 @@ value of the exit flag with <xref linkend='XtAppGetExitFlag' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppGetExitFlag'> <funcprototype> <funcdef>Boolean <function>XtAppGetExitFlag</function></funcdef> @@ -5016,6 +5071,8 @@ Specifies the application context. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtAppGetExitFlag' xrefstyle='select: title'/> will normally return <function>False</function>, indicating that event processing diff --git a/specs/CH08.xml b/specs/CH08.xml index 3d2458e..13f9dca 100755..100644 --- a/specs/CH08.xml +++ b/specs/CH08.xml @@ -28,6 +28,7 @@ Callback procedure pointers for use in callback lists are of type <xref linkend='XtCallbackProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCallbackProc'> <funcprototype> <funcdef>typedef void <function>(*XtCallbackProc)</function></funcdef> @@ -72,6 +73,8 @@ it passes the new position of the thumb. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <emphasis remap='I'>client_data</emphasis> argument provides a way for the client registering the callback procedure also to register client-specific data, @@ -166,6 +169,7 @@ To add a callback procedure to a widget's callback list, use <xref linkend='XtAddCallback' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAddCallback'> <funcprototype> <funcdef>void <function>XtAddCallback</function></funcdef> @@ -220,6 +224,8 @@ or NULL. </listitem> </varlistentry> </variablelist> +</refentry> + <para> A callback will be invoked as many times as it occurs in the callback list. </para> @@ -229,6 +235,7 @@ To add a list of callback procedures to a given widget's callback list, use <xref linkend='XtAddCallbacks' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAddCallbacks'> <funcprototype> <funcdef>void <function>XtAddCallbacks</function></funcdef> @@ -271,6 +278,8 @@ client data. </listitem> </varlistentry> </variablelist> +</refentry> + </sect1> @@ -281,6 +290,7 @@ To delete a callback procedure from a widget's callback list, use <xref linkend='XtRemoveCallback' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveCallback'> <funcprototype> <funcdef>void <function>XtRemoveCallback</function></funcdef> @@ -333,6 +343,8 @@ Specifies the client data to match with the registered callback entry. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRemoveCallback' xrefstyle='select: title'/> @@ -345,6 +357,7 @@ To delete a list of callback procedures from a given widget's callback list, use <xref linkend='XtRemoveCallbacks' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveCallbacks'> <funcprototype> <funcdef>void <function>XtRemoveCallbacks</function></funcdef> @@ -387,12 +400,15 @@ client data. </listitem> </varlistentry> </variablelist> +</refentry> + <para> To delete all callback procedures from a given widget's callback list and free all storage associated with the callback list, use <xref linkend='XtRemoveAllCallbacks' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveAllCallbacks'> <funcprototype> <funcdef>void <function>XtRemoveAllCallbacks</function></funcdef> @@ -423,6 +439,8 @@ Specifies the callback list to be cleared. </listitem> </varlistentry> </variablelist> +</refentry> + </sect1> @@ -434,6 +452,7 @@ specifying the callback list by resource name, use <xref linkend='XtCallCallbacks' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCallCallbacks'> <funcprototype> <funcdef>void <function>XtCallCallbacks</function></funcdef> @@ -476,6 +495,8 @@ procedure in the list, or NULL. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtCallCallbacks' xrefstyle='select: title'/> @@ -490,6 +511,7 @@ list by address, use <xref linkend='XtCallCallbackList' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCallCallbackList'> <funcprototype> <funcdef>void <function>XtCallCallbackList</function></funcdef> @@ -532,6 +554,8 @@ to each of the callback procedures in the list, or NULL. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <emphasis remap='I'>callbacks</emphasis> parameter must specify the contents of a widget or object resource declared with representation type @@ -554,6 +578,7 @@ To find out the status of a given widget's callback list, use typedef enum {XtCallbackNoList, XtCallbackHasNone, XtCallbackHasSome} XtCallbackStatus; </para> +<refentry> <funcsynopsis id='XtHasCallbacks'> <funcprototype> <funcdef>XtCallbackStatus <function>XtHasCallbacks</function></funcdef> @@ -584,6 +609,8 @@ Specifies the callback list to be checked. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtHasCallbacks' xrefstyle='select: title'/> diff --git a/specs/CH09.xml b/specs/CH09.xml index c24a6d2..f0a262d 100755..100644 --- a/specs/CH09.xml +++ b/specs/CH09.xml @@ -165,7 +165,7 @@ physical representation (see <xref linkend='Resource_Conversions' />). The Intrinsics define the following resource types: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -439,6 +439,7 @@ procedure pointers are of type <xref linkend='XtResourceDefaultProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtResourceDefaultProc'> <funcprototype> <funcdef>typedef void <function>(*XtResourceDefaultProc)</function></funcdef> @@ -480,6 +481,8 @@ Specifies the resource value descriptor to return. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtResourceDefaultProc' xrefstyle='select: title'/> @@ -492,6 +495,7 @@ To get the resource list structure for a particular class, use <xref linkend='XtGetResourceList' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetResourceList'> <funcprototype> <funcdef>void <function>XtGetResourceList</function></funcdef> @@ -536,6 +540,8 @@ Returns the number of entries in the resource list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If <xref linkend='XtGetResourceList' xrefstyle='select: title'/> @@ -558,6 +564,7 @@ class, use <xref linkend='XtGetConstraintResourceList' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetConstraintResourceList'> <funcprototype> <funcdef>void <function>XtGetConstraintResourceList</function></funcdef> @@ -601,6 +608,8 @@ Returns the number of entries in the constraint resource list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If <xref linkend='XtGetConstraintResourceList' xrefstyle='select: title'/> @@ -675,6 +684,7 @@ To determine the byte offset of a field within a structure type, use <xref linkend='XtOffsetOf' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtOffsetOf'> <funcprototype> <funcdef>Cardinal <function>XtOffsetOf</function></funcdef> @@ -707,6 +717,8 @@ Specifies the name of a member within the structure. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtOffsetOf' xrefstyle='select: title'/> @@ -723,6 +735,7 @@ To determine the byte offset of a field within a structure pointer type, use <xref linkend='XtOffset' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtOffset'> <funcprototype> <funcdef>Cardinal <function>XtOffset</function></funcdef> @@ -753,6 +766,8 @@ Specifies the name of a member within the structure. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtOffset' xrefstyle='select: title'/> @@ -834,6 +849,7 @@ Such widgets call to accomplish this. </para> +<refentry> <funcsynopsis id='XtGetSubresources'> <funcprototype> <funcdef>void <function>XtGetSubresources</function></funcdef> @@ -932,6 +948,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetSubresources' xrefstyle='select: title'/> @@ -967,6 +985,7 @@ To fetch resources for widget subparts using varargs lists, use <xref linkend='XtVaGetSubresources' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaGetSubresources'> <funcprototype> <funcdef>void <function>XtVaGetSubresources</function></funcdef> @@ -1054,6 +1073,8 @@ resource specifications. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtVaGetSubresources' xrefstyle='select: title'/> is identical in function to @@ -1071,6 +1092,7 @@ but apply to the overall application, use <xref linkend='XtGetApplicationResources' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetApplicationResources'> <funcprototype> <funcdef>void <function>XtGetApplicationResources</function></funcdef> @@ -1147,6 +1169,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetApplicationResources' xrefstyle='select: title'/> @@ -1188,6 +1212,7 @@ To retrieve resources for the overall application using varargs lists, use <xref linkend='XtVaGetApplicationResources' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaGetApplicationResources'> <funcprototype> <funcdef>void <function>XtVaGetApplicationResources</function></funcdef> @@ -1253,6 +1278,8 @@ resource specifications. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtVaGetApplicationResources' xrefstyle='select: title'/> is identical in function to @@ -1311,7 +1338,7 @@ input values of representation type <function>XtRString</function>. </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='3' align='left' rowsep='0' colsep='0'> <colspec colwidth='0.8*' colname='c1'/> @@ -1614,7 +1641,7 @@ an input value of representation type <function>XtRColor</function>. </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='3' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1642,7 +1669,7 @@ input values of representation type <function>XtRInt</function>. </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='3' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1711,7 +1738,7 @@ an input value of representation type <function>XtRPixel</function>. </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='3' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1765,6 +1792,7 @@ A resource converter procedure pointer is of type <xref linkend='XtTypeConverter' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtTypeConverter'> <funcprototype> <funcdef>typedef Boolean <function>(*XtTypeConverter)</function></funcdef> @@ -1846,6 +1874,8 @@ with this conversion. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <emphasis remap='I'>display</emphasis> argument is normally used only when generating error messages, to identify the application context (with the function @@ -2017,6 +2047,7 @@ A resource destructor procedure pointer is of type <xref linkend='XtDestructor' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtDestructor'> <funcprototype> <funcdef>typedef void <function>(*XtDestructor)</function></funcdef> @@ -2081,6 +2112,8 @@ Specifies the number of entries in <emphasis remap='I'>args</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The destructor procedure is responsible for freeing the resource specified by the <emphasis remap='I'>to</emphasis> argument, including any auxiliary storage @@ -2099,6 +2132,7 @@ procedure is a convenience routine for resource type converters that convert from string values. </para> +<refentry> <funcsynopsis id='XtDisplayStringConversionWarning'> <funcprototype> <funcdef>void <function>XtDisplayStringConversionWarning</function></funcdef> @@ -2139,6 +2173,8 @@ Specifies the target representation type requested. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtDisplayStringConversionWarning' xrefstyle='select: title'/> @@ -2163,6 +2199,7 @@ display connection, use <xref linkend='XtDisplayToApplicationContext' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtDisplayToApplicationContext'> <funcprototype> <funcdef>XtAppContext <function>XtDisplayToApplicationContext</function></funcdef> @@ -2182,6 +2219,8 @@ Specifies an open and initialized display connection. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtDisplayToApplicationContext' xrefstyle='select: title'/> @@ -2276,6 +2315,7 @@ and to register a type converter in a single application context, use <xref linkend='XtAppSetTypeConverter' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetTypeConverter'> <funcprototype> <funcdef>void <function>XtSetTypeConverter</function></funcdef> @@ -2365,7 +2405,10 @@ required to deallocate resources produced by the converter. </listitem> </varlistentry> </variablelist> +</refentry> + +<refentry> <funcsynopsis id='XtAppSetTypeConverter'> <funcprototype> <funcdef> <function>XtAppSetTypeConverter</function></funcdef> @@ -2466,6 +2509,8 @@ required to deallocate resources produced by the converter. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtSetTypeConverter' xrefstyle='select: title'/> registers the specified type converter and @@ -2543,6 +2588,7 @@ the address of a function of type <xref linkend='XtConvertArgProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtConvertArgProc'> <funcprototype> <funcdef>typedef void <function>(*XtConvertArgProc)</function></funcdef> @@ -2607,6 +2653,8 @@ Specifies the number of entries in <emphasis remap='I'>args</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The destructor procedure is responsible for freeing the resource specified by the <emphasis remap='I'>to</emphasis> argument, including any auxiliary storage @@ -2639,6 +2687,7 @@ or typedef XtPointer XtCacheRef; </literallayout> +<refentry> <funcsynopsis id='XtCallConverter'> <funcprototype> <funcdef>Boolean <function>XtCallConverter</function></funcdef> @@ -2725,6 +2774,8 @@ Returns a conversion cache id. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCallConverter' xrefstyle='select: title'/> @@ -2786,6 +2837,7 @@ use <xref linkend='XtAppReleaseCacheRefs' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppReleaseCacheRefs'> <funcprototype> <funcdef>void <function>XtAppReleaseCacheRefs</function></funcdef> @@ -2816,6 +2868,8 @@ Specifies the list of cache references to be released. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtAppReleaseCacheRefs' xrefstyle='select: title'/> decrements the reference count for the @@ -2837,6 +2891,7 @@ and <xref linkend='XtCallbackReleaseCacheRefList' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCallbackReleaseCacheRef'> <funcprototype> <funcdef>void <function>XtCallbackReleaseCacheRef</function></funcdef> @@ -2878,6 +2933,8 @@ Is ignored. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This callback procedure may be added to a callback list to release a previously returned @@ -2889,6 +2946,7 @@ data cast to type <function>XtPointer</function>. </para> +<refentry> <funcsynopsis id='XtCallbackReleaseCacheRefList'> <funcprototype> <funcdef>void <function>XtCallbackReleaseCacheRefList</function></funcdef> @@ -2930,6 +2988,8 @@ Is ignored. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This callback procedure may be added to a callback list to release a list of previously returned @@ -2947,6 +3007,7 @@ and free a cached resource when a widget is destroyed, use <xref linkend='XtConvertAndStore' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtConvertAndStore'> <funcprototype> <funcdef>Boolean <function>XtConvertAndStore</function></funcdef> @@ -3012,6 +3073,8 @@ will be returned. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtConvertAndStore' xrefstyle='select: title'/> @@ -3120,6 +3183,7 @@ widget instance, use <xref linkend='XtGetValues' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetValues'> <funcprototype> <funcdef>void <function>XtGetValues</function></funcdef> @@ -3164,6 +3228,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetValues' xrefstyle='select: title'/> @@ -3279,6 +3345,7 @@ instance using varargs lists, use <xref linkend='XtVaGetValues' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaGetValues'> <funcprototype> <funcdef>void <function>XtVaGetValues</function></funcdef> @@ -3310,6 +3377,8 @@ be returned. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtVaGetValues' xrefstyle='select: title'/> is identical in function to @@ -3337,6 +3406,7 @@ The get_values_hook procedure pointer is of type <xref linkend='XtArgsProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='_XtArgsProc'> <funcprototype> <funcdef>typedef void <function>(*XtArgsProc)</function></funcdef> @@ -3382,6 +3452,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The widget with subpart resources should call <xref linkend='XtGetSubvalues' xrefstyle='select: title'/> @@ -3399,6 +3471,7 @@ For a discussion of subpart resources, see <xref linkend='Subresources' />. </para> +<refentry> <funcsynopsis id='XtGetSubvalues'> <funcprototype> <funcdef>void <function>XtGetSubvalues</function></funcdef> @@ -3465,6 +3538,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetSubvalues' xrefstyle='select: title'/> @@ -3483,6 +3558,7 @@ a widget instance using varargs lists, use <xref linkend='XtVaGetSubvalues' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaGetSubvalues'> <funcprototype> <funcdef>void <function>XtVaGetSubvalues</function></funcdef> @@ -3538,6 +3614,8 @@ values are to be stored. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtVaGetSubvalues' xrefstyle='select: title'/> is identical in function to @@ -3564,6 +3642,7 @@ instance, use <xref linkend='XtSetValues' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetValues'> <funcprototype> <funcdef>void <function>XtSetValues</function></funcdef> @@ -3606,6 +3685,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtSetValues' xrefstyle='select: title'/> @@ -3692,6 +3773,7 @@ instance using varargs lists, use <xref linkend='XtVaSetValues' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaSetValues'> <funcprototype> <funcdef>void <function>XtVaSetValues</function></funcdef> @@ -3723,6 +3805,8 @@ contain the resources to be modified and their new values. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtVaSetValues' xrefstyle='select: title'/> is identical in function to @@ -3737,6 +3821,7 @@ The set_values procedure pointer in a widget class is of type <xref linkend='XtSetValuesFunc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetValuesFunc'> <funcprototype> <funcdef>typedef Boolean <function>(*XtSetValuesFunc)</function></funcdef> @@ -3808,6 +3893,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The set_values procedure should recompute any field derived from resources that are changed @@ -3932,6 +4019,7 @@ The set_values_almost procedure pointer in the widget class record is of type <xref linkend='XtAlmostProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAlmostProc'> <funcprototype> <funcdef>typedef void <function>(*XtAlmostProc)</function></funcdef> @@ -3992,6 +4080,8 @@ manager with </listitem> </varlistentry> </variablelist> +</refentry> + <para> Most classes inherit the set_values_almost procedure from their superclass by specifying @@ -4072,6 +4162,7 @@ For a discussion of subpart resources, see <xref linkend='Subresources' />. </para> +<refentry> <funcsynopsis id='XtSetSubvalues'> <funcprototype> <funcdef>void <function>XtSetSubvalues</function></funcdef> @@ -4137,6 +4228,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtSetSubvalues' xrefstyle='select: title'/> @@ -4151,6 +4244,7 @@ a widget instance using varargs lists, use <xref linkend='XtVaSetSubvalues' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaSetSubvalues'> <funcprototype> <funcdef>void <function>XtVaSetSubvalues</function></funcdef> @@ -4204,6 +4298,8 @@ contain the resources to be modified and their new values. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtVaSetSubvalues' xrefstyle='select: title'/> is identical in function to @@ -4236,6 +4332,7 @@ The set_values_hook procedure pointer in a widget class is of type <xref linkend='XtArgsFunc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtArgsFunc'> <funcprototype> <funcdef>typedef Boolean <function>(*XtArgsFunc)</function></funcdef> @@ -4280,6 +4377,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The widget with subpart resources may call <xref linkend='XtSetValues' xrefstyle='select: title'/> diff --git a/specs/CH10.xml b/specs/CH10.xml index cd47990..1874128 100755..100644 --- a/specs/CH10.xml +++ b/specs/CH10.xml @@ -55,6 +55,7 @@ The translation action procedure pointer is of type <xref linkend='XtActionProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtActionProc'> <funcprototype> <funcdef>typedef void <function>(*XtActionProc)</function></funcdef> @@ -110,6 +111,8 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <literallayout > typedef struct _XtActionsRec { String string; @@ -212,6 +215,7 @@ and register it with the translation manager, use <xref linkend='XtAppAddActions' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppAddActions'> <funcprototype> <funcdef>void <function>XtAppAddActions</function></funcdef> @@ -253,6 +257,8 @@ Specifies the number of entries in this action table. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If more than one action is registered with the same name, the most recently registered action is used. @@ -318,6 +324,7 @@ so, the application supplies a procedure pointer of type <xref linkend='XtActionHookProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtActionHookProc'> <funcprototype> <funcdef>typedef void <function>(*XtActionHookProc)</function></funcdef> @@ -395,6 +402,8 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Action hooks should not modify any of the data pointed to by the arguments other than the <emphasis remap='I'>client_data</emphasis> argument. @@ -405,6 +414,7 @@ To add an action hook, use <xref linkend='XtAppAddActionHook' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppAddActionHook'> <funcprototype> <funcdef>XtActionHookId <function>XtAppAddActionHook</function></funcdef> @@ -446,6 +456,8 @@ Specifies application-specific data to be passed to the action hook. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtAppAddActionHook' xrefstyle='select: title'/> adds the specified procedure to the front of a list @@ -470,6 +482,7 @@ context, use <xref linkend='XtRemoveActionHook' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRemoveActionHook'> <funcprototype> <funcdef>void <function>XtRemoveActionHook</function></funcdef> @@ -490,6 +503,8 @@ Specifies the action hook id returned by </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtRemoveActionHook' xrefstyle='select: title'/> removes the specified action hook procedure from @@ -633,6 +648,7 @@ To set the multi-click time dynamically, use <xref linkend='XtSetMultiClickTime' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetMultiClickTime'> <funcprototype> <funcdef>void <function>XtSetMultiClickTime</function></funcdef> @@ -663,6 +679,8 @@ Specifies the multi-click time in milliseconds. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtSetMultiClickTime' xrefstyle='select: title'/> sets the time interval used by the translation @@ -680,6 +698,7 @@ To read the multi-click time, use <xref linkend='XtGetMultiClickTime' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetMultiClickTime'> <funcprototype> <funcdef>int <function>XtGetMultiClickTime</function></funcdef> @@ -699,6 +718,8 @@ Specifies the display connection. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtGetMultiClickTime' xrefstyle='select: title'/> returns the time in milliseconds that the @@ -774,6 +795,7 @@ To compile a translation table, use <xref linkend='XtParseTranslationTable' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtParseTranslationTable'> <funcprototype> <funcdef>XtTranslations <function>XtParseTranslationTable</function></funcdef> @@ -793,6 +815,8 @@ Specifies the translation table to compile. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtParseTranslationTable' xrefstyle='select: title'/> @@ -811,6 +835,7 @@ To merge additional translations into an existing translation table, use <xref linkend='XtAugmentTranslations' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAugmentTranslations'> <funcprototype> <funcdef>void <function>XtAugmentTranslations</function></funcdef> @@ -841,6 +866,8 @@ Specifies the compiled translation table to merge in. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAugmentTranslations' xrefstyle='select: title'/> @@ -868,6 +895,7 @@ To overwrite existing translations with new translations, use <xref linkend='XtOverrideTranslations' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtOverrideTranslations'> <funcprototype> <funcdef>void <function>XtOverrideTranslations</function></funcdef> @@ -898,6 +926,8 @@ Specifies the compiled translation table to merge in. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtOverrideTranslations' xrefstyle='select: title'/> @@ -969,6 +999,7 @@ To completely remove existing translations, use <xref linkend='XtUninstallTranslations' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtUninstallTranslations'> <funcprototype> <funcdef>void <function>XtUninstallTranslations</function></funcdef> @@ -988,6 +1019,8 @@ Specifies the widget from which the translations are to be removed. Must be of </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtUninstallTranslations' xrefstyle='select: title'/> @@ -1030,6 +1063,7 @@ The display_accelerator procedure pointer is of type <xref linkend='XtStringProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtStringProc'> <funcprototype> <funcdef>typedef void <function>(*XtStringProc)</function></funcdef> @@ -1060,6 +1094,8 @@ Specifies the string representation of the accelerators for this widget. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Accelerators can be specified in resource files, and the string representation is the same as for a translation table. @@ -1086,6 +1122,7 @@ To parse an accelerator table, use <xref linkend='XtParseAcceleratorTable' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtParseAcceleratorTable'> <funcprototype> <funcdef>XtAccelerators <function>XtParseAcceleratorTable</function></funcdef> @@ -1105,6 +1142,8 @@ Specifies the accelerator table to compile. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtParseAcceleratorTable' xrefstyle='select: title'/> @@ -1120,6 +1159,7 @@ To install accelerators from a widget on another widget, use <xref linkend='XtInstallAccelerators' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtInstallAccelerators'> <funcprototype> <funcdef>void <function>XtInstallAccelerators</function></funcdef> @@ -1150,6 +1190,8 @@ Specifies the widget from which the accelerators are to come. Must be of class </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtInstallAccelerators' xrefstyle='select: title'/> @@ -1172,6 +1214,7 @@ descendants onto one destination, use <xref linkend='XtInstallAllAccelerators' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtInstallAllAccelerators'> <funcprototype> <funcdef>void <function>XtInstallAllAccelerators</function></funcdef> @@ -1203,6 +1246,8 @@ from which the accelerators are to come. Must be of class Core or any subclass </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtInstallAllAccelerators' xrefstyle='select: title'/> @@ -1224,6 +1269,7 @@ KeyCode-to-KeySym translator procedure pointers are of type <xref linkend='XtKeyProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtKeyProc'> <funcprototype> <funcdef>typedef void <function>(*XtKeyProc)</function></funcdef> @@ -1289,6 +1335,8 @@ Specifies a location in which to store the resulting KeySym. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This procedure takes a KeyCode and modifiers and produces a KeySym. For any given key translator function and keyboard encoding, @@ -1320,6 +1368,7 @@ particular display, use <xref linkend='XtGetKeysymTable' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetKeysymTable'> <funcprototype> <funcdef>KeySym *<function>XtGetKeysymTable</function></funcdef> @@ -1361,6 +1410,8 @@ Returns the number of KeySyms stored for each KeyCode. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtGetKeysymTable' xrefstyle='select: title'/> returns a pointer to the Intrinsics' copy of the @@ -1392,6 +1443,7 @@ To register a key translator, use <xref linkend='XtSetKeyTranslator' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetKeyTranslator'> <funcprototype> <funcdef>void <function>XtSetKeyTranslator</function></funcdef> @@ -1422,6 +1474,8 @@ Specifies the procedure to perform key translations. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtSetKeyTranslator' xrefstyle='select: title'/> @@ -1443,6 +1497,7 @@ use <xref linkend='XtTranslateKeycode' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtTranslateKeycode'> <funcprototype> <funcdef>void <function>XtTranslateKeycode</function></funcdef> @@ -1507,6 +1562,8 @@ Returns the resulting KeySym. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtTranslateKeycode' xrefstyle='select: title'/> @@ -1521,6 +1578,7 @@ Case converter procedure pointers are of type <xref linkend='XtCaseProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCaseProc'> <funcprototype> <funcdef>typedef void <function>(*XtCaseProc)</function></funcdef> @@ -1575,6 +1633,8 @@ the KeySym. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If there is no case distinction, this procedure should store the KeySym into both return values. @@ -1585,6 +1645,7 @@ To register a case converter, use <xref linkend='XtRegisterCaseConverter' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRegisterCaseConverter'> <funcprototype> <funcdef>void <function>XtRegisterCaseConverter</function></funcdef> @@ -1639,6 +1700,8 @@ Specifies the last KeySym for which this converter is valid. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRegisterCaseConverter' xrefstyle='select: title'/> @@ -1659,6 +1722,7 @@ To determine uppercase and lowercase equivalents for a KeySym, use <xref linkend='XtConvertCase' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtConvertCase'> <funcprototype> <funcdef>void <function>XtConvertCase</function></funcdef> @@ -1711,6 +1775,8 @@ Returns the uppercase equivalent of the KeySym. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtConvertCase' xrefstyle='select: title'/> @@ -1742,6 +1808,7 @@ specification in the translation table entry, use <xref linkend='XtGetActionKeysym' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetActionKeysym'> <funcprototype> <funcdef>KeySym <function>XtGetActionKeysym</function></funcdef> @@ -1772,6 +1839,8 @@ Returns the modifiers that caused the match, if non-NULL. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If <xref linkend='XtGetActionKeysym' xrefstyle='select: title'/> @@ -1819,6 +1888,7 @@ the keyboard mapping table maintained by the Intrinsics, use <xref linkend='XtKeysymToKeycodeList' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtKeysymToKeycodeList'> <funcprototype> <funcdef>void <function>XtKeysymToKeycodeList</function></funcdef> @@ -1872,6 +1942,8 @@ Returns the number of KeyCodes in the keycode list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtKeysymToKeycodeList' xrefstyle='select: title'/> @@ -1900,6 +1972,7 @@ event bindings in the widget's translation table, use <xref linkend='XtRegisterGrabAction' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRegisterGrabAction'> <funcprototype> <funcdef>void <function>XtRegisterGrabAction</function></funcdef> @@ -1961,6 +2034,8 @@ or </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtRegisterGrabAction' xrefstyle='select: title'/> adds the specified <emphasis remap='I'>action_proc</emphasis> to a list known to @@ -2032,6 +2107,7 @@ invoke an action procedure directly, without generating <xref linkend='XtCallActionProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCallActionProc'> <funcprototype> <funcdef>void <function>XtCallActionProc</function></funcdef> @@ -2095,6 +2171,8 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtCallActionProc' xrefstyle='select: title'/> searches for the named action routine in the same @@ -2125,6 +2203,7 @@ the list of action procedures registered in the superclass's <xref linkend='XtGetActionList' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetActionList'> <funcprototype> <funcdef>void <function>XtGetActionList</function></funcdef> @@ -2166,6 +2245,8 @@ Returns the number of action procedures declared by the class. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtGetActionList' xrefstyle='select: title'/> returns the action table defined by the specified diff --git a/specs/CH11.xml b/specs/CH11.xml index 2237a94..1b5ae3a 100755..100644 --- a/specs/CH11.xml +++ b/specs/CH11.xml @@ -78,6 +78,7 @@ To determine the number of elements in a fixed-size array, use <xref linkend='XtNumber' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtNumber'> <funcprototype> <funcdef>Cardinal <function>XtNumber</function></funcdef> @@ -97,6 +98,8 @@ Specifies a fixed-size array of arbitrary type. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtNumber' xrefstyle='select: title'/> @@ -111,6 +114,7 @@ To translate a widget name to a widget instance, use <xref linkend='XtNameToWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtNameToWidget'> <funcprototype> <funcdef>Widget <function>XtNameToWidget</function></funcdef> @@ -141,6 +145,8 @@ Specifies the partially qualified name of the desired widget. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtNameToWidget' xrefstyle='select: title'/> @@ -245,6 +251,7 @@ To allocate storage, use <xref linkend='XtMalloc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtMalloc'> <funcprototype> <funcdef>char * <function>XtMalloc</function></funcdef> @@ -264,6 +271,8 @@ Specifies the number of bytes desired. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtMalloc' xrefstyle='select: title'/> @@ -280,6 +289,7 @@ To allocate and initialize an array, use <xref linkend='XtCalloc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCalloc'> <funcprototype> <funcdef>char * <function>XtCalloc</function></funcdef> @@ -310,6 +320,8 @@ Specifies the size of each array element in bytes. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtCalloc' xrefstyle='select: title'/> @@ -328,6 +340,7 @@ To change the size of an allocated block of storage, use <xref linkend='XtRealloc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtRealloc'> <funcprototype> <funcdef>char *<function>XtRealloc</function></funcdef> @@ -363,6 +376,8 @@ Specifies number of bytes desired in new storage. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtRealloc' xrefstyle='select: title'/> @@ -386,6 +401,7 @@ To free an allocated block of storage, use <xref linkend='XtFree' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtFree'> <funcprototype> <funcdef>void <function>XtFree</function></funcdef> @@ -410,6 +426,8 @@ or NULL. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtFree' xrefstyle='select: title'/> @@ -425,6 +443,7 @@ To allocate storage for a new instance of a type, use </para> +<refentry> <funcsynopsis id='XtNew'> <funcprototype> <funcdef>type <function>XtNew</function></funcdef> @@ -444,6 +463,8 @@ Specifies a previously declared type. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtNew' xrefstyle='select: title'/> returns a pointer to the allocated storage. @@ -471,6 +492,7 @@ To copy an instance of a string, use <xref linkend='XtNewString' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtNewString'> <funcprototype> <funcdef>String <function>XtNewString</function></funcdef> @@ -490,6 +512,8 @@ Specifies a previously declared string. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtNewString' xrefstyle='select: title'/> returns a pointer to the allocated storage. @@ -529,6 +553,7 @@ To obtain a shareable GC with modifiable fields, use <xref linkend='XtAllocateGC' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAllocateGC'> <funcprototype> <funcdef>GC <function>XtAllocateGC</function></funcdef> @@ -604,6 +629,8 @@ Specifies fields of the GC that will not be needed by the caller. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAllocateGC' xrefstyle='select: title'/> @@ -653,6 +680,7 @@ To obtain a shareable GC with no modifiable fields, use <xref linkend='XtGetGC' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetGC'> <funcprototype> <funcdef>GC <function>XtGetGC</function></funcdef> @@ -695,6 +723,8 @@ Specifies the actual values for this GC. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetGC' xrefstyle='select: title'/> @@ -724,6 +754,7 @@ To deallocate a shared GC when it is no longer needed, use <xref linkend='XtReleaseGC' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtReleaseGC'> <funcprototype> <funcdef>void <function>XtReleaseGC</function></funcdef> @@ -757,6 +788,8 @@ or </listitem> </varlistentry> </variablelist> +</refentry> + <para> References to shareable GCs are counted and a free request is generated to the server when the last user of a given GC releases it. @@ -801,6 +834,7 @@ To set the Intrinsics selection timeout, use <xref linkend='XtAppSetSelectionTimeout' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppSetSelectionTimeout'> <funcprototype> <funcdef>void <function>XtAppSetSelectionTimeout</function></funcdef> @@ -831,11 +865,14 @@ Specifies the selection timeout in milliseconds. </listitem> </varlistentry> </variablelist> +</refentry> + <para> To get the current selection timeout value, use <xref linkend='XtAppGetSelectionTimeout' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppGetSelectionTimeout'> <funcprototype> <funcdef>unsigned long <function>XtAppGetSelectionTimeout</function></funcdef> @@ -855,6 +892,8 @@ Specifies the application context. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppGetSelectionTimeout' xrefstyle='select: title'/> @@ -895,6 +934,7 @@ data to the Intrinsics is of type <xref linkend='XtConvertSelectionProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtConvertSelectionProc'> <funcprototype> <funcdef>typedef Boolean <function>(*XtConvertSelectionProc)</function></funcdef> @@ -1001,6 +1041,8 @@ of the selection value is to be stored. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This procedure is called by the Intrinsics selection mechanism to get the value of a selection as a given type @@ -1050,6 +1092,7 @@ procedure, use <xref linkend='XtGetSelectionRequest' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetSelectionRequest'> <funcprototype> <funcdef>XSelectionRequestEvent *<function>XtGetSelectionRequest</function></funcdef> @@ -1092,6 +1135,8 @@ selections, or NULL in the case of atomic transfers. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtGetSelectionRequest' xrefstyle='select: title'/> may be called only from within an @@ -1115,6 +1160,7 @@ notification upon losing ownership is of type <xref linkend='XtLoseSelectionProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtLoseSelectionProc'> <funcprototype> <funcdef>typedef void <function>(*XtLoseSelectionProc)</function></funcdef> @@ -1145,6 +1191,8 @@ Specifies the atom naming the selection. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This procedure is called by the Intrinsics selection mechanism to inform the specified widget that it has lost the given selection. @@ -1159,6 +1207,7 @@ containing the data is of type <xref linkend='XtSelectionDoneProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSelectionDoneProc'> <funcprototype> <funcdef>typedef void <function>(*XtSelectionDoneProc)</function></funcdef> @@ -1200,6 +1249,8 @@ Specifies the target type to which the conversion was done. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This procedure is called by the Intrinsics selection mechanism to inform the selection owner that a selection requestor has successfully @@ -1223,6 +1274,7 @@ selection data from the Intrinsics is of type <xref linkend='XtSelectionCallbackProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSelectionCallbackProc'> <funcprototype> <funcdef>typedef void <function>(*XtSelectionCallbackPro)</function></funcdef> @@ -1322,6 +1374,8 @@ Specifies the size in bits of the data in each element of <emphasis remap='I'>va </listitem> </varlistentry> </variablelist> +</refentry> + <para> This procedure is called by the Intrinsics selection mechanism to deliver the requested selection to the requestor. @@ -1345,6 +1399,7 @@ or <xref linkend='XtGetSelectionValues' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetSelectionValue'> <funcprototype> <funcdef>void <function>XtGetSelectionValue</function></funcdef> @@ -1428,6 +1483,8 @@ is not acceptable. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetSelectionValue' xrefstyle='select: title'/> @@ -1446,6 +1503,7 @@ For more information about <emphasis remap='I'>selection</emphasis>, <olink targetdoc='icccm' targetptr='icccm'>Inter-Client Communication Conventions Manual.</olink>. </para> +<refentry> <funcsynopsis id='XtGetSelectionValues'> <funcprototype> <funcdef>void <function>XtGetSelectionValues</function></funcdef> @@ -1540,6 +1598,8 @@ is not acceptable. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetSelectionValues' xrefstyle='select: title'/> @@ -1563,6 +1623,7 @@ be provided in one piece, use <xref linkend='XtOwnSelection' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtOwnSelection'> <funcprototype> <funcdef>Boolean <function>XtOwnSelection</function></funcdef> @@ -1649,6 +1710,8 @@ interested in being called back. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtOwnSelection' xrefstyle='select: title'/> @@ -1693,6 +1756,7 @@ by using that it no longer is to be the selection owner. </para> +<refentry> <funcsynopsis id='XtDisownSelection'> <funcprototype> <funcdef>void <function>XtDisownSelection</function></funcdef> @@ -1735,6 +1799,8 @@ relinquish selection ownership was initiated. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtDisownSelection' xrefstyle='select: title'/> @@ -1813,6 +1879,7 @@ selection data to the Intrinsics is of type typedef XtPointer XtRequestId; </literallayout> +<refentry> <funcsynopsis id='XtConvertSelectionIncrProc'> <funcprototype> <funcdef>typedef Boolean <function>(*XtConvertSelectionIncrProc)</function></funcdef> @@ -1941,6 +2008,8 @@ Specifies an opaque identification for a specific request. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This procedure is called repeatedly by the Intrinsics selection mechanism to get the next incremental chunk of data from a selection owner who has @@ -1978,6 +2047,7 @@ type <xref linkend='XtLoseSelectionIncrProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtLoseSelectionIncrProc'> <funcprototype> <funcdef>typedef void <function>(*XtLoseSelectionIncrProc)</function></funcdef> @@ -2020,6 +2090,8 @@ took ownership of the selection. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This procedure, which is optional, is called by the Intrinsics to inform the selection owner that it no longer owns the selection. @@ -2032,6 +2104,7 @@ the storage containing the data is of type <xref linkend='XtSelectionDoneIncrProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSelectionDoneIncrProc'> <funcprototype> <funcdef>typedef void <function>(*XtSelectionDoneIncrProc)</function></funcdef> @@ -2096,6 +2169,8 @@ took ownership of the selection. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This procedure, which is optional, is called by the Intrinsics after the requestor has retrieved the final (zero-length) segment of the @@ -2111,6 +2186,7 @@ notify it if a transfer should be terminated prematurely is of type <xref linkend='XtCancelConvertSelectionProc' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCancelConvertSelectionProc'> <funcprototype> <funcdef>typedef void <function>(*XtCancelConvertSelectionProc)</function></funcdef> @@ -2175,6 +2251,8 @@ the selection. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This procedure is called by the Intrinsics when it has been determined by means of a timeout or other mechanism that any remaining segments @@ -2193,6 +2271,7 @@ or <xref linkend='XtGetSelectionValuesIncremental' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetSelectionValueIncremental'> <funcprototype> <funcdef>void <function>XtGetSelectionValueIncremental</function></funcdef> @@ -2275,6 +2354,8 @@ is not acceptable. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetSelectionValueIncremental' xrefstyle='select: title'/> @@ -2302,6 +2383,7 @@ For more information about <emphasis remap='I'>selection</emphasis>, <olink targetdoc='icccm' targetptr='icccm'>Inter-Client Communication Conventions Manual.</olink> </para> +<refentry> <funcsynopsis id='XtGetSelectionValuesIncremental'> <funcprototype> <funcdef>void <function>XtGetSelectionValuesIncremental</function></funcdef> @@ -2396,6 +2478,8 @@ is not acceptable. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetSelectionValuesIncremental' xrefstyle='select: title'/> @@ -2425,6 +2509,7 @@ To set the selection owner when using incremental transfers, use <xref linkend='XtOwnSelectionIncremental' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtOwnSelectionIncremental'> <funcprototype> <funcdef>Boolean <function>XtOwnSelectionIncremental</function></funcdef> @@ -2533,6 +2618,8 @@ the callback procedures when they are called. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtOwnSelectionIncremental' xrefstyle='select: title'/> @@ -2589,6 +2676,7 @@ use <xref linkend='XtSetSelectionParameters' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetSelectionParameters'> <funcprototype> <funcdef>void <function>XtSetSelectionParameters</function></funcdef> @@ -2664,6 +2752,8 @@ Specifies the size in bits of the data in the elements of <emphasis remap='I'>va </listitem> </varlistentry> </variablelist> +</refentry> + <para> The specified parameters are copied and stored in a new property of the specified type and format on the requestor's window. To initiate @@ -2712,6 +2802,7 @@ the selection owner calls <xref linkend='XtGetSelectionParameters' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetSelectionParameters'> <funcprototype> <funcdef>void <function>XtGetSelectionParameters</function></funcdef> @@ -2802,6 +2893,8 @@ in the elements of <emphasis remap='I'>value</emphasis> is stored. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtGetSelectionParameters' xrefstyle='select: title'/> may be called only from within an @@ -2828,6 +2921,7 @@ and <xref linkend='XtSendSelectionRequest' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCreateSelectionRequest'> <funcprototype> <funcdef>void <function>XtCreateSelectionRequest</function></funcdef> @@ -2858,6 +2952,8 @@ Specifies the particular selection desired. </listitem> </varlistentry> </variablelist> +</refentry> + <para> When <xref linkend='XtCreateSelectionRequest' xrefstyle='select: title'/> @@ -2874,6 +2970,7 @@ multiple targets. The request is made by calling <xref linkend='XtSendSelectionRequest' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSendSelectionRequest'> <funcprototype> <funcdef>void <function>XtSendSelectionRequest</function></funcdef> @@ -2918,6 +3015,8 @@ is not acceptable. </listitem> </varlistentry> </variablelist> +</refentry> + <para> When <xref linkend='XtSendSelectionRequest' xrefstyle='select: title'/> @@ -2953,6 +3052,7 @@ To relinquish the composition of a MULTIPLE request without sending it, use <xref linkend='XtCancelSelectionRequest' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtCancelSelectionRequest'> <funcprototype> <funcdef>void <function>XtCancelSelectionRequest</function></funcdef> @@ -2983,6 +3083,8 @@ Specifies the particular selection desired. </listitem> </varlistentry> </variablelist> +</refentry> + <para> When <xref linkend='XtCancelSelectionRequest' xrefstyle='select: title'/> @@ -3019,6 +3121,7 @@ request, the client may call <xref linkend='XtReservePropertyAtom' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtReservePropertyAtom'> <funcprototype> <funcdef>Atom <function>XtReservePropertyAtom</function></funcdef> @@ -3038,6 +3141,8 @@ Specifies the widget making a selection request. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtReservePropertyAtom' xrefstyle='select: title'/> returns an atom that may be used as a property name during selection @@ -3052,6 +3157,7 @@ the property named by that atom, use <xref linkend='XtReleasePropertyAtom' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtReleasePropertyAtom'> <funcprototype> <funcdef>void <function>XtReleasePropertyAtom</function></funcdef> @@ -3084,6 +3190,8 @@ that is to be released for reuse. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtReleasePropertyAtom' xrefstyle='select: title'/> marks the specified property name atom as @@ -3104,6 +3212,7 @@ that contained a timestamp, use <xref linkend='XtLastTimestampProcessed' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtLastTimestampProcessed'> <funcprototype> <funcdef>Time <function>XtLastTimestampProcessed</function></funcdef> @@ -3123,6 +3232,8 @@ Specifies an open display connection. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If no <function>KeyPress</function>, @@ -3152,6 +3263,7 @@ for a specific display, use <xref linkend='XtLastEventProcessed' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtLastEventProcessed'> <funcprototype> <funcdef>XEvent *<function>XtLastEventProcessed</function></funcdef> @@ -3171,6 +3283,8 @@ Specifies the display connection from which to retrieve the event. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Returns the last event passed to <xref linkend='XtDispatchEvent' xrefstyle='select: title'/> @@ -3206,6 +3320,7 @@ events into a region, use <xref linkend='XtAddExposureToRegion' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAddExposureToRegion'> <funcprototype> <funcdef>void <function>XtAddExposureToRegion</function></funcdef> @@ -3241,6 +3356,8 @@ Specifies the region object (as defined in </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAddExposureToRegion' xrefstyle='select: title'/> @@ -3270,6 +3387,7 @@ window absolute coordinates, use <xref linkend='XtTranslateCoords' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtTranslateCoords'> <funcprototype> <funcdef>void <function>XtTranslateCoords</function></funcdef> @@ -3327,6 +3445,8 @@ Return the root-relative x and y coordinates. </listitem> </varlistentry> </variablelist> +</refentry> + <para> While <xref linkend='XtTranslateCoords' xrefstyle='select: title'/> @@ -3344,6 +3464,7 @@ To translate a given window and display pointer into a widget instance, use <xref linkend='XtWindowToWidget' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtWindowToWidget'> <funcprototype> <funcdef>Widget <function>XtWindowToWidget</function></funcdef> @@ -3374,6 +3495,8 @@ Specifies the drawable for which you want the widget. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If there is a realized widget whose window is the specified drawable on the specified <emphasis remap='I'>display</emphasis>, @@ -3439,6 +3562,7 @@ an application- or widget-specific database), use <xref linkend='XtAppGetErrorDatabase' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppGetErrorDatabase'> <funcprototype> <funcdef>XrmDatabase *<function>XtAppGetErrorDatabase</function></funcdef> <paramdef>XtAppContext <parameter>app_context</parameter></paramdef> @@ -3457,6 +3581,8 @@ Specifies the application context. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppGetErrorDatabase' xrefstyle='select: title'/> @@ -3476,6 +3602,7 @@ The high-level error and warning handler procedure pointers are of type <xref linkend='XtErrorMsgHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtErrorMsgHandler'> <funcprototype> <funcdef>typedef void <function>(*XtErrorMsgHandler)</function></funcdef> @@ -3552,6 +3679,8 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The specified name can be a general kind of error, like "invalidParameters" or "invalidWindow", @@ -3568,6 +3697,7 @@ error or a warning by calling <xref linkend='XtAppGetErrorDatabaseText' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppGetErrorDatabaseText'> <funcprototype> <funcdef>void <function>XtAppGetErrorDatabaseText</function></funcdef> @@ -3595,11 +3725,6 @@ Specifies the application context. <term> <emphasis remap='I'>name</emphasis> </term> - <listitem> - <para></para> - </listitem> - </varlistentry> - <varlistentry> <term> <emphasis remap='I'>type</emphasis> </term> @@ -3662,6 +3787,8 @@ or NULL if the application context's error database is to be used. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppGetErrorDatabaseText' xrefstyle='select: title'/> @@ -3681,6 +3808,7 @@ for a particular Display, use <xref linkend='XtGetApplicationNameAndClass' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetApplicationNameAndClass'> <funcprototype> <funcdef>void <function>XtGetApplicationNameAndClass</function></funcdef> @@ -3723,6 +3851,8 @@ Returns the application class. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtGetApplicationNameAndClass' xrefstyle='select: title'/> returns the application name and class passed to @@ -3738,6 +3868,7 @@ To register a procedure to be called on fatal error conditions, use <xref linkend='XtAppSetErrorMsgHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppSetErrorMsgHandler'> <funcprototype> <funcdef>XtErrorMsgHandler <function>XtAppSetErrorMsgHandler</function></funcdef> @@ -3768,6 +3899,8 @@ Specifies the new fatal error procedure, which should not return. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtAppSetErrorMsgHandler' xrefstyle='select: title'/> returns a pointer to the previously @@ -3786,6 +3919,7 @@ To call the high-level error handler, use <xref linkend='XtAppErrorMsg' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppErrorMsg'> <funcprototype> <funcdef>void <function>XtAppErrorMsg</function></funcdef> @@ -3871,6 +4005,8 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The Intrinsics internal errors all have class "XtToolkitError". @@ -3881,6 +4017,7 @@ To register a procedure to be called on nonfatal error conditions, use <xref linkend='XtAppSetWarningMsgHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppSetWarningMsgHandler'> <funcprototype> <funcdef>XtErrorMsgHandler <function>XtAppSetWarningMsgHandler</function></funcdef> @@ -3911,6 +4048,8 @@ Specifies the new nonfatal error procedure, which usually returns. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtAppSetWarningMsgHandler' xrefstyle='select: title'/> returns a pointer to the previously @@ -3927,6 +4066,7 @@ To call the installed high-level warning handler, use <xref linkend='XtAppWarningMsg' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppWarningMsg'> <funcprototype> <funcdef>void <function>XtAppWarningMsg</function></funcdef> @@ -4012,6 +4152,8 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The Intrinsics internal warnings all have class "XtToolkitError". @@ -4022,6 +4164,7 @@ The low-level error and warning handler procedure pointers are of type <xref linkend='XtErrorHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtErrorHandler'> <funcprototype> <funcdef>typedef void <function>(*XtErrorHandler)</function></funcdef> @@ -4041,6 +4184,8 @@ Specifies the error message. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The error handler should display the message string in some appropriate fashion. </para> @@ -4050,6 +4195,7 @@ To register a procedure to be called on fatal error conditions, use <xref linkend='XtAppSetErrorHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppSetErrorHandler'> <funcprototype> <funcdef>XtErrorHandler <function>XtAppSetErrorHandler</function></funcdef> @@ -4080,6 +4226,8 @@ Specifies the new fatal error procedure, which should not return. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtAppSetErrorHandler' xrefstyle='select: title'/> returns a pointer to the previously installed @@ -4098,6 +4246,7 @@ To call the installed fatal error procedure, use <xref linkend='XtAppError' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppError'> <funcprototype> <funcdef>void <function>XtAppError</function></funcdef> @@ -4128,6 +4277,8 @@ Specifies the message to be reported. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Most programs should use <xref linkend='XtAppErrorMsg' xrefstyle='select: title'/>, @@ -4141,6 +4292,7 @@ To register a procedure to be called on nonfatal error conditions, use <xref linkend='XtAppSetWarningHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppSetWarningHandler'> <funcprototype> <funcdef>XtErrorHandler <function>XtAppSetWarningHandler</function></funcdef> @@ -4171,6 +4323,8 @@ Specifies the new nonfatal error procedure, which usually returns. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtAppSetWarningHandler' xrefstyle='select: title'/> returns a pointer to the previously installed @@ -4186,6 +4340,7 @@ To call the installed nonfatal error procedure, use <xref linkend='XtAppWarning' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppWarning'> <funcprototype> <funcdef>void <function>XtAppWarning</function></funcdef> @@ -4216,6 +4371,8 @@ Specifies the nonfatal error message to be reported. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Most programs should use <xref linkend='XtAppWarningMsg' xrefstyle='select: title'/>, @@ -4233,6 +4390,7 @@ property on a widget's window by calling <xref linkend='XtSetWMColormapWindows' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetWMColormapWindows'> <funcprototype> <funcdef>void <function>XtSetWMColormapWindows</function></funcdef> @@ -4276,6 +4434,8 @@ Specifies the number of widgets in <emphasis remap='I'>list</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <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. @@ -4335,6 +4495,7 @@ fashion by an procedure. </para> +<refentry> <funcsynopsis id='XtFilePredicate'> <funcprototype> <funcdef>typedef Boolean <function>(*XtFilePredicate)</function></funcdef> @@ -4354,6 +4515,8 @@ Specifies a potential filename. </listitem> </varlistentry> </variablelist> +</refentry> + <para> A file predicate procedure is called with a string that is potentially a file name. It should return @@ -4368,6 +4531,7 @@ To search for a file using substitutions in a path list, use <xref linkend='XtFindFile' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtFindFile'> <funcprototype> <funcdef>String <function>XtFindFile</function></funcdef> @@ -4420,6 +4584,8 @@ Specifies a procedure called to judge each potential file name, or NULL. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <emphasis remap='I'>path</emphasis> parameter specifies a string that consists of a series of potential file names delimited by colons. Within each name, the @@ -4474,6 +4640,7 @@ To search for a file using standard substitutions in a path list, use <xref linkend='XtResolvePathname' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtResolvePathname'> <funcprototype> <funcdef>String <function>XtResolvePathname</function></funcdef> @@ -4564,6 +4731,8 @@ Specifies a procedure called to judge each potential file name, or NULL. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The substitutions specified by <xref linkend='XtResolvePathname' xrefstyle='select: title'/> @@ -4810,6 +4979,7 @@ To retrieve the hook registration widget, use <xref linkend='XtHooksOfDisplay' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtHooksOfDisplay'> <funcprototype> <funcdef>Widget <function>XtHooksOfDisplay</function></funcdef> @@ -4829,6 +4999,8 @@ Specifies the desired display. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The class of this object is a private, implementation-dependent subclass of @@ -4906,7 +5078,7 @@ as an argument: <para> The resource names, classes, and representation types that are specified in the hook object resource list are: -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -5429,6 +5601,7 @@ use <xref linkend='XtGetDisplays' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetDisplays'> <funcprototype> <funcdef>void <function>XtGetDisplays</function></funcdef> @@ -5471,6 +5644,8 @@ Returns the count of open Display connections in <emphasis remap='I'>dpy_return< </listitem> </varlistentry> </variablelist> +</refentry> + <para> <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 diff --git a/specs/CH12.xml b/specs/CH12.xml index dc081ff..a338688 100755..100644 --- a/specs/CH12.xml +++ b/specs/CH12.xml @@ -229,7 +229,7 @@ The resource names, classes, and representation types specified in the resource list are: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -648,7 +648,7 @@ typedef struct _RectObjRec* RectObj; The resource names, classes, and representation types that are specified in the <function>rectObjClassRec</function> resource list are: -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> diff --git a/specs/CH13.xml b/specs/CH13.xml index b8c1b8b..b8c1b8b 100755..100644 --- a/specs/CH13.xml +++ b/specs/CH13.xml diff --git a/specs/acknowledgement.xml b/specs/acknowledgement.xml index 4458d9f..4458d9f 100755..100644 --- a/specs/acknowledgement.xml +++ b/specs/acknowledgement.xml diff --git a/specs/appA.xml b/specs/appA.xml index daf40eb..daf40eb 100755..100644 --- a/specs/appA.xml +++ b/specs/appA.xml diff --git a/specs/appB.xml b/specs/appB.xml index 05787ca..8062c48 100755..100644 --- a/specs/appB.xml +++ b/specs/appB.xml @@ -249,7 +249,7 @@ The use of "None" for a modifier list is identical to the use of an exclamation point with no modifers. </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -420,7 +420,7 @@ Xlib symbolic event type names, the following event type synonyms are defined: </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -590,7 +590,7 @@ are defined: <para>The supported abbreviations are:</para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='3' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> diff --git a/specs/appC.xml b/specs/appC.xml index f825e0b..b4a7bfd 100755..100644 --- a/specs/appC.xml +++ b/specs/appC.xml @@ -77,6 +77,7 @@ or <xref linkend='XtVaAppInitialize' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppInitialize'> <funcprototype> <funcdef>Widget <function>XtAppInitialize</function></funcdef> @@ -186,6 +187,8 @@ Specifies the number of entries in the argument list. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAppInitialize' xrefstyle='select: title'/> @@ -214,6 +217,7 @@ is called with the value prior to calling <xref linkend='XtOpenDisplay' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtVaAppInitialize'> <funcprototype> <funcdef>Widget <function>XtVaAppInitialize</function></funcdef> @@ -311,6 +315,8 @@ resource specifications for the created shell. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtVaAppInitialize' xrefstyle='select: title'/> @@ -340,6 +346,7 @@ and <xref linkend='XtGetSelectionTimeout' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtInitialize'> <funcprototype> <funcdef>Widget <function>XtInitialize</function></funcdef> @@ -416,6 +423,8 @@ Specifies the command line parameters. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtInitialize' xrefstyle='select: title'/> calls @@ -453,6 +462,7 @@ This routine has been replaced by <xref linkend='XtAppMainLoop' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtNextEvent'> <funcprototype> <funcdef>void <function>XtNextEvent</function></funcdef> @@ -472,6 +482,8 @@ Returns the event information to the specified event structure. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If no input is on the X input queue for the default application context, <xref linkend='XtNextEvent' xrefstyle='select: title'/> @@ -484,6 +496,7 @@ This routine has been replaced by must be called before using this routine. </para> +<refentry> <funcsynopsis id='XtProcessEvent'> <funcprototype> <funcdef>void <function>XtProcessEvent</function></funcdef> @@ -503,6 +516,8 @@ Specifies the type of input to process. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtProcessEvent' xrefstyle='select: title'/> processes one X event, timeout, or alternate input source @@ -513,6 +528,7 @@ It has been replaced by must be called before using this function. </para> +<refentry> <funcsynopsis id='XtPeekEvent'> <funcprototype> <funcdef>Boolean <function>XtPeekEvent</function></funcdef> @@ -532,6 +548,8 @@ Returns the event information to the specified event structure. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If there is an event in the queue for the default application context, <xref linkend='XtPeekEvent' xrefstyle='select: title'/> @@ -572,6 +590,7 @@ It has been replaced by must be called before using this routine. </para> +<refentry> <funcsynopsis id='XtAddInput'> <funcprototype> <funcdef>XtInputId <function>XtAddInput</function></funcdef> @@ -626,6 +645,8 @@ Specifies the parameter to be passed to <emphasis remap='I'>proc</emphasis> when </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAddInput' xrefstyle='select: title'/> @@ -644,6 +665,7 @@ This routine has been replaced by must be called before using this routine. </para> +<refentry> <funcsynopsis id='XtAddTimeOut'> <funcprototype> <funcdef>XtIntervalId <function>XtAddTimeOut</function></funcdef> @@ -685,6 +707,8 @@ Specifies the parameter to be passed to <emphasis remap='I'>proc</emphasis> when </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtAddTimeOut' xrefstyle='select: title'/> @@ -699,6 +723,7 @@ This routine has been replaced by must be called before using this routine. </para> +<refentry> <funcsynopsis id='XtAddWorkProc'> <funcprototype> <funcdef>XtWorkProcId <function>XtAddWorkProc</function></funcdef> @@ -729,6 +754,8 @@ Client data to pass to <emphasis remap='I'>proc</emphasis> when it is called. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This routine registers a work procedure in the default application context. It has been replaced by @@ -737,6 +764,7 @@ been replaced by must be called before using this routine. </para> +<refentry> <funcsynopsis id='XtCreateApplicationShell'> <funcprototype> <funcdef>Widget <function>XtCreateApplicationShell</function></funcdef> @@ -792,6 +820,8 @@ Specifies the number of entries in <emphasis remap='I'>args</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The procedure <xref linkend='XtCreateApplicationShell' xrefstyle='select: title'/> @@ -810,6 +840,7 @@ An old-format resource type converter procedure pointer is of type <xref linkend='XtConverter' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtConverter'> <funcprototype> <funcdef>typedef void <function>(*XtConverter)</function></funcdef> @@ -866,6 +897,8 @@ Specifies the descriptor to use to return the converted value. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Type converters should perform the following actions: </para> @@ -919,6 +952,7 @@ function is a convenience routine for old-format resource converters that convert from strings. </para> +<refentry> <funcsynopsis id='XtStringConversionWarning'> <funcprototype> <funcdef>void <function>XtStringConversionWarning</function></funcdef> @@ -948,6 +982,8 @@ Specifies the name of the type to which the string could not be converted. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtStringConversionWarning' xrefstyle='select: title'/> @@ -965,6 +1001,7 @@ or <xref linkend='XtAppAddConverter' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAddConverter'> <funcprototype> <funcdef>void <function>XtAddConverter</function></funcdef> @@ -1028,6 +1065,8 @@ Specifies the number of entries in <emphasis remap='I'>convert_args</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtAddConverter' xrefstyle='select: title'/> is equivalent in function to @@ -1038,6 +1077,7 @@ for old-format type converters. It has been superseded by <xref linkend='XtSetTypeConverter' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAppAddConverter'> <funcprototype> <funcdef>void <function>XtAppAddConverter</function></funcdef> @@ -1112,6 +1152,8 @@ Specifies the number of entries in <emphasis remap='I'>convert_args</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> <xref linkend='XtAppAddConverter' xrefstyle='select: title'/> is equivalent in function to @@ -1129,6 +1171,7 @@ or, for old-format converters only, <xref linkend='XtDirectConvert' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtConvert'> <funcprototype> <funcdef>void <function>XtConvert</function></funcdef> @@ -1193,7 +1236,10 @@ Returns the converted value. </listitem> </varlistentry> </variablelist> +</refentry> + +<refentry> <funcsynopsis id='XtDirectConvert'> <funcprototype> <funcdef>void <function>XtDirectConvert</function></funcdef> @@ -1258,6 +1304,8 @@ Returns the converted value. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtConvert' xrefstyle='select: title'/> @@ -1301,6 +1349,7 @@ To deallocate a shared GC when it is no longer needed, use <xref linkend='XtDestroyGC' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtDestroyGC'> <funcprototype> <funcdef>void <function>XtDestroyGC</function></funcdef> @@ -1332,6 +1381,8 @@ Specifies the shared GC to be deallocated. </listitem> </varlistentry> </variablelist> +</refentry> + <para> 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. @@ -1350,6 +1401,7 @@ and register it with the translation manager, use <xref linkend='XtAddActions' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtAddActions'> <funcprototype> <funcdef>void <function>XtAddActions</function></funcdef> @@ -1380,6 +1432,8 @@ Specifies the number of entries in <emphasis remap='I'>actions</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> If more than one action is registered with the same name, the most recently registered action is used. @@ -1401,6 +1455,7 @@ To set the Intrinsics selection timeout in the default application context, use <xref linkend='XtSetSelectionTimeout' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetSelectionTimeout'> <funcprototype> <funcdef>void <function>XtSetSelectionTimeout</function></funcdef> @@ -1425,6 +1480,8 @@ must be called before using this routine. </listitem> </varlistentry> </variablelist> +</refentry> + <para> To get the current selection timeout value in the default application @@ -1483,6 +1540,7 @@ error or a warning by calling <xref linkend='XtGetErrorDatabaseText' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtGetErrorDatabaseText'> <funcprototype> <funcdef>void <function>XtGetErrorDatabaseText</function></funcdef> @@ -1554,6 +1612,8 @@ Specifies the size of the buffer in bytes. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The <xref linkend='XtGetErrorDatabaseText' xrefstyle='select: title'/> @@ -1574,6 +1634,7 @@ To register a procedure to be called on fatal error conditions, use <xref linkend='XtSetErrorMsgHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetErrorMsgHandler'> <funcprototype> <funcdef>void <function>XtSetErrorMsgHandler</function></funcdef> @@ -1593,6 +1654,8 @@ Specifies the new fatal error procedure, which should not return. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The default error handler provided by the Intrinsics constructs a string from the error resource database and calls @@ -1609,6 +1672,7 @@ To call the high-level error handler, use <xref linkend='XtErrorMsg' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtErrorMsg'> <funcprototype> <funcdef>void <function>XtErrorMsg</function></funcdef> @@ -1683,6 +1747,8 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This routine has been superseded by <xref linkend='XtAppErrorMsg' xrefstyle='select: title'/>. @@ -1693,6 +1759,7 @@ To register a procedure to be called on nonfatal error conditions, use <xref linkend='XtSetWarningMsgHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetWarningMsgHandler'> <funcprototype> <funcdef>void <function>XtSetWarningMsgHandler</function></funcdef> @@ -1712,6 +1779,8 @@ Specifies the new nonfatal error procedure, which usually returns. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The default warning handler provided by the Intrinsics constructs a string from the error resource database and calls @@ -1725,6 +1794,7 @@ To call the installed high-level warning handler, use <xref linkend='XtWarningMsg' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtWarningMsg'> <funcprototype> <funcdef>void <function>XtWarningMsg</function></funcdef> @@ -1799,6 +1869,8 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>. </listitem> </varlistentry> </variablelist> +</refentry> + <para> This routine has been superseded by <xref linkend='XtAppWarningMsg' xrefstyle='select: title'/>. @@ -1809,6 +1881,7 @@ To register a procedure to be called on fatal error conditions, use <xref linkend='XtSetErrorHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetErrorHandler'> <funcprototype> <funcdef>void <function>XtSetErrorHandler</function></funcdef> @@ -1828,6 +1901,8 @@ Specifies the new fatal error procedure, which should not return. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The default error handler provided by the Intrinsics is <function>_XtError</function>. @@ -1845,6 +1920,7 @@ To call the installed fatal error procedure, use <xref linkend='XtError' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtError'> <funcprototype> <funcdef>void <function>XtError</function></funcdef> @@ -1864,6 +1940,8 @@ Specifies the message to be reported. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Most programs should use <xref linkend='XtAppErrorMsg' xrefstyle='select: title'/>, @@ -1879,6 +1957,7 @@ To register a procedure to be called on nonfatal error conditions, use <xref linkend='XtSetWarningHandler' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtSetWarningHandler'> <funcprototype> <funcdef>void <function>XtSetWarningHandler</function></funcdef> @@ -1898,6 +1977,8 @@ Specifies the new nonfatal error procedure, which usually returns. </listitem> </varlistentry> </variablelist> +</refentry> + <para> The default warning handler provided by the Intrinsics is <function>_XtWarning</function>. @@ -1912,6 +1993,7 @@ To call the installed nonfatal error procedure, use <xref linkend='XtWarning' xrefstyle='select: title'/>. </para> +<refentry> <funcsynopsis id='XtWarning'> <funcprototype> <funcdef>void <function>XtWarning</function></funcdef> @@ -1931,6 +2013,8 @@ Specifies the nonfatal error message to be reported. </listitem> </varlistentry> </variablelist> +</refentry> + <para> Most programs should use <xref linkend='XtAppWarningMsg' xrefstyle='select: title'/>, diff --git a/specs/appD.xml b/specs/appD.xml index 7b9db94..dfbeda0 100755..100644 --- a/specs/appD.xml +++ b/specs/appD.xml @@ -10,7 +10,7 @@ Additional implementation-dependent messages are permitted. Error Messages </para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='3' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -265,7 +265,7 @@ Error Messages <para><emphasis role='bold'>Warning Messages</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> diff --git a/specs/appE.xml b/specs/appE.xml index 4df8643..ebb350a 100755..100644 --- a/specs/appE.xml +++ b/specs/appE.xml @@ -8,7 +8,7 @@ class, and representation type symbolic constants. </para> <para><emphasis role='bold'>Resource names:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -405,7 +405,7 @@ class, and representation type symbolic constants. </informaltable> <para><emphasis role='bold'>Resource classes:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -695,7 +695,7 @@ class, and representation type symbolic constants. <para><emphasis role='bold'>Resource representation types:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -916,7 +916,7 @@ class, and representation type symbolic constants. </informaltable> <para><emphasis role='bold'>Boolean enumeration constants:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -957,7 +957,7 @@ class, and representation type symbolic constants. </informaltable> <para><emphasis role='bold'>Orientation enumeration constants:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -983,7 +983,7 @@ class, and representation type symbolic constants. <para><emphasis role='bold'>Text edit enumeration constants:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1012,7 +1012,7 @@ class, and representation type symbolic constants. </informaltable> <para><emphasis role='bold'>Color enumeration constants:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' rowsep='0' colsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1037,7 +1037,7 @@ class, and representation type symbolic constants. </informaltable> <para><emphasis role='bold'>Font constant:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1058,7 +1058,7 @@ class, and representation type symbolic constants. </informaltable> <para><emphasis role='bold'>Hooks for External Agents constants:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1190,7 +1190,7 @@ class, and representation type symbolic constants. </para> <para><emphasis role='bold'>Resource names:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1447,7 +1447,7 @@ class, and representation type symbolic constants. </informaltable> <para><emphasis role='bold'>Resource classes:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="auto" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> @@ -1681,7 +1681,7 @@ class, and representation type symbolic constants. <para><emphasis role='bold'>Resource representation types:</emphasis></para> -<informaltable frame='topbot'> +<informaltable frame='topbot' tabstyle='simpleheadertable'> <?dbfo keep-together="always" ?> <tgroup cols='2' align='left' colsep='0' rowsep='0'> <colspec colwidth='1.0*' colname='c1'/> diff --git a/specs/appF.xml b/specs/appF.xml index f06df27..f06df27 100755..100644 --- a/specs/appF.xml +++ b/specs/appF.xml diff --git a/specs/intrinsics.xml b/specs/intrinsics.xml index 5df21ce..5df21ce 100755..100644 --- a/specs/intrinsics.xml +++ b/specs/intrinsics.xml diff --git a/specs/preface.xml b/specs/preface.xml index a7b10aa..a7b10aa 100755..100644 --- a/specs/preface.xml +++ b/specs/preface.xml |