TextGetWrap

Syntax

WrapMode = TextGetWrap(Text)

Description

Retrieves the current word wrapping mode set for the specified text object.

Parameters

Text
The handle of the text object whose wrapping mode is to be retrieved.

Return Value

Returns the current word wrapping mode constant:

#PG_Text_Wrap_None
#PG_Text_Wrap_Wrap
#PG_Text_Wrap_EmergencyBreak
#PG_Text_Wrap_WholeWord
#PG_Text_Wrap_Character

Returns #False (0) if the text handle is invalid (note: 0 corresponds to #PG_Text_Wrap_None, the default).

See Also

CreateText, TextSetWrap, TextSetWidth

Supported OS

Windows, Linux