Public API Reference

                 

---

Check box
[Components]

Compounds
class	csCheckBox
	The csCheckBox class is a close child of csButton class. More...
Check box style flags
#define	CSBS_CBTYPEMASK   0x00010000
	Checkbox type mask.
#define	CSBS_CB2STATE   0x00000000
	The checkbox is a 2-state checkbox (on/off).
#define	CSBS_CB3STATE   0x00010000
	The checkbox is a 3-state checkbox (on/off/indefinite).
#define	CSBS_CBAUTO   0x00020000
	The checkbox automatically switches between states (on->off{->indefinite}).
#define	CSBS_DEFAULTCHECKBOX   (CSBS_SELECTABLE | CSBS_CB2STATE | CSBS_CBAUTO)
	Default checkbox button style.
Enumerations
enum	{ cscmdCheckBoxSet = 0x00000800, cscmdCheckBoxQuery, cscmdCheckBoxSwitched }
	Check box messages. More...
enum	csCheckBoxState { cscbsNonChecked, cscbsChecked, cscbsIndefinite }
	Possible check box states. More...

---

Define Documentation

#define CSBS_CB2STATE   0x00000000

The checkbox is a 2-state checkbox (on/off). Definition at line 42 of file cschkbox.h.

#define CSBS_CB3STATE   0x00010000

The checkbox is a 3-state checkbox (on/off/indefinite). Definition at line 44 of file cschkbox.h.

#define CSBS_CBAUTO   0x00020000

The checkbox automatically switches between states (on->off{->indefinite}). Definition at line 46 of file cschkbox.h.

#define CSBS_CBTYPEMASK   0x00010000

Checkbox type mask. Definition at line 40 of file cschkbox.h.

#define CSBS_DEFAULTCHECKBOX   (CSBS_SELECTABLE | CSBS_CB2STATE | CSBS_CBAUTO)

Default checkbox button style. Definition at line 48 of file cschkbox.h.

---

Enumeration Type Documentation

anonymous enum

Check box messages. Enumeration values: cscmdCheckBoxSet  Send to a checkbox to set its state. IN: (csCheckBoxState)newstate cscmdCheckBoxQuery  Query the state of a check box. OUT: (csCheckBoxState)state cscmdCheckBoxSwitched  Notify parent that check box state has changed. IN: (csCheckBox *)source Definition at line 53 of file cschkbox.h.

enum csCheckBoxState

Possible check box states. Enumeration values: cscbsNonChecked  The check box has no "checked" mark inside. cscbsChecked  The check box contains a "check" mark. cscbsIndefinite  The checkbox state is indefinite (hashed state). Definition at line 79 of file cschkbox.h.

---