include/AIDA/IInfo.h

0001 // -*- C++ -*-
0002 // AID-GENERATED
0003 // =========================================================================
0004 // This class was generated by AID - Abstract Interface Definition
0005 // DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
0006 // =========================================================================
0007 #ifndef AIDA_IINFO_H
0008 #define AIDA_IINFO_H 1
0009
0010 //  This file is part of the AIDA library
0011 //  Copyright (C) 2002 by the AIDA team.  All rights reserved.
0012 //  This library is free software and under the terms of the
0013 //  GNU Library General Public License described in the LGPL.txt
0014
0015 #include <string>
0016
0017 namespace AIDA {
0018
0019 class IFillStyle;
0020 class ILineStyle;
0021 class IMarkerStyle;
0022
0023 /**
0024  * The info class permits to access the info area of a region.
0025  * Through it legends, statistics, text could be displayed.
0026  * A legend is an association of a graphical marker and a text.
0027  *
0028  * @author The AIDA team (http://aida.freehep.org/)
0029  *
0030  */
0031
0032 class IInfo {
0033
0034 public:
0035     /// Destructor.
0036     virtual ~IInfo() { /* nop */; }
0037
0038   /**
0039    * Clear the info area.
0040    */
0041     virtual void clear() = 0;
0042
0043   /**
0044    * Add a text. The text is appended to existing info elements.
0045    */
0046     virtual void addText(const std::string & text) = 0;
0047
0048   /**
0049    * Add a marker, line or fill area legend.
0050    * The legend is appended to existing elements.
0051    */
0052     virtual void addLegend(const IMarkerStyle & style, const std::string & description) = 0;
0053
0054     virtual void addLegend(const ILineStyle & style, const std::string & description) = 0;
0055
0056     virtual void addLegend(const IFillStyle & style, const std::string & description) = 0;
0057 }; // class
0058 } // namespace AIDA
0059 #endif /* ifndef AIDA_IINFO_H */