omgui::NotebookEvent Class Reference

#include <omgui/event.h>

Inherits omgui::Event.

List of all members.

---

Detailed Description

Event object for the following events:

• event_traits<Notebook>

Public Member Functions
bool	can_veto () const
omgui::NotebookPage	get_current_page () const
event_id	get_id () const
object_id	get_object_id () const
bool	get_veto () const
	NotebookEvent (const NotebookEvent &other)
	NotebookEvent (event_id id, object_id obj, omgui::NotebookPage current_page)
void	veto (bool v=true) const
Private Attributes
omgui::NotebookPage	m_current_page

---

Constructor & Destructor Documentation

omgui::NotebookEvent::NotebookEvent	(	event_id	id,
		object_id	obj,
		omgui::NotebookPage	current_page
	)

Constructs a NotebookEvent

Parameters:

	id	The event_id of the event
	obj	The object_id of the object associated with the event
	current_page	The currently selected NotebookPage

omgui::NotebookEvent::NotebookEvent

(

const NotebookEvent &

other

)

---

Member Function Documentation

bool omgui::NotebookEvent::can_veto

(

)

const [virtual]

Returns:

Whether or not this event can be vetoed.

Reimplemented from omgui::Event.

omgui::NotebookPage omgui::NotebookEvent::get_current_page

(

)

const

Returns:

The currently selected NotebookPage at the time this event was sent.

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

omgui::NotebookPage omgui::NotebookEvent::m_current_page [private]