Class Toggle

Summary

#
  This is a class for representing objects which can have an
  on-off state, in particular checkboxes, toggle buttons,
  and menu checkboxes.

Package:
(main)
File:
toggle.icn
Methods:
clear_is_checked, get_status, into_cbg, is_checked, set_is_checked, set_parent_check_box_group, toggle_is_checked

Fields:
is_checked_flag, parent_check_box_group

Source code.

Details
Constructor

Toggle(parent_check_box_group, is_checked_flag)

Methods:

clear_is_checked()

#
  Set the status to unchecked.


get_status()

#
  Return the status of the object; {1} if the object is checked,
  {&null} otherwise.


into_cbg()

#
  This empty method may be overridden; it is invoked when the
  object is added to a {CheckBoxGroup}.  Note that it is
  overridden by some of the subclasses described below.


is_checked()

#
  Succeed if the object is checked.


set_is_checked()

#
  Set the status to checked.


set_parent_check_box_group(x)

#
  Set the parent {CheckBoxGroup}.
  @param x   The parent {CheckBoxGroup}.


toggle_is_checked()

#
  Toggle the status of the object.


Fields:
is_checked_flag

parent_check_box_group


This page produced by UniDoc on 2021/04/15 @ 23:59:54.