HCategoryProperty Class Reference

Property used to group several other related properties into a group. More...

#include <HPropert.h>

Inheritance diagram for HCategoryProperty:

[legend]Collaboration diagram for HCategoryProperty:

[legend]List of all members.

Public Member Functions
int	AddProperty (HProperty *property)
BOOL	RemoveProperty (HProperty *property)
Static Public Member Functions
static HCategoryProperty *	New ()
static HCategoryProperty *	New (HPropertyInfo *propinfo)

---

Detailed Description

Property used to group several other related properties into a group.

Note:

For HXT plugins, use the HDynamicCategoryProperty.

See also:

HDynamicCategoryProperty

Definition at line 164 of file HPropert.h.

---

Member Function Documentation

int HCategoryProperty::AddProperty (  HProperty *  property  )

Appends a new property at the end of the properties group. Parameters: property  - The new appended property. Returns: The index of the new property in the properties group. The property may later be retrieved with HTreeObject::GetPropertyAt function. Example: m_options = HCategoryProperty::New( theApp.m_optionsinfo ); m_ampl = HFloatProperty::New( theApp.m_amplinfo ); m_options->AddProperty(m_ampl); m_octaves = HIntProperty::New( theApp.m_octavesinfo ); m_options->AddProperty(m_octaves); Note: You must remove the property before deleting it See also: BOOL HCategoryProperty::RemoveProperty(HProperty *property)

static HCategoryProperty* HCategoryProperty::New (  HPropertyInfo *  propinfo  )  [static]

Reimplemented from HContainerProperty.

static HCategoryProperty* HCategoryProperty::New (   )  [static]

Reimplemented from HContainerProperty. Reimplemented in HUserCategoryProperty, HBoolCategoryProperty, and HTypeCategoryProperty.

BOOL HCategoryProperty::RemoveProperty (  HProperty *  property  )

Removes the property from a properties group. It is the responsibility of the programmer to remove the property from the group before deleting it. Parameters: property  - The property to delete. Returns: TRUE if the property could be removed. Example: m_options->RemoveProperty(m_ampl); delete m_ampl;

---

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

• C:/Program Files/Hash Inc/AM120SDK/Include/SDK/HPropert.h
• C:/Dox/SDK/Comments/Property.dox

---