IPlotter.h

// -*- C++ -*-
// AID-GENERATED
// =========================================================================
// This class was generated by AID - Abstract Interface Definition          
// DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it. 
// =========================================================================
#ifndef AIDA_IPLOTTER_H
#define AIDA_IPLOTTER_H 1

//  This file is part of the AIDA library
//  Copyright (C) 2002 by the AIDA team.  All rights reserved.
//  This library is free software and under the terms of the
//  GNU Library General Public License described in the LGPL.txt 

#include <string>
#include <vector>

namespace AIDA {

class IPlotterRegion;
class ITitleStyle;

class IPlotter {

public: 
    virtual ~IPlotter() { /* nop */; }

    virtual IPlotterRegion * createRegion(double x = 0, double y = 0, double w = 1.0, double h = 1.0) = 0;

    virtual bool createRegions(int columns = 1, int rows = 1, int index = 0) = 0;

    virtual IPlotterRegion & currentRegion() const = 0;

    virtual int currentRegionNumber() const = 0;

    virtual int numberOfRegions() const = 0;

    virtual bool setCurrentRegionNumber(int index) = 0;

    virtual IPlotterRegion & next() = 0;

    virtual IPlotterRegion * region(int index) const = 0;

    virtual void destroyRegions() = 0;

    virtual void clearRegions() = 0;

  /*
   * Set various plotting paramters for the whole page.
   * Activate the graphic layer and update the screen window(s)
   * if needed.
   */
    virtual bool setParameter(const std::string & parameter, const std::string & options = "") = 0;

    virtual std::string parameterValue(const std::string & parameter) const = 0;

    virtual std::vector<std::string>  availableParameterOptions(const std::string & parameter) const = 0;

    virtual std::vector<std::string>  availableParameters() const = 0;

  /*
   * GUI related methods :
   */

    virtual bool show() = 0;

    virtual bool refresh() = 0;

    virtual bool hide() = 0;

    virtual bool interact() = 0;

  /*
   * Other methods.
   */

    virtual bool writeToFile(const std::string & filename, const std::string & type = "") = 0;

    virtual void setTitle(const std::string & title) = 0;

    virtual ITitleStyle & titleStyle() = 0;

    virtual void setTitleStyle(const ITitleStyle & style) = 0;
}; // class
} // namespace AIDA
#endif /* ifndef AIDA_IPLOTTER_H */