NAME

C SPECIFICATION

#include <cx/UI.h>

void cxInWdgtScrollListItemsSet (char *portname, int numEntries,
 char *listEntriesString)

FORTRAN SPECIFICATION

subroutine cxInWdgtScrollListItemsSet (portname, numEntries, listEntriesString)
character* portname, listEntriesString
integer numEntries

PARAMETERS

portname

This is the name of the input parameter port whose widget is to get new items

numEntries

This is the number of list items in the list entry string

listEntriesString

This is a string of newline terminated substrings that make up the new list of items. "listEntriesString" should be a single null-terminated string composed of substrings representing each selected item in order. These substrings should be separated by newline characters ('\n'). The last substring should also have a terminating newline.

DESCRIPTION

This is the IRIS Explorer Widget Library call used to assign a series of items to an IRIS Explorer Scrolled List widget. Any items in the scrolled list widget prior to the call are deleted, then a new list of items from the character string "listEntriesString" are inserted in order.

Sample call:

cxInWdgtScrollListItemsSet("Name List", 3, "Item 1\nItem 2\nItem 3\n");

This would result in deleting any prior list items, and stuffing list "Name List" with 3 list items, "Item 1", "Item 2" and "Item 3". The parameter value for that widget will be the empty string.

SEE ALSO