<!-- $XConsortium: TxtCopyL.sgm /main/7 1996/08/30 16:21:30 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. -->

<RefEntry Id="CDEMMA.MAN470.rsml.1">
<RefMeta>
<RefEntryTitle>XmTextCopyLink</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTextCopyLink</Function></RefName>
<RefPurpose>A Text function that copies a link to the primary selection to the clipboard
<IndexTerm>
<Primary>XmTextCopyLink</Primary>
</IndexTerm><IndexTerm>
<Primary>Text functions</Primary>
<Secondary>XmTextCopyLink</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Text.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>XmTextCopyLink</Function></FuncDef>
<!--<ParamDef><Replaceable>widget, time</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>Time <Parameter>time</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmTextCopyLink</Function> copies a link to the primary selected text to the
clipboard.
This routine calls the <SystemItem Class="Resource">XmNconvertCallback</SystemItem> procedures, possibly
multiple times, with the <Symbol Role="Variable">selection</Symbol> member of the
<StructName Role="typedef">XmConvertCallbackStruct</StructName> set to <Symbol Role="Define">CLIPBOARD</Symbol> and with the
<Symbol Role="Variable">parm</Symbol> member set to <SystemItem Class="Constant">XmLINK</SystemItem>.
The Text widget itself does not copy any links; <SystemItem Class="Resource">XmNconvertCallback</SystemItem>
procedures are responsible for copying the link to the clipboard and for
taking any related actions.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the Text widget ID.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">time</Symbol></Term>
<ListItem>
<Para>Specifies the time of the transfer.
This should be the time of the event which triggered this request.
One source of a valid time stamp is the function
<Function>XtLastTimestampProcessed</Function>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of Text and its associated resources, see
&cdeman.XmText;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>This function returns False if the primary selection is NULL, if the
<Symbol Role="Variable">widget</Symbol> does not own the primary selection, if the function is
unable to gain ownership of the clipboard selection, or if no data is
placed on the clipboard.
Otherwise, it returns True.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmText;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
