// // ******************************************************************** // * DISCLAIMER * // * * // * The following disclaimer summarizes all the specific disclaimers * // * of contributors to this software. The specific disclaimers,which * // * govern, are listed with their locations in: * // * http://cern.ch/geant4/license * // * * // * Neither the authors of this software system, nor their employing * // * institutes,nor the agencies providing financial support for this * // * work make any representation or warranty, express or implied, * // * regarding this software system or assume any liability for its * // * use. * // * * // * This code implementation is the intellectual property of the * // * GEANT4 collaboration. * // * By copying, distributing or modifying the Program (or any work * // * based on the Program) you indicate your acceptance of this * // * statement, and all its terms. * // ******************************************************************** // // -*- 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_IBASESTYLE_H #define AIDA_IBASESTYLE_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 #include namespace AIDA { /** * Superclass for all styles in AIDA Plotting package. * All styles can be reset to their original values at construction * time. In the case of styles which 'contain' other styles (like IStyle * or IAxisStyle), reset() calls reset() on the aggregated styles too. * All styles are hierarchical, so the plotter's current style is overridden by the * region's current style, which is overridden by any 'associated' style * which is overwritten by any style passed in explicitly at plotting time. * Parameters and options which have been explicitly set to * non-default (or default!) values are 'sticky'. For example, if a style * has the default 'red' and this has been set explicitly to 'blue' at the * Plotter level, then it will override the default 'red' at the Region level. * IF the user explicitly sets the region to 'green' (or 'red'!) then it will * not be overridden by the 'parent' style. * * @author The AIDA team (http://aida.freehep.org/) */ class IBaseStyle { public: /// Destructor. virtual ~IBaseStyle() { /* nop */; } /** * Return to original (construction time) state. Explicitly * set parameters will be set to defaults and may be overridden */ virtual void reset() = 0; /** * Set a parameter. * @param paramName Name of the parameter. * @param options String of options. * @return false if parameter (or its options) unknown or invalid. */ virtual bool setParameter(const std::string & paramName, const std::string & options = "") = 0; /** * Get value of a parameter. * @param paramName Name of the parameter. * @return the value. */ virtual std::string parameterValue(const std::string & parameter) const = 0; /** * Get list of the available parameters (implementation-dependent) */ virtual std::vector availableParameters() const = 0; /** * Get list of the available options for a given parameter * (implementation-dependent). */ virtual std::vector availableParameterOptions(const std::string & paramName) const = 0; }; // class }; // namespace AIDA #endif /* ifndef AIDA_IBASESTYLE_H */