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

<!-- $XConsortium: EdPasteF.sgm /main/5 1996/08/30 13:01:09 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.MAN34.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN34.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtEditorPasteFromClipboard</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtEditorPasteFromClipboard</Function></RefName>
<RefPurpose>insert the clipboard selection into a DtEditor widget
</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>DtEditorPasteFromClipboard</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtEditorPasteFromClipboard</Function> function inserts the clipboard selection before the insertion cursor of the
DtEditor widget.
If the insertion cursor is inside the current selection,
the clipboard selection replaces the selected text.
Text can be cut or copied to the clipboard with
&cdeman.DtEditorCutToClipboard; and
&cdeman.DtEditorCopyToClipboard;. 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>DtEditorPasteFromClipboard</Function> function returns
True;
otherwise, if the widget does not own the primary selection,
the function returns
False.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorClearSelection;, &cdeman.DtEditorCutToClipboard;, &cdeman.DtEditorCopyToClipboard;, &cdeman.DtEditorDeleteSelection;, &cdeman.DtEditorDeselect;, &cdeman.DtEditorSelectAll;, &cdeman.DtEditorUndoEdit;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->