rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvMenuItemSelector Class Reference

Named property class. More...

#include <ilviews/gadgets/amenu.h>

Inheritance diagram for IlvMenuItemSelector:
IlvMenuItemGroup IlvNamedProperty

List of all members.

Public Member Functions

 IlvMenuItemSelector (IlSymbol *symbol)
 Constructor.
virtual void doIt (IlvMenuItem *item)
 Is called each time an item of the group is selected.
IlvGraphicCallback getCallback () const
 Returns a pointer to the group callback.
IlAny getCallbackData () const
 Returns a pointer to the group callback data.
IlSymbolgetCallbackName () const
 Returns the symbol that represents the name of the group callback.
void selectItem (IlvMenuItem *item)
 Select the specified item, and deselect the other items of the group.
void setCallback (IlvGraphicCallback callback)
 Sets the group callback.
void setCallbackData (IlAny callbackData)
 Sets the group callback data.
void setCallbackName (IlSymbol *callbackName)
 Sets the name of the group callback.
const IlSymbolwhichSelected () const
 Returns the last selected item of the group.

Detailed Description

Named property class.

Library: ilvgadgt

The class IlvMenuItemSelector is a named property that can be set on an IlvAbstractMenu object to implement exclusive selection between the menu items of the group.

See also:
IlvAbstractMenu, IlvMenuItem

Constructor & Destructor Documentation

IlvMenuItemSelector::IlvMenuItemSelector ( IlSymbol symbol  ) 

Constructor.

Initializes a new instance of the IlvMenuItemSelector class.

Parameters:
symbol The selector name.

Member Function Documentation

virtual void IlvMenuItemSelector::doIt ( IlvMenuItem item  )  [virtual]

Is called each time an item of the group is selected.

The default implementation calls the IlvMenuItemSelector::selectItem method.

Parameters:
item The item that has been selected.
See also:
selectItem
IlvGraphicCallback IlvMenuItemSelector::getCallback (  )  const

Returns a pointer to the group callback.

Returns:
A pointer to the callback associated with the group or 0 if there is none.
IlAny IlvMenuItemSelector::getCallbackData (  )  const

Returns a pointer to the group callback data.

Returns:
A pointer to the callback data associated with the group or 0 if there is none.
IlSymbol* IlvMenuItemSelector::getCallbackName (  )  const

Returns the symbol that represents the name of the group callback.

Returns:
The symbol that represents the name of the group callback or 0 if there is none.
See also:
setCallbackName, getCallback
void IlvMenuItemSelector::selectItem ( IlvMenuItem item  ) 

Select the specified item, and deselect the other items of the group.

Parameters:
item The item that has been selected.
See also:
doIt
void IlvMenuItemSelector::setCallback ( IlvGraphicCallback  callback  ) 

Sets the group callback.

Sets the callback associated with the group to callback.

Parameters:
callback A pointer to the new group callback.
See also:
getCallback, setCallbackName
void IlvMenuItemSelector::setCallbackData ( IlAny  callbackData  ) 

Sets the group callback data.

Sets the callback data associated with the group.

Parameters:
callback A pointer to the new group callback.
See also:
getCallback, setCallbackName
void IlvMenuItemSelector::setCallbackName ( IlSymbol callbackName  ) 

Sets the name of the group callback.

Sets the name of the group callback to callbackName. The item callback is triggered when an item of the group is activated.

Parameters:
callbackName The name of the callback.
See also:
getCallbackName, setCallback
const IlSymbol* IlvMenuItemSelector::whichSelected (  )  const

Returns the last selected item of the group.

Parameters:
item The last item of the group that has been selected.
See also:
selectItem
 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.