casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
casa::PlotMouseEvent Class Reference

Generic mouse event where the canvas is the origin, and the type, button, and location of the event are provided. More...

#include <PlotEvent.h>

Inheritance diagram for casa::PlotMouseEvent:
casa::PlotEvent casa::PlotClickEvent casa::PlotMouseDragEvent casa::PlotMouseMoveEvent casa::PlotMousePressEvent casa::PlotMouseReleaseEvent

Public Types

enum  Type {
  CLICK,
  PRESS,
  RELEASE,
  DRAG,
  MOVE
}
 Mouse event types. More...
 
enum  Button {
  SINGLE,
  DOUBLE,
  CONTEXT,
  MIDDLE
}
 Mouse button types that we care about. More...
 

Public Member Functions

 PlotMouseEvent (PlotCanvas *canvas, Type type, Button button, const PlotCoordinate &coord)
 Constructor which takes the originating canvas, type, button, and location. More...
 
virtual ~PlotMouseEvent ()
 Destructor. More...
 
void * origin () const
 Overrides PlotEvent::origin(). More...
 
PlotCanvascanvas () const
 Canvas origin of event. More...
 
Type type () const
 Type of event. More...
 
Button button () const
 Button of event. More...
 
PlotCoordinate where () const
 Location of event. More...
 
- Public Member Functions inherited from casa::PlotEvent
 PlotEvent ()
 
virtual ~PlotEvent ()
 

Protected Attributes

PlotCanvasm_canvas
 
Type m_type
 
Button m_button
 
PlotCoordinate m_coord
 

Detailed Description

Generic mouse event where the canvas is the origin, and the type, button, and location of the event are provided.

Definition at line 78 of file PlotEvent.h.

Member Enumeration Documentation

Mouse button types that we care about.

Enumerator
SINGLE 
DOUBLE 
CONTEXT 
MIDDLE 

Definition at line 90 of file PlotEvent.h.

Mouse event types.

Enumerator
CLICK 
PRESS 
RELEASE 
DRAG 
MOVE 

Definition at line 81 of file PlotEvent.h.

Constructor & Destructor Documentation

casa::PlotMouseEvent::PlotMouseEvent ( PlotCanvas canvas,
Type  type,
Button  button,
const PlotCoordinate &  coord 
)

Constructor which takes the originating canvas, type, button, and location.

virtual casa::PlotMouseEvent::~PlotMouseEvent ( )
virtual

Destructor.

Member Function Documentation

Button casa::PlotMouseEvent::button ( ) const

Button of event.

PlotCanvas* casa::PlotMouseEvent::canvas ( ) const

Canvas origin of event.

Referenced by origin().

void* casa::PlotMouseEvent::origin ( ) const
inlinevirtual

Overrides PlotEvent::origin().

Implements casa::PlotEvent.

Definition at line 106 of file PlotEvent.h.

References canvas().

Type casa::PlotMouseEvent::type ( ) const

Type of event.

PlotCoordinate casa::PlotMouseEvent::where ( ) const

Location of event.

Member Data Documentation

Button casa::PlotMouseEvent::m_button
protected

Definition at line 123 of file PlotEvent.h.

PlotCanvas* casa::PlotMouseEvent::m_canvas
protected

Definition at line 121 of file PlotEvent.h.

PlotCoordinate casa::PlotMouseEvent::m_coord
protected

Definition at line 124 of file PlotEvent.h.

Type casa::PlotMouseEvent::m_type
protected

Definition at line 122 of file PlotEvent.h.


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