DESIGN (kwidgets) functions


LIBRARY ROUTINE

xvw_create_list - create list GUI object

LIBRARY CALL

xvobject xvw_create_list(
   xvobject parent,
   char   *name)

INPUT

OUTPUT

none

RETURN VALUE

The list object on success, NULL on failure

DESCRIPTION

The list GUI object presents the user with a set of strings inside a scrolled viewport. A callback can be installed on the list object which will be fired when the user selects an item from the list.

A list GUI object is really a compound object; that is, it is made up of two objects: the viewport and the "actual list", where the viewport contains the list and provides scrolling capabilities, and the "actual list" is inside the viewport and contains the list contents.

When you create a list, the GUI object returned is the viewport object; this object should be referenced when setting geometry, relative offset, and so on (in other words, when setting or getting any attribute not having to do directly with the contents of the list, where those particular attributes are called out below).

The "actual list" part of the object is used when changing the contents of the list, setting the size of the list, and highlighting or unhighlighting elements of the list. The "actual list" part of the compound list object can be obtained with a call to xvw_retrieve_list().

When the Athena widget set is used, the list object is instantiated as a xfwfScrolledListWidget. When the Olit widget set is used, the list object is instantiated as a scrollingListWidget. When the Motif widget set is used, the list object is instantiated as a ScrolledList.

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

none

MODIFICATION

none

FILES

$DESIGN/objects/library/kwidgets/src/List.c

SEE ALSO

kwidgets(3)

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.