diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a03858.html | 284 |
1 files changed, 284 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03858.html b/docs/doxygen/nel/a03858.html new file mode 100644 index 00000000..248a0c7b --- /dev/null +++ b/docs/doxygen/nel/a03858.html @@ -0,0 +1,284 @@ +<!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>NeL: NLMISC::IInputDeviceManager struct Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLMISC::IInputDeviceManager Struct Reference</h1><code>#include <<a class="el" href="a05819.html">input_device_manager.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Interface for objects that give low level access access to devices (mouse, keyboard, joypads and joysticks). Generally an object implementing this interface will send the appropriate events when a device is 'created'. (Example of implementation : a direct input event emitter) +<p> + +<p> +Definition at line <a class="el" href="a05819.html#l00052">52</a> of file <a class="el" href="a05819.html">input_device_manager.h</a>.<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>virtual <a class="el" href="a03854.html">IGameDevice</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03858.html#NLMISC_1_1IInputDeviceManagera0">createGameDevice</a> (const std::string &instanceName)=0 throw (EInputDevice)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03858.html#NLMISC_1_1IInputDeviceManagera1">enumerateGameDevice</a> (<a class="el" href="a05378.html#a219">TDeviceDescVect</a> &descs)=0 throw (EInputDevice)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a03860.html">IKeyboardDevice</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03858.html#NLMISC_1_1IInputDeviceManagera2">getKeyboardDevice</a> ()=0 throw (EInputDevice)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the low level keyboard device if needed (one active at a time for that object, repeated calls returns the same pointer). An exception if thrown if it couldn't be obtained. <a href="#NLMISC_1_1IInputDeviceManagera2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a03867.html">IMouseDevice</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03858.html#NLMISC_1_1IInputDeviceManagera3">getMouseDevice</a> (bool hardware)=0 throw (EInputDevice)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the low level mouse device if needed (one active at a time for that object, repeated calls returns the same pointer). An exception if thrown if it couldn't be obtained. <a href="#NLMISC_1_1IInputDeviceManagera3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03858.html#NLMISC_1_1IInputDeviceManagera4">isMouseCreated</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03858.html#NLMISC_1_1IInputDeviceManagera5">releaseGameDevice</a> (<a class="el" href="a03854.html">IGameDevice</a> *gd)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03858.html#NLMISC_1_1IInputDeviceManagera6">releaseKeyboard</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">remove the low level keyboard <a href="#NLMISC_1_1IInputDeviceManagera6"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03858.html#NLMISC_1_1IInputDeviceManagera7">releaseMouse</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">remove the low level mouse <a href="#NLMISC_1_1IInputDeviceManagera7"></a><br><br></td></tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLMISC_1_1IInputDeviceManagera0" doxytag="NLMISC::IInputDeviceManager::createGameDevice" ></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"> virtual <a class="el" href="a03854.html">IGameDevice</a>* NLMISC::IInputDeviceManager::createGameDevice </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>instanceName</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> throw (<a class="el" href="a03793.html">EInputDevice</a>)<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IInputDeviceManagera1" doxytag="NLMISC::IInputDeviceManager::enumerateGameDevice" ></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"> virtual void NLMISC::IInputDeviceManager::enumerateGameDevice </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05378.html#a219">TDeviceDescVect</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>descs</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> throw (<a class="el" href="a03793.html">EInputDevice</a>)<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IInputDeviceManagera2" doxytag="NLMISC::IInputDeviceManager::getKeyboardDevice" ></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"> virtual <a class="el" href="a03860.html">IKeyboardDevice</a>* NLMISC::IInputDeviceManager::getKeyboardDevice </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> throw (<a class="el" href="a03793.html">EInputDevice</a>)<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create the low level keyboard device if needed (one active at a time for that object, repeated calls returns the same pointer). An exception if thrown if it couldn't be obtained. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IInputDeviceManagera3" doxytag="NLMISC::IInputDeviceManager::getMouseDevice" ></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"> virtual <a class="el" href="a03867.html">IMouseDevice</a>* NLMISC::IInputDeviceManager::getMouseDevice </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>hardware</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> throw (<a class="el" href="a03793.html">EInputDevice</a>)<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create the low level mouse device if needed (one active at a time for that object, repeated calls returns the same pointer). An exception if thrown if it couldn't be obtained. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IInputDeviceManagera4" doxytag="NLMISC::IInputDeviceManager::isMouseCreated" ></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"> virtual bool NLMISC::IInputDeviceManager::isMouseCreated </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IInputDeviceManagera5" doxytag="NLMISC::IInputDeviceManager::releaseGameDevice" ></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"> virtual void NLMISC::IInputDeviceManager::releaseGameDevice </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03854.html">IGameDevice</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>gd</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IInputDeviceManagera6" doxytag="NLMISC::IInputDeviceManager::releaseKeyboard" ></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"> virtual void NLMISC::IInputDeviceManager::releaseKeyboard </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +remove the low level keyboard +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IInputDeviceManagera7" doxytag="NLMISC::IInputDeviceManager::releaseMouse" ></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"> virtual void NLMISC::IInputDeviceManager::releaseMouse </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +remove the low level mouse +<p> + </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="a05819.html">input_device_manager.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 13:46:14 2004 for NeL 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> |