casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions | Private Attributes
casa::WorldCanvasEvent Class Reference

Base class describing event information for WorldCanvases. More...

#include <WorldCanvasEvent.h>

Inheritance diagram for casa::WorldCanvasEvent:
casa::DisplayEvent casa::CrosshairEvent casa::RectRegionEvent casa::WCMotionEvent casa::WCRefreshEvent casa::WCPositionEvent

List of all members.

Public Member Functions

 WorldCanvasEvent (WorldCanvas *wc)
 Constructor, taking a pointer to a WorldCanvas.
virtual ~WorldCanvasEvent ()
 Destructor.
virtual WorldCanvasworldCanvas () const
 Return a pointer to the WorldCanvas on which the event occurred.

Protected Member Functions

 WorldCanvasEvent ()
 (Required) default constructor.
 WorldCanvasEvent (const WorldCanvasEvent &other)
 (Required) copy constructor.
WorldCanvasEventoperator= (const WorldCanvasEvent &other)
 (Required) copy assignment.

Private Attributes

WorldCanvasitsWorldCanvas
 Store the WorldCanvas of the event here at construction.

Detailed Description

Base class describing event information for WorldCanvases.

Intended use:

Internal

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

.

Definition at line 79 of file WorldCanvasEvent.h.


Constructor & Destructor Documentation

Constructor, taking a pointer to a WorldCanvas.

Destructor.

(Required) default constructor.

(Required) copy constructor.


Member Function Documentation

WorldCanvasEvent& casa::WorldCanvasEvent::operator= ( const WorldCanvasEvent other) [protected]

(Required) copy assignment.

virtual WorldCanvas* casa::WorldCanvasEvent::worldCanvas ( ) const [inline, virtual]

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

Definition at line 90 of file WorldCanvasEvent.h.

References itsWorldCanvas.


Member Data Documentation

Store the WorldCanvas of the event here at construction.

Definition at line 107 of file WorldCanvasEvent.h.

Referenced by worldCanvas().


The documentation for this class was generated from the following file: