WkCheckBoxView

WkCheckBoxView provides a customizable version of a standard check box. It has a boolean value that is set to true when the box is checked and false when the box is unchecked. The value is toggled on and off by clicking on the check box. The state of a checkbox can be queried and changed using the #selection and #set messages, respectively. Checkboxes trigger a selectionChanged event when their state is changed. The textual label that appears to the right of the check box can be changed at runtime with the #labelString: message.

Protocol

alignment: resourceValue
Sets the horizontal alignment for the widget's image.

Default: XmALIGNMENTBEGINNING (Left)

Valid resource values:

XmALIGNMENTBEGINNING (Left) - Causes the center of the image to be horizontally aligned with the left edge of the widget's window.

XmALIGNMENTCENTER (Center) - Causes the center of the image to be horizontally aligned in the center of the widget's window.

XmALIGNMENTEND (Right) - Causes the center of the image to be horizontally aligned with the right edge of the widget's window.

 

checkedLabelString: aString
Specifies the renderable object (string) which draws on the face of the widget when it is checked.

 

click
Programatically click the button.

 

disabledLabelString: aString
Specifies the renderable object (string) which draws on the face of the widget when it is disabled.

 

drawPolicy: anInteger
Specifies the drawing policy used in rendering buttons. The drawing policy determines two things for a button:

1. how the button draws itself so it looks like a button;
2. how the button animates when pressed.

Default: XmFLATDRAWPOLICY (Flat)

Valid resource values:

XmSHADOWEDTWOSTATEDRAWPOLICY (Shadowed Two State) - Buttons are drawn with a 3D shadowed outline and exhibit a simple 2-state (OFF and ON) state rendering.

XmSHADOWEDTHREESTATEDRAWPOLICY (Shadowed Three State) - Buttons are drawn with a 3D shadowed outline and exhibit a 3-state (OFF, ON, and PRESSED) state rendering.

XmOUTLINEDRAWPOLICY (Outlined) - Buttons are drawn with a simple etched (non-shadowed) outline and exhibit a 2-state (OFF and ON) state rendering.

XmFLATDRAWPOLICY (Flat) - Buttons are drawn flat without a 3D shadow.

 

labelString: aString
Specifies the renderable object (string) which draws on the face of the widget.

 

mnemonic: aCharacter
Provides the user with alternate means for selecting a button.

 

orientation: anInteger
Specifies whether the image and label are displayed vertically or horizontally.

Default: XmHORIZONTAL (Horizontal)

Valid resource values:

XmVERTICAL (Vertical) - Displays the image and label vertically.

XmHORIZONTAL (Horizontal) - Displays the image and label horizontally.

 

pressedLabelString: aString
Specifies the renderable object (string) which draws on the face of the widget when it is pressed.

 

selection: aBoolean
Displays the button in its selected state if set to true.

 

set
Set the receiver's state to on (true).

 

verticalAlignment: anInteger
Specifies the vertical alignment for the widget's image.

Default: XmALIGNMENTCENTER (Center)

Valid resource values:

XmALIGNMENTCENTER (Center) - Causes the center of the image to be vertically aligned in the center of the widget's window.

XmALIGNMENTTOP (Top) - Causes the top edge of the image to be vertically aligned with the top edge of the widget's window.

XmALIGNMENTBOTTOM (Bottom) - Causes the center of the image to be vertically aligned in the center of the widget's window.

Events

Default Action Requested
These events are triggered when the widget is double clicked.

 

Selection Changed
These events are triggered when the checkbox value is changed.