PixelCanvasEvent.h

Classes

PixelCanvasEvent -- Base class describing event information for PixelCanvases. (full description)

class PixelCanvasEvent : public DisplayEvent

Interface

Public Members
PixelCanvasEvent(PixelCanvas *pc)
virtual ~PixelCanvasEvent()
virtual PixelCanvas *pixelCanvas() const
Protected Members
PixelCanvasEvent()
PixelCanvasEvent(const PixelCanvasEvent &other)
PixelCanvasEvent &operator=(const PixelCanvasEvent &other)

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Etymology

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

Prerequisite

Synopsis

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

Example

Motivation

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

Thrown Exceptions

To Do

Member Description

PixelCanvasEvent(PixelCanvas *pc)

Constructor, taking a pointer to a PixelCanvas.

virtual ~PixelCanvasEvent()

Destructor.

virtual PixelCanvas *pixelCanvas() const

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

PixelCanvasEvent()

(Required) default constructor.

PixelCanvasEvent(const PixelCanvasEvent &other)

(Required) copy constructor.

PixelCanvasEvent &operator=(const PixelCanvasEvent &other)

(Required) copy assignment.