MWAPI - VALUE

Draft MDC Standard

VALUE specifies the data associated with or represented by the gadget.

For a check box gadget, if the user selects the gadget, VALUE is set to 1 (one). If the user deselects the gadget, VALUE is set to 0 (zero). If a value that is assigned by the application evaluates to TRUE, the gadget is selected. If a value that is assigned by the application evaluates to FALSE, the gadget is deselected.

For a document, list entry box or text gadget, VALUE specifies the text value. Within a document text value, each linend indicates that, when the text value is displayed, the character following the linend should begin a new line. Otherwise, the formatting mechanisms used for displaying a document text value are determined by the underlying windowing platform, if there is one, and by the MWAPI otherwise.

For a list box, long list box or table gadget, VALUE specifies the number of choices selected. For a list box or, long list box, the choices selected are indicated by descendant nodes, of the form

^$W[INDOW] ( wname , gkeyword , gname , vkeyword , item )

where

and item identifies a selected choice.

For a table gadget, the choices selected are indicated by descendant nodes, of the form

^$W[INDOW] ( wname , gkeyword , gname , vkeyword , ritem , citem )

where ritem and citem identify a selected choice.

For a list box, long list box or table gadget, the value of these nodes is the emptystring. If an application attempts to create a descendant node of VALUE which has an item that does not identify a defined choice for the gadget, an error condition occurs with an ecode = "M48" and $EREF containing a value that indicates the ssvn reference for which the error occurred. If an application attempts to create a descendant node of VALUE which has a citem or ritem that does not identify a non-header row or column for the gadget, an error condition occurs with an ecode = "M48" and $EREF containing a value that indicates the ssvn reference for which the error occurred.

For a list box, long list box, or table gadget, an application can assign values to descendant nodes of VALUE, but it cannot assign a value to the VALUE node itself. However, an application can use an M[UMPS] KILL command of the form

^$W[INDOW] ( wname , gkeyword , gname , vkeyword )

to deselect all current selections in a list box, long list box, or table.

For a radio button set or list button gadget, VALUE specifies the item value of the selected choice. If an application attempts to assign to VALUE an item that does not identify a defined choice for the gadget, an error condition occurs with an ecode = "M48" and $EREF containing a value that indicates the ssvn reference for which the error occurred. If no choice is selected, the value of VALUE is an emptystring.

For a scroll gadget, VALUE specifies the value represented by the value indicator.

For a check box gadget, truefalse.

For a document gadget, longchars.

For a list entry box or text gadget, chars.

For a list box, long list box, or table gadget, VALUE has a domain of intexpr and descendant nodes have a domain of emptystring.

For a radio button set or list button gadget, item or emptystring.

For a scroll gadget, numexpr.

For a check box gadget, 0 (zero).

For a document, list button, list entry box, radio button set, or text gadget, emptystring.

For a list box, long list box, or table gadget, 0 (zero) with no descendant nodes.

For a scroll gadget, the value of the scrollmin component of the SCROLLRANGE elattribute.