NAME

DtEditorFormat − format all or part of the contents of a DtEditor widget

SYNOPSIS

#include <Dt/Editor.h>
Boolean DtEditorFormat(Widget widget,
unsigned int amountToFormat);

DESCRIPTION

The DtEditorFormat() function formats all or part of the contents of the DtEditor widget according to the current (or default) text formatting options in the Format Settings dialog. These options specify which margins and alignment (left aligned, right aligned, justified or centered) are used. This function formats either the paragraph containing the insertion cursor or the entire contents of the DtEditor widget, depending on the value of amountToFormat.

The Format Settings dialog is displayed with DtEditorInvokeFormatDialog(3).  For a complete description of formatting and the Format Settings dialog, see DtEditor(3). 

The widget argument specifies the editor widget ID. 

???? the argument definition must fit this wording template - same as the widget argument above - I’ve altered your material, please check this out ????
The amountToFormat argument, when set to DtEDITOR_FORMAT_ALL, reformats all the text in the DtEditor editor.  When set to DtEDITOR_PARAGRAPH, only the paragraph containing the insertion cursor is formatted. 

For a complete definition of the DtEditor widget and its associated resources, see DtEditor(3). 

RETURN VALUE

Upon successful completion, DtEditorFormat() function returns True; otherwise, it returns False. 

DtEditorFormat() fails if it cannot create two temporary files in the directory returned by tmpnam(3S). 

SEE ALSO

DtEditor(5), DtEditor(3), DtEditorInvokeFormatDialog(3), tmpnam(3S). 
 
 
 
 
 
 

  —  3 May 1994