summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Dew <marcoz@osource.org>2011-10-22 21:17:35 -0600
committerMatt Dew <marcoz@osource.org>2011-10-22 21:17:35 -0600
commit86b829fcc98b0a73d3d9674f6b61e354c4929813 (patch)
tree190e5aeb9d0dc9b457bc160898672e1360751ae6
parentc048e94143a5480c684bd4d927a7411c0597a2c9 (diff)
updated appC.xml
-rw-r--r--specs/appC.xml1215
1 files changed, 460 insertions, 755 deletions
diff --git a/specs/appC.xml b/specs/appC.xml
index 7b8ec9c..53e7c24 100644
--- a/specs/appC.xml
+++ b/specs/appC.xml
@@ -1,81 +1,31 @@
-<!-- .\" $Xorg: appC,v 1.3 2000/08/17 19:42:48 cpqbld Exp $ -->
-<!-- .\" Copyright \(co 1985, 1986, 1987, 1988, 1991, 1994 -->
-<!-- .\" X Consortium -->
-<!-- .\" -->
-<!-- .\" Permission is hereby granted, free of charge, to any person obtaining -->
-<!-- .\" a copy of this software and associated documentation files (the -->
-<!-- .\" "Software"), to deal in the Software without restriction, including -->
-<!-- .\" without limitation the rights to use, copy, modify, merge, publish, -->
-<!-- .\" distribute, sublicense, and/or sell copies of the Software, and to -->
-<!-- .\" permit persons to whom the Software is furnished to do so, subject to -->
-<!-- .\" the following conditions: -->
-<!-- .\" -->
-<!-- .\" The above copyright notice and this permission notice shall be included -->
-<!-- .\" in all copies or substantial portions of the Software. -->
-<!-- .\" -->
-<!-- .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -->
-<!-- .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -->
-<!-- .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -->
-<!-- .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR -->
-<!-- .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -->
-<!-- .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -->
-<!-- .\" OTHER DEALINGS IN THE SOFTWARE. -->
-<!-- .\" -->
-<!-- .\" Except as contained in this notice, the name of the X Consortium shall -->
-<!-- .\" not be used in advertising or otherwise to promote the sale, use or -->
-<!-- .\" other dealings in this Software without prior written authorization -->
-<!-- .\" from the X Consortium. -->
-<!-- .\" -->
-<!-- .\" Copyright \(co 1985, 1986, 1987, 1988, 1991, 1994 -->
-<!-- .\" Digital Equipment Corporation, Maynard, Massachusetts. -->
-<!-- .\" -->
-<!-- .\" Permission to use, copy, modify and distribute this documentation for any -->
-<!-- .\" purpose and without fee is hereby granted, provided that the above copyright -->
-<!-- .\" notice appears in all copies and that both that copyright notice and this -->
-<!-- .\" permission notice appear in supporting documentation, and that the name of -->
-<!-- .\" Digital not be used in in advertising or publicity pertaining -->
-<!-- .\" to distribution of the software without specific, written prior permission. -->
-<!-- .\" Digital makes no representations about the suitability of the -->
-<!-- .\" software described herein for any purpose. -->
-<!-- .\" It is provided ``as is'' without express or implied warranty. -->
-<!-- .\" -->
-<!-- .bp -->
-\&
-<!-- .sp 1 -->
-<!-- .ce 3 -->
-\s+1<function>Appendix C</function>\s-1
-
-\s+1<function>Compatibility Functions</function>\s-1
-<!-- .sp 2 -->
+<appendix id='Compability_Functions'>
+<title>Compatibility Functions
+<footnote>
<para>
-<!-- .LP -->
-<!-- .XS -->
-<!-- <function>Appendix C \(em Compatibility Functions</function> -->
-<!-- .XE -->
-<!-- .FS -->
This appendix is part of the formal Intrinsics Specification.
-<!-- .FE -->
</para>
+</footnote>
+</title>
+
<para>
-<!-- .LP -->
In prototype versions of the (tk
each widget class
implemented an Xt&lt;\^<emphasis remap='I'>Widget</emphasis>\^&gt;Create (for example,
-<function>XtLabelCreate )</function>
+<function>XtLabelCreate</function>)
function, in which most of the code was identical from widget to widget.
-In the (xI, a single generic
+In the Intrinsics, a single generic
<function>XtCreateWidget</function>
performs most of the common work and then calls the initialize procedure
implemented for the particular widget class.
</para>
+
<para>
-<!-- .LP -->
Each Composite class also implemented the procedures
Xt&lt;\^<emphasis remap='I'>Widget</emphasis>\^&gt;Add and an Xt&lt;\^<emphasis remap='I'>Widget</emphasis>\^&gt;Delete (for example,
<function>XtButtonBoxAddButton</function>
and
<function>XtButtonBoxDeleteButton ).</function>
-In the (xI, the Composite generic procedures
+In the Intrinsics, the Composite generic procedures
<function>XtManageChildren</function>
and
<function>XtUnmanageChildren</function>
@@ -85,88 +35,63 @@ implemented for the widget's Composite class.
If the widget's parent has not yet been realized,
the call to the change_managed procedure is delayed until realization time.
</para>
+
<para>
-<!-- .LP -->
Old-style calls can be implemented in the (tk by defining
one-line procedures or macros that invoke a generic routine. For example,
you could define the macro
<function>XtLabelCreate</function>
as:
</para>
-<itemizedlist>
- <listitem>
- <para>
-<literallayout class="monospaced">
-<!-- .TA .5i 3i -->
-<!-- .ta .5i 3i -->
-#define XtLabelCreate(<emphasis remap='I'>name</emphasis>, <emphasis remap='I'>parent</emphasis>, <emphasis remap='I'>args</emphasis>, <emphasis remap='I'>num_args</emphasis>) \\
- ((LabelWidget) XtCreateWidget(<emphasis remap='I'>name</emphasis>, <emphasis remap='I'>labelWidgetClass</emphasis>, \
-<emphasis remap='I'>parent</emphasis>, <emphasis remap='I'>args</emphasis>, <emphasis remap='I'>num_args</emphasis>))
+
+<literallayout class='monospaced'>
+#define XtLabelCreate(name, parent, args, num_args) \
+ ((LabelWidget) XtCreateWidget(name, labelWidgetClass, parent, args, num_args))
</literallayout>
-<!-- .sp -->
- </para>
- </listitem>
-</itemizedlist>
+
<para>
-<!-- .LP -->
Pop-up shells in some of the prototypes automatically performed an
<function>XtManageChild</function>
on their child within their insert_child procedure.
-<!-- .IN "insert_child procedure" -->
Creators of pop-up children need to call
<function>XtManageChild</function>
themselves.
-<!-- .sp -->
</para>
+
<para>
-<!-- .LP -->
<function>XtAppInitialize</function>
and
<function>XtVaAppInitialize</function>
have been replaced by
<function>XtOpenApplication</function>
and
-<function>XtVaOpenApplication .</function>
+<function>XtVaOpenApplication</function>.
</para>
+
<para>
-<!-- .LP -->
-To initialize the (xI internals, create an application context,
+To initialize the Intrinsics internals, create an application context,
open and initialize a display, and create the initial application shell
instance, an application may use
<function>XtAppInitialize</function>
or
-<function>XtVaAppInitialize .</function>
-</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtAppInitialize" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtVaAppInitialize</function>.
</para>
-<!-- .FD 0 -->
-Widget XtAppInitialize(<emphasis remap='I'>app_context_return</emphasis>, <emphasis remap='I'>application_class</emphasis>, \
-<emphasis remap='I'>options</emphasis>, <emphasis remap='I'>num_options</emphasis>,
-<!-- .br -->
- <emphasis remap='I'>argc_in_out</emphasis>, <emphasis remap='I'>argv_in_out</emphasis>, \
-<emphasis remap='I'>fallback_resources</emphasis>, <emphasis remap='I'>args</emphasis>, <emphasis remap='I'>num_args</emphasis>)
-<!-- .br -->
- XtAppContext *<emphasis remap='I'>app_context_return</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>application_class</emphasis>;
-<!-- .br -->
- XrmOptionDescList <emphasis remap='I'>options</emphasis>;
-<!-- .br -->
- Cardinal <emphasis remap='I'>num_options</emphasis>;
-<!-- .br -->
- int *<emphasis remap='I'>argc_in_out</emphasis>;
-<!-- .br -->
- String *<emphasis remap='I'>argv_in_out</emphasis>;
-<!-- .br -->
- String *<emphasis remap='I'>fallback_resources</emphasis>;
-<!-- .br -->
- ArgList <emphasis remap='I'>args</emphasis>;
-<!-- .br -->
- Cardinal <emphasis remap='I'>num_args</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtAppInitialize'>
+<funcprototype>
+<funcdef>Widget <function>XtAppInitialize</function></funcdef>
+ <paramdef>XtAppContext *<parameter>app_context_return</parameter></paramdef>
+ <paramdef>String <parameter>application_class</parameter></paramdef>
+ <paramdef>XrmOptionDescList <parameter>options</parameter></paramdef>
+ <paramdef>Cardinal <parameter>num_options</parameter></paramdef>
+ <paramdef>int *<parameter>argc_in_out</parameter></paramdef>
+ <paramdef>String *<parameter>argv_in_out</parameter></paramdef>
+ <paramdef>String *<parameter>fallback_resources</parameter></paramdef>
+ <paramdef>ArgList <parameter>args</parameter></paramdef>
+ <paramdef>Cardinal <parameter>num_args</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -262,21 +187,19 @@ Specifies the number of entries in the argument list.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
The
<function>XtAppInitialize</function>
function calls
<function>XtToolkitInitialize</function>
followed by
-<function>XtCreateApplicationContext ,</function>
+<function>XtCreateApplicationContext</function>,
then calls
<function>XtOpenDisplay</function>
with <emphasis remap='I'>display_string</emphasis> NULL and
<emphasis remap='I'>application_name</emphasis> NULL, and finally calls
<function>XtAppCreateShell</function>
with <emphasis remap='I'>application_name</emphasis> NULL, <emphasis remap='I'>widget_class</emphasis>
-<function>application\%Shell\%Widget\%Class ,</function>
+<function>application\%Shell\%Widget\%Class</function>,
and the specified <emphasis remap='I'>args</emphasis> and <emphasis remap='I'>num_args</emphasis>
and returns the created shell. The modified <emphasis remap='I'>argc</emphasis> and <emphasis remap='I'>argv</emphasis> returned by
<function>XtDisplayInitialize</function>
@@ -288,35 +211,22 @@ opened, an error message is issued and
terminates the application. If <emphasis remap='I'>fallback_resources</emphasis> is non-NULL,
<function>XtAppSetFallbackResources</function>
is called with the value prior to calling
-<function>XtOpenDisplay .</function>
-<!-- .sp -->
+<function>XtOpenDisplay</function>.
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtVaAppInitialize" "" "@DEF@" -->
-<!-- .sM -->
-</para>
-<!-- .FD 0 -->
-Widget XtVaAppInitialize(<emphasis remap='I'>app_context_return</emphasis>, <emphasis remap='I'>application_class</emphasis>, \
-<emphasis remap='I'>options</emphasis>, <emphasis remap='I'>num_options</emphasis>,
-<!-- .br -->
- <emphasis remap='I'>argc_in_out</emphasis>, <emphasis remap='I'>argv_in_out</emphasis>, \
-<emphasis remap='I'>fallback_resources</emphasis>, ...)
-<!-- .br -->
- XtAppContext *<emphasis remap='I'>app_context_return</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>application_class</emphasis>;
-<!-- .br -->
- XrmOptionDescList <emphasis remap='I'>options</emphasis>;
-<!-- .br -->
- Cardinal <emphasis remap='I'>num_options</emphasis>;
-<!-- .br -->
- int *<emphasis remap='I'>argc_in_out</emphasis>;
-<!-- .br -->
- String *<emphasis remap='I'>argv_in_out</emphasis>;
-<!-- .br -->
- String *<emphasis remap='I'>fallback_resources</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtVaAppInitialize'>
+<funcprototype>
+<funcdef>Widget <function>XtVaAppInitialize</function></funcdef>
+ <paramdef>XtAppContext *<parameter>app_context_return</parameter></paramdef>
+ <paramdef>String <parameter>application_class</parameter></paramdef>
+ <paramdef>XrmOptionDescList <parameter>options</parameter></paramdef>
+ <paramdef>Cardinal <parameter>num_options</parameter></paramdef>
+ <paramdef>int *<parameter>argc_in_out</parameter></paramdef>
+ <paramdef>String *<parameter>argv_in_out</parameter></paramdef>
+ <paramdef>String *<parameter>fallback_resources</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -402,8 +312,6 @@ resource specifications for the created shell.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
The
<function>XtVaAppInitialize</function>
procedure is identical in function to
@@ -411,48 +319,39 @@ procedure is identical in function to
with the <emphasis remap='I'>args</emphasis> and <emphasis remap='I'>num_args</emphasis> parameters replaced by a varargs list,
as described
in Section 2.5.1.
-<!-- .sp -->
</para>
+
<para>
-<!-- .LP -->
As a convenience to people converting from earlier versions of the toolkit
without application contexts, the following routines exist:
-<function>XtInitialize ,</function>
-<function>XtMainLoop ,</function>
-<function>XtNextEvent ,</function>
-<function>XtProcessEvent ,</function>
-<function>XtPeekEvent ,</function>
-<function>XtPending ,</function>
-<function>XtAddInput ,</function>
-<function>XtAddTimeOut ,</function>
-<function>XtAddWorkProc ,</function>
-<function>XtCreateApplicationShell ,</function>
-<function>XtAddActions ,</function>
-<function>XtSetSelectionTimeout ,</function>
+<function>XtInitialize</function>,
+<function>XtMainLoop</function>,
+<function>XtNextEvent</function>,
+<function>XtProcessEvent</function>,
+<function>XtPeekEvent</function>,
+<function>XtPending</function>,
+<function>XtAddInput</function>,
+<function>XtAddTimeOut</function>,
+<function>XtAddWorkProc</function>,
+<function>XtCreateApplicationShell</function>,
+<function>XtAddActions</function>,
+<function>XtSetSelectionTimeout</function>,
and
-<function>XtGetSelectionTimeout .</function>
+<function>XtGetSelectionTimeout</function>.
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtInitialize" "" "@DEF@" -->
-<!-- .sM -->
-</para>
-<!-- .FD 0 -->
-Widget XtInitialize(<emphasis remap='I'>shell_name</emphasis>, <emphasis remap='I'>application_class</emphasis>, <emphasis remap='I'>options</emphasis>, \
-<emphasis remap='I'>num_options</emphasis>, <emphasis remap='I'>argc</emphasis>, <emphasis remap='I'>argv</emphasis>)
-<!-- .br -->
- String <emphasis remap='I'>shell_name</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>application_class</emphasis>;
-<!-- .br -->
- XrmOptionDescRec <emphasis remap='I'>options</emphasis>[];
-<!-- .br -->
- Cardinal <emphasis remap='I'>num_options</emphasis>;
-<!-- .br -->
- int *<emphasis remap='I'>argc</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>argv</emphasis>[];
-<!-- .FN -->
+
+<funcsynopsis id='XtInitialize'>
+<funcprototype>
+<funcdef>Widget <function>XtInitialize</function></funcdef>
+ <paramdef>String <parameter>shell_name</parameter></paramdef>
+ <paramdef>String <parameter>application_class</parameter></paramdef>
+ <paramdef>XrmOptionDescRec <parameter>options</parameter></paramdef>
+ <paramdef>Cardinal <parameter>num_options</parameter></paramdef>
+ <paramdef>int *<parameter>argc</parameter></paramdef>
+ <paramdef>String <parameter>argv</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -482,7 +381,7 @@ Specifies the class name of this application.
<para>
Specifies how to parse the command line for any application-specific resources.
The <emphasis remap='I'>options</emphasis> argument is passed as a parameter to
-<function>XrmParseCommand .</function>
+<function>XrmParseCommand</function>.
</para>
</listitem>
</varlistentry>
@@ -518,8 +417,6 @@ Specifies the command line parameters.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
<function>XtInitialize</function>
calls
<function>XtToolkitInitialize</function>
@@ -536,33 +433,33 @@ The semantics of calling
<function>XtInitialize</function>
more than once are undefined.
This routine has been replaced by
-<function>XtOpenApplication .</function>
-<!-- .sp -->
-<!-- .IN "XtMainLoop" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtOpenApplication</function>.
</para>
-<!-- .FD 0 -->
-void XtMainLoop(void)
-<!-- .FN -->
+
+<funcsynopsis id='XtMainLoop'>
+<funcprototype>
+<funcdef>void <function>XtMainLoop</function></funcdef>
+ <paramdef><parameter>void</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<para>
-<!-- .LP -->
-<!-- .eM -->
<function>XtMainLoop</function>
first reads the next alternate input, timer, or X event by calling
-<function>XtNextEvent .</function>
+<function>XtNextEvent</function>.
Then it dispatches this to the appropriate registered procedure by calling
-<function>XtDispatchEvent .</function>
+<function>XtDispatchEvent</function>.
This routine has been replaced by
-<function>XtAppMainLoop .</function>
-<!-- .sp -->
-<!-- .IN "XtNextEvent" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtAppMainLoop</function>.
</para>
-<!-- .FD 0 -->
-void XtNextEvent(<emphasis remap='I'>event_return</emphasis>)
-<!-- .br -->
- XEvent *<emphasis remap='I'>event_return</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtNextEvent'>
+<funcprototype>
+<funcdef>void <function>XtNextEvent</function></funcdef>
+ <paramdef>XEvent *<parameter>event_return</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -576,26 +473,24 @@ Returns the event information to the specified event structure.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
If no input is on the X input queue for the default application context,
<function>XtNextEvent</function>
flushes the X output buffer
and waits for an event while looking at the alternate input sources
and timeout values and calling any callback procedures triggered by them.
This routine has been replaced by
-<function>XtAppNextEvent .</function>
+<function>XtAppNextEvent</function>.
<function>XtInitialize</function>
must be called before using this routine.
-<!-- .sp -->
-<!-- .IN "XtProcessEvent" "" "@DEF@" -->
-<!-- .sM -->
</para>
-<!-- .FD 0 -->
-void XtProcessEvent(<emphasis remap='I'>mask</emphasis>)
-<!-- .br -->
- XtInputMask <emphasis remap='I'>mask</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtProcessEvent'>
+<funcprototype>
+<funcdef>void <function>XtProcessEvent</function></funcdef>
+ <paramdef>XtInputMask <parameter>mask</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -609,24 +504,22 @@ Specifies the type of input to process.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
<function>XtProcessEvent</function>
processes one X event, timeout, or alternate input source
(depending on the value of <emphasis remap='I'>mask</emphasis>), blocking if necessary.
It has been replaced by
-<function>XtAppProcessEvent .</function>
+<function>XtAppProcessEvent</function>.
<function>XtInitialize</function>
must be called before using this function.
-<!-- .sp -->
-<!-- .IN "XtPeekEvent" "" "@DEF@" -->
-<!-- .sM -->
</para>
-<!-- .FD 0 -->
-Boolean XtPeekEvent(<emphasis remap='I'>event_return</emphasis>)
-<!-- .br -->
- XEvent *<emphasis remap='I'>event_return</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtPeekEvent'>
+<funcprototype>
+<funcdef>Boolean <function>XtPeekEvent</function></funcdef>
+ <paramdef>XEvent *<parameter>event_return</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -640,8 +533,6 @@ Returns the event information to the specified event structure.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
If there is an event in the queue for the default application context,
<function>XtPeekEvent</function>
fills in the event and returns a nonzero value.
@@ -656,19 +547,19 @@ Otherwise, the input is for an alternate input source, and
<function>XtPeekEvent</function>
returns zero.
This routine has been replaced by
-<function>XtAppPeekEvent .</function>
+<function>XtAppPeekEvent</function>.
<function>XtInitialize</function>
must be called before using this routine.
-<!-- .sp -->
-<!-- .IN "XtPending" "" "@DEF@" -->
-<!-- .sM -->
</para>
-<!-- .FD 0 -->
-Boolean XtPending()
-<!-- .FN -->
+
+<funcsynopsis id='XtPending'>
+<funcprototype>
+<funcdef>Boolean <function>XtPending</function></funcdef>
+ <paramdef><parameter></parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<para>
-<!-- .LP -->
-<!-- .eM -->
<function>XtPending</function>
returns a nonzero value if there are
events pending from the X server or alternate input sources in the default
@@ -676,25 +567,21 @@ application context.
If there are no events pending,
it flushes the output buffer and returns a zero value.
It has been replaced by
-<function>XtAppPending .</function>
+<function>XtAppPending</function>.
<function>XtInitialize</function>
must be called before using this routine.
-<!-- .sp -->
-<!-- .IN "XtAddInput" "" "@DEF@" -->
-<!-- .sM -->
</para>
-<!-- .FD 0 -->
-XtInputId XtAddInput(<emphasis remap='I'>source</emphasis>, <emphasis remap='I'>condition</emphasis>, <emphasis remap='I'>proc</emphasis>, \
-<emphasis remap='I'>client_data</emphasis>)
-<!-- .br -->
- int <emphasis remap='I'>source</emphasis>;
-<!-- .br -->
- XtPointer <emphasis remap='I'>condition</emphasis>;
-<!-- .br -->
- XtInputCallbackProc <emphasis remap='I'>proc</emphasis>;
-<!-- .br -->
- XtPointer <emphasis remap='I'>client_data</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtAddInput'>
+<funcprototype>
+<funcdef>XtInputId <function>XtAddInput</function></funcdef>
+ <paramdef>int <parameter>source</parameter></paramdef>
+ <paramdef>XtPointer <parameter>condition</parameter></paramdef>
+ <paramdef>XtInputCallbackProc <parameter>proc</parameter></paramdef>
+ <paramdef>XtPointer <parameter>client_data</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -740,8 +627,6 @@ Specifies the parameter to be passed to <emphasis remap='I'>proc</emphasis> when
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
The
<function>XtAddInput</function>
function registers in the default application context a new
@@ -754,22 +639,20 @@ also specifies the conditions under which the source can generate events.
When input is pending on this source in the default application context,
the callback procedure is called.
This routine has been replaced by
-<function>XtAppAddInput .</function>
+<function>XtAppAddInput</function>.
<function>XtInitialize</function>
must be called before using this routine.
-<!-- .sp -->
-<!-- .IN "XtAddTimeOut" "" "@DEF@" -->
-<!-- .sM -->
</para>
-<!-- .FD 0 -->
-XtIntervalId XtAddTimeOut(<emphasis remap='I'>interval</emphasis>, <emphasis remap='I'>proc</emphasis>, <emphasis remap='I'>client_data</emphasis>)
-<!-- .br -->
- unsigned long <emphasis remap='I'>interval</emphasis>;
-<!-- .br -->
- XtTimerCallbackProc <emphasis remap='I'>proc</emphasis>;
-<!-- .br -->
- XtPointer <emphasis remap='I'>client_data</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtAddTimeOut'>
+<funcprototype>
+<funcdef>XtIntervalId <function>XtAddTimeOut</function></funcdef>
+ <paramdef>unsigned long <parameter>interval</parameter></paramdef>
+ <paramdef>XtTimerCallbackProc <parameter>proc</parameter></paramdef>
+ <paramdef>XtPointer <parameter>client_data</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -803,8 +686,6 @@ Specifies the parameter to be passed to <emphasis remap='I'>proc</emphasis> when
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
The
<function>XtAddTimeOut</function>
function creates a timeout in the default application context
@@ -813,20 +694,19 @@ The timeout value is set to <emphasis remap='I'>interval</emphasis>.
The callback procedure will be called after
the time interval elapses, after which the timeout is removed.
This routine has been replaced by
-<function>XtAppAddTimeOut .</function>
+<function>XtAppAddTimeOut</function>.
<function>XtInitialize</function>
must be called before using this routine.
-<!-- .sp -->
-<!-- .IN "XtAddWorkProc" "" "@DEF@" -->
-<!-- .sM -->
</para>
-<!-- .FD 0 -->
-XtWorkProcId XtAddWorkProc(<emphasis remap='I'>proc</emphasis>, <emphasis remap='I'>client_data</emphasis>)
-<!-- .br -->
- XtWorkProc <emphasis remap='I'>proc</emphasis>;
-<!-- .br -->
- XtPointer <emphasis remap='I'>client_data</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtAddWorkProc'>
+<funcprototype>
+<funcdef>XtWorkProcId <function>XtAddWorkProc</function></funcdef>
+ <paramdef>XtWorkProc <parameter>proc</parameter></paramdef>
+ <paramdef>XtPointer <parameter>client_data</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -850,29 +730,23 @@ Client data to pass to <emphasis remap='I'>proc</emphasis> when it is called.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
This routine registers a work procedure in the default application context. It has
been replaced by
-<function>XtAppAddWorkProc .</function>
+<function>XtAppAddWorkProc</function>.
<function>XtInitialize</function>
must be called before using this routine.
-<!-- .sp -->
-<!-- .IN "XtCreateApplicationShell" "" "@DEF@" -->
-<!-- .sM -->
</para>
-<!-- .FD 0 -->
-Widget XtCreateApplicationShell(<emphasis remap='I'>name</emphasis>, <emphasis remap='I'>widget_class</emphasis>, <emphasis remap='I'>args</emphasis>, \
-<emphasis remap='I'>num_args</emphasis>)
-<!-- .br -->
- String <emphasis remap='I'>name</emphasis>;
-<!-- .br -->
- WidgetClass <emphasis remap='I'>widget_class</emphasis>;
-<!-- .br -->
- ArgList <emphasis remap='I'>args</emphasis>;
-<!-- .br -->
- Cardinal <emphasis remap='I'>num_args</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtCreateApplicationShell'>
+<funcprototype>
+<funcdef>Widget <function>XtCreateApplicationShell</function></funcdef>
+ <paramdef>String <parameter>name</parameter></paramdef>
+ <paramdef>WidgetClass <parameter>widget_class</parameter></paramdef>
+ <paramdef>ArgList <parameter>args</parameter></paramdef>
+ <paramdef>Cardinal <parameter>num_args</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -919,41 +793,34 @@ Specifies the number of entries in <emphasis remap='I'>args</emphasis>.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
The procedure
<function>XtCreateApplicationShell</function>
calls
<function>XtAppCreateShell</function>
with <emphasis remap='I'>application_name</emphasis> NULL, the application class passed to
-<function>XtInitialize ,</function>
+<function>XtInitialize</function>,
and the default application context created by
-<function>XtInitialize .</function>
+<function>XtInitialize</function>.
This routine has been replaced by
-<function>XtAppCreateShell .</function>
-<!-- .sp -->
+<function>XtAppCreateShell</function>.
</para>
+
<para>
-<!-- .LP -->
An old-format resource type converter procedure pointer is of type
-<function>XtConverter .</function>
+<function>XtConverter</function>.
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtConverter" "" "@DEF@" -->
-<!-- .sM -->
-</para>
-<!-- .FD 0 -->
-typedef void (*XtConverter)(XrmValue*, Cardinal*, XrmValue*, XrmValue*);
-<!-- .br -->
- XrmValue *<emphasis remap='I'>args</emphasis>;
-<!-- .br -->
- Cardinal *<emphasis remap='I'>num_args</emphasis>;
-<!-- .br -->
- XrmValue *<emphasis remap='I'>from</emphasis>;
-<!-- .br -->
- XrmValue *<emphasis remap='I'>to</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtConverter'>
+<funcprototype>
+<funcdef>void <function>*XtConverter</function></funcdef>
+
+ <paramdef>XrmValue *<parameter>args</parameter></paramdef>
+ <paramdef>Cardinal *<parameter>num_args</parameter></paramdef>
+ <paramdef>XrmValue *<parameter>from</parameter></paramdef>
+ <paramdef>XrmValue *<parameter>to</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1000,8 +867,6 @@ Specifies the descriptor to use to return the converted value.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
Type converters should perform the following actions:
</para>
<itemizedlist>
@@ -1025,7 +890,6 @@ and return without modifying the <emphasis remap='I'>to</emphasis> argument.
</listitem>
</itemizedlist>
<para>
-<!-- .LP -->
Most type converters just take the data described by the specified <emphasis remap='I'>from</emphasis>
argument and return data by writing into the specified <emphasis remap='I'>to</emphasis> argument.
A few need other information, which is available in the specified
@@ -1034,37 +898,34 @@ A type converter can invoke another type converter,
which allows differing sources that may convert into a common intermediate
result to make maximum use of the type converter cache.
</para>
+
<para>
-<!-- .LP -->
Note that the address returned in <emphasis remap='I'>to-&gt;addr</emphasis> cannot be that of a local variable of
the converter because this is not valid after the converter returns.
It should be a pointer to a static variable.
</para>
+
<para>
-<!-- .LP -->
The procedure type
<function>XtConverter</function>
has been replaced by
-<function>XtTypeConverter .</function>
-<!-- .sp -->
+<function>XtTypeConverter</function>.
</para>
+
<para>
-<!-- .LP -->
The
<function>XtStringConversionWarning</function>
-<!-- .IN "XtStringConversionWarning" "" "@DEF@" -->
function is a convenience routine for old-format resource converters
that convert from strings.
</para>
-<para>
-<!-- .LP -->
-<!-- .sM -->
-</para>
-<!-- .FD 0 -->
-void XtStringConversionWarning(<emphasis remap='I'>src</emphasis>, <emphasis remap='I'>dst_type</emphasis>)
-<!-- .br -->
- String <emphasis remap='I'>src</emphasis>, <emphasis remap='I'>dst_type</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtStringConversionWarning'>
+<funcprototype>
+<funcdef>void <function>XtStringConversionWarning</function></funcdef>
+ <paramdef>String <parameter>src</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1088,44 +949,33 @@ Specifies the name of the type to which the string could not be converted.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
The
<function>XtStringConversionWarning</function>
-function issues a warning message with name ``conversionError'',
-type ``string'', class ``XtToolkitError, and the default message string
-``Cannot convert "<emphasis remap='I'>src</emphasis>" to type <emphasis remap='I'>dst_type</emphasis>''. This routine
+function issues a warning message with name "conversionError",
+type "string", class "XtToolkitError, and the default message string
+"Cannot convert "<emphasis remap='I'>src</emphasis>" to type <emphasis remap='I'>dst_type</emphasis>". This routine
has been superseded by
-<function>XtDisplayStringConversionWarning .</function>
-<!-- .sp -->
+<function>XtDisplayStringConversionWarning</function>.
</para>
+
<para>
-<!-- .LP -->
To register an old-format converter, use
<function>XtAddConverter</function>
-<!-- .IN "XtAddConverter" "" "@DEF@" -->
or
-<function>XtAppAddConverter .</function>
-<!-- .IN "XtAppAddConverter" "" "@DEF@" -->
-</para>
-<para>
-<!-- .LP -->
-<!-- .sM -->
+<function>XtAppAddConverter</function>.
</para>
-<!-- .FD 0 -->
-void XtAddConverter(<emphasis remap='I'>from_type</emphasis>, <emphasis remap='I'>to_type</emphasis>, <emphasis remap='I'>converter</emphasis>, \
-<emphasis remap='I'>convert_args</emphasis>, <emphasis remap='I'>num_args</emphasis>)
-<!-- .br -->
- String <emphasis remap='I'>from_type</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>to_type</emphasis>;
-<!-- .br -->
- XtConverter <emphasis remap='I'>converter</emphasis>;
-<!-- .br -->
- XtConvertArgList <emphasis remap='I'>convert_args</emphasis>;
-<!-- .br -->
- Cardinal <emphasis remap='I'>num_args</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtAddConverter'>
+<funcprototype>
+<funcdef>void <function>XtAddConverter</function></funcdef>
+ <paramdef>String <parameter>from_type</parameter></paramdef>
+ <paramdef>String <parameter>to_type</parameter></paramdef>
+ <paramdef>XtConverter <parameter>converter</parameter></paramdef>
+ <paramdef>XtConvertArgList <parameter>convert_args</parameter></paramdef>
+ <paramdef>Cardinal <parameter>num_args</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1174,40 +1024,32 @@ Specifies how to compute the additional arguments to the converter, or NULL.
<listitem>
<para>
Specifies the number of entries in <emphasis remap='I'>convert_args</emphasis>.
-<!-- .sp -->
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
<function>XtAddConverter</function>
is equivalent in function to
<function>XtSetTypeConverter</function>
with <emphasis remap='I'>cache_type</emphasis> equal to
<function>XtCacheAll</function>
for old-format type converters. It has been superseded by
-<function>XtSetTypeConverter .</function>
-<!-- .sp -->
-<!-- .sM -->
+<function>XtSetTypeConverter</function>.
</para>
-<!-- .FD 0 -->
-void XtAppAddConverter(<emphasis remap='I'>app_context</emphasis>, <emphasis remap='I'>from_type</emphasis>, <emphasis remap='I'>to_type</emphasis>, \
-<emphasis remap='I'>converter</emphasis>, <emphasis remap='I'>convert_args</emphasis>, <emphasis remap='I'>num_args</emphasis>)
-<!-- .br -->
- XtAppContext <emphasis remap='I'>app_context</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>from_type</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>to_type</emphasis>;
-<!-- .br -->
- XtConverter <emphasis remap='I'>converter</emphasis>;
-<!-- .br -->
- XtConvertArgList <emphasis remap='I'>convert_args</emphasis>;
-<!-- .br -->
- Cardinal <emphasis remap='I'>num_args</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtAppAddConverter'>
+<funcprototype>
+<funcdef>void <function>XtAppAddConverter</function></funcdef>
+ <paramdef>XtAppContext <parameter>app_context</parameter></paramdef>
+ <paramdef>String <parameter>from_type</parameter></paramdef>
+ <paramdef>String <parameter>to_type</parameter></paramdef>
+ <paramdef>XtConverter <parameter>converter</parameter></paramdef>
+ <paramdef>XtConvertArgList <parameter>convert_args</parameter></paramdef>
+ <paramdef>Cardinal <parameter>num_args</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1271,43 +1113,33 @@ Specifies the number of entries in <emphasis remap='I'>convert_args</emphasis>.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
<function>XtAppAddConverter</function>
is equivalent in function to
<function>XtAppSetTypeConverter</function>
with <emphasis remap='I'>cache_type</emphasis> equal to
<function>XtCacheAll</function>
for old-format type converters. It has been superseded by
-<function>XtAppSetTypeConverter .</function>
-<!-- .sp -->
+<function>XtAppSetTypeConverter</function>.
</para>
+
<para>
-<!-- .LP -->
To invoke resource conversions, a client may use
<function>XtConvert</function>
or, for old-format converters only,
-<function>XtDirectConvert .</function>
+<function>XtDirectConvert</function>.
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtConvert" "" "@DEF@" -->
-<!-- .sM -->
-</para>
-<!-- .FD 0 -->
-void XtConvert(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>from_type</emphasis>, <emphasis remap='I'>from</emphasis>, <emphasis remap='I'>to_type</emphasis>, \
-<emphasis remap='I'>to_return</emphasis>)
-<!-- .br -->
- Widget <emphasis remap='I'>w</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>from_type</emphasis>;
-<!-- .br -->
- XrmValuePtr <emphasis remap='I'>from</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>to_type</emphasis>;
-<!-- .br -->
- XrmValuePtr <emphasis remap='I'>to_return</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtConvert'>
+<funcprototype>
+<funcdef>void <function>XtConvert</function></funcdef>
+ <paramdef>Widget <parameter>w</parameter></paramdef>
+ <paramdef>String <parameter>from_type</parameter></paramdef>
+ <paramdef>XrmValuePtr <parameter>from</parameter></paramdef>
+ <paramdef>String <parameter>to_type</parameter></paramdef>
+ <paramdef>XrmValuePtr <parameter>to_return</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1361,24 +1193,18 @@ Returns the converted value.
</listitem>
</varlistentry>
</variablelist>
-<para>
-<!-- .LP -->
-<!-- .IN "XtDirectConvert" "" "@DEF@" -->
-</para>
-<!-- .FD 0 -->
-void XtDirectConvert(<emphasis remap='I'>converter</emphasis>, <emphasis remap='I'>args</emphasis>, <emphasis remap='I'>num_args</emphasis>, <emphasis remap='I'>from</emphasis>, \
-<emphasis remap='I'>to_return</emphasis>)
-<!-- .br -->
- XtConverter <emphasis remap='I'>converter</emphasis>;
-<!-- .br -->
- XrmValuePtr <emphasis remap='I'>args</emphasis>;
-<!-- .br -->
- Cardinal <emphasis remap='I'>num_args</emphasis>;
-<!-- .br -->
- XrmValuePtr <emphasis remap='I'>from</emphasis>;
-<!-- .br -->
- XrmValuePtr <emphasis remap='I'>to_return</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtDirectConvert'>
+<funcprototype>
+<funcdef> <function>XtDirectConvert</function></funcdef>
+ <paramdef>XtConverter <parameter>converter</parameter></paramdef>
+ <paramdef>XrmValuePtr <parameter>args</parameter></paramdef>
+ <paramdef>Cardinal <parameter>num_args</parameter></paramdef>
+ <paramdef>XrmValuePtr <parameter>from</parameter></paramdef>
+ <paramdef>XrmValuePtr <parameter>to_return</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1433,15 +1259,13 @@ Returns the converted value.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
The
<function>XtConvert</function>
function looks up the type converter registered to convert <emphasis remap='I'>from_type</emphasis>
to <emphasis remap='I'>to_type</emphasis>, computes any additional arguments needed, and then calls
<function>XtDirectConvert</function>
or
-<function>XtCallConverter .</function>
+<function>XtCallConverter</function>.
The
<function>XtDirectConvert</function>
function looks in the converter cache to see if this conversion procedure
@@ -1449,8 +1273,8 @@ has been called with the specified arguments.
If so, it returns a descriptor for information stored in the cache;
otherwise, it calls the converter and enters the result in the cache.
</para>
+
<para>
-<!-- .LP -->
Before calling the specified converter,
<function>XtDirectConvert</function>
sets the return value size to zero and the return value address to NULL.
@@ -1461,34 +1285,30 @@ The data returned by
must be copied immediately by the caller,
as it may point to static data in the type converter.
</para>
+
<para>
-<!-- .LP -->
<function>XtConvert</function>
has been replaced by
-<function>XtConvertAndStore ,</function>
+<function>XtConvertAndStore</function>,
and
<function>XtDirectConvert</function>
has been superseded by
-<function>XtCallConverter .</function>
-<!-- .sp -->
+<function>XtCallConverter</function>.
</para>
+
<para>
-<!-- .LP -->
To deallocate a shared GC when it is no longer needed, use
-<function>XtDestroyGC .</function>
+<function>XtDestroyGC</function>.
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtDestroyGC" "" "@DEF@" -->
-<!-- .sM -->
-</para>
-<!-- .FD 0 -->
-void XtDestroyGC(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>gc</emphasis>)
-<!-- .br -->
- Widget <emphasis remap='I'>w</emphasis>;
-<!-- .br -->
- GC <emphasis remap='I'>gc</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtDestroyGC'>
+<funcprototype>
+<funcdef>void <function>XtDestroyGC</function></funcdef>
+ <paramdef>Widget <parameter>w</parameter></paramdef>
+ <paramdef>GC <parameter>gc</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1497,7 +1317,7 @@ void XtDestroyGC(<emphasis remap='I'>w</emphasis>, <emphasis remap='I'>gc</empha
<listitem>
<para>
Specifies any object on the display for which the shared GC was
-created. (oI
+created. Must be of class Object or any subclass thereof.
</para>
</listitem>
</varlistentry>
@@ -1513,8 +1333,6 @@ Specifies the shared GC to be deallocated.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
References to sharable GCs are counted and a free request is generated to the
server when the last user of a given GC destroys it.
Note that some earlier versions of
@@ -1524,26 +1342,22 @@ Therefore, this function is not very portable,
and you are encouraged to use
<function>XtReleaseGC</function>
instead.
-<!-- .sp -->
</para>
+
<para>
-<!-- .LP -->
To declare an action table in the default application context
and register it with the translation manager, use
-<function>XtAddActions .</function>
-</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtAddActions" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtAddActions</function>.
</para>
-<!-- .FD 0 -->
-void XtAddActions(<emphasis remap='I'>actions</emphasis>, <emphasis remap='I'>num_actions</emphasis>)
-<!-- .br -->
- XtActionList <emphasis remap='I'>actions</emphasis>;
-<!-- .br -->
- Cardinal <emphasis remap='I'>num_actions</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtAddActions'>
+<funcprototype>
+<funcdef>void <function>XtAddActions</function></funcdef>
+ <paramdef>XtActionList <parameter>actions</parameter></paramdef>
+ <paramdef>Cardinal <parameter>num_actions</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1567,38 +1381,34 @@ Specifies the number of entries in <emphasis remap='I'>actions</emphasis>.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
If more than one action is registered with the same name,
the most recently registered action is used.
If duplicate actions exist in an action table,
the first is used.
-The (xI register an action table for
+The Intrinsics register an action table for
<function>XtMenuPopup</function>
and
<function>XtMenuPopdown</function>
as part of (tk initialization.
This routine has been replaced by
-<function>XtAppAddActions .</function>
+<function>XtAppAddActions</function>.
<function>XtInitialize</function>
must be called before using this routine.
-<!-- .sp -->
-</para>
-<para>
-<!-- .LP -->
-To set the (xI selection timeout in the default application context, use
-<function>XtSetSelectionTimeout .</function>
</para>
+
<para>
-<!-- .LP -->
-<!-- .IN "XtSetSelectionTimeout" "" "@DEF@" -->
-<!-- .sM -->
+To set the Intrinsics selection timeout in the default application context, use
+<function>XtSetSelectionTimeout</function>.
</para>
-<!-- .FD 0 -->
-void XtSetSelectionTimeout(<emphasis remap='I'>timeout</emphasis>)
-<!-- .br -->
- unsigned long <emphasis remap='I'>timeout</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtSetSelectionTimeout'>
+<funcprototype>
+<funcdef>void <function>XtSetSelectionTimeout</function></funcdef>
+ <paramdef>unsigned long <parameter>timeout</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
+
<variablelist>
<varlistentry>
<term>
@@ -1608,108 +1418,88 @@ void XtSetSelectionTimeout(<emphasis remap='I'>timeout</emphasis>)
<para>
Specifies the selection timeout in milliseconds.
This routine has been replaced by
-<function>XtAppSetSelectionTimeout .</function>
+<function>XtAppSetSelectionTimeout</function>.
<function>XtInitialize</function>
must be called before using this routine.
</para>
</listitem>
</varlistentry>
</variablelist>
+
<para>
-<!-- .LP -->
-<!-- .eM -->
-<!-- .sp -->
-</para>
-<para>
-<!-- .LP -->
To get the current selection timeout value in the default application
context, use
-<function>XtGetSelectionTimeout .</function>
-</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtGetSelectionTimeout" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtGetSelectionTimeout</function>.
</para>
-<!-- .FD 0 -->
-unsigned long XtGetSelectionTimeout()
-<!-- .FN -->
+
+<funcsynopsis id='XtGetSelectionTimeout'>
+<funcprototype>
+<funcdef>unsigned long <function>XtGetSelectionTimeout</function></funcdef>
+ <paramdef><parameter></parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<para>
-<!-- .LP -->
-<!-- .eM -->
The selection timeout is the time within which the two communicating
applications must respond to one another.
If one of them does not respond within this interval,
-the (xI abort the selection request.
+the Intrinsics abort the selection request.
</para>
+
<para>
-<!-- .LP -->
This routine has been replaced by
-<function>XtAppGetSelectionTimeout .</function>
+<function>XtAppGetSelectionTimeout</function>.
<function>XtInitialize</function>
must be called before using this routine.
-<!-- .sp -->
</para>
+
<para>
-<!-- .LP -->
To obtain the global error database (for example, to merge with
an application- or widget-specific database), use
-<function>XtGetErrorDatabase .</function>
-</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtGetErrorDatabase" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtGetErrorDatabase</function>.
</para>
-<!-- .FD 0 -->
-XrmDatabase *XtGetErrorDatabase()
-<!-- .FN -->
+
+<funcsynopsis id='XtGetErrorDatabase'>
+<funcprototype>
+<funcdef>XrmDatabase <function>*XtGetErrorDatabase</function></funcdef>
+ <paramdef><parameter></parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<para>
-<!-- .LP -->
-<!-- .eM -->
The
<function>XtGetErrorDatabase</function>
function returns the address of the error database.
-The (xI do a lazy binding of the error database and do not merge in the
+The Intrinsics do a lazy binding of the error database and do not merge in the
database file until the first call to
-<function>XtGetErrorDatbaseText .</function>
+<function>XtGetErrorDatbaseText</function>.
This routine has been replaced by
-<function>XtAppGetErrorDatabase .</function>
-<!-- .sp -->
+<function>XtAppGetErrorDatabase</function>.
</para>
+
<para>
-<!-- .LP -->
An error message handler can obtain the error database text for an
error or a warning by calling
-<function>XtGetErrorDatabaseText .</function>
-</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtGetErrorDatabaseText" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtGetErrorDatabaseText</function>.
</para>
-<!-- .FD 0 -->
-void XtGetErrorDatabaseText(<emphasis remap='I'>name</emphasis>, <emphasis remap='I'>type</emphasis>, <emphasis remap='I'>class</emphasis>, \
-<emphasis remap='I'>default</emphasis>, <emphasis remap='I'>buffer_return</emphasis>, <emphasis remap='I'>nbytes</emphasis>)
-<!-- .br -->
- String <emphasis remap='I'>name</emphasis>, <emphasis remap='I'>type</emphasis>, <emphasis remap='I'>class</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>default</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>buffer_return</emphasis>;
-<!-- .br -->
- int <emphasis remap='I'>nbytes</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtGetErrorDatabaseText'>
+<funcprototype>
+<funcdef>void <function>XtGetErrorDatabaseText</function></funcdef>
+ <paramdef>String <parameter>name</parameter></paramdef>
+ <paramdef>String <parameter>default</parameter></paramdef>
+ <paramdef>String <parameter>buffer_return</parameter></paramdef>
+ <paramdef>int <parameter>nbytes</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
<emphasis remap='I'>name</emphasis>
</term>
<listitem>
- <para>
-<!-- .br -->
-<!-- .ns -->
- </para>
+ <para></para>
</listitem>
</varlistentry>
<varlistentry>
@@ -1765,8 +1555,6 @@ Specifies the size of the buffer in bytes.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
The
<function>XtGetErrorDatabaseText</function>
returns the appropriate message from the error database
@@ -1774,28 +1562,25 @@ associated with the default application context
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 ".".
This routine has been superseded by
-<function>XtAppGetErrorDatabaseText .</function>
-<!-- .sp -->
+<function>XtAppGetErrorDatabaseText</function>.
</para>
+
<para>
-<!-- .LP -->
To register a procedure to be called on fatal error conditions, use
-<function>XtSetErrorMsgHandler .</function>
-</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtSetErrorMsgHandler" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtSetErrorMsgHandler</function>.
</para>
-<!-- .FD 0 -->
-void XtSetErrorMsgHandler(<emphasis remap='I'>msg_handler</emphasis>)
-<!-- .br -->
- XtErrorMsgHandler <emphasis remap='I'>msg_handler</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtSetErrorMsgHandler'>
+<funcprototype>
+<funcdef>void <function>XtSetErrorMsgHandler</function></funcdef>
+ <paramdef>XtErrorMsgHandler <parameter>msg_handler</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1809,44 +1594,33 @@ Specifies the new fatal error procedure, which should not return.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
-The default error handler provided by the (xI constructs a
+The default error handler provided by the Intrinsics constructs a
string from the error resource database and calls
-<function>XtError .</function>
+<function>XtError</function>.
Fatal error message handlers should not return.
If one does,
-subsequent (xI behavior is undefined.
+subsequent Intrinsics behavior is undefined.
This routine has been superseded by
-<function>XtAppSetErrorMsgHandler .</function>
-<!-- .sp -->
+<function>XtAppSetErrorMsgHandler</function>.
</para>
+
<para>
-<!-- .LP -->
To call the high-level error handler, use
-<function>XtErrorMsg .</function>
+<function>XtErrorMsg</function>.
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtErrorMsg" "" "@DEF@" -->
-<!-- .sM -->
-</para>
-<!-- .FD 0 -->
-void XtErrorMsg(<emphasis remap='I'>name</emphasis>, <emphasis remap='I'>type</emphasis>, <emphasis remap='I'>class</emphasis>, <emphasis remap='I'>default</emphasis>, \
-<emphasis remap='I'>params</emphasis>, <emphasis remap='I'>num_params</emphasis>)
-<!-- .br -->
- String <emphasis remap='I'>name</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>type</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>class</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>default</emphasis>;
-<!-- .br -->
- String *<emphasis remap='I'>params</emphasis>;
-<!-- .br -->
- Cardinal *<emphasis remap='I'>num_params</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtErrorMsg'>
+<funcprototype>
+<funcdef>void <function>XtErrorMsg</function></funcdef>
+ <paramdef>String <parameter>name</parameter></paramdef>
+ <paramdef>String <parameter>type</parameter></paramdef>
+ <paramdef>String <parameter>class</parameter></paramdef>
+ <paramdef>String <parameter>default</parameter></paramdef>
+ <paramdef>String *<parameter>params</parameter></paramdef>
+ <paramdef>Cardinal *<parameter>num_params</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1910,27 +1684,22 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
This routine has been superseded by
-<function>XtAppErrorMsg .</function>
-<!-- .sp -->
+<function>XtAppErrorMsg</function>.
</para>
+
<para>
-<!-- .LP -->
To register a procedure to be called on nonfatal error conditions, use
-<function>XtSetWarningMsgHandler .</function>
+<function>XtSetWarningMsgHandler</function>.
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtSetWarningMsgHandler" "" "@DEF@" -->
-<!-- .sM -->
-</para>
-<!-- .FD 0 -->
-void XtSetWarningMsgHandler(<emphasis remap='I'>msg_handler</emphasis>)
-<!-- .br -->
- XtErrorMsgHandler <emphasis remap='I'>msg_handler</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtSetWarningMsgHandler'>
+<funcprototype>
+<funcdef>void <function>XtSetWarningMsgHandler</function></funcdef>
+ <paramdef>XtErrorMsgHandler <parameter>msg_handler</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -1944,41 +1713,30 @@ Specifies the new nonfatal error procedure, which usually returns.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
-The default warning handler provided by the (xI constructs a string
+The default warning handler provided by the Intrinsics constructs a string
from the error resource database and calls
-<function>XtWarning .</function>
+<function>XtWarning</function>.
This routine has been superseded by
-<function>XtAppSetWarningMsgHandler .</function>
-<!-- .sp -->
+<function>XtAppSetWarningMsgHandler</function>.
</para>
+
<para>
-<!-- .LP -->
To call the installed high-level warning handler, use
-<function>XtWarningMsg .</function>
-</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtWarningMsg" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtWarningMsg</function>.
</para>
-<!-- .FD 0 -->
-void XtWarningMsg(<emphasis remap='I'>name</emphasis>, <emphasis remap='I'>type</emphasis>, <emphasis remap='I'>class</emphasis>, <emphasis remap='I'>default</emphasis>, \
-<emphasis remap='I'>params</emphasis>, <emphasis remap='I'>num_params</emphasis>)
-<!-- .br -->
- String <emphasis remap='I'>name</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>type</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>class</emphasis>;
-<!-- .br -->
- String <emphasis remap='I'>default</emphasis>;
-<!-- .br -->
- String *<emphasis remap='I'>params</emphasis>;
-<!-- .br -->
- Cardinal *<emphasis remap='I'>num_params</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtWarningMsg'>
+<funcprototype>
+<funcdef>void <function>XtWarningMsg</function></funcdef>
+ <paramdef>String <parameter>name</parameter></paramdef>
+ <paramdef>String <parameter>type</parameter></paramdef>
+ <paramdef>String <parameter>class</parameter></paramdef>
+ <paramdef>String <parameter>default</parameter></paramdef>
+ <paramdef>String *<parameter>params</parameter></paramdef>
+ <paramdef>Cardinal *<parameter>num_params</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -2042,27 +1800,22 @@ Specifies the number of entries in <emphasis remap='I'>params</emphasis>.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
This routine has been superseded by
-<function>XtAppWarningMsg .</function>
-<!-- .sp -->
+<function>XtAppWarningMsg</function>.
</para>
+
<para>
-<!-- .LP -->
To register a procedure to be called on fatal error conditions, use
-<function>XtSetErrorHandler .</function>
-</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtSetErrorHandler" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtSetErrorHandler</function>.
</para>
-<!-- .FD 0 -->
-void XtSetErrorHandler(<emphasis remap='I'>handler</emphasis>)
-<!-- .br -->
- XtErrorHandler <emphasis remap='I'>handler</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtSetErrorHandler'>
+<funcprototype>
+<funcdef>void <function>XtSetErrorHandler</function></funcdef>
+ <paramdef>XtErrorHandler <parameter>handler</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -2076,34 +1829,29 @@ Specifies the new fatal error procedure, which should not return.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
-The default error handler provided by the (xI is
-<function>_XtError .</function>
+The default error handler provided by the Intrinsics is
+<function>_XtError</function>.
On POSIX-based systems,
it prints the message to standard error and terminates the application.
Fatal error message handlers should not return.
If one does,
subsequent (tk behavior is undefined.
This routine has been superseded by
-<function>XtAppSetErrorHandler .</function>
-<!-- .sp -->
+<function>XtAppSetErrorHandler</function>.
</para>
+
<para>
-<!-- .LP -->
To call the installed fatal error procedure, use
-<function>XtError .</function>
-</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtError" "" "@DEF@" -->
-<!-- .sM -->
+<function>XtError</function>.
</para>
-<!-- .FD 0 -->
-void XtError(<emphasis remap='I'>message</emphasis>)
-<!-- .br -->
- String <emphasis remap='I'>message</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtError'>
+<funcprototype>
+<funcdef>void <function>XtError</function></funcdef>
+ <paramdef>String <parameter>message</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -2117,32 +1865,27 @@ Specifies the message to be reported.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
Most programs should use
-<function>XtAppErrorMsg ,</function>
+<function>XtAppErrorMsg</function>,
not
-<function>XtError ,</function>
+<function>XtError</function>,
to provide for customization and internationalization of error
messages. This routine has been superseded by
-<function>XtAppError .</function>
-<!-- .sp -->
+<function>XtAppError</function>.
</para>
+
<para>
-<!-- .LP -->
To register a procedure to be called on nonfatal error conditions, use
-<function>XtSetWarningHandler .</function>
+<function>XtSetWarningHandler</function>.
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtSetWarningHandler" "" "@DEF@" -->
-<!-- .sM -->
-</para>
-<!-- .FD 0 -->
-void XtSetWarningHandler(<emphasis remap='I'>handler</emphasis>)
-<!-- .br -->
- XtErrorHandler <emphasis remap='I'>handler</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtSetWarningHandler'>
+<funcprototype>
+<funcdef>void <function>XtSetWarningHandler</function></funcdef>
+ <paramdef>XtErrorHandler <parameter>handler</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -2156,31 +1899,26 @@ Specifies the new nonfatal error procedure, which usually returns.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
-The default warning handler provided by the (xI is
-<function>_XtWarning .</function>
+The default warning handler provided by the Intrinsics is
+<function>_XtWarning</function>.
On POSIX-based systems,
it prints the message to standard error and returns to the caller.
This routine has been superseded by
-<function>XtAppSetWarningHandler .</function>
-<!-- .sp -->
+<function>XtAppSetWarningHandler</function>.
</para>
+
<para>
-<!-- .LP -->
To call the installed nonfatal error procedure, use
-<function>XtWarning .</function>
+<function>XtWarning</function>.
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "XtWarning" "" "@DEF@" -->
-<!-- .sM -->
-</para>
-<!-- .FD 0 -->
-void XtWarning(<emphasis remap='I'>message</emphasis>)
-<!-- .br -->
- String <emphasis remap='I'>message</emphasis>;
-<!-- .FN -->
+
+<funcsynopsis id='XtWarning'>
+<funcprototype>
+<funcdef>void <function>XtWarning</function></funcdef>
+ <paramdef>String <parameter>message</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+
<variablelist>
<varlistentry>
<term>
@@ -2194,45 +1932,12 @@ Specifies the nonfatal error message to be reported.
</varlistentry>
</variablelist>
<para>
-<!-- .LP -->
-<!-- .eM -->
Most programs should use
-<function>XtAppWarningMsg ,</function>
+<function>XtAppWarningMsg</function>,
not
-<function>XtWarning ,</function>
+<function>XtWarning</function>,
to provide for customization and internationalization of warning messages.
This routine has been superseded by
-<function>XtAppWarning .</function>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+<function>XtAppWarning</function>.
</para>
-</chapter>
-</book>
+</appendix>