rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Manager Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Friends
IlvManagerSelectionHook Class Reference

Manager hook class. More...

#include <ilviews/manager/selhook.h>

Public Member Functions

 IlvManagerSelectionHook ()
 Constructor. More...
 
virtual ~IlvManagerSelectionHook ()
 Destructor. More...
 
IlvManagergetManager () const
 Returns the manager. More...
 
virtual void selectionChanged (IlvGraphic *object, IlBoolean selected)
 Called when a selection status changes. More...
 
virtual void selectionChangedEnd ()
 Called when the selection ends. More...
 
virtual void selectionChangedStart ()
 Called when the selection starts. More...
 
void setManager (IlvManager *manager)
 Sets the manager. More...
 

Friends

class IlvManager
 

Detailed Description

Manager hook class.

Library: ilvmgr

This class is used to monitor selection operations within a manager. Instances of this class, called selection hooks, are used to notify the user of any selection change that occurs within an interactive application. Selection hooks are installed on and removed from managers using IlvManager::installSelectionHook and IlvManager::removeSelectionHook. Deleting a manager will also delete all selection hooks that remain installed on it.

See Also
IlvManager.

Constructor & Destructor Documentation

IlvManagerSelectionHook::IlvManagerSelectionHook ( )

Constructor.

Initializes a new selection hook, ready to be installed on any manager.

virtual IlvManagerSelectionHook::~IlvManagerSelectionHook ( )
virtual

Destructor.

Releases the memory used by the instance.

Member Function Documentation

IlvManager* IlvManagerSelectionHook::getManager ( ) const

Returns the manager.

Returns
The manager to which the hook is connected.
virtual void IlvManagerSelectionHook::selectionChanged ( IlvGraphic object,
IlBoolean  selected 
)
virtual

Called when a selection status changes.

Called by the manager when the selection status of an object changes.

Parameters
objectThe graphic object.
selectedIlTrue if the object is selected and IlFalse if it is not selected.
virtual void IlvManagerSelectionHook::selectionChangedEnd ( )
virtual

Called when the selection ends.

Called by the manager when selection modification ends.

virtual void IlvManagerSelectionHook::selectionChangedStart ( )
virtual

Called when the selection starts.

Called by the manager when selection modification starts.

void IlvManagerSelectionHook::setManager ( IlvManager manager)

Sets the manager.

Sets the manager to which the hook is connected.

Parameters
managerSpecifies the manager to connect to.

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