U_EDITREND

Create and modify rendition schemes

WTSupported in traditional Synergy on Windows

WNSupported in Synergy .NET on Windows

USupported on UNIX

VSupported on OpenVMS

xcall U_EDITREND([filename], [number], [description], [windows], [areas], 
&     [field_numbers][, help_id])

Arguments

filename

(optional) The name of the rendition file in which to save the rendition schemes. (a)

number

(optional) The number of user renditions to change. The default is 0. (n)

description

(optional) The array of user rendition descriptions to load in the “Select Screen Area” selection window. If description is not passed and user renditions are to be changed, the default descriptions (“User rendition X”) will be supplied. (a)

windows

(optional) The array of window IDs for the user renditions to load in the “Sample Windows” window on UNIX or OpenVMS. Each window will be placed on the screen at its default position. (Ignored on Windows.) (n)

areas

(optional) The array of the screen areas within windows that will be affected on UNIX or OpenVMS. These areas can be added together for combined effects. If areas is 0, then none are affected. The default is all three areas. (Ignored on Windows.) (n)

D_RND_AREA = Processing area.

D_RND_BRDR = Border area.

D_RND_TITLE = Title area.

field_numbers

(optional) The array of field numbers within windows that will be affected on UNIX or OpenVMS, or WFN_ALL to affect all fields. The default is none. (Ignored on Windows.) (n)

help_id

(optional) The help identifier. (a)

Discussion

U_EDITREND enables the user to create or modify rendition schemes and save them to a rendition file. It affects the default and user renditions referenced in the U_REND subroutine topic. (These renditions, as listed in the tools.def file, are D_RND_MNU_ENA through D_RND_USER_5).

On Windows, U_EDITREND cannot set the Input Field Processing rendition. On all platforms, U_EDITREND cannot set Disabled Input Field, Read-only Input Field Display, or Read-Only Field Processing. (These can be set only by U_REND and only on UNIX and OpenVMS.)

This subroutine is used by Proto to support the task of editing renditions. See Using the Renditions window (Windows) for more information.

On Windows, U_EDITREND invokes the Renditions Control where users can graphically modify and maintain window system renditions. See Customizing the look of your application for more information on editing renditions in a Windows environment.

If filename doesn’t exist, it is created. If filename is not specified, UI Toolkit searches for the rendition file as follows:

• If the environment variable DTKRNDFIL is defined, the rendition filename is the value of DTKRNDFIL.
• If DTKRND is defined instead of DTKRNDFIL, the rendition file is opened as DTKRND:dtkrnd.ism.
• If neither environment variable is defined, dtkrnd.ism is opened in the current directory.

If windows is not specified and user renditions are used, default sample windows are created. All created windows are deleted upon exit.

U_EDITREND recognizes the following menu entry names if they are included in a placed menu column:

O_CANCEL	Cancel changes to area with which you are working.
O_EXIT	Exit and save all changes.
O_HELP	Call the EHELP_METHOD subroutine and pass help_id.
O_DEFAULT	Set renditions to their default values.
O_LDSCHEME	Load rendition schemes from the rendition file.
O_PALETTE	Modify a color palette.
O_RESET	Reset to the working rendition scheme that was saved on entry.
O_RMSCHEME	Remove a rendition scheme from the rendition file.
O_STSCHEME	Store rendition schemes to the rendition file.
S_UP	Move to the previous selection window item.
S_DOWN	Move to the next selection window item.
S_LEFT	Move to the selection item in the previous column.
S_RIGHT	Move to the selection item in the next column.

Any other menu entries cause this subroutine to return with g_select set to true and g_entnam set to the selected menu entry.

O_EXIT causes U_EDITREND to return to the calling program, but it does not clear g_select and g_entnam. This enables a layered calling routine to continue a seamless exit.

This subroutine always stores UI Toolkit’s current renditions to the rendition file as the working rendition settings upon both entry and exit of the subroutine.

See also

Customizing the look of your application

Examples

The following subroutine provides the entire “Renditions” utility included in Proto.

subroutine editrnd
.include "WND:tools.def"
record
      colid  ,i4
proc
      xcall e_enter                     ;Enter new environment
      xcall m_column(D_REMOVE, D_LOCAL) ;Remove all local columns
      xcall m_ldcol(colid, g_utlib, "c_editrend") ;Load edit column
      xcall m_defcol(9)                 ;Make it the default column
      xcall u_editrend                  ;Edit renditions
      xcall e_exit                      ;Exit environment
      xreturn
endsubroutine