Name: | Box |
Version: | 1.0 |
ID: | ID_BOX |
Status: | Stable |
Category: | GUI |
Date: | April 2001 |
Author: | Rocklyte Systems |
Copyright: | Rocklyte Systems (c) 2000-2001. All rights reserved. |
Short: | Draws rectangular graphics. |
The Box is a simple drawable object used for drawing bevelled boxes and filled areas inside rendered objects. By default a Box will take up the entire width and height of its container, but powerful features are also provided that allow you to create complicated shapes out of multiple rectangles.
Here are some examples for creating Box graphics. The first creates a raised, bevelled box with grey colouring.
<box colour="#808080" shadow="#303030" highlight="#ffffff" raised/>
This example creates a 10x10 box with a black border that is 2 pixels thick:
<box thickness="2" width="10" height="10" border="#000000"/>
If you want to draw multiple boxes with one object, you can use the Boxes field. This next example draws a box that fills up the area of its container, and also draws a smaller box that is offset by 5 pixels from each margin:
<box boxes="(0,0,!0,!0) (5,5,!5,!5)" colour0="255,0,0" colour1="255,255,255"/>
For more detail on how to use the Box class, please refer to the documentation for the individual fields.
The Box class supports the following actions:
Draw Draws a Box graphic within its drawable area. Hide Hides Box graphics from the display. SetUnlistedField Used to set special Box fields. Show Shows Box graphics on the display.
The Box object consists of the following public fields:
Border String-based field for setting the border colour of a Box object. Boxes Special field to create multiple boxes using one object. ColourRGB Defines the internal colour of the box in RGB format. Colour String-based field for setting the internal colour of the box. Drawable Defines the drawable area for the Box graphics. Fill Set to TRUE or FALSE to alter the filling of a box. Frame Determines the rendering frame that the Box will be applied to. Height The height of the box. HighlightRGB Defines the highlight colour of the box in RGB format. Highlight String-based field for setting the highlight colour of a box object. Raised If set to TRUE the box will appear to be raised into the foreground. Shadow String-based field for setting the shadow colour of a Box object. ShadowRGB Defines the shadow colour of the box in RGB format. Sunken Set to TRUE to make the box appear to sink into the background. Thickness Defines the thickness of the box' border. Width The width of the box. XCoord The horizontal position of the box. XOffset The horizontal offset of the box. YCoord The vertical coordinate of the box. YOffset The vertical offset of the box.
Field: | Boxes | |
Short: | Special field to create multiple boxes using one object. | |
Type: | STRING | |
Status: | Write | |
|
Field: | ColourRGB | |
Short: | Defines the internal colour of the box in RGB format. | |
Type: | RGB | |
Status: | Read | |
|
Field: | Colour | |
Short: | String-based field for setting the internal colour of the box. | |
Type: | STRING | |
Status: | Write | |
|
Field: | Drawable | |
Short: | Defines the drawable area for the Box graphics. | |
Type: | OBJECTID | |
Status: | Read/Write | |
|
Field: | Fill | |
Short: | Set to TRUE or FALSE to alter the filling of a box. | |
Type: | BOOLEAN | |
Status: | Write | |
|
Field: | Frame | |
Short: | Determines the rendering frame that the Box will be applied to. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | Height | |
Short: | The height of the box. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Write | |
|
Field: | HighlightRGB | |
Short: | Defines the highlight colour of the box in RGB format. | |
Type: | RGB | |
Status: | Read | |
|
Field: | Highlight | |
Short: | String-based field for setting the highlight colour of a box object. | |
Type: | STRING | |
Status: | Write | |
|
Field: | Raised | |
Short: | If set to TRUE the box will appear to be raised into the foreground. | |
Type: | BOOLEAN | |
Status: | Write | |
|
Field: | Shadow | |
Short: | String-based field for setting the shadow colour of a Box object. | |
Type: | STRING | |
Status: | Write | |
|
Field: | ShadowRGB | |
Short: | Defines the shadow colour of the box in RGB format. | |
Type: | RGB | |
Status: | Read | |
|
Field: | Sunken | |
Short: | Set to TRUE to make the box appear to sink into the background. | |
Type: | BOOLEAN | |
Status: | Write | |
|
Field: | Thickness | |
Short: | Defines the thickness of the box' border. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | Width | |
Short: | The width of the box. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Write | |
|
Field: | XCoord | |
Short: | The horizontal position of the box. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Read/Write | |
|
Field: | XOffset | |
Short: | The horizontal offset of the box. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Write | |
|
Field: | YCoord | |
Short: | The vertical coordinate of the box. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Read/Write | |
|
Field: | YOffset | |
Short: | The vertical offset of the box. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Write | |
|