DtEditorFormat man page on HP-UX

Man page or keyword search:  
man Server   10987 pages
apropos Keyword Search (all sections)
Output format
HP-UX logo
[printable version]

DtEditorFormat(library call)			  DtEditorFormat(library call)

       DtEditorFormat  — format all or part of the contents of a DtEditor wid‐

       #include <Dt/Editor.h>
       DtEditorErrorCode DtEditorFormat(
       Widget widget,
       DtEditorFormatSettings *formatSettings,
       unsigned int amountToFormat);

       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
       reformats all the text in the edit window.  When this argument  is  set
       to DtEDITOR_PARAGRAPH, only the paragraph containing the insertion cur‐
       sor 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 -

       Upon successful completion, the DtEditorFormat function returns	DtEDI‐
       TOR_NO_ERRORS; otherwise, it returns one of the following values:

		 The DtEditorFormat function cannot create two temporary files
		 in the directory returned by tmpnam3S.

		 The left or right margin values are negative.

		 The amountToFormat argument is not recognized.

		 The Alignment field is not recognized.

       Dt/Editor.h - DtEditor(5), DtEditor(3),	DtEditorInvokeFormatDialog(3);

						  DtEditorFormat(library call)

List of man pages available for HP-UX

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net