Difference between revisions of "FontBase:layoutText"
| Line 2: | Line 2: | ||
'''Available since:''' Gideros 2017.10<br/> | '''Available since:''' Gideros 2017.10<br/> | ||
=== Description === | === Description === | ||
| − | <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 /> | ||
<br /> | <br /> | ||
| − | Refer to | + | Refer to [[[TextField:setLayout]]] for a description of the arguments.<br/> |
The returned table contains the following fields: | The returned table contains the following fields: | ||
- x,y,w,h: Computed bounding box of the full text | - x,y,w,h: Computed bounding box of the full text | ||
| Line 16: | Line 16: | ||
- dx,dy: Coordinates to draw this chunk at | - dx,dy: Coordinates to draw this chunk at | ||
- sep: separator character that came just after this chunk in text block | - sep: separator character that came just after this chunk in text block | ||
| − | - line: line number this chunk belongs to | + | - line: line number this chunk belongs to</translate> |
<source lang="lua"> | <source lang="lua"> | ||
(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 === | === Parameters === | ||
| − | '''text''': (string) | + | '''text''': (string) <translate></translate> <br/> |
| − | '''width''': (number) | + | '''width''': (number) <translate></translate> <br/> |
| − | '''height''': (number) | + | '''height''': (number) <translate></translate> <br/> |
| − | '''flags''': (number, default=FontBase.TLF_NOWRAP) | + | '''flags''': (number, default=FontBase.TLF_NOWRAP) <translate></translate> <br/> |
| − | '''letterSpacing''': (number, default = 0) | + | '''letterSpacing''': (number, default = 0) <translate></translate> <br/> |
| − | '''lineSpacing''': (number, default = 0) | + | '''lineSpacing''': (number, default = 0) <translate></translate> <br/> |
| − | '''tabSpace''': (number, default = 4) | + | '''tabSpace''': (number, default = 4) <translate></translate> <br/> |
| − | '''breakChar''': (string) | + | '''breakChar''': (string) <translate></translate> '''optional'''<br/> |
=== Return values === | === Return values === | ||
| − | '''Returns''' (table) A table describing how to draw the given text.<br/> | + | '''Returns''' (table) <translate>A table describing how to draw the given text.</translate><br/> |
Revision as of 13:38, 23 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.
