Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvButtonInteractor Class Reference

Button interactor class. More...

#include <ilviews/graphics/inter.h>

Inheritance diagram for IlvButtonInteractor:
IlvInteractor IlvRepeatButtonInteractor IlvToggleInteractor

Public Member Functions

 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...
 
virtual IlBoolean handleEvent (IlvGraphic *obj, IlvEvent &event, const IlvTransformer *t)
 Handles events received by the interactor. 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 IlvInteractorGet (const char *name, IlBoolean=IlTrue)
 Returns a predefined shared interactor instance. More...
 

Detailed Description

Button interactor class.

Library: views

Use the IlvButtonInteractor class to make an object act like a standard interface button. The member function handleEvent() is designed to call the member function IlvGraphic::invert() of the object. This gives the object the appearance that is is pressed or activated when you click on it.

The registered name of this interactor is "Button".

See also
IlvButton, IlvRepeatButtonInteractor.

Constructor & Destructor Documentation

◆ IlvButtonInteractor()

IlvButtonInteractor::IlvButtonInteractor ( IlUShort  button = IlvLeftButton,
IlvApplyObject  action = 0,
IlAny  arg = 0 
)

Constructor.

Initializes a new instance of the IlvButtonInteractor class. The action function will be called when the user clicks on the object. If action is not specified, the object's callback is called.

Parameters
buttonThe mouse button that is used for the interaction.
actionThe user function called on a click.
argThe user argument.

Member Function Documentation

◆ doIt()

virtual void IlvButtonInteractor::doIt ( IlvGraphic obj)
virtual

Calls the user function.

Called when the user presses and releases the mouse button over the object obj. The default implementation calls the associated action, if one exists. If there is no associated action, then the object's callback is called. Then the object's callback corresponding to the Button symbol is called. You can overload this method to implement a different button-like behavior.

Parameters
objThe graphic object.
See also
setAction(), IlvGraphic::setCallback()

◆ getAction()

IlvApplyObject IlvButtonInteractor::getAction ( ) const

Returns the user function.

Returns
The action associated with the interactor.

◆ handleEvent()

virtual IlBoolean IlvButtonInteractor::handleEvent ( IlvGraphic g,
IlvEvent event,
const IlvTransformer t 
)
virtual

Handles events received by the interactor.

This method is the entry point of all events dispatched to this interactor.

Parameters
gThe graphic object that receives the event.
eventThe received event.
tThe transformer applied to the view in which the event occurred.
Returns
IlTrue if the event was successfully handled and IlFalse otherwise.

Implements IlvInteractor.

Reimplemented in IlvToggleInteractor.

◆ setAction()

void IlvButtonInteractor::setAction ( IlvApplyObject  action,
IlAny  arg = 0 
)

Sets the user function and the user argument.

Sets the action to action and its argument to userArg.

Parameters
actionThe user function.
argThe user argument.