diff options
Diffstat (limited to 'docs/html/class_allegro_keyboard_init.html')
-rw-r--r-- | docs/html/class_allegro_keyboard_init.html | 247 |
1 files changed, 247 insertions, 0 deletions
diff --git a/docs/html/class_allegro_keyboard_init.html b/docs/html/class_allegro_keyboard_init.html new file mode 100644 index 0000000..da380c1 --- /dev/null +++ b/docs/html/class_allegro_keyboard_init.html @@ -0,0 +1,247 @@ +<!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>Rally X: AllegroKeyboardInit Class Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> + +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + <td id="projectlogo"><img alt="Logo" src="car.PNG"/></td> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">Rally X + + </div> + <div id="projectbrief">ELEN3009 Project by Justin Wernick and David Schneider</div> + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</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> + <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="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pri-attribs">Private Attributes</a> | +<a href="#pri-static-attribs">Static Private Attributes</a> </div> + <div class="headertitle"> +<div class="title">AllegroKeyboardInit Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="AllegroKeyboardInit" --> +<p>Class ensures that Allegro's keyboard is installed and uninstalled when appropriate. + <a href="class_allegro_keyboard_init.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_allegro_wrappers_8h_source.html">AllegroWrappers.h</a>></code></p> + +<p><a href="class_allegro_keyboard_init-members.html">List of all members.</a></p> +<table class="memberdecls"> +<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_allegro_keyboard_init.html#a42fce2d97b6b7c0c0c666d0f5804a45e">AllegroKeyboardInit</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor calls al_install_keyboard() if it is the first instance. <a href="#a42fce2d97b6b7c0c0c666d0f5804a45e"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allegro_keyboard_init.html#ae28cb5cbafdba3372f21ddb95a9ed134">AllegroKeyboardInit</a> (const <a class="el" href="class_allegro_keyboard_init.html">AllegroKeyboardInit</a> &ref)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor, implemented to be included in instance count. <a href="#ae28cb5cbafdba3372f21ddb95a9ed134"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allegro_keyboard_init.html#a7d1b1cda1d2220ad522ee955ba8a2c5d">~AllegroKeyboardInit</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor calls al_uninstall_keyboard() if it is the last instant. <a href="#a7d1b1cda1d2220ad522ee955ba8a2c5d"></a><br/></td></tr> +<tr><td colspan="2"><h2><a name="pri-attribs"></a> +Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_allegro_init.html">AllegroInit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allegro_keyboard_init.html#af8655fcd2e20750f965e55304500bc3b">_allegro</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Depends on Allegro being initialised. <a href="#af8655fcd2e20750f965e55304500bc3b"></a><br/></td></tr> +<tr><td colspan="2"><h2><a name="pri-static-attribs"></a> +Static Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_allegro_keyboard_init.html#ac7f75bcc5cb56a1c2f4e9ce653d9dfd7">_initCount</a> = 0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Count of the current number of initialised <a class="el" href="class_allegro_keyboard_init.html" title="Class ensures that Allegro's keyboard is installed and uninstalled when appropriate.">AllegroKeyboardInit</a> objects. <a href="#ac7f75bcc5cb56a1c2f4e9ce653d9dfd7"></a><br/></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><p>Class ensures that Allegro's keyboard is installed and uninstalled when appropriate. </p> +<p>Any classes that use the keyboard for input should include this class as a data member. This class includes <a class="el" href="class_allegro_init.html" title="Class ensures that Allegro is initialized and uninstalled when appropriate.">AllegroInit</a>, so both of them do not need to be included.</p> +<dl class="author"><dt><b>Author:</b></dt><dd>Justin Wernick </dd> +<dd> +David Schneider </dd></dl> + +<p>Definition at line <a class="el" href="_allegro_wrappers_8h_source.html#l00057">57</a> of file <a class="el" href="_allegro_wrappers_8h_source.html">AllegroWrappers.h</a>.</p> +</div><hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a42fce2d97b6b7c0c0c666d0f5804a45e"></a><!-- doxytag: member="AllegroKeyboardInit::AllegroKeyboardInit" ref="a42fce2d97b6b7c0c0c666d0f5804a45e" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">AllegroKeyboardInit::AllegroKeyboardInit </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Constructor calls al_install_keyboard() if it is the first instance. </p> + +<p>Definition at line <a class="el" href="_allegro_wrappers_8cpp_source.html#l00041">41</a> of file <a class="el" href="_allegro_wrappers_8cpp_source.html">AllegroWrappers.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="ae28cb5cbafdba3372f21ddb95a9ed134"></a><!-- doxytag: member="AllegroKeyboardInit::AllegroKeyboardInit" ref="ae28cb5cbafdba3372f21ddb95a9ed134" args="(const AllegroKeyboardInit &ref)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">AllegroKeyboardInit::AllegroKeyboardInit </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_allegro_keyboard_init.html">AllegroKeyboardInit</a> & </td> + <td class="paramname"><em>ref</em></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Copy constructor, implemented to be included in instance count. </p> + +<p>Definition at line <a class="el" href="_allegro_wrappers_8cpp_source.html#l00053">53</a> of file <a class="el" href="_allegro_wrappers_8cpp_source.html">AllegroWrappers.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a7d1b1cda1d2220ad522ee955ba8a2c5d"></a><!-- doxytag: member="AllegroKeyboardInit::~AllegroKeyboardInit" ref="a7d1b1cda1d2220ad522ee955ba8a2c5d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">AllegroKeyboardInit::~AllegroKeyboardInit </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Destructor calls al_uninstall_keyboard() if it is the last instant. </p> + +<p>Definition at line <a class="el" href="_allegro_wrappers_8cpp_source.html#l00065">65</a> of file <a class="el" href="_allegro_wrappers_8cpp_source.html">AllegroWrappers.cpp</a>.</p> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="af8655fcd2e20750f965e55304500bc3b"></a><!-- doxytag: member="AllegroKeyboardInit::_allegro" ref="af8655fcd2e20750f965e55304500bc3b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_allegro_init.html">AllegroInit</a> <a class="el" href="class_allegro_keyboard_init.html#af8655fcd2e20750f965e55304500bc3b">AllegroKeyboardInit::_allegro</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Depends on Allegro being initialised. </p> + +<p>Definition at line <a class="el" href="_allegro_wrappers_8h_source.html#l00074">74</a> of file <a class="el" href="_allegro_wrappers_8h_source.html">AllegroWrappers.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ac7f75bcc5cb56a1c2f4e9ce653d9dfd7"></a><!-- doxytag: member="AllegroKeyboardInit::_initCount" ref="ac7f75bcc5cb56a1c2f4e9ce653d9dfd7" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="class_allegro_keyboard_init.html#ac7f75bcc5cb56a1c2f4e9ce653d9dfd7">AllegroKeyboardInit::_initCount</a> = 0<code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Count of the current number of initialised <a class="el" href="class_allegro_keyboard_init.html" title="Class ensures that Allegro's keyboard is installed and uninstalled when appropriate.">AllegroKeyboardInit</a> objects. </p> + +<p>Definition at line <a class="el" href="_allegro_wrappers_8h_source.html#l00073">73</a> of file <a class="el" href="_allegro_wrappers_8h_source.html">AllegroWrappers.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>source/logic/<a class="el" href="_allegro_wrappers_8h_source.html">AllegroWrappers.h</a></li> +<li>source/logic/<a class="el" href="_allegro_wrappers_8cpp_source.html">AllegroWrappers.cpp</a></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>Files</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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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> + + + +<hr class="footer"/><address class="footer"><small> +Generated on Wed Oct 5 2011 20:08:31 for Rally X by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.7.5.1 +</small></address> + +</body> +</html> |