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

<!-- $XConsortium: EdCheckF.sgm /main/5 1996/08/30 12:57: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. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN17.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN17.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtEditorCheckForUnsavedChanges</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtEditorCheckForUnsavedChanges</Function></RefName>
<RefPurpose>report whether text has been edited
</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>DtEditorCheckForUnsavedChanges</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtEditorCheckForUnsavedChanges</Function> function reports whether the text contained in the edit window of a
DtEditor widget has been modified since the last call to
&cdeman.DtEditorGetContents; or
&cdeman.DtEditorSaveContentsToFile;, including inserting, deleting or moving text with the keyboard
or mouse.
For information about retrieving the text without affecting whether
<Function>DtEditorCheckForUnsavedChanges</Function> reports that all changes have been saved, see
&cdeman.DtEditorGetContents; and
&cdeman.DtEditorSaveContentsToFile;.</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>DtEditorCheckForUnsavedChanges</Function> function returns
True
if changes have been
made to the contents of the DtEditor widget since the last call to
&cdeman.DtEditorGetContents; or
&cdeman.DtEditorSaveContentsToFile;; otherwise, it returns
False.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorGetContents;, &cdeman.DtEditorSaveContentsToFile;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->