WorldCanvasEvent.h

Classes

WorldCanvasEvent -- Base class describing event information for WorldCanvases. (full description)

class WorldCanvasEvent : public DisplayEvent

Interface

Public Members
WorldCanvasEvent(WorldCanvas *wc)
virtual ~WorldCanvasEvent()
virtual WorldCanvas *worldCanvas() const
Protected Members
WorldCanvasEvent()
WorldCanvasEvent(const WorldCanvasEvent &other)
WorldCanvasEvent &operator=(const WorldCanvasEvent &other)

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Etymology

"WorldCanvasEvents" describes "Events" (ie. things which happen at a measurable time) which occur on WorldCanvases.

Prerequisite

Synopsis

This class adds to the information stored in the DisplayEvent class. It adds information specific to events occuring on WorldCanvases, viz. a pointer to the WorldCanvas itself.

Example

Motivation

It is desirable to locate in a single place the information which is common to all events occuring on WorldCanvases.

Thrown Exceptions

To Do

Member Description

WorldCanvasEvent(WorldCanvas *wc)

Constructor, taking a pointer to a WorldCanvas.

virtual ~WorldCanvasEvent()

Destructor.

virtual WorldCanvas *worldCanvas() const

Return a pointer to the WorldCanvas on which the event occurred.

WorldCanvasEvent()

(Required) default constructor.

WorldCanvasEvent(const WorldCanvasEvent &other)

(Required) copy constructor.

WorldCanvasEvent &operator=(const WorldCanvasEvent &other)

(Required) copy assignment.