Checkbox

  (subclass of 9.1.3.2 Button)

A Checkbox toggles a flag. Checkboxes can be combined to a CheckField which allows defining connection rules like radio-button-mode.

   GRAPE(checkbox, "get-flag")(on_off)

CHECKBOX *checkbox
int * on_off

Get the associated flag. * on_off is set ON resp.\ OFF depending on the state.

   GRAPE(Checkbox, "new-instance")(name, value)

CLASS *checkbox
char *name
int *value

A checkbox can be used inside of a checkfield, or stand alone. If you want to use a stand alone checkbox the pointer value must not be a NULL pointer.

   GRAPE(checkbox, "set-checkfield-bits")(that, bit)

CHECKBOX *checkbox
CHECKBOX *that
int bit

Using this method the dependency with one other Checkbox (that) can be set.

bit contains the combined values to be set in the 4 masks of checkbox, to set a 1 use the appropriate constant,
G_CHECKFIELD_CHECK_AND,
G_CHECKFIELD_CHECK_XOR,
G_CHECKFIELD_UNCHECK_AND,
G_CHECKFIELD_UNCHECK_XOR.

   GRAPE(checkbox, "set-dependency-masks")(check_and, check_xor, uncheck_and, uncheck_xor)

CHECKBOX *checkbox
CHECKFIELD_VAR check_and, check_xor
CHECKFIELD_VAR uncheck_and, uncheck_xor

Directly set the dependency mask of one Checkbox.

   GRAPE(checkbox, "set-flag")(on_off)

CHECKBOX *checkbox
int on_off

Set the associated flag.

   GRAPE(checkbox, "set-mask")(mask)

CHECKBOX *checkbox
CHECKFIELD_VAR mask

Set a new unique bit mask for the Checkbox.

   GRAPE(checkbox, "set-variable")(var)

CHECKBOX *checkbox
int * var

Set var as new variable pointer of the Checkbox, i.e. change the value passed as argument of "new-instance" or even "new-chekcbox" of class CheckField.

If checkbox is contained in a CheckField setting the variable to NULL makes checkbox use the field's variable. Vice versa if checkbox is part of and using the variable of a CheckField its gets an independent variable if non NULL is set.

   GRAPE(checkbox, "switch-flag")()

CHECKBOX *checkbox

Toggle the flag.

   GRAPE(checkbox, "switch-off")()

CHECKBOX *checkbox

Switches the Checkbox flag off. Since it has no arguments this method can be used by Buttons.

   GRAPE(checkbox, "switch-on")()

CHECKBOX *checkbox

Switches the Checkbox flag off. Since it has no arguments this method can be used by Buttons.