casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
casa::PlotMouseTool Class Reference

A PlotMouseTool is a specialization of PlotTool that handles all mouse events. More...

#include <PlotTool.h>

Inheritance diagram for casa::PlotMouseTool:
casa::PlotWheelEventHandler casa::PlotMouseMoveEventHandler casa::PlotMouseDragEventHandler casa::PlotMouseReleaseEventHandler casa::PlotMousePressEventHandler casa::PlotClickEventHandler casa::PlotSelectEventHandler casa::PlotTool casa::PlotMSAnnotator casa::PlotSelectTool

List of all members.

Public Member Functions

 PlotMouseTool (PlotCoordinate::System coordSys=PlotCoordinate::WORLD)
 Constructor which takes the tool's coordinate system.
 PlotMouseTool (PlotAxis xAxis, PlotAxis yAxis, PlotCoordinate::System coordSys=PlotCoordinate::WORLD)
 Constructor which takes the tool's axes and coordinate system.
virtual ~PlotMouseTool ()
 Destructor.
virtual void handleSelect (const PlotSelectEvent &event)
 Event handling methods.
virtual void handleClick (const PlotClickEvent &event)
 Handle the given event.
virtual void handleMousePress (const PlotMousePressEvent &event)
 Handle the given event.
virtual void handleMouseRelease (const PlotMouseReleaseEvent &event)
 Handle the given event.
virtual void handleMouseDrag (const PlotMouseDragEvent &event)
 Handle the given event.
virtual void handleMouseMove (const PlotMouseMoveEvent &event)
 Handle the given event.
virtual void handleWheel (const PlotWheelEvent &event)
 Handle the given event.
virtual void handleMouseEvent (const PlotEvent &event)=0
 ABSTRACT METHODS //.

Detailed Description

A PlotMouseTool is a specialization of PlotTool that handles all mouse events.

It is abstract, and combines all mouse event handling methods into one for convenience.

Definition at line 165 of file PlotTool.h.


Constructor & Destructor Documentation

casa::PlotMouseTool::PlotMouseTool ( PlotCoordinate::System  coordSys = PlotCoordinate::WORLD) [inline]

Constructor which takes the tool's coordinate system.

Definition at line 175 of file PlotTool.h.

casa::PlotMouseTool::PlotMouseTool ( PlotAxis  xAxis,
PlotAxis  yAxis,
PlotCoordinate::System  coordSys = PlotCoordinate::WORLD 
) [inline]

Constructor which takes the tool's axes and coordinate system.

Definition at line 179 of file PlotTool.h.

virtual casa::PlotMouseTool::~PlotMouseTool ( ) [inline, virtual]

Destructor.

Definition at line 184 of file PlotTool.h.


Member Function Documentation

virtual void casa::PlotMouseTool::handleClick ( const PlotClickEvent event) [inline, virtual]

Handle the given event.

Implements casa::PlotClickEventHandler.

Definition at line 191 of file PlotTool.h.

References handleMouseEvent().

virtual void casa::PlotMouseTool::handleMouseDrag ( const PlotMouseDragEvent event) [inline, virtual]

Handle the given event.

Implements casa::PlotMouseDragEventHandler.

Definition at line 197 of file PlotTool.h.

References handleMouseEvent().

virtual void casa::PlotMouseTool::handleMouseEvent ( const PlotEvent event) [pure virtual]

ABSTRACT METHODS //.

Handles the given mouse event. Guaranteed to be one of the mouse events (select, click, press, release, drag, move, wheel). The implementing class should also update the last event handled flag as necessary.

Implemented in casa::PlotSelectTool, and casa::PlotMSAnnotator.

Referenced by handleClick(), handleMouseDrag(), handleMouseMove(), handleMousePress(), handleMouseRelease(), handleSelect(), and handleWheel().

virtual void casa::PlotMouseTool::handleMouseMove ( const PlotMouseMoveEvent event) [inline, virtual]

Handle the given event.

Implements casa::PlotMouseMoveEventHandler.

Definition at line 199 of file PlotTool.h.

References handleMouseEvent().

virtual void casa::PlotMouseTool::handleMousePress ( const PlotMousePressEvent event) [inline, virtual]

Handle the given event.

Implements casa::PlotMousePressEventHandler.

Definition at line 193 of file PlotTool.h.

References handleMouseEvent().

virtual void casa::PlotMouseTool::handleMouseRelease ( const PlotMouseReleaseEvent event) [inline, virtual]

Handle the given event.

Implements casa::PlotMouseReleaseEventHandler.

Definition at line 195 of file PlotTool.h.

References handleMouseEvent().

virtual void casa::PlotMouseTool::handleSelect ( const PlotSelectEvent event) [inline, virtual]

Event handling methods.

Implements casa::PlotSelectEventHandler.

Definition at line 189 of file PlotTool.h.

References handleMouseEvent().

virtual void casa::PlotMouseTool::handleWheel ( const PlotWheelEvent event) [inline, virtual]

Handle the given event.

Implements casa::PlotWheelEventHandler.

Definition at line 201 of file PlotTool.h.

References handleMouseEvent().


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