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

<!-- $XConsortium: EdInvFor.sgm /main/5 1996/08/30 13:00:50 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.MAN33.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN33.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtEditorInvokeFormatDialog</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtEditorInvokeFormatDialog</Function></RefName>
<RefPurpose>display the DtEditor widget dialog for choosing formatting options
</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>void <Function>DtEditorInvokeFormatDialog</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtEditorInvokeFormatDialog</Function> function displays the Format Settings dialog of the DtEditor widget.
This dialog
enables a user to set the text formatting options:
margins and
text alignments (left aligned, right aligned, justified or centered).
The dialog also provides the capability to format either the paragraph
containing the insertion cursor or the entire contents of the DtEditor widget.
The Format Settings dialog remains displayed until the user closes it.
For a complete description of the Format Settings dialog, see
<Classname>DtEditor</Classname>.</Para>
<Para>Text can be formatted programmatically with
&cdeman.DtEditorFormat;.</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>The
<Function>DtEditorInvokeFormatDialog</Function> function returns no value.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorFormat;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->