casa::PCMotionEvent Class Reference

Class which stores PixelCanvas motion event information. More...

#include <PCMotionEvent.h>

Inheritance diagram for casa::PCMotionEvent:

Public Member Functions
	PCMotionEvent (PixelCanvas *pc, const casacore::Int &x, const casacore::Int &y, const casacore::uInt &modifiers)
	Constructor taking a pointer to the PixelCanvas for which the event is valid, the position of the event, and the keyboard and pointer modifiers. More...
virtual	~PCMotionEvent ()
	Destructor. More...
virtual casacore::Int	x () const
	The x and y pixel position of the pointer when the event occured. More...
virtual casacore::Int	y () const
virtual casacore::uInt	modifiers () const
	Return the state of the "modifiers": this is made up of mask bits referring to various keys on the keyboard (eg. More...
Public Member Functions inherited from casa::PixelCanvasEvent
	PixelCanvasEvent (PixelCanvas *pc)
	Constructor, taking a pointer to a PixelCanvas. More...
virtual	~PixelCanvasEvent ()
	Destructor. More...
virtual PixelCanvas *	pixelCanvas () const
	Return a pointer to the PixelCanvas on which the event occurred. More...
Public Member Functions inherited from casa::DisplayEvent
	DisplayEvent ()
	Constructor. More...
	DisplayEvent (const DisplayEvent &other)
	Copy constructor - construct a new DisplayEvent from other. More...
virtual	~DisplayEvent ()
	Destructor. More...
DisplayEvent &	operator= (const DisplayEvent &other)
	Copy assignment using copy semantics. More...
virtual casacore::Double	timeOfEvent () const
	Return the Julian date (in fractional seconds) that this event occured. More...

Protected Member Functions
	PCMotionEvent ()
	(Required) default constructor. More...
	PCMotionEvent (const PCMotionEvent &other)
	(Required) copy constructor. More...
PCMotionEvent &	operator= (const PCMotionEvent &other)
	(Required) copy assignment. More...
Protected Member Functions inherited from casa::PixelCanvasEvent
	PixelCanvasEvent ()
	(Required) default constructor. More...
	PixelCanvasEvent (const PixelCanvasEvent &other)
	(Required) copy constructor. More...
PixelCanvasEvent &	operator= (const PixelCanvasEvent &other)
	(Required) copy assignment. More...

Private Attributes
casacore::Int	itsX
	Store the position of the event here. More...
casacore::Int	itsY
casacore::uInt	itsModifiers
	Store the button and keyboard modifier masks here. More...

Detailed Description

Class which stores PixelCanvas motion event information.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

"PCMotionEvent" is a contraction and concatenation of "PixelCanvas", "Motion" and "Event", and describes motion events occuring on PixelCanvases.

Prerequisite

• PixelCanvasEvent

Synopsis

This class adds to the information stored in the PixelCanvasEvent class. It adds information describing the current position of the mouse or pointing device, and the state of the keyboard modifiers (including the mouse buttons).

Example

Motivation

A compact way of passing motion event information around the PixelCanvas-oriented display classes was needed, with a functional but tight and efficient interface.

Thrown Exceptions

.

Definition at line 82 of file PCMotionEvent.h.

Constructor & Destructor Documentation

casa::PCMotionEvent::PCMotionEvent	(	PixelCanvas *	pc,
		const casacore::Int &	x,
		const casacore::Int &	y,
		const casacore::uInt &	modifiers
	)

Constructor taking a pointer to the PixelCanvas for which the event is valid, the position of the event, and the keyboard and pointer modifiers.

virtual casa::PCMotionEvent::~PCMotionEvent ( )

virtual

Destructor.

casa::PCMotionEvent::PCMotionEvent ( )

protected

(Required) default constructor.

casa::PCMotionEvent::PCMotionEvent ( const PCMotionEvent &  other )

protected

(Required) copy constructor.

Member Function Documentation

virtual casacore::uInt casa::PCMotionEvent::modifiers ( ) const

inlinevirtual

Return the state of the "modifiers": this is made up of mask bits referring to various keys on the keyboard (eg.

Control, Shift, etc.) and the mouse buttons.

Definition at line 108 of file PCMotionEvent.h.

References itsModifiers.

PCMotionEvent& casa::PCMotionEvent::operator= ( const PCMotionEvent &  other )

protected

(Required) copy assignment.

virtual casacore::Int casa::PCMotionEvent::x ( ) const

inlinevirtual

The x and y pixel position of the pointer when the event occured.

Definition at line 97 of file PCMotionEvent.h.

References itsX.

virtual casacore::Int casa::PCMotionEvent::y ( ) const

inlinevirtual

Definition at line 100 of file PCMotionEvent.h.

References itsY.

Member Data Documentation

casacore::uInt casa::PCMotionEvent::itsModifiers

private

Store the button and keyboard modifier masks here.

Definition at line 129 of file PCMotionEvent.h.

Referenced by modifiers().

casacore::Int casa::PCMotionEvent::itsX

private

Store the position of the event here.

Definition at line 126 of file PCMotionEvent.h.

Referenced by x().

casacore::Int casa::PCMotionEvent::itsY

private

Definition at line 126 of file PCMotionEvent.h.

Referenced by y().

---

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

• casa/code/display/DisplayEvents/PCMotionEvent.h