Developer

API Reference

IRootContainer_GetCanvas()

Brew Release
Brew MP 1.0.2
See Also
- IRootContainer_SetCanvas
- ICanvas
Description
The root container is the top-most entity in the widget/container hierarchy and is responsible for drawing all of its contained widgets. The ICanvas interface provides a drawing surface upon which widgets and other components draw. This function is used to get the ICanvas and the position and extent of the canvas itself.
Parameters
  • pif
    []:
    [in] A pointer to an IRootContainer object.
  • ppi
    []:
    [out] A pointer to an ICanvas pointer which will be set
  • prc
    []:
    [out] Pointer to an AEERect structure that specifies the location and extent of the root container.

Prototype
   int IRootContainer_GetCanvas(IRootContainer *pif, ICanvas **pic, const AEERect *prc);
Return
   
   AEE_SUCCESS  --  The canvas was successfully retrieved.
   AEE_EFAILED  --  The canvas was NULL

Side Effect
None
Comment
This function does an Add_Ref on the returned ICanvas.
  • Follow