NLMISC::IKeyboardDevice Struct Reference

#include <keyboard_device.h>

Inheritance diagram for NLMISC::IKeyboardDevice:

---

Detailed Description

Gives access to low level keyboard parameters

• 'Shift' messages are replaced by RShift and LShift msg.
• 'Control' messages are replaced by 'RControl' and 'LControl' msg.
• 'Menu' (alternate) messages are replaced by 'RMenu' and 'LMenu' msg.

Definition at line 43 of file keyboard_device.h.

Public Types
enum	{ NumKeys = 256 }
	Max number of supported keys. More...
Public Member Functions
virtual void	disableRepetition (const TKey *keyTab, uint numKey)=0
	Set a set of keys for which repetition is disabled.
virtual uint	getBufferSize () const=0
	Get the buffer size for this device.
virtual void	getDisabledRepetitions (TKey *destTab) const=0
virtual uint	getKeyRepeatDelay () const=0
	Get the delay before key repeat, in milliseconds.
virtual uint	getKeyRepeatPeriod () const=0
	Get the period before key repeat, in milliseconds.
virtual uint	getNumDisabledRepetition () const=0
	Get the number of disabled keys.
virtual bool	setBufferSize (uint size)=0
virtual void	setKeyRepeatDelay (uint delay)=0
	Get the delay before key repeat, in milliseconds.
virtual void	setKeyRepeatPeriod (uint period)=0
	Get the period before key repeat, in milliseconds.

---

Member Enumeration Documentation

anonymous enum

Max number of supported keys. Enumeration values: NumKeys  Definition at line 46 of file keyboard_device.h. { NumKeys = 256 };

---

Member Function Documentation

virtual void NLMISC::IInputDevice::begin (  CEventServer *  server  )  [inline, virtual, inherited]

For device server usage : Called at the beginning of each events retrieval. If a device doesn't support buffered datas, the state changes can be directly send to the event server. The default does nothing. Definition at line 64 of file input_device.h. {}

virtual void NLMISC::IKeyboardDevice::disableRepetition (  const TKey *  keyTab, uint  numKey )  [pure virtual]

Set a set of keys for which repetition is disabled.

virtual uint NLMISC::IInputDevice::getBufferSize (   )  const [pure virtual, inherited]

Get the buffer size for this device.

virtual void NLMISC::IKeyboardDevice::getDisabledRepetitions (  TKey *  destTab  )  const [pure virtual]

Get the disabled keys and stores in the given tab. NB: must ensure the destination table has the right size See also: getNumDisabledKeys()

virtual uint NLMISC::IKeyboardDevice::getKeyRepeatDelay (   )  const [pure virtual]

Get the delay before key repeat, in milliseconds.

virtual uint NLMISC::IKeyboardDevice::getKeyRepeatPeriod (   )  const [pure virtual]

Get the period before key repeat, in milliseconds.

virtual uint NLMISC::IKeyboardDevice::getNumDisabledRepetition (   )  const [pure virtual]

Get the number of disabled keys.

virtual void NLMISC::IInputDevice::poll (  CInputDeviceServer *  dev  )  [pure virtual, inherited]

For device server usage : Poll all events from that device, and notify them to the given device server, so that they can be sorted between devices. This retrieves messages, but do not process them.

virtual bool NLMISC::IInputDevice::setBufferSize (  uint  size  )  [pure virtual, inherited]

Set the buffer size for this device (the number of samples it can retains). This return true if the size could be set

virtual void NLMISC::IKeyboardDevice::setKeyRepeatDelay (  uint  delay  )  [pure virtual]

Get the delay before key repeat, in milliseconds.

virtual void NLMISC::IKeyboardDevice::setKeyRepeatPeriod (  uint  period  )  [pure virtual]

Get the period before key repeat, in milliseconds.

virtual void NLMISC::IInputDevice::submit (  IInputDeviceEvent *  deviceEvent, CEventServer *  server )  [pure virtual, inherited]

For device server usage : Process an event (eventually update this device state), and translate the message to a IEventServerMessage

virtual void NLMISC::IInputDevice::transitionOccured (  CEventServer *  server, const IInputDeviceEvent *  nextMessage )  [inline, virtual, inherited]

For device server usage : Says that the next message is for another device, or that it is the last message that will be received. This allow to pack several messages in one (for example, to sum up mouse moves until a click occurs) The default does nothing. The next message can be used to get a time stamp for example. It may be NULL is no next message is available Definition at line 81 of file input_device.h. Referenced by NLMISC::CInputDeviceServer::poll(). {}

---

The documentation for this struct was generated from the following file:

• keyboard_device.h

---