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

Named property class. More...

#include <ilviews/gadgets/amenu.h>

Inheritance diagram for IlvMenuItemHighlighter:
IlvMenuItemGroup IlvNamedProperty IlvValueInterface

Public Member Functions

 IlvMenuItemHighlighter (IlSymbol *symbol)
 Constructor. More...
 
virtual void doIt (IlvMenuItem *item)
 Is called each time an item of the group is highlighted. More...
 
void highlightItems (IlvMenuItem *item)
 Highlights all the items of the group. More...
 
- Public Member Functions inherited from IlvMenuItemGroup
 IlvMenuItemGroup (IlSymbol *symbol)
 Constructor. More...
 
void addItem (const IlSymbol *name)
 Adds an item to the group. More...
 
void addItem (IlvMenuItem *item)
 Adds an item to the group. More...
 
void addTo (IlvAbstractMenu *menu)
 Adds the menu items group to the specified abstract menu. More...
 
IlBoolean contains (const IlSymbol *name) const
 Indicates whether the specified name is managed by this group. More...
 
IlvAbstractMenugetAbstractMenu () const
 Returns the IlvAbstractMenu object to which the group is connected. More...
 
IlvMenuItemgetItem (const IlSymbol *name) const
 Returns the item of the group corresponding to the specified name. More...
 
const IlSymbol *const * getItemNames (IlUShort &count) const
 Returns an array of all the items names of this group. More...
 
IlvMenuItem *const * getItems (IlUShort &count) const
 Returns an array of all the items names of this group. More...
 
void removeFrom (IlvAbstractMenu *menu)
 Removes the menu items group from the specified abstract menu. More...
 
void removeItem (const IlSymbol *name)
 Removes an item from the group. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvMenuItemGroup
static IlvMenuItemGroupGet (const IlvAbstractMenu *menu, const IlSymbol *name)
 Returns the IlvMenuItemGroup object with the specified name and connected to the specified menu. More...
 
static IlvMenuItemGroupRemoveFrom (IlvAbstractMenu *menu, const IlSymbol *name)
 Removes the menu items group specified from the specified abstract menu. More...
 

Detailed Description

Named property class.

Library: ilvgadgt

The class IlvMenuItemHighlighter is a named property that can be set on an IlvAbstractMenu object to implement menu item group highlighting: That is, when an item of the group is highlighted, the whole group is highlighted.

See also
IlvAbstractMenu, IlvMenuItem.

Constructor & Destructor Documentation

◆ IlvMenuItemHighlighter()

IlvMenuItemHighlighter::IlvMenuItemHighlighter ( IlSymbol symbol)

Constructor.

Initializes a new instance of the IlvMenuItemHighlighter class.

Parameters
symbolThe selector name.

Member Function Documentation

◆ doIt()

virtual void IlvMenuItemHighlighter::doIt ( IlvMenuItem item)
virtual

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

The default implementation calls the IlvMenuItemSelector::highlightItem() method.

Parameters
itemThe item that has been highlighted.
See also
highlightItems().

◆ highlightItems()

void IlvMenuItemHighlighter::highlightItems ( IlvMenuItem item)

Highlights all the items of the group.

Parameters
itemThe item that has been highlighted.
See also
doIt().