CL_InputContext Class Reference
[clanDisplay Input]

CL_InputContext. More...

#include <input_context.h>

List of all members.

Implementation
class	CL_Win32Window
class	CL_X11Window
Public Member Functions
Construction
	CL_InputContext ()
	Constructs an input context.
	CL_InputContext (const CL_InputContext &copy)
	Constructs a InputContext.
	~CL_InputContext ()
Attributes
int	get_keyboard_count () const
	Returns the number of keyboards available.
int	get_mouse_count () const
	Returns the number of mice available.
int	get_joystick_count () const
	Returns the number of joysticks available.
int	get_tablet_count () const
	Returns the number of tablets available.
CL_InputDevice &	get_keyboard (int keyboard=0)
	Returns the input device for the specified keyboard.
CL_InputDevice &	get_mouse (int mouse=0)
	Returns the input device for the specified mouse.
CL_InputDevice &	get_joystick (int joystick=0)
	Returns the input device for the specified joystick.
CL_InputDevice &	get_tablet (int tablet=0)
	Returns the input device for the specified tablet.
CL_InputDevice &	get_device (const CL_StringRef &device_name)
	Returns the input device with the given devicename.
Operations
CL_InputContext &	operator= (CL_InputContext &copy)
	Copy assignment operator.
void	clear ()
	Removes all devices from this input context.
void	add_keyboard (const CL_InputDevice keyboard)
	Adds a new keyboard to the input context.
void	add_mouse (const CL_InputDevice mouse)
	Adds a new mouse to the input context.
void	add_joystick (const CL_InputDevice joystick)
	Adds a new joystick to the input context.
void	add_tablet (const CL_InputDevice tablet)
	Adds a new tablet to the input context.
void	process_messages ()
	Process and dispatch messages to signals.
bool	poll (bool peek_only)
	Update device.

---

Detailed Description

CL_InputContext.

---

Constructor & Destructor Documentation

CL_InputContext::CL_InputContext (   )

Constructs an input context.

CL_InputContext::CL_InputContext (  const CL_InputContext &  copy  )

Constructs a InputContext. Parameters: copy  = Input Context

CL_InputContext::~CL_InputContext (   )

---

Member Function Documentation

void CL_InputContext::add_joystick (  const CL_InputDevice  joystick  )

Adds a new joystick to the input context.

void CL_InputContext::add_keyboard (  const CL_InputDevice  keyboard  )

Adds a new keyboard to the input context.

void CL_InputContext::add_mouse (  const CL_InputDevice  mouse  )

Adds a new mouse to the input context.

void CL_InputContext::add_tablet (  const CL_InputDevice  tablet  )

Adds a new tablet to the input context.

void CL_InputContext::clear (   )

Removes all devices from this input context.

CL_InputDevice& CL_InputContext::get_device (  const CL_StringRef &  device_name  )

Returns the input device with the given devicename.

CL_InputDevice& CL_InputContext::get_joystick (  int  joystick = 0  )

Returns the input device for the specified joystick.

int CL_InputContext::get_joystick_count (   )  const

Returns the number of joysticks available.

CL_InputDevice& CL_InputContext::get_keyboard (  int  keyboard = 0  )

Returns the input device for the specified keyboard.

int CL_InputContext::get_keyboard_count (   )  const

Returns the number of keyboards available.

CL_InputDevice& CL_InputContext::get_mouse (  int  mouse = 0  )

Returns the input device for the specified mouse.

int CL_InputContext::get_mouse_count (   )  const

Returns the number of mice available.

CL_InputDevice& CL_InputContext::get_tablet (  int  tablet = 0  )

Returns the input device for the specified tablet.

int CL_InputContext::get_tablet_count (   )  const

Returns the number of tablets available.

CL_InputContext& CL_InputContext::operator= (  CL_InputContext &  copy  )

Copy assignment operator.

bool CL_InputContext::poll (  bool  peek_only  )

Update device. Parameters: peek_only  Treat as a request to see if an event would occur Returns: true when the device event has occurred

void CL_InputContext::process_messages (   )

Process and dispatch messages to signals.

---

Friends And Related Function Documentation

friend class CL_Win32Window [friend]

friend class CL_X11Window [friend]

---

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

• input_context.h

---