NAME

C SPECIFICATION

#include <cx/UI.h>

void cxInWdgtScrollListItemsDelete (char *portname, char *listEntriesString)

FORTRAN SPECIFICATION

subroutine cxInWdgtScrollListItemsDelete (portname, listEntriesString)
character* portname, listEntriesString

PARAMETERS

portname

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

listEntriesString

This is a string of newline terminated substrings that should be deleted from the list. "listEntriesString" should be a single null-terminated string composed of substrings representing each selected item. 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 remove items from the named IRIS Explorer Scrolled List Widget. Items in "listEntriesString" are removed from the named list if they exist in the named list. "listEntriesString" should be a single null-terminated string composed of substrings representing each selected item. The widget parameter value will change to the empty string. Items requested to be deleted but not in the list are ignored.

Sample call:

cxInWdgtScrollListItemsDelete("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 is the empty string.

SEE ALSO