YKeyEvent Class Reference

#include <YEvent.h>

Inheritance diagram for YKeyEvent:

List of all members.

Public Member Functions
	YKeyEvent (const string &keySymbol, YWidget *focusWidget=0)
string	keySymbol () const
YWidget *	focusWidget () const
virtual YCPMap	ycpEvent ()
virtual YCPValue	userInput ()
Protected Attributes
string	_keySymbol
YWidget *	_focusWidget

---

Constructor & Destructor Documentation

YKeyEvent::YKeyEvent	(	const string &	keySymbol,
		YWidget *	focusWidget = 0
	)

Constructor.

Create a key event with a specified key symbol (a text describing the key, such as "CursorLeft", "F1", etc.) and optionally the widget that currently has the keyboard focus.

---

Member Function Documentation

string YKeyEvent::keySymbol

(

)

const [inline]

Returns the key symbol - a text describing the key, such as "CursorLeft", "F1", "a", "A", etc.

YWidget* YKeyEvent::focusWidget

(

)

const [inline]

Returns the widget that currently has the keyboard focus.

This might as well be 0 if no widget has the focus or if the creator of this event could not obtain that information.

YCPMap YKeyEvent::ycpEvent

(

)

[virtual]

Constructs a YCP map to be returned upon UI::WaitForEvent().

Reimplemented from YEvent.

Reimplemented from YEvent.

YCPValue YKeyEvent::userInput

(

)

[virtual]

Returns the ID to be returned upon UI::UserInput(). This is the same as the "id" field of the ycpEvent() map.

Reimplemented from YEvent.

Reimplemented from YEvent.

---

Member Data Documentation

string YKeyEvent::_keySymbol [protected]

YWidget* YKeyEvent::_focusWidget [protected]

---

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

• YEvent.h
• YEvent.cc

---