Difference between revisions of "FontBase"

From GiderosMobile
m (reordered constants + added more contents)
Line 12: Line 12:
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Methods</translate> ===
 
=== <translate>Methods</translate> ===
−
[[Special:MyLanguage/FontBase:getAdvanceX|FontBase:getAdvanceX]] <br/><!-- GIDEROSMTD:FontBase:getAdvanceX(text,letterSpacing,size) -->
+
[[Special:MyLanguage/FontBase:getAdvanceX|FontBase:getAdvanceX]] ''returns the width of the first character''<br/>
−
[[Special:MyLanguage/FontBase:getAscender|FontBase:getAscender]] ''<translate>returns the ascender of the font</translate>''<br/><!-- GIDEROSMTD:FontBase:getAscender() returns the ascender of the font -->
+
<!-- GIDEROSMTD:FontBase:getAdvanceX(text,letterSpacing,size) returns the width of the first character -->
−
[[Special:MyLanguage/FontBase:getBounds|FontBase:getBounds]] ''<translate>returns the tight bounding rectangle of the characters in the string specified by text</translate>''<br/><!-- GIDEROSMTD:FontBase:getBounds(text) returns the tight bounding rectangle of the characters in the string specified by text -->
+
[[Special:MyLanguage/FontBase:getAscender|FontBase:getAscender]] ''returns the ascender of the font''<br/>
−
[[Special:MyLanguage/FontBase:getCharIndexAtOffset|FontBase:getCharIndexAtOffset]] <br/><!-- GIDEROSMTD:FontBase:getCharIndexAtOffset(text,offset,letterSpacing,size) -->
+
<!-- GIDEROSMTD:FontBase:getAscender() returns the ascender of the font -->
−
[[Special:MyLanguage/FontBase:getLineHeight|FontBase:getLineHeight]] ''<translate>returns the distance from one base line to the next</translate>''<br/><!-- GIDEROSMTD:FontBase:getLineHeight() returns the distance from one base line to the next -->
+
[[Special:MyLanguage/FontBase:getBounds|FontBase:getBounds]] ''returns the tight bounding rectangle of the characters in the string specified by text''<br/>
−
[[Special:MyLanguage/FontBase:layoutText|FontBase:layoutText]] ''<translate>compute layout of text with given constraints</translate>''<br/><!-- GIDEROSMTD:FontBase:layoutText(text,width,height,flags,letterSpacing,lineSpacing,tabSpace,breakChar) compute layout of text with given constraints -->
+
<!-- GIDEROSMTD:FontBase:getBounds(text) returns the tight bounding rectangle of the characters in the string specified by text -->
 +
[[Special:MyLanguage/FontBase:getCharIndexAtOffset|FontBase:getCharIndexAtOffset]] ''returns the offset within the given text string''<br/>
 +
<!-- GIDEROSMTD:FontBase:getCharIndexAtOffset(text,offset,letterSpacing,size) returns the offset within the given text string -->
 +
[[Special:MyLanguage/FontBase:getLineHeight|FontBase:getLineHeight]] ''returns the distance from one base line to the next''<br/>
 +
<!-- GIDEROSMTD:FontBase:getLineHeight() returns the distance from one base line to the next -->
 +
[[Special:MyLanguage/FontBase:layoutText|FontBase:layoutText]] ''computes the text layout with given constraints''<br/><!-- GIDEROSMTD:FontBase:layoutText(text,width,height,flags,letterSpacing,lineSpacing,tabSpace,breakChar) computes the text layout with given constraints -->
  
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Events</translate> ===
 
=== <translate>Events</translate> ===
 
=== <translate>Constants</translate> ===
 
=== <translate>Constants</translate> ===
−
[[Special:MyLanguage/FontBase.TLF_BOTTOM|FontBase.TLF_BOTTOM]]<br/><!-- GIDEROSCST:FontBase.TLF_BOTTOM TLF_BOTTOM-->
+
[[Special:MyLanguage/FontBase.TLF_BOTTOM|FontBase.TLF_BOTTOM]]<br/>
−
[[Special:MyLanguage/FontBase.TLF_BREAKWORDS|FontBase.TLF_BREAKWORDS]]<br/><!-- GIDEROSCST:FontBase.TLF_BREAKWORDS TLF_BREAKWORDS-->
+
<!-- GIDEROSCST:FontBase.TLF_BOTTOM TLF_BOTTOM -->
−
[[Special:MyLanguage/FontBase.TLF_CENTER|FontBase.TLF_CENTER]]<br/><!-- GIDEROSCST:FontBase.TLF_CENTER TLF_CENTER-->
+
[[Special:MyLanguage/FontBase.TLF_BREAKWORDS|FontBase.TLF_BREAKWORDS]]<br/>
−
[[Special:MyLanguage/FontBase.TLF_JUSTIFIED|FontBase.TLF_JUSTIFIED]]<br/><!-- GIDEROSCST:FontBase.TLF_JUSTIFIED TLF_JUSTIFIED-->
+
<!-- GIDEROSCST:FontBase.TLF_BREAKWORDS TLF_BREAKWORDS -->
−
[[Special:MyLanguage/FontBase.TLF_LEFT|FontBase.TLF_LEFT]]<br/><!-- GIDEROSCST:FontBase.TLF_LEFT TLF_LEFT-->
+
[[Special:MyLanguage/FontBase.TLF_CENTER|FontBase.TLF_CENTER]]<br/>
−
[[Special:MyLanguage/FontBase.TLF_NOWRAP|FontBase.TLF_NOWRAP]]<br/><!-- GIDEROSCST:FontBase.TLF_NOWRAP TLF_NOWRAP-->
+
<!-- GIDEROSCST:FontBase.TLF_CENTER TLF_CENTER -->
−
[[Special:MyLanguage/FontBase.TLF_REF_BASELINE|FontBase.TLF_REF_BASELINE]]<br/><!-- GIDEROSCST:FontBase.TLF_REF_BASELINE TLF_REF_BASELINE-->
+
[[Special:MyLanguage/FontBase.TLF_JUSTIFIED|FontBase.TLF_JUSTIFIED]]<br/>
−
[[Special:MyLanguage/FontBase.TLF_REF_BOTTOM|FontBase.TLF_REF_BOTTOM]]<br/><!-- GIDEROSCST:FontBase.TLF_REF_BOTTOM TLF_REF_BOTTOM-->
+
<!-- GIDEROSCST:FontBase.TLF_JUSTIFIED TLF_JUSTIFIED -->
−
[[Special:MyLanguage/FontBase.TLF_REF_MIDDLE|FontBase.TLF_REF_MIDDLE]]<br/><!-- GIDEROSCST:FontBase.TLF_REF_MIDDLE TLF_REF_MIDDLE-->
+
[[Special:MyLanguage/FontBase.TLF_LEFT|FontBase.TLF_LEFT]]<br/>
−
[[Special:MyLanguage/FontBase.TLF_REF_ASCENT|FontBase.TLF_REF_ASCENT]]<br/><!-- GIDEROSCST:FontBase.TLF_REF_ASCENT TLF_REF_ASCENT-->
+
<!-- GIDEROSCST:FontBase.TLF_LEFT TLF_LEFT -->
−
[[Special:MyLanguage/FontBase.TLF_REF_DESCENT|FontBase.TLF_REF_DESCENT]]<br/><!-- GIDEROSCST:FontBase.TLF_REF_DESCENT TLF_REF_DESCENT-->
+
[[Special:MyLanguage/FontBase.TLF_LTR|FontBase.TLF_LTR]]<br/>
−
[[Special:MyLanguage/FontBase.TLF_REF_MEDIAN|FontBase.TLF_REF_MEDIAN]]<br/><!-- GIDEROSCST:FontBase.TLF_REF_MEDIAN TLF_REF_MEDIAN-->
+
<!-- GIDEROSCST:FontBase.TLF_LTR TLF_LTR -->
−
[[Special:MyLanguage/FontBase.TLF_REF_TOP|FontBase.TLF_REF_TOP]]<br/><!-- GIDEROSCST:FontBase.TLF_REF_TOP TLF_REF_TOP-->
+
[[Special:MyLanguage/FontBase.TLF_NOBIDI|FontBase.TLF_NOBIDI]]<br/>
−
[[Special:MyLanguage/FontBase.TLF_RIGHT|FontBase.TLF_RIGHT]]<br/><!-- GIDEROSCST:FontBase.TLF_RIGHT TLF_RIGHT-->
+
<!-- GIDEROSCST:FontBase.TLF_NOBIDI TLF_NOBIDI -->
−
[[Special:MyLanguage/FontBase.TLF_TOP|FontBase.TLF_TOP]]<br/><!-- GIDEROSCST:FontBase.TLF_TOP TLF_TOP-->
+
[[Special:MyLanguage/FontBase.TLF_NOSHAPING|FontBase.TLF_NOSHAPING]]<br/>
−
[[Special:MyLanguage/FontBase.TLF_VCENTER|FontBase.TLF_VCENTER]]<br/><!-- GIDEROSCST:FontBase.TLF_VCENTER TLF_VCENTER-->
+
<!-- GIDEROSCST:FontBase.TLF_NOSHAPING TLF_NOSHAPING -->
−
[[Special:MyLanguage/FontBase.TLF_RTL|FontBase.TLF_RTL]]<br/><!-- GIDEROSCST:FontBase.TLF_RTL TLF_RTL-->
+
[[Special:MyLanguage/FontBase.TLF_NOWRAP|FontBase.TLF_NOWRAP]]<br/>
−
[[Special:MyLanguage/FontBase.TLF_LTR|FontBase.TLF_LTR]]<br/><!-- GIDEROSCST:FontBase.TLF_LTR TLF_LTR-->
+
<!-- GIDEROSCST:FontBase.TLF_NOWRAP TLF_NOWRAP -->
−
[[Special:MyLanguage/FontBase.TLF_NOBIDI|FontBase.TLF_NOBIDI]]<br/><!-- GIDEROSCST:FontBase.TLF_NOBIDI TLF_NOBIDI-->
+
[[Special:MyLanguage/FontBase.TLF_REF_ASCENT|FontBase.TLF_REF_ASCENT]]<br/>
−
[[Special:MyLanguage/FontBase.TLF_NOSHAPING|FontBase.TLF_NOSHAPING]]<br/><!-- GIDEROSCST:FontBase.TLF_NOSHAPING TLF_NOSHAPING-->
+
<!-- GIDEROSCST:FontBase.TLF_REF_ASCENT TLF_REF_ASCENT -->
 +
[[Special:MyLanguage/FontBase.TLF_REF_BASELINE|FontBase.TLF_REF_BASELINE]]<br/>
 +
<!-- GIDEROSCST:FontBase.TLF_REF_BASELINE TLF_REF_BASELINE -->
 +
[[Special:MyLanguage/FontBase.TLF_REF_BOTTOM|FontBase.TLF_REF_BOTTOM]]<br/>
 +
<!-- GIDEROSCST:FontBase.TLF_REF_BOTTOM TLF_REF_BOTTOM -->
 +
[[Special:MyLanguage/FontBase.TLF_REF_DESCENT|FontBase.TLF_REF_DESCENT]]<br/>
 +
<!-- GIDEROSCST:FontBase.TLF_REF_DESCENT TLF_REF_DESCENT -->
 +
[[Special:MyLanguage/FontBase.TLF_REF_MEDIAN|FontBase.TLF_REF_MEDIAN]]<br/>
 +
<!-- GIDEROSCST:FontBase.TLF_REF_MEDIAN TLF_REF_MEDIAN -->
 +
[[Special:MyLanguage/FontBase.TLF_REF_MIDDLE|FontBase.TLF_REF_MIDDLE]]<br/>
 +
<!-- GIDEROSCST:FontBase.TLF_REF_MIDDLE TLF_REF_MIDDLE -->
 +
[[Special:MyLanguage/FontBase.TLF_REF_TOP|FontBase.TLF_REF_TOP]]<br/>
 +
<!-- GIDEROSCST:FontBase.TLF_REF_TOP TLF_REF_TOP -->
 +
[[Special:MyLanguage/FontBase.TLF_RIGHT|FontBase.TLF_RIGHT]]<br/>
 +
<!-- GIDEROSCST:FontBase.TLF_RIGHT TLF_RIGHT -->
 +
[[Special:MyLanguage/FontBase.TLF_RTL|FontBase.TLF_RTL]]<br/>
 +
<!-- GIDEROSCST:FontBase.TLF_RTL TLF_RTL -->
 +
[[Special:MyLanguage/FontBase.TLF_TOP|FontBase.TLF_TOP]]<br/>
 +
<!-- GIDEROSCST:FontBase.TLF_TOP TLF_TOP -->
 +
[[Special:MyLanguage/FontBase.TLF_VCENTER|FontBase.TLF_VCENTER]]<br/>
 +
<!-- GIDEROSCST:FontBase.TLF_VCENTER TLF_VCENTER -->
 
|}
 
|}

Revision as of 23:58, 4 January 2020


Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
Available since: Gideros 2011.6
Inherits from: Object

Description

FontBase is the base class for Font and TTFont classes.

Methods

FontBase:getAdvanceX returns the width of the first character
FontBase:getAscender returns the ascender of the font
FontBase:getBounds returns the tight bounding rectangle of the characters in the string specified by text
FontBase:getCharIndexAtOffset returns the offset within the given text string
FontBase:getLineHeight returns the distance from one base line to the next
FontBase:layoutText computes the text layout with given constraints

Events

Constants

FontBase.TLF_BOTTOM
FontBase.TLF_BREAKWORDS
FontBase.TLF_CENTER
FontBase.TLF_JUSTIFIED
FontBase.TLF_LEFT
FontBase.TLF_LTR
FontBase.TLF_NOBIDI
FontBase.TLF_NOSHAPING
FontBase.TLF_NOWRAP
FontBase.TLF_REF_ASCENT
FontBase.TLF_REF_BASELINE
FontBase.TLF_REF_BOTTOM
FontBase.TLF_REF_DESCENT
FontBase.TLF_REF_MEDIAN
FontBase.TLF_REF_MIDDLE
FontBase.TLF_REF_TOP
FontBase.TLF_RIGHT
FontBase.TLF_RTL
FontBase.TLF_TOP
FontBase.TLF_VCENTER

Retrieved from ‘https://wiki.gideros.rocks/index.php?title=FontBase&oldid=15230’