CDE/cde/doc/C/guides/man/m3_Dt/EdCutToC.sgm

<!-- $XConsortium: EdCutToC.sgm /main/5 1996/08/30 12:58:14 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.XCSA.MAN20.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN20.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtEditorCutToClipboard</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtEditorCutToClipboard</Function></RefName>
<RefPurpose>copy the primary selection in a DtEditor widget to the clipboard and delete the selected text
</RefPurpose>
</RefNameDiv>
<!-- 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;Dt/Editor.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>DtEditorCutToClipboard</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtEditorCutToClipboard</Function> function copies the primary selected text in the DtEditor widget,
specified by the
<Symbol Role="Variable">widget</Symbol>, argument to the clipboard and then
deletes the primary selected text.
Text can be selected and deselected programmatically with
&cdeman.DtEditorSelectAll; and
&cdeman.DtEditorDeselect;.</Para>
<Para>The
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
<![ %CDE.C.CDE; [</Para>
<Para>For a complete definition of the DtEditor widget
and its associated resources, see
&cdeman.DtEditor;. ]]></Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtEditorCutToClipboard</Function> function returns
True;
otherwise, if the primary selection is
<SystemItem Class="Constant">NULL</SystemItem>, or if the widget doesn't own the primary selection, or if the
function is unable to gain ownership of the clipboard selection, it
returns
False.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorClearSelection;, &cdeman.DtEditorCopyToClipboard;, &cdeman.DtEditorDeleteSelection;, &cdeman.DtEditorDeselect;, &cdeman.DtEditorPasteFromClipboard;, &cdeman.DtEditorSelectAll;, &cdeman.DtEditorUndoEdit;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->