oak-editor/app/widget/slider/sliderbase.cpp

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2019 Olive Team

  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 3 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, see <http://www.gnu.org/licenses/>.

***/

#include "sliderbase.h"

#include <QDebug>
#include <QEvent>
#include <QMessageBox>

SliderBase::SliderBase(Mode mode, QWidget *parent) :
  QStackedWidget(parent),
  decimal_places_(1),
  drag_multiplier_(1.0),
  has_min_(false),
  has_max_(false),
  mode_(mode),
  dragged_(false)
{
  setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Maximum);

  label_ = new SliderLabel(this);
  addWidget(label_);

  editor_ = new SliderLineEdit(this);
  addWidget(editor_);

  connect(label_, SIGNAL(drag_start()), this, SLOT(LabelPressed()));
  connect(label_, SIGNAL(dragged(int)), this, SLOT(LabelDragged(int)));
  connect(label_, SIGNAL(drag_stop()), this, SLOT(LabelClicked()));
  connect(editor_, SIGNAL(Confirmed()), this, SLOT(LineEditConfirmed()));
  connect(editor_, SIGNAL(Cancelled()), this, SLOT(LineEditCancelled()));

  // Set valid cursor based on mode
  switch (mode_) {
  case kString:
    setCursor(Qt::PointingHandCursor);
    SetValue("");
    break;
  case kInteger:
  case kFloat:
    setCursor(Qt::SizeHorCursor);
    SetValue(0);
    break;
  }
}

void SliderBase::SetDragMultiplier(const double &d)
{
  drag_multiplier_ = d;
}

const QVariant &SliderBase::Value()
{
  if (dragged_) {
    return temp_dragged_value_;
  }

  return value_;
}

void SliderBase::SetValue(const QVariant &v)
{
  value_ = ClampValue(v);

  UpdateLabel(value_);
}

void SliderBase::SetMinimumInternal(const QVariant &v)
{
  min_value_ = v;
  has_min_ = true;

  // Limit value by this new minimum value
  if (value_ < min_value_) {
    SetValue(min_value_);
  }
}

void SliderBase::SetMaximumInternal(const QVariant &v)
{
  max_value_ = v;
  has_max_ = true;

  // Limit value by this new maximum value
  if (value_ > max_value_) {
    SetValue(max_value_);
  }
}

void SliderBase::changeEvent(QEvent *e)
{
  if (e->type() == QEvent::LanguageChange) {
    UpdateLabel(value_);
  }
  QStackedWidget::changeEvent(e);
}

const QVariant &SliderBase::ClampValue(const QVariant &v)
{
  if (has_min_ && v < min_value_) {
    return min_value_;
  }

  if (has_max_ && v > max_value_) {
    return max_value_;
  }

  return v;
}

void SliderBase::UpdateLabel(const QVariant &v)
{
  switch (mode_) {
  case kString:
  {
    QString vstr = v.toString();

    if (vstr.isEmpty()) {
      label_->setText(tr("(none)"));
    } else {
      label_->setText(vstr);
    }
    break;
  }
  case kInteger:
    label_->setText(v.toString());
    break;
  case kFloat:
    // For floats, we show a limited number of decimal places
    label_->setText(QString::number(v.toDouble(), 'f', decimal_places_));
    break;
  }
}

void SliderBase::LabelPressed()
{
  dragged_ = false;

  if (mode_ != kString) {
    dragged_diff_ = value_.toDouble();
  }
}

void SliderBase::LabelClicked()
{
  if (dragged_) {
    // This was a drag
    switch (mode_) {
    case kString:
      // No-op
      break;
    case kInteger:
      SetValue(qRound(dragged_diff_));
      break;
    case kFloat:
      SetValue(dragged_diff_);
      break;
    }
  } else {
    // This was a simple click

    // Load label's text into editor
    editor_->setText(label_->text());

    // Show editor
    setCurrentWidget(editor_);

    // Select all text in the editor
    editor_->setFocus();
    editor_->selectAll();
  }

  dragged_ = false;
}

void SliderBase::LabelDragged(int i)
{
  switch (mode_) {
  case kString:
    // No dragging supported for strings
    break;
  case kInteger:
  case kFloat:
  {
    double real_drag = static_cast<double>(i) * drag_multiplier_;

    dragged_diff_ += real_drag;

    // Update temporary value
    if (mode_ == kInteger) {
      temp_dragged_value_ = qRound(dragged_diff_);
    } else {
      temp_dragged_value_ = dragged_diff_;
    }

    temp_dragged_value_ = ClampValue(temp_dragged_value_);

    UpdateLabel(temp_dragged_value_);
    emit ValueChanged(temp_dragged_value_);
    break;
  }
  }

  dragged_ = true;
}

void SliderBase::LineEditConfirmed()
{
  bool is_valid = true;
  QVariant test_val;

  // Check whether the entered value is valid for this mode
  switch (mode_) {
  case kString:
    // Anything goes for a string
    test_val = editor_->text();
    break;
  case kInteger:
  case kFloat:
    // Allow both floats and integers for either modes
    test_val = editor_->text().toDouble(&is_valid);

    if (is_valid && mode_ == kInteger) {
      // But for an integer, we round it
      test_val = qRound(test_val.toDouble());
    }
    break;
  }

  if (is_valid) {
    SetValue(test_val);

    emit ValueChanged(value_);

    setCurrentWidget(label_);
  } else {
    // Ensure the editor focusing out when the messagebox appears does not cause another messagebox
    editor_->blockSignals(true);

    QMessageBox::critical(this,
                          tr("Invalid Value"),
                          tr("The entered value is not valid for this field."),
                          QMessageBox::Ok);

    // Refocus editor
    editor_->setFocus();

    editor_->blockSignals(false);
  }
}

void SliderBase::LineEditCancelled()
{
  // Ensure editor doesn't signal that the focus is lost
  editor_->blockSignals(true);

  // Set widget back to label
  setCurrentWidget(label_);

  editor_->blockSignals(false);
}