Name: | Box |
Version: | 1.0 |
ID: | ID_BOX |
Status: | Stable |
Category: | GUI |
Date: | June 2003 |
Author: | Rocklyte Systems |
Copyright: | Rocklyte Systems (c) 2000-2003. 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:
Hide Hides a box from view. SetUnlistedField Used to set special box fields. Show Shows a box.
The Box object consists of the following public fields:
Border String-based field for setting the border colour of a Box object. BorderOpacity Determines the level of translucency applied to box borders. Boxes Special field to create multiple boxes using one object. Brightness Alters the brightness level of the box colours. ColourRGB Defines the internal colour of a box in RGB format. Colour String-based field for setting the colour inside 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 Limits the drawing of a box to a single frame. Frames Determines a sequence of frames that a box graphic may be drawn to. Height The height of a box graphic. HighlightRGB Defines the highlight colour of the box in RGB format. Highlight String-based field for setting the highlight colour of a box object. Opacity Determines the level of translucency applied to a box. Raised If set to TRUE the box will appear to be raised into the foreground. Round Pixel specification for rounding at each corner of the box. Shadow String-based field for setting the shadow colour of a Box object. ShadowRGB Defines the shadow colour of a box in RGB format. Sunken Set to TRUE to make a box appear to sink into the background. Thickness Defines the thickness of a box's border. TotalBoxes Defines the total amount of boxes to be drawn by a box object. Width The width of a box's graphic. XCoord The horizontal position of a box. XOffset The horizontal offset of a box. YCoord The vertical coordinate of a box. YOffset The vertical offset of a box.
Field: | BorderOpacity | |
Short: | Determines the level of translucency applied to box borders. | |
Type: | FLOAT | |
Status: | Get/Set | |
|
Field: | Boxes | |
Short: | Special field to create multiple boxes using one object. | |
Type: | STRING (Unlisted) | |
Status: | Write | |
|
Field: | Brightness | |
Short: | Alters the brightness level of the box colours. | |
Type: | FLOAT | |
Status: | Read/Write | |
|
Field: | ColourRGB | |
Short: | Defines the internal colour of a box in RGB format. | |
Type: | RGB | |
Status: | Read | |
|
Field: | Colour | |
Short: | String-based field for setting the colour inside of the box. | |
Type: | STRING | |
Status: | Set | |
|
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: | Limits the drawing of a box to a single frame. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | Frames | |
Short: | Determines a sequence of frames that a box graphic may be drawn to. | |
Type: | STRING | |
Status: | Set | |
|
Field: | Height | |
Short: | The height of a box graphic. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Get/Set | |
|
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: | Opacity | |
Short: | Determines the level of translucency applied to a box. | |
Type: | FLOAT | |
Status: | Get/Set | |
|
Field: | Raised | |
Short: | If set to TRUE the box will appear to be raised into the foreground. | |
Type: | BOOLEAN | |
Status: | Write | |
|
Field: | Round | |
Short: | Pixel specification for rounding at each corner of the box. | |
Type: | LONG | |
Status: | Set | |
|
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 a box in RGB format. | |
Type: | RGB | |
Status: | Read | |
|
Field: | Sunken | |
Short: | Set to TRUE to make a box appear to sink into the background. | |
Type: | BOOLEAN | |
Status: | Write | |
|
Field: | Thickness | |
Short: | Defines the thickness of a box's border. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | TotalBoxes | |
Short: | Defines the total amount of boxes to be drawn by a box object. | |
Type: | LONG | |
Status: | Read/Set | |
|
Field: | Width | |
Short: | The width of a box's graphic. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Get/Set | |
|
Field: | XCoord | |
Short: | The horizontal position of a box. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Get/Set | |
|
Field: | XOffset | |
Short: | The horizontal offset of a box. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Get/Set | |
|
Field: | YCoord | |
Short: | The vertical coordinate of a box. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Get/Set | |
|
Field: | YOffset | |
Short: | The vertical offset of a box. | |
Type: | DOUBLE/PERCENTAGE | |
Status: | Get/Set | |
|