YBarGraph.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. This library
  is distributed in the hope that it will be useful, but WITHOUT ANY
  WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
  License for more details. You should have received a copy of the GNU
  Lesser General Public License along with this library; if not, write
  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

  File:     YBarGraph.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YBarGraph_h
#define YBarGraph_h

#include "YWidget.h"
#include "YColor.h"


class YBarGraphPrivate;
class YBarGraphSegment;

class YBarGraph : public YWidget
{
    friend class YBarGraphMultiUpdate;

protected:
    YBarGraph( YWidget * parent );

public:
    virtual ~YBarGraph();

    virtual const char * widgetClass() const { return "YBarGraph"; }

    void addSegment( const YBarGraphSegment & segment );

    void deleteAllSegments();

    int segments();

    const YBarGraphSegment & segment( int segmentIndex ) const;

    void setValue( int segmentIndex, int newValue );

    void setLabel( int segmentIndex, const std::string & newLabel );

    void setSegmentColor( int segmentIndex, const YColor & color );

    void setTextColor( int segmentIndex, const YColor & color );

    virtual bool setProperty( const std::string    & propertyName,
                  const YPropertyValue & val );

    virtual YPropertyValue getProperty( const std::string & propertyName );

    virtual const YPropertySet & propertySet();


protected:
    virtual void doUpdate() = 0;


private:
    void updateDisplay();

    ImplPtr<YBarGraphPrivate> priv;
};




class YBarGraphSegment
{
public:
    YBarGraphSegment( int           value       = 0,
              const std::string &   label       = std::string(),
              const YColor &        segmentColor    = YColor(),
              const YColor &        textColor   = YColor() )
    : _value( value )
    , _label( label )
    , _segmentColor( segmentColor )
    , _textColor( textColor )
    {}

    int value() const { return _value; }

    void setValue( int newValue ) { _value = newValue; }

    std::string label() const { return _label; }

    void setLabel( const std::string & newLabel ) { _label = newLabel; }

    YColor segmentColor() const { return _segmentColor; }

    bool hasSegmentColor() const { return _segmentColor.isDefined(); }

    void setSegmentColor( const YColor & color ) { _segmentColor = color; }

    YColor textColor() const { return _textColor; }

    bool hasTextColor() const { return _textColor.isDefined(); }

    void setTextColor( const YColor & color ) { _textColor = color; }


private:

    int     _value;
    std::string _label;
    YColor  _segmentColor;
    YColor  _textColor;
};



class YBarGraphMultiUpdate
{
public:
    YBarGraphMultiUpdate( YBarGraph * barGraph );

    ~YBarGraphMultiUpdate();

private:

    YBarGraph * _barGraph;
};


#endif // YBarGraph_h