libyui  2.42.6
 All Classes Functions Variables Enumerations Friends
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
YEvent Class Reference

#include <YEvent.h>

Inheritance diagram for YEvent:
Inheritance graph
[legend]

Public Types

enum  EventType {
  NoEvent = 0, UnknownEvent, WidgetEvent, MenuEvent,
  KeyEvent, CancelEvent, TimeoutEvent, DebugEvent,
  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.

Definition at line 43 of file YEvent.h.

Constructor & Destructor Documentation

YEvent::YEvent ( EventType  eventType = UnknownEvent)

Constructor.

Definition at line 38 of file YEvent.cc.

Here is the call graph for this function:

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.

Definition at line 46 of file YEvent.cc.

Here is the call graph for this function:

Member Function Documentation

YDialog* YEvent::dialog ( ) const
inline

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

Definition at line 106 of file YEvent.h.

EventType YEvent::eventType ( ) const
inline

Returns the event type.

Definition at line 79 of file YEvent.h.

void YEvent::invalidate ( )
protected

Mark this event as invalid. This cannot be undone.

Definition at line 60 of file YEvent.cc.

bool YEvent::isValid ( ) const

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

Definition at line 53 of file YEvent.cc.

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.

Definition at line 101 of file YEvent.h.

unsigned long YEvent::serial ( ) const
inline

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

Definition at line 85 of file YEvent.h.

void YEvent::setDialog ( YDialog *  dia)
inlineprotected

Set the dialog this event belongs to.

Definition at line 129 of file YEvent.h.

const char * YEvent::toString ( EventType  eventType)
static

Returns the character representation of an event type.

Definition at line 67 of file YEvent.cc.

const char * YEvent::toString ( EventReason  reason)
static

Returns the character representation of an event reason.

Definition at line 90 of file YEvent.cc.

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.

Definition at line 93 of file YEvent.h.

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