Caution: This version of this document is no longer maintained. For the latest documentation, see


Collapse an expandable item


int PtTreeCollapse( PtWidget_t *tree, 
                    PtTreeItem_t *item,
                    PhEvent_t *event );


This function collapses the given subtree item. The tree argument must point to the tree that contains the item, or it can be NULL if the item doesn't belong to any tree.

If the item is in the tree, the tree's Pt_CB_TREE_STATE callback is invoked after the item has been collapsed. The event argument to this function is the event that's passed to the callback.


The value assigned to the expand field in the callback structure, or zero if the item isn't in a tree or there's no Pt_CB_TREE_STATE callback that modifies the expand field.



Interrupt handler No
Signal handler No
Thread No

See also:

PtTree, PtTreeExpand(), PtTreeGetCurrent(), PtTreeGoto(), PtTreeItem_t, PtTreeShow()

PhEvent_t in the Photon Library Reference