GenValue: 3.4 GenValue Basics: GenValue States

GVLI_stateFlags, MSG_GEN_VALUE_SET_INDETERMINATE_STATE, MSG_GEN_VALUE_IS_INDETERMINATE, MSG_GEN_VALUE_SET_MODIFIED_STATE, MSG_GEN_VALUE_IS_MODIFIED, ATTR_GEN_SET_MODIFIED_ON_REDUNDANT_SELECTION

GVLI_ stateFlags stores the current state of the GenValue. There are two GenValueStateFlags :

GVSF_INDETERMINATE
This flag specifies that the value within the GenValue is indeterminate (may or may not be true). In most cases, you will not need to set this flag.
GVSF_MODIFIED
This flag specifies that the value within the GenValue has changed since it last received a MSG_GEN_APPLY . The handler for MSG_GEN_APPLY checks whether this flag is set before sending out the GenValue's GVLI_applyMsg .
GVSF_OUT_OF_DATE
This flag specifies that the value within the GenValue is out of date with what the user has typed in. This is distinct from the GVSF_MODIFIED state; while the user is typing an a value ("123" for example) the typed value may be temporarily out of range, or incomplete. In this case, the value would be marked GVSF_OUT_OF_DATE and GVSF_MODIFIED. Notice that if the value were incremented or decremented, it would be marked GVSF_MODIFIED, but not GVSF_OUT_OF_DATE because the value is legal and presumable valid for operations. This flag is most useful when telling status messages whether a value should be used.

GenValues are normally marked as not modified anytime their state is set with an external message, marked modified whenever the user interacts with them, and marked not modified after receiving MSG_GEN_APPLY . MSG_GEN_VALUE_SET_MODIFIED_STATE allows you to control the modified state of a GenValue outside of these events.

You may set a GenValue's indeterminate or modified state with MSG_GEN_VALUE_SET_INDETERMINATE_STATE or MSG_GEN_VALUE_SET_MODIFIED_STATE , respectively.

To check whether a GenValue is indeterminate or modified, use MSG_GEN_VALUE_IS_INDETERMINATE or MSG_GEN_VALUE_IS_MODIFIED.

You may also mark a GenValue GVSF_OUT_OF_DATE by sending it MSG_GEN_VALUE_SET_OUT_OF_DATE.

MSG_GEN_VALUE_SET_INDETERMINATE_STATE

void	MSG_GEN_VALUE_SET_INDETERMINATE_STATE(
        Boolean		indeterminateState);

This message sets the indeterminate state for a GenValue. Pass TRUE to mark the GenValue indeterminate, FALSE to mark it not indeterminate. The GenValue will not be marked modified after this message.

Source: Unrestricted.

Destination: Any GenValue object.

Parameters: indeterminateState
TRUE to set the GVSF_INDETERMINATE flag in the GenValue's GVLI_stateFlags ,
FALSE to clear the GVSF_INDETERMINATE flag.

Interception: Generally not intercepted.

MSG_GEN_VALUE_IS_INDETERMINATE

Boolean	MSG_GEN_VALUE_IS_INDETERMINATE();

This message checks whether a GenValue is indeterminate.

Source: Unrestricted.

Destination: Any GenValue object.

Return: TRUE if GenValue is indeterminate, FALSE if it is not.

Interception: Generally not intercepted.

MSG_GEN_VALUE_SET_MODIFIED_STATE

void	MSG_GEN_VALUE_SET_MODIFIED_STATE(
        Boolean		modifiedState);

This message sets the modified state for a GenValue. Pass TRUE to mark the GenValue modified, FALSE to mark it not modified.

Source: Unrestricted.

Destination: Any GenValue object.

Parameters: modifiedState
TRUE to set the GVSF_MODIFIED flag in the GenValue's GVLI_stateFlags ,
FALSE to clear the GVSF_MODIFIED flag.

Interception: Generally not intercepted.

MSG_GEN_VALUE_IS_MODIFIED

Boolean	MSG_GEN_VALUE_IS_MODIFIED();

This message checks whether a GenValue has been modified since the last MSG_GEN_APPLY .

Source: Unrestricted.

Destination: Any GenValue object.

Return: TRUE if GenValue is modified, FALSE if it is not.

Interception: Generally not intercepted.

MSG_GEN_VALUE_SET_OUT_OF_DATE

void	MSG_GEN_VALUE_SET_OUT_OF_DATE();

This message sets a GenValue's GVSF_OUT_OF_DATE flag.

Source: Unrestricted.

Destination: Any GenValue object.

Interception: Generally not intercepted.

GEOS SDK TechDocs |

3.3 The Increment | Next:

3.5 Display Formats