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

<!-- $XConsortium: EdInvSpe.sgm /main/5 1996/08/31 14:57:26 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="CDEMX.MAN51.rsml.1">
<RefMeta>
<RefEntryTitle>DtEditorInvokeSpellDialog</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtEditorInvokeSpellDialog</Function></RefName>
<RefPurpose>display the DtEditor widget dialog for checking text for spelling errors
<IndexTerm>
<Primary>DtEditorInvokeSpellDialog</Primary>
</IndexTerm><IndexTerm>
<Primary>DtEditor functions</Primary>
<Secondary>DtEditorInvokeSpellDialog</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- **  (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- **  (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- **  (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Dt/Editor.h>
</FuncSynopsisInfo>
<FuncDef>DtEditorErrorCode <Function>DtEditorInvokeSpellDialog</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtEditorInvokeSpellDialog</Function> function displays the Spell dialog for the DtEditor widget.
This dialog displays
the list of unrecognized or misspelled words from the widget's text.
Users can search for and replace misspelled words
with the Spell dialog.
The list of misspelled words is automatically generated by filtering the
text for the DtEditor widget through the filter specified by the
<SystemItem Class="Resource">DtNspellFilter</SystemItem> resource when
<Function>DtEditorInvokeSpellDialog</Function> is called.
For a complete description of the Spell dialog and
the
<SystemItem Class="Resource">DtNspellFilter</SystemItem> resource, see
&cdeman.DtEditor;.</Para>
<Para>The
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
</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>DtEditorInvokeSpellDialog</Function> function returns
<SystemItem Class="Constant">DtEDITOR_NO_ERRORS</SystemItem> if the widget successfully executed the spell filter; otherwise,
it returns one of the following:
</Para>
<VariableList>
<VarListEntry>
<Term>DtEDITOR_SPELL_FILTER_FAILED</Term>
<ListItem>
<Para>If it cannot successfully execute the filter specified by the
<Symbol>DtNspellfilter</Symbol> resource.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_NO_TMP_FILE</Term>
<ListItem>
<Para>If it cannot create a temporary file in the directory returned by
<Filename MoreInfo="RefEntry">tmpnam</Filename>(3S).</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, <Filename MoreInfo="RefEntry">tmpnam</Filename>(3S).</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->