TextItemGetScale: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This | This function allows retrieval of the scale or size of a text item. | ||
==Syntax== | ==Syntax== | ||
| Line 10: | Line 8: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''textitem:''' The text item you wish to retreive the scale of | ||
===Returns=== | ===Returns=== | ||
Returns | Returns a floating point of the scale of the text. 1.0 is around 12pt. | ||
==Example== | ==Example== | ||
This example | This example retreives the scale of the 'theTextitem' text item, and if it is too small it enlarges it so it is more visible. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | scale = textItemGetScale ( theTextitem ) --get the scale of theTextitem and define it as 'scale' | ||
if scale < 0.5 then --if the scale is smaller than 0.5 | |||
-- | textItemSetScale ( theTextitem, 1.0 ) --then restore it to default size, 1.0. | ||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ | {{Text functions}} | ||
Revision as of 17:02, 16 August 2006
This function allows retrieval of the scale or size of a text item.
Syntax
float textItemGetScale ( textitem textitem )
Required Arguments
- textitem: The text item you wish to retreive the scale of
Returns
Returns a floating point of the scale of the text. 1.0 is around 12pt.
Example
This example retreives the scale of the 'theTextitem' text item, and if it is too small it enlarges it so it is more visible.
scale = textItemGetScale ( theTextitem ) --get the scale of theTextitem and define it as 'scale'
if scale < 0.5 then --if the scale is smaller than 0.5
textItemSetScale ( theTextitem, 1.0 ) --then restore it to default size, 1.0.
end
See Also
- textCreateDisplay
- textCreateTextItem
- textDestroyDisplay
- textDestroyTextItem
- textDisplayAddObserver
- textDisplayAddText
- textDisplayGetObservers
- textDisplayIsObserver
- textDisplayRemoveObserver
- textDisplayRemoveText
- textItemGetColor
- textItemGetPosition
- textItemGetPriority
- textItemGetScale
- textItemGetText
- textItemSetColor
- textItemSetPosition
- textItemSetPriority
- textItemSetScale
- textItemSetText