casa::PCPositionEvent Class Reference

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

#include <PCPositionEvent.h>

Inheritance diagram for casa::PCPositionEvent:

Public Member Functions
	PCPositionEvent (PixelCanvas *pc, const Display::KeySym &key, const casacore::Bool &keystate, 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 symbol of the key, the state of the key, the position of the pointer, and the input "modifiers". More...
virtual	~PCPositionEvent ()
	Destructor. More...
virtual Display::KeySym	key () const
	Which key was pressed or released? More...
virtual casacore::Bool	keystate () const
	What state is the key in: true for pressed, false for released. More...
Public Member Functions inherited from 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. 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
	PCPositionEvent ()
	(Required) default constructor. More...
	PCPositionEvent (const PCPositionEvent &other)
	(Required) copy constructor. More...
PCPositionEvent &	operator= (const PCPositionEvent &other)
	(Required) copy assignment. More...
Protected Member Functions inherited from casa::PCMotionEvent
	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
Display::KeySym	itsKey
	Store the key that was pressed or released here. More...
casacore::Bool	itsKeyState
	Store the state of that key here. More...

Detailed Description

Class which stores PixelCanvas position event information.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

"PCPositionEvent" is a contraction and concatenation of "PixelCanvas", "Position" and "Event", and describes position events occuring on PixelCanvases.

Prerequisite

• PixelCanvasEvent

Synopsis

This class adds to the information stored in the PCMotionEvent class. It adds information describing key that has been pressed or released, and the state of that key.

Example

Motivation

A compact way of passing passing position 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 PCPositionEvent.h.

Constructor & Destructor Documentation

casa::PCPositionEvent::PCPositionEvent	(	PixelCanvas *	pc,
		const Display::KeySym &	key,
		const casacore::Bool &	keystate,
		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 symbol of the key, the state of the key, the position of the pointer, and the input "modifiers".

User Constructor

virtual casa::PCPositionEvent::~PCPositionEvent ( )

virtual

Destructor.

casa::PCPositionEvent::PCPositionEvent ( )

protected

(Required) default constructor.

casa::PCPositionEvent::PCPositionEvent ( const PCPositionEvent &  other )

protected

(Required) copy constructor.

Member Function Documentation

virtual Display::KeySym casa::PCPositionEvent::key ( ) const

inlinevirtual

Which key was pressed or released?

Definition at line 98 of file PCPositionEvent.h.

References itsKey.

Referenced by casa::QtDisplayPanel::operator()().

virtual casacore::Bool casa::PCPositionEvent::keystate ( ) const

inlinevirtual

What state is the key in: true for pressed, false for released.

Definition at line 104 of file PCPositionEvent.h.

References itsKeyState.

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

protected

(Required) copy assignment.

Member Data Documentation

Display::KeySym casa::PCPositionEvent::itsKey

private

Store the key that was pressed or released here.

Definition at line 122 of file PCPositionEvent.h.

Referenced by key().

casacore::Bool casa::PCPositionEvent::itsKeyState

private

Store the state of that key here.

Definition at line 125 of file PCPositionEvent.h.

Referenced by keystate().

---

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

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