<!-- $XConsortium: TxtFieAC.sgm /main/8 1996/09/08 21:12:45 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.MAN476.rsml.1">
<RefMeta>
<RefEntryTitle>XmTextFieldCopy</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTextFieldCopy</Function></RefName>
<RefPurpose>A TextField function that copies the primary selection to the clipboard
<IndexTerm>
<Primary>XmTextFieldCopy</Primary>
</IndexTerm><IndexTerm>
<Primary>TextField functions</Primary>
<Secondary>XmTextFieldCopy</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-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/TextF.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>XmTextFieldCopy</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>XmTextFieldCopy</Function> copies the primary selected text to the clipboard.
</Para>
<Para>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">XmCOPY</SystemItem>.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the TextField widget ID.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">time</Symbol></Term>
<ListItem>
<Para>Specifies the time at which the selection value is to be modified. This
should be the time of the event that triggered this request.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of TextField and its associated resources, see
&cdeman.XmTextField;.
</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.XmTextField;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
