Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Interactor to add toggle behavior to graphic objects. More...
#include <ilviews/graphics/inter.h>
Public Member Functions | |
IlvToggleInteractor (IlUShort button=IlvLeftButton, IlvApplyObject action=0, IlAny userarg=0) | |
Constructor. More... | |
virtual IlBoolean | handleEvent (IlvGraphic *obj, IlvEvent &event, const IlvTransformer *t) |
Handles events received by the interactor. More... | |
Public Member Functions inherited from IlvButtonInteractor | |
IlvButtonInteractor (IlUShort button=IlvLeftButton, IlvApplyObject action=0, IlAny arg=0) | |
Constructor. More... | |
virtual void | doIt (IlvGraphic *obj) |
Calls the user function. More... | |
IlvApplyObject | getAction () const |
Returns the user function. More... | |
void | setAction (IlvApplyObject action, IlAny arg=0) |
Sets the user function and the user argument. More... | |
Public Member Functions inherited from IlvInteractor | |
virtual void | abort (IlvGraphic *obj) |
Aborts the interactor. More... | |
virtual IlBoolean | accept (const IlvGraphic *obj) const |
Indicates whether the current interactor can be associated with a given object. More... | |
virtual void | endOperation () |
Performs the actions needed when the interaction ends. More... | |
virtual void | getCallbackTypes (IlUInt &count, const char *const **names, const IlSymbol *const **types) const |
Gets the number of register callback types for the interactor. More... | |
const char * | getRegisteredName () const |
Returns the name of the predefined shared instance. More... | |
IlBoolean | isAborted () const |
Indicates whether the current interactor is in an aborted state. More... | |
IlBoolean | isInOperation () const |
Indicates whether the current interactor is in an interaction state. More... | |
void | lock () |
Locks the current instance. Increments the counter that is used to know how many objects reference the current instance. More... | |
virtual void | startOperation () |
Performs the actions needed when the interaction starts. More... | |
void | unLock () |
Unlocks the current instance. Decrements the reference counter. When the counter drops down to zero, the current instance is deleted. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from IlvInteractor | |
static IlvInteractor * | Get (const char *name, IlBoolean=IlTrue) |
Returns a predefined shared interactor instance. More... | |
Interactor to add toggle behavior to graphic objects.
Library: views
Use this class to give an object the behavior of a toggle button. The object with which this interactor is associated is inverted when the user presses and then releases the mouse button over it. This is done by calling the object member function IlvGraphic::invert()
.
The registered name of this interactor is "Toggle".
IlvToggle
. IlvToggleInteractor::IlvToggleInteractor | ( | IlUShort | button = IlvLeftButton , |
IlvApplyObject | action = 0 , |
||
IlAny | userarg = 0 |
||
) |
Constructor.
Initializes a new instance of the IlvToggleInteractor
class and sets the function to be called when the object is clicked.
button | The mouse button that is used for the interaction. |
action | The user function to be called on a click. |
userarg | The user argument. |
|
virtual |
Handles events received by the interactor.
This method is the entry point of all events dispatched to this interactor.
g | The graphic object that receives the event. |
event | The received event. |
t | The transformer applied to the view in which the event occurred. |
IlTrue
if the event was successfully handled and IlFalse
otherwise. Reimplemented from IlvButtonInteractor.
© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.