Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvSelectorInteractor Class Reference

Interactor for IlvSelector instances. More...

#include <ilviews/graphics/selector.h>

Inheritance diagram for IlvSelectorInteractor:
IlvInteractor

Public Member Functions

virtual IlBoolean accept (const IlvGraphic *obj) const
 Indicates whether the current interactor can be associated with a given object. More...
 
virtual IlBoolean handleEvent (IlvGraphic *obj, IlvEvent &ev, const IlvTransformer *t=0)
 Handles events received by the interactor. More...
 
- Public Member Functions inherited from IlvInteractor
virtual void abort (IlvGraphic *obj)
 Aborts the interactor. 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...
 

Protected Member Functions

virtual void doIt (IlvSelector *selector)
 Called when objects are selected or deselected. 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

Interactor for IlvSelector instances.

Library: views

Handles the interactive selection and deselection of objects managed by an IlvSelector instance.

The registered name of this interactor is "Selector".

See also
IlvSelector.

Member Function Documentation

§ accept()

virtual IlBoolean IlvSelectorInteractor::accept ( const IlvGraphic obj) const
virtual

Indicates whether the current interactor can be associated with a given object.

Parameters
objThe considered graphic object.
Returns
IlTrue if the interactor can safely be attached to obj, and IlFalse otherwise.
See also
IlvGraphic::setInteractor().

Reimplemented from IlvInteractor.

§ doIt()

virtual void IlvSelectorInteractor::doIt ( IlvSelector selector)
protectedvirtual

Called when objects are selected or deselected.

Called when an item of the selector is selected or deselected. The user can check the selector object to find out what has been modified. The default implementation calls the callback of selector if it exists.

Parameters
selectorThe selector object.

§ handleEvent()

virtual IlBoolean IlvSelectorInteractor::handleEvent ( IlvGraphic g,
IlvEvent event,
const IlvTransformer t = 0 
)
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.


© Copyright 2018, 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.