You may return to the Cvo Object Documenation Index from this document. This document contains the following sections describing the Cvo_BasicToggleButton object:
Cvo_BasicToggleButton
Cvo_BasicButton
The Cvo_BasicToggleButton provides the basic features required for a toggle button. It should not be created directly. Rather, objects should be derived from it, such as Cvo_ToggleButton is.
This object will send an event when the toggle button changes state
from on to off or vice versa. When it enters the on
state, the CvoButtonDownEvent
will be sent. When it enters the
off state, the CvoButtonUpEvent
will be sent. See the
parent object for information on those
events.
This object defines the following member functions in addition to those defined by its parent and ancestor objects.
Toggle (
)
This function causes the toggle button to change states. If it was off before, it now becomes on. If it was on, it becomes off.
ForceOn (
)
This function forces the toggle button to enter the on state.
ForceOff (
)
This function forces the toggle button to enter the off state.
int Pressed (
)
This function returns zero if the toggle is not pressed (i.e. off) and a non-zero value if it is pressed (i.e. on).
See the example source code for an example of how to use this object.
See the legend for information about the conventions used in this documentation.