CW_BGRID Name
CW_BGRID Purpose
CW_BGRID is a compound widget that implements a multi-column
cw_bgroup widget.
Category
Compound widgets
Calling Sequence
widget = CW_BGRID(parent,names)
To get or set the value of a CW_BGRID, use the GET_VALUE and
SET_VALUE keywords to WIDGET_CONTROL. The value of a CW_BGRID
is:
-----------------------------------------------
Type Value
-----------------------------------------------
normal None
exclusive label of currently set button
non-exclusive Vector indicating the position
of each button (1-set, 0-unset)
-----------------------------------------------
Inputs
parent - The ID of the parent widget.
names - A StrArr of button names (a vector).
Keyword Parameters
EVENT_FUNC - The name of an optional user-supplied event function
for buttons. This function is called with the return
value structure whenever a button is pressed, and
follows the conventions for user-written event
functions.
UVALUE - Supplies the user value for the widget.
UNAME - Supplies the user name for the widget.
ROWS - The number of rows in the grid (the default is eight).
GREY_BUTTONS - Use this keyword to turn off certain buttons.
Pass in an array of 0s and 1s with the same
dimensions as the names input array. Buttons
will be made insensitive where this array holds
a 0.
SET_VALUE - Set the initial value of each button in the grid.
This keyword is an array of 0s and 1s with the
same dimensions as the names input array. Buttons
will be set on where this array holds a 1. This
keyword only applies when the NONEXCLUSIVE keyword
is also set.
SORT - Sort the button names into alphabetical order before
creating the widget. This option uses IDL's sort
function.
EXCLUSIVE - The buttons will take the form of radio buttons
where only one button may be selected at a time.
NONEXCLUSIVE - The buttons take the form of the nonexclusive
cw_bgroup buttons. A checkmark appears when
the button is selected and more than one button
may be selected at a time.
Outputs
The ID of the created widget is returned.
Common Blocks
None.
Procedure
WIDGET_CONTROL, id, SET_VALUE=value can be used to change the
current value displayed by the widget.
WIDGET_CONTROL, id, GET_VALUE=var can be used to obtain the current
value displayed by the widget. Uses
CW_BGROUP_MOD (for the ability to set a cw_bgroup to all buttons off)
Modification History
Written by: Edward C. Wiebe, 2002-08-27