YEvent Class Reference

#include <YEvent.h>

Inheritance diagram for YEvent:

Public Types
enum	EventType {   NoEvent = 0 , UnknownEvent , WidgetEvent , MenuEvent ,   KeyEvent , CancelEvent , TimeoutEvent , DebugEvent ,   SpecialKeyEvent , InvalidEvent = 0x4242 }
enum	EventReason {   UnknownReason = 0 , Activated , SelectionChanged , ValueChanged ,   ContextMenuActivated }

Public Member Functions
	YEvent (EventType eventType=UnknownEvent)
EventType	eventType () const
unsigned long	serial () const
virtual YWidget *	widget () const
virtual YItem *	item () const
YDialog *	dialog () const
bool	isValid () const

Static Public Member Functions
static const char *	toString (EventType eventType)
static const char *	toString (EventReason reason)

Protected Member Functions
void	setDialog (YDialog *dia)
virtual	~YEvent ()
void	invalidate ()

Friends
void	YDialog::deleteEvent (YEvent *event)
void	YSimpleEventHandler::deleteEvent (YEvent *event)

Detailed Description

Abstract base class for events to be returned upon UI::UserInput() and related functions.

Constructor & Destructor Documentation

YEvent()

YEvent::YEvent

(

EventType

eventType = UnknownEvent

)

Constructor.

~YEvent()

YEvent::~YEvent ( )

protectedvirtual

Protected destructor - events can only be deleted via YDialog::deleteEvent(). The associated dialog will take care of this event and delete it when appropriate.

This desctructor is virtual to force a polymorph object so dynamic_cast<> can be used.

Member Function Documentation

dialog()

YDialog * YEvent::dialog ( ) const

inline

Return the dialog this event belongs to or 0 if no dialog was set yet.

eventType()

EventType YEvent::eventType ( ) const

inline

Returns the event type.

invalidate()

void YEvent::invalidate ( )

protected

Mark this event as invalid. This cannot be undone.

isValid()

bool YEvent::isValid

(

)

const

Check if this event is valid. Events become invalid in the destructor.

item()

virtual YItem * YEvent::item ( ) const

inlinevirtual

Return the YItem that corresponds to this event or 0 if there is none.

This default implementation always returns 0. Subclasses that actually return items should overwrite this method.

Reimplemented in YMenuEvent.

serial()

unsigned long YEvent::serial ( ) const

inline

Returns the unique serial no. of this event. This is mainly useful for debugging.

setDialog()

void YEvent::setDialog ( YDialog * dia )

inlineprotected

Set the dialog this event belongs to.

toString() [1/2]

const char * YEvent::toString ( EventReason reason )

static

Returns the character representation of an event reason.

toString() [2/2]

const char * YEvent::toString ( EventType eventType )

static

Returns the character representation of an event type.

widget()

virtual YWidget * YEvent::widget ( ) const

inlinevirtual

Returns the widget that caused this event or 0 if there is none.

This default implementation always returns 0. Subclasses that actually return widgets should overwrite this method.

Reimplemented in YWidgetEvent.

---

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

• /__w/libyui/libyui/libyui/src/YEvent.h
• /__w/libyui/libyui/libyui/src/YEvent.cc