VOS Object Type Definition

widget

OTD #024; Revision 2.

Group: gui.

Base type for GUI components. Must be within a container object. local object when pressed.

Authors

Reed Hedges, (http://zerohour.net/~reed) (reed@zerohour.net)

Child Objects

 

gui:alignment [property:property] (optional.)

Alignment of this widget within its parent object. Must be one of the following values: "center", "fill" (fill all available space), "expand" (like fill, but expand proportionally according to the widget's original shape), "top" (for horizontal containers only), "bottom" (for horizontal containers only), "left" (for vertical containers only), or "right" (for vertical containers only). Default value is "center".

 

gui:padding [property:property] (optional.)

Empty space maintained around widget (on all sides). Default value is 0.

 

gui:proportion [property:property] (optional.)

Amount of space this widget should use, in relation to other widgets in the same container, along the layout direction of their container. For example, if all widgets in a container have a proportion of 1, they will all use the same amount of space. if one widget has a proportion of 2, and the others 1, the widget with a proportion of 2 will use twice as much space as each of the other widgets. The default is 1. TODO: allow percentages?

 

gui:enabled [property:property] (optional.)

If this property is "no", then this control should be disabled, or "greyed out."

Messages

this type defines no new messages.

History of this document

Revision 0 (Sept, 2002):
created.
Revision 1 (Thu Dec 26 17:34:40 EST 2002):
Added group prefix to subobjects. Changed type "property" to "property:property". Merry Christmas!
Revision 2 (Wed Jan 22 17:42:02 EST 2003):
Added proportion property.