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

<!-- $XConsortium: EdUndoEd.sgm /main/5 1996/08/30 13:02:57 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.MAN44.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN44.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtEditorUndoEdit</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtEditorUndoEdit</Function></RefName>
<RefPurpose>undo the last edit made to the text in 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>DtEditorUndoEdit</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtEditorUndoEdit</Function> function undoes the last change (deletion or insertion) made
to the text in a DtEditor widget.
A change consists of either a set of
consecutive insertions, or a set of consecutive deletions followed by up
to one set of consecutive insertions.
An insertion is consecutive if there have been no intervening deletions,
and it is continuing forward from the same point.
A deletion is consecutive if there have been no intervening insertions,
and its start or end position is coincidental with the last deletion
(that is, the deletion is continuing from the same point, either forward or
backward).
Undoing an edit once restores the original text.
Undoing an edit twice restores the last change.
</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>DtEditorUndoEdit</Function> function returns
True;
otherwise, if there is no pending undo it returns
False.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->