| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
| <title>FTGL: FTCharmap class Reference</title> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"> |
| </head><body> |
| <!-- Generated by Doxygen 1.3.6 --> |
| <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> |
| <h1>FTCharmap Class Reference</h1><code>#include <<a class="el" href="FTCharmap_8h-source.html">FTCharmap.h</a>></code> |
| <p> |
| <table border=0 cellpadding=0 cellspacing=0> |
| <tr><td></td></tr> |
| <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFTCharmap.html#a0">FTCharmap</a> (<a class="el" href="classFTFace.html">FTFace</a> *face)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a0"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classFTCharmap.html#a1">~FTCharmap</a> ()</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a1"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>FT_Encoding </td><td class="memItemRight" valign=bottom><a class="el" href="classFTCharmap.html#a2">Encoding</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Queries for the current character map code. <a href="#a2"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classFTCharmap.html#a3">CharMap</a> (FT_Encoding encoding)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the character map for the face. <a href="#a3"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="classFTCharmap.html#a4">GlyphListIndex</a> (const unsigned int characterCode)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classFTGlyphContainer.html">FTGlyphContainer</a> index of the input character. <a href="#a4"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="classFTCharmap.html#a5">FontIndex</a> (const unsigned int characterCode)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the font glyph index of the input character. <a href="#a5"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFTCharmap.html#a6">InsertIndex</a> (const unsigned int characterCode, const unsigned int containerIndex)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classFTGlyphContainer.html">FTGlyphContainer</a> index of the character code. <a href="#a6"></a><br><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>FT_Error </td><td class="memItemRight" valign=bottom><a class="el" href="classFTCharmap.html#a7">Error</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Queries for errors. <a href="#a7"></a><br><br></td></tr> |
| </table> |
| <hr><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" name="a0" doxytag="FTCharmap::FTCharmap" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> FTCharmap::FTCharmap </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top"><a class="el" href="classFTFace.html">FTFace</a> * </td> |
| <td class="mdname1" valign="top" nowrap> <em>face</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Constructor. |
| <p> |
| |
| <p> |
| Definition at line <a class="el" href="FTCharmap_8cpp-source.html#l00005">5</a> of file <a class="el" href="FTCharmap_8cpp-source.html">FTCharmap.cpp</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a1" doxytag="FTCharmap::~FTCharmap" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> FTCharmap::~<a class="el" href="classFTCharmap.html">FTCharmap</a> </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Destructor. |
| <p> |
| |
| <p> |
| Definition at line <a class="el" href="FTCharmap_8cpp-source.html#l00018">18</a> of file <a class="el" href="FTCharmap_8cpp-source.html">FTCharmap.cpp</a>. |
| <p> |
| References <a class="el" href="FTCharToGlyphIndexMap_8h-source.html#l00059">FTCharToGlyphIndexMap::clear()</a>. </td> |
| </tr> |
| </table> |
| <hr><h2>Member Function Documentation</h2> |
| <a class="anchor" name="a3" doxytag="FTCharmap::CharMap" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> bool FTCharmap::CharMap </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">FT_Encoding </td> |
| <td class="mdname1" valign="top" nowrap> <em>encoding</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Sets the character map for the face. |
| <p> |
| Valid encodings as at Freetype 2.0.4 ft_encoding_none ft_encoding_symbol ft_encoding_unicode ft_encoding_latin_2 ft_encoding_sjis ft_encoding_gb2312 ft_encoding_big5 ft_encoding_wansung ft_encoding_johab ft_encoding_adobe_standard ft_encoding_adobe_expert ft_encoding_adobe_custom ft_encoding_apple_roman<p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>encoding</em> </td><td>the Freetype encoding symbol. See above. </td></tr> |
| </table> |
| </dl> |
| <dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if charmap was valid and set correctly. If the requested encoding is unavailable it will be set to ft_encoding_none. </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTCharmap_8cpp-source.html#l00024">24</a> of file <a class="el" href="FTCharmap_8cpp-source.html">FTCharmap.cpp</a>. |
| <p> |
| References <a class="el" href="FTCharToGlyphIndexMap_8h-source.html#l00059">FTCharToGlyphIndexMap::clear()</a>. |
| <p> |
| Referenced by <a class="el" href="FTGlyphContainer_8cpp-source.html#l00029">FTGlyphContainer::CharMap()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a2" doxytag="FTCharmap::Encoding" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> FT_Encoding FTCharmap::Encoding </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Queries for the current character map code. |
| <p> |
| <dl compact><dt><b>Returns:</b></dt><dd>The current character map code. </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTCharmap_8h-source.html#l00047">47</a> of file <a class="el" href="FTCharmap_8h-source.html">FTCharmap.h</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a7" doxytag="FTCharmap::Error" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> FT_Error FTCharmap::Error </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Queries for errors. |
| <p> |
| <dl compact><dt><b>Returns:</b></dt><dd>The current error code. Zero means no error. </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTCharmap_8h-source.html#l00107">107</a> of file <a class="el" href="FTCharmap_8h-source.html">FTCharmap.h</a>. |
| <p> |
| Referenced by <a class="el" href="FTGlyphContainer_8cpp-source.html#l00029">FTGlyphContainer::CharMap()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a5" doxytag="FTCharmap::FontIndex" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> unsigned int FTCharmap::FontIndex </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const unsigned int </td> |
| <td class="mdname1" valign="top" nowrap> <em>characterCode</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Get the font glyph index of the input character. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>characterCode</em> </td><td>The character code of the requested glyph in the current encoding eg apple roman. </td></tr> |
| </table> |
| </dl> |
| <dl compact><dt><b>Returns:</b></dt><dd>The glyph index for the character. </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTCharmap_8cpp-source.html#l00053">53</a> of file <a class="el" href="FTCharmap_8cpp-source.html">FTCharmap.cpp</a>. |
| <p> |
| Referenced by <a class="el" href="FTGlyphContainer_8cpp-source.html#l00063">FTGlyphContainer::Advance()</a>, <a class="el" href="FTGlyphContainer_8cpp-source.html#l00037">FTGlyphContainer::FontIndex()</a>, and <a class="el" href="FTGlyphContainer_8cpp-source.html#l00075">FTGlyphContainer::Render()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a4" doxytag="FTCharmap::GlyphListIndex" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> unsigned int FTCharmap::GlyphListIndex </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const unsigned int </td> |
| <td class="mdname1" valign="top" nowrap> <em>characterCode</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Get the <a class="el" href="classFTGlyphContainer.html">FTGlyphContainer</a> index of the input character. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>characterCode</em> </td><td>The character code of the requested glyph in the current encoding eg apple roman. </td></tr> |
| </table> |
| </dl> |
| <dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="classFTGlyphContainer.html">FTGlyphContainer</a> index for the character or zero if it wasn't found </dd></dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTCharmap_8cpp-source.html#l00047">47</a> of file <a class="el" href="FTCharmap_8cpp-source.html">FTCharmap.cpp</a>. |
| <p> |
| References <a class="el" href="FTCharToGlyphIndexMap_8h-source.html#l00074">FTCharToGlyphIndexMap::find()</a>. |
| <p> |
| Referenced by <a class="el" href="FTGlyphContainer_8cpp-source.html#l00063">FTGlyphContainer::Advance()</a>, <a class="el" href="FTGlyphContainer_8cpp-source.html#l00057">FTGlyphContainer::BBox()</a>, <a class="el" href="FTGlyphContainer_8cpp-source.html#l00050">FTGlyphContainer::Glyph()</a>, and <a class="el" href="FTGlyphContainer_8cpp-source.html#l00075">FTGlyphContainer::Render()</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a6" doxytag="FTCharmap::InsertIndex" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void FTCharmap::InsertIndex </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const unsigned int </td> |
| <td class="mdname" nowrap> <em>characterCode</em>, </td> |
| </tr> |
| <tr> |
| <td class="md" nowrap align="right"></td> |
| <td></td> |
| <td class="md" nowrap>const unsigned int </td> |
| <td class="mdname" nowrap> <em>containerIndex</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Set the <a class="el" href="classFTGlyphContainer.html">FTGlyphContainer</a> index of the character code. |
| <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>characterCode</em> </td><td>The character code of the requested glyph in the current encoding eg apple roman. </td></tr> |
| <tr><td valign=top><em>containerIndex</em> </td><td>The index into the <a class="el" href="classFTGlyphContainer.html">FTGlyphContainer</a> of the character code. </td></tr> |
| </table> |
| </dl> |
| |
| <p> |
| Definition at line <a class="el" href="FTCharmap_8cpp-source.html#l00059">59</a> of file <a class="el" href="FTCharmap_8cpp-source.html">FTCharmap.cpp</a>. |
| <p> |
| References <a class="el" href="FTCharToGlyphIndexMap_8h-source.html#l00098">FTCharToGlyphIndexMap::insert()</a>. |
| <p> |
| Referenced by <a class="el" href="FTGlyphContainer_8cpp-source.html#l00043">FTGlyphContainer::Add()</a>. </td> |
| </tr> |
| </table> |
| <hr>The documentation for this class was generated from the following files:<ul> |
| <li><a class="el" href="FTCharmap_8h-source.html">FTCharmap.h</a><li><a class="el" href="FTCharmap_8cpp-source.html">FTCharmap.cpp</a></ul> |
| <hr size="1"><address style="align: right;"><small>Generated on Sun Dec 5 22:24:06 2004 for FTGL by |
| <a href="http://www.doxygen.org/index.html"> |
| <img src="doxygen.png" alt="doxygen" align="middle" border=0 > |
| </a>1.3.6 </small></address> |
| </body> |
| </html> |