TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: AndroidFont Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_android_font-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">AndroidFont Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;AndroidFont.h&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for AndroidFont:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="class_android_font.png" usemap="#AndroidFont_map" alt=""/>
  <map id="AndroidFont_map" name="AndroidFont_map">
<area href="class_platform_font.html" alt="PlatformFont" shape="rect" coords="0,0,83,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac0d288821aa73ed6f6cf9ab672177a85" id="r_ac0d288821aa73ed6f6cf9ab672177a85"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_android_font.html#ac0d288821aa73ed6f6cf9ab672177a85">AndroidFont</a> ()</td></tr>
<tr class="separator:ac0d288821aa73ed6f6cf9ab672177a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeccc956d3c8b13360249dcab7f6afa34" id="r_aeccc956d3c8b13360249dcab7f6afa34"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_android_font.html#aeccc956d3c8b13360249dcab7f6afa34">~AndroidFont</a> ()</td></tr>
<tr class="separator:aeccc956d3c8b13360249dcab7f6afa34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae50bc1c88c917edd4d502caf35f2cae7" id="r_ae50bc1c88c917edd4d502caf35f2cae7"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_android_font.html#ae50bc1c88c917edd4d502caf35f2cae7">create</a> (const char *name, U32 size, U32 charset=TGE_ANSI_CHARSET)</td></tr>
<tr class="memdesc:ae50bc1c88c917edd4d502caf35f2cae7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Look up the requested font, cache style, layout, colorspace, and some metrics.  <br /></td></tr>
<tr class="separator:ae50bc1c88c917edd4d502caf35f2cae7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b7b7f04438b493bd30ca4cac578564a" id="r_a6b7b7f04438b493bd30ca4cac578564a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_android_font.html#a6b7b7f04438b493bd30ca4cac578564a">isValidChar</a> (const UTF16 character) const</td></tr>
<tr class="memdesc:a6b7b7f04438b493bd30ca4cac578564a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine if the character requested is a drawable character, or if it should be ignored.  <br /></td></tr>
<tr class="separator:a6b7b7f04438b493bd30ca4cac578564a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a880869f1f02f85ba6671ad318b18b04b" id="r_a880869f1f02f85ba6671ad318b18b04b"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_android_font.html#a880869f1f02f85ba6671ad318b18b04b">isValidChar</a> (const UTF8 *str) const</td></tr>
<tr class="separator:a880869f1f02f85ba6671ad318b18b04b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af98f40d08ef0479c305f8213523d42e3" id="r_af98f40d08ef0479c305f8213523d42e3"><td class="memItemLeft" align="right" valign="top">virtual U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_android_font.html#af98f40d08ef0479c305f8213523d42e3">getFontHeight</a> () const</td></tr>
<tr class="memdesc:af98f40d08ef0479c305f8213523d42e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get some vertical data on the font at large. Useful for drawing multiline text, and sizing text boxes.  <br /></td></tr>
<tr class="separator:af98f40d08ef0479c305f8213523d42e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6ba2408f88da00fa98369ef0ab87f12" id="r_ab6ba2408f88da00fa98369ef0ab87f12"><td class="memItemLeft" align="right" valign="top">virtual U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_android_font.html#ab6ba2408f88da00fa98369ef0ab87f12">getFontBaseLine</a> () const</td></tr>
<tr class="separator:ab6ba2408f88da00fa98369ef0ab87f12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e7221f52fe57ee8f8e69ab85be1f000" id="r_a4e7221f52fe57ee8f8e69ab85be1f000"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="struct_platform_font_1_1_char_info.html">PlatformFont::CharInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_android_font.html#a4e7221f52fe57ee8f8e69ab85be1f000">getCharInfo</a> (const UTF16 character) const</td></tr>
<tr class="separator:a4e7221f52fe57ee8f8e69ab85be1f000"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add01ec134ba8e62dadc05405b385794b" id="r_add01ec134ba8e62dadc05405b385794b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="struct_platform_font_1_1_char_info.html">PlatformFont::CharInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_android_font.html#add01ec134ba8e62dadc05405b385794b">getCharInfo</a> (const UTF8 *str) const</td></tr>
<tr class="separator:add01ec134ba8e62dadc05405b385794b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_platform_font"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_platform_font')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_platform_font.html">PlatformFont</a></td></tr>
<tr class="memitem:ad191ae01c89172389dd139029d9dd8e5 inherit pub_methods_class_platform_font" id="r_ad191ae01c89172389dd139029d9dd8e5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_platform_font.html#ad191ae01c89172389dd139029d9dd8e5">PlatformFont</a> ()</td></tr>
<tr class="separator:ad191ae01c89172389dd139029d9dd8e5 inherit pub_methods_class_platform_font"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d691ddd248e50c77f10924d1c00fd9c inherit pub_methods_class_platform_font" id="r_a6d691ddd248e50c77f10924d1c00fd9c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_platform_font.html#a6d691ddd248e50c77f10924d1c00fd9c">~PlatformFont</a> ()</td></tr>
<tr class="separator:a6d691ddd248e50c77f10924d1c00fd9c inherit pub_methods_class_platform_font"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_class_platform_font"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_platform_font')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="class_platform_font.html">PlatformFont</a></td></tr>
<tr class="memitem:a2fe4feb16d8d28337f20e4ae71a8d75c inherit pub_static_methods_class_platform_font" id="r_a2fe4feb16d8d28337f20e4ae71a8d75c"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_platform_font.html#a2fe4feb16d8d28337f20e4ae71a8d75c">enumeratePlatformFonts</a> (<a class="el" href="class_vector.html">Vector</a>&lt; StringTableEntry &gt; &amp;fonts)</td></tr>
<tr class="separator:a2fe4feb16d8d28337f20e4ae71a8d75c inherit pub_static_methods_class_platform_font"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac0d288821aa73ed6f6cf9ab672177a85" name="ac0d288821aa73ed6f6cf9ab672177a85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0d288821aa73ed6f6cf9ab672177a85">&#9670;&#160;</a></span>AndroidFont()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_android_font.html">AndroidFont</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aeccc956d3c8b13360249dcab7f6afa34" name="aeccc956d3c8b13360249dcab7f6afa34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeccc956d3c8b13360249dcab7f6afa34">&#9670;&#160;</a></span>~AndroidFont()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="class_android_font.html">AndroidFont</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae50bc1c88c917edd4d502caf35f2cae7" name="ae50bc1c88c917edd4d502caf35f2cae7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae50bc1c88c917edd4d502caf35f2cae7">&#9670;&#160;</a></span>create()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool create </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>charset</em> = <code>TGE_ANSI_CHARSET</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Look up the requested font, cache style, layout, colorspace, and some metrics. </p>

<p>Implements <a class="el" href="class_platform_font.html#a612ed67d6729185096c61f624f88a2fe">PlatformFont</a>.</p>

</div>
</div>
<a id="a4e7221f52fe57ee8f8e69ab85be1f000" name="a4e7221f52fe57ee8f8e69ab85be1f000"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e7221f52fe57ee8f8e69ab85be1f000">&#9670;&#160;</a></span>getCharInfo() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_platform_font_1_1_char_info.html">PlatformFont::CharInfo</a> &amp; getCharInfo </td>
          <td>(</td>
          <td class="paramtype">const UTF16&#160;</td>
          <td class="paramname"><em>character</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="class_platform_font.html#aaaf8ad1067ad15500e9a8d152e3b1112">PlatformFont</a>.</p>

</div>
</div>
<a id="add01ec134ba8e62dadc05405b385794b" name="add01ec134ba8e62dadc05405b385794b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add01ec134ba8e62dadc05405b385794b">&#9670;&#160;</a></span>getCharInfo() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_platform_font_1_1_char_info.html">PlatformFont::CharInfo</a> &amp; getCharInfo </td>
          <td>(</td>
          <td class="paramtype">const UTF8 *&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="class_platform_font.html#a67608b1b41e1954f2f9395d5f762f9d5">PlatformFont</a>.</p>

</div>
</div>
<a id="ab6ba2408f88da00fa98369ef0ab87f12" name="ab6ba2408f88da00fa98369ef0ab87f12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6ba2408f88da00fa98369ef0ab87f12">&#9670;&#160;</a></span>getFontBaseLine()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual U32 getFontBaseLine </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="class_platform_font.html#ae57c22112cf12eca6bc5284fbff62560">PlatformFont</a>.</p>

</div>
</div>
<a id="af98f40d08ef0479c305f8213523d42e3" name="af98f40d08ef0479c305f8213523d42e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af98f40d08ef0479c305f8213523d42e3">&#9670;&#160;</a></span>getFontHeight()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual U32 getFontHeight </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get some vertical data on the font at large. Useful for drawing multiline text, and sizing text boxes. </p>

<p>Implements <a class="el" href="class_platform_font.html#a4a582c8e0b92dbb3e8d23e93f9ff0da6">PlatformFont</a>.</p>

</div>
</div>
<a id="a6b7b7f04438b493bd30ca4cac578564a" name="a6b7b7f04438b493bd30ca4cac578564a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b7b7f04438b493bd30ca4cac578564a">&#9670;&#160;</a></span>isValidChar() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool isValidChar </td>
          <td>(</td>
          <td class="paramtype">const UTF16&#160;</td>
          <td class="paramname"><em>character</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Determine if the character requested is a drawable character, or if it should be ignored. </p>

<p>Implements <a class="el" href="class_platform_font.html#aa44009cf2e946b6dbddc3d43c7d57809">PlatformFont</a>.</p>

</div>
</div>
<a id="a880869f1f02f85ba6671ad318b18b04b" name="a880869f1f02f85ba6671ad318b18b04b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a880869f1f02f85ba6671ad318b18b04b">&#9670;&#160;</a></span>isValidChar() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool isValidChar </td>
          <td>(</td>
          <td class="paramtype">const UTF8 *&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="class_platform_font.html#ad79e9ec7d7fbedbed5191edd14a9e344">PlatformFont</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>platformAndroid/<b>AndroidFont.h</b></li>
<li>platformAndroid/<b>AndroidFont.cpp</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>