[Previous] [Contents] [Index] [Next]

PtTreeExpand()

Expand an expandable item

Synopsis:

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

Description:

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

If tree isn't NULL, the Pt_CB_TREE_STATE callback is invoked. The event argument is the event that will be passed to the callback. If the callback function prevents the expansion by setting the expand field in the callback structure to a nonzero value, the function will return that value. A value of 0 means successful expansion.

Returns:

A value of zero on successful expansion, otherwise the value that prevented the expansion.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

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


[Previous] [Contents] [Index] [Next]