SIMPOL Documentation

wxgraphicellipse

Description

A wxgraphicellipse object represents an ellipse that can be drawn on an appropriate container. The ellipse has an optional border, border width and border color together with a fill color. If an attempt is made to create an ellipse with impossible charactersitics, an error will be generated.

Type Tags

wxgraphic

Object Value

Properties

PropertyTypeDescription
_type(*) This property is provided for use by the user to attach any object of any type to the type in which this property is provided.
__type(*) This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property.
borderrgbrgb Gives the color of the ellipse's border.
bordervisibleboolean Specifies whether or not the border is visible.
borderwidthinteger Gives the width of the border, in pixels.
containertype(wxgraphiccontainer) Specifies the object to which this graphic belongs.
midpointfixedpoint Gives the position of the midpoint of the ellipse.
namestring The name of the wxgraphicellipse object.
nexttype(wxgraphic) Specifies the next wxgraphic on the same container.
point1fixedpoint Gives the position of the first point of the ellipse.
point2fixedpoint Gives the position of the second and opposite point of the ellipse.
rgbrgb Gives the fill color of the ellipse.
typetype Specifies the wxgraphicellipse type object.
visibleboolean Specifies whether or not the content is visible.

Methods

remove()

Description

Removes the graphic from the container. If any object has a reference to the graphic, those references will no longer be valid. It is not safe to attempt to use a graphic after this method has been called.

Prototype

wxgraphicellipsevar.remove ()

Parameters

None

setname()

Description

Sets the name of the ellipse control. The wxgraphicellipse object itself is returned, to allow multiple setting methods to be put into one expression.

Prototype

wxgraphicellipsevar.setname ( string name )

Parameters
ParameterDefault valueType nameDescription
nameNonestring The new name for the graphic.

setnext()

Description

Sets the position of the graphic in the z-order and tab order.

Prototype

wxgraphicellipsevar.setnext ( type(wxgraphic) next )

Parameters
ParameterDefault valueType nameDescription
nextNonetype(wxgraphic) Calling the method with the value .nul sets a graphic to be the last one in the ring (the one before container.firstgraphic) and so has the highest z-order, and passing any other graphic as the argument puts the target graphic immediately below the one specified as the parameter. The visible stacking of graphics on a container is such that the earliest in the ring is the furthest back in the z-order.

setposition()

Description

Sets the size and/or position of the graphic. The wxgraphicellipse object itself is returned, to allow multiple setting methods to be put into one expression. Not all parameters are available to all wxgraphic objects. It is recommended to name the parameters when using this method.

Prototype

wxgraphicellipsevar.setposition ( point point1, point point2, point point3, point midpoint, integer width, integer borderwidth )

Parameters
ParameterDefault valueType nameDescription
point1The current value of the point1 propertypoint The new position of the starting point of the graphic.
point2The current value of the point2 propertypoint The new position of the second point of the graphic.
point3The current value of the point3 propertypoint The new position of the third point of the graphic.
midpointThe current value of the midpoint propertypoint The new position of the midpoint of the graphic.
widthThe current value of the width propertyinteger The new width of the graphic.
borderwidthThe current value of the borderwidth propertyinteger The new width of the border of the graphic.

setrgb()

Description

Sets the color and border color of the graphic. The wxgraphicellipse object itself is returned, to allow multiple setting methods to be put into one expression.

Prototype

wxgraphicellipsevar.setrgb ( integer rgb, integer borderrgb )

Parameters
ParameterDefault valueType nameDescription
rgbThe current value of the rgb propertyinteger The new color of the graphic. It is inadvisable to specify any value for this argument that is not the value of an existing rgb object.
borderrgbThe current value of the borderrgb propertyinteger The new border color of the graphic. It is inadvisable to specify any value for this argument that is not the value of an existing rgb object.

setvisible()

Description

Sets the visibility of the graphic. The wxgraphicellipse object itself is returned, to allow multiple setting methods to be put into one expression.

Prototype

wxgraphicellipsevar.setvisible ( boolean visible, boolean bordervisible )

Parameters
ParameterDefault valueType nameDescription
visibleNoneboolean The desired visibility of the content of the graphic.
bordervisibleNoneboolean The desired visibility of the graphic's border.