debian/cdesktop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial import of the CDE 2.1.30 sources from the Open Group.

Browse Source
This commit is contained in:
Peter Howkins
2012-03-10 18:21:40 +00:00
commit 83b6996daa
18978 changed files with 3945623 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
cde/doc/C/guides/man/m3_tttk/Xt_inp_h.sgm Normal file
View File

@@ -0,0 +1,101 @@
<!-- $XConsortium: Xt_inp_h.sgm /main/6 1996/09/08 20:23:40 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN273.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN273.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_Xt_input_handler</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_Xt_input_handler</Function></RefName>
<RefPurpose>Process ToolTalk events for Xt clients
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Xt_inp_h.sgm /main/6 1996/09/08 20:23:40 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tttk.h>
</FuncSynopsisInfo>
<FuncDef>void <Function>tttk_Xt_input_handler</Function></FuncDef>
<ParamDef>XtPointer <Parameter>procid</Parameter></ParamDef>
<ParamDef>int *<Parameter>source</Parameter></ParamDef>
<ParamDef>XtInputId *<Parameter>id</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>If
<Emphasis>procid</Emphasis> is not
<SystemItem Class="Constant">NULL</SystemItem>, <Function>tttk_Xt_input_handler</Function> passes it to
&cdeman.tt.default.procid.set;. The
<Function>tttk_Xt_input_handler</Function> function then calls
&cdeman.tt.message.receive;, which retrieves the next message available, if any, for the default
procid.
If
&cdeman.tt.message.receive; returns
<SystemItem Class="Constant">TT_ERR_NOMP</SystemItem>, then
<Function>tttk_Xt_input_handler</Function> closes the default
procid
with
&cdeman.ttdt.close;, and removes the input source
<Emphasis>*id</Emphasis> with
<Function>XtRemoveInput</Function>(3) if
<Emphasis>id</Emphasis> is not zero.
If a message is available and
&cdeman.tt.message.receive; returns it (indicating it was not consumed by any message or pattern
callback), then the ToolTalk service passes the message to
&cdeman.tttk.message.abandon;.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>tttk_Xt_input_handler</Function> function returns no value.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application should use
<Function>tttk_Xt_input_handler</Function> as its Xt input handler unless some
messages are expected not to be consumed by callbacks.
(The only messages that
absolutely cannot be intercepted and consumed by callbacks are those
that match observe signatures in a
ptype
or
otype.)
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<InformalExample>
<ProgramListing>int myTtFd;
char *myProcID;
myProcID = ttdt_open(&amp;myTtFd, "WhizzyCalc", "Acme", "1.0", 1);
/* ... */
/* Process the message that started us, if any */
tttk_Xt_input_handler(myProcID, 0, 0);
/* ... */
XtAppAddInput(myContext, myTtFd, (XtPointer)XtInputReadMask,
tttk_Xt_input_handler, myProcID);
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.ttdt.close;, &cdeman.tttk.message.abandon;, &cdeman.tt.default.procid.set;, &cdeman.tt.message.receive;, <Function>XtAppAddInput</Function>(3), <![ %CDE.C.CDE; [<Function>XtRemoveInput</Function>(3). ]]><![ %CDE.C.XO; [<Function>XtRemoveInput</Function> in the &str-Zt;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

155
cde/doc/C/guides/man/m3_tttk/block_wh.sgm Normal file
View File

@@ -0,0 +1,155 @@
<!-- $XConsortium: block_wh.sgm /main/5 1996/08/30 14:01:38 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN274.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN274.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_block_while</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_block_while</Function></RefName>
<RefPurpose>block while a counter is greater than zero
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: block_wh.sgm /main/5 1996/08/30 14:01:38 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tttk.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tttk_block_while</Function></FuncDef>
<ParamDef>XtAppContext <Parameter>app2run</Parameter></ParamDef>
<ParamDef>const int *<Parameter>blocked</Parameter></ParamDef>
<ParamDef>int <Parameter>ms_timeout</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tttk_block_while</Function> function
is used to process asynchronous events, such as ToolTalk messages
or window system events, while waiting for a condition or timeout.
</Para>
<Para>If
<Emphasis>app2run</Emphasis> is not zero, then an event loop is run for that application context,
by repeatedly calling
<Function>XtAppProcessEvent</Function>(3) with
<Emphasis>ms_timeout</Emphasis> being effected using
<Function>XtAppAddTimeOut</Function>(3). If
<Emphasis>app2run</Emphasis> is zero, then the file descriptor (as returned by
&cdeman.tt.fd;) of the default procid is polled (using the
<Function>poll</Function>(2) function) and
&cdeman.tttk.Xt.input.handler; is called whenever the file descriptor is active.
</Para>
<Para>If
<Emphasis>blocked</Emphasis> is zero, then
<Function>tttk_block_while</Function> runs until
<Emphasis>ms_timeout</Emphasis> occurs.
If
<Emphasis>blocked</Emphasis> is non-zero, then the loop is run until either
<Emphasis>ms_timeout</Emphasis> occurs, or
<Emphasis>*blocked</Emphasis> is less than 1.
</Para>
<Para>If
<Emphasis>ms_timeout</Emphasis> is zero,
<Function>tttk_block_while</Function> checks once for events, processes the first one, and then returns.
If
<Emphasis>ms_timeout</Emphasis> is negative,
no timeout is in effect.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tttk_block_while</Function> function returns the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ETIMEDOUT</Term>
<ListItem>
<Para>The timeout occurred within
<Emphasis>ms_timeout</Emphasis> milliseconds, or
<Emphasis>ms_timeout</Emphasis> was zero and no input was available.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_EINTR</Term>
<ListItem>
<Para>The
<Emphasis>app2run</Emphasis> argument was zero, and
<Function>poll</Function>(2) was interrupted by a signal.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_EAGAIN</Term>
<ListItem>
<Para>The
<Emphasis>app2run</Emphasis> argument was zero, and
<Function>poll</Function>(2) returned
<SystemItem Class="Constant">EAGAIN</SystemItem>.</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>If
<Emphasis>app2run</Emphasis> is not zero and
<Emphasis>ms_timeout</Emphasis> is negative, then
<Function>tttk_block_while</Function> will only return when
<Emphasis>*blocked</Emphasis> is less than 1, with
<SystemItem Class="Constant">TT_OK</SystemItem> being returned.
</Para>
<Para>If
<Emphasis>app2run</Emphasis> is not zero,
<Emphasis>ms_timeout</Emphasis> is negative, and
<Emphasis>blocked</Emphasis> is zero, then
<Function>tttk_block_while</Function> behaves equivalent to
<Function>XtAppMainLoop</Function>(3), and will never return.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>If
<Emphasis>app2run</Emphasis> is zero, then only messaging events for the default procid will be serviced.
Events for other procids will be blocked, as will window
system events, so that the graphical user interface of the application
will not update itself even, for example, after expose events.
</Para>
<Para>On the other hand, if the application passes its Xt context in as
<Emphasis>app2run</Emphasis>, then window system events will continue to be handled, as will message
activity for all procids for which an
<Function>XtAppAddInput</Function>(3) has been done.
Since the window system event loop is fully operational
in this case, the application should take care to disable any
user interface controls that the user should not operate while
the application is waiting for
<Function>tttk_block_while</Function> to return.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.tttk.Xt.input.handler;; <![ %CDE.C.CDE; [<Function>poll</Function>(2), <Function>XtAppPending</Function>(3), <Function>XtAppAddTimeOut</Function>(3), <Function>XtAppNextEvent</Function>(3), <Function>XtDispatchEvent</Function>(3). ]]><![ %CDE.C.XO; [<Function>poll</Function> in the &str-ZK;;
<Function>XtAppPending</Function>, <Function>XtAppAddTimeOut</Function>, <Function>XtAppNextEvent</Function>, <Function>XtDispatchEvent</Function> in the &str-Zt;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

104
cde/doc/C/guides/man/m3_tttk/m_abando.sgm Normal file
View File

@@ -0,0 +1,104 @@
<!-- $XConsortium: m_abando.sgm /main/5 1996/08/30 14:02:17 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN275.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN275.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_message_abandon</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_message_abandon</Function></RefName>
<RefPurpose>finalize a message properly
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: m_abando.sgm /main/5 1996/08/30 14:02:17 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tttk.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tttk_message_abandon</Function></FuncDef>
<ParamDef>Tt_message <Parameter>msg</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tttk_message_abandon</Function> function is used by an application
when it does not understand a message
and wants to get rid of it.
The
<Function>tttk_message_abandon</Function> function fails or rejects
<Emphasis>msg</Emphasis> if appropriate, and then destroys it.
The
<Function>tttk_message_abandon</Function> will reject or fail the message only if
<Emphasis>msg</Emphasis> is a
<SystemItem Class="Constant">TT_REQUEST</SystemItem> in
<StructName Role="typedef">Tt_state</StructName> <SystemItem Class="Constant">TT_SENT</SystemItem>. If it has a
<StructName Role="typedef">Tt_address</StructName> of
<SystemItem Class="Constant">TT_HANDLER</SystemItem> or a
<Function>tt_message_status</Function> of
<SystemItem Class="Constant">TT_WRN_START_MESSAGE</SystemItem>, then it fails the message;
otherwise, it rejects it.
In either case,
<Function>tttk_message_abandon</Function> gives
<Emphasis>msg</Emphasis> a message status (see
&cdeman.tt.message.status;) of
<SystemItem Class="Constant">TT_DESKTOP_ENOTSUP</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tttk_message_abandon</Function> function returns the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOTHANDLER</Term>
<ListItem>
<Para>This application is not the handler for this message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_POINTER</Term>
<ListItem>
<Para>The pointer passed does not point to an object
of the correct type for this operation.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.tt.message.status;, &cdeman.tttk.message.fail;, &cdeman.tttk.message.reject;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

112
cde/doc/C/guides/man/m3_tttk/m_create.sgm Normal file
View File

@@ -0,0 +1,112 @@
<!-- $XConsortium: m_create.sgm /main/5 1996/08/30 14:02:51 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN276.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN276.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_message_create</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_message_create</Function></RefName>
<RefPurpose>create a message conforming to the &str-XZ; conventions
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: m_create.sgm /main/5 1996/08/30 14:02:51 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tttk.h>
</FuncSynopsisInfo>
<FuncDef>Tt_message <Function>tttk_message_create</Function></FuncDef>
<ParamDef>Tt_message <Parameter>context</Parameter></ParamDef>
<ParamDef>Tt_class <Parameter>the_class</Parameter></ParamDef>
<ParamDef>Tt_scope <Parameter>the_scope</Parameter></ParamDef>
<ParamDef>const char *<Parameter>handler</Parameter></ParamDef>
<ParamDef>const char *<Parameter>op</Parameter></ParamDef>
<ParamDef>Tt_message_callback <Parameter>callback</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tttk_message_create</Function> function
creates a message that propagates inherited contexts
from one message to another.
The
<Function>tttk_message_create</Function> function creates a message and copies onto it all the context slots from
<Symbol Role="Variable">context</Symbol> whose slotname begins with the characters
<SystemItem Class="Constant">ENV_</SystemItem>. It gives
the created message a
<StructName Role="typedef">Tt_class</StructName> of
<Emphasis>the_class</Emphasis> and a
<StructName Role="typedef">Tt_scope</StructName> of
<Emphasis>the_scope</Emphasis>. If
<Emphasis>handler</Emphasis> is not
<SystemItem Class="Constant">NULL</SystemItem>, then
<Function>tttk_message_create</Function> addresses the message as a
<SystemItem Class="Constant">TT_HANDLER</SystemItem> to that
procid;
otherwise, it gives the message a
<StructName Role="typedef">Tt_address</StructName> of
<SystemItem Class="Constant">TT_PROCEDURE</SystemItem>. It sets
the message's op to
<Symbol Role="Variable">op</Symbol> if
<Symbol Role="Variable">op</Symbol> is not
<SystemItem Class="Constant">NULL</SystemItem>. If
<Symbol Role="Variable">callback</Symbol> is not
<SystemItem Class="Constant">NULL</SystemItem>, <Function>tttk_message_create</Function> adds it to the message as a message callback.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tttk_message_create</Function> function
returns the created
<StructName Role="typedef">Tt_message</StructName>, which can be modified, sent, and destroyed like any other
<StructName Role="typedef">Tt_message</StructName> <Literal>;</Literal> otherwise, it returns an error pointer.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned handle:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_ERR_NOMEM</Term>
<ListItem>
<Para>There is insufficient memory available to perform the function.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>The specified process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.tt.message.create;, &cdeman.tttk.message.create;, &cdeman.ttdt.file.notice;, &cdeman.ttdt.file.request;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

93
cde/doc/C/guides/man/m3_tttk/m_destro.sgm Normal file
View File

@@ -0,0 +1,93 @@
<!-- $XConsortium: m_destro.sgm /main/5 1996/08/30 14:03:28 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN277.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN277.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_message_destroy</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_message_destroy</Function></RefName>
<RefPurpose>destroy a message conforming to the &str-XZ; conventions
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: m_destro.sgm /main/5 1996/08/30 14:03:28 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tttk.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tttk_message_destroy</Function></FuncDef>
<ParamDef>Tt_message <Parameter>msg</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tttk_message_destroy</Function> function
can be used in place of
&cdeman.tt.message.destroy;. It destroys any patterns that may have been stored on
<Emphasis>msg</Emphasis> by
&cdeman.ttdt.message.accept; or
&cdeman.ttdt.subcontract.manage;. Then it passes
<Emphasis>msg</Emphasis> to
&cdeman.tt.message.destroy;.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tttk_message_destroy</Function> function returns the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_POINTER</Term>
<ListItem>
<Para>The pointer passed does not point to an object of
the correct type for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_WRN_STOPPED</Term>
<ListItem>
<Para>The message is not actually destroyed.
(A message is not destroyed if it is in a non-final state;
for example, a request for which the reply has not been received.)
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.tt.message.create;, &cdeman.tt.message.destroy;, &cdeman.ttdt.file.notice;, &cdeman.ttdt.file.request;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

92
cde/doc/C/guides/man/m3_tttk/m_fail.sgm Normal file
View File

@@ -0,0 +1,92 @@
<!-- $XConsortium: m_fail.sgm /main/5 1996/08/30 14:04:03 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN278.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN278.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_message_fail</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_message_fail</Function></RefName>
<RefPurpose>fail a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: m_fail.sgm /main/5 1996/08/30 14:04:03 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tttk.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tttk_message_fail</Function></FuncDef>
<ParamDef>Tt_message <Parameter>msg</Parameter></ParamDef>
<ParamDef>Tt_status <Parameter>status</Parameter></ParamDef>
<ParamDef>const char *<Parameter>status_string</Parameter></ParamDef>
<ParamDef>int <Parameter>destroy</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tttk_message_fail</Function> function sets the status and status string of the
<SystemItem Class="Constant">TT_REQUEST</SystemItem> <Emphasis>msg</Emphasis>, fails
<Emphasis>msg</Emphasis>, and then destroys
<Emphasis>msg</Emphasis> if
<Symbol Role="Variable">destroy</Symbol> is True.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tttk_message_fail</Function> function returns the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOTHANDLER</Term>
<ListItem>
<Para>This application is not the handler for this message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_POINTER</Term>
<ListItem>
<Para>The pointer passed does not point to an object
of the correct type for this operation.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.tt.message.fail;, &cdeman.tttk.message.abandon;, &cdeman.tttk.message.reject;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

93
cde/doc/C/guides/man/m3_tttk/m_reject.sgm Normal file
View File

@@ -0,0 +1,93 @@
<!-- $XConsortium: m_reject.sgm /main/5 1996/08/30 14:05:03 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN279.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN279.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_message_reject</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_message_reject</Function></RefName>
<RefPurpose>reject a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: m_reject.sgm /main/5 1996/08/30 14:05:03 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tttk.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tttk_message_reject</Function></FuncDef>
<ParamDef>Tt_message <Parameter>msg</Parameter></ParamDef>
<ParamDef>Tt_status <Parameter>status</Parameter></ParamDef>
<ParamDef>const char *<Parameter>status_string</Parameter></ParamDef>
<ParamDef>int <Parameter>destroy</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tttk_message_reject</Function> function
sets the status and status string of the
<SystemItem Class="Constant">TT_REQUEST</SystemItem> <Emphasis>msg</Emphasis>, rejects the
<Emphasis>msg</Emphasis>, and then destroys
<Emphasis>msg</Emphasis> if
<Symbol Role="Variable">destroy</Symbol> is True.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tttk_message_reject</Function> function returns the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOTHANDLER</Term>
<ListItem>
<Para>This application is not the handler for this message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_POINTER</Term>
<ListItem>
<Para>The pointer passed does not point to an object
of the correct type for this operation.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.tt.message.reject;, &cdeman.tttk.message.fail;, &cdeman.tttk.message.abandon;, &cdeman.tttk.message.fail;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

68
cde/doc/C/guides/man/m3_tttk/op_str.sgm Normal file
View File

@@ -0,0 +1,68 @@
<!-- $XConsortium: op_str.sgm /main/5 1996/08/30 14:05:34 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN280.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN280.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_op_string</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_op_string</Function></RefName>
<RefPurpose>map a ToolTalk op code to a string
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: op_str.sgm /main/5 1996/08/30 14:05:34 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tttk.h>
</FuncSynopsisInfo>
<FuncDef>char <Function>*tttk_op_string</Function></FuncDef>
<ParamDef>Tttk_op <Parameter>opcode</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tttk_op_string</Function> function
returns a string containing the op for
<Emphasis>opcode</Emphasis>.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tttk_op_string</Function> function returns a string that can be freed using
&cdeman.tt.free;; otherwise, it returns
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The distinctions in the
<StructName Role="typedef">Tttk_op</StructName> enumerated type are for programmer convenience, and elements of
<StructName Role="typedef">Tttk_op</StructName> do not necessarily map one-to-one with op strings, since ToolTalk
allows ops to be overloaded.
For example,
<SystemItem Class="Constant">TTME_EDIT</SystemItem> and
<SystemItem Class="Constant">TTME_COMPOSE</SystemItem> are overloaded on the same op
(<Symbol Role="Message">Edit</Symbol>), and the messages
only vary by the
<StructName Role="typedef">Tt_mode</StructName> of the first argument.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.tt.message.op;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

60
cde/doc/C/guides/man/m3_tttk/str_op.sgm Normal file
View File

@@ -0,0 +1,60 @@
<!-- $XConsortium: str_op.sgm /main/5 1996/08/30 14:06:07 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN281.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN281.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_string_op</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_string_op</Function></RefName>
<RefPurpose>map a string to a ToolTalk op code
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: str_op.sgm /main/5 1996/08/30 14:06:07 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tttk.h>
</FuncSynopsisInfo>
<FuncDef>Tttk_op <Function>tttk_string_op</Function></FuncDef>
<ParamDef>const char *<Parameter>opstring</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tttk_string_op</Function> function returns the
<StructName Role="typedef">Tttk_op</StructName> named by
<Emphasis>opstring</Emphasis>.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tttk_string_op</Function> function a
<StructName Role="typedef">Tttk_op</StructName> value;
otherwise, it returns
<SystemItem Class="Constant">TTDT_OP_NONE</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>See
&cdeman.tttk.op.string;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.tttk.op.string;, &cdeman.tt.message.op;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->