DzPropertyGroup Class Reference
[Property Objects]

Represents a grouping of properties. More...

Inheritance diagram for DzPropertyGroup:

DzBase QObject Object List of all members.

Methods

DzPropertyGroup findChild (String name)
DzPropertyGroup findSibling (String name)
Array getAllPaths ()
Boolean getCollapsed ()
DzPropertyGroup getFirstChild ()
DzPropertyGroup getNextSibling ()
Number getNumProperties ()
DzPropertyGroup getParent ()
String getPath ()
DzProperty getProperty (Number i)
DzPropertyGroupTree getTree ()
Boolean moveChildToIndex (String childName, Number newIndex)
Boolean movePropertyToIndex (DzProperty prop, Number newIndex)
Boolean movePropertyToIndex (String propName, Number newIndex)
void setCollapsed (Boolean onOff)

Signals

void addedChild (DzPropertyGroup newChild)
 Signature: "addedChild(DzPropertyGroup*)"
void childListChanged ()
 Signature: "childListChanged()"
void parentChanged (DzPropertyGroup newParent)
 Signature: "parentChanged(DzPropertyGroup*)"
void removedChild (DzPropertyGroup child)
 Signature: "removedChild(DzPropertyGroup*)"
void treeChanged ()
 Signature: "treeChanged()"

Detailed Description

Represents a grouping of properties.

DzPropertyGroup objects are all owned and managed by DzElement objects. Do not create property groups yourself - they are automatically created as needed when you assign individual properties to a group. To iterate through the property groups for an element, use DzElement::getPropertyGroups() to get the property group tree that the element's properties are grouped in.

    // Create a new property
    oProperty = new DzFloatProperty( "MyDeformer Control", true, false );

    // Set the path of the property - this moves the property to the group cooresponding
    // to the given path, creating groups if necessary.
    oProperty.setPath( "/Defomers/MyDeformerGroup" );

See also:
DzPropertyGroupTree


Member Function Documentation

DzPropertyGroup::addedChild ( DzPropertyGroup  newChild  )  [signal]

Signature: "addedChild(DzPropertyGroup*)"

Emitted when a child has been added to the group.

void DzPropertyGroup::childListChanged (  )  [signal]

Signature: "childListChanged()"

Emitted when the child list of the group has changed.

DzPropertyGroup DzPropertyGroup::findChild ( String  name  ) 

Parameters:
name The name of the property grou to look for.
Returns:
The child with the given name, NULL if not found.

DzPropertyGroup DzPropertyGroup::findSibling ( String  name  ) 

Parameters:
name The name of the sibling to look for.
Returns:
The sibling with the given name, NULL if not found.

Array DzPropertyGroup::getAllPaths (  ) 

Provided for convenience and DAZ Script access.

Returns:
A list of all property group paths beginning with this group.

bool DzPropertyGroup::getCollapsed (  ) 

Returns:
true if the group is collapsed

DzPropertyGroup DzPropertyGroup::getFirstChild (  ) 

Returns:
The first child group, if any.

DzPropertyGroup DzPropertyGroup::getNextSibling (  ) 

Returns:
The next sibling to this group, if any.

Number DzPropertyGroup::getNumProperties (  ) 

Returns:
The number of properties in this group

DzPropertyGroup DzPropertyGroup::getParent (  ) 

Returns:
The current parent of this group

String DzPropertyGroup::getPath (  ) 

Returns:
The path of this group

DzProperty DzPropertyGroup::getProperty ( Number  i  ) 

Parameters:
i The index of the property to return.
Returns:
The i'th property in this group

DzPropertyGroupTree DzPropertyGroup::getTree (  ) 

Returns:
The property group tree that this group belongs to.

Boolean DzPropertyGroup::moveChildToIndex ( String  childName,
Number  newIndex 
)

Moves the child group to a different position in the list.

Parameters:
childName The name of the child group to move
newIndex The position in the list to move the child group to.

Boolean DzPropertyGroup::movePropertyToIndex ( DzProperty  prop,
Number  newIndex 
)

This is an overloaded method, provided for convenience. Moves prop to a new location within the group.

Parameters:
prop The property to move. This property must be in this group to be successful.
newIndex The location to move prop to. If newIndex is not a valid index, prop is moved to the end of the list.
Returns:
true if the move was successful, false otherwise

Boolean DzPropertyGroup::movePropertyToIndex ( String  propName,
Number  newIndex 
)

Moves the property to a different location in the group list.

Parameters:
propName The name of the property to move
newIndex The new position in the list for the property
Returns:
true if the property was successfully moved, otherwise false.

DzPropertyGroup::parentChanged ( DzPropertyGroup  newParent  )  [signal]

Signature: "parentChanged(DzPropertyGroup*)"

Emitted when the parent of the group has changed.

DzPropertyGroup::removedChild ( DzPropertyGroup  child  )  [signal]

Signature: "removedChild(DzPropertyGroup*)"

Emitted when a child has been removed from the group.

void DzPropertyGroup::setCollapsed ( Boolean  onOff  ) 

Sets whether the group is displayed as collapsed in the interface.

Parameters:
onOff If true, the group is collapsed, if false, the group is expanded.

void DzPropertyGroup::treeChanged (  )  [signal]

Signature: "treeChanged()"

Emitted when the tree has changed.


Generated on Thu Sep 24 12:21:14 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.