Difference between revisions of "TextField:getPointFromTextPosition"
From GiderosMobile
(added example + 1 typo) |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | '''Available since:''' Gideros 2019.5<br/> | |
| − | ''' | + | '''Class:''' [[TextField]]<br/> |
| − | ''' | ||
| − | === | + | === Description === |
| − | + | Returns the coordinates from a given offset within the text. | |
| − | < | + | <syntaxhighlight lang="lua"> |
(number),(number) = TextField:getPointFromTextPosition(offset) | (number),(number) = TextField:getPointFromTextPosition(offset) | ||
| − | </ | + | </syntaxhighlight> |
| − | === | + | === Parameters === |
| − | '''offset''': (string) | + | '''offset''': (string) The byte offset into the text string. <br/> |
| − | === | + | === Return values === |
| − | ''' | + | '''Returns''' (number) the X coordinate<br/> |
| − | ''' | + | '''Returns''' (number) the Y coordinate<br/> |
| − | === | + | === Example === |
'''Draws a red underline under the 'is' word:''' | '''Draws a red underline under the 'is' word:''' | ||
| − | < | + | <syntaxhighlight lang="lua"> |
local font = TTFont.new("fonts/Tahoma.ttf", 32, "", true, 1) | local font = TTFont.new("fonts/Tahoma.ttf", 32, "", true, 1) | ||
local text = TextField.new(font, "This is a text") | local text = TextField.new(font, "This is a text") | ||
| Line 31: | Line 30: | ||
stage:addChild(text) | stage:addChild(text) | ||
stage:addChild(underline) | stage:addChild(underline) | ||
| − | </ | + | </syntaxhighlight> |
{{TextField}} | {{TextField}} | ||
Latest revision as of 08:09, 18 October 2024
Available since: Gideros 2019.5
Class: TextField
Description
Returns the coordinates from a given offset within the text.
(number),(number) = TextField:getPointFromTextPosition(offset)
Parameters
offset: (string) The byte offset into the text string.
Return values
Returns (number) the X coordinate
Returns (number) the Y coordinate
Example
Draws a red underline under the 'is' word:
local font = TTFont.new("fonts/Tahoma.ttf", 32, "", true, 1)
local text = TextField.new(font, "This is a text")
text:setPosition(100, 100)
local isS, isE = string.find(text:getText(), " is ") --Get 'is' word position
local isSX, isSY = text:getPointFromTextPosition(isS) --Get 'i' starting point
local isEX, isEY = text:getPointFromTextPosition(isE - 1) -- Get 's' end point
-- Draw a red underline under the 'is' word
local underline = Pixel.new(0xFF0000, 1, isEX - isSX, 3)
underline:setPosition(100 + isSX, 100 + 2)
stage:addChild(text)
stage:addChild(underline)
- TextField
- TextField.new
- TextField:getLayout
- TextField:getLetterSpacing
- TextField:getLineHeight
- TextField:getPointFromTextPosition
- TextField:getSample
- TextField:getText
- TextField:getTextColor
- TextField:getTextPositionFromPoint
- TextField:setFont
- TextField:setLayout
- TextField:setLetterSpacing
- TextField:setSample
- TextField:setText
- TextField:setTextColor
