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 Bool &keystate, const Int &x, const Int &y, const 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".
virtual	~PCPositionEvent ()
	Destructor.
virtual Display::KeySym	key () const
	Which key was pressed or released?
virtual Bool	keystate () const
	What state is the key in: `True` for pressed, `False` for released.
Protected Member Functions
	PCPositionEvent ()
	(Required) default constructor.
	PCPositionEvent (const PCPositionEvent &other)
	(Required) copy constructor.
PCPositionEvent &	operator= (const PCPositionEvent &other)
	(Required) copy assignment.
Private Attributes
Display::KeySym	itsKey
	Store the key that was pressed or released here.
Bool	itsKeyState
	Store the state of that key here.

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 Bool &	keystate,
		const Int &	x,
		const Int &	y,
		const 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 [inline, virtual]

Which key was pressed or released?

Definition at line 98 of file PCPositionEvent.h.

References itsKey.

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

virtual Bool casa::PCPositionEvent::keystate ( ) const [inline, virtual]

What state is the key in: True for pressed, False for released.

Definition at line 103 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 120 of file PCPositionEvent.h.

Referenced by key().

Bool casa::PCPositionEvent::itsKeyState [private]

Store the state of that key here.

Definition at line 123 of file PCPositionEvent.h.

Referenced by keystate().

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

code/display/DisplayEvents/PCPositionEvent.h

Public Member Functions

Protected Member Functions

Private Attributes