VisClass: 3.4 VisClass Instance Data: VI_optFlags

VI_optFlags, MSG_VIS_GET_OPT_FLAGS

The VI_optFlags field is a VisOptFlags record containing eight flags. These flags are set and used by the geometry manager to mark which objects need to be updated and how. The flags can not be set individually by applications; however, they can be retrieved with the message MSG_VIS_GET_OPT_FLAGS . It is unlikely that your code will ever access these flags directly. The eight flags in this field are listed below.

VOF_GEOMETRY_INVALID: This flag indicates that the general geometry of this object has become invalid (with a MSG_VIS_MARK_INVALID ). This is used primarily when an object knows that its bounds must be recalculated or re-verified and that any change must be reflected in its parent window. This flag will be reset when a geometry update resolves the object's bounds. Typically, this will occur with a window update message such as MSG_VIS_UPDATE_WIN_GROUP .
VOF_GEO_UPDATE_PATH: This flag, also set by MSG_VIS_MARK_INVALID , marks a trail of objects that all must have their geometry updated.
VOF_IMAGE_INVALID: This flag indicates that the image of the object or the bounds of a windowed object have changed and therefore need to be updated. This flag is set by MSG_VIS_MARK_INVALID . The image redraw will occur the next time one of the window update messages is used on the object's visual branch. This flag will be reset when a visual update redraws the object. Typically, this will occur with MSG_VIS_UPDATE_WIN_GROUP or another window update message.
VOF_IMAGE_UPDATE_PATH: This flag, also set by MSG_VIS_MARK_INVALID , marks a trail of objects that must have their images updated.
VOF_WINDOW_INVALID: This flag indicates that the window the object resides in needs to be opened or closed, or that the object itself needs to be opened or closed via MSG_VIS_OPEN or MSG_VIS_CLOSE . It is set by MSG_VIS_MARK_INVALID . This flag will be reset when a visual update occurs on the window group. Typically, this will occur with a window update message such as MSG_VIS_VUP_UPDATE_WIN_GROUP . (This message should be called whenever an object is added to a visible tree; it ensures the object will be properly opened.)
VOF_WINDOW_UPDATE_PATH: This flag, also set by MSG_VIS_MARK_INVALID , marks a trail of window objects that all must have their windows and open/closed state updated.
VOF_UPDATE_PENDING: This flag indicates that the object has an unprocessed MSG_VIS_UPDATE_WIN_GROUP in its event queue.
VOF_EC_UPDATING: This flag is used by the VisClass error-checking code only. It indicates that a visible branch is currently being updated; the system checks it to make sure nested updates do not occur.

MSG_VIS_GET_OPT_FLAGS

VisOptFlags MSG_VIS_GET_OPT_FLAGS();

This message returns the current VI_optFlags field of the object.

Source: Unrestricted.

Destination: Any visible object.

Parameters: None.

Return: A byte record of VisOptFlags reflecting the current settings in the object's VI_optFlags field.

Interception: Unlikely.