title: Phi::CheckBox
author: YOSHIDA Kazuhiro
mailto: moriq@moriq.com

1. Phi::CheckBox

  CheckBox コンポーネントは，オン（チェック）状態またはオフ（非チェック）状態を切り替えることができるチェックボックスを表します。

  CheckBox コンポーネントはユーザーオプションを提供します。ユーザーはチェックボックスにチェックマークを付けてオプションを選択したり，チェックマークをはずしてオプションの選択を解除したりできます。

1.1. super class

  Phi::Button

1.1. class methods

: new(parent[, name, caption]) : Phi::CheckBox

1.1. properties

: alignment : Fixnum (LeftRight)
  チェックボックスのキャプションの位置

  : TA_RIGHT_JUSTIFY
    右側に表示されます。
  : TA_LEFT_JUSTIFY
    左側に表示されます。

: allow_grayed : Boolean
  チェックボックスを淡色表示にできるかどうか

  : true
    チェック，非チェック，淡色表示の 3 つの状態を持つ
  : false
    チェック，非チェックの 2 つの状態を持つ

: checked : Boolean
  チェックボックスがオンになっているかどうか

  : 注意
    #allow_grayed が true の場合は， #state の方が便利な場合もあります。

: state : Fixnum (CheckBoxState)
  チェックボックスがチェック，非チェック，淡色表示のいずれの状態にあるか

  : cb_Unchecked
    チェックボックスがチェックされていない。オプションが選択されていないことを示す
  : cb_Checked
    チェックボックスがチェックされている。オプションが選択されていることを示す
  : cb_Grayed
    チェックボックスが淡色表示されている。一般に，オプションの一部が選択されていることを示す

