Difference between revisions of "FontBase:layoutText"
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | '''Available since:''' Gideros 2017.10<br/> | + | '''<translate>Available since</translate>:''' Gideros 2017.10<br/> |
| − | === Description === | + | === <translate>Description</translate> === |
<translate><br /> | <translate><br /> | ||
Compute the layout of the given text according to a given rectangular region size, layout flags and other parameters.<br /> | Compute the layout of the given text according to a given rectangular region size, layout flags and other parameters.<br /> | ||
| Line 20: | Line 20: | ||
(table) = FontBase:layoutText(text,width,height,flags,letterSpacing,lineSpacing,tabSpace,breakChar) | (table) = FontBase:layoutText(text,width,height,flags,letterSpacing,lineSpacing,tabSpace,breakChar) | ||
</source> | </source> | ||
| − | === Parameters === | + | === <translate>Parameters</translate> === |
'''text''': (string) <translate></translate> <br/> | '''text''': (string) <translate></translate> <br/> | ||
'''width''': (number) <translate></translate> <br/> | '''width''': (number) <translate></translate> <br/> | ||
| Line 29: | Line 29: | ||
'''tabSpace''': (number, default = 4) <translate></translate> <br/> | '''tabSpace''': (number, default = 4) <translate></translate> <br/> | ||
'''breakChar''': (string) <translate></translate> '''optional'''<br/> | '''breakChar''': (string) <translate></translate> '''optional'''<br/> | ||
| − | === Return values === | + | === <translate>Return values</translate> === |
| − | '''Returns''' (table) <translate>A table describing how to draw the given text.</translate><br/> | + | '''<translate>Returns</translate>''' (table) <translate>A table describing how to draw the given text.</translate><br/> |
Revision as of 07:27, 24 August 2018
Available since: Gideros 2017.10
Description
Compute the layout of the given text according to a given rectangular region size, layout flags and other parameters.
Refer to TextField:setLayout for a description of the arguments.
The returned table contains the following fields:
- x,y,w,h: Computed bounding box of the full text
- lines: The number of lines used to display the text
- parts: Information about individual chunks of texts.
Each table in the part field of the returned table describe the placement of chunks of text. Their fields are:
- text: The text to display in this chunk
- x,y,w,h: Computed bounding box of this chunk
- dx,dy: Coordinates to draw this chunk at
- sep: separator character that came just after this chunk in text block
- line: line number this chunk belongs to
(table) = FontBase:layoutText(text,width,height,flags,letterSpacing,lineSpacing,tabSpace,breakChar)
Parameters
text: (string)
width: (number)
height: (number)
flags: (number, default=FontBase.TLF_NOWRAP)
letterSpacing: (number, default = 0)
lineSpacing: (number, default = 0)
tabSpace: (number, default = 4)
breakChar: (string) optional
Return values
Returns (table) A table describing how to draw the given text.
