maj/OpenArena
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

*** empty log message ***

Browse Source
This commit is contained in:
Tom Hicks
2006-07-19 00:03:26 -04:00
parent 6d640f3148
commit fdc4f9e0ce
177 changed files with 679 additions and 951 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
doc/html/class_open_arena_1_1_control_scheme.html
View File

@@ -20,7 +20,7 @@
</ul></div>
<div class="nav">
<a class="el" href="namespace_open_arena.html">OpenArena</a>::<a class="el" href="class_open_arena_1_1_control_scheme.html">ControlScheme</a></div>
<h1>OpenArena::ControlScheme Class Reference</h1><!-- doxytag: class="OpenArena::ControlScheme" -->Write brief comment for <a class="el" href="class_open_arena_1_1_control_scheme.html">ControlScheme</a> here.
<h1>OpenArena::ControlScheme Class Reference</h1><!-- doxytag: class="OpenArena::ControlScheme" -->This class represents a user's control scheme.
<a href="#_details">More...</a>
<p>
<code>#include &lt;ctrls.h&gt;</code>
@@ -103,16 +103,16 @@
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_control_scheme.html#932882dbe80e19222cebf1bdf6fbfe4c">LoadDefaultControlScheme</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for LoadDefaultControlScheme here. <a href="#932882dbe80e19222cebf1bdf6fbfe4c"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method loads a hard coded default control scheme. <a href="#932882dbe80e19222cebf1bdf6fbfe4c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_control_scheme.html#1e53440ff1add23d420605d8a50d0329">ClearControlScheme</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for ClearControlScheme here. <a href="#1e53440ff1add23d420605d8a50d0329"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method clears this control scheme so that no keys are bound to any actions. <a href="#1e53440ff1add23d420605d8a50d0329"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_control_scheme.html#a05a50132bde8beff71dce6d497bb725">Unbind</a> (uint8)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for Unbind here. <a href="#a05a50132bde8beff71dce6d497bb725"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method removes a key from all actions. <a href="#a05a50132bde8beff71dce6d497bb725"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_control_scheme.html#8e036dbf842c63c661968d6fe20cd3dd">Bind</a> (uint32, uint8)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for Bind here. <a href="#8e036dbf842c63c661968d6fe20cd3dd"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method binds a key to an action. <a href="#8e036dbf842c63c661968d6fe20cd3dd"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_open_arena_1_1list.html">list</a>&lt; uint8 &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_control_scheme.html#abe764f69af07d6922ecfafc4f72b964">forward</a></td></tr>
@@ -158,11 +158,11 @@
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Write brief comment for <a class="el" href="class_open_arena_1_1_control_scheme.html">ControlScheme</a> here.
This class represents a user's control scheme.
<p>
Write detailed description for <a class="el" href="class_open_arena_1_1_control_scheme.html">ControlScheme</a> here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for <a class="el" href="class_open_arena_1_1_control_scheme.html">ControlScheme</a> here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
This class manages a set of actions and their associated keys.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>This could become a set of keys with associated actions.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
<p>
<hr><h2>Member Enumeration Documentation</h2>
@@ -254,23 +254,17 @@ Write detailed description for <a class="el" href="class_open_arena_1_1_control_
<div class="memdoc">
<p>
Write brief comment for Bind here.
This method binds a key to an action.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Description</em>&nbsp;</td><td>of parameter .</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Description</em>&nbsp;</td><td>of parameter .</td></tr>
<tr><td valign="top"></td><td valign="top"><em>The</em>&nbsp;</td><td>ACTION_* constant for the action to bind to.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>The</em>&nbsp;</td><td>KEY_* constant for the key to bind.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Write description of return value here.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for Bind here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for Bind here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>Returns false if an invalid action is specified and true otherwise.</dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd>This unbinds the key before binding it to the new action.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -290,16 +284,10 @@ Write detailed description for Bind here.<p>
<div class="memdoc">
<p>
Write brief comment for ClearControlScheme here.
This method clears this control scheme so that no keys are bound to any actions.
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for ClearControlScheme here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for ClearControlScheme here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -319,16 +307,10 @@ Write detailed description for ClearControlScheme here.<p>
<div class="memdoc">
<p>
Write brief comment for LoadDefaultControlScheme here.
This method loads a hard coded default control scheme.
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for LoadDefaultControlScheme here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for LoadDefaultControlScheme here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -349,21 +331,15 @@ Write detailed description for LoadDefaultControlScheme here.<p>
<div class="memdoc">
<p>
Write brief comment for Unbind here.
This method removes a key from all actions.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Description</em>&nbsp;</td><td>of parameter .</td></tr>
<tr><td valign="top"></td><td valign="top"><em>The</em>&nbsp;</td><td>KEY_* constant for the key to unbind.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for Unbind here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for Unbind here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -684,8 +660,8 @@ Write detailed description for Unbind here.<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>My Documents/Visual Studio 2005/Projects/openarena-clean/src/<a class="el" href="ctrls_8h.html">ctrls.h</a><li>My Documents/Visual Studio 2005/Projects/openarena-clean/src/<a class="el" href="ctrls_8cpp.html">ctrls.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jul 10 21:41:11 2006 for OpenArena by&nbsp;
<li>src/<a class="el" href="ctrls_8h.html">ctrls.h</a><li>src/<a class="el" href="ctrls_8cpp.html">ctrls.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jul 11 00:17:53 2006 for OpenArena by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>