Skip to content
- [Main Page](index.md) - [Classes](annotated.md) - [Files](files.md) - [Directories](dirs.md) - [Related Pages](pages.md)
- [Class List](annotated.md) - [Alphabetical List](classes.md) - [Class Hierarchy](hierarchy.md) - [Class Members](functions.md)

HCategoryProperty Class Reference

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

#include <HPropert.h>

Inheritance diagram for HCategoryProperty:

Inheritance graph

[legend]

Collaboration diagram for HCategoryProperty:

Collaboration graph

[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:

This A:M SDK v12.0 documentation is maintained by Hash Inc. Please address any comments concerning this documentation to AMReports. If you have any information, knowledge, or documentation to share with the A:M developer community, please post them on the Hash SDK forum.

Generated on Thu Oct 27 11:46:54 2005 with doxygen 1.4.5 written by Dimitri van Heesch, © 1997-2001