Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HRegionSelItem Class Reference

The HRegionSelItem - region selection item which can handle instancing. More...

#include <HSelectionItem.h>

List of all members.

Public Member Functions

virtual bool Equals (const HSelectionItem *i2) const
virtual const char * GetName () const
virtual int const GetRegion () const
virtual bool Highlight ()
 HRegionSelItem (HShellObject const &oShellObj, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[], int region)
virtual bool UnHighlight ()

Detailed Description

The HRegionSelItem - region selection item which can handle instancing.

This implementation of HSmartSelItem class handles instanced regions. It also uses the 'conditional styling' mechanism to highlight the selection


Constructor & Destructor Documentation

HRegionSelItem::HRegionSelItem ( HShellObject const &  oShellObj,
HSelectionSet selection_set,
int  incl_count,
HC_KEY  incl_keys[],
int  region 
)

Constructs a HRegionSelItem object.

Parameters:
keyHOOPS key to selection item.
selection_setA pointer to the HOOPS selection set which owns this selection item.
incl_countNumber of include keys in the selection item segment path.
incl_keysAn array of HOOPS keys of all the include keys in the selection item path.

Member Function Documentation

virtual bool HRegionSelItem::Equals ( const HSelectionItem i2) const [virtual]
Returns:
True if the two region selection elements are equal.
Parameters:
i2An HRegionSelItem object to be compared with this object.

Reimplemented from HSmartSelItem.

virtual const char* HRegionSelItem::GetName ( ) const [inline, virtual]
Returns:
A character pointer denoting the name which is "HRegionSelItem."

Reimplemented from HSmartSelItem.

virtual int const HRegionSelItem::GetRegion ( ) const [inline, virtual]
Returns:
The shell region which is selected.
virtual bool HRegionSelItem::Highlight ( ) [virtual]

Call this function to highlight the selection region.

Returns:
A true if the item was successfully highlighted.

Reimplemented from HSmartSelItem.

virtual bool HRegionSelItem::UnHighlight ( ) [virtual]

Call this function to unhighlight the selection item.

Returns:
A true if the item was successfully unhighlighted.

Reimplemented from HSmartSelItem.


The documentation for this class was generated from the following file: