The Text Objects: 5.6 Using VisText: Setting Text Confines

GEOS SDK TechDocs

5.5 Key Functions

5.7 Output Messages

MSG_VIS_TEXT_GET_MAX_LENGTH, MSG_VIS_TEXT_SET_MAX_LENGTH, MSG_VIS_TEXT_GET_LR_MARGIN, MSG_VIS_TEXT_SET_LR_MARGIN, MSG_VIS_TEXT_GET_TB_MARGIN, MSG_VIS_TEXT_SET_TB_MARGIN

MSG_VIS_TEXT_GET_MAX_LENGTH

word	MSG_VIS_TEXT_GET_MAX_LENGTH();

This message returns the maximum length of text in the text object (stored in VTI_ maxLength ).

Source: Unrestricted.

Destination: Any text object.

Return: Maximum length of the text, in characters.

Interception: Generally not intercepted.

MSG_VIS_TEXT_SET_MAX_LENGTH

void	MSG_VIS_TEXT_SET_MAX_LENGTH(
        word		newMaxLength);

This message sets the maximum length of text within a text object (stored in VTI_ maxLength ). If the current text is too long, any excess text is removed.

Source: Unrestricted.

Destination: Any text object (except VisLargeTextClass ).

Parameters: newMaxLength Maximum length of the text object (in characters).

Interception: Generally not intercepted.

MSG_VIS_TEXT_GET_LR_MARGIN

byte	MSG_VIS_TEXT_GET_LR_MARGIN();

This message returns the current left/right margins. Both margins are the same and are thus represented by the same returned value.

Source: Unrestricted.

Destination: VisTextClass objects (not GenText objects).

Return: The current left/right margin.

Interception: Generally not intercepted.

MSG_VIS_TEXT_SET_LR_MARGIN

void	MSG_VIS_TEXT_SET_LR_MARGIN(
        byte		lrMargin);

This message sets the left/right margins of the text object. Both margins will be set to the same value. Do not use this message on GenText objects, as the specific UI is responsible for this behavior.

Source: Unrestricted.

Destination: VisTextClass objects (not GenText objects).

Parameters: lrMargin New left/right margins.

Interception: Generally not intercepted.

MSG_VIS_TEXT_GET_TB_MARGIN

byte	MSG_VIS_TEXT_GET_TB_MARGIN();

This message returns the current top/bottom margins. Both margins are the same and are thus represented by the same returned value.

Source: Unrestricted.

Destination: VisTextClass objects (not GenText objects).

Return: The current top/bottom margin.

Interception: Generally not intercepted.

MSG_VIS_TEXT_SET_TB_MARGIN

void	MSG_VIS_TEXT_SET_TB_MARGIN(
        byte		tbMargin);

This message sets the top/bottom margins of the text object. Both margins will be set to the same value. Do not use this message on GenText objects, as the specific UI is responsible for this behavior.

Source: Unrestricted.

Destination: VisTextClass objects (not GenText objects).

Parameters: tbMargin New top/bottom margins.

Interception: Generally not intercepted.

GEOS SDK TechDocs

5.5 Key Functions

5.7 Output Messages