rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Manager Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvManagerViewInteractorSelector Class Reference

Manager View Hook class. More...

#include <ilviews/gadmgr/mviselect.h>

Inheritance diagram for IlvManagerViewInteractorSelector:
IlvManagerViewHook

List of all members.

Public Member Functions

 IlvManagerViewInteractorSelector (IlvManager *manager, IlvView *view, IlvMenuItemSelector *selector)
 Constructor.
IlvManagerViewInteractorgetInteractor (const IlSymbol *name) const
 Returns the view interactor associated with the specified item name.
IlvMenuItemSelector * getMenuItemSelector () const
 Returns the menu item selector connected to this hook.
const IlSymbolgetName (IlvManagerViewInteractor *interactor) const
 Returns the item name associated with the specified view interactor.
virtual void interactorChanged (IlvManagerViewInteractor *current, IlvManagerViewInteractor *previous)
 Called when the interactor of the manager view changes.
void link (const IlSymbol *name, IlvManagerViewInteractor *interactor)
 Associates the specified item name with the specified view interactor.
void setMenuItemSelector (IlvMenuItemSelector *selector)
 Sets the menu item selector connected to this hook.
void unLink (const IlSymbol *name)
 Removes the association between the specified item name and its view interactor.

Detailed Description

Manager View Hook class.

Library: ilvgadmgr

This subclass of IlvManagerViewHook provides a predefined hook to help the user control a set of view interactors with a manager. It is linked with an IlvMenuItemSelector selector, which handles exclusive selection in an IlvAbstractMenu object. Each item of the menu item selector can be associated with a view interactor. When the selection is changed in the menu item selector, the view interactor associated with the selected item of the menu item selector is set on the manager view. When the view interactor is changed, the menu item selector is updated.

See also:
IlvManager::installViewHook, IlvAbstractMenu, IlvMenuItemSelector, IlvMenuItem.

Constructor & Destructor Documentation

IlvManagerViewInteractorSelector::IlvManagerViewInteractorSelector ( IlvManager manager,
IlvView view,
IlvMenuItemSelector *  selector 
)

Constructor.

Initializes a new instance of the IlvManagerViewInteractorSelector class.

Parameters:
manager The manager connected to this hook.
view The manager view connected to this hook.
selector The menu item selector connected to this hook.

Member Function Documentation

IlvManagerViewInteractor* IlvManagerViewInteractorSelector::getInteractor ( const IlSymbol name  )  const

Returns the view interactor associated with the specified item name.

Parameters:
name The item name.
Returns:
The view interactor associated with the specified item name.
See also:
link.
IlvMenuItemSelector* IlvManagerViewInteractorSelector::getMenuItemSelector (  )  const

Returns the menu item selector connected to this hook.

Returns:
The menu item selector connected to this hook.
const IlSymbol* IlvManagerViewInteractorSelector::getName ( IlvManagerViewInteractor interactor  )  const

Returns the item name associated with the specified view interactor.

Parameters:
interactor The view interactor.
Returns:
The item name associated with the specified view interactor.
See also:
link.
virtual void IlvManagerViewInteractorSelector::interactorChanged ( IlvManagerViewInteractor current,
IlvManagerViewInteractor previous 
) [virtual]

Called when the interactor of the manager view changes.

Called when you change the view interactor for the view to which the hook is connected.

Parameters:
current The new interactor set on the view.
previous The interactor previously set on the view.

Reimplemented from IlvManagerViewHook.

void IlvManagerViewInteractorSelector::link ( const IlSymbol name,
IlvManagerViewInteractor interactor 
)

Associates the specified item name with the specified view interactor.

Parameters:
name The item name.
interactor The view interactor.
See also:
unLink.
void IlvManagerViewInteractorSelector::setMenuItemSelector ( IlvMenuItemSelector *  selector  ) 

Sets the menu item selector connected to this hook.

Parameters:
selector The new menu item selector.
void IlvManagerViewInteractorSelector::unLink ( const IlSymbol name  ) 

Removes the association between the specified item name and its view interactor.

Parameters:
name The item name.
See also:
link.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

© 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.