omgui::WindowCloseEvent Class Reference

#include <omgui/event.h>

Inherits omgui::Event.

List of all members.

---

Detailed Description

Event object for the following events:

• event_traits<Window>::CLOSE

Public Member Functions
bool	can_veto () const
event_id	get_id () const
object_id	get_object_id () const
bool	get_veto () const
void	veto (bool v=true) const
	WindowCloseEvent (const WindowCloseEvent &other)
	WindowCloseEvent (event_id id, object_id obj, bool vetoable=true)
Private Attributes
bool	m_vetoable

---

Constructor & Destructor Documentation

omgui::WindowCloseEvent::WindowCloseEvent	(	event_id	id,
		object_id	obj,
		bool	vetoable = true
	)

Constructs a WindowCloseEvent

Parameters:

	id	The event_id of the event
	obj	The object_id of the object associated with the event
	vetoable	Whether or not the closure of the window is allowed to be vetoed

omgui::WindowCloseEvent::WindowCloseEvent

(

const WindowCloseEvent &

other

)

---

Member Function Documentation

bool omgui::WindowCloseEvent::can_veto

(

)

const [virtual]

Returns:

Whether or not the closure of the Window can be vetoed. Certain situations prevent you from vetoing Window closure events, such as when the system is shutting down and the shutdown cannot be canceled.

Reimplemented from omgui::Event.

event_id omgui::Event::get_id

(

)

const [inherited]

Returns:

The id of this event

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

bool omgui::WindowCloseEvent::m_vetoable [private]