QtMouseTools.qo.h

Go to the documentation of this file.

//# QtMouseTools.qo.h: Qt versions of display library mouse tools.
//# Copyright (C) 2005
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//# $Id$


#ifndef QTMOUSETOOLS_H
#define QTMOUSETOOLS_H

#include <casa/aips.h>
#include <display/DisplayEvents/MultiRectToolImpl.h>
#include <display/DisplayEvents/MultiEllipseToolImpl.h>
#include <display/DisplayEvents/MultiPointToolImpl.h>
#include <display/DisplayEvents/MultiPolyToolImpl.h>
#include <display/DisplayEvents/MultiPolylineToolImpl.h>
#include <display/DisplayEvents/MultiPVToolImpl.h>
#include <display/DisplayEvents/MWCETRegion.h>
#include <display/Display/PanelDisplay.h>
#include <casa/Containers/Record.h>

#include <graphics/X11/X_enter.h>
#  include <QObject>
#include <graphics/X11/X_exit.h>

namespace casa {



// <synopsis>
// Nothing yet: it may prove useful for Qt-signal-emitting mouse tools
// (which are MWCTools or possibly PCTools) to have a common base.
// </synopsis>
class QtMouseTool: public QObject {

  Q_OBJECT      //# Allows slot/signal definition.  Must only occur in
                //# implement/.../*.h files; also, makefile must include
                //# name of this file in 'mocs' section.
  
 public: 
 
  QtMouseTool() : QObject() {  }
  ~QtMouseTool() {  }

}; 




// <synopsis>
// QtRTRegion is the Rectangle Region mouse tool that sends a signal
// when a new rectangle is ready.
// </synopsis>
class QtRTRegion: public QtMouseTool, public MultiRectToolImpl {
  
  Q_OBJECT      //# Allows slot/signal definition.  Must only occur in
                //# implement/.../*.h files; also, makefile must include
                //# name of this file in 'mocs' section.

 public: 
 
  QtRTRegion(viewer::RegionSourceFactory *rf, PanelDisplay* pd) : QtMouseTool(), MultiRectToolImpl(rf, pd), pd_(pd) {  }
  
  ~QtRTRegion() {  }
  
  // Retrieve the current rectangular mouse region record and WCH, if any.
  // (If nothing is ready, returns False -- be sure to check before using
  // return parameters.  See implementation for mouseRegion Record format).
  Bool getMouseRegion(Record& mouseRegion, WorldCanvasHolder*& wch);

 signals:
 
  // See regionReady() implementation for format of the record.  (For some
  // uses, a connecting slot may be able to do without the WCH* parameter).
  void mouseRegionReady(Record mouseRegion, WorldCanvasHolder*);
  void echoClicked(Record);

 protected:
  
  // Signals mouseRegionReady with an appropriate Record, when
  // called by base class in response to user selection with the mouse.
  // See implementation for format of the record.
  virtual void regionReady();

  virtual void clicked(Int x, Int y); 
  virtual void doubleClicked(Int x, Int y); 
  //virtual void rectangleReady(); 
  //virtual void handleEvent(DisplayEvent& ev);
  //virtual void keyPressed(const WCPositionEvent &ev);
  
  PanelDisplay* pd_;    // (Kludge... zIndex inaccessible from WC...)

};


// <synopsis>
// QtPTRegion is the Rectangle Region mouse tool that sends a signal
// when a new rectangle is ready.
// </synopsis>
class QtPointRegion: public QtMouseTool, public MultiPointToolImpl {
  
  Q_OBJECT      //# Allows slot/signal definition.  Must only occur in
                //# implement/.../*.h files; also, makefile must include
                //# name of this file in 'mocs' section.

 public: 
 
  QtPointRegion(viewer::RegionSourceFactory *rf, PanelDisplay* pd) : QtMouseTool(), MultiPointToolImpl(rf, pd), pd_(pd) {  }
  
  ~QtPointRegion() {  }
  
  // Retrieve the current rectangular mouse region record and WCH, if any.
  // (If nothing is ready, returns False -- be sure to check before using
  // return parameters.  See implementation for mouseRegion Record format).
  Bool getMouseRegion(Record& mouseRegion, WorldCanvasHolder*& wch);

 signals:
 
  // See regionReady() implementation for format of the record.  (For some
  // uses, a connecting slot may be able to do without the WCH* parameter).
  void mouseRegionReady(Record mouseRegion, WorldCanvasHolder*);
  void echoClicked(Record);

 protected:
  
  // Signals mouseRegionReady with an appropriate Record, when
  // called by base class in response to user selection with the mouse.
  // See implementation for format of the record.
  virtual void regionReady();

  virtual void clicked(Int x, Int y); 
  virtual void doubleClicked(Int x, Int y); 
  //virtual void rectangleReady(); 
  //virtual void handleEvent(DisplayEvent& ev);
  //virtual void keyPressed(const WCPositionEvent &ev);
  
  PanelDisplay* pd_;    // (Kludge... zIndex inaccessible from WC...)

};


// <synopsis>
// QtELRegion is the Ellipse Region mouse tool that sends a signal
// when a new circle is ready.
// </synopsis>
class QtELRegion: public QtMouseTool, public MultiEllipseToolImpl {

  Q_OBJECT      //# Allows slot/signal definition.  Must only occur in
                //# implement/.../*.h files; also, makefile must include
                //# name of this file in 'mocs' section.

 public:

  QtELRegion(viewer::RegionSourceFactory *rf, PanelDisplay* pd) : QtMouseTool(), MultiEllipseToolImpl(rf, pd), pd_(pd) {  }

  ~QtELRegion() {  }

  // Retrieve the current circular mouse region record and WCH, if any.
  // (If nothing is ready, returns False -- be sure to check before using
  // return parameters.  See implementation for mouseRegion Record format).
  Bool getMouseRegion(Record& mouseRegion, WorldCanvasHolder*& wch);

 signals:

  // See regionReady() implementation for format of the record.  (For some
  // uses, a connecting slot may be able to do without the WCH* parameter).
  void mouseRegionReady(Record mouseRegion, WorldCanvasHolder*);
  void echoClicked(Record);

 protected:

  // Signals mouseRegionReady with an appropriate Record, when
  // called by base class in response to user selection with the mouse.
  // See implementation for format of the record.
  virtual void regionReady();

  virtual void clicked(Int x, Int y);
  virtual void doubleClicked(Int x, Int y);

  PanelDisplay* pd_;    // (Kludge... zIndex inaccessible from WC...)

};


// <synopsis>
// QtPTRegion is the Polygon Region mouse tool that sends a signal
// when a new polygon is ready.
// </synopsis>
class QtPTRegion: public QtMouseTool, public MultiPolyToolImpl {
  
  Q_OBJECT      //# Allows slot/signal definition.  Must only occur in
                //# implement/.../*.h files; also, makefile must include
                //# name of this file in 'mocs' section.

 public: 
 
  QtPTRegion(viewer::RegionSourceFactory *rf, PanelDisplay* pd) : QtMouseTool(), MultiPolyToolImpl(rf, pd), pd_(pd) {  }
  
  ~QtPTRegion() {  }
  
  // Retrieve the current polygon mouse region record and WCH, if any.
  // (If nothing is ready, returns False -- be sure to check before using
  // return parameters.  See implementation for mouseRegion Record format).
  Bool getMouseRegion(Record& mouseRegion, WorldCanvasHolder*& wch);

 signals:
 
  // See regionReady() implementation for format of the record.  (For some
  // uses, a connecting slot may be able to do without the WCH* parameter).
  void mouseRegionReady(Record mouseRegion, WorldCanvasHolder*);
  void echoClicked(Record);

 protected:
  
  // This callback is invoked by the base when the user double-clicks
  // inside a polygon defined previously (but see also polygonReady(),
  // below).  This implementation emits the Qt signal mouseRegionReady()
  // with an appropriate Record defining the user's polygon mouse selection.
  // See implementation for format of the record.
  virtual void regionReady();
  virtual void clicked(Int x, Int y);
  virtual void doubleClicked(Int x, Int y); 

  //virtual void handleEvent(DisplayEvent& ev);
  //virtual void keyPressed(const WCPositionEvent &ev);
  
  //
  // This callback is invoked by the base when the polygon is first
  // defined (by a double-click at last point) or when the mouse is
  // released after a move/resize.  It was unused in glish.  For Qt,
  // this will also signal that the polygon region has been fully
  // 'selected/made ready' (which will preclude the need for the
  // user to double-click [again] inside the polygon to select it). 
  //virtual void polygonReady() { regionReady();  }

  // is this fix to 1393?
  virtual void polygonReady() { }

  PanelDisplay* pd_;    // (Kludge... zIndex inaccessible from WC...)

};

// <synopsis>
// QtPolylineToolRegion is the Polyline Region mouse tool that sends a signal
// when a new polyline is ready.
// </synopsis>
class QtPolylineToolRegion: public QtMouseTool, public MultiPolylineToolImpl {

  Q_OBJECT

 public:

  QtPolylineToolRegion(viewer::RegionSourceFactory *rf, PanelDisplay* pd) :
          QtMouseTool(), MultiPolylineToolImpl(rf, pd), pd_(pd) {  }

  ~QtPolylineToolRegion() {  }

  // Retrieve the current polyline mouse region record and WCH, if any.
  // (If nothing is ready, returns False -- be sure to check before using
  // return parameters.  See implementation for mouseRegion Record format).
  Bool getMouseRegion(Record& mouseRegion, WorldCanvasHolder*& wch);

 signals:

  // See regionReady() implementation for format of the record.  (For some
  // uses, a connecting slot may be able to do without the WCH* parameter).
  void mouseRegionReady(Record mouseRegion, WorldCanvasHolder*);
  void echoClicked(Record);

 protected:

  // This callback is invoked by the base when the user double-clicks
  // inside a polygon defined previously (but see also polygonReady(),
  // below).  This implementation emits the Qt signal mouseRegionReady()
  // with an appropriate Record defining the user's polygon mouse selection.
  // See implementation for format of the record.
  virtual void regionReady();
  virtual void clicked(Int x, Int y);
  virtual void doubleClicked(Int x, Int y);



  //
  // This callback is invoked by the base when the polygon is first
  // defined (by a double-click at last point) or when the mouse is
  // released after a move/resize.  It was unused in glish.  For Qt,
  // this will also signal that the polygon region has been fully
  // 'selected/made ready' (which will preclude the need for the
  // user to double-click [again] inside the polygon to select it).
  //virtual void polygonReady() { regionReady();  }

  // is this fix to 1393?
  virtual void polylineReady() { }

  PanelDisplay* pd_;    // (Kludge... zIndex inaccessible from WC...)

};

// <synopsis>
// QtPVToolRegion is the Polygon Region mouse tool that sends a signal
// when a new polygon is ready.
// </synopsis>
class QtPVToolRegion: public QtMouseTool, public MultiPVToolImpl {
  
  Q_OBJECT      //# Allows slot/signal definition.  Must only occur in
                //# implement/.../*.h files; also, makefile must include
                //# name of this file in 'mocs' section.

 public: 
 
  QtPVToolRegion(viewer::RegionSourceFactory *rf, PanelDisplay* pd) : QtMouseTool(), MultiPVToolImpl(rf, pd), pd_(pd) {  }
  
  ~QtPVToolRegion() {  }
  
  // Retrieve the current polygon mouse region record and WCH, if any.
  // (If nothing is ready, returns False -- be sure to check before using
  // return parameters.  See implementation for mouseRegion Record format).
  Bool getMouseRegion(Record& mouseRegion, WorldCanvasHolder*& wch);

 signals:
 
  // See regionReady() implementation for format of the record.  (For some
  // uses, a connecting slot may be able to do without the WCH* parameter).
  void mouseRegionReady(Record mouseRegion, WorldCanvasHolder*);
  void echoClicked(Record);

 protected:
  
  // This callback is invoked by the base when the user double-clicks
  // inside a polygon defined previously (but see also polygonReady(),
  // below).  This implementation emits the Qt signal mouseRegionReady()
  // with an appropriate Record defining the user's polygon mouse selection.
  // See implementation for format of the record.
  virtual void regionReady();
  virtual void clicked(Int x, Int y);
  virtual void doubleClicked(Int x, Int y); 

  //virtual void handleEvent(DisplayEvent& ev);
  //virtual void keyPressed(const WCPositionEvent &ev);
  
  PanelDisplay* pd_;    // (Kludge... zIndex inaccessible from WC...)

};


} //# NAMESPACE CASA - END

#endif