Developer

API Reference

IDecorator_SetExtent()

Brew Release
Brew MP 1.0.2
See Also
- WidgetExtent
- IDecorator
- IDecorator_GetPreferredExtent()
- IDecorator_GetExtent()
- IWidget_SetPreferredExtent()
Description
Sets the horizontal and vertical extent of the decorator, independent of the decorator's preferred size. IDecorator_SetExtent() communicates to the decorator the size it has been allocated on the display, and provides an opportunity for the decorator to adjust its content as best suited for the allotted size. For example, a decorator that wraps a list widget would likely cause that widget to reformat its contents to better suit the new decorator extent. As the size of the decorator changes, so shall the layout, formatting and arrangement of all the objects held within. The new size assigned to the decorator MUST be honored by the decorator, its child widget, and all the children, grandchildren and the entire hierarchy of objects that may be contained within the child widget.
Parameters
  • p
    []:
    Pointer to the IDecorator object.
  • x
    []:
    Pointer to the WidgetExtent struct that provides the new extent of the decorator.
Interface
Prototype
   void IDecorator_SetExtent(IDecorator *p, WidgetExtent *x);
   
Return
None
Side Effect
None
Comment
Subsequent call to IDecorator_GetExtent() should return the same extent value sent in the call to IDecorator_SetExtent().
  • Follow