Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
DtEditorFormat(library call)			  DtEditorFormat(library call)

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

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	align-
       ments  (left  aligned,  right aligned, justified	or centered) are used.
       Optionally, alternative settings	can be passed as an argument to	DtEdi-
       torFormat  in a data structure.	This function formats either the para-
       graph 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 DtEditorInvokeFormatDia-
       log(3). For a complete description of formatting	and  the  Format  Set-
       tings 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_JUS-
       TIFY,  DtEDITOR_ALIGN_LEFT  or  DtEDITOR_ALIGN_RIGHT. If	the formatSet-
       tings 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 re-
       formats 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 re-
       sources,	see DtEditor(3).

       For  a complete definition of DtEditorFormatSettings, see Dt/Editor.h -
       DtEditor(5).

RETURN VALUE
       Upon successful completion, the DtEditorFormat function returns	DtEDI-
       TOR_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 tmpnam3S.

       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
       Dt/Editor.h - DtEditor(5), DtEditor(3),	DtEditorInvokeFormatDialog(3);
       tmpnam3S.

						  DtEditorFormat(library call)
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=DtEditorFormat&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help