include/AIDA/ILineStyle.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_ILINESTYLE_H
0008 #define AIDA_ILINESTYLE_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 #include <vector>
0017
0018 #include "AIDA/IBrushStyle.h"
0019
0020 namespace AIDA {
0021
0022 /**
0023  * Style for all lines (axis lines, legend box outlines, etc.)
0024  *
0025  * @author The AIDA team (http://aida.freehep.org/)
0026  */
0027
0028 class ILineStyle : virtual public IBrushStyle {
0029
0030 public:
0031     /// Destructor.
0032     virtual ~ILineStyle() { /* nop */; }
0033
0034   /**
0035    * Get list of line types supported by this implementation.
0036    */
0037     virtual std::vector<std::string>  availableLineTypes() const = 0;
0038
0039   /**
0040    * Get line type currently in use.
0041    */
0042     virtual std::string lineType() const = 0;
0043
0044   /**
0045    * Get current line thickness.
0046    */
0047     virtual int thickness() const = 0;
0048
0049   /**
0050    * Set current line type e.g. "dotted".
0051    * @return false if line type not known to this implementation.
0052    */
0053     virtual bool setLineType(const std::string & newLineType) = 0;
0054
0055   /**
0056    * Set thickness (exact meaning is implementation-dependent,
0057    * but <0 means invisible).
0058    * @return false if value not supported by this implementation.
0059    */
0060     virtual bool setThickness(int newThickness) = 0;
0061 }; // class
0062 } // namespace AIDA
0063 #endif /* ifndef AIDA_ILINESTYLE_H */