PlotLabel.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2006 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Plotting/Pulsar/PlotLabel.h
 
#ifndef __Pulsar_PlotLabel_h
#define __Pulsar_PlotLabel_h
 
#include "TextInterface.h"
#include "pgutil.h"
 
namespace Pulsar {
 
  class Archive;

  class PlotLabel : public Reference::Able {
 
  public:

    static std::string unset;

    PlotLabel ();

    virtual ~PlotLabel ();
 
    // Text interface to the PlotLabel class
    class Interface : public TextInterface::To<PlotLabel> {
    public:
      Interface (PlotLabel* = 0);
    };

    void set_left (const std::string& label) { left = label; }
    std::string get_left () const { return left; }

    void set_centre (const std::string& label) { centre = label; }
    std::string get_centre () const { return centre; }

    void set_right (const std::string& label) { right = label; }
    std::string get_right () const { return right; }

    void set_offset (float _offset) { offset = _offset; }
    float get_offset () const { return offset; }

    void set_spacing (float _spacing) { spacing = _spacing; }
    float get_spacing () const { return spacing; }

    void set_all (const std::string& label) { left = right = centre = label; }

    virtual void plot (const Archive*);

    float get_margin (pgplot::Units) const;

    float get_displacement (int row, pgplot::Units) const;

    float get_displacement (int row) const;

    unsigned get_nrows (const std::string& label) const;
 
  protected:
 
    std::string left;
    std::string right;
    std::string centre;
    float offset;
    float spacing;

    void plot (const Archive*, const std::string& label, float side);

    void row (const std::string&, unsigned irow, unsigned nrow, float side);
 
  };
 
}
 
#endif