The Text Objects: 5.8 Using VisText: Getting Geometry Information

Up: GEOS SDK TechDocs | Up | Prev: 5.7 Output Messages | Next: 6 Using GenText
MSG_VIS_TEXT_GET_MIN_WIDTH, MSG_VIS_TEXT_GET_AVERAGE_CHAR_WIDTH, MSG_VIS_TEXT_GET_LINE_HEIGHT, MSG_VIS_TEXT_RECALC_AND_DRAW, MSG_VIS_TEXT_GET_ONE_LINE_WIDTH, MSG_VIS_TEXT_GET_SIMPLE_MIN_WIDTH

MSG_VIS_TEXT_GET_MIN_WIDTH

word	MSG_VIS_TEXT_GET_MIN_WIDTH();

This message returns the minimum width that can be supported for attributes of the text object.

Source: Unrestricted.

Destination: Any text object.

Return: Minimum width (in points) that can be supported.

MSG_VIS_TEXT_GET_AVERAGE_CHAR_WIDTH

word	MSG_VIS_TEXT_GET_AVERAGE_CHAR_WIDTH();

This message returns the average character width for the first font/character attribute run.

Source: Unrestricted.,

Destination: Any text object.

Return: Average character width (in points).

MSG_VIS_TEXT_GET_LINE_HEIGHT

word	MSG_VIS_TEXT_GET_LINE_HEIGHT();

This message returns the height of a line (in points) for a single-line text object only .

Source: Unrestricted.

Destination: Single-line text objects that are not within document objects.

Return: Height of line (in points).

MSG_VIS_TEXT_RECALC_AND_DRAW

void	MSG_VIS_TEXT_RECALC_AND_DRAW();

This message recalculates and redraws a text object, usually after constraints on either its width or its height is made without its knowledge.

Source: Unrestricted.

Destination: Any text object.

Interception: Generally not intercepted.

MSG_VIS_TEXT_GET_ONE_LINE_WIDTH

word	MSG_VIS_TEXT_GET_ONE_LINE_WIDTH(
        word		charsToCalc);

This message calculates the width of a single-line text object. This width is calculated using the first encountered character attributes.

Source: Unrestricted.

Destination: Any single-line text object.

Parameters: charsToCalc Number of characters (from start of text) to use in the calculation.

Return: Width of the text.

MSG_VIS_TEXT_GET_SIMPLE_MIN_WIDTH

word	MSG_VIS_TEXT_GET_SIMPLE_MIN_WIDTH();

This message returns the minimum width that can be supported for the text object's current text, font and character attributes. This message assumes that the caller is not worried about keeping a width for the largest border possible.

Source: Unrestricted.

Destination: Any text object.

Return: Minimum width which can be supported.


Up: GEOS SDK TechDocs | Up | Prev: 5.7 Output Messages | Next: 6 Using GenText