lengtheditbase.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * 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/>.
 */

#ifndef LIBREPCB_EDITOR_LENGTHEDITBASE_H
#define LIBREPCB_EDITOR_LENGTHEDITBASE_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../widgets/numbereditbase.h"

#include <librepcb/core/types/length.h>
#include <librepcb/core/types/lengthunit.h>

#include <QtCore>
#include <QtWidgets>

/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
namespace editor {

/*******************************************************************************
 *  Class LengthEditBase
 ******************************************************************************/

class LengthEditBase : public QAbstractSpinBox {
  Q_OBJECT

public:
  struct Steps {
    static QVector<PositiveLength> generic() noexcept {
      return {
          PositiveLength(10000),  // 0.01mm
          PositiveLength(25400),  // 0.0254mm
          PositiveLength(100000),  // 0.1mm
          PositiveLength(254000),  // 0.254mm
          PositiveLength(1000000),  // 1mm
          PositiveLength(2540000),  // 2.54mm
      };
    }

    static QVector<PositiveLength> textHeight() noexcept {
      return {
          PositiveLength(100000),  // 0.1mm
          PositiveLength(254000),  // 0.254mm
          PositiveLength(500000),  // 0.5mm (default)
      };
    }

    static QVector<PositiveLength> pinLength() noexcept {
      return {
          PositiveLength(2500000),  // 2.5mm (for metric symbols)
          PositiveLength(2540000),  // 2.54mm (default)
      };
    }

    static QVector<PositiveLength> drillDiameter() noexcept {
      return {
          PositiveLength(254000),  // 0.254mm (for imperial drills)
          PositiveLength(100000),  // 0.1mm (default, for metric drills)
      };
    }
  };

  enum class StepBehavior {
    PredefinedSteps,
    HalfAndDouble,
  };

  // Constructors / Destructor
  LengthEditBase() = delete;
  explicit LengthEditBase(const Length& min, const Length& max,
                          const Length& value,
                          QWidget* parent = nullptr) noexcept;
  LengthEditBase(const LengthEditBase& other) = delete;
  virtual ~LengthEditBase() noexcept;

  // Getters
  const LengthUnit& getDisplayedUnit() const noexcept;

  // Setters
  void setDefaultValueToolTip(const Length& value) noexcept;
  void setDefaultUnit(const LengthUnit& unit) noexcept;
  void setChangeUnitActionVisible(bool visible) noexcept;
  void setStepBehavior(StepBehavior behavior) noexcept;

  void setSteps(const QVector<PositiveLength>& steps) noexcept;

  // General Methods
  void resetUnit() noexcept;
  void configureClientSettings(const QString& uniqueIdentifier) noexcept;
  void configure(const LengthUnit& defaultUnit,
                 const QVector<PositiveLength>& steps,
                 const QString& uniqueIdentifier) noexcept;
  virtual void stepBy(int steps) override;

  // Reimplemented Methods
  QSize minimumSizeHint() const override;
  QSize sizeHint() const override;

  // Operator Overloadings
  LengthEditBase& operator=(const LengthEditBase& rhs) = delete;

signals:
  void displayedUnitChanged(const LengthUnit& unit);

protected:  // Methods
  virtual QAbstractSpinBox::StepEnabled stepEnabled() const override;
  void setValueImpl(Length value) noexcept;
  void updateValueFromText(QString text) noexcept;
  void updateSingleStep() noexcept;
  void updateSingleStepPredefined() noexcept;
  void updateSingleStepHalfDouble() noexcept;
  void updateText() noexcept;
  LengthUnit extractUnitFromExpression(QString& expression) const noexcept;
  void changeUnitActionTriggered() noexcept;
  void setSelectedUnit(const LengthUnit& unit) noexcept;
  void saveSelectedUnit() noexcept;
  QString getValueStr(const LengthUnit& unit) const noexcept;
  virtual void valueChangedImpl(const Length& diff) noexcept = 0;

protected:  // Data
  QPointer<QAction> mChangeUnitAction;
  LengthUnit mDefaultUnit;
  tl::optional<LengthUnit> mSelectedUnit;
  Length mMinimum;
  Length mMaximum;
  Length mValue;
  StepBehavior mStepBehavior;
  QVector<PositiveLength> mSteps;
  Length mSingleStepUp;  
  Length mSingleStepDown;  
  QSize mAdditionalSize;
  QString mSettingsKey;  
};

/*******************************************************************************
 *  End of File
 ******************************************************************************/

}  // namespace editor
}  // namespace librepcb

#endif