summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Dew <marcoz@osource.org>2011-10-25 23:21:16 -0600
committerMatt Dew <marcoz@osource.org>2011-10-25 23:21:16 -0600
commit7791a5fe02efe98e5c5ae4fd3992d7d3f7ad5541 (patch)
tree7a418789789437c94334e996892f0fb31429bac2
parentc0ab4506032fa55a3a86c17de1664bf2d35bd40d (diff)
proofread CH11.xml
-rw-r--r--specs/CH11.xml129
1 files changed, 64 insertions, 65 deletions
diff --git a/specs/CH11.xml b/specs/CH11.xml
index 71325ea..7dc837c 100644
--- a/specs/CH11.xml
+++ b/specs/CH11.xml
@@ -330,7 +330,7 @@ To change the size of an allocated block of storage, use
<funcsynopsis id='XtRealloc'>
<funcprototype>
-<funcdef>char * <function>XtRealloc</function></funcdef>
+<funcdef>char *<function>XtRealloc</function></funcdef>
<paramdef>char *<parameter>ptr</parameter></paramdef>
<paramdef>Cardinal <parameter>num</parameter></paramdef>
</funcprototype>
@@ -897,7 +897,7 @@ data to the Intrinsics is of type
<funcsynopsis id='XtConvertSelectionProc'>
<funcprototype>
-<funcdef>Boolean <function>*XtConvertSelectionProc</function></funcdef>
+<funcdef>typedef Boolean <function>(*XtConvertSelectionProc)</function></funcdef>
<paramdef>Widget <parameter>w</parameter></paramdef>
<paramdef>Atom *<parameter>selection</parameter></paramdef>
<paramdef>Atom *<parameter>target</parameter></paramdef>
@@ -1115,7 +1115,7 @@ notification upon losing ownership is of type
<funcsynopsis id='XtLoseSelectionProc'>
<funcprototype>
-<funcdef>void <function>*XtLoseSelectionProc</function></funcdef>
+<funcdef>typedef void <function>(*XtLoseSelectionProc)</function></funcdef>
<paramdef>Widget <parameter>w</parameter></paramdef>
<paramdef>Atom *<parameter>selection</parameter></paramdef>
</funcprototype>
@@ -1159,7 +1159,7 @@ containing the data is of type
<funcsynopsis id='XtSelectionDoneProc'>
<funcprototype>
-<funcdef>void <function>*XtSelectionDoneProc</function></funcdef>
+<funcdef>typedef void <function>(*XtSelectionDoneProc)</function></funcdef>
<paramdef>Widget <parameter>w</parameter></paramdef>
<paramdef>Atom *<parameter>selection</parameter></paramdef>
<paramdef>Atom *<parameter>target</parameter></paramdef>
@@ -1223,7 +1223,7 @@ selection data from the Intrinsics is of type
<funcsynopsis id='XtSelectionCallbackProc'>
<funcprototype>
-<funcdef>void <function>*XtSelectionCallbackProc</function></funcdef>
+<funcdef>typedef void <function>(*XtSelectionCallbackPro)</function></funcdef>
<paramdef>Widget <parameter>w</parameter></paramdef>
<paramdef>XtPointer <parameter>client_data</parameter></paramdef>
<paramdef>Atom *<parameter>selection</parameter></paramdef>
@@ -1808,7 +1808,7 @@ typedef XtPointer XtRequestId;
<funcsynopsis id='XtConvertSelectionIncrProc'>
<funcprototype>
-<funcdef>Boolean <function>*XtConvertSelectionIncrProc</function></funcdef>
+<funcdef>typedef Boolean <function>(*XtConvertSelectionIncrProc)</function></funcdef>
<paramdef>Widget <parameter>w</parameter></paramdef>
<paramdef>Atom *<parameter>selection</parameter></paramdef>
<paramdef>Atom *<parameter>target</parameter></paramdef>
@@ -1973,8 +1973,7 @@ type
<funcsynopsis id='XtLoseSelectionIncrProc'>
<funcprototype>
-<funcdef>void <function>*XtLoseSelectionIncrProc</function></funcdef>
-
+<funcdef>typedef void <function>(*XtLoseSelectionIncrProc)</function></funcdef>
<paramdef>Widget <parameter>w</parameter></paramdef>
<paramdef>Atom *<parameter>selection</parameter></paramdef>
<paramdef>XtPointer <parameter>client_data</parameter></paramdef>
@@ -2028,8 +2027,7 @@ the storage containing the data is of type
<funcsynopsis id='XtSelectionDoneIncrProc'>
<funcprototype>
-<funcdef>void <function>*XtSelectionDoneIncrProc</function></funcdef>
-
+<funcdef>typedef void <function>(*XtSelectionDoneIncrProc)</function></funcdef>
<paramdef>Widget <parameter>w</parameter></paramdef>
<paramdef>Atom *<parameter>selection</parameter></paramdef>
<paramdef>Atom *<parameter>target</parameter></paramdef>
@@ -2108,8 +2106,7 @@ notify it if a transfer should be terminated prematurely is of type
<funcsynopsis id='XtCancelConvertSelectionProc'>
<funcprototype>
-<funcdef>void <function>*XtCancelConvertSelectionProc</function></funcdef>
-
+<funcdef>typedef void <function>(*XtCancelConvertSelectionProc)</function></funcdef>
<paramdef>Widget <parameter>w</parameter></paramdef>
<paramdef>Atom *<parameter>selection</parameter></paramdef>
<paramdef>Atom *<parameter>target</parameter></paramdef>
@@ -2811,7 +2808,7 @@ when the parameters are no longer needed.
<title>Generating MULTIPLE Requests</title>
<para>
To have the Intrinsics bundle multiple calls to make selection requests into
-a single request using a \s-1MULTIPLE\s+1 target, use
+a single request using a <emphasis role='bold'>MULTIPLE</emphasis> target, use
<function>XtCreateSelectionRequest</function>
and
<function>XtSendSelectionRequest</function>.
@@ -3405,8 +3402,11 @@ The high-level functions construct a string to pass to the lower-level
interface.
The strings may be specified in application code and are
overridden by the contents of an external systemwide file,
-the ``error database file''. The location and name of this file are
+the "error database file". The location and name of this file are
implementation-dependent.
+</para>
+<note>
+<para>
The application-context-specific error handling is not
implemented on many systems, although the interfaces are
always present.
@@ -3415,6 +3415,7 @@ for all application contexts within a process.
If they are set for different application contexts,
the ones registered last will prevail.
</para>
+</note>
<para>
To obtain the error database (for example, to merge with
@@ -3423,8 +3424,7 @@ an application- or widget-specific database), use
</para>
<funcsynopsis id='XtAppGetErrorDatabase'>
-<funcprototype>
-<funcdef>XrmDatabase *<function>XtAppGetErrorDatabase</function></funcdef>
+<funcprototype> <funcdef>XrmDatabase *<function>XtAppGetErrorDatabase</function></funcdef>
<paramdef>XtAppContext <parameter>app_context</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -3462,7 +3462,7 @@ The high-level error and warning handler procedure pointers are of type
<funcsynopsis id='XtErrorMsgHandler'>
<funcprototype>
-<funcdef>void <function>*XtErrorMsgHandler</function></funcdef>
+<funcdef>typedef void <function>(*XtErrorMsgHandler)</function></funcdef>
<paramdef>String <parameter>name</parameter></paramdef>
<paramdef>String <parameter>type</parameter></paramdef>
<paramdef>String <parameter>class</parameter></paramdef>
@@ -3538,7 +3538,7 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>.
</variablelist>
<para>
The specified name can be a general kind of error,
-like ``invalidParameters'' or ``invalidWindow'',
+like "invalidParameters" or "invalidWindow",
and the specified type gives extra information
such as the name of the routine in which the error was detected.
Standard
@@ -3653,9 +3653,9 @@ returns the appropriate message from the error database
or returns the specified default message if one is not found in the
error database.
To form the full resource name and class when querying the database,
-the <emphasis remap='I'>name</emphasis> and <emphasis remap='I'>type</emphasis> are concatenated with a single ``.''
+the <emphasis remap='I'>name</emphasis> and <emphasis remap='I'>type</emphasis> are concatenated with a single "."
between them and the <emphasis remap='I'>class</emphasis> is concatenated with itself with a
-single ``.'' if it does not already contain a ``.''.
+single "." if it does not already contain a ".".
</para>
<para>
@@ -3857,7 +3857,7 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>.
</variablelist>
<para>
The Intrinsics internal errors all have class
-``XtToolkitError''.
+"XtToolkitError".
</para>
<para>
@@ -3998,7 +3998,7 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>.
</variablelist>
<para>
The Intrinsics internal warnings all have class
-``XtToolkitError''.
+"XtToolkitError".
</para>
<para>
@@ -4008,8 +4008,7 @@ The low-level error and warning handler procedure pointers are of type
<funcsynopsis id='XtErrorHandler'>
<funcprototype>
-<funcdef>void <function>*XtErrorHandler</function></funcdef>
-
+<funcdef>typedef void <function>(*XtErrorHandler)</function></funcdef>
<paramdef>String <parameter>message</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -4213,7 +4212,7 @@ to provide for customization and internationalization of warning messages.
<sect1 id="Setting_WM_COLORMAP_WINDOWS">
<title>Setting WM_COLORMAP_WINDOWS</title>
<para>
-A client may set the value of the \s-1WM_COLORMAP_WINDOWS\s+1
+A client may set the value of the <emphasis role='bold'>WM_COLORMAP_WINDOWS</emphasis>
property on a widget's window by calling
<function>XtSetWMColormapWindows</function>.
</para>
@@ -4234,7 +4233,7 @@ property on a widget's window by calling
</term>
<listitem>
<para>
-Specifies the widget on whose window the \s-1WM_COLORMAP_WINDOWS\s+1
+Specifies the widget on whose window the <emphasis role='bold'>WM_COLORMAP_WINDOWS</emphasis>
property is stored. Must be of class Core or any subclass thereof.
</para>
</listitem>
@@ -4246,7 +4245,7 @@ property is stored. Must be of class Core or any subclass thereof.
<listitem>
<para>
Specifies a list of widgets whose windows are potentially to be
-listed in the \s-1WM_COLORMAP_WINDOWS\s+1 property.
+listed in the <emphasis role='bold'>WM_COLORMAP_WINDOWS</emphasis> property.
</para>
</listitem>
</varlistentry>
@@ -4277,10 +4276,10 @@ resources of all widgets whose windows are already on the window list.
<para>
Finally,
<function>XtSetWMColormapWindows</function>
-stores the resulting window list in the \s-1WM_COLORMAP_WINDOWS\s+1
+stores the resulting window list in the <emphasis role='bold'>WM_COLORMAP_WINDOWS</emphasis>
property on the specified widget's window.
Refer to Section 4.1.8 in the <emphasis remap='I'>Inter-Client Communication Conventions Manual.</emphasis> for details of
-the semantics of the \s-1WM_COLORMAP_WINDOWS\s+1 property.
+the semantics of the <emphasis role='bold'>WM_COLORMAP_WINDOWS</emphasis> property.
</para>
</sect1>
@@ -4322,8 +4321,7 @@ procedure.
<funcsynopsis id='XtFilePredicate'>
<funcprototype>
-<funcdef>Boolean <function>*XtFilePredicate</function></funcdef>
-
+<funcdef>typedef Boolean <function>(*XtFilePredicate)</function></funcdef>
<paramdef>String <parameter>filename</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -4410,9 +4408,9 @@ Specifies a procedure called to judge each potential file name, or NULL.
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
percent character specifies a string substitution selected by the
-following character. The character sequence ``%:'' specifies an
+following character. The character sequence "%:" specifies an
embedded colon that is not a delimiter; the sequence is replaced by a
-single colon. The character sequence ``%%'' specifies a percent
+single colon. The character sequence "%%" specifies a percent
character that does not introduce a substitution; the sequence is
replaced by a single percent character. If a percent character is
followed by any other character,
@@ -4424,7 +4422,7 @@ replaces the percent and match characters with the string in the
corresponding <emphasis remap='I'>substitution</emphasis> field. A <emphasis remap='I'>substitution</emphasis> field entry of NULL
is equivalent to a pointer to an empty string. If the operating
system does not interpret multiple embedded name separators in the
-path (i.e., ``/'' in POSIX) the same way as a single separator,
+path (i.e., "/" in POSIX) the same way as a single separator,
<function>XtFindFile</function>
will collapse multiple separators into a single one after performing
all string substitutions. Except for collapsing embedded separators,
@@ -4557,12 +4555,12 @@ are determined from the value of the language string retrieved by
<function>XtDisplayInitialize</function>
for the specified display.
To set the
-language for all applications specify ``*xnlLanguage: <emphasis remap='I'>lang</emphasis>'' in the
+language for all applications specify "*xnlLanguage: <emphasis remap='I'>lang</emphasis>" in the
resource database.
The format and content of the language string are
implementation-defined. One suggested syntax is to compose
-the language string of three parts; a ``language part'', a
-``territory part'' and a ``codeset part''. The manner in which
+the language string of three parts; a "language part", a
+"territory part" and a "codeset part". The manner in which
this composition is accomplished is implementation-defined,
and the Intrinsics make no interpretation of the parts other
than to use them in substitutions as described below.
@@ -4631,20 +4629,26 @@ If a path is passed to
it is passed along to
<function>XtFindFile</function>.
If the <emphasis remap='I'>path</emphasis> argument is NULL, the value of the
-<function>\s-1XFILESEARCHPATH\s+1</function>
+<emphasis role='bold'>XFILESEARCHPATH</emphasis>
environment variable is passed to
<function>XtFindFile</function>.
If
-<function>\s-1XFILESEARCHPATH\s+1</function>
+<emphasis role='bold'>XFILESEARCHPATH</emphasis>
is not defined, an implementation-specific default path is used
that contains at least six entries. These entries
must contain the following substitutions:
-1. %C, %N, %S, %T, %L or %C, %N, %S, %T, %l, %t, %c
-2. %C, %N, %S, %T, %l
-3. %C, %N, %S, %T
-4. %N, %S, %T, %L or %N, %S, %T, %l, %t, %c
-5. %N, %S, %T, %l
-6. %N, %S, %T
+</para>
+
+<literallayout>
+1. %C, %N, %S, %T, %L or %C, %N, %S, %T, %l, %t, %c
+2. %C, %N, %S, %T, %l
+3. %C, %N, %S, %T
+4. %N, %S, %T, %L or %N, %S, %T, %l, %t, %c
+5. %N, %S, %T, %l
+6. %N, %S, %T
+</literallayout>
+
+<para>
The order of these six entries within the path must be as given above.
The order and use of substitutions within a given entry
are implementation-dependent.
@@ -4656,26 +4660,24 @@ adjacent colons, <function>%N%S</function> is inserted between them.
<para>
The <emphasis remap='I'>type</emphasis> parameter is intended to be a category of files, usually
being translated into a directory in the pathname. Possible values
-might include ``app-defaults'', ``help'', and ``bitmap''.
+might include "app-defaults", "help", and "bitmap".
</para>
<para>
The <emphasis remap='I'>suffix</emphasis> parameter is intended to be appended to the file name.
-Possible values might include ``.txt'', ``.dat'', and ``.bm''.
+Possible values might include ".txt", ".dat", and ".bm".
</para>
<para>
A suggested value for the default path on POSIX-based systems is
</para>
-<itemizedlist>
- <listitem>
- <para>
-/usr/lib/X11/%L/%T/%N%C%S:/usr/lib/X11/%l/%T/%N%C%S:\\
-/usr/lib/X11/%T/%N%C%S:/usr/lib/X11/%L/%T/%N%S:\\
-/usr/lib/X11/%l/%T/%N%S:/usr/lib/X11/%T/%N%S
- </para>
- </listitem>
-</itemizedlist>
+<literallayout>
+ /usr/lib/X11/%L/%T/%N%C%S:/usr/lib/X11/%l/%T/%N%C%S:\\
+ /usr/lib/X11/%T/%N%C%S:/usr/lib/X11/%L/%T/%N%S:\\
+ /usr/lib/X11/%l/%T/%N%S:/usr/lib/X11/%T/%N%S
+</literallayout>
+
+
<para>
Using this example, if the user has specified a language, it is
used as a subdirectory of /usr/lib/X11 that is searched for other
@@ -4691,18 +4693,15 @@ The %D substitution allows the addition of path
elements to the implementation-specific default path, typically to
allow additional directories to be searched without preventing
resources in the system directories from being found. For example, a
-user installing resource files under a directory called ``ourdir''
+user installing resource files under a directory called "ourdir"
might set
-<function>\s-1XFILESEARCHPATH\s+1</function>
+<emphasis role='bold'>XFILESEARCHPATH</emphasis>
to
</para>
-<itemizedlist>
- <listitem>
- <para>
-%D:ourdir/%T/%N%C:ourdir/%T/%N
- </para>
- </listitem>
-</itemizedlist>
+<literallayout>
+ %D:ourdir/%T/%N%C:ourdir/%T/%N
+</literallayout>
+
<para>
The customization string is obtained by querying the resource database
currently associated with the display (the database returned by