casa6

//# PlotAnnotation.h: Annotation class that can be drawn on a canvas.

//# Copyright (C) 2008

//# 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 PLOTANNOTATION_H_

#define PLOTANNOTATION_H_

​

#include <graphics/GenericPlotter/PlotItem.h>

​

#include <casacore/casa/BasicSL/String.h>

​

namespace casa {

​

// PlotAnnotation is an abstraction of text written directly on the canvas.  An

// annotation has text, font, orientation, outline, and background properties.

class PlotAnnotation : public virtual PlotItem {

public:

    // Constructor.

    PlotAnnotation() { }

    // Destructor.

    virtual ~PlotAnnotation() { }

    // Implements PlotItem::drawCount().  Provides default implementation that

    // returns 1.

    virtual unsigned int drawCount() const { return 1; }

    // ABSTRACT METHODS //

    // Returns the text of the annotation.

    virtual casacore::String text() const = 0;

    // Sets the text of the annotation.

    virtual void setText(const casacore::String& newText) = 0;

    // Returns a copy of the font used in the annotation.

    virtual PlotFontPtr font() const = 0;

    // Sets the annotation font to the given.

    virtual void setFont(const PlotFont& font) = 0;