Developer

API Reference

IWidget_TraverseContainerTree()

Brew Release
Brew MP 1.0.2
Description
This function is used to execute a function on a container and some or all of its children. This is similar to the broadcast functionality but allows more control and flexibility. The client passes in a callback function, function context and a depth value, and then the container widget performs a preorder traversal of its containment tree. Each widget is visited in turn, starting with the top-level container that is the target for this function.
Parameters
  • pif
    []:
    Pointer to the IWidget interface object.
  • pfn
    []:
    Callback function to execute on each widget in container hierarchy
  • pv
    []:
    Context pointer for callback function
  • wDepth
    []:
    Number of levels to descend. (Use zero to descend into all levels).
Interface
Prototype
   int IWidget_TraverseContainerTree(IWidget *pif, PFNVISIT pfn, void *pv, uint16 wDepth);
Return
   AEE_SUCCESS - If the target widget handles the EVT_WDG_TRAVERSE event.
   AEE_EFAILED - If the target widget does not handle the EVT_WDG_TRAVERSE event.
Side Effect
None
Comment
This function is a convenience inline for the EVT_WDG_TRAVERSE event.
  • Follow