HelpSource/Classes/CheckBox.schelp

   1 CLASS:: CheckBox
   2 redirect:: implClass
   3 summary:: A view that toggles between two states.
   4 categories:: GUI>Views
   5
   6 DESCRIPTION::
   7
   8 A view that toggles between two states when clicked, displaying or hiding a check mark accordingly.
   9
  10 CLASSMETHODS::
  11
  12 PRIVATE:: key
  13
  14
  15
  16 INSTANCEMETHODS::
  17
  18
  19
  20 SUBSECTION:: Data
  21
  22
  23
  24 METHOD:: value
  25         Stating which of the two states the view is currently in, false meaning unchecked and true meaning checked. Default to false.
  26
  27         argument::
  28                 A Boolean.
  29
  30 METHOD:: valueAction
  31         Sets link::#-value:: and triggeres link::#-action::.
  32
  33         argument::
  34                 A Boolean.
  35
  36 METHOD:: string
  37         The text displayed next to the check mark.
  38
  39
  40
  41 SUBSECTION:: Actions
  42
  43 METHOD:: action
  44         The action object evaluated whenever the user toggles the state.
  45
  46
  47
  48 SUBSECTION:: Drag and drop
  49
  50 METHOD:: defaultGetDrag
  51         returns::
  52                 The link::#-value::.
  53
  54 METHOD:: defaultCanReceiveDrag
  55         returns::
  56                 True if the current drag data is a Boolean.
  57
  58 METHOD:: defaultReceiveDrag
  59         Sets link::#-valueAction:: to the current drag data.