gadget::InputArea Class Reference

Base class for window types that accept keyboard and mouse input. More...

#include <gadget/Devices/KeyboardMouseDevice/InputArea.h>

Inheritance diagram for gadget::InputArea:

[legend]Collaboration diagram for gadget::InputArea:

[legend]List of all members.

Public Types
enum	lockState { Unlocked, Lock_LockKey, Lock_KeyDown }
	Enum to keep track of current lock state for state machine. More...
Public Member Functions
	InputArea ()
	~InputArea ()
bool	config (jccl::ConfigElementPtr e)
Protected Types
typedef KeyboardMouseDevice::KeyboardMouseDeviceRegistry	km_registry_t
	Shortened form of the keyboard/mouse device registry type name.
Protected Attributes
lockState	mLockState
	The current state of locking.
int	mLockStoredKey
	The key that was pressed down.
int	mLockToggleKey
	The key that toggles the locking.
float	mMouseSensitivity
int	mSleepTimeMS
KeyboardMouseDevice *	mKeyboardMouseDevice
std::string	mKeyboardMouseDeviceName
	Name of the remote display window (index in registry).
km_registry_t::KeyboardMouseDeviceInfo	mKeyboardMouseDeviceInfo
	Info structure for remote window.

---

Detailed Description

Base class for window types that accept keyboard and mouse input.

Definition at line 51 of file InputArea.h.

---

Member Typedef Documentation

typedef KeyboardMouseDevice::KeyboardMouseDeviceRegistry gadget::InputArea::km_registry_t [protected]

Shortened form of the keyboard/mouse device registry type name.

Definition at line 71 of file InputArea.h.

---

Member Enumeration Documentation

enum gadget::InputArea::lockState

Enum to keep track of current lock state for state machine.

Enumerator:

Unlocked	The mouse is free.
Lock_LockKey	The mouse is locked due to lock toggle key press.
Lock_KeyDown	The mouse is locked due to a key being held down.

Definition at line 55 of file InputArea.h.

   {
      Unlocked,     
      Lock_LockKey, 
      Lock_KeyDown  
   };

---

Constructor & Destructor Documentation

gadget::InputArea::InputArea

(

)

Definition at line 46 of file InputArea.cpp.

   : mLockState(Unlocked)
   , mLockStoredKey(-1)
   , mLockToggleKey(-1)
   , mMouseSensitivity(1.0f)
   , mSleepTimeMS(0)
   , mKeyboardMouseDevice(NULL)
   , mKeyboardMouseDeviceName("")
{
   /* Do nothing. */ ;
}

gadget::InputArea::~InputArea

(

)

[inline]

Definition at line 64 of file InputArea.h.

   {;}

---

Member Function Documentation

bool gadget::InputArea::config

(

jccl::ConfigElementPtr

e

)

Reimplemented in gadget::InputWindowWin32, and gadget::InputWindowXWin.

Definition at line 58 of file InputArea.cpp.

References gadgetDBG_INPUT_MGR(), Lock_LockKey, gadget::KeyboardMouseDevice::KeyboardMouseDeviceRegistry::KeyboardMouseDeviceInfo::mKeyboardMouseDevice, mKeyboardMouseDevice, mKeyboardMouseDeviceInfo, mKeyboardMouseDeviceName, mLockState, mLockToggleKey, and mSleepTimeMS.

Referenced by gadget::InputWindowXWin::config(), and gadget::InputWindowWin32::config().

{
   // Get the lock information
   mLockToggleKey = e->getProperty<int>("lock_key");
   bool start_locked = e->getProperty<bool>("start_locked");

   if (start_locked)
   {
      mLockState = Lock_LockKey;      // Initialize to the locked state
   }

   mSleepTimeMS = e->getProperty<int>("sleep_time");

   // Sanity check.
   if (mSleepTimeMS == 0)
   {
      mSleepTimeMS = 50;
   }

   // If we have a pointer to a window in registry, then use that
   mKeyboardMouseDeviceName = e->getProperty<std::string>("keyboard_mouse_device_name");

   km_registry_t::KeyboardMouseDeviceInfo event_source_info;
   bool found_window =
      km_registry_t::instance()->getKeyboardMouseDevice(mKeyboardMouseDeviceName,
                                                        event_source_info);

   if(!found_window)
   {
      // Use vprDBG_WARNING_LVL for input_window config elements as they are
      // almost certainly mis-configured without a valid value for
      // keyboard_mouse_device_name.
      int level = e->getID() == std::string("input_window") ? vprDBG_WARNING_LVL
                                                            : vprDBG_STATE_LVL;

      vprDEBUG(gadgetDBG_INPUT_MGR, level)
         << "WARNING: Could not find keyboard/mouse device named '"
         << mKeyboardMouseDeviceName << "'\n" << vprDEBUG_FLUSH;
      vprDEBUG_NEXT(gadgetDBG_INPUT_MGR, level)
         << "No InputArea will be created for window named '"
         << e->getName() << "'.\n" << vprDEBUG_FLUSH;
      return false;
   }
   else
   {
      mKeyboardMouseDeviceInfo = event_source_info;
      mKeyboardMouseDevice = mKeyboardMouseDeviceInfo.mKeyboardMouseDevice;
   }

   return true;
}

---

Member Data Documentation

lockState gadget::InputArea::mLockState [protected]

The current state of locking.

Definition at line 73 of file InputArea.h.

Referenced by config(), gadget::InputWindowXWin::controlLoop(), gadget::InputWindowWin32::controlLoop(), gadget::InputAreaXWin::handleEvent(), and gadget::InputAreaWin32::updKeys().

int gadget::InputArea::mLockStoredKey [protected]

The key that was pressed down.

Definition at line 74 of file InputArea.h.

Referenced by gadget::InputAreaXWin::handleEvent(), and gadget::InputAreaWin32::updKeys().

int gadget::InputArea::mLockToggleKey [protected]

The key that toggles the locking.

Definition at line 75 of file InputArea.h.

Referenced by config(), gadget::InputAreaXWin::handleEvent(), and gadget::InputAreaWin32::updKeys().

float gadget::InputArea::mMouseSensitivity [protected]

Definition at line 76 of file InputArea.h.

int gadget::InputArea::mSleepTimeMS [protected]

Definition at line 77 of file InputArea.h.

Referenced by config(), gadget::InputWindowXWin::controlLoop(), and gadget::InputWindowWin32::controlLoop().

KeyboardMouseDevice* gadget::InputArea::mKeyboardMouseDevice [protected]

Definition at line 79 of file InputArea.h.

Referenced by gadget::InputAreaWin32::addKeyEvent(), gadget::InputAreaWin32::addMouseButtonEvent(), gadget::InputAreaWin32::addMouseMoveEvent(), config(), gadget::InputAreaWin32::getButtonMask(), gadget::InputAreaWin32::getModifierMask(), gadget::InputAreaXWin::handleEvent(), gadget::InputAreaXWin::handleEvents(), gadget::InputAreaWin32::handleEvents(), and gadget::InputAreaWin32::updKeys().

std::string gadget::InputArea::mKeyboardMouseDeviceName [protected]

Name of the remote display window (index in registry).

Definition at line 82 of file InputArea.h.

Referenced by config().

km_registry_t::KeyboardMouseDeviceInfo gadget::InputArea::mKeyboardMouseDeviceInfo [protected]

Info structure for remote window.

Definition at line 85 of file InputArea.h.

Referenced by config().

---

The documentation for this class was generated from the following files:

• InputArea.h
• InputArea.cpp

---