trace.cpp

Go to the documentation of this file.

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2013 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <extdef.h>

#include <assert.h>
#include <cmath>

#include <QApplication>
#include <QFormLayout>
#include <QKeyEvent>
#include <QLineEdit>

#include "trace.hpp"
#include "tracepalette.hpp"
#include "view.hpp"

#include <pv/widgets/colourbutton.hpp>
#include <pv/widgets/popup.hpp>

namespace pv {
namespace view {

const QPen Trace::AxisPen(QColor(128, 128, 128, 64));
const int Trace::LabelHitPadding = 2;

const QColor Trace::DarkBGColour(235, 235, 235);    // Quite light grey
const QColor Trace::BrightBGColour(245, 245, 245);  // Very light grey

Trace::Trace(QString name) :
    name_(name),
    coloured_bg_(true), // Default setting is set in MainWindow::setup_ui()
    popup_(nullptr),
    popup_form_(nullptr)
{
}

QString Trace::name() const
{
    return name_;
}

void Trace::set_name(QString name)
{
    name_ = name;
}

QColor Trace::colour() const
{
    return colour_;
}

void Trace::set_colour(QColor colour)
{
    colour_ = colour;

    bgcolour_ = colour;
    bgcolour_.setAlpha(20);
}

void Trace::set_coloured_bg(bool state)
{
    coloured_bg_ = state;
}

void Trace::paint_label(QPainter &p, const QRect &rect, bool hover)
{
    const int y = get_visual_y();

    p.setBrush(colour_);

    if (!enabled())
        return;

    const QRectF r = label_rect(rect);

    // Paint the label
    const float label_arrow_length = r.height() / 2;
    const QPointF points[] = {
        r.topLeft(),
        QPointF(r.right() - label_arrow_length, r.top()),
        QPointF(r.right(), y),
        QPointF(r.right() - label_arrow_length, r.bottom()),
        r.bottomLeft()
    };
    const QPointF highlight_points[] = {
        QPointF(r.left() + 1, r.top() + 1),
        QPointF(r.right() - label_arrow_length, r.top() + 1),
        QPointF(r.right() - 1, y),
        QPointF(r.right() - label_arrow_length, r.bottom() - 1),
        QPointF(r.left() + 1, r.bottom() - 1)
    };

    if (selected()) {
        p.setPen(highlight_pen());
        p.setBrush(Qt::transparent);
        p.drawPolygon(points, countof(points));
    }

    p.setPen(Qt::transparent);
    p.setBrush(hover ? colour_.lighter() : colour_);
    p.drawPolygon(points, countof(points));

    p.setPen(colour_.lighter());
    p.setBrush(Qt::transparent);
    p.drawPolygon(highlight_points, countof(highlight_points));

    p.setPen(colour_.darker());
    p.setBrush(Qt::transparent);
    p.drawPolygon(points, countof(points));

    // Paint the text
    p.setPen(select_text_colour(colour_));
    p.setFont(QApplication::font());
    p.drawText(QRectF(r.x(), r.y(),
        r.width() - label_arrow_length, r.height()),
        Qt::AlignCenter | Qt::AlignVCenter, name_);
}

QMenu* Trace::create_context_menu(QWidget *parent)
{
    QMenu *const menu = ViewItem::create_context_menu(parent);

    return menu;
}

pv::widgets::Popup* Trace::create_popup(QWidget *parent)
{
    using pv::widgets::Popup;

    popup_ = new Popup(parent);
    popup_->set_position(parent->mapToGlobal(
        point(parent->rect())), Popup::Right);

    create_popup_form();

    connect(popup_, SIGNAL(closed()),
        this, SLOT(on_popup_closed()));

    return popup_;
}

QRectF Trace::label_rect(const QRectF &rect) const
{
    using pv::view::View;

    QFontMetrics m(QApplication::font());
    const QSize text_size(
        m.boundingRect(QRect(), 0, name_).width(), m.height());
    const QSizeF label_size(
        text_size.width() + LabelPadding.width() * 2,
        ceilf((text_size.height() + LabelPadding.height() * 2) / 2) * 2);
    const float half_height = label_size.height() / 2;
    return QRectF(
        rect.right() - half_height - label_size.width() - 0.5,
        get_visual_y() + 0.5f - half_height,
        label_size.width() + half_height,
        label_size.height());
}

void Trace::paint_back(QPainter &p, const ViewItemPaintParams &pp)
{
    if (coloured_bg_)
        p.setBrush(bgcolour_);
    else
        p.setBrush(bgcolour_state_ ? BrightBGColour : DarkBGColour);

    p.setPen(QPen(Qt::NoPen));

    const std::pair<int, int> extents = v_extents();

    const int x = 0;
    const int y = get_visual_y() + extents.first;
    const int w = pp.right() - pp.left();
    const int h = extents.second - extents.first;

    p.drawRect(x, y, w, h);
}

void Trace::paint_axis(QPainter &p, const ViewItemPaintParams &pp, int y)
{
    p.setPen(AxisPen);
    p.drawLine(QPointF(pp.left(), y + 0.5f), QPointF(pp.right(), y + 0.5f));
}

void Trace::add_colour_option(QWidget *parent, QFormLayout *form)
{
    using pv::widgets::ColourButton;

    ColourButton *const colour_button = new ColourButton(
        TracePalette::Rows, TracePalette::Cols, parent);
    colour_button->set_palette(TracePalette::Colours);
    colour_button->set_colour(colour_);
    connect(colour_button, SIGNAL(selected(const QColor&)),
        this, SLOT(on_colour_changed(const QColor&)));

    form->addRow(tr("Colour"), colour_button);
}

void Trace::create_popup_form()
{
    // Clear the layout

    // Transfer the layout and the child widgets to a temporary widget
    // which then goes out of scope destroying the layout and all the child
    // widgets.
    if (popup_form_)
        QWidget().setLayout(popup_form_);

    // Repopulate the popup
    popup_form_ = new QFormLayout(popup_);
    popup_->setLayout(popup_form_);
    populate_popup_form(popup_, popup_form_);
}

void Trace::populate_popup_form(QWidget *parent, QFormLayout *form)
{
    QLineEdit *const name_edit = new QLineEdit(parent);
    name_edit->setText(name_);
    connect(name_edit, SIGNAL(textChanged(const QString&)),
        this, SLOT(on_text_changed(const QString&)));
    form->addRow(tr("Name"), name_edit);

    add_colour_option(parent, form);
}

void Trace::on_popup_closed()
{
    popup_ = nullptr;
    popup_form_ = nullptr;
}

void Trace::on_text_changed(const QString &text)
{
    set_name(text);

    if (owner_)
        owner_->extents_changed(true, false);
}

void Trace::on_colour_changed(const QColor &colour)
{
    set_colour(colour);

    if (owner_)
        owner_->row_item_appearance_changed(true, true);
}

} // namespace view
} // namespace pv