Name: | Ellipse |
Version: | 1.0 |
ID: | ID_ELLIPSE |
Status: | Unspecified |
Category: | GUI |
Date: | March 2003 |
Author: | Rocklyte Systems |
Copyright: | Rocklyte Systems (c) 2000-2003. All rights reserved. |
Short: | Draws elliptical and circular shapes. |
The Ellipse class is used to draw elliptical shapes and circles to graphics areas. All you need to specify are the dimensions of the ellipse and its colour. Here is a DML based example:
<ellipse x="10%" y="10%" width="80" height="60" colour="#6090a0"/>
If you want to draw an unfilled ellipse, set the Border field as opposed to the Colour. Beyond this, there is little else that you need to know about the Ellipse class - but check the documented fields if you need more detial.
The Ellipse object consists of the following public fields:
Border Set this field to define the colour of the elliptical border. Colour Set this field to define the colour of the ellipse. ColourRGB Read this field to get the ellipse colour in RGB format. Drawable This field can be set to define the drawable area for the ellipse. Fill Set to TRUE to fill the ellipse. Frame Limits the drawing of an ellipse graphic to a single frame. Frames Determines a sequence of frames that an ellipse may be drawn to. Height The height of the ellipse is specified here. Highlight String-based field for setting the highlight colour of a ellipse object. HighlightRGB Defines the highlight colour of the ellipse in RGB format. Hollow If set to TRUE the ellipse will be given a hollow appearance. Raised If set to TRUE the ellipse will appear to be raised into the foreground. Shadow String-based field for setting the shadow colour of an ellipse object. ShadowRGB Defines the shadow colour of an ellipse in RGB format. Sunken Set to TRUE to make an ellipse appear to sink into the background. Thickness The thickness of the ellipse border is managed by this field. Width The width of the ellipse is specified here. XCoord Defines the horizontal position of the ellipse. XOffset Defines the horizontal offset of the ellipse. YCoord Defines the vertical position of the ellipse. YOffset Defines the vertical offset of the ellipse.
Field: | Colour | |
Short: | Set this field to define the colour of the ellipse. | |
Type: | STRING | |
Status: | Write | |
|
Field: | ColourRGB | |
Short: | Read this field to get the ellipse colour in RGB format. | |
Type: | RGB | |
Status: | Read | |
|
Field: | Drawable | |
Short: | This field can be set to define the drawable area for the ellipse. | |
Type: | OBJECTID | |
Status: | Read/Write | |
|
Field: | Fill | |
Short: | Set to TRUE to fill the ellipse. | |
Type: | BOOLEAN | |
Status: | Read/Write | |
|
Field: | Frame | |
Short: | Limits the drawing of an ellipse graphic to a single frame. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | Frames | |
Short: | Determines a sequence of frames that an ellipse may be drawn to. | |
Type: | STRING | |
Status: | Set | |
|
Field: | Height | |
Short: | The height of the ellipse is specified here. | |
Type: | FLOAT/PERCENTAGE | |
Status: | Read/Write | |
|
Field: | Highlight | |
Short: | String-based field for setting the highlight colour of a ellipse object. | |
Type: | STRING | |
Status: | Write | |
|
Field: | HighlightRGB | |
Short: | Defines the highlight colour of the ellipse in RGB format. | |
Type: | RGB | |
Status: | Read | |
|
Field: | Hollow | |
Short: | If set to TRUE the ellipse will be given a hollow appearance. | |
Type: | BOOLEAN | |
Status: | Write | |
|
Field: | Raised | |
Short: | If set to TRUE the ellipse will appear to be raised into the foreground. | |
Type: | BOOLEAN | |
Status: | Write | |
|
Field: | Shadow | |
Short: | String-based field for setting the shadow colour of an ellipse object. | |
Type: | STRING | |
Status: | Write | |
|
Field: | ShadowRGB | |
Short: | Defines the shadow colour of an ellipse in RGB format. | |
Type: | RGB | |
Status: | Read | |
|
Field: | Sunken | |
Short: | Set to TRUE to make an ellipse appear to sink into the background. | |
Type: | BOOLEAN | |
Status: | Write | |
|
Field: | Thickness | |
Short: | The thickness of the ellipse border is managed by this field. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | Width | |
Short: | The width of the ellipse is specified here. | |
Type: | FLOAT/PERCENTAGE | |
Status: | Read/Write | |
|
Field: | XCoord | |
Short: | Defines the horizontal position of the ellipse. | |
Type: | FLOAT/PERCENTAGE | |
Status: | Read/Write | |
|
Field: | XOffset | |
Short: | Defines the horizontal offset of the ellipse. | |
Type: | FLOAT/PERCENTAGE | |
Status: | Read/Write | |
|
Field: | YCoord | |
Short: | Defines the vertical position of the ellipse. | |
Type: | FLOAT/PERCENTAGE | |
Status: | Read/Write | |
|
Field: | YOffset | |
Short: | Defines the vertical offset of the ellipse. | |
Type: | FLOAT/PERCENTAGE | |
Status: | Read/Write | |
|