DtEditorFormat(3)

     NAME
          DtEditorFormat - format all or part of the contents of a
          DtEditor widget

     SYNOPSIS
          #include <Dt/Editor.h>

          DtEditorErrorCode DtEditorFormat(Widget widget,
                                           DtEditorFormatSettings *formatSettings,
                                           unsigned int amountToFormat);

     DESCRIPTION
          The DtEditorFormat() function formats all or part of the
          contents of the DtEditor widget according to the current
          text format settings in the Format Settings dialog.  These
          options specify which margins and alignments (left aligned,
          right aligned, justified or centered) are used.  Optionally,
          alternative settings can be passed as an argument to
          DtEditorFormat() in a data structure.  This function formats
          either the paragraph containing the insertion cursor or the
          entire contents of the DtEditor widget, depending on the
          value of the amountToFormat argument.

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

          The widget argument specifies the editor widget ID.

          The formatSettings argument specifies left margin value,
          right margin value and the justification style.  The
          LeftMargin and RightMargin fields of DtEditorFormatSettings
          must be zero or larger.  The Alignment field can have a
          value of DtEDITOR_ALIGN_CENTER, DtEDITOR_ALIGN_JUSTIFY,
          DtEDITOR_ALIGN_LEFT or DtEDITOR_ALIGN_RIGHT.  If the
          formatSettings argument is NULL, DtEditorFormat() uses the
          last format settings specified in the Format Settings
          dialog.

          When the amountToFormat argument is set to
          DtEDITOR_FORMAT_ALL, it reformats all the text in the edit
          window.  When this argument is 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).

          For a complete definition of DtEditorFormatSettings, see
          <Dt/Editor.h>.

     RETURN VALUE
          Upon successful completion, the DtEditorFormat() function
          returns DtEDITOR_NO_ERRORS; otherwise, it returns one of the
          following values:

             DtEDITOR_NO_TMP_FILE
                   The DtEditorFormat() function cannot create two
                   temporary files in the directory returned by
                   tmpnam(3S).

             DtEDITOR_ILLEGAL_SIZE
                   The left or right margin values are negative.

             DtEDITOR_INVALID_RANGE
                   The amountToFormat argument is not recognized.

             DtEDITOR_INVALID_TYPE
                   The Alignment field is not recognized.

     SEE ALSO
          DtEditor(5), DtEditor(3), DtEditorInvokeFormatDialog(3);
          tmpnam(3S).