omgui::Event Class Reference

#include <omgui/event.h>

Inherited by omgui::MenuEvent, omgui::MouseEvent, omgui::NotebookEvent, and omgui::WindowCloseEvent.

List of all members.

Public Member Functions
virtual bool	can_veto () const
	Event (const Event &other)
	Event (event_id id, object_id obj)
event_id	get_id () const
object_id	get_object_id () const
bool	get_veto () const
void	veto (bool v=true) const
virtual	~Event ()
Private Attributes
const event_id	m_id
const object_id	m_obj_id
bool	m_veto

---

Constructor & Destructor Documentation

omgui::Event::Event	(	event_id	id,
		object_id	obj
	)

Construct an event.

Parameters:

	id	The event_id of the event being sent
	obj	The object_id of the object associated with the event

omgui::Event::Event

(

const Event &

other

)

omgui::Event::~Event

(

)

[virtual]

---

Member Function Documentation

bool omgui::Event::can_veto

(

)

const [virtual]

Returns:

True if this event is allowed to be vetoed

Reimplemented in omgui::WindowCloseEvent, and omgui::NotebookEvent.

event_id omgui::Event::get_id

(

)

const

Returns:

The id of this event

object_id omgui::Event::get_object_id

(

)

const

Returns:

The id of the object associated with this event

bool omgui::Event::get_veto

(

)

const

Returns:

Whether or not this event has been vetoed.

void omgui::Event::veto

(

bool

v = true

)

const

Vetos the event.

Precondition:

The event is vetoable. That is, can_veto() returns true.

---

Member Data Documentation

const event_id omgui::Event::m_id [private]

const object_id omgui::Event::m_obj_id [private]

bool omgui::Event::m_veto [mutable, private]