Developer

API Reference

IWidget_Invalidate()

Brew Release
Brew MP 1.0.2
See Also
- IContainer
- IWidget
- IContainer_Invalidate
Description
This is a helper function for invalidating a widget when you only have a pointer to the widget interface and not a pointer to the interface of the parent container of the widget. See IContainer_Invalidate() for details on invalidation.
Parameters
  • pif
    []:
    Pointer to the IWidget to be invalidated, or a constant that implies a particular widget within the container. The constants used to identify a relative position for the widget to be invalidated, are defined as follows WIDGET_ZTOPMOST - Requests that the widget at the top of the container's widget stack should be invalidated. WIDGET_ZBOTTOMMOST - Requests that the widget at the bottom of the container's widget stack should be invalidated. WIDGET_ZNORMAL - Requests that the widget placed at the container's most normal layout location be invalidated. The base container treats the WIDGET_ZTOPMOST position as the "normal" location.
  • prc
    []:
    Pointer to the rectangle that defines the area to be invalidated. This rectangle is expressed relative to the coordinates of the specified widget. When this parameter is NULL, the interface will use the full extent of the 'pw' widget as the invalidation rectangle.
  • dwFlags
    []:
    A set of flags that control the calculation of the invalidation rectangle. The defined validation flags are ICIF_EXTENT - When this flag is ON, it is an indication that the widget has changed its extent. ICIF_REDRAW - When this flag is ON, it is an indication that the widget has changed its contents, but its preferred extent is still the same. The widget simply wants to be redrawn. ICIF_DEFER - When this flag is ON, it indicates that the widget's layout is disabled, but it is still passing an invalidate up to notify its ancestors that an invalidate occurred but no action was taken as layout was disabled. When RootContainer receives an invalidate with the ICIF_DEFER flag appended, it will not cause a draw to be scheduled.
Interface
Prototype
   void IWidget_Invalidate(IWidget *pif, AEERect *prc, uint32 dwFlags);
   
Return
None
Side Effect
None
Comment
None
  • Follow