BC::BCKeyboardEvent Class Reference

#include <BCKeyboardEvent.h>

Inheritance diagram for BC::BCKeyboardEvent:

List of all members.

Public Member Functions
	BCKeyboardEvent (const WebCore::String &aText, const WebCore::String &aUnmodifiedText, const WebCore::String &aKeyIdentifier, bool bIsKeyUp, bool bShiftKey, bool bCtrlKey, bool bAltKey, bool bMetaKey, bool bIsAutoRepeat, int aVKey)
virtual WebCore::String	text () const
	returns the key, in lower case for the letters.
virtual WebCore::String	unmodifiedText () const
	returns the key unmodified.
virtual WebCore::String	keyIdentifier () const
	returns a string for all the keys.
virtual bool	isKeyUp () const
	whether key is up or down (release or pressed).
virtual bool	isAutoRepeat () const
	autorepeat
virtual void	setIsAutoRepeat (bool)
	autorepeat
virtual int	WindowsKeyCode () const
	Get the windows keycode.
virtual int	setWindowsKeyCode (int code) const
	Get the windows keycode.
virtual int	virtualKeyCode () const
	returns a VK for a key.
virtual bool	isKeypad () const
	isKeyPad
virtual BIEvent *	clone () const
	clone the object
virtual bool	shiftKey () const
virtual bool	ctrlKey () const
virtual bool	altKey () const
virtual bool	metaKey () const
Protected Attributes
WebCore::String	m_text
WebCore::String	m_unmodifiedText
WebCore::String	m_keyIdentifier
bool	m_isKeyUp
bool	m_autoRepeat
int	m_BALVirtualKeyCode
bool	m_isKeypad

---

Detailed Description

the KeyboardEvent The keyboard event

See also:

BIEvent, BIEventLoop

---

Constructor & Destructor Documentation

BCKeyboardEvent::BCKeyboardEvent	(	const WebCore::String &	aText,
		const WebCore::String &	aUnmodifiedText,
		const WebCore::String &	aKeyIdentifier,
		bool	bIsKeyUp,
		bool	bShiftKey,
		bool	bCtrlKey,
		bool	bAltKey,
		bool	bMetaKey,
		bool	bIsAutoRepeat,
		int	aVKey
	)

---

Member Function Documentation

WebCore::String BCKeyboardEvent::text

(

)

const [virtual]

returns the key, in lower case for the letters.

some keys can have no corresponding text (Enter, Arrow, etc.)

Implements BAL::BIKeyboardEvent.

WebCore::String BCKeyboardEvent::unmodifiedText

(

)

const [virtual]

returns the key unmodified.

It means in lower case or upper case, according to the shift/capslock key

Implements BAL::BIKeyboardEvent.

WebCore::String BCKeyboardEvent::keyIdentifier

(

)

const [virtual]

returns a string for all the keys.

It is a set over the text() method, completed with string like "Enter", for the Enter key, and so on.

Implements BAL::BIKeyboardEvent.

bool BCKeyboardEvent::isKeyUp

(

)

const [virtual]

whether key is up or down (release or pressed).

Implements BAL::BIKeyboardEvent.

bool BCKeyboardEvent::isAutoRepeat

(

)

const [virtual]

autorepeat

Implements BAL::BIKeyboardEvent.

void BCKeyboardEvent::setIsAutoRepeat

(

bool

)

[virtual]

autorepeat

Implements BAL::BIKeyboardEvent.

int BCKeyboardEvent::WindowsKeyCode

(

)

const [virtual]

Get the windows keycode.

Implements BAL::BIKeyboardEvent.

int BCKeyboardEvent::setWindowsKeyCode

(

int

)

const [virtual]

Get the windows keycode.

Implements BAL::BIKeyboardEvent.

int BCKeyboardEvent::virtualKeyCode

(

)

const [virtual]

returns a VK for a key.

It is important to note that some keys can have no VK. VKs are mainly used for function (F1, F2, etc), navigation (Arrow, etc.). For keys which purpose is to be written, use the text method, to get the resulting text.

Implements BAL::BIKeyboardEvent.

bool BCKeyboardEvent::isKeypad

(

)

const [virtual]

isKeyPad

Implements BAL::BIKeyboardEvent.

BIEvent * BCKeyboardEvent::clone

(

)

const [virtual]

clone the object

Implements BAL::BIKeyboardEvent.

virtual bool BC::BCKeyboardEvent::shiftKey

(

)

const [inline, virtual]

Reimplemented from BCCommonInputEventData.

virtual bool BC::BCKeyboardEvent::ctrlKey

(

)

const [inline, virtual]

Reimplemented from BCCommonInputEventData.

virtual bool BC::BCKeyboardEvent::altKey

(

)

const [inline, virtual]

Reimplemented from BCCommonInputEventData.

virtual bool BC::BCKeyboardEvent::metaKey

(

)

const [inline, virtual]

Reimplemented from BCCommonInputEventData.

---

Member Data Documentation

WebCore::String BC::BCKeyboardEvent::m_text [protected]

WebCore::String BC::BCKeyboardEvent::m_unmodifiedText [protected]

WebCore::String BC::BCKeyboardEvent::m_keyIdentifier [protected]

bool BC::BCKeyboardEvent::m_isKeyUp [protected]

bool BC::BCKeyboardEvent::m_autoRepeat [protected]

int BC::BCKeyboardEvent::m_BALVirtualKeyCode [protected]

bool BC::BCKeyboardEvent::m_isKeypad [protected]

---

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

• /src/trunk2/BAL/Implementations/Events/Common/BCKeyboardEvent.h
• /src/trunk2/BAL/Implementations/Events/Common/BCKeyboardEvent.cpp

---

pleyo.com