SIMPOL Documentation

wxtool

Description

A wxtool object represents an entry on a tool bar and when selected will normally cause an event to occur in the program. Tools are buttons that have a bitmap and optionally a disabled bitmap.

Type Tags

None

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.
bitmapwxbitmap The bitmap that is shown representing the tool on the tool bar.
disabledbitmapwxbitmap The bitmap that is shown representing the tool on the tool bar if the tool is disabled.
enabledboolean Specifies whether or not the tool is enabled.
namestring The name of the tool, to allow it to be referenced using the member operator (!).
nextwxtool This property holds a reference to the next tool. All tools for a given tool bar are in a ring.
onclickevent An event that is triggered every time the user clicks on the tool.
toolbarwxtoolbar This property holds a reference to the tool bar that contains the tool.
tooltipstring Contains the test that is displayed as a tooltip for the tool.
typetype Specifies the wxtool type object.

Methods

setenabled()

Description

Sets the enabled state of the tool. The wxtool object itself is returned, to allow multiple setting methods to be put into one expression.

Prototype

wxtoolvar.setenabled ( boolean enabled )

Parameters
ParameterDefault valueType nameDescription
enabledNoneboolean The desired enabled state for the tool.

settooltip()

Description

Sets the text for the tooltip associated with the tool. The wxtool object itself is returned, to allow multiple setting methods to be put into one expression.

Prototype

wxtoolvar.settooltip ( string tooltip )

Parameters
ParameterDefault valueType nameDescription
tooltipNonestring The new text to set for the tooltip.