omgui::MenuEvent Class Reference

#include <omgui/event.h>

Inherits omgui::Event.

List of all members.

---

Detailed Description

Event object for the following events:

• event_traits<Menu>

Public Member Functions
virtual bool	can_veto () const
event_id	get_id () const
menu_id	get_menu_id () const
object_id	get_object_id () const
bool	get_veto () const
	MenuEvent (event_id e_id, object_id obj, menu_id m_id)
void	veto (bool v=true) const
Protected Attributes
menu_id	m_menu_id

---

Constructor & Destructor Documentation

omgui::MenuEvent::MenuEvent	(	event_id	e_id,
		object_id	obj,
		menu_id	m_id
	)

Constructs a MenuEvent

Parameters:

	e_id	The event_id of the event
	obj	The object_id of the object associated with the event
	m_id	The menu_id associated with the event

---

Member Function Documentation

bool omgui::Event::can_veto

(

)

const [virtual, inherited]

Returns:

True if this event is allowed to be vetoed

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

event_id omgui::Event::get_id

(

)

const [inherited]

Returns:

The id of this event

menu_id omgui::MenuEvent::get_menu_id

(

)

const

object_id omgui::Event::get_object_id

(

)

const [inherited]

Returns:

The id of the object associated with this event

bool omgui::Event::get_veto

(

)

const [inherited]

Returns:

Whether or not this event has been vetoed.

void omgui::Event::veto

(

bool

v = true

)

const [inherited]

Vetos the event.

Precondition:

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

---

Member Data Documentation

menu_id omgui::MenuEvent::m_menu_id [protected]