<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>FIFE: FIFE::Key Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.4 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">FIFE <span id="projectnumber">2008.0</span></div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('class_f_i_f_e_1_1_key.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">FIFE::Key Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="FIFE::Key" --> <p><code>#include <<a class="el" href="ec__key_8h_source.html">ec_key.h</a>></code></p> <p><a href="class_f_i_f_e_1_1_key-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-types"></a> Public Types</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_key.html#a9e00d13095d00184a28863ade8bd6f13">KeyType</a> </td></tr> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_key.html#a5d4b68ae4199fbe4682a9f0b40bd1983">Key</a> (<a class="el" href="class_f_i_f_e_1_1_key.html#a9e00d13095d00184a28863ade8bd6f13">KeyType</a> key=INVALID_KEY, uint32_t codepoint=0)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_key.html#aa289e4664b7dacbe899e5f06e36eabe8">~Key</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_key.html#a5669374ddfd87d990ef7fc2855d2917f">isPrintable</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_f_i_f_e_1_1_key.html#a9e00d13095d00184a28863ade8bd6f13">KeyType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_key.html#aedd22edaae54dcd3ae6fcf5a211206a1">getValue</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_key.html#add1d7fab4315e556fd07867c5452d5af">getAsString</a> () const </td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Represents a key or a character. </p> <p>Definition at line <a class="el" href="ec__key_8h_source.html#l00041">41</a> of file <a class="el" href="ec__key_8h_source.html">ec_key.h</a>.</p> </div><hr/><h2>Member Enumeration Documentation</h2> <a class="anchor" id="a9e00d13095d00184a28863ade8bd6f13"></a><!-- doxytag: member="FIFE::Key::KeyType" ref="a9e00d13095d00184a28863ade8bd6f13" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="class_f_i_f_e_1_1_key.html#a9e00d13095d00184a28863ade8bd6f13">FIFE::Key::KeyType</a></td> </tr> </table> </div> <div class="memdoc"> <p>Codes for different keys </p> <p>Definition at line <a class="el" href="ec__key_8h_source.html#l00045">45</a> of file <a class="el" href="ec__key_8h_source.html">ec_key.h</a>.</p> </div> </div> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a5d4b68ae4199fbe4682a9f0b40bd1983"></a><!-- doxytag: member="FIFE::Key::Key" ref="a5d4b68ae4199fbe4682a9f0b40bd1983" args="(KeyType key=INVALID_KEY, uint32_t codepoint=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">FIFE::Key::Key </td> <td>(</td> <td class="paramtype"><a class="el" href="class_f_i_f_e_1_1_key.html#a9e00d13095d00184a28863ade8bd6f13">KeyType</a> </td> <td class="paramname"><em>key</em> = <code>INVALID_KEY</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>codepoint</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">value</td><td>value of the key </td></tr> <tr><td class="paramname">codepoint</td><td>Unicode representation of the key </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="ec__key_8h_source.html#l00284">284</a> of file <a class="el" href="ec__key_8h_source.html">ec_key.h</a>.</p> </div> </div> <a class="anchor" id="aa289e4664b7dacbe899e5f06e36eabe8"></a><!-- doxytag: member="FIFE::Key::~Key" ref="aa289e4664b7dacbe899e5f06e36eabe8" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual FIFE::Key::~Key </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Destructor. </p> <p>Definition at line <a class="el" href="ec__key_8h_source.html#l00290">290</a> of file <a class="el" href="ec__key_8h_source.html">ec_key.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="add1d7fab4315e556fd07867c5452d5af"></a><!-- doxytag: member="FIFE::Key::getAsString" ref="add1d7fab4315e556fd07867c5452d5af" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string FIFE::Key::getAsString </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Gets the string representation of the key, encoded as UTF-8. </p> <p>Definition at line <a class="el" href="ec__key_8h_source.html#l00311">311</a> of file <a class="el" href="ec__key_8h_source.html">ec_key.h</a>.</p> </div> </div> <a class="anchor" id="aedd22edaae54dcd3ae6fcf5a211206a1"></a><!-- doxytag: member="FIFE::Key::getValue" ref="aedd22edaae54dcd3ae6fcf5a211206a1" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_f_i_f_e_1_1_key.html#a9e00d13095d00184a28863ade8bd6f13">KeyType</a> FIFE::Key::getValue </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Gets the value of the key. </p> <p>Definition at line <a class="el" href="ec__key_8h_source.html#l00305">305</a> of file <a class="el" href="ec__key_8h_source.html">ec_key.h</a>.</p> </div> </div> <a class="anchor" id="a5669374ddfd87d990ef7fc2855d2917f"></a><!-- doxytag: member="FIFE::Key::isPrintable" ref="a5669374ddfd87d990ef7fc2855d2917f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool FIFE::Key::isPrintable </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Tells whether the <a class="el" href="class_f_i_f_e_1_1_key.html">Key</a> can be represented as a string. </p> <p>Definition at line <a class="el" href="ec__key_8h_source.html#l00294">294</a> of file <a class="el" href="ec__key_8h_source.html">ec_key.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>engine/core/eventchannel/key/<a class="el" href="ec__key_8h_source.html">ec_key.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespace_f_i_f_e.html">FIFE</a> </li> <li class="navelem"><a class="el" href="class_f_i_f_e_1_1_key.html">Key</a> </li> <li class="footer">Generated on Sun Jul 10 2011 for FIFE by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </body> </html>