The Text Objects: 5.7 Using VisText: Output Messages

Up: GEOS SDK TechDocs | Up | Prev: 5.6 Setting Text Confines | Next: 5.8 Getting Geometry Information
VTI_output, MSG_VIS_TEXT_GET_OUTPUT, MSG_VIS_TEXT_SET_OUTPUT, MSG_META_TEXT_USER_MODIFIED, MSG_META_TEXT_NOT_USER_MODIFIED,MSG_META_TEXT_CR_FILTERED,MSG_META_TEXT_TAB_FILTERED, MSG_META_TEXT_LOST_FOCUS, MSG_META_TEXT_GAINED_FOCUS, MSG_META_TEXT_LOST_TARGET, MSG_META_TEXT_GAINED_TARGET, MSG_META_TEXT_EMPTY_STATUS_CHANGED

VTI_ output stores the object to receive messages sent out by the text object. A range of messages imported from MetaClass ( MetaTextMessages ) are sent to this destination optr. These messages are listed below:

MSG_META_TEXT_USER_MODIFIED is sent to VTI_ output when the user first modifies text within the object. This message is also sent to the text object itself to set its VTS_MODIFIED state (after it is sent to VTI_ output ). If the text object's VTS_MODIFIED bit is later cleared, it is sent MSG_META_TEXT_NOT_USER_MODIFIED (and may receive MSG_META_TEXT_USER_MODIFIED again).

MSG_META_TEXT_CR_FILTERED is sent when a Carriage Return is filtered out of the text input by the text object's filtering mechanism. This message is first sent to the text object itself.

MSG_META_TEXT_TAB_FILTERED is sent when a Tab is filtered out of the text input by the text object's filtering mechanism. This message is first sent to the text object itself.

MSG_META_TEXT_LOST_FOCUS is sent when the text object loses the focus. MSG_META_TEXT_GAINED_FOCUS is sent when the text object gains the focus.

MSG_META_TEXT_LOST_TARGET is sent when the text object loses the target. MSG_META_TEXT_GAINED_TARGET is sent when the text object gains the target.

MSG_META_TEXT_EMPTY_STATUS_CHANGED is sent when the text object either changes from being empty to being non-empty or vice-versa.

To retrieve the current output of the text object, send it MSG_VIS_TEXT_GET_OUTPUT. To change the current output, send it MSG_VIS_TEXT_SET_OUTPUT.

MSG_META_TEXT_USER_MODIFIED

@importMessage MetaTextMessages, void MSG_META_TEXT_USER_MODIFIED(
        optr		obj);

MSG_META_TEXT_USER_MODIFIED is sent to VTI_ output when the user modifies text within the object. The message is also sent to the text object itself (to mark itself modified) after it is sent to the destination, so the state of the text's VTS_MODIFIED bit may not accurately reflect the state of the text object. If you need to intercept this message and also need to perform an operation using the text object's modified state.

Source: Sent by the system when the user modifies the text object.

Destination: VTI_ output of the text object's instance data. The message is also sent to the text object itself.

Parameters: obj Optr of the text object modified.

Interception: May intercept to receive notification of user modification of text. Because modification of the text object's VTS_MODIFIED bit may be asynchronous, you should send any operations that depend on this information (such as clearing the VTS_MODIFIED bit) to the text object using MF_FORCE_QUEUE

MSG_META_TEXT_NOT_USER_MODIFIED

@importMessage MetaTextMessages, void MSG_META_TEXT_NOT_USER_MODIFIED(
        optr		obj);

This message is sent to VTI_ output when the VTS_MODIFIED state of the text object is cleared, either by the system, or by an application inspired action.

Source: Sent by the system when the user modifies the text object.

Destination: VTI_ output of the text object's instance data. The message is also sent to the text object itself first.

Parameters: obj Optr of the text object marked not modified.

Interception: Intercept to receive notification of when a text object is marked not modified.

MSG_META_TEXT_CR_FILTERED

@importMessage MetaTextMessages, void MSG_META_TEXT_CR_FILTERED(
        word		character,
        word		flags,
        word		state);

This message is sent to VTI_ output when a Carriage Return is filtered out in the text input stream.

Source: Sent by the system when a CR is filtered out of the text object.

Destination: VTI_ output of the text object's instance data. The message is also sent to the text object itself.

Parameters: character The character value (CR).

flags
ShiftState and CharFlags .
state
The state of the text object (VTI_ state ) at the time of the filtering action.

Interception: Intercept to receive notification that a Carriage Return has been filtered out of the text object.

MSG_META_TEXT_TAB_FILTERED

@importMessage MetaTextMessages, void MSG_META_TEXT_TAB_FILTERED(
        word		character,
        word		flags,
        word		state);

This message is sent to VTI_ output when a Tab is filtered out in the text input stream.

Source: Sent by the system when the user modifies the text object.

Destination: VTI_ output of the text object's instance data. The message is also sent to the text object itself.

Parameters: character The character value (Tab).

flags
ShiftState and CharFlags .
state
The state of the text object (VTI_ state ) at the time of the filtering action.

Interception: Intercept to receive notification that a Tab has been filtered out of the text object.

MSG_META_TEXT_LOST_FOCUS

@importMessage MetaTextMessages, void MSG_META_TEXT_LOST_FOCUS(
        optr		obj);

This message is sent when the text object loses the focus of the application.

Source: Sent by the system when the user modifies the text object.

Destination: VTI_ output of the text object's instance data.

Parameters: obj Optr of the text object.

Interception: Intercept to receive notification of when the text object loses the focus.

MSG_META_TEXT_GAINED_FOCUS

@importMessage MetaTextMessages, void MSG_META_TEXT_GAINED_FOCUS(
        optr		obj);

This message is sent when the text object gains the focus of the application.

Source: Sent by the system when the user modifies the text object.

Destination: VTI_ output of the text object's instance data.

Parameters: obj Optr of the text object.

Interception: Intercept to receive notification of when the text object gains the focus.

MSG_META_TEXT_LOST_TARGET

@importMessage MetaTextMessages, void MSG_META_TEXT_LOST_TARGET(
        optr		obj);

This message is sent when the text object loses the target of an application.

Source: Sent by the system when the user modifies the text object.

Destination: VTI_ output of the text object's instance data.

Parameters: obj Optr of the text object.

Interception: Intercept to receive notification of when the text object loses the target.

MSG_META_TEXT_GAINED_TARGET

@importMessage MetaTextMessages, void MSG_META_TEXT_GAINED_TARGET(
        optr		obj);

This message is sent when the text object gains the target of an application.

Source: Sent by the system when the user modifies the text object.

Destination: VTI_ output of the text object's instance data.

Parameters: obj Optr of the text object.

Interception: Intercept to receive notification of when the text object gains the target.

MSG_META_TEXT_EMPTY_STATUS_CHANGED

@importMessage MetaTextMessages, void MSG_META_TEXT_EMPTY_STATUS_CHANGED(
        optr		object,
        Boolean		hasTextFlag);

This message is sent out when the text object is either becoming empty or not empty.

Source: Sent by the system when the user modifies the text object.

Destination: VTI_ output of the text object's instance data. The message is also sent to the text object itself first.

Parameters: object Optr of the text object whose empty status is changing.

hasTextFlag
Non-zero if the text object is becoming non-empty.

Interception: Intercept to receive notification when the empty status of the text object is changing.

MSG_VIS_TEXT_GET_OUTPUT

optr	MSG_VIS_TEXT_GET_OUTPUT();

This message returns the current destination (output) for actions taken by the text object.

Source: Unrestricted.

Destination: Any text object.

Return: Optr of the object's destination (in the VTI_ output field).

Interception: Generally not intercepted.

MSG_VIS_TEXT_SET_OUTPUT

void	MSG_VIS_TEXT_SET_OUTPUT(
        optr		newOutput);

This message sets the destination object for actions taken by this text object.

Source: Unrestricted.

Destination: Any text object.

Parameters: newOutput New destination object (placed in object's VTI_ output field).

Interception: Generally not intercepted.


Up: GEOS SDK TechDocs | Up | Prev: 5.6 Setting Text Confines | Next: 5.8 Getting Geometry Information