Source
xxxxxxxxxx
//# DisplayTool.h: base class for event-based tools in the display classes
//# Copyright (C) 1999,2000
//# 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$
namespace casa { //# NAMESPACE CASA - BEGIN
// <summary>
// Base class for event-based tools in the display classes.
// </summary>
// <use visibility=local>
// <reviewed reviewer="Ralph Marson" date="2000/04/18" tests="tDisplayTool">
// </reviewed>
// <etymology>
// "DisplayTool" is a base interface for "Tools" to be used in "Display"
// applications.
// <etymology>
// <synopsis>
// This class is a simple base class which provides a suitable base upon
// which to build interactive user tools for the display classes. It
// simply provides a facility to setup a key to catch and respond to, and
// an interface to enable and disable the tool.
// </synopsis>
// <example>
// A function to provide information about a DisplayTool might look like:
// <srcblock>
// void MyClass::printToolKey(const DisplayTool &tool) const {
// cout << tool.getKey() << endl;
// }
// </srcblock>