awesome-widgets/sources/awesomewidgets/graphicalitem.cpp

/***************************************************************************
 *   This file is part of awesome-widgets                                  *
 *                                                                         *
 *   awesome-widgets is free software: you can redistribute it and/or      *
 *   modify it under the terms of the GNU General Public License as        *
 *   published by the Free Software Foundation, either version 3 of the    *
 *   License, or (at your option) any later version.                       *
 *                                                                         *
 *   awesome-widgets 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with awesome-widgets. If not, see http://www.gnu.org/licenses/  *
 ***************************************************************************/

#include "graphicalitem.h"
#include "ui_graphicalitem.h"

#include <KI18n/KLocalizedString>

#include <QBuffer>
#include <QColorDialog>
#include <QDir>
#include <QGraphicsEllipseItem>
#include <QGraphicsScene>
#include <QGraphicsView>
#include <QSettings>

#include <math.h>

#include "awdebug.h"
#include "version.h"


GraphicalItem::GraphicalItem(QWidget *parent, const QString desktopName,
                             const QStringList directories)
    : AbstractExtItem(parent, desktopName, directories)
    , ui(new Ui::GraphicalItem)
{
    qCDebug(LOG_LIB) << __PRETTY_FUNCTION__;

    readConfiguration();
    ui->setupUi(this);
    translate();

    initScene();

    connect(ui->checkBox_custom, SIGNAL(stateChanged(int)), this,
            SLOT(changeValue(int)));
    connect(ui->pushButton_activeColor, SIGNAL(clicked()), this,
            SLOT(changeColor()));
    connect(ui->pushButton_inactiveColor, SIGNAL(clicked()), this,
            SLOT(changeColor()));
}


GraphicalItem::~GraphicalItem()
{
    qCDebug(LOG_LIB) << __PRETTY_FUNCTION__;

    delete m_scene;
    delete ui;
}


GraphicalItem *GraphicalItem::copy(const QString _fileName, const int _number)
{
    qCDebug(LOG_LIB) << "File" << _fileName << "with number" << _number;

    GraphicalItem *item = new GraphicalItem(static_cast<QWidget *>(parent()),
                                            _fileName, directories());
    copyDefaults(item);
    item->setActiveColor(m_activeColor);
    item->setBar(m_bar);
    item->setCustom(m_custom);
    item->setDirection(m_direction);
    item->setHeight(m_height);
    item->setInactiveColor(m_inactiveColor);
    item->setMaxValue(m_maxValue);
    item->setMinValue(m_minValue);
    item->setNumber(_number);
    item->setType(m_type);
    item->setWidth(m_width);

    return item;
}


QString GraphicalItem::image(const QVariant &value)
{
    qCDebug(LOG_LIB) << "Value" << value;

    m_scene->clear();
    int scale[2] = {1, 1};

    // paint
    switch (m_type) {
    case Vertical:
        paintVertical(value.toFloat());
        // scale
        scale[1] = -2 * static_cast<int>(m_direction) + 1;
        break;
    case Circle:
        paintCircle(value.toFloat());
        // scale
        scale[0] = -2 * static_cast<int>(m_direction) + 1;
        break;
    case Graph:
        paintGraph(value.value<QList<float>>());
        // direction option is not recognized by this GI type
        break;
    case Horizontal:
    default:
        paintHorizontal(value.toFloat());
        // scale
        scale[0] = -2 * static_cast<int>(m_direction) + 1;
        break;
    }

    // convert
    QPixmap pixmap
        = m_view->grab().transformed(QTransform().scale(scale[0], scale[1]));
    QByteArray byteArray;
    QBuffer buffer(&byteArray);
    pixmap.save(&buffer, "PNG");
    QString url = QString("<img src=\"data:image/png;base64,%1\"/>")
                      .arg(QString(byteArray.toBase64()));

    return url;
}


QString GraphicalItem::bar() const
{
    return m_bar;
}


QString GraphicalItem::activeColor() const
{
    return m_activeColor;
}


QString GraphicalItem::inactiveColor() const
{
    return m_inactiveColor;
}


bool GraphicalItem::isCustom() const
{
    return m_custom;
}


float GraphicalItem::maxValue() const
{
    return m_maxValue;
}


float GraphicalItem::minValue() const
{
    return m_minValue;
}


GraphicalItem::Type GraphicalItem::type() const
{
    return m_type;
}


QString GraphicalItem::strType() const
{
    QString value;
    switch (m_type) {
    case Vertical:
        value = QString("Vertical");
        break;
    case Circle:
        value = QString("Circle");
        break;
    case Graph:
        value = QString("Graph");
        break;
    case Horizontal:
    default:
        value = QString("Horizontal");
        break;
    }

    return value;
}


GraphicalItem::Direction GraphicalItem::direction() const
{
    return m_direction;
}


QString GraphicalItem::strDirection() const
{
    QString value;
    switch (m_direction) {
    case RightToLeft:
        value = QString("RightToLeft");
        break;
    case LeftToRight:
    default:
        value = QString("LeftToRight");
        break;
    }

    return value;
}


int GraphicalItem::height() const
{
    return m_height;
}


QStringList GraphicalItem::usedKeys() const
{
    return m_usedKeys;
}


int GraphicalItem::width() const
{
    return m_width;
}


QString GraphicalItem::uniq() const
{
    return m_bar;
}


void GraphicalItem::setBar(const QString _bar)
{
    qCDebug(LOG_LIB) << "Bar" << _bar;

    m_bar = _bar;
}


void GraphicalItem::setActiveColor(const QString _color)
{
    qCDebug(LOG_LIB) << "Color" << _color;

    m_activeColor = _color;
}


void GraphicalItem::setCustom(const bool _custom)
{
    qCDebug(LOG_LIB) << "Use custom tag" << _custom;

    m_custom = _custom;
}


void GraphicalItem::setInactiveColor(const QString _color)
{
    qCDebug(LOG_LIB) << "Color" << _color;

    m_inactiveColor = _color;
}


void GraphicalItem::setMaxValue(const float _value)
{
    qCDebug(LOG_LIB) << "Max value" << _value;

    m_maxValue = _value;
}


void GraphicalItem::setMinValue(const float _value)
{
    qCDebug(LOG_LIB) << "Min value" << _value;

    m_minValue = _value;
}


void GraphicalItem::setType(const Type _type)
{
    qCDebug(LOG_LIB) << "Type" << _type;

    m_type = _type;
}


void GraphicalItem::setStrType(const QString _type)
{
    qCDebug(LOG_LIB) << "Type" << _type;

    if (_type == QString("Vertical"))
        setType(Vertical);
    else if (_type == QString("Circle"))
        setType(Circle);
    else if (_type == QString("Graph"))
        setType(Graph);
    else
        setType(Horizontal);
}


void GraphicalItem::setDirection(const Direction _direction)
{
    qCDebug(LOG_LIB) << "Direction" << _direction;

    m_direction = _direction;
}


void GraphicalItem::setStrDirection(const QString _direction)
{
    qCDebug(LOG_LIB) << "Direction" << _direction;

    if (_direction == QString("RightToLeft"))
        setDirection(RightToLeft);
    else
        setDirection(LeftToRight);
}


void GraphicalItem::setHeight(const int _height)
{
    qCDebug(LOG_LIB) << "Height" << _height;
    if (_height <= 0)
        return;

    m_height = _height;
}


void GraphicalItem::setUsedKeys(const QStringList _usedKeys)
{
    qCDebug(LOG_LIB) << "Used keys" << _usedKeys;

    // remove dubs
    m_usedKeys = QSet<QString>::fromList(_usedKeys).toList();
}


void GraphicalItem::setWidth(const int _width)
{
    qCDebug(LOG_LIB) << "Width" << _width;
    if (_width <= 0)
        return;

    m_width = _width;
}


void GraphicalItem::readConfiguration()
{
    AbstractExtItem::readConfiguration();

    for (int i = directories().count() - 1; i >= 0; i--) {
        if (!QDir(directories().at(i))
                 .entryList(QDir::Files)
                 .contains(fileName()))
            continue;
        QSettings settings(
            QString("%1/%2").arg(directories().at(i)).arg(fileName()),
            QSettings::IniFormat);

        settings.beginGroup(QString("Desktop Entry"));
        setCustom(settings.value(QString("X-AW-Custom"), m_custom).toBool());
        setBar(settings.value(QString("X-AW-Value"), m_bar).toString());
        setMaxValue(settings.value(QString("X-AW-Max"), m_maxValue).toFloat());
        setMinValue(settings.value(QString("X-AW-Min"), m_minValue).toFloat());
        setActiveColor(
            settings.value(QString("X-AW-ActiveColor"), m_activeColor)
                .toString());
        setInactiveColor(
            settings.value(QString("X-AW-InactiveColor"), m_inactiveColor)
                .toString());
        setStrType(settings.value(QString("X-AW-Type"), strType()).toString());
        setStrDirection(
            settings.value(QString("X-AW-Direction"), strDirection())
                .toString());
        setHeight(settings.value(QString("X-AW-Height"), m_height).toInt());
        setWidth(settings.value(QString("X-AW-Width"), m_width).toInt());
        // api == 2
        if (apiVersion() < 2)
            setNumber(bar().remove(QString("bar")).toInt());
        settings.endGroup();
    }

    // update for current API
    if ((apiVersion() > 0) && (apiVersion() < AWGIAPI)) {
        qCWarning(LOG_LIB) << "Bump API version from" << apiVersion() << "to"
                           << AWGIAPI;
        setApiVersion(AWGIAPI);
        writeConfiguration();
    }
}


QVariantHash GraphicalItem::run()
{
    // required by abstract class
    return QVariantHash();
}


int GraphicalItem::showConfiguration(const QVariant args)
{
    qCDebug(LOG_LIB) << "Combobox arguments" << args;
    QStringList tags = args.toStringList();

    ui->lineEdit_name->setText(name());
    ui->lineEdit_comment->setText(comment());
    ui->checkBox_custom->setChecked(m_custom);
    ui->comboBox_value->addItems(tags);
    if (m_custom) {
        ui->lineEdit_customValue->setText(m_bar);
    } else {
        ui->comboBox_value->addItem(m_bar);
        ui->comboBox_value->setCurrentIndex(ui->comboBox_value->count() - 1);
    }
    ui->doubleSpinBox_max->setValue(m_maxValue);
    ui->doubleSpinBox_min->setValue(m_minValue);
    ui->pushButton_activeColor->setText(m_activeColor);
    ui->pushButton_inactiveColor->setText(m_inactiveColor);
    ui->comboBox_type->setCurrentIndex(static_cast<int>(m_type));
    ui->comboBox_direction->setCurrentIndex(static_cast<int>(m_direction));
    ui->spinBox_height->setValue(m_height);
    ui->spinBox_width->setValue(m_width);

    int ret = exec();
    if (ret != 1)
        return ret;
    setName(ui->lineEdit_name->text());
    setComment(ui->lineEdit_comment->text());
    setApiVersion(AWGIAPI);
    setCustom(ui->checkBox_custom->isChecked());
    setBar(m_custom ? ui->lineEdit_customValue->text()
                    : ui->comboBox_value->currentText());
    setMaxValue(ui->doubleSpinBox_max->value());
    setMinValue(ui->doubleSpinBox_min->value());
    setActiveColor(ui->pushButton_activeColor->text().remove(QChar('&')));
    setInactiveColor(ui->pushButton_inactiveColor->text().remove(QChar('&')));
    setStrType(ui->comboBox_type->currentText());
    setStrDirection(ui->comboBox_direction->currentText());
    setHeight(ui->spinBox_height->value());
    setWidth(ui->spinBox_width->value());

    writeConfiguration();
    return ret;
}


void GraphicalItem::writeConfiguration() const
{
    AbstractExtItem::writeConfiguration();

    QSettings settings(
        QString("%1/%2").arg(directories().first()).arg(fileName()),
        QSettings::IniFormat);
    qCInfo(LOG_LIB) << "Configuration file" << settings.fileName();

    settings.beginGroup(QString("Desktop Entry"));
    settings.setValue(QString("X-AW-Value"), m_bar);
    settings.setValue(QString("X-AW-Custom"), m_custom);
    settings.setValue(QString("X-AW-Max"), m_maxValue);
    settings.setValue(QString("X-AW-Min"), m_minValue);
    settings.setValue(QString("X-AW-ActiveColor"), m_activeColor);
    settings.setValue(QString("X-AW-InactiveColor"), m_inactiveColor);
    settings.setValue(QString("X-AW-Type"), strType());
    settings.setValue(QString("X-AW-Direction"), strDirection());
    settings.setValue(QString("X-AW-Height"), m_height);
    settings.setValue(QString("X-AW-Width"), m_width);
    settings.endGroup();

    settings.sync();
}


void GraphicalItem::changeColor()
{
    QColor color
        = stringToColor((static_cast<QPushButton *>(sender()))->text());
    QColor newColor = QColorDialog::getColor(color, this, tr("Select color"),
                                             QColorDialog::ShowAlphaChannel);
    if (!newColor.isValid())
        return;
    qCInfo(LOG_LIB) << "Selected color" << newColor;

    QStringList colorText;
    colorText.append(QString("%1").arg(newColor.red()));
    colorText.append(QString("%1").arg(newColor.green()));
    colorText.append(QString("%1").arg(newColor.blue()));
    colorText.append(QString("%1").arg(newColor.alpha()));

    return static_cast<QPushButton *>(sender())
        ->setText(colorText.join(QChar(',')));
}


void GraphicalItem::changeValue(const int state)
{
    qCDebug(LOG_LIB) << "Current state is" << state;

    ui->widget_value->setHidden(state == Qt::Unchecked);
    ui->widget_customValue->setHidden(state != Qt::Unchecked);
}


void GraphicalItem::initScene()
{
    // init scene
    m_scene = new QGraphicsScene();
    if (m_type == Graph)
        m_scene->setBackgroundBrush(stringToColor(m_inactiveColor));
    else
        m_scene->setBackgroundBrush(QBrush(Qt::NoBrush));
    // init view
    m_view = new QGraphicsView(m_scene);
    m_view->setStyleSheet(QString("background: transparent"));
    m_view->setContentsMargins(0, 0, 0, 0);
    m_view->setFrameShape(QFrame::NoFrame);
    m_view->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
    m_view->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
    m_view->resize(m_width + 5, m_height + 5);
}


void GraphicalItem::paintCircle(const float value)
{
    QPen pen;
    pen.setWidth(1);
    float percent = (value - m_minValue) / (m_maxValue - m_minValue);
    QGraphicsEllipseItem *circle;

    QColor inactive = stringToColor(m_inactiveColor);
    QColor active = stringToColor(m_activeColor);

    // inactive
    pen.setColor(inactive);
    circle = m_scene->addEllipse(0.0, 0.0, m_width, m_height, pen,
                                 QBrush(inactive, Qt::SolidPattern));
    circle->setSpanAngle(-(1.0f - percent) * 360.0f * 16.0f);
    circle->setStartAngle(90.0f * 16.0f - percent * 360.0f * 16.0f);
    // active
    pen.setColor(active);
    circle = m_scene->addEllipse(0.0, 0.0, m_width, m_height, pen,
                                 QBrush(active, Qt::SolidPattern));
    circle->setSpanAngle(-percent * 360.0f * 16.0f);
    circle->setStartAngle(90.0f * 16.0f);
}


void GraphicalItem::paintGraph(const QList<float> value)
{
    QPen pen;
    pen.setColor(stringToColor(m_activeColor));

    // default norms
    float normX
        = static_cast<float>(m_width) / static_cast<float>(value.count());
    float normY = static_cast<float>(m_height) / (1.5f * 100.0f);
    // paint graph
    for (int i = 0; i < value.count() - 1; i++) {
        // some magic here
        float x1 = i * normX;
        float y1 = -fabs(value.at(i)) * normY + 5.0f;
        float x2 = (i + 1) * normX;
        float y2 = -fabs(value.at(i + 1)) * normY + 5.0f;
        m_scene->addLine(x1, y1, x2, y2, pen);
    }
}


void GraphicalItem::paintHorizontal(const float value)
{
    QPen pen;
    float percent = (value - m_minValue) / (m_maxValue - m_minValue);

    pen.setWidth(m_height);
    // inactive
    pen.setColor(stringToColor(m_inactiveColor));
    m_scene->addLine(percent * m_width + 0.5 * m_height, 0.5 * m_height,
                     m_width + 0.5 * m_height, 0.5 * m_height, pen);
    // active
    pen.setColor(stringToColor(m_activeColor));
    m_scene->addLine(-0.5 * m_height, 0.5 * m_height,
                     percent * m_width - 0.5 * m_height, 0.5 * m_height, pen);
}


void GraphicalItem::paintVertical(const float value)
{
    QPen pen;
    float percent = (value - m_minValue) / (m_maxValue - m_minValue);

    pen.setWidth(m_width);
    // inactive
    pen.setColor(stringToColor(m_inactiveColor));
    m_scene->addLine(0.5 * m_width, -0.5 * m_width, 0.5 * m_width,
                     (1.0 - percent) * m_height - 0.5 * m_width, pen);
    // active
    pen.setColor(stringToColor(m_activeColor));
    m_scene->addLine(0.5 * m_width, (1.0 - percent) * m_height + 0.5 * m_width,
                     0.5 * m_width, m_height + 0.5 * m_width, pen);
}


QColor GraphicalItem::stringToColor(const QString _color) const
{
    qCDebug(LOG_LIB) << "Color" << _color;

    QColor qcolor;
    QStringList listColor = _color.split(QChar(','));
    while (listColor.count() < 4)
        listColor.append(QString("0"));
    qcolor.setRed(listColor.at(0).toInt());
    qcolor.setGreen(listColor.at(1).toInt());
    qcolor.setBlue(listColor.at(2).toInt());
    qcolor.setAlpha(listColor.at(3).toInt());

    return qcolor;
}


void GraphicalItem::translate()
{
    ui->label_name->setText(i18n("Name"));
    ui->label_comment->setText(i18n("Comment"));
    ui->checkBox_custom->setText(i18n("Use custom formula"));
    ui->label_value->setText(i18n("Value"));
    ui->label_customValue->setText(i18n("Value"));
    ui->label_max->setText(i18n("Max value"));
    ui->label_min->setText(i18n("Min value"));
    ui->label_activeColor->setText(i18n("Active color"));
    ui->label_inactiveColor->setText(i18n("Inactive color"));
    ui->label_type->setText(i18n("Type"));
    ui->label_direction->setText(i18n("Direction"));
    ui->label_height->setText(i18n("Height"));
    ui->label_width->setText(i18n("Width"));
}