<!-- $XConsortium: ContainD.sgm /main/8 1996/08/30 14:23:47 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.MAN113.rsml.1">
<RefMeta>
<RefEntryTitle>XmContainerCut</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmContainerCut</Function></RefName>
<RefPurpose>Container widget function to move items to the
clipboard
<IndexTerm>
<Primary>XmContainerCut</Primary>
</IndexTerm><IndexTerm>
<Primary>XmContainer</Primary>
</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 1993 by International Business Machines Corporation-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Container.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>XmContainerCut</Function></FuncDef>
<!--<ParamDef><Replaceable>container, timestamp</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>container</Parameter></ParamDef>
<ParamDef>Time <Parameter>timestamp</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmContainerCut</Function> cuts the primary selected items 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">XmMOVE</SystemItem>.
If the transfer is successful, this routine then calls the
<SystemItem Class="Resource">XmNconvertCallback</SystemItem> procedures for the <Symbol Role="Define">CLIPBOARD</Symbol> selection
and the <Symbol Role="Define">DELETE</Symbol> target.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">container</Symbol></Term>
<ListItem>
<Para>Specifies the Container widget ID.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">timestamp</Symbol></Term>
<ListItem>
<Para>Specifies the server time at which to modify the selection value.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of Container and its associated resources, see
&cdeman.XmContainer;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>The function returns False in the following cases: if the primary selection
is NULL, if the widget does not own the primary selection, or if the function
is unable to gain ownership of the clipboard selection. Otherwise, it returns
True.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmContainer;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
